class CacheTest

Same name in this branch
  1. 11.x core/modules/views/tests/src/Kernel/Plugin/CacheTest.php \Drupal\Tests\views\Kernel\Plugin\CacheTest
Same name in other branches
  1. 9 core/modules/views/tests/src/Kernel/Plugin/CacheTest.php \Drupal\Tests\views\Kernel\Plugin\CacheTest
  2. 9 core/tests/Drupal/Tests/Core/Cache/CacheTest.php \Drupal\Tests\Core\Cache\CacheTest
  3. 8.9.x core/modules/views/tests/src/Kernel/Plugin/CacheTest.php \Drupal\Tests\views\Kernel\Plugin\CacheTest
  4. 8.9.x core/tests/Drupal/Tests/Core/Cache/CacheTest.php \Drupal\Tests\Core\Cache\CacheTest
  5. 10 core/modules/views/tests/src/Kernel/Plugin/CacheTest.php \Drupal\Tests\views\Kernel\Plugin\CacheTest
  6. 10 core/tests/Drupal/Tests/Core/Cache/CacheTest.php \Drupal\Tests\Core\Cache\CacheTest

@coversDefaultClass \Drupal\Core\Cache\Cache @group Cache

Hierarchy

Expanded class hierarchy of CacheTest

File

core/tests/Drupal/Tests/Core/Cache/CacheTest.php, line 17

Namespace

Drupal\Tests\Core\Cache
View source
class CacheTest extends UnitTestCase {
    
    /**
     * Provides a list of cache tags arrays.
     *
     * @return array
     */
    public function validateTagsProvider() {
        return [
            [
                [],
                FALSE,
            ],
            [
                [
                    'foo',
                ],
                FALSE,
            ],
            [
                [
                    'foo',
                    'bar',
                ],
                FALSE,
            ],
            [
                [
                    'foo',
                    'bar',
                    'llama:2001988',
                    'baz',
                    'llama:14031991',
                ],
                FALSE,
            ],
            // Invalid.
[
                [
                    FALSE,
                ],
                'Cache tags must be strings, boolean given.',
            ],
            [
                [
                    TRUE,
                ],
                'Cache tags must be strings, boolean given.',
            ],
            [
                [
                    'foo',
                    FALSE,
                ],
                'Cache tags must be strings, boolean given.',
            ],
            [
                [
                    NULL,
                ],
                'Cache tags must be strings, NULL given.',
            ],
            [
                [
                    'foo',
                    NULL,
                ],
                'Cache tags must be strings, NULL given.',
            ],
            [
                [
                    1337,
                ],
                'Cache tags must be strings, integer given.',
            ],
            [
                [
                    'foo',
                    1337,
                ],
                'Cache tags must be strings, integer given.',
            ],
            [
                [
                    3.14,
                ],
                'Cache tags must be strings, double given.',
            ],
            [
                [
                    'foo',
                    3.14,
                ],
                'Cache tags must be strings, double given.',
            ],
            [
                [
                    [],
                ],
                'Cache tags must be strings, array given.',
            ],
            [
                [
                    'foo',
                    [],
                ],
                'Cache tags must be strings, array given.',
            ],
            [
                [
                    'foo',
                    [
                        'bar',
                    ],
                ],
                'Cache tags must be strings, array given.',
            ],
            [
                [
                    new \stdClass(),
                ],
                'Cache tags must be strings, object given.',
            ],
            [
                [
                    'foo',
                    new \stdClass(),
                ],
                'Cache tags must be strings, object given.',
            ],
        ];
    }
    
    /**
     * Provides a list of pairs of cache tags arrays to be merged.
     *
     * @return array
     */
    public static function mergeTagsProvider() {
        return [
            [
                [],
                [],
                [],
            ],
            [
                [
                    'bar',
                    'foo',
                ],
                [
                    'bar',
                ],
                [
                    'foo',
                ],
            ],
            [
                [
                    'foo',
                    'bar',
                ],
                [
                    'foo',
                ],
                [
                    'bar',
                ],
            ],
            [
                [
                    'foo',
                    'bar',
                ],
                [
                    'foo',
                ],
                [
                    'bar',
                    'foo',
                ],
            ],
            [
                [
                    'foo',
                    'bar',
                ],
                [
                    'foo',
                ],
                [
                    'foo',
                    'bar',
                ],
            ],
            [
                [
                    'bar',
                    'foo',
                ],
                [
                    'bar',
                    'foo',
                ],
                [
                    'foo',
                    'bar',
                ],
            ],
            [
                [
                    'foo',
                    'bar',
                ],
                [
                    'foo',
                    'bar',
                ],
                [
                    'foo',
                    'bar',
                ],
            ],
            [
                [
                    'bar',
                    'foo',
                    'llama',
                ],
                [
                    'bar',
                    'foo',
                ],
                [
                    'foo',
                    'bar',
                ],
                [
                    'llama',
                    'foo',
                ],
            ],
        ];
    }
    
    /**
     * @covers ::mergeTags
     *
     * @dataProvider mergeTagsProvider
     */
    public function testMergeTags(array $expected, ...$cache_tags) : void {
        $this->assertEqualsCanonicalizing($expected, Cache::mergeTags(...$cache_tags));
    }
    
    /**
     * Provides a list of pairs of cache tags arrays to be merged.
     *
     * @return array
     */
    public static function mergeMaxAgesProvider() {
        return [
            [
                Cache::PERMANENT,
                Cache::PERMANENT,
                Cache::PERMANENT,
            ],
            [
                60,
                60,
                60,
            ],
            [
                0,
                0,
                0,
            ],
            [
                0,
                60,
                0,
            ],
            [
                0,
                0,
                60,
            ],
            [
                0,
                Cache::PERMANENT,
                0,
            ],
            [
                0,
                0,
                Cache::PERMANENT,
            ],
            [
                60,
                Cache::PERMANENT,
                60,
            ],
            [
                60,
                60,
                Cache::PERMANENT,
            ],
            [
                Cache::PERMANENT,
                Cache::PERMANENT,
                Cache::PERMANENT,
                Cache::PERMANENT,
            ],
            [
                30,
                60,
                60,
                30,
            ],
            [
                0,
                0,
                0,
                0,
            ],
            [
                60,
                Cache::PERMANENT,
                60,
                Cache::PERMANENT,
            ],
            [
                60,
                60,
                Cache::PERMANENT,
                Cache::PERMANENT,
            ],
            [
                60,
                Cache::PERMANENT,
                Cache::PERMANENT,
                60,
            ],
        ];
    }
    
    /**
     * @covers ::mergeMaxAges
     *
     * @dataProvider mergeMaxAgesProvider
     */
    public function testMergeMaxAges($expected, ...$max_ages) : void {
        $this->assertSame($expected, Cache::mergeMaxAges(...$max_ages));
    }
    
    /**
     * Provides a list of pairs of cache contexts arrays to be merged.
     *
     * @return array
     */
    public static function mergeCacheContextsProvide() {
        return [
            [
                [],
                [],
                [],
            ],
            [
                [
                    'foo',
                ],
                [],
                [
                    'foo',
                ],
            ],
            [
                [
                    'foo',
                ],
                [
                    'foo',
                ],
                [],
            ],
            [
                [
                    'bar',
                    'foo',
                ],
                [
                    'foo',
                ],
                [
                    'bar',
                ],
            ],
            [
                [
                    'bar',
                    'foo',
                ],
                [
                    'bar',
                ],
                [
                    'foo',
                ],
            ],
            [
                [
                    'foo.bar',
                    'foo.foo',
                ],
                [
                    'foo.foo',
                ],
                [
                    'foo.bar',
                ],
            ],
            [
                [
                    'foo.bar',
                    'foo.foo',
                ],
                [
                    'foo.bar',
                ],
                [
                    'foo.foo',
                ],
            ],
            [
                [
                    'bar',
                    'foo',
                    'llama',
                ],
                [],
                [
                    'foo',
                    'bar',
                    'llama',
                ],
            ],
            [
                [
                    'bar',
                    'foo',
                    'llama',
                ],
                [
                    'foo',
                    'bar',
                    'llama',
                ],
                [],
            ],
            [
                [
                    'bar',
                    'foo',
                    'llama',
                ],
                [
                    'foo',
                ],
                [
                    'foo',
                    'bar',
                    'llama',
                ],
            ],
            [
                [
                    'bar',
                    'foo',
                    'llama',
                ],
                [
                    'foo',
                    'bar',
                    'llama',
                ],
                [
                    'foo',
                ],
            ],
        ];
    }
    
    /**
     * @covers ::mergeContexts
     *
     * @dataProvider mergeCacheContextsProvide
     */
    public function testMergeCacheContexts(array $expected, ...$contexts) : void {
        $cache_contexts_manager = $this->prophesize(CacheContextsManager::class);
        $cache_contexts_manager->assertValidTokens(Argument::any())
            ->willReturn(TRUE);
        $container = $this->prophesize(Container::class);
        $container->get('cache_contexts_manager')
            ->willReturn($cache_contexts_manager->reveal());
        \Drupal::setContainer($container->reveal());
        $this->assertEqualsCanonicalizing($expected, Cache::mergeContexts(...$contexts));
    }
    
    /**
     * Provides a list of pairs of (prefix, suffixes) to build cache tags from.
     *
     * @return array
     */
    public static function buildTagsProvider() {
        return [
            [
                'node',
                [
                    1,
                ],
                [
                    'node:1',
                ],
            ],
            [
                'node',
                [
                    1,
                    2,
                    3,
                ],
                [
                    'node:1',
                    'node:2',
                    'node:3',
                ],
            ],
            [
                'node',
                [
                    3,
                    2,
                    1,
                ],
                [
                    'node:3',
                    'node:2',
                    'node:1',
                ],
            ],
            [
                'node',
                [
                    NULL,
                ],
                [
                    'node:',
                ],
            ],
            [
                'node',
                [
                    TRUE,
                    FALSE,
                ],
                [
                    'node:1',
                    'node:',
                ],
            ],
            [
                'node',
                [
                    'a',
                    'z',
                    'b',
                ],
                [
                    'node:a',
                    'node:z',
                    'node:b',
                ],
            ],
            // No suffixes, no cache tags.
[
                '',
                [],
                [],
            ],
            [
                'node',
                [],
                [],
            ],
            // Only suffix values matter, not keys: verify that expectation.
[
                'node',
                [
                    5 => 145,
                    4545 => 3,
                ],
                [
                    'node:145',
                    'node:3',
                ],
            ],
            [
                'node',
                [
                    5 => TRUE,
                ],
                [
                    'node:1',
                ],
            ],
            [
                'node',
                [
                    5 => NULL,
                ],
                [
                    'node:',
                ],
            ],
            [
                'node',
                [
                    'a' => NULL,
                ],
                [
                    'node:',
                ],
            ],
            [
                'node',
                [
                    'a' => TRUE,
                ],
                [
                    'node:1',
                ],
            ],
            // Test the $glue parameter.
[
                'config:system.menu',
                [
                    'menu_name',
                ],
                [
                    'config:system.menu.menu_name',
                ],
                '.',
            ],
        ];
    }
    
    /**
     * @covers ::buildTags
     *
     * @dataProvider buildTagsProvider
     */
    public function testBuildTags($prefix, array $suffixes, array $expected, $glue = ':') : void {
        $this->assertEquals($expected, Cache::buildTags($prefix, $suffixes, $glue));
    }

}

Members

Title Sort descending Modifiers Object type Summary Overrides
CacheTest::buildTagsProvider public static function Provides a list of pairs of (prefix, suffixes) to build cache tags from.
CacheTest::mergeCacheContextsProvide public static function Provides a list of pairs of cache contexts arrays to be merged.
CacheTest::mergeMaxAgesProvider public static function Provides a list of pairs of cache tags arrays to be merged.
CacheTest::mergeTagsProvider public static function Provides a list of pairs of cache tags arrays to be merged.
CacheTest::testBuildTags public function @covers ::buildTags
CacheTest::testMergeCacheContexts public function @covers ::mergeContexts
CacheTest::testMergeMaxAges public function @covers ::mergeMaxAges
CacheTest::testMergeTags public function @covers ::mergeTags
CacheTest::validateTagsProvider public function Provides a list of cache tags arrays.
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
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.
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.
UnitTestCase::$root protected property The app root.
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub public function Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::setUp protected function 367
UnitTestCase::setUpBeforeClass public static function

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.