class DenyNoCacheRoutesTest

@coversDefaultClass \Drupal\Core\PageCache\ResponsePolicy\DenyNoCacheRoutes @group PageCache @group Route

Hierarchy

Expanded class hierarchy of DenyNoCacheRoutesTest

File

core/tests/Drupal/Tests/Core/PageCache/DenyNoCacheRoutesTest.php, line 20

Namespace

Drupal\Tests\Core\PageCache
View source
class DenyNoCacheRoutesTest extends UnitTestCase {
    
    /**
     * The response policy under test.
     *
     * @var \Drupal\Core\PageCache\ResponsePolicy\DenyNoCacheRoutes
     */
    protected $policy;
    
    /**
     * A request object.
     *
     * @var \Symfony\Component\HttpFoundation\Request
     */
    protected $request;
    
    /**
     * A response object.
     *
     * @var \Symfony\Component\HttpFoundation\Response
     */
    protected $response;
    
    /**
     * The current route match.
     *
     * @var \Drupal\Core\Routing\RouteMatch|\PHPUnit\Framework\MockObject\MockObject
     */
    protected $routeMatch;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->routeMatch = $this->createMock(RouteMatchInterface::class);
        $this->policy = new DenyNoCacheRoutes($this->routeMatch);
        $this->response = new Response();
        $this->request = new Request();
    }
    
    /**
     * Asserts that caching is denied on the node preview route.
     *
     * @dataProvider providerDenyNoCacheRoutesPolicy
     * @covers ::check
     */
    public function testDenyNoCacheRoutesPolicy($expected_result, ?Route $route) : void {
        $this->routeMatch
            ->expects($this->once())
            ->method('getRouteObject')
            ->willReturn($route);
        $actual_result = $this->policy
            ->check($this->response, $this->request);
        $this->assertSame($expected_result, $actual_result);
    }
    
    /**
     * Provides data and expected results for the test method.
     *
     * @return array
     *   Data and expected results.
     */
    public static function providerDenyNoCacheRoutesPolicy() : array {
        $no_cache_route = new Route('', [], [], [
            'no_cache' => TRUE,
        ]);
        return [
            [
                ResponsePolicyInterface::DENY,
                $no_cache_route,
            ],
            [
                NULL,
                new Route(''),
            ],
            [
                NULL,
                NULL,
            ],
        ];
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
DenyNoCacheRoutesTest::$policy protected property The response policy under test.
DenyNoCacheRoutesTest::$request protected property A request object.
DenyNoCacheRoutesTest::$response protected property A response object.
DenyNoCacheRoutesTest::$routeMatch protected property The current route match.
DenyNoCacheRoutesTest::providerDenyNoCacheRoutesPolicy public static function Provides data and expected results for the test method.
DenyNoCacheRoutesTest::setUp protected function Overrides UnitTestCase::setUp
DenyNoCacheRoutesTest::testDenyNoCacheRoutesPolicy public function Asserts that caching is denied on the node preview route.
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
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::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::setDebugDumpHandler public static function Registers the dumper CLI handler when the DebugDump extension is enabled.

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