class CacheDecoratorTest

Tests \Drupal\Core\Plugin\Discovery\CacheDecorator behavior.

Hierarchy

Expanded class hierarchy of CacheDecoratorTest

File

drupal/core/modules/system/lib/Drupal/system/Tests/Plugin/CacheDecoratorTest.php, line 19
Contains \Drupal\system\Tests\Plugin\CacheDecoratorTest.

Namespace

Drupal\system\Tests\Plugin
View source
class CacheDecoratorTest extends DiscoveryTestBase {

  /**
   * The cache bin.
   *
   * @var string
   */
  protected $cacheBin = 'test_cacheDecorator';

  /**
   * The cache key.
   *
   * @var string
   */
  protected $cacheKey = 'test_cacheDecorator';
  public static function getInfo() {
    return array(
      'name' => 'CacheDecorator',
      'description' => 'Tests the CacheDecorator.',
      'group' => 'Plugin API',
    );
  }
  public function setUp() {
    global $conf;
    parent::setUp();

    // Use a non-db cache backend, so that we can use DiscoveryTestBase (which
    // extends UnitTestBase).
    // @todo switch to injecting the MemoryBackend http://drupal.org/node/1903346
    drupal_container()
      ->set("cache.{$this->cacheBin}", new MemoryBackend($this->cacheBin));

    // Create discovery objects to test.
    $this->emptyDiscovery = new StaticDiscovery();
    $this->emptyDiscovery = new CacheDecorator($this->emptyDiscovery, $this->cacheKey . '_empty', $this->cacheBin);
    $this->discovery = new StaticDiscovery();
    $this->discovery = new CacheDecorator($this->discovery, $this->cacheKey, $this->cacheBin);

    // Populate sample definitions.
    $this->expectedDefinitions = array(
      'apple' => array(
        'label' => 'Apple',
        'color' => 'green',
      ),
      'cherry' => array(
        'label' => 'Cherry',
        'color' => 'red',
      ),
      'orange' => array(
        'label' => 'Orange',
        'color' => 'orange',
      ),
    );
    foreach ($this->expectedDefinitions as $plugin_id => $definition) {
      $this->discovery
        ->setDefinition($plugin_id, $definition);
    }
  }

  /**
   * Tests that discovered definitions are properly cached.
   *
   * This comes in addition to DiscoveryTestBase::testDiscoveryInterface(),
   * that test the basic discovery behavior.
   */
  public function testCachedDefinitions() {
    $cache = cache($this->cacheBin);

    // Check that nothing is cached initially.
    $cached = $cache
      ->get($this->cacheKey);
    $this
      ->assertIdentical($cached, FALSE, 'Cache is empty.');

    // Get the definitions once, and check that they are present in the cache.
    $definitions = $this->discovery
      ->getDefinitions();
    $this
      ->assertIdentical($definitions, $this->expectedDefinitions, 'Definitions are correctly retrieved.');
    $cached = $cache
      ->get($this->cacheKey);
    $this
      ->assertIdentical($cached->data, $this->expectedDefinitions, 'Definitions are cached.');

    // Check that the definitions are also cached in memory. Since the
    // CacheDecorator::definitions property is protected, this is tested "from
    // the outside" by wiping the cache entry, getting the definitions, and
    // checking that the cache entry was not regenerated (thus showing that
    // defintions were not fetched from the decorated discovery).
    $cache
      ->delete($this->cacheKey);
    $definitions = $this->discovery
      ->getDefinitions();
    $cached = $cache
      ->get($this->cacheKey);
    $this
      ->assertIdentical($cached, FALSE, 'Cache is empty.');
    $this
      ->assertIdentical($definitions, $this->expectedDefinitions, 'Definitions are cached in memory.');
  }

  /**
   * Tests CacheDecorator::clearCachedDefinitions().
   */
  public function testClearCachedDefinitions() {
    $cache = cache($this->cacheBin);

    // Populate the caches by collecting definitions once.
    $this->discovery
      ->getDefinitions();

    // Add a new definition.
    $this->expectedDefinitions['banana'] = array(
      'label' => 'Banana',
      'color' => 'yellow',
    );
    $this->discovery
      ->setDefinition('banana', $this->expectedDefinitions['banana']);

    // Check that the new definition is not found.
    $definition = $this->discovery
      ->getDefinition('banana');
    $this
      ->assertNull($definition, 'Newly added definition is not found.');

    // Clear cached definitions, and check that the new definition is found.
    $this->discovery
      ->clearCachedDefinitions();
    $cached = $cache
      ->get($this->cacheKey);
    $this
      ->assertIdentical($cached, FALSE, 'Cache is empty.');
    $definitions = $this->discovery
      ->getDefinitions();
    $this
      ->assertIdentical($definitions, $this->expectedDefinitions, 'Newly added definition is found.');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CacheDecoratorTest::$cacheBin protected property The cache bin.
CacheDecoratorTest::$cacheKey protected property The cache key.
CacheDecoratorTest::getInfo public static function
CacheDecoratorTest::setUp public function Sets up unit test environment. Overrides UnitTestBase::setUp
CacheDecoratorTest::testCachedDefinitions public function Tests that discovered definitions are properly cached.
CacheDecoratorTest::testClearCachedDefinitions public function Tests CacheDecorator::clearCachedDefinitions().
DiscoveryTestBase::$discovery protected property The discovery component to test.
DiscoveryTestBase::$emptyDiscovery protected property An empty discovery component.
DiscoveryTestBase::$expectedDefinitions protected property The plugin definitions the discovery component is expected to discover.
DiscoveryTestBase::testDiscoveryInterface function Tests getDefinitions() and getDefinition().
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 1
TestBase::$container protected property The dependency injection container used in the test. 1
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalSettings protected property The settings array.
TestBase::$public_files_directory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$setup protected property Flag to indicate whether the test has been set up.
TestBase::$setupDatabasePrefix protected property
TestBase::$setupEnvironment protected property
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$verbose protected property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertFalse protected function Check to see if a value is false (an empty string, 0, NULL, or FALSE).
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
TestBase::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 4
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 1
TestBase::copyConfig public function Copies configuration objects from source storage to target storage.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 1
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareConfigDirectories protected function Create and set new configuration directories. 1
TestBase::prepareDatabasePrefix protected function Generates a database prefix for running tests.
TestBase::prepareEnvironment protected function Prepares the current environment for running the test.
TestBase::randomName public static function Generates a random string containing letters and numbers.
TestBase::randomObject public static function Generates a random PHP object.
TestBase::randomString public static function Generates a random string of ASCII characters of codes 32 to 126.
TestBase::rebuildContainer protected function Rebuild drupal_container(). 1
TestBase::run public function Run all tests in this class.
TestBase::settingsSet protected function Changes in memory settings.
TestBase::tearDown protected function Deletes created files, database tables, and reverts all environment changes. 9
TestBase::verbose protected function Logs verbose message in a text file.
UnitTestBase::$configDirectories protected property
UnitTestBase::__construct function Constructor for UnitTestBase. Overrides TestBase::__construct 4