123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\Routing\Tests\Matcher;
- use PHPUnit\Framework\TestCase;
- use Symfony\Component\Routing\Exception\MethodNotAllowedException;
- use Symfony\Component\Routing\Exception\ResourceNotFoundException;
- use Symfony\Component\Routing\Matcher\UrlMatcher;
- use Symfony\Component\Routing\Route;
- use Symfony\Component\Routing\RouteCollection;
- use Symfony\Component\Routing\RequestContext;
- class UrlMatcherTest extends TestCase
- {
- public function testNoMethodSoAllowed()
- {
- $coll = new RouteCollection();
- $coll->add('foo', new Route('/foo'));
- $matcher = new UrlMatcher($coll, new RequestContext());
- $this->assertInternalType('array', $matcher->match('/foo'));
- }
- public function testMethodNotAllowed()
- {
- $coll = new RouteCollection();
- $coll->add('foo', new Route('/foo', array(), array(), array(), '', array(), array('post')));
- $matcher = new UrlMatcher($coll, new RequestContext());
- try {
- $matcher->match('/foo');
- $this->fail();
- } catch (MethodNotAllowedException $e) {
- $this->assertEquals(array('POST'), $e->getAllowedMethods());
- }
- }
- public function testHeadAllowedWhenRequirementContainsGet()
- {
- $coll = new RouteCollection();
- $coll->add('foo', new Route('/foo', array(), array(), array(), '', array(), array('get')));
- $matcher = new UrlMatcher($coll, new RequestContext('', 'head'));
- $this->assertInternalType('array', $matcher->match('/foo'));
- }
- public function testMethodNotAllowedAggregatesAllowedMethods()
- {
- $coll = new RouteCollection();
- $coll->add('foo1', new Route('/foo', array(), array(), array(), '', array(), array('post')));
- $coll->add('foo2', new Route('/foo', array(), array(), array(), '', array(), array('put', 'delete')));
- $matcher = new UrlMatcher($coll, new RequestContext());
- try {
- $matcher->match('/foo');
- $this->fail();
- } catch (MethodNotAllowedException $e) {
- $this->assertEquals(array('POST', 'PUT', 'DELETE'), $e->getAllowedMethods());
- }
- }
- public function testMatch()
- {
- // test the patterns are matched and parameters are returned
- $collection = new RouteCollection();
- $collection->add('foo', new Route('/foo/{bar}'));
- $matcher = new UrlMatcher($collection, new RequestContext());
- try {
- $matcher->match('/no-match');
- $this->fail();
- } catch (ResourceNotFoundException $e) {
- }
- $this->assertEquals(array('_route' => 'foo', 'bar' => 'baz'), $matcher->match('/foo/baz'));
- // test that defaults are merged
- $collection = new RouteCollection();
- $collection->add('foo', new Route('/foo/{bar}', array('def' => 'test')));
- $matcher = new UrlMatcher($collection, new RequestContext());
- $this->assertEquals(array('_route' => 'foo', 'bar' => 'baz', 'def' => 'test'), $matcher->match('/foo/baz'));
- // test that route "method" is ignored if no method is given in the context
- $collection = new RouteCollection();
- $collection->add('foo', new Route('/foo', array(), array(), array(), '', array(), array('get', 'head')));
- $matcher = new UrlMatcher($collection, new RequestContext());
- $this->assertInternalType('array', $matcher->match('/foo'));
- // route does not match with POST method context
- $matcher = new UrlMatcher($collection, new RequestContext('', 'post'));
- try {
- $matcher->match('/foo');
- $this->fail();
- } catch (MethodNotAllowedException $e) {
- }
- // route does match with GET or HEAD method context
- $matcher = new UrlMatcher($collection, new RequestContext());
- $this->assertInternalType('array', $matcher->match('/foo'));
- $matcher = new UrlMatcher($collection, new RequestContext('', 'head'));
- $this->assertInternalType('array', $matcher->match('/foo'));
- // route with an optional variable as the first segment
- $collection = new RouteCollection();
- $collection->add('bar', new Route('/{bar}/foo', array('bar' => 'bar'), array('bar' => 'foo|bar')));
- $matcher = new UrlMatcher($collection, new RequestContext());
- $this->assertEquals(array('_route' => 'bar', 'bar' => 'bar'), $matcher->match('/bar/foo'));
- $this->assertEquals(array('_route' => 'bar', 'bar' => 'foo'), $matcher->match('/foo/foo'));
- $collection = new RouteCollection();
- $collection->add('bar', new Route('/{bar}', array('bar' => 'bar'), array('bar' => 'foo|bar')));
- $matcher = new UrlMatcher($collection, new RequestContext());
- $this->assertEquals(array('_route' => 'bar', 'bar' => 'foo'), $matcher->match('/foo'));
- $this->assertEquals(array('_route' => 'bar', 'bar' => 'bar'), $matcher->match('/'));
- // route with only optional variables
- $collection = new RouteCollection();
- $collection->add('bar', new Route('/{foo}/{bar}', array('foo' => 'foo', 'bar' => 'bar'), array()));
- $matcher = new UrlMatcher($collection, new RequestContext());
- $this->assertEquals(array('_route' => 'bar', 'foo' => 'foo', 'bar' => 'bar'), $matcher->match('/'));
- $this->assertEquals(array('_route' => 'bar', 'foo' => 'a', 'bar' => 'bar'), $matcher->match('/a'));
- $this->assertEquals(array('_route' => 'bar', 'foo' => 'a', 'bar' => 'b'), $matcher->match('/a/b'));
- }
- public function testMatchWithPrefixes()
- {
- $collection = new RouteCollection();
- $collection->add('foo', new Route('/{foo}'));
- $collection->addPrefix('/b');
- $collection->addPrefix('/a');
- $matcher = new UrlMatcher($collection, new RequestContext());
- $this->assertEquals(array('_route' => 'foo', 'foo' => 'foo'), $matcher->match('/a/b/foo'));
- }
- public function testMatchWithDynamicPrefix()
- {
- $collection = new RouteCollection();
- $collection->add('foo', new Route('/{foo}'));
- $collection->addPrefix('/b');
- $collection->addPrefix('/{_locale}');
- $matcher = new UrlMatcher($collection, new RequestContext());
- $this->assertEquals(array('_locale' => 'fr', '_route' => 'foo', 'foo' => 'foo'), $matcher->match('/fr/b/foo'));
- }
- public function testMatchSpecialRouteName()
- {
- $collection = new RouteCollection();
- $collection->add('$péß^a|', new Route('/bar'));
- $matcher = new UrlMatcher($collection, new RequestContext());
- $this->assertEquals(array('_route' => '$péß^a|'), $matcher->match('/bar'));
- }
- public function testMatchNonAlpha()
- {
- $collection = new RouteCollection();
- $chars = '!"$%éà &\'()*+,./:;<=>@ABCDEFGHIJKLMNOPQRSTUVWXYZ\\[]^_`abcdefghijklmnopqrstuvwxyz{|}~-';
- $collection->add('foo', new Route('/{foo}/bar', array(), array('foo' => '['.preg_quote($chars).']+'), array('utf8' => true)));
- $matcher = new UrlMatcher($collection, new RequestContext());
- $this->assertEquals(array('_route' => 'foo', 'foo' => $chars), $matcher->match('/'.rawurlencode($chars).'/bar'));
- $this->assertEquals(array('_route' => 'foo', 'foo' => $chars), $matcher->match('/'.strtr($chars, array('%' => '%25')).'/bar'));
- }
- public function testMatchWithDotMetacharacterInRequirements()
- {
- $collection = new RouteCollection();
- $collection->add('foo', new Route('/{foo}/bar', array(), array('foo' => '.+')));
- $matcher = new UrlMatcher($collection, new RequestContext());
- $this->assertEquals(array('_route' => 'foo', 'foo' => "\n"), $matcher->match('/'.urlencode("\n").'/bar'), 'linefeed character is matched');
- }
- public function testMatchOverriddenRoute()
- {
- $collection = new RouteCollection();
- $collection->add('foo', new Route('/foo'));
- $collection1 = new RouteCollection();
- $collection1->add('foo', new Route('/foo1'));
- $collection->addCollection($collection1);
- $matcher = new UrlMatcher($collection, new RequestContext());
- $this->assertEquals(array('_route' => 'foo'), $matcher->match('/foo1'));
- $this->{method_exists($this, $_ = 'expectException') ? $_ : 'setExpectedException'}('Symfony\Component\Routing\Exception\ResourceNotFoundException');
- $this->assertEquals(array(), $matcher->match('/foo'));
- }
- public function testMatchRegression()
- {
- $coll = new RouteCollection();
- $coll->add('foo', new Route('/foo/{foo}'));
- $coll->add('bar', new Route('/foo/bar/{foo}'));
- $matcher = new UrlMatcher($coll, new RequestContext());
- $this->assertEquals(array('foo' => 'bar', '_route' => 'bar'), $matcher->match('/foo/bar/bar'));
- $collection = new RouteCollection();
- $collection->add('foo', new Route('/{bar}'));
- $matcher = new UrlMatcher($collection, new RequestContext());
- try {
- $matcher->match('/');
- $this->fail();
- } catch (ResourceNotFoundException $e) {
- }
- }
- public function testDefaultRequirementForOptionalVariables()
- {
- $coll = new RouteCollection();
- $coll->add('test', new Route('/{page}.{_format}', array('page' => 'index', '_format' => 'html')));
- $matcher = new UrlMatcher($coll, new RequestContext());
- $this->assertEquals(array('page' => 'my-page', '_format' => 'xml', '_route' => 'test'), $matcher->match('/my-page.xml'));
- }
- public function testMatchingIsEager()
- {
- $coll = new RouteCollection();
- $coll->add('test', new Route('/{foo}-{bar}-', array(), array('foo' => '.+', 'bar' => '.+')));
- $matcher = new UrlMatcher($coll, new RequestContext());
- $this->assertEquals(array('foo' => 'text1-text2-text3', 'bar' => 'text4', '_route' => 'test'), $matcher->match('/text1-text2-text3-text4-'));
- }
- public function testAdjacentVariables()
- {
- $coll = new RouteCollection();
- $coll->add('test', new Route('/{w}{x}{y}{z}.{_format}', array('z' => 'default-z', '_format' => 'html'), array('y' => 'y|Y')));
- $matcher = new UrlMatcher($coll, new RequestContext());
- // 'w' eagerly matches as much as possible and the other variables match the remaining chars.
- // This also shows that the variables w-z must all exclude the separating char (the dot '.' in this case) by default requirement.
- // Otherwise they would also consume '.xml' and _format would never match as it's an optional variable.
- $this->assertEquals(array('w' => 'wwwww', 'x' => 'x', 'y' => 'Y', 'z' => 'Z', '_format' => 'xml', '_route' => 'test'), $matcher->match('/wwwwwxYZ.xml'));
- // As 'y' has custom requirement and can only be of value 'y|Y', it will leave 'ZZZ' to variable z.
- // So with carefully chosen requirements adjacent variables, can be useful.
- $this->assertEquals(array('w' => 'wwwww', 'x' => 'x', 'y' => 'y', 'z' => 'ZZZ', '_format' => 'html', '_route' => 'test'), $matcher->match('/wwwwwxyZZZ'));
- // z and _format are optional.
- $this->assertEquals(array('w' => 'wwwww', 'x' => 'x', 'y' => 'y', 'z' => 'default-z', '_format' => 'html', '_route' => 'test'), $matcher->match('/wwwwwxy'));
- $this->{method_exists($this, $_ = 'expectException') ? $_ : 'setExpectedException'}('Symfony\Component\Routing\Exception\ResourceNotFoundException');
- $matcher->match('/wxy.html');
- }
- public function testOptionalVariableWithNoRealSeparator()
- {
- $coll = new RouteCollection();
- $coll->add('test', new Route('/get{what}', array('what' => 'All')));
- $matcher = new UrlMatcher($coll, new RequestContext());
- $this->assertEquals(array('what' => 'All', '_route' => 'test'), $matcher->match('/get'));
- $this->assertEquals(array('what' => 'Sites', '_route' => 'test'), $matcher->match('/getSites'));
- // Usually the character in front of an optional parameter can be left out, e.g. with pattern '/get/{what}' just '/get' would match.
- // But here the 't' in 'get' is not a separating character, so it makes no sense to match without it.
- $this->{method_exists($this, $_ = 'expectException') ? $_ : 'setExpectedException'}('Symfony\Component\Routing\Exception\ResourceNotFoundException');
- $matcher->match('/ge');
- }
- public function testRequiredVariableWithNoRealSeparator()
- {
- $coll = new RouteCollection();
- $coll->add('test', new Route('/get{what}Suffix'));
- $matcher = new UrlMatcher($coll, new RequestContext());
- $this->assertEquals(array('what' => 'Sites', '_route' => 'test'), $matcher->match('/getSitesSuffix'));
- }
- public function testDefaultRequirementOfVariable()
- {
- $coll = new RouteCollection();
- $coll->add('test', new Route('/{page}.{_format}'));
- $matcher = new UrlMatcher($coll, new RequestContext());
- $this->assertEquals(array('page' => 'index', '_format' => 'mobile.html', '_route' => 'test'), $matcher->match('/index.mobile.html'));
- }
- /**
- * @expectedException \Symfony\Component\Routing\Exception\ResourceNotFoundException
- */
- public function testDefaultRequirementOfVariableDisallowsSlash()
- {
- $coll = new RouteCollection();
- $coll->add('test', new Route('/{page}.{_format}'));
- $matcher = new UrlMatcher($coll, new RequestContext());
- $matcher->match('/index.sl/ash');
- }
- /**
- * @expectedException \Symfony\Component\Routing\Exception\ResourceNotFoundException
- */
- public function testDefaultRequirementOfVariableDisallowsNextSeparator()
- {
- $coll = new RouteCollection();
- $coll->add('test', new Route('/{page}.{_format}', array(), array('_format' => 'html|xml')));
- $matcher = new UrlMatcher($coll, new RequestContext());
- $matcher->match('/do.t.html');
- }
- /**
- * @expectedException \Symfony\Component\Routing\Exception\ResourceNotFoundException
- */
- public function testSchemeRequirement()
- {
- $coll = new RouteCollection();
- $coll->add('foo', new Route('/foo', array(), array(), array(), '', array('https')));
- $matcher = new UrlMatcher($coll, new RequestContext());
- $matcher->match('/foo');
- }
- /**
- * @expectedException \Symfony\Component\Routing\Exception\ResourceNotFoundException
- */
- public function testCondition()
- {
- $coll = new RouteCollection();
- $route = new Route('/foo');
- $route->setCondition('context.getMethod() == "POST"');
- $coll->add('foo', $route);
- $matcher = new UrlMatcher($coll, new RequestContext());
- $matcher->match('/foo');
- }
- public function testDecodeOnce()
- {
- $coll = new RouteCollection();
- $coll->add('foo', new Route('/foo/{foo}'));
- $matcher = new UrlMatcher($coll, new RequestContext());
- $this->assertEquals(array('foo' => 'bar%23', '_route' => 'foo'), $matcher->match('/foo/bar%2523'));
- }
- public function testCannotRelyOnPrefix()
- {
- $coll = new RouteCollection();
- $subColl = new RouteCollection();
- $subColl->add('bar', new Route('/bar'));
- $subColl->addPrefix('/prefix');
- // overwrite the pattern, so the prefix is not valid anymore for this route in the collection
- $subColl->get('bar')->setPath('/new');
- $coll->addCollection($subColl);
- $matcher = new UrlMatcher($coll, new RequestContext());
- $this->assertEquals(array('_route' => 'bar'), $matcher->match('/new'));
- }
- public function testWithHost()
- {
- $coll = new RouteCollection();
- $coll->add('foo', new Route('/foo/{foo}', array(), array(), array(), '{locale}.example.com'));
- $matcher = new UrlMatcher($coll, new RequestContext('', 'GET', 'en.example.com'));
- $this->assertEquals(array('foo' => 'bar', '_route' => 'foo', 'locale' => 'en'), $matcher->match('/foo/bar'));
- }
- public function testWithHostOnRouteCollection()
- {
- $coll = new RouteCollection();
- $coll->add('foo', new Route('/foo/{foo}'));
- $coll->add('bar', new Route('/bar/{foo}', array(), array(), array(), '{locale}.example.net'));
- $coll->setHost('{locale}.example.com');
- $matcher = new UrlMatcher($coll, new RequestContext('', 'GET', 'en.example.com'));
- $this->assertEquals(array('foo' => 'bar', '_route' => 'foo', 'locale' => 'en'), $matcher->match('/foo/bar'));
- $matcher = new UrlMatcher($coll, new RequestContext('', 'GET', 'en.example.com'));
- $this->assertEquals(array('foo' => 'bar', '_route' => 'bar', 'locale' => 'en'), $matcher->match('/bar/bar'));
- }
- /**
- * @expectedException \Symfony\Component\Routing\Exception\ResourceNotFoundException
- */
- public function testWithOutHostHostDoesNotMatch()
- {
- $coll = new RouteCollection();
- $coll->add('foo', new Route('/foo/{foo}', array(), array(), array(), '{locale}.example.com'));
- $matcher = new UrlMatcher($coll, new RequestContext('', 'GET', 'example.com'));
- $matcher->match('/foo/bar');
- }
- /**
- * @expectedException \Symfony\Component\Routing\Exception\ResourceNotFoundException
- */
- public function testPathIsCaseSensitive()
- {
- $coll = new RouteCollection();
- $coll->add('foo', new Route('/locale', array(), array('locale' => 'EN|FR|DE')));
- $matcher = new UrlMatcher($coll, new RequestContext());
- $matcher->match('/en');
- }
- public function testHostIsCaseInsensitive()
- {
- $coll = new RouteCollection();
- $coll->add('foo', new Route('/', array(), array('locale' => 'EN|FR|DE'), array(), '{locale}.example.com'));
- $matcher = new UrlMatcher($coll, new RequestContext('', 'GET', 'en.example.com'));
- $this->assertEquals(array('_route' => 'foo', 'locale' => 'en'), $matcher->match('/'));
- }
- }
|