class HeadersCacheContextTest

Same name in other branches
  1. 9 core/tests/Drupal/Tests/Core/Cache/Context/HeadersCacheContextTest.php \Drupal\Tests\Core\Cache\Context\HeadersCacheContextTest
  2. 8.9.x core/tests/Drupal/Tests/Core/Cache/Context/HeadersCacheContextTest.php \Drupal\Tests\Core\Cache\Context\HeadersCacheContextTest
  3. 10 core/tests/Drupal/Tests/Core/Cache/Context/HeadersCacheContextTest.php \Drupal\Tests\Core\Cache\Context\HeadersCacheContextTest

@coversDefaultClass \Drupal\Core\Cache\Context\HeadersCacheContext @group Cache

Hierarchy

Expanded class hierarchy of HeadersCacheContextTest

File

core/tests/Drupal/Tests/Core/Cache/Context/HeadersCacheContextTest.php, line 16

Namespace

Drupal\Tests\Core\Cache\Context
View source 
class HeadersCacheContextTest extends UnitTestCase {
    
    /**
     * @covers ::getContext
     *
     * @dataProvider providerTestGetContext
     */
    public function testGetContext($headers, $header_name, $context) : void {
        $request_stack = new RequestStack();
        $request = Request::create('/', 'GET');
        // Request defaults could change, so compare with default values instead of
        // passed in context value.
        $request->headers
            ->replace($headers);
        $request_stack->push($request);
        $cache_context = new HeadersCacheContext($request_stack);
        $this->assertSame($cache_context->getContext($header_name), $context);
    }
    
    /**
     * Provides a list of headers and expected cache contexts.
     */
    public static function providerTestGetContext() {
        return [
            [
                [],
                NULL,
                '',
            ],
            [
                [],
                'foo',
                '',
            ],
            // Non-empty headers.
[
                [
                    'llama' => 'rocks',
                    'alpaca' => '',
                    'panda' => 'drools',
                    'z' => '0',
                ],
                NULL,
                'alpaca=&llama=rocks&panda=drools&z=0',
            ],
            [
                [
                    'llama' => 'rocks',
                    'alpaca' => '',
                    'panda' => 'drools',
                    'z' => '0',
                ],
                'llama',
                'rocks',
            ],
            [
                [
                    'llama' => 'rocks',
                    'alpaca' => '',
                    'panda' => 'drools',
                    'z' => '0',
                ],
                'alpaca',
                '?valueless?',
            ],
            [
                [
                    'llama' => 'rocks',
                    'alpaca' => '',
                    'panda' => 'drools',
                    'z' => '0',
                ],
                'panda',
                'drools',
            ],
            [
                [
                    'llama' => 'rocks',
                    'alpaca' => '',
                    'panda' => 'drools',
                    'z' => '0',
                ],
                'z',
                '0',
            ],
            [
                [
                    'llama' => 'rocks',
                    'alpaca' => '',
                    'panda' => 'drools',
                    'z' => '0',
                ],
                'chicken',
                '',
            ],
            // Header value could be an array.
[
                [
                    'z' => [
                        '0',
                        '1',
                    ],
                ],
                NULL,
                'z=0,1',
            ],
            // Values are sorted to minimize cache variations.
[
                [
                    'z' => [
                        '1',
                        '0',
                    ],
                    'a' => [],
                ],
                NULL,
                'a=&z=0,1',
            ],
            [
                [
                    'a' => [],
                    'z' => [
                        '1',
                        '0',
                    ],
                ],
                NULL,
                'a=&z=0,1',
            ],
        ];
    }

}

Members

Title Modifiers Object type Summary Overrides
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.
HeadersCacheContextTest::providerTestGetContext public static function Provides a list of headers and expected cache contexts.
HeadersCacheContextTest::testGetContext public function @covers ::getContext
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.