class RouteProviderTest
Same name in this branch
- 9 core/tests/Drupal/KernelTests/Core/Entity/RouteProviderTest.php \Drupal\KernelTests\Core\Entity\RouteProviderTest
Same name in other branches
- 8.9.x core/tests/Drupal/KernelTests/Core/Routing/RouteProviderTest.php \Drupal\KernelTests\Core\Routing\RouteProviderTest
- 8.9.x core/tests/Drupal/KernelTests/Core/Entity/RouteProviderTest.php \Drupal\KernelTests\Core\Entity\RouteProviderTest
- 10 core/tests/Drupal/KernelTests/Core/Routing/RouteProviderTest.php \Drupal\KernelTests\Core\Routing\RouteProviderTest
- 10 core/tests/Drupal/KernelTests/Core/Entity/RouteProviderTest.php \Drupal\KernelTests\Core\Entity\RouteProviderTest
- 11.x core/tests/Drupal/KernelTests/Core/Routing/RouteProviderTest.php \Drupal\KernelTests\Core\Routing\RouteProviderTest
- 11.x core/tests/Drupal/KernelTests/Core/Entity/RouteProviderTest.php \Drupal\KernelTests\Core\Entity\RouteProviderTest
Confirm that the default route provider is working correctly.
@group Routing
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements \Drupal\Core\DependencyInjection\ServiceProviderInterface uses \Drupal\KernelTests\AssertLegacyTrait, \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\ExtensionListTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\Traits\PhpUnitWarnings, \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait
- class \Drupal\KernelTests\Core\Routing\RouteProviderTest extends \Drupal\KernelTests\KernelTestBase uses \Drupal\Tests\Traits\Core\PathAliasTestTrait
Expanded class hierarchy of RouteProviderTest
File
-
core/
tests/ Drupal/ KernelTests/ Core/ Routing/ RouteProviderTest.php, line 34
Namespace
Drupal\KernelTests\Core\RoutingView source
class RouteProviderTest extends KernelTestBase {
use PathAliasTestTrait;
/**
* Modules to enable.
*/
protected static $modules = [
'url_alter_test',
'system',
'language',
'path_alias',
];
/**
* A collection of shared fixture data for tests.
*
* @var \Drupal\Tests\Core\Routing\RoutingFixtures
*/
protected $fixtures;
/**
* The state.
*
* @var \Drupal\Core\State\StateInterface
*/
protected $state;
/**
* The current path.
*
* @var \Drupal\Core\Path\CurrentPathStack
*/
protected $currentPath;
/**
* The cache backend.
*
* @var \Drupal\Core\Cache\MemoryBackend
*/
protected $cache;
/**
* The inbound path processor.
*
* @var \Drupal\Core\PathProcessor\InboundPathProcessorInterface
*/
protected $pathProcessor;
/**
* The cache tags invalidator.
*
* @var \Drupal\Core\Cache\CacheTagsInvalidatorInterface
*/
protected $cacheTagsInvalidator;
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->fixtures = new RoutingFixtures();
$this->state = new State(new KeyValueMemoryFactory());
$this->currentPath = new CurrentPathStack(new RequestStack());
$this->cache = new MemoryBackend();
$this->pathProcessor = \Drupal::service('path_processor_manager');
$this->cacheTagsInvalidator = \Drupal::service('cache_tags.invalidator');
$this->installEntitySchema('path_alias');
}
/**
* {@inheritdoc}
*/
public function register(ContainerBuilder $container) {
parent::register($container);
// Read the incoming path alias for these tests.
if ($container->hasDefinition('path_alias.path_processor')) {
$definition = $container->getDefinition('path_alias.path_processor');
$definition->addTag('path_processor_inbound');
}
}
/**
* {@inheritdoc}
*/
protected function tearDown() : void {
$this->fixtures
->dropTables(Database::getConnection());
parent::tearDown();
}
/**
* Confirms that the correct candidate outlines are generated.
*/
public function testCandidateOutlines() {
$connection = Database::getConnection();
$provider = new TestRouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
$parts = [
'node',
'5',
'edit',
];
$candidates = $provider->getCandidateOutlines($parts);
$candidates = array_flip($candidates);
$this->assertCount(7, $candidates, 'Correct number of candidates found');
$this->assertArrayHasKey('/node/5/edit', $candidates);
$this->assertArrayHasKey('/node/5/%', $candidates);
$this->assertArrayHasKey('/node/%/edit', $candidates);
$this->assertArrayHasKey('/node/%/%', $candidates);
$this->assertArrayHasKey('/node/5', $candidates);
$this->assertArrayHasKey('/node/%', $candidates);
$this->assertArrayHasKey('/node', $candidates);
}
/**
* Don't fail when given an empty path.
*/
public function testEmptyPathCandidatesOutlines() {
$provider = new TestRouteProvider(Database::getConnection(), $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
$candidates = $provider->getCandidateOutlines([]);
$this->assertCount(0, $candidates, 'Empty parts should return no candidates.');
}
/**
* Confirms that we can find routes with the exact incoming path.
*/
public function testExactPathMatch() {
$connection = Database::getConnection();
$provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
$this->fixtures
->createTables($connection);
$dumper = new MatcherDumper($connection, $this->state, 'test_routes');
$dumper->addRoutes($this->fixtures
->sampleRouteCollection());
$dumper->dump();
$path = '/path/one';
$request = Request::create($path, 'GET');
$routes = $provider->getRouteCollectionForRequest($request);
foreach ($routes as $route) {
$this->assertEquals($path, $route->getPath(), 'Found path has correct pattern');
}
}
/**
* Confirms that we can find routes whose pattern would match the request.
*/
public function testOutlinePathMatch() {
$connection = Database::getConnection();
$provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
$this->fixtures
->createTables($connection);
$dumper = new MatcherDumper($connection, $this->state, 'test_routes');
$dumper->addRoutes($this->fixtures
->complexRouteCollection());
$dumper->dump();
$path = '/path/1/one';
$request = Request::create($path, 'GET');
$routes = $provider->getRouteCollectionForRequest($request);
// All of the matching paths have the correct pattern.
foreach ($routes as $route) {
$this->assertEquals('/path/%/one', $route->compile()
->getPatternOutline(), 'Found path has correct pattern');
}
$this->assertCount(2, $routes, 'The correct number of routes was found.');
$this->assertNotNull($routes->get('route_a'), 'The first matching route was found.');
$this->assertNotNull($routes->get('route_b'), 'The second matching route was not found.');
}
/**
* Data provider for testMixedCasePaths()
*/
public function providerMixedCaseRoutePaths() {
// cSpell:disable
return [
[
'/path/one',
'route_a',
],
[
'/path/two',
NULL,
],
[
'/PATH/one',
'route_a',
],
[
'/path/2/one',
'route_b',
'PUT',
],
[
'/paTH/3/one',
'route_b',
'PUT',
],
// There should be no lower case of a Hebrew letter.
[
'/somewhere/4/over/the/קainbow',
'route_c',
],
[
'/Somewhere/5/over/the/קainboW',
'route_c',
],
[
'/another/llama/aboUT/22',
'route_d',
],
[
'/another/llama/about/22',
'route_d',
],
[
'/place/meΦω',
'route_e',
'HEAD',
],
[
'/place/meφΩ',
'route_e',
'HEAD',
],
];
// cSpell:enable
}
/**
* Confirms that we find routes using a case-insensitive path match.
*
* @dataProvider providerMixedCaseRoutePaths
*/
public function testMixedCasePaths($path, $expected_route_name, $method = 'GET') {
$connection = Database::getConnection();
$provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
$this->fixtures
->createTables($connection);
$dumper = new MatcherDumper($connection, $this->state, 'test_routes');
$dumper->addRoutes($this->fixtures
->mixedCaseRouteCollection());
$dumper->dump();
$request = Request::create($path, $method);
$routes = $provider->getRouteCollectionForRequest($request);
if ($expected_route_name) {
$this->assertCount(1, $routes, 'The correct number of routes was found.');
$this->assertNotNull($routes->get($expected_route_name), 'The first matching route was found.');
}
else {
$this->assertCount(0, $routes, 'No routes matched.');
}
}
/**
* Data provider for testMixedCasePaths()
*/
public function providerDuplicateRoutePaths() {
// When matching routes with the same fit the route with the lowest-sorting
// name should end up first in the resulting route collection.
return [
[
'/path/one',
3,
'route_a',
],
[
'/PATH/one',
3,
'route_a',
],
[
'/path/two',
1,
'route_d',
],
[
'/PATH/three',
0,
],
[
'/place/meΦω',
2,
'route_e',
],
[
'/placE/meφΩ',
2,
'route_e',
],
];
}
/**
* Confirms that we find all routes with the same path.
*
* @dataProvider providerDuplicateRoutePaths
*/
public function testDuplicateRoutePaths($path, $number, $expected_route_name = NULL) {
$connection = Database::getConnection();
$provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
$this->fixtures
->createTables($connection);
$dumper = new MatcherDumper($connection, $this->state, 'test_routes');
$dumper->addRoutes($this->fixtures
->duplicatePathsRouteCollection());
$dumper->dump();
$request = Request::create($path);
$routes = $provider->getRouteCollectionForRequest($request);
$this->assertCount($number, $routes, 'The correct number of routes was found.');
if ($expected_route_name) {
$route_name = $routes->getIterator()
->key();
$this->assertEquals($expected_route_name, $route_name, 'The expected route name was found.');
}
}
/**
* Confirms RouteProvider::getAllRoutes() extracts information correctly from the database.
*/
public function testGetAllRoutes() {
$connection = Database::getConnection();
$provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
$this->fixtures
->createTables($connection);
$dumper = new MatcherDumper($connection, $this->state, 'test_routes');
$dumper->addRoutes($this->fixtures
->SampleRouteCollection());
$dumper->dump();
$sample_routes = $this->fixtures
->staticSampleRouteCollection();
$returned_routes = $provider->getAllRoutes();
$this->assertInstanceOf(\Iterator::class, $returned_routes);
$this->assertSameSize($sample_routes, $returned_routes);
foreach ($returned_routes as $route_name => $route) {
$this->assertArrayHasKey($route_name, $sample_routes);
$this->assertEquals($route->getPath(), $sample_routes[$route_name]['path']);
}
}
/**
* Confirms that a trailing slash on the request does not result in a 404.
*/
public function testOutlinePathMatchTrailingSlash() {
$connection = Database::getConnection();
$provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
$this->fixtures
->createTables($connection);
$dumper = new MatcherDumper($connection, $this->state, 'test_routes');
$dumper->addRoutes($this->fixtures
->complexRouteCollection());
$dumper->dump();
$path = '/path/1/one/';
$request = Request::create($path, 'GET');
$routes = $provider->getRouteCollectionForRequest($request);
// All of the matching paths have the correct pattern.
foreach ($routes as $route) {
$this->assertEquals('/path/%/one', $route->compile()
->getPatternOutline(), 'Found path has correct pattern');
}
$this->assertCount(2, $routes, 'The correct number of routes was found.');
$this->assertNotNull($routes->get('route_a'), 'The first matching route was found.');
$this->assertNotNull($routes->get('route_b'), 'The second matching route was not found.');
}
/**
* Confirms that we can find routes whose pattern would match the request.
*/
public function testOutlinePathMatchDefaults() {
$connection = Database::getConnection();
$provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
$this->fixtures
->createTables($connection);
$collection = new RouteCollection();
$collection->add('poink', new Route('/some/path/{value}', [
'value' => 'poink',
]));
$dumper = new MatcherDumper($connection, $this->state, 'test_routes');
$dumper->addRoutes($collection);
$dumper->dump();
$path = '/some/path';
$request = Request::create($path, 'GET');
try {
$routes = $provider->getRouteCollectionForRequest($request);
// All of the matching paths have the correct pattern.
foreach ($routes as $route) {
$this->assertEquals('/some/path', $route->compile()
->getPatternOutline(), 'Found path has correct pattern');
}
$this->assertCount(1, $routes, 'The correct number of routes was found.');
$this->assertNotNull($routes->get('poink'), 'The first matching route was found.');
} catch (ResourceNotFoundException $e) {
$this->fail('No matching route found with default argument value.');
}
}
/**
* Confirms that we can find routes whose pattern would match the request.
*/
public function testOutlinePathMatchDefaultsCollision() {
$connection = Database::getConnection();
$provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
$this->fixtures
->createTables($connection);
$collection = new RouteCollection();
$collection->add('poink', new Route('/some/path/{value}', [
'value' => 'poink',
]));
$collection->add('narf', new Route('/some/path/here'));
$dumper = new MatcherDumper($connection, $this->state, 'test_routes');
$dumper->addRoutes($collection);
$dumper->dump();
$path = '/some/path';
$request = Request::create($path, 'GET');
try {
$routes = $provider->getRouteCollectionForRequest($request);
// All of the matching paths have the correct pattern.
foreach ($routes as $route) {
$this->assertEquals('/some/path', $route->compile()
->getPatternOutline(), 'Found path has correct pattern');
}
$this->assertCount(1, $routes, 'The correct number of routes was found.');
$this->assertNotNull($routes->get('poink'), 'The first matching route was found.');
} catch (ResourceNotFoundException $e) {
$this->fail('No matching route found with default argument value.');
}
}
/**
* Confirms that we can find routes whose pattern would match the request.
*/
public function testOutlinePathMatchDefaultsCollision2() {
$connection = Database::getConnection();
$provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
$this->fixtures
->createTables($connection);
$collection = new RouteCollection();
$collection->add('poink', new Route('/some/path/{value}', [
'value' => 'poink',
]));
$collection->add('narf', new Route('/some/path/here'));
$collection->add('eep', new Route('/something/completely/different'));
$dumper = new MatcherDumper($connection, $this->state, 'test_routes');
$dumper->addRoutes($collection);
$dumper->dump();
$path = '/some/path/here';
$request = Request::create($path, 'GET');
try {
$routes = $provider->getRouteCollectionForRequest($request);
$routes_array = $routes->all();
$this->assertCount(2, $routes, 'The correct number of routes was found.');
$this->assertEquals([
'narf',
'poink',
], array_keys($routes_array), 'Ensure the fitness was taken into account.');
$this->assertNotNull($routes->get('narf'), 'The first matching route was found.');
$this->assertNotNull($routes->get('poink'), 'The second matching route was found.');
$this->assertNull($routes->get('eep'), 'Non-matching route was not found.');
} catch (ResourceNotFoundException $e) {
$this->fail('No matching route found with default argument value.');
}
}
/**
* Confirms that we can find multiple routes that match the request equally.
*/
public function testOutlinePathMatchDefaultsCollision3() {
$connection = Database::getConnection();
$provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
$this->fixtures
->createTables($connection);
$collection = new RouteCollection();
$collection->add('poink', new Route('/some/{value}/path'));
// Add a second route matching the same path pattern.
$collection->add('poink2', new Route('/some/{object}/path'));
$collection->add('narf', new Route('/some/here/path'));
$collection->add('eep', new Route('/something/completely/different'));
$dumper = new MatcherDumper($connection, $this->state, 'test_routes');
$dumper->addRoutes($collection);
$dumper->dump();
$path = '/some/over-there/path';
$request = Request::create($path, 'GET');
try {
$routes = $provider->getRouteCollectionForRequest($request);
$routes_array = $routes->all();
$this->assertCount(2, $routes, 'The correct number of routes was found.');
$this->assertEquals([
'poink',
'poink2',
], array_keys($routes_array), 'Ensure the fitness and name were taken into account in the sort.');
$this->assertNotNull($routes->get('poink'), 'The first matching route was found.');
$this->assertNotNull($routes->get('poink2'), 'The second matching route was found.');
$this->assertNull($routes->get('eep'), 'Non-matching route was not found.');
} catch (ResourceNotFoundException $e) {
$this->fail('No matching route found with default argument value.');
}
}
/**
* Tests a route with a 0 as value.
*/
public function testOutlinePathMatchZero() {
$connection = Database::getConnection();
$provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
$this->fixtures
->createTables($connection);
$collection = new RouteCollection();
$collection->add('poink', new Route('/some/path/{value}'));
$dumper = new MatcherDumper($connection, $this->state, 'test_routes');
$dumper->addRoutes($collection);
$dumper->dump();
$path = '/some/path/0';
$request = Request::create($path, 'GET');
try {
$routes = $provider->getRouteCollectionForRequest($request);
// All of the matching paths have the correct pattern.
foreach ($routes as $route) {
$this->assertEquals('/some/path/%', $route->compile()
->getPatternOutline(), 'Found path has correct pattern');
}
$this->assertCount(1, $routes, 'The correct number of routes was found.');
} catch (ResourceNotFoundException $e) {
$this->fail('No matchout route found with 0 as argument value');
}
}
/**
* Confirms that an exception is thrown when no matching path is found.
*/
public function testOutlinePathNoMatch() {
$connection = Database::getConnection();
$provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
$this->fixtures
->createTables($connection);
$dumper = new MatcherDumper($connection, $this->state, 'test_routes');
$dumper->addRoutes($this->fixtures
->complexRouteCollection());
$dumper->dump();
$path = '/no/such/path';
$request = Request::create($path, 'GET');
$routes = $provider->getRoutesByPattern($path);
$this->assertEmpty($routes, 'No path found with this pattern.');
$collection = $provider->getRouteCollectionForRequest($request);
$this->assertEmpty($collection, 'Empty route collection found with this pattern.');
}
/**
* Tests that route caching works.
*/
public function testRouteCaching() {
$connection = Database::getConnection();
$language_manager = \Drupal::languageManager();
$provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes', $language_manager);
$this->fixtures
->createTables($connection);
$dumper = new MatcherDumper($connection, $this->state, 'test_routes');
$dumper->addRoutes($this->fixtures
->sampleRouteCollection());
$dumper->addRoutes($this->fixtures
->complexRouteCollection());
$dumper->dump();
// A simple path.
$path = '/path/add/one';
$request = Request::create($path, 'GET');
$provider->getRouteCollectionForRequest($request);
$cache = $this->cache
->get('route:[language]=en:/path/add/one:');
$this->assertEquals('/path/add/one', $cache->data['path']);
$this->assertEquals([], $cache->data['query']);
$this->assertCount(3, $cache->data['routes']);
// A path with query parameters.
$path = '/path/add/one?foo=bar';
$request = Request::create($path, 'GET');
$provider->getRouteCollectionForRequest($request);
$cache = $this->cache
->get('route:[language]=en:/path/add/one:foo=bar');
$this->assertEquals('/path/add/one', $cache->data['path']);
$this->assertEquals([
'foo' => 'bar',
], $cache->data['query']);
$this->assertCount(3, $cache->data['routes']);
// A path with placeholders.
$path = '/path/1/one';
$request = Request::create($path, 'GET');
$provider->getRouteCollectionForRequest($request);
$cache = $this->cache
->get('route:[language]=en:/path/1/one:');
$this->assertEquals('/path/1/one', $cache->data['path']);
$this->assertEquals([], $cache->data['query']);
$this->assertCount(2, $cache->data['routes']);
// A path with a path alias.
$this->createPathAlias('/path/add/one', '/path/add-one');
/** @var \Drupal\path_alias\AliasManagerInterface $alias_manager */
$alias_manager = \Drupal::service('path_alias.manager');
$alias_manager->cacheClear();
$path = '/path/add-one';
$request = Request::create($path, 'GET');
$provider->getRouteCollectionForRequest($request);
$cache = $this->cache
->get('route:[language]=en:/path/add-one:');
$this->assertEquals('/path/add/one', $cache->data['path']);
$this->assertEquals([], $cache->data['query']);
$this->assertCount(3, $cache->data['routes']);
// Test with a different current language by switching out the default
// language.
$swiss = ConfigurableLanguage::createFromLangcode('gsw-berne');
$language_manager->reset();
\Drupal::service('language.default')->set($swiss);
$path = '/path/add-one';
$request = Request::create($path, 'GET');
$provider->getRouteCollectionForRequest($request);
$cache = $this->cache
->get('route:[language]=gsw-berne:/path/add-one:');
$this->assertEquals('/path/add/one', $cache->data['path']);
$this->assertEquals([], $cache->data['query']);
$this->assertCount(3, $cache->data['routes']);
}
/**
* Tests RouteProvider::getRouteByName() & RouteProvider::getRoutesByNames().
*/
public function testRouteByName() {
$connection = Database::getConnection();
$provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
$this->fixtures
->createTables($connection);
$dumper = new MatcherDumper($connection, $this->state, 'test_routes');
$dumper->addRoutes($this->fixtures
->sampleRouteCollection());
$dumper->dump();
$route = $provider->getRouteByName('route_a');
$this->assertEquals('/path/one', $route->getPath(), 'The right route pattern was found.');
$this->assertEquals([
'GET',
], $route->getMethods(), 'The right route method was found.');
$route = $provider->getRouteByName('route_b');
$this->assertEquals('/path/one', $route->getPath(), 'The right route pattern was found.');
$this->assertEquals([
'PUT',
], $route->getMethods(), 'The right route method was found.');
$exception_thrown = FALSE;
try {
$provider->getRouteByName('invalid_name');
} catch (RouteNotFoundException $e) {
$exception_thrown = TRUE;
}
$this->assertTrue($exception_thrown, 'Random route was not found.');
$routes = $provider->getRoutesByNames([
'route_c',
'route_d',
$this->randomMachineName(),
]);
$this->assertCount(2, $routes, 'Only two valid routes found.');
$this->assertEquals('/path/two', $routes['route_c']->getPath());
$this->assertEquals('/path/three', $routes['route_d']->getPath());
}
/**
* Ensures that the routing system is capable of extreme long patterns.
*/
public function testGetRoutesByPatternWithLongPatterns() {
$connection = Database::getConnection();
$provider = new TestRouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
$this->fixtures
->createTables($connection);
// This pattern has only 3 parts, so we will get candidates, but no routes,
// even though we have not dumped the routes yet.
$shortest = '/test/1/test2';
$result = $provider->getRoutesByPattern($shortest);
$this->assertEquals(0, $result->count());
$candidates = $provider->getCandidateOutlines(explode('/', trim($shortest, '/')));
$this->assertCount(7, $candidates);
// A longer patten is not found and returns no candidates
$path_to_test = '/test/1/test2/2/test3/3/4/5/6/test4';
$result = $provider->getRoutesByPattern($path_to_test);
$this->assertEquals(0, $result->count());
$candidates = $provider->getCandidateOutlines(explode('/', trim($path_to_test, '/')));
$this->assertCount(0, $candidates);
// Add a matching route and dump it.
$dumper = new MatcherDumper($connection, $this->state, 'test_routes');
$collection = new RouteCollection();
$collection->add('long_pattern', new Route('/test/{v1}/test2/{v2}/test3/{v3}/{v4}/{v5}/{v6}/test4'));
$dumper->addRoutes($collection);
$dumper->dump();
$result = $provider->getRoutesByPattern($path_to_test);
$this->assertEquals(1, $result->count());
// We can't compare the values of the routes directly, nor use
// spl_object_hash() because they are separate instances.
$this->assertEquals(serialize($collection->get('long_pattern')), serialize($result->get('long_pattern')), 'The right route was found.');
// We now have a single candidate outline.
$candidates = $provider->getCandidateOutlines(explode('/', trim($path_to_test, '/')));
$this->assertCount(1, $candidates);
// Longer and shorter patterns are not found. Both are longer than 3, so
// we should not have any candidates either. The fact that we do not
// get any candidates for a longer path is a security feature.
$longer = '/test/1/test2/2/test3/3/4/5/6/test4/trailing/more/parts';
$result = $provider->getRoutesByPattern($longer);
$this->assertEquals(0, $result->count());
$candidates = $provider->getCandidateOutlines(explode('/', trim($longer, '/')));
$this->assertCount(1, $candidates);
$shorter = '/test/1/test2/2/test3';
$result = $provider->getRoutesByPattern($shorter);
$this->assertEquals(0, $result->count());
$candidates = $provider->getCandidateOutlines(explode('/', trim($shorter, '/')));
$this->assertCount(0, $candidates);
// This pattern has only 3 parts, so we will get candidates, but no routes.
// This result is unchanged by running the dumper.
$result = $provider->getRoutesByPattern($shortest);
$this->assertEquals(0, $result->count());
$candidates = $provider->getCandidateOutlines(explode('/', trim($shortest, '/')));
$this->assertCount(7, $candidates);
}
/**
* Tests getRoutesPaged().
*
* @group legacy
*/
public function testGetRoutesPaged() {
$this->expectDeprecation('Drupal\\Core\\Routing\\RouteProvider::getRoutesPaged() is deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. No direct replacement is provided. See https://www.drupal.org/node/3151009');
$connection = Database::getConnection();
$provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
$this->fixtures
->createTables($connection);
$dumper = new MatcherDumper($connection, $this->state, 'test_routes');
$dumper->addRoutes($this->fixtures
->sampleRouteCollection());
$dumper->dump();
$fixture_routes = $this->fixtures
->staticSampleRouteCollection();
// Query all the routes.
$routes = $provider->getRoutesPaged(0);
$this->assertEquals(array_keys($fixture_routes), array_keys($routes));
// Query non routes.
$routes = $provider->getRoutesPaged(0, 0);
$this->assertEquals([], array_keys($routes));
// Query a limited sets of routes.
$routes = $provider->getRoutesPaged(1, 2);
$this->assertEquals(array_slice(array_keys($fixture_routes), 1, 2), array_keys($routes));
}
/**
* Tests getRoutesCount().
*
* @group legacy
*/
public function testGetRoutesCount() {
$this->expectDeprecation('Drupal\\Core\\Routing\\RouteProvider::getRoutesCount() is deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. No direct replacement is provided. See https://www.drupal.org/node/3151009');
$connection = Database::getConnection();
$provider = new RouteProvider($connection, $this->state, $this->currentPath, $this->cache, $this->pathProcessor, $this->cacheTagsInvalidator, 'test_routes');
$this->fixtures
->createTables($connection);
$dumper = new MatcherDumper($connection, $this->state, 'test_routes');
$dumper->addRoutes($this->fixtures
->sampleRouteCollection());
$dumper->dump();
$this->assertEquals(5, $provider->getRoutesCount());
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
AssertContentTrait::$content | protected | property | The current raw content. | |||
AssertContentTrait::$drupalSettings | protected | property | The drupalSettings value from the current raw $content. | |||
AssertContentTrait::$elements | protected | property | The XML structure parsed from the current raw $content. | 1 | ||
AssertContentTrait::$plainTextContent | protected | property | The plain-text content of raw $content (text nodes). | |||
AssertContentTrait::assertEscaped | protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |||
AssertContentTrait::assertField | protected | function | Asserts that a field exists with the given name or ID. | |||
AssertContentTrait::assertFieldById | protected | function | Asserts that a field exists with the given ID and value. | |||
AssertContentTrait::assertFieldByName | protected | function | Asserts that a field exists with the given name and value. | |||
AssertContentTrait::assertFieldByXPath | protected | function | Asserts that a field exists in the current page by the given XPath. | |||
AssertContentTrait::assertFieldChecked | protected | function | Asserts that a checkbox field in the current page is checked. | |||
AssertContentTrait::assertFieldsByValue | protected | function | Asserts that a field exists in the current page with a given Xpath result. | |||
AssertContentTrait::assertLink | protected | function | Passes if a link with the specified label is found. | |||
AssertContentTrait::assertLinkByHref | protected | function | Passes if a link containing a given href (part) is found. | |||
AssertContentTrait::assertNoDuplicateIds | protected | function | Asserts that each HTML ID is used for just a single element. | |||
AssertContentTrait::assertNoEscaped | protected | function | Passes if raw text IS NOT found escaped on loaded page, fail otherwise. | |||
AssertContentTrait::assertNoField | protected | function | Asserts that a field does not exist with the given name or ID. | |||
AssertContentTrait::assertNoFieldById | protected | function | Asserts that a field does not exist with the given ID and value. | |||
AssertContentTrait::assertNoFieldByName | protected | function | Asserts that a field does not exist with the given name and value. | |||
AssertContentTrait::assertNoFieldByXPath | protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |||
AssertContentTrait::assertNoFieldChecked | protected | function | Asserts that a checkbox field in the current page is not checked. | |||
AssertContentTrait::assertNoLink | protected | function | Passes if a link with the specified label is not found. | |||
AssertContentTrait::assertNoLinkByHref | protected | function | Passes if a link containing a given href (part) is not found. | |||
AssertContentTrait::assertNoLinkByHrefInMainRegion | protected | function | Passes if a link containing a given href is not found in the main region. | |||
AssertContentTrait::assertNoOption | protected | function | Asserts that a select option in the current page does not exist. | |||
AssertContentTrait::assertNoOptionSelected | protected | function | Asserts that a select option in the current page is not checked. | |||
AssertContentTrait::assertNoPattern | protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |||
AssertContentTrait::assertNoRaw | protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |||
AssertContentTrait::assertNoText | protected | function | Passes if the page (with HTML stripped) does not contains the text. | |||
AssertContentTrait::assertNoTitle | protected | function | Pass if the page title is not the given string. | |||
AssertContentTrait::assertNoUniqueText | protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |||
AssertContentTrait::assertOption | protected | function | Asserts that a select option in the current page exists. | |||
AssertContentTrait::assertOptionByText | protected | function | Asserts that a select option with the visible text exists. | |||
AssertContentTrait::assertOptionSelected | protected | function | Asserts that a select option in the current page is checked. | |||
AssertContentTrait::assertOptionSelectedWithDrupalSelector | protected | function | Asserts that a select option in the current page is checked. | |||
AssertContentTrait::assertOptionWithDrupalSelector | protected | function | Asserts that a select option in the current page exists. | |||
AssertContentTrait::assertPattern | protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |||
AssertContentTrait::assertRaw | protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |||
AssertContentTrait::assertText | protected | function | Passes if the page (with HTML stripped) contains the text. | |||
AssertContentTrait::assertTextHelper | protected | function | Helper for assertText and assertNoText. | |||
AssertContentTrait::assertTextPattern | protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |||
AssertContentTrait::assertThemeOutput | protected | function | Asserts themed output. | |||
AssertContentTrait::assertTitle | protected | function | Pass if the page title is the given string. | |||
AssertContentTrait::assertUniqueText | protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |||
AssertContentTrait::assertUniqueTextHelper | protected | function | Helper for assertUniqueText and assertNoUniqueText. | |||
AssertContentTrait::buildXPathQuery | protected | function | Builds an XPath query. | |||
AssertContentTrait::constructFieldXpath | protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |||
AssertContentTrait::cssSelect | protected | function | Searches elements using a CSS selector in the raw content. | |||
AssertContentTrait::getAllOptions | protected | function | Get all option elements, including nested options, in a select. | |||
AssertContentTrait::getDrupalSettings | protected | function | Gets the value of drupalSettings for the currently-loaded page. | |||
AssertContentTrait::getRawContent | protected | function | Gets the current raw content. | |||
AssertContentTrait::getSelectedItem | protected | function | Get the selected value from a select field. | |||
AssertContentTrait::getTextContent | protected | function | Retrieves the plain-text content from the current raw content. | |||
AssertContentTrait::getUrl | protected | function | Get the current URL from the cURL handler. | 1 | ||
AssertContentTrait::parse | protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |||
AssertContentTrait::removeWhiteSpace | protected | function | Removes all white-space between HTML tags from the raw content. | |||
AssertContentTrait::setDrupalSettings | protected | function | Sets the value of drupalSettings for the currently-loaded page. | |||
AssertContentTrait::setRawContent | protected | function | Sets the raw content (e.g. HTML). | |||
AssertContentTrait::xpath | protected | function | Performs an xpath search on the contents of the internal browser. | |||
AssertLegacyTrait::assert | Deprecated | protected | function | |||
AssertLegacyTrait::assertEqual | Deprecated | protected | function | |||
AssertLegacyTrait::assertIdentical | Deprecated | protected | function | |||
AssertLegacyTrait::assertIdenticalObject | Deprecated | protected | function | |||
AssertLegacyTrait::assertNotEqual | Deprecated | protected | function | |||
AssertLegacyTrait::assertNotIdentical | Deprecated | protected | function | |||
AssertLegacyTrait::pass | Deprecated | protected | function | |||
AssertLegacyTrait::verbose | Deprecated | protected | function | |||
ConfigTestTrait::configImporter | protected | function | Returns a ConfigImporter object to import test configuration. | |||
ConfigTestTrait::copyConfig | protected | function | Copies configuration objects from source storage to target storage. | |||
ExtensionListTestTrait::getModulePath | protected | function | Gets the path for the specified module. | |||
ExtensionListTestTrait::getThemePath | protected | function | Gets the path for the specified theme. | |||
KernelTestBase::$backupGlobals | protected | property | Back up and restore any global variables that may be changed by tests. | |||
KernelTestBase::$backupStaticAttributes | protected | property | Back up and restore static class properties that may be changed by tests. | |||
KernelTestBase::$backupStaticAttributesBlacklist | protected | property | Contains a few static class properties for performance. | |||
KernelTestBase::$classLoader | protected | property | ||||
KernelTestBase::$configImporter | protected | property | @todo Move into Config test base class. | 6 | ||
KernelTestBase::$configSchemaCheckerExclusions | protected static | property | An array of config object names that are excluded from schema checking. | |||
KernelTestBase::$container | protected | property | ||||
KernelTestBase::$databasePrefix | protected | property | ||||
KernelTestBase::$keyValue | protected | property | The key_value service that must persist between container rebuilds. | |||
KernelTestBase::$preserveGlobalState | protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. |
|||
KernelTestBase::$root | protected | property | The app root. | |||
KernelTestBase::$runTestInSeparateProcess | protected | property | Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property. |
|||
KernelTestBase::$siteDirectory | protected | property | ||||
KernelTestBase::$strictConfigSchema | protected | property | Set to TRUE to strict check all configuration saved. | 7 | ||
KernelTestBase::$vfsRoot | protected | property | The virtual filesystem root directory. | |||
KernelTestBase::assertPostConditions | protected | function | 1 | |||
KernelTestBase::bootEnvironment | protected | function | Bootstraps a basic test environment. | |||
KernelTestBase::bootKernel | private | function | Bootstraps a kernel for a test. | |||
KernelTestBase::config | protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |||
KernelTestBase::disableModules | protected | function | Disables modules for this test. | |||
KernelTestBase::enableModules | protected | function | Enables modules for this test. | |||
KernelTestBase::getConfigSchemaExclusions | protected | function | Gets the config schema exclusions for this test. | |||
KernelTestBase::getDatabaseConnectionInfo | protected | function | Returns the Database connection info to be used for this test. | 3 | ||
KernelTestBase::getDatabasePrefix | public | function | ||||
KernelTestBase::getExtensionsForModules | private | function | Returns Extension objects for $modules to enable. | |||
KernelTestBase::getModulesToEnable | private static | function | Returns the modules to enable for this test. | |||
KernelTestBase::initFileCache | protected | function | Initializes the FileCache component. | |||
KernelTestBase::installConfig | protected | function | Installs default configuration for a given list of modules. | |||
KernelTestBase::installEntitySchema | protected | function | Installs the storage schema for a specific entity type. | |||
KernelTestBase::installSchema | protected | function | Installs database tables from a module schema definition. | |||
KernelTestBase::render | protected | function | Renders a render array. | 1 | ||
KernelTestBase::setInstallProfile | protected | function | Sets the install profile and rebuilds the container to update it. | |||
KernelTestBase::setSetting | protected | function | Sets an in-memory Settings variable. | |||
KernelTestBase::setUpBeforeClass | public static | function | 1 | |||
KernelTestBase::setUpFilesystem | protected | function | Sets up the filesystem, so things like the file directory. | 3 | ||
KernelTestBase::stop | protected | function | Stops test execution. | |||
KernelTestBase::tearDownCloseDatabaseConnection | public | function | @after | |||
KernelTestBase::vfsDump | protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |||
KernelTestBase::__sleep | public | function | Prevents serializing any properties. | |||
PathAliasTestTrait::assertPathAliasExists | protected | function | Asserts that a path alias exists in the storage. | |||
PathAliasTestTrait::assertPathAliasNotExists | protected | function | Asserts that a path alias does not exist in the storage. | |||
PathAliasTestTrait::createPathAlias | protected | function | Creates a new path alias. | |||
PathAliasTestTrait::loadPathAliasByConditions | protected | function | Gets the first result from a 'load by properties' storage call. | |||
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. | |||
RandomGeneratorTrait::$randomGenerator | protected | property | The random generator. | |||
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. | 1 | ||
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. | |||
RandomGeneratorTrait::randomStringValidate | public | function | Callback for random string validation. | |||
RouteProviderTest::$cache | protected | property | The cache backend. | |||
RouteProviderTest::$cacheTagsInvalidator | protected | property | The cache tags invalidator. | |||
RouteProviderTest::$currentPath | protected | property | The current path. | |||
RouteProviderTest::$fixtures | protected | property | A collection of shared fixture data for tests. | |||
RouteProviderTest::$modules | protected static | property | Modules to enable. | Overrides KernelTestBase::$modules | ||
RouteProviderTest::$pathProcessor | protected | property | The inbound path processor. | |||
RouteProviderTest::$state | protected | property | The state. | |||
RouteProviderTest::providerDuplicateRoutePaths | public | function | Data provider for testMixedCasePaths() | |||
RouteProviderTest::providerMixedCaseRoutePaths | public | function | Data provider for testMixedCasePaths() | |||
RouteProviderTest::register | public | function | Registers test-specific services. | Overrides KernelTestBase::register | ||
RouteProviderTest::setUp | protected | function | Overrides KernelTestBase::setUp | |||
RouteProviderTest::tearDown | protected | function | Overrides KernelTestBase::tearDown | |||
RouteProviderTest::testCandidateOutlines | public | function | Confirms that the correct candidate outlines are generated. | |||
RouteProviderTest::testDuplicateRoutePaths | public | function | Confirms that we find all routes with the same path. | |||
RouteProviderTest::testEmptyPathCandidatesOutlines | public | function | Don't fail when given an empty path. | |||
RouteProviderTest::testExactPathMatch | public | function | Confirms that we can find routes with the exact incoming path. | |||
RouteProviderTest::testGetAllRoutes | public | function | Confirms RouteProvider::getAllRoutes() extracts information correctly from the database. | |||
RouteProviderTest::testGetRoutesByPatternWithLongPatterns | public | function | Ensures that the routing system is capable of extreme long patterns. | |||
RouteProviderTest::testGetRoutesCount | public | function | Tests getRoutesCount(). | |||
RouteProviderTest::testGetRoutesPaged | public | function | Tests getRoutesPaged(). | |||
RouteProviderTest::testMixedCasePaths | public | function | Confirms that we find routes using a case-insensitive path match. | |||
RouteProviderTest::testOutlinePathMatch | public | function | Confirms that we can find routes whose pattern would match the request. | |||
RouteProviderTest::testOutlinePathMatchDefaults | public | function | Confirms that we can find routes whose pattern would match the request. | |||
RouteProviderTest::testOutlinePathMatchDefaultsCollision | public | function | Confirms that we can find routes whose pattern would match the request. | |||
RouteProviderTest::testOutlinePathMatchDefaultsCollision2 | public | function | Confirms that we can find routes whose pattern would match the request. | |||
RouteProviderTest::testOutlinePathMatchDefaultsCollision3 | public | function | Confirms that we can find multiple routes that match the request equally. | |||
RouteProviderTest::testOutlinePathMatchTrailingSlash | public | function | Confirms that a trailing slash on the request does not result in a 404. | |||
RouteProviderTest::testOutlinePathMatchZero | public | function | Tests a route with a 0 as value. | |||
RouteProviderTest::testOutlinePathNoMatch | public | function | Confirms that an exception is thrown when no matching path is found. | |||
RouteProviderTest::testRouteByName | public | function | Tests RouteProvider::getRouteByName() & RouteProvider::getRoutesByNames(). | |||
RouteProviderTest::testRouteCaching | public | function | Tests that route caching works. | |||
StorageCopyTrait::replaceStorageContents | protected static | function | Copy the configuration from one storage to another and remove stale items. | |||
TestRequirementsTrait::checkModuleRequirements | private | function | Checks missing module requirements. | |||
TestRequirementsTrait::checkRequirements | protected | function | Check module requirements for the Drupal use case. | |||
TestRequirementsTrait::getDrupalRoot | protected static | function | Returns the Drupal root directory. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.