PartialResponseTest Class Reference

Inheritance diagram for PartialResponseTest:

Public Member Functions
	testCustomerWithEmailFilter ()
	testCustomerWithEmailAndAddressFilter ()
	testCustomerWithNestedAddressFilter ()
	testCustomerInvalidFilter ()
	testFilterForCustomerApiWithSimpleResponse ()
Public Member Functions inherited from WebapiAbstract
	addModelToDelete ($model, $secure=false)
	processRestExceptionResult (\Exception $e)

Protected Member Functions
	setUp ()
	_getCustomerWithFilter ($filter, $customerId, $path='')
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
	$customerHelper
	$customerData
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

Definition at line 13 of file PartialResponseTest.php.

Member Function Documentation

_getCustomerWithFilter()

_getCustomerWithFilter (   $filter,   $customerId,   $path = ''  )

protected

Definition at line 80 of file PartialResponseTest.php.

    {
        $resourcePath = sprintf(
            '%s/%d%s?fields=%s',
            AccountManagementTest::RESOURCE_PATH,
            $customerId,
            $path,
            $filter
        );

        $serviceInfo = [
            'rest' => [
                'resourcePath' => $resourcePath,
                'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
            ],
        ];

        return $this->_webApiCall($serviceInfo);
    }

setUp()

setUp ( )

protected

Definition at line 21 of file PartialResponseTest.php.

    {
        $this->_markTestAsRestOnly('Partial response functionality available in REST mode only.');

        $this->customerHelper = Bootstrap::getObjectManager()
            ->get(\Magento\TestFramework\Helper\Customer::class);

        $this->customerData = $this->customerHelper->createSampleCustomer();
    }

testCustomerInvalidFilter()

testCustomerInvalidFilter

(

)

Definition at line 66 of file PartialResponseTest.php.

    {
        // Invalid filter should return an empty result
        $result = $this->_getCustomerWithFilter('invalid', $this->customerData['id']);
        $this->assertEmpty($result);
    }

testCustomerWithEmailAndAddressFilter()

testCustomerWithEmailAndAddressFilter

(

)

Definition at line 39 of file PartialResponseTest.php.

    {
        $filter = 'email,addresses[city]';
        $expected = [
            'email' => $this->customerData['email'],
            'addresses' => [
                ['city' => CustomerHelper::ADDRESS_CITY1],
                ['city' => CustomerHelper::ADDRESS_CITY2],
            ],
        ];
        $result = $this->_getCustomerWithFilter($filter, $this->customerData['id']);
        $this->assertEquals($expected, $result);
    }

testCustomerWithEmailFilter()

testCustomerWithEmailFilter

(

)

Definition at line 31 of file PartialResponseTest.php.

    {
        $filter = 'email';
        $expected = ['email' => $this->customerData['email']];
        $result = $this->_getCustomerWithFilter($filter, $this->customerData['id']);
        $this->assertEquals($expected, $result);
    }

testCustomerWithNestedAddressFilter()

testCustomerWithNestedAddressFilter

(

)

Definition at line 53 of file PartialResponseTest.php.

    {
        $filter = 'addresses[region[region_code]]';
        $expected = [
            'addresses' => [
                ['region' => ['region_code' => CustomerHelper::ADDRESS_REGION_CODE1]],
                ['region' => ['region_code' => CustomerHelper::ADDRESS_REGION_CODE2]],
            ],
        ];
        $result = $this->_getCustomerWithFilter($filter, $this->customerData['id']);
        $this->assertEquals($expected, $result);
    }

testFilterForCustomerApiWithSimpleResponse()

testFilterForCustomerApiWithSimpleResponse

(

)

Definition at line 73 of file PartialResponseTest.php.

    {
        $result = $this->_getCustomerWithFilter('customers', $this->customerData['id'], '/permissions/readonly');
        // assert if filter is ignored and a normal response is returned
        $this->assertFalse($result);
    }

Field Documentation

$customerData

$customerData

protected

Definition at line 19 of file PartialResponseTest.php.

$customerHelper

$customerHelper

protected

Definition at line 16 of file PartialResponseTest.php.

---

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

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