BaseService Class Reference

Inheritance diagram for BaseService:

Protected Member Functions
	assertUnauthorizedException ($serviceInfo, $requestData=null)
	_assertRestUnauthorizedException ($serviceInfo, $requestData=null)
	_assertNoRouteOrOperationException ($serviceInfo, $requestData=null)
	_assertNoRestRouteException ($serviceInfo, $requestData=null)
	_assertSoapException ($serviceInfo, $requestData=null, $expectedMessage='')
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)

Additional Inherited Members
Public Member Functions inherited from WebapiAbstract
	addModelToDelete ($model, $secure=false)
	processRestExceptionResult (\Exception $e)
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)
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

Base class for all Service based routing tests

Definition at line 14 of file BaseService.php.

Member Function Documentation

_assertNoRestRouteException()

_assertNoRestRouteException (   $serviceInfo,   $requestData = null  )

protected

Invoke the REST api and assert for test cases that no such REST route exist

Parameters

array	$serviceInfo
array | null	$requestData

Definition at line 80 of file BaseService.php.

    {
        try {
            $this->_webApiCall($serviceInfo, $requestData);
        } catch (\Exception $e) {
            $error = json_decode($e->getMessage(), true);
            $this->assertEquals('Request does not match any route.', $error['message']);
            $this->assertEquals(WebapiException::HTTP_NOT_FOUND, $e->getCode());
        }
    }

_assertNoRouteOrOperationException()

_assertNoRouteOrOperationException (   $serviceInfo,   $requestData = null  )

protected

Check a particular adapter and assert the exception

Parameters

array	$serviceInfo
array | null	$requestData

Definition at line 65 of file BaseService.php.

    {
        if (TESTS_WEB_API_ADAPTER == self::ADAPTER_SOAP) {
            $this->_assertSoapException($serviceInfo, $requestData);
        } elseif (TESTS_WEB_API_ADAPTER == self::ADAPTER_REST) {
            $this->_assertNoRestRouteException($serviceInfo, $requestData);
        }
    }

_assertRestUnauthorizedException()

_assertRestUnauthorizedException (   $serviceInfo,   $requestData = null  )

protected

Invoke the REST api and assert access is unauthorized

Parameters

array	$serviceInfo
array | null	$requestData

Definition at line 41 of file BaseService.php.

    {
        try {
            $this->_webApiCall($serviceInfo, $requestData);
        } catch (\Exception $e) {
            $this->assertContains(
                '{"message":"The consumer isn\'t authorized to access %resources.',
                $e->getMessage(),
                sprintf(
                    'REST routing did not fail as expected for the method "%s" of service "%s"',
                    $serviceInfo['rest']['httpMethod'],
                    $serviceInfo['rest']['resourcePath']
                )
            );
            $this->assertEquals(WebapiException::HTTP_UNAUTHORIZED, $e->getCode());
        }
    }

_assertSoapException()

_assertSoapException (   $serviceInfo,   $requestData = null,   $expectedMessage = ''  )

protected

Invoke the SOAP api and assert for the NoWebApiXmlTestTest test cases that no such SOAP route exists

Parameters

array	$serviceInfo
array | null	$requestData
string	$expectedMessage

Definition at line 98 of file BaseService.php.

    {
        try {
            $this->_webApiCall($serviceInfo, $requestData);
        } catch (\Exception $e) {
            if (get_class($e) !== 'SoapFault') {
                $this->fail(
                    sprintf(
                        'Expected SoapFault exception not generated for Service - "%s" and Operation - "%s"',
                        $serviceInfo['soap']['service'],
                        $serviceInfo['soap']['operation']
                    )
                );
            }

            if ($expectedMessage) {
                $this->assertContains($expectedMessage, $e->getMessage());
            }
        }
    }

assertUnauthorizedException()

assertUnauthorizedException (   $serviceInfo,   $requestData = null  )

protected

Check a particular adapter and assert unauthorized access

Parameters

array	$serviceInfo
array | null	$requestData

Definition at line 22 of file BaseService.php.

    {
        if (TESTS_WEB_API_ADAPTER == self::ADAPTER_SOAP) {
            $this->_assertSoapException(
                $serviceInfo,
                $requestData,
                "The consumer isn't authorized to access %resources."
            );
        } elseif (TESTS_WEB_API_ADAPTER == self::ADAPTER_REST) {
            $this->_assertRestUnauthorizedException($serviceInfo, $requestData);
        }
    }

---

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

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