class RouteMatchTestBase
Same name in other branches
- 9 core/tests/Drupal/Tests/Core/Routing/RouteMatchTestBase.php \Drupal\Tests\Core\Routing\RouteMatchTestBase
- 8.9.x core/tests/Drupal/Tests/Core/Routing/RouteMatchTestBase.php \Drupal\Tests\Core\Routing\RouteMatchTestBase
- 10 core/tests/Drupal/Tests/Core/Routing/RouteMatchTestBase.php \Drupal\Tests\Core\Routing\RouteMatchTestBase
Base test class for testing classes implementing the route match interface.
@coversDefaultClass \Drupal\Core\Routing\RouteMatch
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait, \Drupal\Tests\RandomGeneratorTrait
- class \Drupal\Tests\Core\Routing\RouteMatchTestBase extends \Drupal\Tests\UnitTestCase
Expanded class hierarchy of RouteMatchTestBase
File
-
core/
tests/ Drupal/ Tests/ Core/ Routing/ RouteMatchTestBase.php, line 16
Namespace
Drupal\Tests\Core\RoutingView source
abstract class RouteMatchTestBase extends UnitTestCase {
/**
* Build a test route match object for the given implementation.
*
* @param string $name
* Route name.
* @param \Symfony\Component\Routing\Route $route
* Request object
* @param array $parameters
* Parameters array
* @param array $raw_parameters
* Raw parameters array
*
* @return \Drupal\Core\Routing\RouteMatchInterface
*/
protected static abstract function getRouteMatch(string $name, Route $route, array $parameters, array $raw_parameters) : RouteMatchInterface;
/**
* Provide sets of parameters and expected parameters for parameter tests.
*/
public static function routeMatchProvider() : array {
$base_data = [
[
new Route('/test-route/{param_without_leading_underscore}/{_param_with_leading_underscore}', [
'default_without_leading_underscore' => NULL,
'_default_with_leading_underscore' => NULL,
]),
[
'param_without_leading_underscore' => 'value',
'_param_with_leading_underscore' => 'value',
'default_without_leading_underscore' => 'value',
'_default_with_leading_underscore' => 'value',
'foo' => 'value',
],
// Parameters should be filtered to only those defined by the route.
// Specifically:
// - Path parameters, regardless of name.
// - Defaults that are not path parameters only if they do not start with
// an underscore.
[
'param_without_leading_underscore' => 'value',
'_param_with_leading_underscore' => 'value',
'default_without_leading_underscore' => 'value',
],
],
];
$data = [];
foreach ($base_data as $entry) {
$route = $entry[0];
$params = $entry[1];
$expected_params = $entry[2];
$data[] = [
static::getRouteMatch('test_route', $route, $params, $params),
$route,
$params,
$expected_params,
];
}
return $data;
}
/**
* @covers ::getRouteName
* @dataProvider routeMatchProvider
*/
public function testGetRouteName(RouteMatchInterface $route_match) : void {
$this->assertSame('test_route', $route_match->getRouteName());
}
/**
* @covers ::getRouteObject
* @dataProvider routeMatchProvider
*/
public function testGetRouteObject(RouteMatchInterface $route_match, Route $route) : void {
$this->assertSame($route, $route_match->getRouteObject());
}
/**
* @covers ::getParameter
* @covers \Drupal\Core\Routing\RouteMatch::getParameterNames
* @dataProvider routeMatchProvider
*/
public function testGetParameter(RouteMatchInterface $route_match, Route $route, array $parameters, array $expected_filtered_parameters) : void {
foreach ($expected_filtered_parameters as $name => $expected_value) {
$this->assertSame($expected_value, $route_match->getParameter($name));
}
foreach (array_diff_key($parameters, $expected_filtered_parameters) as $name) {
$this->assertNull($route_match->getParameter($name));
}
}
/**
* @covers ::getParameters
* @covers \Drupal\Core\Routing\RouteMatch::getParameterNames
* @dataProvider routeMatchProvider
*/
public function testGetParameters(RouteMatchInterface $route_match, Route $route, array $parameters, array $expected_filtered_parameters) : void {
$this->assertSame($expected_filtered_parameters, $route_match->getParameters()
->all());
}
/**
* @covers ::getRawParameter
* @covers \Drupal\Core\Routing\RouteMatch::getParameterNames
* @dataProvider routeMatchProvider
*/
public function testGetRawParameter(RouteMatchInterface $route_match, Route $route, array $parameters, array $expected_filtered_parameters) : void {
foreach ($expected_filtered_parameters as $name => $expected_value) {
$this->assertSame($expected_value, $route_match->getRawParameter($name));
}
foreach (array_diff_key($parameters, $expected_filtered_parameters) as $name) {
$this->assertNull($route_match->getRawParameter($name));
}
}
/**
* @covers ::getRawParameters
* @covers \Drupal\Core\Routing\RouteMatch::getParameterNames
* @dataProvider routeMatchProvider
*/
public function testGetRawParameters(RouteMatchInterface $route_match, Route $route, array $parameters, array $expected_filtered_parameters) : void {
$this->assertSame($expected_filtered_parameters, $route_match->getRawParameters()
->all());
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
ExpectDeprecationTrait::expectDeprecation | public | function | Adds an expected deprecation. | |
ExpectDeprecationTrait::getCallableName | private static | function | Returns a callable as a string suitable for inclusion in a message. | |
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. | |
RouteMatchTestBase::getRouteMatch | abstract protected static | function | Build a test route match object for the given implementation. | 2 |
RouteMatchTestBase::routeMatchProvider | public static | 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::$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::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::getStringTranslationStub | public | function | Returns a stub translation manager that just returns the passed string. | |
UnitTestCase::setUp | protected | function | 355 | |
UnitTestCase::setUpBeforeClass | public static | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.