You are here

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

class EntityControllerCacheTest in Apigee Edge 8

Same name in this branch
  1. 8 tests/src/Kernel/EntityControllerCacheTest.php \Drupal\Tests\apigee_edge\Kernel\EntityControllerCacheTest
  2. 8 modules/apigee_edge_teams/tests/src/Kernel/EntityControllerCacheTest.php \Drupal\Tests\apigee_edge_teams\Kernel\EntityControllerCacheTest

Apigee Edge entity controller cache tests.

@group apigee_edge @group apigee_edge_kernel

Hierarchy

Expanded class hierarchy of EntityControllerCacheTest

File

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

Namespace

Drupal\Tests\apigee_edge\Kernel
View source 
class EntityControllerCacheTest extends KernelTestBase {
  use EntityControllerCacheUtilsTrait;

  /**
   * Indicates this test class is mock API client ready.
   *
   * @var bool
   */
  protected static $mock_api_client_ready = TRUE;

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

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('user');
  }

  /**
   * Tests developer entity controller cache.
   */
  public function testDeveloperEntityControllerCache() {
    $developer_cache = $this->container
      ->get('apigee_edge.controller.cache.developer');
    $developer_id_cache = $this->container
      ->get('apigee_edge.controller.cache.developer_ids');

    // Generate developer entities with random data.
    $developers = [];
    for ($i = 0; $i < 3; $i++) {
      $id = $this
        ->getRandomUniqueId();
      $developers[$id] = new Developer([
        'developerId' => $id,
        'email' => strtolower($this
          ->randomMachineName()) . '@example.com',
      ]);
    }
    $this
      ->saveAllEntitiesAndValidate($developers, $developer_cache, $developer_id_cache);

    /** @var \Apigee\Edge\Api\Management\Entity\DeveloperInterface $developer */
    foreach ($developers as $developer) {

      // Load developer by email and by id.
      $this
        ->assertSame($developer, $developer_cache
        ->getEntity($developer
        ->getEmail()));
      $this
        ->assertSame($developer, $developer_cache
        ->getEntity($developer
        ->getDeveloperId()));
      $this
        ->assertContains($developer
        ->getEmail(), $developer_id_cache
        ->getIds());

      // Pass an invalid entity id to ensure it does not cause any trouble
      // anymore.
      // @see \Drupal\apigee_edge\Entity\Controller\Cache\EntityCache::removeEntities()
      // @see https://www.drupal.org/project/drupal/issues/3017753
      $developer_cache
        ->removeEntities([
        $developer
          ->getDeveloperId(),
        $this
          ->getRandomGenerator()
          ->string(),
      ]);
      $this
        ->assertNull($developer_cache
        ->getEntity($developer
        ->getEmail()));
      $this
        ->assertNull($developer_cache
        ->getEntity($developer
        ->getDeveloperId()));
      $this
        ->assertNotContains($developer
        ->getEmail(), $developer_id_cache
        ->getIds());
    }
    $this
      ->assertEmptyCaches($developer_cache, $developer_id_cache);
  }

  /**
   * Tests app entity controller cache.
   */
  public function testAppEntityControllerCache() {
    $app_cache = $this->container
      ->get('apigee_edge.controller.cache.apps');
    $app_id_cache = $this->container
      ->get('apigee_edge.controller.cache.app_ids');

    // Generate developer app entities with random data.
    $developer_apps = [];
    $parent_id = $this
      ->getRandomUniqueId();
    for ($i = 0; $i < 2; $i++) {
      $id = $this
        ->getRandomUniqueId();
      $developer_apps[$id] = new DeveloperApp([
        'appId' => $id,
        'name' => $this
          ->getRandomGenerator()
          ->name(),
        'developerId' => $parent_id,
      ]);
    }

    // Generate company app entities with random data.
    $company_apps = [];
    $parent_id = $this
      ->getRandomUniqueId();
    for ($i = 0; $i < 2; $i++) {
      $id = $this
        ->getRandomUniqueId();
      $company_apps[$id] = new CompanyApp([
        'appId' => $id,
        'name' => $this
          ->getRandomGenerator()
          ->name(),
        'companyName' => $parent_id,
      ]);
    }
    $apps = $developer_apps + $company_apps;
    $this
      ->saveAllEntitiesAndValidate($apps, $app_cache, $app_id_cache);

    /** @var \Apigee\Edge\Api\Management\Entity\AppInterface $app */
    foreach ($apps as $app) {

      // Load app by id and by owner (developer uuid or company name).
      $this
        ->assertSame($app, $app_cache
        ->getEntity($app
        ->getAppId()));
      $this
        ->assertContains($app, $app_cache
        ->getAppsByOwner($app_cache
        ->getAppOwner($app)));
      $this
        ->assertContains($app
        ->getAppId(), $app_id_cache
        ->getIds());
    }

    // Remove apps from cache by owner.
    $app_cache
      ->removeAppsByOwner(reset($developer_apps)
      ->getDeveloperId());
    $app_cache
      ->removeAppsByOwner(reset($company_apps)
      ->getCompanyName());
    foreach ($apps as $app) {
      $this
        ->assertNull($app_cache
        ->getEntity($app
        ->getAppId()));
      $this
        ->assertNull($app_cache
        ->getAppsByOwner($app_cache
        ->getAppOwner($app)));
      $this
        ->assertNotContains($app
        ->getAppId(), $app_id_cache
        ->getIds());
    }
    $this
      ->assertEmptyCaches($app_cache, $app_id_cache);
  }

  /**
   * Tests developer app entity controller cache.
   */
  public function testDeveloperAppEntityControllerCache() {
    $developer_app_cache_factory = $this->container
      ->get('apigee_edge.entity.controller.cache.developer_app_cache_factory');

    // Owner of the developer apps. It should be saved into the developer cache
    // because developer app cache tries to load the owner email from the
    // developer cache to reduce API calls.
    $developer = new Developer([
      'developerId' => $this
        ->getRandomUniqueId(),
      'email' => strtolower($this
        ->randomMachineName()) . '@example.com',
    ]);
    $developer_cache = $this->container
      ->get('apigee_edge.controller.cache.developer');
    $developer_cache
      ->saveEntities([
      $developer,
    ]);
    $developer_apps = [];
    for ($i = 0; $i < 2; $i++) {
      $id = $this
        ->getRandomUniqueId();
      $developer_apps[$id] = new DeveloperApp([
        'appId' => $id,
        'name' => $this
          ->getRandomGenerator()
          ->name(),
        'developerId' => $developer
          ->getDeveloperId(),
      ]);
    }
    list($developer_app_1, $developer_app_2) = array_values($developer_apps);
    $cache_by_email = $developer_app_cache_factory
      ->getAppCache($developer
      ->getEmail());
    $cache_by_id = $developer_app_cache_factory
      ->getAppCache($developer
      ->getDeveloperId());
    $cache_by_email
      ->saveEntities([
      $developer_app_1,
    ]);
    $cache_by_id
      ->saveEntities([
      $developer_app_2,
    ]);
    $this
      ->assertSame($developer_apps, $cache_by_email
      ->getEntities());
    $this
      ->assertSame($developer_apps, $cache_by_id
      ->getEntities());

    /** @var \Apigee\Edge\Api\Management\Entity\DeveloperAppInterface $developer_app */
    foreach ($developer_apps as $developer_app) {

      // Load developer app by name.
      $this
        ->assertSame($developer_app, $cache_by_email
        ->getEntity($developer_app
        ->getName()));
      $this
        ->assertSame($developer_app, $cache_by_id
        ->getEntity($developer_app
        ->getName()));
    }

    // Remove developer app by name from developer app cache by email.
    $cache_by_email
      ->removeEntities([
      $developer_app_1
        ->getName(),
    ]);
    $this
      ->assertNull($cache_by_email
      ->getEntity($developer_app_1
      ->getName()));
    $this
      ->assertNull($cache_by_id
      ->getEntity($developer_app_1
      ->getName()));

    // Remove developer app by name from developer app cache by id.
    $cache_by_id
      ->removeEntities([
      $developer_app_2
        ->getName(),
    ]);
    $this
      ->assertNull($cache_by_email
      ->getEntity($developer_app_2
      ->getName()));
    $this
      ->assertNull($cache_by_id
      ->getEntity($developer_app_2
      ->getName()));
    $this
      ->assertEmpty($cache_by_email
      ->getEntities());
    $this
      ->assertEmpty($cache_by_id
      ->getEntities());
  }

}

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.
EntityControllerCacheTest::$mock_api_client_ready protected static property Indicates this test class is mock API client ready.
EntityControllerCacheTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
EntityControllerCacheTest::setUp protected function Overrides KernelTestBase::setUp
EntityControllerCacheTest::testAppEntityControllerCache public function Tests app entity controller cache.
EntityControllerCacheTest::testDeveloperAppEntityControllerCache public function Tests developer app entity controller cache.
EntityControllerCacheTest::testDeveloperEntityControllerCache public function Tests developer entity controller cache.
EntityControllerCacheUtilsTrait::assertEmptyCaches protected function Checks whether the cache is properly cleared.
EntityControllerCacheUtilsTrait::getRandomUniqueId protected function Gets a random unique ID.
EntityControllerCacheUtilsTrait::saveAllEntitiesAndValidate protected function Saves entities into the entity cache and checks the result.
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::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
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.
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.