class CustomAccessCheckTest

Same name in other branches
  1. 8.9.x core/tests/Drupal/Tests/Core/Access/CustomAccessCheckTest.php \Drupal\Tests\Core\Access\CustomAccessCheckTest
  2. 10 core/tests/Drupal/Tests/Core/Access/CustomAccessCheckTest.php \Drupal\Tests\Core\Access\CustomAccessCheckTest
  3. 11.x core/tests/Drupal/Tests/Core/Access/CustomAccessCheckTest.php \Drupal\Tests\Core\Access\CustomAccessCheckTest

@coversDefaultClass \Drupal\Core\Access\CustomAccessCheck @group Access

Hierarchy

Expanded class hierarchy of CustomAccessCheckTest

File

core/tests/Drupal/Tests/Core/Access/CustomAccessCheckTest.php, line 24

Namespace

Drupal\Tests\Core\Access
View source
class CustomAccessCheckTest extends UnitTestCase {
    
    /**
     * The access checker to test.
     *
     * @var \Drupal\Core\Access\CustomAccessCheck
     */
    protected $accessChecker;
    
    /**
     * The mocked controller resolver.
     *
     * @var \Drupal\Core\Controller\ControllerResolverInterface|\PHPUnit\Framework\MockObject\MockObject
     */
    protected $controllerResolver;
    
    /**
     * The mocked arguments resolver.
     *
     * @var \Drupal\Core\Access\AccessArgumentsResolverFactoryInterface|\PHPUnit\Framework\MockObject\MockObject
     */
    protected $argumentsResolverFactory;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->controllerResolver = $this->createMock('Drupal\\Core\\Controller\\ControllerResolverInterface');
        $this->argumentsResolverFactory = $this->createMock('Drupal\\Core\\Access\\AccessArgumentsResolverFactoryInterface');
        $this->accessChecker = new CustomAccessCheck($this->controllerResolver, $this->argumentsResolverFactory);
    }
    
    /**
     * Tests the access method.
     */
    public function testAccess() {
        $route_match = $this->createMock('Drupal\\Core\\Routing\\RouteMatchInterface');
        $this->controllerResolver
            ->expects($this->exactly(3))
            ->method('getControllerFromDefinition')
            ->willReturnMap([
            [
                '\\Drupal\\Tests\\Core\\Access\\TestController::accessDeny',
                [
                    new TestController(),
                    'accessDeny',
                ],
            ],
            [
                '\\Drupal\\Tests\\Core\\Access\\TestController::accessAllow',
                [
                    new TestController(),
                    'accessAllow',
                ],
            ],
            [
                '\\Drupal\\Tests\\Core\\Access\\TestController::accessParameter',
                [
                    new TestController(),
                    'accessParameter',
                ],
            ],
        ]);
        $resolver0 = $this->createMock('Drupal\\Component\\Utility\\ArgumentsResolverInterface');
        $resolver0->expects($this->once())
            ->method('getArguments')
            ->willReturn([]);
        $resolver1 = $this->createMock('Drupal\\Component\\Utility\\ArgumentsResolverInterface');
        $resolver1->expects($this->once())
            ->method('getArguments')
            ->willReturn([]);
        $resolver2 = $this->createMock('Drupal\\Component\\Utility\\ArgumentsResolverInterface');
        $resolver2->expects($this->once())
            ->method('getArguments')
            ->willReturn([
            'parameter' => 'TRUE',
        ]);
        $this->argumentsResolverFactory
            ->expects($this->exactly(3))
            ->method('getArgumentsResolver')
            ->willReturnOnConsecutiveCalls($resolver0, $resolver1, $resolver2);
        $route = new Route('/test-route', [], [
            '_custom_access' => '\\Drupal\\Tests\\Core\\Access\\TestController::accessDeny',
        ]);
        $account = $this->createMock('Drupal\\Core\\Session\\AccountInterface');
        $this->assertEquals(AccessResult::neutral(), $this->accessChecker
            ->access($route, $route_match, $account));
        $route = new Route('/test-route', [], [
            '_custom_access' => '\\Drupal\\Tests\\Core\\Access\\TestController::accessAllow',
        ]);
        $this->assertEquals(AccessResult::allowed(), $this->accessChecker
            ->access($route, $route_match, $account));
        $route = new Route('/test-route', [
            'parameter' => 'TRUE',
        ], [
            '_custom_access' => '\\Drupal\\Tests\\Core\\Access\\TestController::accessParameter',
        ]);
        $this->assertEquals(AccessResult::allowed(), $this->accessChecker
            ->access($route, $route_match, $account));
    }
    
    /**
     * Tests the access method exception for invalid access callbacks.
     */
    public function testAccessException() {
        // Create two mocks for the ControllerResolver constructor.
        $httpMessageFactory = $this->getMockBuilder(HttpMessageFactoryInterface::class)
            ->getMock();
        $controllerResolver = $this->getMockBuilder(ClassResolverInterface::class)
            ->getMock();
        // Re-create the controllerResolver mock with proxy to original methods.
        $this->controllerResolver = $this->getMockBuilder(ControllerResolver::class)
            ->setConstructorArgs([
            $httpMessageFactory,
            $controllerResolver,
        ])
            ->enableProxyingToOriginalMethods()
            ->getMock();
        // Overwrite the access checker using the newly mocked controller resolve.
        $this->accessChecker = new CustomAccessCheck($this->controllerResolver, $this->argumentsResolverFactory);
        // Add a route with a _custom_access route that doesn't exist.
        $route = new Route('/test-route', [], [
            '_custom_access' => '\\Drupal\\Tests\\Core\\Access\\NonExistentController::nonExistentMethod',
        ]);
        $route_match = $this->createMock(RouteMatchInterface::class);
        $account = $this->createMock(AccountInterface::class);
        $this->expectException(\BadMethodCallException::class);
        $this->expectExceptionMessage('The "\\Drupal\\Tests\\Core\\Access\\NonExistentController::nonExistentMethod" method is not callable as a _custom_access callback in route "/test-route"');
        // Run the access check.
        $this->accessChecker
            ->access($route, $route_match, $account);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
CustomAccessCheckTest::$accessChecker protected property The access checker to test.
CustomAccessCheckTest::$argumentsResolverFactory protected property The mocked arguments resolver.
CustomAccessCheckTest::$controllerResolver protected property The mocked controller resolver.
CustomAccessCheckTest::setUp protected function Overrides UnitTestCase::setUp
CustomAccessCheckTest::testAccess public function Tests the access method.
CustomAccessCheckTest::testAccessException public function Tests the access method exception for invalid access callbacks.
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.
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root. 1
UnitTestCase::assertArrayEquals Deprecated protected function Asserts if two arrays are equal by sorting them first.
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::getRandomGenerator protected function Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName public function Generates a unique random string containing letters and numbers.
UnitTestCase::setUpBeforeClass public static function

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