class CurrentRouteMatchTest in Drupal 9

@coversDefaultClass \Drupal\Core\Routing\CurrentRouteMatch @group Routing

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, PhpUnitCompatibilityTrait, PhpUnitWarnings
  • class \Drupal\Tests\Core\Routing\RouteMatchTestBase
    • class \Drupal\Tests\Core\Routing\CurrentRouteMatchTest

File

core/tests/Drupal/Tests/Core/Routing/CurrentRouteMatchTest.php, line 16

Namespace

Drupal\Tests\Core\Routing

class CurrentRouteMatchTest extends RouteMatchTestBase {

  /**
   * {@inheritdoc}
   */
  protected function getRouteMatch($name, Route $route, array $parameters, array $raw_parameters) {
    $request_stack = new RequestStack();
    $request = new Request();
    $request_stack
      ->push($request);
    $request = $request_stack
      ->getCurrentRequest();
    $request->attributes = new ParameterBag($parameters);
    $request->attributes
      ->set(RouteObjectInterface::ROUTE_NAME, $name);
    $request->attributes
      ->set(RouteObjectInterface::ROUTE_OBJECT, $route);
    $request->attributes
      ->set('_raw_variables', new ParameterBag($raw_parameters));
    return new CurrentRouteMatch($request_stack);
  }

  /**
   * @covers ::__construct
   * @covers ::getRouteObject
   * @covers ::getCurrentRouteMatch
   * @covers ::getRouteMatch
   */
  public function testGetCurrentRouteObject() {
    $request_stack = new RequestStack();
    $request = new Request();
    $request_stack
      ->push($request);
    $current_route_match = new CurrentRouteMatch($request_stack);

    // Before routing.
    $this
      ->assertNull($current_route_match
      ->getRouteObject());

    // After routing.
    $route = new Route('/test-route/{foo}');
    $request->attributes
      ->set(RouteObjectInterface::ROUTE_NAME, 'test_route');
    $request->attributes
      ->set(RouteObjectInterface::ROUTE_OBJECT, $route);
    $request->attributes
      ->set('foo', '1');
    $this
      ->assertSame('1', $current_route_match
      ->getParameter('foo'));

    // Immutable for the same request once a route has been matched.
    $request->attributes
      ->set('foo', '2');
    $this
      ->assertSame('1', $current_route_match
      ->getParameter('foo'));

    // Subrequest.
    $subrequest = new Request();
    $subrequest->attributes
      ->set(RouteObjectInterface::ROUTE_NAME, 'test_subrequest_route');
    $subrequest->attributes
      ->set(RouteObjectInterface::ROUTE_OBJECT, new Route('/test-subrequest-route/{foo}'));
    $subrequest->attributes
      ->set('foo', '2');
    $request_stack
      ->push($subrequest);
    $this
      ->assertSame('2', $current_route_match
      ->getParameter('foo'));

    // Restored original request.
    $request_stack
      ->pop();
    $this
      ->assertSame('1', $current_route_match
      ->getParameter('foo'));
  }

  /**
   * @covers ::getRouteMatchFromRequest
   */
  public function testGetRouteMatchFromRequestWithRouting() {
    $request_stack = new RequestStack();
    $request = new Request();
    $request_stack
      ->push($request);
    $current_route_match = new CurrentRouteMatch($request_stack);
    $route_match = $current_route_match
      ->getRouteMatchFromRequest($request);
    $this
      ->assertNull($route_match
      ->getRouteName());
    $this
      ->assertNull($route_match
      ->getRouteObject());
  }

  /**
   * @covers ::getRouteMatchFromRequest
   */
  public function testGetRouteMatchFromRequest() {
    $request_stack = new RequestStack();
    $request = new Request();
    $request_stack
      ->push($request);
    $route = new Route('/test-route/{foo}');
    $request->attributes
      ->set(RouteObjectInterface::ROUTE_NAME, 'test_route');
    $request->attributes
      ->set(RouteObjectInterface::ROUTE_OBJECT, $route);
    $request->attributes
      ->set('foo', '1');
    $current_route_match = new CurrentRouteMatch($request_stack);
    $route_match = $current_route_match
      ->getRouteMatchFromRequest($request);
    $this
      ->assertEquals('test_route', $route_match
      ->getRouteName());
    $this
      ->assertEquals($route, $route_match
      ->getRouteObject());
  }

  /**
   * @covers ::resetRouteMatch
   */
  public function testResetRouteMatch() {
    $route = new Route('/test-route/{foo}');
    $request = new Request();
    $request->attributes
      ->set(RouteObjectInterface::ROUTE_NAME, 'test_route');
    $request->attributes
      ->set(RouteObjectInterface::ROUTE_OBJECT, $route);
    $request_stack = new RequestStack();
    $request_stack
      ->push($request);
    $current_route_match = new CurrentRouteMatch($request_stack);
    $route_name = $current_route_match
      ->getRouteName();
    $this
      ->assertSame('test_route', $route_name);

    // Replace the matched route on the request.
    $request->attributes
      ->set(RouteObjectInterface::ROUTE_NAME, NULL);
    $request->attributes
      ->set(RouteObjectInterface::ROUTE_OBJECT, NULL);

    // Reset the route match.
    $current_route_match
      ->resetRouteMatch();
    $route_name = $current_route_match
      ->getRouteName();
    $this
      ->assertNull($route_name);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CurrentRouteMatchTest::getRouteMatch	protected	function	Build a test route match object for the given implementation. Overrides RouteMatchTestBase::getRouteMatch
CurrentRouteMatchTest::testGetCurrentRouteObject	public	function	@covers ::__construct @covers ::getRouteObject @covers ::getCurrentRouteMatch @covers ::getRouteMatch
CurrentRouteMatchTest::testGetRouteMatchFromRequest	public	function	@covers ::getRouteMatchFromRequest
CurrentRouteMatchTest::testGetRouteMatchFromRequestWithRouting	public	function	@covers ::getRouteMatchFromRequest
CurrentRouteMatchTest::testResetRouteMatch	public	function	@covers ::resetRouteMatch
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.
RouteMatchTestBase::routeMatchProvider	public	function	Provide sets of parameters and expected parameters for parameter tests.
RouteMatchTestBase::testGetParameter	public	function	@covers ::getParameter @covers \Drupal\Core\Routing\RouteMatch::getParameterNames @dataProvider routeMatchProvider
RouteMatchTestBase::testGetParameters	public	function	@covers ::getParameters @covers \Drupal\Core\Routing\RouteMatch::getParameterNames @dataProvider routeMatchProvider
RouteMatchTestBase::testGetRawParameter	public	function	@covers ::getRawParameter @covers \Drupal\Core\Routing\RouteMatch::getParameterNames @dataProvider routeMatchProvider
RouteMatchTestBase::testGetRawParameters	public	function	@covers ::getRawParameters @covers \Drupal\Core\Routing\RouteMatch::getParameterNames @dataProvider routeMatchProvider
RouteMatchTestBase::testGetRouteName	public	function	@covers ::getRouteName @dataProvider routeMatchProvider
RouteMatchTestBase::testGetRouteObject	public	function	@covers ::getRouteObject @dataProvider routeMatchProvider
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::setUp	protected	function		308
UnitTestCase::setUpBeforeClass	public static	function