Inheritance diagram for AddressMetadataTest:

Public Member Functions
	testGetAttributeMetadata ($attributeCode, $expectedMetadata)

	getAttributeMetadataDataProvider ()

	testGetAllAttributesMetadata ()

	testGetCustomAttributesMetadata ()

	testGetAttributes ($formCode, $expectedMetadata)

	getAttributesDataProvider ()

	checkValidationRules ($expectedResult, $actualResult)

	checkMultipleAttributesValidationRules ($expectedResult, $actualResultSet)

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

	processRestExceptionResult (\Exception $e)

Data Fields
const	SERVICE_NAME = "customerAddressMetadataV1"

const	SERVICE_VERSION = "V1"

const	RESOURCE_PATH = "/V1/attributeMetadata/customerAddress"

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'

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)

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)

Static Protected Member Functions inherited from WebapiAbstract
static	_setFixtureNamespace ()

static	_unsetFixtureNamespace ()

static	_getFixtureNamespace ()

static	_deleteFixtures ($fixtures)

Protected Attributes inherited from WebapiAbstract
	$_appCache

	$_modelsToDelete = []

	$_origConfigValues = []

	$_webApiAdapters

	$_webApiAdaptersMap

Static Protected Attributes inherited from WebapiAbstract
static	$_fixturesNamespace

static	$_fixtures = []

static	$_methodLevelFixtures = []

static	$_classLevelFixtures = []

Detailed Description

Class AddressMetadataTest

Definition at line 16 of file AddressMetadataTest.php.

Member Function Documentation

◆ checkMultipleAttributesValidationRules()

checkMultipleAttributesValidationRules	(	$expectedResult,
		$actualResultSet
	)

Check specific attribute validation rules in set of multiple attributes

Parameters

array	$expectedResult	Set of expected attribute metadata
array	$actualResultSet	Set of actual attribute metadata

Returns: array

Definition at line 246 of file AddressMetadataTest.php.

     {
         if (is_array($expectedResult) && is_array($actualResultSet)) {
             if (isset($expectedResult[AttributeMetadata::ATTRIBUTE_CODE])) {
                 foreach ($actualResultSet as $actualAttributeKey => $actualAttribute) {
                     if (isset($actualAttribute[AttributeMetadata::ATTRIBUTE_CODE])
                         && $expectedResult[AttributeMetadata::ATTRIBUTE_CODE]
                         == $actualAttribute[AttributeMetadata::ATTRIBUTE_CODE]
                     ) {
                         $this->checkValidationRules($expectedResult, $actualAttribute);
                         unset($actualResultSet[$actualAttributeKey][AttributeMetadata::VALIDATION_RULES]);
                     }
                 }
                 unset($expectedResult[AttributeMetadata::VALIDATION_RULES]);
             }
         }
         return [$expectedResult, $actualResultSet];
     }

◆ checkValidationRules()

checkValidationRules	(	$expectedResult,
		$actualResult
	)

Checks that expected and actual attribute metadata validation rules are equal and removes the validation rules entry from expected and actual attribute metadata

Parameters

array	$expectedResult
array	$actualResult

Returns: array @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 204 of file AddressMetadataTest.php.

     {
         $expectedRules = [];
         $actualRules = [];
 
         if (isset($expectedResult[AttributeMetadata::VALIDATION_RULES])) {
             $expectedRules = $expectedResult[AttributeMetadata::VALIDATION_RULES];
             unset($expectedResult[AttributeMetadata::VALIDATION_RULES]);
         }
         if (isset($actualResult[AttributeMetadata::VALIDATION_RULES])) {
             $actualRules = $actualResult[AttributeMetadata::VALIDATION_RULES];
             unset($actualResult[AttributeMetadata::VALIDATION_RULES]);
         }
 
         if (is_array($expectedRules) && is_array($actualRules)) {
             foreach ($expectedRules as $expectedRule) {
                 if (isset($expectedRule['name']) && isset($expectedRule['value'])) {
                     $found = false;
                     foreach ($actualRules as $actualRule) {
                         if (isset($actualRule['name']) && isset($actualRule['value'])) {
                             if ($expectedRule['name'] == $actualRule['name']
                                 && $expectedRule['value'] == $actualRule['value']
                             ) {
                                 $found = true;
                                 break;
                             }
                         }
                     }
                     $this->assertTrue($found);
                 }
             }
         }
         return [$expectedResult, $actualResult];
     }

◆ getAttributeMetadataDataProvider()

getAttributeMetadataDataProvider ( )

Data provider for testGetAttributeMetadata.

Returns: array

Definition at line 58 of file AddressMetadataTest.php.

     {
         return [
             Address::POSTCODE => [
                 Address::POSTCODE,
                 [
                     AttributeMetadata::FRONTEND_INPUT => 'text',
                     AttributeMetadata::INPUT_FILTER => '',
                     AttributeMetadata::STORE_LABEL => 'Zip/Postal Code',
                     AttributeMetadata::MULTILINE_COUNT => 0,
                     AttributeMetadata::VALIDATION_RULES => [],
                     AttributeMetadata::VISIBLE => true,
                     AttributeMetadata::REQUIRED => false,
                     AttributeMetadata::DATA_MODEL => \Magento\Customer\Model\Attribute\Data\Postcode::class,
                     AttributeMetadata::OPTIONS => [],
                     AttributeMetadata::FRONTEND_CLASS => '',
                     AttributeMetadata::USER_DEFINED => false,
                     AttributeMetadata::SORT_ORDER => 110,
                     AttributeMetadata::FRONTEND_LABEL => 'Zip/Postal Code',
                     AttributeMetadata::NOTE => '',
                     AttributeMetadata::SYSTEM => true,
                     AttributeMetadata::BACKEND_TYPE => 'static',
                     AttributeMetadata::IS_USED_IN_GRID => true,
                     AttributeMetadata::IS_VISIBLE_IN_GRID => true,
                     AttributeMetadata::IS_FILTERABLE_IN_GRID => true,
                     AttributeMetadata::IS_SEARCHABLE_IN_GRID => true,
                     AttributeMetadata::ATTRIBUTE_CODE => 'postcode',
                 ],
             ]
         ];
     }

◆ getAttributesDataProvider()

getAttributesDataProvider ( )

Data provider for testGetAttributes.

Returns: array

Definition at line 184 of file AddressMetadataTest.php.

     {
         $attributeMetadata = $this->getAttributeMetadataDataProvider();
         return [
             [
                 'customer_address_edit',
                 $attributeMetadata[Address::POSTCODE][1],
             ]
         ];
     }

◆ testGetAllAttributesMetadata()

testGetAllAttributesMetadata ( )

Test retrieval of all address attribute metadata.

Definition at line 93 of file AddressMetadataTest.php.

     {
         $serviceInfo = [
             'rest' => [
                 'resourcePath' => self::RESOURCE_PATH,
                 'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
             ],
             'soap' => [
                 'service' => self::SERVICE_NAME,
                 'serviceVersion' => self::SERVICE_VERSION,
                 'operation' => self::SERVICE_NAME . 'GetAllAttributesMetadata',
             ],
         ];
 
         $attributeMetadata = $this->_webApiCall($serviceInfo);
         $this->assertCount(19, $attributeMetadata);
         $postcode = $this->getAttributeMetadataDataProvider()[Address::POSTCODE][1];
         $validationResult = $this->checkMultipleAttributesValidationRules($postcode, $attributeMetadata);
         list($postcode, $attributeMetadata) = $validationResult;
         $this->assertContains($postcode, $attributeMetadata);
     }

◆ testGetAttributeMetadata()

testGetAttributeMetadata	(	$attributeCode,
		$expectedMetadata
	)

Test retrieval of attribute metadata for the address entity type.

Parameters

string	$attributeCode	The attribute code of the requested metadata.
array	$expectedMetadata	Expected entity metadata for the attribute code. @dataProvider getAttributeMetadataDataProvider

Definition at line 29 of file AddressMetadataTest.php.

     {
         $serviceInfo = [
             'rest' => [
                 'resourcePath' => self::RESOURCE_PATH . "/attribute/$attributeCode",
                 'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
             ],
             'soap' => [
                 'service' => self::SERVICE_NAME,
                 'serviceVersion' => self::SERVICE_VERSION,
                 'operation' => self::SERVICE_NAME . 'GetAttributeMetadata',
             ],
         ];
 
         $requestData = [
             'attributeCode' => $attributeCode,
         ];
 
         $attributeMetadata = $this->_webapiCall($serviceInfo, $requestData);
         $validationResult = $this->checkValidationRules($expectedMetadata, $attributeMetadata);
         list($expectedMetadata, $attributeMetadata) = $validationResult;
         $this->assertEquals($expectedMetadata, $attributeMetadata);
     }

◆ testGetAttributes()

testGetAttributes	(	$formCode,
		$expectedMetadata
	)

Test retrieval of attributes

Parameters

string	$formCode	Form code
array	$expectedMetadata	The expected attribute metadata @dataProvider getAttributesDataProvider

Definition at line 148 of file AddressMetadataTest.php.

     {
         $serviceInfo = [
             'rest' => [
                 'resourcePath' => self::RESOURCE_PATH . "/form/$formCode",
                 'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
             ],
             'soap' => [
                 'service' => self::SERVICE_NAME,
                 'serviceVersion' => self::SERVICE_VERSION,
                 'operation' => self::SERVICE_NAME . 'GetAttributes',
             ],
         ];
 
         $requestData = [
             'formCode' => $formCode,
         ];
 
         $attributeMetadataList = $this->_webApiCall($serviceInfo, $requestData);
         foreach ($attributeMetadataList as $attributeMetadata) {
             if (isset($attributeMetadata['attribute_code'])
                 && $attributeMetadata['attribute_code'] == $expectedMetadata['attribute_code']
             ) {
                 $validationResult = $this->checkValidationRules($expectedMetadata, $attributeMetadata);
                 list($expectedMetadata, $attributeMetadata) = $validationResult;
                 $this->assertEquals($expectedMetadata, $attributeMetadata);
                 break;
             }
         }
     }

◆ testGetCustomAttributesMetadata()

testGetCustomAttributesMetadata ( )

Test retrieval of custom address attribute metadata.

@magentoApiDataFixture Magento/Customer/_files/attribute_user_defined_address_custom_attribute.php

Definition at line 120 of file AddressMetadataTest.php.

     {
         $customAttributeCode = 'custom_attribute1';
         $serviceInfo = [
             'rest' => [
                 'resourcePath' => self::RESOURCE_PATH . '/custom',
                 'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
             ],
             'soap' => [
                 'service' => self::SERVICE_NAME,
                 'serviceVersion' => self::SERVICE_VERSION,
                 'operation' => self::SERVICE_NAME . 'GetCustomAttributesMetadata',
             ],
         ];
 
         $requestData = ['attribute_code' => $customAttributeCode];
         $attributeMetadata = $this->_webApiCall($serviceInfo, $requestData);
         $this->assertCount(2, $attributeMetadata);
         $this->assertEquals($customAttributeCode, $attributeMetadata[0]['attribute_code']);
     }

Field Documentation

◆ RESOURCE_PATH

const RESOURCE_PATH = "/V1/attributeMetadata/customerAddress"

Definition at line 20 of file AddressMetadataTest.php.

◆ SERVICE_NAME

const SERVICE_NAME = "customerAddressMetadataV1"

Definition at line 18 of file AddressMetadataTest.php.

◆ SERVICE_VERSION

const SERVICE_VERSION = "V1"

Definition at line 19 of file AddressMetadataTest.php.

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

vendor/magento/magento2-base/dev/tests/api-functional/testsuite/Magento/Customer/Api/AddressMetadataTest.php

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ checkMultipleAttributesValidationRules()

◆ checkValidationRules()

◆ getAttributeMetadataDataProvider()

◆ getAttributesDataProvider()

◆ testGetAllAttributesMetadata()

◆ testGetAttributeMetadata()

◆ testGetAttributes()

◆ testGetCustomAttributesMetadata()

Field Documentation

◆ RESOURCE_PATH

◆ SERVICE_NAME

◆ SERVICE_VERSION