abstract class GenericCacheBackendUnitTestBase in Drupal 9

Same name and namespace in other branches

8 core/tests/Drupal/KernelTests/Core/Cache/GenericCacheBackendUnitTestBase.php \Drupal\KernelTests\Core\Cache\GenericCacheBackendUnitTestBase

Tests any cache backend.

Full generic unit test suite for any cache backend. In order to use it for a cache backend implementation, extend this class and override the createBackendInstance() method to return an object.

For a full working implementation.

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\KernelTests\Core\Cache\GenericCacheBackendUnitTestBase

Expanded class hierarchy of GenericCacheBackendUnitTestBase

File

core/tests/Drupal/KernelTests/Core/Cache/GenericCacheBackendUnitTestBase.php, line 19

Namespace

Drupal\KernelTests\Core\Cache

View source

abstract class GenericCacheBackendUnitTestBase extends KernelTestBase {

  /**
   * Array of objects implementing Drupal\Core\Cache\CacheBackendInterface.
   *
   * @var array
   */
  protected $cachebackends;

  /**
   * Cache bin to use for testing.
   *
   * @var string
   */
  protected $testBin;

  /**
   * Random value to use in tests.
   *
   * @var string
   */
  protected $defaultValue;

  /**
   * Gets the testing bin.
   *
   * Override this method if you want to work on a different bin than the
   * default one.
   *
   * @return string
   *   Bin name.
   */
  protected function getTestBin() {
    if (!isset($this->testBin)) {
      $this->testBin = 'page';
    }
    return $this->testBin;
  }

  /**
   * Creates a cache backend to test.
   *
   * Override this method to test a CacheBackend.
   *
   * @param string $bin
   *   Bin name to use for this backend instance.
   *
   * @return \Drupal\Core\Cache\CacheBackendInterface
   *   Cache backend to test.
   */
  protected abstract function createCacheBackend($bin);

  /**
   * Allows specific implementation to change the environment before a test run.
   */
  public function setUpCacheBackend() {
  }

  /**
   * Allows alteration of environment after a test run but before tear down.
   *
   * Used before the real tear down because the tear down will change things
   * such as the database prefix.
   */
  public function tearDownCacheBackend() {
  }

  /**
   * Gets a backend to test; this will get a shared instance set in the object.
   *
   * @return \Drupal\Core\Cache\CacheBackendInterface
   *   Cache backend to test.
   */
  protected function getCacheBackend($bin = NULL) {
    if (!isset($bin)) {
      $bin = $this
        ->getTestBin();
    }
    if (!isset($this->cachebackends[$bin])) {
      $this->cachebackends[$bin] = $this
        ->createCacheBackend($bin);

      // Ensure the backend is empty.
      $this->cachebackends[$bin]
        ->deleteAll();
    }
    return $this->cachebackends[$bin];
  }
  protected function setUp() {
    $this->cachebackends = [];
    $this->defaultValue = $this
      ->randomMachineName(10);
    parent::setUp();
    $this
      ->setUpCacheBackend();
  }
  protected function tearDown() {

    // Destruct the registered backend, each test will get a fresh instance,
    // properly emptying it here ensure that on persistent data backends they
    // will come up empty the next test.
    foreach ($this->cachebackends as $bin => $cachebackend) {
      $this->cachebackends[$bin]
        ->deleteAll();
    }
    unset($this->cachebackends);
    $this
      ->tearDownCacheBackend();
    parent::tearDown();
  }

  /**
   * Tests the get and set methods of Drupal\Core\Cache\CacheBackendInterface.
   */
  public function testSetGet() {
    $backend = $this
      ->getCacheBackend();
    $this
      ->assertFalse($backend
      ->get('test1'), "Backend does not contain data for cache id test1.");
    $with_backslash = [
      'foo' => '\\Drupal\\foo\\Bar',
    ];
    $backend
      ->set('test1', $with_backslash);
    $cached = $backend
      ->get('test1');
    $this
      ->assertIsObject($cached);
    $this
      ->assertSame($with_backslash, $cached->data);
    $this
      ->assertTrue($cached->valid, 'Item is marked as valid.');

    // We need to round because microtime may be rounded up in the backend.
    $this
      ->assertGreaterThanOrEqual(REQUEST_TIME, $cached->created);
    $this
      ->assertLessThanOrEqual(round(microtime(TRUE), 3), $cached->created);
    $this
      ->assertEquals(Cache::PERMANENT, $cached->expire, 'Expire time is correct.');
    $this
      ->assertFalse($backend
      ->get('test2'), "Backend does not contain data for cache id test2.");
    $backend
      ->set('test2', [
      'value' => 3,
    ], REQUEST_TIME + 3);
    $cached = $backend
      ->get('test2');
    $this
      ->assertIsObject($cached);
    $this
      ->assertSame([
      'value' => 3,
    ], $cached->data);
    $this
      ->assertTrue($cached->valid, 'Item is marked as valid.');
    $this
      ->assertGreaterThanOrEqual(REQUEST_TIME, $cached->created);
    $this
      ->assertLessThanOrEqual(round(microtime(TRUE), 3), $cached->created);
    $this
      ->assertEquals(REQUEST_TIME + 3, $cached->expire, 'Expire time is correct.');
    $backend
      ->set('test3', 'foobar', REQUEST_TIME - 3);
    $this
      ->assertFalse($backend
      ->get('test3'), 'Invalid item not returned.');
    $cached = $backend
      ->get('test3', TRUE);
    $this
      ->assertIsObject($cached);
    $this
      ->assertFalse($cached->valid, 'Item is marked as valid.');
    $this
      ->assertGreaterThanOrEqual(REQUEST_TIME, $cached->created);
    $this
      ->assertLessThanOrEqual(round(microtime(TRUE), 3), $cached->created);
    $this
      ->assertEquals(REQUEST_TIME - 3, $cached->expire, 'Expire time is correct.');
    $this
      ->assertFalse($backend
      ->get('test4'), "Backend does not contain data for cache id test4.");
    $with_eof = [
      'foo' => "\nEOF\ndata",
    ];
    $backend
      ->set('test4', $with_eof);
    $cached = $backend
      ->get('test4');
    $this
      ->assertIsObject($cached);
    $this
      ->assertSame($with_eof, $cached->data);
    $this
      ->assertTrue($cached->valid, 'Item is marked as valid.');
    $this
      ->assertGreaterThanOrEqual(REQUEST_TIME, $cached->created);
    $this
      ->assertLessThanOrEqual(round(microtime(TRUE), 3), $cached->created);
    $this
      ->assertEquals(Cache::PERMANENT, $cached->expire, 'Expire time is correct.');
    $this
      ->assertFalse($backend
      ->get('test5'), "Backend does not contain data for cache id test5.");
    $with_eof_and_semicolon = [
      'foo' => "\nEOF;\ndata",
    ];
    $backend
      ->set('test5', $with_eof_and_semicolon);
    $cached = $backend
      ->get('test5');
    $this
      ->assertIsObject($cached);
    $this
      ->assertSame($with_eof_and_semicolon, $cached->data);
    $this
      ->assertTrue($cached->valid, 'Item is marked as valid.');
    $this
      ->assertGreaterThanOrEqual(REQUEST_TIME, $cached->created);
    $this
      ->assertLessThanOrEqual(round(microtime(TRUE), 3), $cached->created);
    $this
      ->assertEquals(Cache::PERMANENT, $cached->expire, 'Expire time is correct.');
    $with_variable = [
      'foo' => '$bar',
    ];
    $backend
      ->set('test6', $with_variable);
    $cached = $backend
      ->get('test6');
    $this
      ->assertIsObject($cached);
    $this
      ->assertSame($with_variable, $cached->data);

    // Make sure that a cached object is not affected by changing the original.
    $data = new \stdClass();
    $data->value = 1;
    $data->obj = new \stdClass();
    $data->obj->value = 2;
    $backend
      ->set('test7', $data);
    $expected_data = clone $data;

    // Add a property to the original. It should not appear in the cached data.
    $data->this_should_not_be_in_the_cache = TRUE;
    $cached = $backend
      ->get('test7');
    $this
      ->assertIsObject($cached);
    $this
      ->assertEquals($expected_data, $cached->data);
    $this
      ->assertFalse(isset($cached->data->this_should_not_be_in_the_cache));

    // Add a property to the cache data. It should not appear when we fetch
    // the data from cache again.
    $cached->data->this_should_not_be_in_the_cache = TRUE;
    $fresh_cached = $backend
      ->get('test7');
    $this
      ->assertFalse(isset($fresh_cached->data->this_should_not_be_in_the_cache));

    // Check with a long key.
    $cid = str_repeat('a', 300);
    $backend
      ->set($cid, 'test');
    $this
      ->assertEquals('test', $backend
      ->get($cid)->data);

    // Check that the cache key is case sensitive.
    $backend
      ->set('TEST8', 'value');
    $this
      ->assertEquals('value', $backend
      ->get('TEST8')->data);
    $this
      ->assertFalse($backend
      ->get('test8'));

    // Calling ::set() with invalid cache tags. This should fail an assertion.
    try {
      $backend
        ->set('assertion_test', 'value', Cache::PERMANENT, [
        'node' => [
          3,
          5,
          7,
        ],
      ]);
      $this
        ->fail('::set() was called with invalid cache tags, but runtime assertion did not fail.');
    } catch (\AssertionError $e) {

      // Do nothing; continue testing in extending classes.
    }
  }

  /**
   * Tests Drupal\Core\Cache\CacheBackendInterface::delete().
   */
  public function testDelete() {
    $backend = $this
      ->getCacheBackend();
    $this
      ->assertFalse($backend
      ->get('test1'), "Backend does not contain data for cache id test1.");
    $backend
      ->set('test1', 7);
    $this
      ->assertIsObject($backend
      ->get('test1'));
    $this
      ->assertFalse($backend
      ->get('test2'), "Backend does not contain data for cache id test2.");
    $backend
      ->set('test2', 3);
    $this
      ->assertIsObject($backend
      ->get('test2'));
    $backend
      ->delete('test1');
    $this
      ->assertFalse($backend
      ->get('test1'), "Backend does not contain data for cache id test1 after deletion.");
    $this
      ->assertIsObject($backend
      ->get('test2'));
    $backend
      ->delete('test2');
    $this
      ->assertFalse($backend
      ->get('test2'), "Backend does not contain data for cache id test2 after deletion.");
    $long_cid = str_repeat('a', 300);
    $backend
      ->set($long_cid, 'test');
    $backend
      ->delete($long_cid);
    $this
      ->assertFalse($backend
      ->get($long_cid), "Backend does not contain data for long cache id after deletion.");
  }

  /**
   * Tests data type preservation.
   */
  public function testValueTypeIsKept() {
    $backend = $this
      ->getCacheBackend();
    $variables = [
      'test1' => 1,
      'test2' => '0',
      'test3' => '',
      'test4' => 12.64,
      'test5' => FALSE,
      'test6' => [
        1,
        2,
        3,
      ],
    ];

    // Create cache entries.
    foreach ($variables as $cid => $data) {
      $backend
        ->set($cid, $data);
    }

    // Retrieve and test cache objects.
    foreach ($variables as $cid => $value) {
      $object = $backend
        ->get($cid);
      $this
        ->assertIsObject($object, sprintf("Backend returned an object for cache id %s.", $cid));
      $this
        ->assertSame($value, $object->data, sprintf("Data of cached id %s kept is identical in type and value", $cid));
    }
  }

  /**
   * Tests Drupal\Core\Cache\CacheBackendInterface::getMultiple().
   */
  public function testGetMultiple() {
    $backend = $this
      ->getCacheBackend();

    // Set numerous testing keys.
    $long_cid = str_repeat('a', 300);
    $backend
      ->set('test1', 1);
    $backend
      ->set('test2', 3);
    $backend
      ->set('test3', 5);
    $backend
      ->set('test4', 7);
    $backend
      ->set('test5', 11);
    $backend
      ->set('test6', 13);
    $backend
      ->set('test7', 17);
    $backend
      ->set($long_cid, 300);

    // Mismatch order for harder testing.
    $reference = [
      'test3',
      'test7',
      // Cid does not exist.
      'test21',
      'test6',
      // Cid does not exist until added before second getMultiple().
      'test19',
      'test2',
    ];
    $cids = $reference;
    $ret = $backend
      ->getMultiple($cids);

    // Test return - ensure it contains existing cache ids.
    $this
      ->assertArrayHasKey('test2', $ret, "Existing cache id test2 is set.");
    $this
      ->assertArrayHasKey('test3', $ret, "Existing cache id test3 is set.");
    $this
      ->assertArrayHasKey('test6', $ret, "Existing cache id test6 is set.");
    $this
      ->assertArrayHasKey('test7', $ret, "Existing cache id test7 is set.");

    // Test return - ensure that objects has expected properties.
    $this
      ->assertTrue($ret['test2']->valid, 'Item is marked as valid.');
    $this
      ->assertGreaterThanOrEqual(REQUEST_TIME, $ret['test2']->created);
    $this
      ->assertLessThanOrEqual(round(microtime(TRUE), 3), $ret['test2']->created);
    $this
      ->assertEquals(Cache::PERMANENT, $ret['test2']->expire, 'Expire time is correct.');

    // Test return - ensure it does not contain nonexistent cache ids.
    $this
      ->assertFalse(isset($ret['test19']), "Nonexistent cache id test19 is not set.");
    $this
      ->assertFalse(isset($ret['test21']), "Nonexistent cache id test21 is not set.");

    // Test values.
    $this
      ->assertSame(3, $ret['test2']->data, "Existing cache id test2 has the correct value.");
    $this
      ->assertSame(5, $ret['test3']->data, "Existing cache id test3 has the correct value.");
    $this
      ->assertSame(13, $ret['test6']->data, "Existing cache id test6 has the correct value.");
    $this
      ->assertSame(17, $ret['test7']->data, "Existing cache id test7 has the correct value.");

    // Test $cids array - ensure it contains cache id's that do not exist.
    $this
      ->assertContains('test19', $cids, "Nonexistent cache id test19 is in cids array.");
    $this
      ->assertContains('test21', $cids, "Nonexistent cache id test21 is in cids array.");

    // Test $cids array - ensure it does not contain cache id's that exist.
    $this
      ->assertNotContains('test2', $cids, "Existing cache id test2 is not in cids array.");
    $this
      ->assertNotContains('test3', $cids, "Existing cache id test3 is not in cids array.");
    $this
      ->assertNotContains('test6', $cids, "Existing cache id test6 is not in cids array.");
    $this
      ->assertNotContains('test7', $cids, "Existing cache id test7 is not in cids array.");

    // Test a second time after deleting and setting new keys which ensures that
    // if the backend uses statics it does not cause unexpected results.
    $backend
      ->delete('test3');
    $backend
      ->delete('test6');
    $backend
      ->set('test19', 57);
    $cids = $reference;
    $ret = $backend
      ->getMultiple($cids);

    // Test return - ensure it contains existing cache ids.
    $this
      ->assertArrayHasKey('test2', $ret, "Existing cache id test2 is set");
    $this
      ->assertArrayHasKey('test7', $ret, "Existing cache id test7 is set");
    $this
      ->assertArrayHasKey('test19', $ret, "Added cache id test19 is set");

    // Test return - ensure it does not contain nonexistent cache ids.
    $this
      ->assertFalse(isset($ret['test3']), "Deleted cache id test3 is not set");
    $this
      ->assertFalse(isset($ret['test6']), "Deleted cache id test6 is not set");
    $this
      ->assertFalse(isset($ret['test21']), "Nonexistent cache id test21 is not set");

    // Test values.
    $this
      ->assertSame(3, $ret['test2']->data, "Existing cache id test2 has the correct value.");
    $this
      ->assertSame(17, $ret['test7']->data, "Existing cache id test7 has the correct value.");
    $this
      ->assertSame(57, $ret['test19']->data, "Added cache id test19 has the correct value.");

    // Test $cids array - ensure it contains cache id's that do not exist.
    $this
      ->assertContains('test3', $cids, "Deleted cache id test3 is in cids array.");
    $this
      ->assertContains('test6', $cids, "Deleted cache id test6 is in cids array.");
    $this
      ->assertContains('test21', $cids, "Nonexistent cache id test21 is in cids array.");

    // Test $cids array - ensure it does not contain cache id's that exist.
    $this
      ->assertNotContains('test2', $cids, "Existing cache id test2 is not in cids array.");
    $this
      ->assertNotContains('test7', $cids, "Existing cache id test7 is not in cids array.");
    $this
      ->assertNotContains('test19', $cids, "Added cache id test19 is not in cids array.");

    // Test with a long $cid and non-numeric array key.
    $cids = [
      'key:key' => $long_cid,
    ];
    $return = $backend
      ->getMultiple($cids);
    $this
      ->assertEquals(300, $return[$long_cid]->data);
    $this
      ->assertTrue(empty($cids));
  }

  /**
   * Tests \Drupal\Core\Cache\CacheBackendInterface::setMultiple().
   */
  public function testSetMultiple() {
    $backend = $this
      ->getCacheBackend();
    $future_expiration = REQUEST_TIME + 100;

    // Set multiple testing keys.
    $backend
      ->set('cid_1', 'Some other value');
    $items = [
      'cid_1' => [
        'data' => 1,
      ],
      'cid_2' => [
        'data' => 2,
      ],
      'cid_3' => [
        'data' => [
          1,
          2,
        ],
      ],
      'cid_4' => [
        'data' => 1,
        'expire' => $future_expiration,
      ],
      'cid_5' => [
        'data' => 1,
        'tags' => [
          'test:a',
          'test:b',
        ],
      ],
    ];
    $backend
      ->setMultiple($items);
    $cids = array_keys($items);
    $cached = $backend
      ->getMultiple($cids);
    $this
      ->assertEquals($items['cid_1']['data'], $cached['cid_1']->data, 'Over-written cache item set correctly.');
    $this
      ->assertTrue($cached['cid_1']->valid, 'Item is marked as valid.');
    $this
      ->assertGreaterThanOrEqual(REQUEST_TIME, $cached['cid_1']->created);
    $this
      ->assertLessThanOrEqual(round(microtime(TRUE), 3), $cached['cid_1']->created);
    $this
      ->assertEquals(CacheBackendInterface::CACHE_PERMANENT, $cached['cid_1']->expire, 'Cache expiration defaults to permanent.');
    $this
      ->assertEquals($items['cid_2']['data'], $cached['cid_2']->data, 'New cache item set correctly.');
    $this
      ->assertEquals(CacheBackendInterface::CACHE_PERMANENT, $cached['cid_2']->expire, 'Cache expiration defaults to permanent.');
    $this
      ->assertEquals($items['cid_3']['data'], $cached['cid_3']->data, 'New cache item with serialized data set correctly.');
    $this
      ->assertEquals(CacheBackendInterface::CACHE_PERMANENT, $cached['cid_3']->expire, 'Cache expiration defaults to permanent.');
    $this
      ->assertEquals($items['cid_4']['data'], $cached['cid_4']->data, 'New cache item set correctly.');
    $this
      ->assertEquals($future_expiration, $cached['cid_4']->expire, 'Cache expiration has been correctly set.');
    $this
      ->assertEquals($items['cid_5']['data'], $cached['cid_5']->data, 'New cache item set correctly.');

    // Calling ::setMultiple() with invalid cache tags. This should fail an
    // assertion.
    try {
      $items = [
        'exception_test_1' => [
          'data' => 1,
          'tags' => [],
        ],
        'exception_test_2' => [
          'data' => 2,
          'tags' => [
            'valid',
          ],
        ],
        'exception_test_3' => [
          'data' => 3,
          'tags' => [
            'node' => [
              3,
              5,
              7,
            ],
          ],
        ],
      ];
      $backend
        ->setMultiple($items);
      $this
        ->fail('::setMultiple() was called with invalid cache tags, but runtime assertion did not fail.');
    } catch (\AssertionError $e) {

      // Do nothing; continue testing in extending classes.
    }
  }

  /**
   * Tests Drupal\Core\Cache\CacheBackendInterface::delete() and
   * Drupal\Core\Cache\CacheBackendInterface::deleteMultiple().
   */
  public function testDeleteMultiple() {
    $backend = $this
      ->getCacheBackend();

    // Set numerous testing keys.
    $backend
      ->set('test1', 1);
    $backend
      ->set('test2', 3);
    $backend
      ->set('test3', 5);
    $backend
      ->set('test4', 7);
    $backend
      ->set('test5', 11);
    $backend
      ->set('test6', 13);
    $backend
      ->set('test7', 17);
    $backend
      ->delete('test1');

    // Nonexistent key should not cause an error.
    $backend
      ->delete('test23');
    $backend
      ->deleteMultiple([
      'test3',
      'test5',
      'test7',
      // Nonexistent key should not cause an error.
      'test19',
      // Nonexistent key should not cause an error.
      'test21',
    ]);

    // Test if expected keys have been deleted.
    $this
      ->assertFalse($backend
      ->get('test1'), "Cache id test1 deleted.");
    $this
      ->assertFalse($backend
      ->get('test3'), "Cache id test3 deleted.");
    $this
      ->assertFalse($backend
      ->get('test5'), "Cache id test5 deleted.");
    $this
      ->assertFalse($backend
      ->get('test7'), "Cache id test7 deleted.");

    // Test if expected keys exist.
    $this
      ->assertNotFalse($backend
      ->get('test2'), "Cache id test2 exists.");
    $this
      ->assertNotFalse($backend
      ->get('test4'), "Cache id test4 exists.");
    $this
      ->assertNotFalse($backend
      ->get('test6'), "Cache id test6 exists.");

    // Test if that expected keys do not exist.
    $this
      ->assertFalse($backend
      ->get('test19'), "Cache id test19 does not exist.");
    $this
      ->assertFalse($backend
      ->get('test21'), "Cache id test21 does not exist.");

    // Calling deleteMultiple() with an empty array should not cause an error.
    $this
      ->assertNull($backend
      ->deleteMultiple([]));
  }

  /**
   * Tests Drupal\Core\Cache\CacheBackendInterface::deleteAll().
   */
  public function testDeleteAll() {
    $backend_a = $this
      ->getCacheBackend();
    $backend_b = $this
      ->getCacheBackend('bootstrap');

    // Set both expiring and permanent keys.
    $backend_a
      ->set('test1', 1, Cache::PERMANENT);
    $backend_a
      ->set('test2', 3, time() + 1000);
    $backend_b
      ->set('test3', 4, Cache::PERMANENT);
    $backend_a
      ->deleteAll();
    $this
      ->assertFalse($backend_a
      ->get('test1'), 'First key has been deleted.');
    $this
      ->assertFalse($backend_a
      ->get('test2'), 'Second key has been deleted.');
    $this
      ->assertNotEmpty($backend_b
      ->get('test3'), 'Item in other bin is preserved.');
  }

  /**
   * Tests Drupal\Core\Cache\CacheBackendInterface::invalidate() and
   * Drupal\Core\Cache\CacheBackendInterface::invalidateMultiple().
   */
  public function testInvalidate() {
    $backend = $this
      ->getCacheBackend();
    $backend
      ->set('test1', 1);
    $backend
      ->set('test2', 2);
    $backend
      ->set('test3', 2);
    $backend
      ->set('test4', 2);
    $reference = [
      'test1',
      'test2',
      'test3',
      'test4',
    ];
    $cids = $reference;
    $ret = $backend
      ->getMultiple($cids);
    $this
      ->assertCount(4, $ret, 'Four items returned.');
    $backend
      ->invalidate('test1');
    $backend
      ->invalidateMultiple([
      'test2',
      'test3',
    ]);
    $cids = $reference;
    $ret = $backend
      ->getMultiple($cids);
    $this
      ->assertCount(1, $ret, 'Only one item element returned.');
    $cids = $reference;
    $ret = $backend
      ->getMultiple($cids, TRUE);
    $this
      ->assertCount(4, $ret, 'Four items returned.');

    // Calling invalidateMultiple() with an empty array should not cause an
    // error.
    $this
      ->assertNull($backend
      ->invalidateMultiple([]));
  }

  /**
   * Tests Drupal\Core\Cache\CacheBackendInterface::invalidateTags().
   */
  public function testInvalidateTags() {
    $backend = $this
      ->getCacheBackend();

    // Create two cache entries with the same tag and tag value.
    $backend
      ->set('test_cid_invalidate1', $this->defaultValue, Cache::PERMANENT, [
      'test_tag:2',
    ]);
    $backend
      ->set('test_cid_invalidate2', $this->defaultValue, Cache::PERMANENT, [
      'test_tag:2',
    ]);
    $this
      ->assertSame($this->defaultValue, $backend
      ->get('test_cid_invalidate1')->data);
    $this
      ->assertSame($this->defaultValue, $backend
      ->get('test_cid_invalidate2')->data);

    // Invalidate test_tag of value 1. This should invalidate both entries.
    Cache::invalidateTags([
      'test_tag:2',
    ]);
    $this
      ->assertFalse($backend
      ->get('test_cid_invalidate1') || $backend
      ->get('test_cid_invalidate2'), 'Two cache items invalidated after invalidating a cache tag.');

    // Verify that cache items have not been deleted after invalidation.
    $this
      ->assertSame($this->defaultValue, $backend
      ->get('test_cid_invalidate1', TRUE)->data);
    $this
      ->assertSame($this->defaultValue, $backend
      ->get('test_cid_invalidate2', TRUE)->data);

    // Create two cache entries with the same tag and an array tag value.
    $backend
      ->set('test_cid_invalidate1', $this->defaultValue, Cache::PERMANENT, [
      'test_tag:1',
    ]);
    $backend
      ->set('test_cid_invalidate2', $this->defaultValue, Cache::PERMANENT, [
      'test_tag:1',
    ]);
    $this
      ->assertSame($this->defaultValue, $backend
      ->get('test_cid_invalidate1')->data);
    $this
      ->assertSame($this->defaultValue, $backend
      ->get('test_cid_invalidate2')->data);

    // Invalidate test_tag of value 1. This should invalidate both entries.
    Cache::invalidateTags([
      'test_tag:1',
    ]);
    $this
      ->assertFalse($backend
      ->get('test_cid_invalidate1') || $backend
      ->get('test_cid_invalidate2'), 'Two caches removed after invalidating a cache tag.');

    // Verify that cache items have not been deleted after invalidation.
    $this
      ->assertSame($this->defaultValue, $backend
      ->get('test_cid_invalidate1', TRUE)->data);
    $this
      ->assertSame($this->defaultValue, $backend
      ->get('test_cid_invalidate2', TRUE)->data);

    // Create three cache entries with a mix of tags and tag values.
    $backend
      ->set('test_cid_invalidate1', $this->defaultValue, Cache::PERMANENT, [
      'test_tag:1',
    ]);
    $backend
      ->set('test_cid_invalidate2', $this->defaultValue, Cache::PERMANENT, [
      'test_tag:2',
    ]);
    $backend
      ->set('test_cid_invalidate3', $this->defaultValue, Cache::PERMANENT, [
      'test_tag_foo:3',
    ]);
    $this
      ->assertSame($this->defaultValue, $backend
      ->get('test_cid_invalidate1')->data);
    $this
      ->assertSame($this->defaultValue, $backend
      ->get('test_cid_invalidate2')->data);
    $this
      ->assertSame($this->defaultValue, $backend
      ->get('test_cid_invalidate3')->data);
    Cache::invalidateTags([
      'test_tag_foo:3',
    ]);

    // Verify that cache items not matching the tag were not invalidated.
    $this
      ->assertSame($this->defaultValue, $backend
      ->get('test_cid_invalidate1')->data);
    $this
      ->assertSame($this->defaultValue, $backend
      ->get('test_cid_invalidate2')->data);
    $this
      ->assertFalse($backend
      ->get('test_cid_invalidate3'), 'Cached item matching the tag was removed.');

    // Create cache entry in multiple bins. Two cache entries
    // (test_cid_invalidate1 and test_cid_invalidate2) still exist from previous
    // tests.
    $tags = [
      'test_tag:1',
      'test_tag:2',
      'test_tag:3',
    ];
    $bins = [
      'path',
      'bootstrap',
      'page',
    ];
    foreach ($bins as $bin) {
      $this
        ->getCacheBackend($bin)
        ->set('test', $this->defaultValue, Cache::PERMANENT, $tags);
      $this
        ->assertNotEmpty($this
        ->getCacheBackend($bin)
        ->get('test'), 'Cache item was set in bin.');
    }
    Cache::invalidateTags([
      'test_tag:2',
    ]);

    // Test that the cache entry has been invalidated in multiple bins.
    foreach ($bins as $bin) {
      $this
        ->assertFalse($this
        ->getCacheBackend($bin)
        ->get('test'), 'Tag invalidation affected item in bin.');
    }

    // Test that the cache entry with a matching tag has been invalidated.
    $this
      ->assertFalse($this
      ->getCacheBackend($bin)
      ->get('test_cid_invalidate2'), 'Cache items matching tag were invalidated.');

    // Test that the cache entry with without a matching tag still exists.
    $this
      ->assertNotEmpty($this
      ->getCacheBackend($bin)
      ->get('test_cid_invalidate1'), 'Cache items not matching tag were not invalidated.');
  }

  /**
   * Tests Drupal\Core\Cache\CacheBackendInterface::invalidateAll().
   */
  public function testInvalidateAll() {
    $backend_a = $this
      ->getCacheBackend();
    $backend_b = $this
      ->getCacheBackend('bootstrap');

    // Set both expiring and permanent keys.
    $backend_a
      ->set('test1', 1, Cache::PERMANENT);
    $backend_a
      ->set('test2', 3, time() + 1000);
    $backend_b
      ->set('test3', 4, Cache::PERMANENT);
    $backend_a
      ->invalidateAll();
    $this
      ->assertFalse($backend_a
      ->get('test1'), 'First key has been invalidated.');
    $this
      ->assertFalse($backend_a
      ->get('test2'), 'Second key has been invalidated.');
    $this
      ->assertNotEmpty($backend_b
      ->get('test3'), 'Item in other bin is preserved.');
    $this
      ->assertNotEmpty($backend_a
      ->get('test1', TRUE), 'First key has not been deleted.');
    $this
      ->assertNotEmpty($backend_a
      ->get('test2', TRUE), 'Second key has not been deleted.');
  }

  /**
   * Tests Drupal\Core\Cache\CacheBackendInterface::removeBin().
   */
  public function testRemoveBin() {
    $backend_a = $this
      ->getCacheBackend();
    $backend_b = $this
      ->getCacheBackend('bootstrap');

    // Set both expiring and permanent keys.
    $backend_a
      ->set('test1', 1, Cache::PERMANENT);
    $backend_a
      ->set('test2', 3, time() + 1000);
    $backend_b
      ->set('test3', 4, Cache::PERMANENT);
    $backend_a
      ->removeBin();
    $this
      ->assertFalse($backend_a
      ->get('test1'), 'First key has been deleted.');
    $this
      ->assertFalse($backend_a
      ->get('test2', TRUE), 'Second key has been deleted.');
    $this
      ->assertNotEmpty($backend_b
      ->get('test3'), 'Item in other bin is preserved.');
  }

}

Members

Name	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.
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	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.
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
GenericCacheBackendUnitTestBase::$cachebackends	protected	property	Array of objects implementing Drupal\Core\Cache\CacheBackendInterface.
GenericCacheBackendUnitTestBase::$defaultValue	protected	property	Random value to use in tests.
GenericCacheBackendUnitTestBase::$testBin	protected	property	Cache bin to use for testing.
GenericCacheBackendUnitTestBase::createCacheBackend	abstract protected	function	Creates a cache backend to test.	6
GenericCacheBackendUnitTestBase::getCacheBackend	protected	function	Gets a backend to test; this will get a shared instance set in the object.
GenericCacheBackendUnitTestBase::getTestBin	protected	function	Gets the testing bin.
GenericCacheBackendUnitTestBase::setUp	protected	function	Overrides KernelTestBase::setUp
GenericCacheBackendUnitTestBase::setUpCacheBackend	public	function	Allows specific implementation to change the environment before a test run.
GenericCacheBackendUnitTestBase::tearDown	protected	function	Overrides KernelTestBase::tearDown	1
GenericCacheBackendUnitTestBase::tearDownCacheBackend	public	function	Allows alteration of environment after a test run but before tear down.
GenericCacheBackendUnitTestBase::testDelete	public	function	Tests Drupal\Core\Cache\CacheBackendInterface::delete().
GenericCacheBackendUnitTestBase::testDeleteAll	public	function	Tests Drupal\Core\Cache\CacheBackendInterface::deleteAll().
GenericCacheBackendUnitTestBase::testDeleteMultiple	public	function	Tests Drupal\Core\Cache\CacheBackendInterface::delete() and Drupal\Core\Cache\CacheBackendInterface::deleteMultiple().
GenericCacheBackendUnitTestBase::testGetMultiple	public	function	Tests Drupal\Core\Cache\CacheBackendInterface::getMultiple().
GenericCacheBackendUnitTestBase::testInvalidate	public	function	Tests Drupal\Core\Cache\CacheBackendInterface::invalidate() and Drupal\Core\Cache\CacheBackendInterface::invalidateMultiple().
GenericCacheBackendUnitTestBase::testInvalidateAll	public	function	Tests Drupal\Core\Cache\CacheBackendInterface::invalidateAll().
GenericCacheBackendUnitTestBase::testInvalidateTags	public	function	Tests Drupal\Core\Cache\CacheBackendInterface::invalidateTags().
GenericCacheBackendUnitTestBase::testRemoveBin	public	function	Tests Drupal\Core\Cache\CacheBackendInterface::removeBin().
GenericCacheBackendUnitTestBase::testSetGet	public	function	Tests the get and set methods of Drupal\Core\Cache\CacheBackendInterface.	2
GenericCacheBackendUnitTestBase::testSetMultiple	public	function	Tests \Drupal\Core\Cache\CacheBackendInterface::setMultiple().
GenericCacheBackendUnitTestBase::testValueTypeIsKept	public	function	Tests data type preservation.
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::$modules	protected static	property	Modules to enable.	457
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.	3
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::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	24
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::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep	public	function	Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.

You are here

abstract class GenericCacheBackendUnitTestBase in Drupal 9

Hierarchy

See also

File

Namespace

Members

API Navigation