View source
<?php
namespace Drupal\KernelTests\Core\Routing;
use Drupal\Core\Cache\MemoryBackend;
use Drupal\Core\Database\Database;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\KeyValueStore\KeyValueMemoryFactory;
use Drupal\Core\Path\CurrentPathStack;
use Drupal\Core\Routing\MatcherDumper;
use Drupal\Core\Routing\RouteProvider;
use Drupal\Core\State\State;
use Drupal\KernelTests\KernelTestBase;
use Drupal\language\Entity\ConfigurableLanguage;
use Drupal\Tests\Core\Routing\RoutingFixtures;
use Drupal\Tests\Traits\Core\PathAliasTestTrait;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Routing\Exception\ResourceNotFoundException;
use Symfony\Component\Routing\Exception\RouteNotFoundException;
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;
class RouteProviderTest extends KernelTestBase {
use PathAliasTestTrait;
protected static $modules = [
'url_alter_test',
'system',
'language',
'path_alias',
];
protected $fixtures;
protected $state;
protected $currentPath;
protected $cache;
protected $pathProcessor;
protected $cacheTagsInvalidator;
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');
}
public function register(ContainerBuilder $container) {
parent::register($container);
if ($container
->hasDefinition('path_alias.path_processor')) {
$definition = $container
->getDefinition('path_alias.path_processor');
$definition
->addTag('path_processor_inbound');
}
}
protected function tearDown() : void {
$this->fixtures
->dropTables(Database::getConnection());
parent::tearDown();
}
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);
}
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.');
}
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');
}
}
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);
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.');
}
public function providerMixedCaseRoutePaths() {
return [
[
'/path/one',
'route_a',
],
[
'/path/two',
NULL,
],
[
'/PATH/one',
'route_a',
],
[
'/path/2/one',
'route_b',
'PUT',
],
[
'/paTH/3/one',
'route_b',
'PUT',
],
[
'/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',
],
];
}
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.');
}
}
public function providerDuplicateRoutePaths() {
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',
],
];
}
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.');
}
}
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']);
}
}
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);
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.');
}
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);
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.');
}
}
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);
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.');
}
}
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.');
}
}
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'));
$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.');
}
}
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);
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');
}
}
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.');
}
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();
$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']);
$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']);
$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']);
$this
->createPathAlias('/path/add/one', '/path/add-one');
$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']);
$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']);
}
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());
}
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);
$shortest = '/test/1/test2';
$result = $provider
->getRoutesByPattern($shortest);
$this
->assertEquals(0, $result
->count());
$candidates = $provider
->getCandidateOutlines(explode('/', trim($shortest, '/')));
$this
->assertCount(7, $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);
$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());
$this
->assertEquals(serialize($collection
->get('long_pattern')), serialize($result
->get('long_pattern')), 'The right route was found.');
$candidates = $provider
->getCandidateOutlines(explode('/', trim($path_to_test, '/')));
$this
->assertCount(1, $candidates);
$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);
$result = $provider
->getRoutesByPattern($shortest);
$this
->assertEquals(0, $result
->count());
$candidates = $provider
->getCandidateOutlines(explode('/', trim($shortest, '/')));
$this
->assertCount(7, $candidates);
}
}
class TestRouteProvider extends RouteProvider {
public function getCandidateOutlines(array $parts) {
return parent::getCandidateOutlines($parts);
}
}