View source
<?php
namespace Drupal\system\Tests\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\Tests\Core\Routing\RoutingFixtures;
use Drupal\simpletest\KernelTestBase;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Routing\Exception\RouteNotFoundException;
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;
use Symfony\Component\Routing\Exception\ResourceNotFoundException;
class RouteProviderTest extends KernelTestBase {
public static $modules = [
'url_alter_test',
'system',
];
protected $fixtures;
protected $state;
protected $currentPath;
protected $cache;
protected $pathProcessor;
protected $cacheTagsInvalidator;
protected function setUp() {
parent::setUp();
$this->fixtures = new RoutingFixtures();
$this->state = new State(new KeyValueMemoryFactory());
$this->currentPath = new CurrentPathStack(new RequestStack());
$this->cache = new MemoryBackend('data');
$this->pathProcessor = \Drupal::service('path_processor_manager');
$this->cacheTagsInvalidator = \Drupal::service('cache_tags.invalidator');
$this
->installSchema('system', 'url_alias');
}
public function containerBuild(ContainerBuilder $container) {
parent::containerBuild($container);
if ($container
->hasDefinition('path_processor_alias')) {
$definition = $container
->getDefinition('path_processor_alias');
$definition
->addTag('path_processor_inbound');
}
}
protected function tearDown() {
$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 = array(
'node',
'5',
'edit',
);
$candidates = $provider
->getCandidateOutlines($parts);
$candidates = array_flip($candidates);
$this
->assertTrue(count($candidates) == 7, 'Correct number of candidates found');
$this
->assertTrue(array_key_exists('/node/5/edit', $candidates), 'First candidate found.');
$this
->assertTrue(array_key_exists('/node/5/%', $candidates), 'Second candidate found.');
$this
->assertTrue(array_key_exists('/node/%/edit', $candidates), 'Third candidate found.');
$this
->assertTrue(array_key_exists('/node/%/%', $candidates), 'Fourth candidate found.');
$this
->assertTrue(array_key_exists('/node/5', $candidates), 'Fifth candidate found.');
$this
->assertTrue(array_key_exists('/node/%', $candidates), 'Sixth candidate found.');
$this
->assertTrue(array_key_exists('/node', $candidates), 'Seventh candidate found.');
}
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
->assertEqual($route
->getPath(), $path, 'Found path has correct pattern');
}
}
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
->assertEqual($route
->compile()
->getPatternOutline(), '/path/%/one', 'Found path has correct pattern');
}
$this
->assertEqual(count($routes), 2, '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.');
}
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
->assertEqual($route
->compile()
->getPatternOutline(), '/path/%/one', 'Found path has correct pattern');
}
$this
->assertEqual(count($routes), 2, '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.');
}
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}', array(
'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
->assertEqual($route
->compile()
->getPatternOutline(), '/some/path', 'Found path has correct pattern');
}
$this
->assertEqual(count($routes), 1, '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.');
}
}
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}', array(
'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
->assertEqual($route
->compile()
->getPatternOutline(), '/some/path', 'Found path has correct pattern');
}
$this
->assertEqual(count($routes), 1, '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.');
}
}
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}', array(
'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
->assertEqual(count($routes), 2, 'The correct number of routes was found.');
$this
->assertEqual(array(
'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.');
}
}
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
->assertEqual(count($routes), 2, 'The correct number of routes was found.');
$this
->assertEqual(array(
'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
->assertEqual($route
->compile()
->getPatternOutline(), '/some/path/%', 'Found path has correct pattern');
}
$this
->assertEqual(count($routes), 1, 'The correct number of routes was found.');
} catch (ResourceNotFoundException $e) {
$this
->fail('No matchout route found with 0 as argument value');
}
}
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
->assertFalse(count($routes), 'No path found with this pattern.');
$collection = $provider
->getRouteCollectionForRequest($request);
$this
->assertTrue(count($collection) == 0, 'Empty route collection found with this pattern.');
}
public function testRouteCaching() {
$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
->addRoutes($this->fixtures
->complexRouteCollection());
$dumper
->dump();
$path = '/path/add/one';
$request = Request::create($path, 'GET');
$provider
->getRouteCollectionForRequest($request);
$cache = $this->cache
->get('route:/path/add/one:');
$this
->assertEqual('/path/add/one', $cache->data['path']);
$this
->assertEqual([], $cache->data['query']);
$this
->assertEqual(3, count($cache->data['routes']));
$path = '/path/add/one?foo=bar';
$request = Request::create($path, 'GET');
$provider
->getRouteCollectionForRequest($request);
$cache = $this->cache
->get('route:/path/add/one:foo=bar');
$this
->assertEqual('/path/add/one', $cache->data['path']);
$this
->assertEqual([
'foo' => 'bar',
], $cache->data['query']);
$this
->assertEqual(3, count($cache->data['routes']));
$path = '/path/1/one';
$request = Request::create($path, 'GET');
$provider
->getRouteCollectionForRequest($request);
$cache = $this->cache
->get('route:/path/1/one:');
$this
->assertEqual('/path/1/one', $cache->data['path']);
$this
->assertEqual([], $cache->data['query']);
$this
->assertEqual(2, count($cache->data['routes']));
$path_storage = \Drupal::service('path.alias_storage');
$path_storage
->save('/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:/path/add-one:');
$this
->assertEqual('/path/add/one', $cache->data['path']);
$this
->assertEqual([], $cache->data['query']);
$this
->assertEqual(3, count($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
->assertEqual($route
->getPath(), '/path/one', 'The right route pattern was found.');
$this
->assertEqual($route
->getMethods(), [
'GET',
], 'The right route method was found.');
$route = $provider
->getRouteByName('route_b');
$this
->assertEqual($route
->getPath(), '/path/one', 'The right route pattern was found.');
$this
->assertEqual($route
->getMethods(), [
'PUT',
], '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(array(
'route_c',
'route_d',
$this
->randomMachineName(),
));
$this
->assertEqual(count($routes), 2, 'Only two valid routes found.');
$this
->assertEqual($routes['route_c']
->getPath(), '/path/two');
$this
->assertEqual($routes['route_d']
->getPath(), '/path/three');
}
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
->assertEqual($result
->count(), 0);
$candidates = $provider
->getCandidateOutlines(explode('/', trim($shortest, '/')));
$this
->assertEqual(count($candidates), 7);
$path_to_test = '/test/1/test2/2/test3/3/4/5/6/test4';
$result = $provider
->getRoutesByPattern($path_to_test);
$this
->assertEqual($result
->count(), 0);
$candidates = $provider
->getCandidateOutlines(explode('/', trim($path_to_test, '/')));
$this
->assertEqual(count($candidates), 0);
$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
->assertEqual($result
->count(), 1);
$this
->assertEqual(serialize($result
->get('long_pattern')), serialize($collection
->get('long_pattern')), 'The right route was found.');
$candidates = $provider
->getCandidateOutlines(explode('/', trim($path_to_test, '/')));
$this
->assertEqual(count($candidates), 1);
$longer = '/test/1/test2/2/test3/3/4/5/6/test4/trailing/more/parts';
$result = $provider
->getRoutesByPattern($longer);
$this
->assertEqual($result
->count(), 0);
$candidates = $provider
->getCandidateOutlines(explode('/', trim($longer, '/')));
$this
->assertEqual(count($candidates), 1);
$shorter = '/test/1/test2/2/test3';
$result = $provider
->getRoutesByPattern($shorter);
$this
->assertEqual($result
->count(), 0);
$candidates = $provider
->getCandidateOutlines(explode('/', trim($shorter, '/')));
$this
->assertEqual(count($candidates), 0);
$result = $provider
->getRoutesByPattern($shortest);
$this
->assertEqual($result
->count(), 0);
$candidates = $provider
->getCandidateOutlines(explode('/', trim($shortest, '/')));
$this
->assertEqual(count($candidates), 7);
}
public function testGetRoutesPaged() {
$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();
$routes = $provider
->getRoutesPaged(0);
$this
->assertEqual(array_keys($routes), array_keys($fixture_routes));
$routes = $provider
->getRoutesPaged(0, 0);
$this
->assertEqual(array_keys($routes), []);
$routes = $provider
->getRoutesPaged(1, 2);
$this
->assertEqual(array_keys($routes), array_slice(array_keys($fixture_routes), 1, 2));
}
}
class TestRouteProvider extends RouteProvider {
public function getCandidateOutlines(array $parts) {
return parent::getCandidateOutlines($parts);
}
}