RestTest Class Reference

Inheritance diagram for RestTest:

Public Member Functions
	testGetRequestTokenInvalidConsumerKey ()
	testGetRequestTokenInvalidConsumerSecret ()
	testGetAccessToken ()
	testGetAccessTokenInvalidVerifier ()
	testGetAccessTokenConsumerMismatch ()
	testAccessApiInvalidAccessToken ()
Public Member Functions inherited from WebapiAbstract
	addModelToDelete ($model, $secure=false)
	processRestExceptionResult (\Exception $e)

Static Public Member Functions
static	consumerFixture ($date=null)
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
	setUp ()
	tearDown ()
	_getOauthClient ($consumerKey, $consumerSecret)
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
	$_oAuthClients = []
Protected Attributes inherited from WebapiAbstract
	$_appCache
	$_modelsToDelete = []
	$_origConfigValues = []
	$_webApiAdapters
	$_webApiAdaptersMap

Static Protected Attributes
static	$_consumer
static	$_token
static	$_consumerKey
static	$_consumerSecret
static	$_verifier
Static Protected Attributes inherited from WebapiAbstract
static	$_fixturesNamespace
static	$_fixtures = []
static	$_methodLevelFixtures = []
static	$_classLevelFixtures = []

Additional Inherited Members
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)

Detailed Description

@magentoApiDataFixture consumerFixture

Definition at line 13 of file RestTest.php.

Member Function Documentation

_getOauthClient()

_getOauthClient (   $consumerKey,   $consumerSecret  )

protected

Definition at line 197 of file RestTest.php.

    {
        if (!isset($this->_oAuthClients[$consumerKey])) {
            $credentials = new \OAuth\Common\Consumer\Credentials($consumerKey, $consumerSecret, TESTS_BASE_URL);
            $this->_oAuthClients[$consumerKey] = new \Magento\TestFramework\Authentication\Rest\OauthClient(
                $credentials
            );
        }
        return $this->_oAuthClients[$consumerKey];
    }

consumerFixture()

static consumerFixture (   $date = null )

static

Create a consumer

Clear the credentials because during the fixture generation, any previous credentials are invalidated

Definition at line 42 of file RestTest.php.

    {
        \Magento\TestFramework\Authentication\OauthHelper::clearApiAccessCredentials();

        $consumerCredentials = \Magento\TestFramework\Authentication\OauthHelper::getConsumerCredentials($date);
        self::$_consumerKey = $consumerCredentials['key'];
        self::$_consumerSecret = $consumerCredentials['secret'];
        self::$_verifier = $consumerCredentials['verifier'];
        self::$_consumer = $consumerCredentials['consumer'];
        self::$_token = $consumerCredentials['token'];
    }

setUp()

setUp ( )

protected

Definition at line 33 of file RestTest.php.

    {
        $this->_markTestAsRestOnly();
        parent::setUp();
    }

tearDown()

tearDown ( )

protected

Definition at line 55 of file RestTest.php.

    {
        parent::tearDown();
        $this->_oAuthClients = [];
        if (isset(self::$_consumer)) {
            self::$_consumer->delete();
            self::$_token->delete();
        }
    }

testAccessApiInvalidAccessToken()

testAccessApiInvalidAccessToken

(

)

@expectedException \Exception @expectedExceptionMessage 400 Bad Request

Definition at line 184 of file RestTest.php.

    {
        $oAuthClient = $this->_getOauthClient(self::$_consumerKey, self::$_consumerSecret);
        $requestToken = $oAuthClient->requestRequestToken();
        $accessToken = $oAuthClient->requestAccessToken(
            $requestToken->getRequestToken(),
            self::$_verifier,
            $requestToken->getRequestTokenSecret()
        );
        $accessToken->setAccessToken('invalid');
        $oAuthClient->validateAccessToken($accessToken);
    }

testGetAccessToken()

testGetAccessToken

(

)

Definition at line 120 of file RestTest.php.

    {
        $oAuthClient = $this->_getOauthClient(self::$_consumerKey, self::$_consumerSecret);
        $requestToken = $oAuthClient->requestRequestToken();
        $accessToken = $oAuthClient->requestAccessToken(
            $requestToken->getRequestToken(),
            self::$_verifier,
            $requestToken->getRequestTokenSecret()
        );
        $this->assertNotEmpty($accessToken->getAccessToken(), "Access token value is not set.");
        $this->assertNotEmpty($accessToken->getAccessTokenSecret(), "Access token secret is not set.");

        $this->assertEquals(
            \Magento\Framework\Oauth\Helper\Oauth::LENGTH_TOKEN,
            strlen($accessToken->getAccessToken()),
            "Access token value length should be " . \Magento\Framework\Oauth\Helper\Oauth::LENGTH_TOKEN
        );
        $this->assertEquals(
            \Magento\Framework\Oauth\Helper\Oauth::LENGTH_TOKEN_SECRET,
            strlen($accessToken->getAccessTokenSecret()),
            "Access token secret length should be " . \Magento\Framework\Oauth\Helper\Oauth::LENGTH_TOKEN_SECRET
        );
    }

testGetAccessTokenConsumerMismatch()

testGetAccessTokenConsumerMismatch

(

)

@expectedException \Exception @expectedExceptionMessage 401 Unauthorized

Definition at line 163 of file RestTest.php.

    {
        $oAuthClientA = $this->_getOauthClient(self::$_consumerKey, self::$_consumerSecret);
        $requestTokenA = $oAuthClientA->requestRequestToken();
        $oauthVerifierA = self::$_verifier;

        self::consumerFixture();
        $oAuthClientB = $this->_getOauthClient(self::$_consumerKey, self::$_consumerSecret);
        $oAuthClientB->requestRequestToken();

        $oAuthClientB->requestAccessToken(
            $requestTokenA->getRequestToken(),
            $oauthVerifierA,
            $requestTokenA->getRequestTokenSecret()
        );
    }

testGetAccessTokenInvalidVerifier()

testGetAccessTokenInvalidVerifier

(

)

@expectedException \Exception @expectedExceptionMessage 401 Unauthorized

Definition at line 148 of file RestTest.php.

    {
        $oAuthClient = $this->_getOauthClient(self::$_consumerKey, self::$_consumerSecret);
        $requestToken = $oAuthClient->requestRequestToken();
        $oAuthClient->requestAccessToken(
            $requestToken->getRequestToken(),
            'invalid verifier',
            $requestToken->getRequestTokenSecret()
        );
    }

testGetRequestTokenInvalidConsumerKey()

testGetRequestTokenInvalidConsumerKey

(

)

@expectedException \Exception @expectedExceptionMessage 401 Unauthorized

Definition at line 104 of file RestTest.php.

    {
        $oAuthClient = $this->_getOauthClient('invalid_key', self::$_consumerSecret);
        $oAuthClient->requestRequestToken();
    }

testGetRequestTokenInvalidConsumerSecret()

testGetRequestTokenInvalidConsumerSecret

(

)

@expectedException \Exception @expectedExceptionMessage 401 Unauthorized

Definition at line 114 of file RestTest.php.

    {
        $oAuthClient = $this->_getOauthClient(self::$_consumerKey, 'invalid_secret');
        $oAuthClient->requestRequestToken();
    }

Field Documentation

$_consumer

$_consumer

staticprotected

Definition at line 19 of file RestTest.php.

$_consumerKey

$_consumerKey

staticprotected

Definition at line 25 of file RestTest.php.

$_consumerSecret

$_consumerSecret

staticprotected

Definition at line 28 of file RestTest.php.

$_oAuthClients

$_oAuthClients = []

protected

Definition at line 16 of file RestTest.php.

$_token

$_token

staticprotected

Definition at line 22 of file RestTest.php.

$_verifier

$_verifier

staticprotected

Definition at line 31 of file RestTest.php.

---

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

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