Inheritance diagram for JsonGenerationFromDataObjectTest:

Public Member Functions
	testMultiServiceRetrieval ()

	testSingleServiceRetrieval ()

	testInvalidRestUrlNoServices ()

	testInvalidRestUrlInvalidServiceName ()

	checkActualData ($expected, $actual)

	getExpectedCommonData ()

	getExpectedMultiServiceData ()

	getExpectedSingleServiceData ()

Public Member Functions inherited from WebapiAbstract
	addModelToDelete ($model, $secure=false)

	processRestExceptionResult (\Exception $e)

Protected Member Functions
	setUp ()

Protected Member Functions inherited from WebapiAbstract
	tearDown ()

	_webApiCall ( $serviceInfo, $arguments=[], $webApiAdapterCode=null, $storeCode=null, $integration=null)

	_markTestAsSoapOnly ($message=null)

	_markTestAsRestOnly ($message=null)

	_getWebApiAdapter ($webApiAdapterCode)

	_assertMessagesEqual ($expectedMessages, $receivedMessages)

	_cleanAppConfigCache ()

	_restoreAppConfig ()

	checkSoapFault ( $soapFault, $expectedMessage, $expectedFaultCode, $expectedErrorParams=[], $expectedWrappedErrors=[], $traceString=null)

	_checkFaultParams ($expectedErrorParams, $errorDetails)

	_checkWrappedErrors ($expectedWrappedErrors, $errorDetails)

Protected Attributes
	$baseUrl = TESTS_BASE_URL

	$storeCode

	$isSingleService

	$productMetadata

Protected Attributes inherited from WebapiAbstract
	$_appCache

	$_modelsToDelete = []

	$_origConfigValues = []

	$_webApiAdapters

	$_webApiAdaptersMap

Additional Inherited Members
Static Public Member Functions inherited from WebapiAbstract
static	setUpBeforeClass ()

static	tearDownAfterClass ()

static	setFixture ($key, $fixture, $tearDown=self::AUTO_TEAR_DOWN_AFTER_METHOD)

static	getFixture ($key)

static	callModelDelete ($model, $secure=false)

static	deleteFixture ($key, $secure=false)

Data Fields inherited from WebapiAbstract
const	AUTO_TEAR_DOWN_DISABLED = 0

const	AUTO_TEAR_DOWN_AFTER_METHOD = 1

const	AUTO_TEAR_DOWN_AFTER_CLASS = 2

const	ADAPTER_SOAP = 'soap'

const	ADAPTER_REST = 'rest'

Static Protected Member Functions inherited from WebapiAbstract
static	_setFixtureNamespace ()

static	_unsetFixtureNamespace ()

static	_getFixtureNamespace ()

static	_deleteFixtures ($fixtures)

Static Protected Attributes inherited from WebapiAbstract
static	$_fixturesNamespace

static	$_fixtures = []

static	$_methodLevelFixtures = []

static	$_classLevelFixtures = []

Detailed Description

Test REST schema generation mechanisms.

Definition at line 16 of file JsonGenerationFromDataObjectTest.php.

Member Function Documentation

◆ checkActualData()

checkActualData	(	$expected,
		$actual
	)

Definition at line 132 of file JsonGenerationFromDataObjectTest.php.

     {
         $this->assertRecursiveArray($expected, $actual, true);
     }

◆ getExpectedCommonData()

getExpectedCommonData ( )

Definition at line 137 of file JsonGenerationFromDataObjectTest.php.

     {
         $versionParts = explode('.', $this->productMetadata->getVersion());
         if (!isset($versionParts[0]) || !isset($versionParts[1])) {
             return []; // Major and minor version are not set - return empty response
         }
         $majorMinorVersion = $versionParts[0] . '.' . $versionParts[1];
         $url = str_replace('://', '', strstr($this->baseUrl, '://'));
         $host = strpos($url, '/') ? strstr($url, '/', true) : $url;
         $basePath = strstr(rtrim($url, '/'), '/');
         $basePath = $basePath ? trim($basePath, '/') . '/' : '';
         $basePath = '/' . $basePath . 'rest/' . $this->storeCode;
         return [
             'swagger' => '2.0',
             'info' => [
                 'version' => $majorMinorVersion,
                 'title' => $this->productMetadata->getName() . ' ' .$this->productMetadata->getEdition(),
             ],
             'host' => $host,
             'basePath' => $basePath,
         ];
     }

◆ getExpectedMultiServiceData()

getExpectedMultiServiceData ( )

Returns: array @SuppressWarnings(PHPMD.ExcessiveMethodLength)

Definition at line 164 of file JsonGenerationFromDataObjectTest.php.

     {
         $expected = [
             'tags' => [
                 [
                   'name' => 'testModule5AllSoapAndRestV1',
                   'description' => 'Both SOAP and REST Version ONE',
                 ],
                 [
                   'name' => 'testModule5AllSoapAndRestV2',
                   'description' => 'Both SOAP and REST Version TWO',
                 ],
             ],
             'paths' => [
                 '/V1/TestModule5/{parentId}/nestedResource/{entityId}' =>    [
                     'put' => [
                         'tags' => [
                             'testModule5AllSoapAndRestV1',
                         ],
                         'description' => 'Update existing item.',
                         'operationId' => 'testModule5AllSoapAndRestV1NestedUpdatePut',
                         'parameters' => [
                             [
                                 'name' => 'parentId',
                                 'in' => 'path',
                                 'type' => 'string',
                                 'required' => true
                             ],
                             [
                                 'name' => 'entityId',
                                 'in' => 'path',
                                 'type' => 'string',
                                 'required' => true
                             ],
                             [
                                 'name' => 'testModule5AllSoapAndRestV1NestedUpdatePutBody',
                                 'in' => 'body',
                                 'schema' => [
                                     'required' => [
                                         'entityItem',
                                     ],
                                     'properties' => [
                                         'entityItem' => [
                                             '$ref' => '#/definitions/test-module5-v1-entity-all-soap-and-rest',
                                         ],
                                     ],
                                     'type' => 'object'
                                 ],
                             ]
                         ],
                         'responses' => [
                             200 => [
                                 'description' => '200 Success.',
                                 'schema' => [
                                     '$ref' => '#/definitions/test-module5-v1-entity-all-soap-and-rest',
                                 ],
                             ],
                             401 => [
                                 'description' => '401 Unauthorized',
                                 'schema' => [
                                     '$ref' => '#/definitions/error-response',
                                 ],
                             ],
                             'default' => [
                                 'description' => 'Unexpected error',
                                 'schema' => [
                                     '$ref' => '#/definitions/error-response',
                                 ],
                             ],
                         ],
                     ],
                 ],
             ],
             'definitions' => [
                 'framework-attribute-interface' => [
                     'type' => 'object',
                     'description' => 'Interface for custom attribute value.',
                     'properties' => [
                         'attribute_code' => [
                             'type' => 'string',
                             'description' => 'Attribute code',
                         ],
                         'value' => [
                             'type' => 'string',
                             'description' => 'Attribute value',
                         ],
                     ],
                     'required' => [
                         'attribute_code',
                         'value',
                     ],
                 ],
                 'test-module5-v1-entity-all-soap-and-rest' => [
                     'type' => 'object',
                     'description' => 'Some Data Object short description. Data Object long multi line description.',
                     'properties' => [
                         'entity_id' => [
                             'type' => 'integer',
                                 'description' => 'Item ID',
                             ],
                             'name' => [
                                 'type' => 'string',
                                 'description' => 'Item name',
                             ],
                             'enabled' => [
                                 'type' => 'boolean',
                                 'description' => 'If entity is enabled',
                             ],
                             'orders' => [
                                 'type' => 'boolean',
                                 'description' => 'If current entity has a property defined',
                             ],
                             'custom_attributes' => [
                                 'type' => 'array',
                                 'description' => 'Custom attributes values.',
                                 'items' => [
                                     '$ref' => '#/definitions/framework-attribute-interface',
                                 ],
                             ],
                     ],
                     'required' => [
                         'entity_id',
                         'enabled',
                         'orders',
                     ],
                 ],
             ],
         ];
         return array_merge_recursive($expected, $this->getExpectedCommonData());
     }

◆ getExpectedSingleServiceData()

getExpectedSingleServiceData ( )

Returns: array @SuppressWarnings(PHPMD.ExcessiveMethodLength)

Definition at line 299 of file JsonGenerationFromDataObjectTest.php.

     {
         $expected = [
             'tags' => [
                 [
                   'name' => 'testModule5AllSoapAndRestV2',
                   'description' => 'Both SOAP and REST Version TWO',
                 ],
             ],
             'paths' => [
                 '/V2/TestModule5/{id}' => [
                     'delete' => [
                         'tags' => [
                             'testModule5AllSoapAndRestV2',
                         ],
                         'description' => 'Delete existing item.',
                         'operationId' => 'testModule5AllSoapAndRestV2DeleteDelete',
                         'parameters' => [
                             [
                                 'name' => 'id',
                                 'in' => 'path',
                                 'type' => 'string',
                                 'required' => true
                             ],
                         ],
                         'responses' => [
                             200 => [
                                 'description' => '200 Success.',
                                 'schema' => [
                                     '$ref' => '#/definitions/test-module5-v2-entity-all-soap-and-rest',
                                 ],
                             ],
                             401 => [
                                 'description' => '401 Unauthorized',
                                 'schema' => [
                                     '$ref' => '#/definitions/error-response',
                                 ],
                             ],
                             'default' => [
                                 'description' => 'Unexpected error',
                                 'schema' => [
                                     '$ref' => '#/definitions/error-response',
                                 ],
                             ],
                         ],
                     ],
                 ],
             ],
             'definitions' => [
                 'test-module5-v2-entity-all-soap-and-rest' => [
                     'type' => 'object',
                     'description' => 'Some Data Object short description. Data Object long multi line description.',
                     'properties' => [
                         'price' => [
                             'type' => 'integer',
                         ],
                     ],
                     'required' => [
                         'price',
                     ],
                 ],
             ],
         ];
         return array_merge($expected, $this->getExpectedCommonData());
     }

◆ setUp()

setUp ( )

protected

Definition at line 32 of file JsonGenerationFromDataObjectTest.php.

     {
         $this->_markTestAsRestOnly("JSON generation tests are intended to be executed for REST adapter only.");
 
         $this->storeCode = Bootstrap::getObjectManager()->get(StoreManagerInterface::class)
             ->getStore()->getCode();
 
         $this->productMetadata =  Bootstrap::getObjectManager()->get(ProductMetadataInterface::class);
 
         parent::setUp();
     }

◆ testInvalidRestUrlInvalidServiceName()

testInvalidRestUrlInvalidServiceName ( )

@expectedException \Exception @expectedExceptionMessage Incorrect format of request URI or Requested services are missing.

Definition at line 101 of file JsonGenerationFromDataObjectTest.php.

     {
         $this->isSingleService = false;
 
         $resourcePath = '/schema?services=invalidServiceName';
 
         $serviceInfo = [
             'rest' => [
                 'resourcePath' => $resourcePath,
                 'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
             ],
         ];
 
         $this->_webApiCall($serviceInfo);
     }

◆ testInvalidRestUrlNoServices()

testInvalidRestUrlNoServices ( )

@expectedException \Exception @expectedExceptionMessage Specified request cannot be processed.

Definition at line 83 of file JsonGenerationFromDataObjectTest.php.

     {
         $resourcePath = '';
 
         $serviceInfo = [
             'rest' => [
                 'resourcePath' => $resourcePath,
                 'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
             ],
         ];
 
         $this->_webApiCall($serviceInfo);
     }

◆ testMultiServiceRetrieval()

testMultiServiceRetrieval ( )

Definition at line 44 of file JsonGenerationFromDataObjectTest.php.

     {
         $this->isSingleService = false;
 
         $resourcePath = '/schema?services=testModule5AllSoapAndRestV1,testModule5AllSoapAndRestV2';
 
         $serviceInfo = [
             'rest' => [
                 'resourcePath' => $resourcePath,
                 'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
             ],
         ];
 
         $schemaContent =  $this->_webApiCall($serviceInfo);
         $this->checkActualData($this->getExpectedMultiServiceData(), $schemaContent);
     }

◆ testSingleServiceRetrieval()

testSingleServiceRetrieval ( )

Definition at line 61 of file JsonGenerationFromDataObjectTest.php.

     {
         $this->isSingleService = false;
 
         $resourcePath = '/schema?services=testModule5AllSoapAndRestV2';
 
         $serviceInfo = [
             'rest' => [
                 'resourcePath' => $resourcePath,
                 'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
             ],
         ];
 
         $schemaContent =  $this->_webApiCall($serviceInfo);
 
         $this->checkActualData($this->getExpectedSingleServiceData(), $schemaContent);
     }

Field Documentation

◆ $baseUrl

$baseUrl = TESTS_BASE_URL

protected

Definition at line 19 of file JsonGenerationFromDataObjectTest.php.

◆ $isSingleService

$isSingleService

protected

Definition at line 25 of file JsonGenerationFromDataObjectTest.php.

◆ $productMetadata

$productMetadata

protected

Definition at line 30 of file JsonGenerationFromDataObjectTest.php.

◆ $storeCode

$storeCode

protected

Definition at line 22 of file JsonGenerationFromDataObjectTest.php.

The documentation for this class was generated from the following file:

vendor/magento/magento2-base/dev/tests/api-functional/testsuite/Magento/Webapi/JsonGenerationFromDataObjectTest.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ checkActualData()

◆ getExpectedCommonData()

◆ getExpectedMultiServiceData()

◆ getExpectedSingleServiceData()

◆ setUp()

◆ testInvalidRestUrlInvalidServiceName()

◆ testInvalidRestUrlNoServices()

◆ testMultiServiceRetrieval()

◆ testSingleServiceRetrieval()

Field Documentation

◆ $baseUrl

◆ $isSingleService

◆ $productMetadata

◆ $storeCode