You are here

Home » API reference » Apigee Edge 8 » OauthTokenFileStorageTest.php

class OauthTokenFileStorageTest in Apigee Edge 8

OAuth cache storage tests.

@group apigee_edge @group apigee_edge_kernel

Hierarchy

Expanded class hierarchy of OauthTokenFileStorageTest

File

tests/src/Kernel/OauthTokenFileStorageTest.php, line 34

Namespace

Drupal\Tests\apigee_edge\Kernel
View source 
class OauthTokenFileStorageTest extends KernelTestBase {

  /**
   * Indicates this test class is mock API client ready.
   *
   * @var bool
   */
  protected static $mock_api_client_ready = TRUE;
  private const CUSTOM_TOKEN_DIR = 'oauth/token/dir';

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'system',
    'apigee_edge',
    'key',
  ];

  /**
   * Test token data.
   *
   * @var array
   */
  private $testTokenData = [];

  /**
   * {@inheritdoc}
   *
   * @throws \Exception
   */
  public function setUp() {
    parent::setUp();
    $this->testTokenData = [
      'access_token' => mb_strtolower($this
        ->randomMachineName(32)),
      'token_type' => 'bearer',
      'expires_in' => 300,
      'refresh_token' => mb_strtolower($this
        ->randomMachineName(32)),
      'scope' => 'create',
    ];
  }

  /**
   * Returns a pre-configured token storage service for testing.
   *
   * @param bool $rebuild
   *   Enforces rebuild of the container and with the the token storage
   *   service.
   *
   * @return \Drupal\apigee_edge\OauthTokenFileStorage
   *   The configured and initialized OAuth file token storage service.
   *
   * @throws \Exception
   */
  private function tokenStorage(bool $rebuild = FALSE) : OauthTokenFileStorage {
    $config = $this
      ->config('apigee_edge.auth');
    $config
      ->set('oauth_token_storage_location', $this
      ->tokenDirectoryUri())
      ->save();
    if ($rebuild) {
      $this->container
        ->get('kernel')
        ->rebuildContainer();
    }
    return $this->container
      ->get('apigee_edge.authentication.oauth_token_storage');
  }

  /**
   * Returns the URI of the token directory.
   *
   * @return string
   *   Token directory URI.
   */
  private function tokenDirectoryUri() : string {
    return $this->vfsRoot
      ->url() . '/' . static::CUSTOM_TOKEN_DIR;
  }

  /**
   * Returns the URI of the token file.
   *
   * @return string
   *   URI of the token file.
   */
  private function tokenFileUri() : string {
    return $this
      ->tokenDirectoryUri() . '/oauth.dat';
  }

  /**
   * Validates checks in the storage.
   */
  public function testCheckRequirements() {

    /** @var \Drupal\apigee_edge\OauthTokenFileStorage $storage */
    $storage = $this->container
      ->get('apigee_edge.authentication.oauth_token_storage');
    try {
      $storage
        ->checkRequirements();
    } catch (OauthTokenStorageException $exception) {
      $this
        ->assertEquals('Unable to save token data to private filesystem because it has not been configured yet.', $exception
        ->getMessage());
    }

    // @see \Drupal\Core\StreamWrapper\LocalStream::getLocalPath()
    $this
      ->setSetting('file_private_path', 'vfs://private');
    try {
      $storage
        ->checkRequirements();
    } catch (OauthTokenStorageException $exception) {
      $this
        ->assertEquals(sprintf('Unable to set up %s directory for token file.', OauthTokenFileStorage::DEFAULT_DIRECTORY), $exception
        ->getMessage());
    }
    $storage = $this
      ->tokenStorage(TRUE);

    // No exception should be thrown anymore.
    $storage
      ->checkRequirements();
    $this
      ->assertTrue(file_exists($this->vfsRoot
      ->getChild(static::CUSTOM_TOKEN_DIR)
      ->url()));
  }

  /**
   * Test that saving a token produces the expected file data.
   */
  public function testSaveToken() {
    $storage = $this
      ->tokenStorage();

    // Will use this to test expire.
    $current_time = time();

    // Save the token.
    $storage
      ->saveToken($this->testTokenData);

    // Load raw token data.
    $stored_token = unserialize(base64_decode(file_get_contents($this
      ->tokenFileUri())));

    // Test token values.
    $this
      ->assertSame($this->testTokenData['access_token'], $stored_token['access_token']);
    $this
      ->assertSame($this->testTokenData['token_type'], $stored_token['token_type']);
    $this
      ->assertSame($this->testTokenData['refresh_token'], $stored_token['refresh_token']);
    $this
      ->assertSame($this->testTokenData['scope'], $stored_token['scope']);

    // The difference in the timestamp should be 1 or 0 seconds.
    $this
      ->assertLessThan(2, abs($this->testTokenData['expires_in'] + $current_time - $stored_token['expires']));
  }

  /**
   * Test the token storage is using static cache.
   */
  public function testStaticCaching() {
    $storage = $this
      ->tokenStorage();

    // Save the token.
    $storage
      ->saveToken($this->testTokenData);
    $access_token = $storage
      ->getAccessToken();

    // Load raw token data.
    $stored_token = unserialize(base64_decode(file_get_contents($this
      ->tokenFileUri())));

    // Create a new access token and write it to file.
    $stored_token['access_token'] = mb_strtolower($this
      ->randomMachineName(32));
    \Drupal::service('file_system')
      ->saveData(base64_encode(serialize($stored_token)), $this
      ->tokenFileUri(), FileSystemInterface::EXISTS_REPLACE);

    // Make sure the cached version is still returned.
    $this
      ->assertSame($access_token, $storage
      ->getAccessToken());
  }

  /**
   * Test the get and has methods of the cache storage.
   */
  public function testGetters() {
    $storage = $this
      ->tokenStorage();

    // Will use this to test expire.
    $current_time = time();

    // Save the token.
    $storage
      ->saveToken($this->testTokenData);
    $this
      ->assertSame($this->testTokenData['access_token'], $storage
      ->getAccessToken());
    $this
      ->assertSame($this->testTokenData['token_type'], $storage
      ->getTokenType());
    $this
      ->assertSame($this->testTokenData['refresh_token'], $storage
      ->getRefreshToken());
    $this
      ->assertSame($this->testTokenData['scope'], $storage
      ->getScope());

    // The difference in the timestamp should be 1 or 0 seconds.
    $this
      ->assertLessThan(2, abs($this->testTokenData['expires_in'] + $current_time - $storage
      ->getExpires()));

    // The token should still be valid for 5 minutes.
    $this
      ->assertFalse($storage
      ->hasExpired());

    // Expire token.
    $storage
      ->markExpired();

    // The token should not be valid anymore.
    $this
      ->assertTrue($storage
      ->hasExpired());
  }

  /**
   * Test that the tokens are removed when cache is cleared.
   */
  public function testCacheClear() {
    $storage = $this
      ->tokenStorage();

    // Save the token.
    $storage
      ->saveToken($this->testTokenData);
    $this
      ->assertNotEmpty($storage
      ->getAccessToken());
    drupal_flush_all_caches();
    $this
      ->assertEmpty($storage
      ->getAccessToken());
  }

  /**
   * Tests OAuth token data file removal on module uninstall.
   */
  public function testTokenFileRemovalOnUninstall() {
    $storage = $this
      ->tokenStorage();

    // Save the token.
    $storage
      ->saveToken($this->testTokenData);
    $this
      ->assertTrue(file_exists($this
      ->tokenFileUri()), 'Oauth token data file should not exist after the module got uninstalled.');

    /** @var \Drupal\Core\Extension\ModuleInstallerInterface $installer */
    $installer = $this->container
      ->get('module_installer');
    $installer
      ->uninstall([
      'apigee_edge',
    ]);
    $this
      ->assertFalse(file_exists($this
      ->tokenFileUri()), 'Oauth token data file should not exist after the module got uninstalled.');
  }

  /**
   * {@inheritdoc}
   */
  public function register(ContainerBuilder $container) {
    parent::register($container);

    // The private:// scheme is the default scheme used by the token storage
    // therefore it has to be available but we are going to use vfs:// in tests.
    $container
      ->register('stream_wrapper.private', 'Drupal\\Core\\StreamWrapper\\PrivateStream')
      ->addTag('stream_wrapper', [
      'scheme' => 'private',
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
OauthTokenFileStorageTest::$mock_api_client_ready protected static property Indicates this test class is mock API client ready.
OauthTokenFileStorageTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
OauthTokenFileStorageTest::$testTokenData private property Test token data.
OauthTokenFileStorageTest::CUSTOM_TOKEN_DIR private constant
OauthTokenFileStorageTest::register public function Registers test-specific services. Overrides KernelTestBase::register
OauthTokenFileStorageTest::setUp public function Overrides KernelTestBase::setUp
OauthTokenFileStorageTest::testCacheClear public function Test that the tokens are removed when cache is cleared.
OauthTokenFileStorageTest::testCheckRequirements public function Validates checks in the storage.
OauthTokenFileStorageTest::testGetters public function Test the get and has methods of the cache storage.
OauthTokenFileStorageTest::testSaveToken public function Test that saving a token produces the expected file data.
OauthTokenFileStorageTest::testStaticCaching public function Test the token storage is using static cache.
OauthTokenFileStorageTest::testTokenFileRemovalOnUninstall public function Tests OAuth token data file removal on module uninstall.
OauthTokenFileStorageTest::tokenDirectoryUri private function Returns the URI of the token directory.
OauthTokenFileStorageTest::tokenFileUri private function Returns the URI of the token file.
OauthTokenFileStorageTest::tokenStorage private function Returns a pre-configured token storage service for testing.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.