class CustomAccessCheckTest
Same name and namespace in other branches
- 11.x core/tests/Drupal/Tests/Core/Access/CustomAccessCheckTest.php \Drupal\Tests\Core\Access\CustomAccessCheckTest
- 10 core/tests/Drupal/Tests/Core/Access/CustomAccessCheckTest.php \Drupal\Tests\Core\Access\CustomAccessCheckTest
- 9 core/tests/Drupal/Tests/Core/Access/CustomAccessCheckTest.php \Drupal\Tests\Core\Access\CustomAccessCheckTest
- 8.9.x core/tests/Drupal/Tests/Core/Access/CustomAccessCheckTest.php \Drupal\Tests\Core\Access\CustomAccessCheckTest
Tests Drupal\Core\Access\CustomAccessCheck.
Attributes
#[CoversClass(CustomAccessCheck::class)]
#[Group('Access')]
Hierarchy
- class \Drupal\Tests\UnitTestCase uses \Drupal\Tests\DrupalTestCaseTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\Tests\RandomGeneratorTrait extends \PHPUnit\Framework\TestCase
- class \Drupal\Tests\Core\Access\CustomAccessCheckTest extends \Drupal\Tests\UnitTestCase
Expanded class hierarchy of CustomAccessCheckTest
File
-
core/
tests/ Drupal/ Tests/ Core/ Access/ CustomAccessCheckTest.php, line 22
Namespace
Drupal\Tests\Core\AccessView source
class CustomAccessCheckTest extends UnitTestCase {
/**
* Tests the access method.
*/
public function testAccess() : void {
$callableResolver = $this->createMock(CallableResolver::class);
$argumentsResolverFactory = $this->createMock(AccessArgumentsResolverFactoryInterface::class);
$accessChecker = new CustomAccessCheck($callableResolver, $argumentsResolverFactory);
$route_match = $this->createStub(RouteMatchInterface::class);
$callableResolver->expects($this->exactly(4))
->method('getCallableFromDefinition')
->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',
],
],
[
'\\Drupal\\Tests\\Core\\Access\\TestController::accessRequest',
[
new TestController(),
'accessRequest',
],
],
]);
$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',
]);
$request = Request::create('/foo?example=muh');
$resolver3 = $this->createMock('Drupal\\Component\\Utility\\ArgumentsResolverInterface');
$resolver3->expects($this->once())
->method('getArguments')
->willReturn([
'request' => $request,
]);
$argumentsResolverFactory->expects($this->exactly(4))
->method('getArgumentsResolver')
->willReturnOnConsecutiveCalls($resolver0, $resolver1, $resolver2, $resolver3);
$route = new Route('/test-route', [], [
'_custom_access' => '\\Drupal\\Tests\\Core\\Access\\TestController::accessDeny',
]);
$account = $this->createStub(AccountInterface::class);
$this->assertEquals(AccessResult::neutral(), $accessChecker->access($route, $route_match, $account, $request));
$route = new Route('/test-route', [], [
'_custom_access' => '\\Drupal\\Tests\\Core\\Access\\TestController::accessAllow',
]);
$this->assertEquals(AccessResult::allowed(), $accessChecker->access($route, $route_match, $account, $request));
$route = new Route('/test-route', [
'parameter' => 'TRUE',
], [
'_custom_access' => '\\Drupal\\Tests\\Core\\Access\\TestController::accessParameter',
]);
$this->assertEquals(AccessResult::allowed(), $accessChecker->access($route, $route_match, $account, $request));
$route = new Route('/test-route', [
'parameter' => 'TRUE',
], [
'_custom_access' => '\\Drupal\\Tests\\Core\\Access\\TestController::accessRequest',
]);
$this->assertEquals(AccessResult::allowed(), $accessChecker->access($route, $route_match, $account, $request));
}
/**
* Tests the access method exception for invalid access callbacks.
*/
public function testAccessException() : void {
// Create callableResolver mock to return InvalidArgumentException.
$callableResolver = $this->createStub(CallableResolver::class);
$callableResolver->method('getCallableFromDefinition')
->willThrowException(new \InvalidArgumentException());
$accessChecker = new CustomAccessCheck($callableResolver, $this->createStub(AccessArgumentsResolverFactoryInterface::class));
// 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->createStub(RouteMatchInterface::class);
$account = $this->createStub(AccountInterface::class);
$request = Request::create('/foo?example=muh');
$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.
$accessChecker->access($route, $route_match, $account, $request);
}
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overrides |
|---|---|---|---|---|
| CustomAccessCheckTest::testAccess | public | function | Tests the access method. | |
| CustomAccessCheckTest::testAccessException | public | function | Tests the access method exception for invalid access callbacks. | |
| DrupalTestCaseTrait::checkErrorHandlerOnTearDown | public | function | Checks the test error handler after test execution. | 1 |
| 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. | |
| UnitTestCase::setUp | protected | function | 355 | |
| UnitTestCase::setupMockIterator | protected | function | Set up a traversable class mock to return specific items when iterated. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.