class AccessAwareRouterTest
@coversDefaultClass \Drupal\Core\Routing\AccessAwareRouter
      
    
@group Routing
Hierarchy
- class \Drupal\Tests\UnitTestCase uses \Drupal\Tests\PhpunitCompatibilityTrait extends \PHPUnit\Framework\TestCase- class \Drupal\Tests\Core\Routing\AccessAwareRouterTest extends \Drupal\Tests\UnitTestCase
 
Expanded class hierarchy of AccessAwareRouterTest
File
- 
              core/tests/ Drupal/ Tests/ Core/ Routing/ AccessAwareRouterTest.php, line 18 
Namespace
Drupal\Tests\Core\RoutingView source
class AccessAwareRouterTest extends UnitTestCase {
  
  /**
   * @var \Symfony\Component\Routing\Route
   */
  protected $route;
  
  /**
   * @var \Symfony\Cmf\Component\Routing\ChainRouter|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $chainRouter;
  
  /**
   * @var \Drupal\Core\Access\AccessManagerInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $accessManager;
  
  /**
   * @var \Drupal\Core\Session\AccountInterface||\PHPUnit\Framework\MockObject\MockObject
   */
  protected $currentUser;
  
  /**
   * @var \Drupal\Core\Routing\AccessAwareRouter
   */
  protected $router;
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->route = new Route('test');
    $this->accessManager = $this->createMock('Drupal\\Core\\Access\\AccessManagerInterface');
    $this->currentUser = $this->createMock('Drupal\\Core\\Session\\AccountInterface');
  }
  
  /**
   * Sets up a chain router with matchRequest.
   */
  protected function setupRouter() {
    $this->chainRouter = $this->getMockBuilder('Symfony\\Cmf\\Component\\Routing\\ChainRouter')
      ->disableOriginalConstructor()
      ->getMock();
    $this->chainRouter
      ->expects($this->once())
      ->method('matchRequest')
      ->will($this->returnValue([
      RouteObjectInterface::ROUTE_OBJECT => $this->route,
    ]));
    $this->router = new AccessAwareRouter($this->chainRouter, $this->accessManager, $this->currentUser);
  }
  
  /**
   * Tests the matchRequest() function for access allowed.
   */
  public function testMatchRequestAllowed() {
    $this->setupRouter();
    $request = new Request();
    $access_result = AccessResult::allowed();
    $this->accessManager
      ->expects($this->once())
      ->method('checkRequest')
      ->with($request)
      ->willReturn($access_result);
    $parameters = $this->router
      ->matchRequest($request);
    $expected = [
      RouteObjectInterface::ROUTE_OBJECT => $this->route,
      AccessAwareRouterInterface::ACCESS_RESULT => $access_result,
    ];
    $this->assertSame($expected, $request->attributes
      ->all());
    $this->assertSame($expected, $parameters);
  }
  
  /**
   * Tests the matchRequest() function for access denied.
   */
  public function testMatchRequestDenied() {
    $this->setupRouter();
    $request = new Request();
    $access_result = AccessResult::forbidden();
    $this->accessManager
      ->expects($this->once())
      ->method('checkRequest')
      ->with($request)
      ->willReturn($access_result);
    $this->expectException(AccessDeniedHttpException::class);
    $this->router
      ->matchRequest($request);
  }
  
  /**
   * Tests the matchRequest() function for access denied with reason message.
   */
  public function testCheckAccessResultWithReason() {
    $this->setupRouter();
    $request = new Request();
    $reason = $this->getRandomGenerator()
      ->string();
    $access_result = AccessResult::forbidden($reason);
    $this->accessManager
      ->expects($this->once())
      ->method('checkRequest')
      ->with($request)
      ->willReturn($access_result);
    $this->expectException(AccessDeniedHttpException::class);
    $this->expectExceptionMessage($reason);
    $this->router
      ->matchRequest($request);
  }
  
  /**
   * Ensure that methods are passed to the wrapped router.
   *
   * @covers ::__call
   */
  public function testCall() {
    $mock_router = $this->createMock('Symfony\\Component\\Routing\\RouterInterface');
    $this->chainRouter = $this->getMockBuilder('Symfony\\Cmf\\Component\\Routing\\ChainRouter')
      ->disableOriginalConstructor()
      ->setMethods([
      'add',
    ])
      ->getMock();
    $this->chainRouter
      ->expects($this->once())
      ->method('add')
      ->with($mock_router)
      ->willReturnSelf();
    $this->router = new AccessAwareRouter($this->chainRouter, $this->accessManager, $this->currentUser);
    $this->router
      ->add($mock_router);
  }
}Members
| Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|---|
| AccessAwareRouterTest::$accessManager | protected | property | ||||
| AccessAwareRouterTest::$chainRouter | protected | property | ||||
| AccessAwareRouterTest::$currentUser | protected | property | ||||
| AccessAwareRouterTest::$route | protected | property | ||||
| AccessAwareRouterTest::$router | protected | property | ||||
| AccessAwareRouterTest::setUp | protected | function | Overrides UnitTestCase::setUp | |||
| AccessAwareRouterTest::setupRouter | protected | function | Sets up a chain router with matchRequest. | |||
| AccessAwareRouterTest::testCall | public | function | Ensure that methods are passed to the wrapped router. | |||
| AccessAwareRouterTest::testCheckAccessResultWithReason | public | function | Tests the matchRequest() function for access denied with reason message. | |||
| AccessAwareRouterTest::testMatchRequestAllowed | public | function | Tests the matchRequest() function for access allowed. | |||
| AccessAwareRouterTest::testMatchRequestDenied | public | function | Tests the matchRequest() function for access denied. | |||
| PhpunitCompatibilityTrait::getMock | Deprecated | public | function | Returns a mock object for the specified class using the available method. | ||
| PhpunitCompatibilityTrait::setExpectedException | Deprecated | public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | ||
| UnitTestCase::$randomGenerator | protected | property | The random generator. | |||
| UnitTestCase::$root | protected | property | The app root. | 1 | ||
| UnitTestCase::assertArrayEquals | protected | function | Asserts if two arrays are equal by sorting them first. | |||
| UnitTestCase::getBlockMockWithMachineName | Deprecated | protected | function | Mocks a block with a block plugin. | 1 | |
| 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. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
