4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Symfony\Component\Routing\Tests\Loader;
14 use Symfony\Component\Routing\Annotation\Route;
16 class AnnotationClassLoaderTest extends AbstractAnnotationLoaderTest
21 protected function setUp()
25 $this->reader = $this->getReader();
26 $this->loader = $this->getClassLoader($this->reader);
30 * @expectedException \InvalidArgumentException
32 public function testLoadMissingClass()
34 $this->loader->load('MissingClass');
38 * @expectedException \InvalidArgumentException
40 public function testLoadAbstractClass()
42 $this->loader->load('Symfony\Component\Routing\Tests\Fixtures\AnnotatedClasses\AbstractClass');
46 * @dataProvider provideTestSupportsChecksResource
48 public function testSupportsChecksResource($resource, $expectedSupports)
50 $this->assertSame($expectedSupports, $this->loader->supports($resource), '->supports() returns true if the resource is loadable');
53 public function provideTestSupportsChecksResource()
57 array('\fully\qualified\class\name', true),
58 array('namespaced\class\without\leading\slash', true),
59 array('ÿClassWithLegalSpecialCharacters', true),
61 array('foo.foo', false),
66 public function testSupportsChecksTypeIfSpecified()
68 $this->assertTrue($this->loader->supports('class', 'annotation'), '->supports() checks the resource type if specified');
69 $this->assertFalse($this->loader->supports('class', 'foo'), '->supports() checks the resource type if specified');
72 public function getLoadTests()
76 'Symfony\Component\Routing\Tests\Fixtures\AnnotatedClasses\BarClass',
77 array('name' => 'route1', 'path' => '/path'),
78 array('arg2' => 'defaultValue2', 'arg3' => 'defaultValue3'),
81 'Symfony\Component\Routing\Tests\Fixtures\AnnotatedClasses\BarClass',
82 array('defaults' => array('arg2' => 'foo'), 'requirements' => array('arg3' => '\w+')),
83 array('arg2' => 'defaultValue2', 'arg3' => 'defaultValue3'),
86 'Symfony\Component\Routing\Tests\Fixtures\AnnotatedClasses\BarClass',
87 array('options' => array('foo' => 'bar')),
88 array('arg2' => 'defaultValue2', 'arg3' => 'defaultValue3'),
91 'Symfony\Component\Routing\Tests\Fixtures\AnnotatedClasses\BarClass',
92 array('schemes' => array('https'), 'methods' => array('GET')),
93 array('arg2' => 'defaultValue2', 'arg3' => 'defaultValue3'),
96 'Symfony\Component\Routing\Tests\Fixtures\AnnotatedClasses\BarClass',
97 array('condition' => 'context.getMethod() == "GET"'),
98 array('arg2' => 'defaultValue2', 'arg3' => 'defaultValue3'),
104 * @dataProvider getLoadTests
106 public function testLoad($className, $routeData = array(), $methodArgs = array())
108 $routeData = array_replace(array(
111 'requirements' => array(),
112 'options' => array(),
113 'defaults' => array(),
114 'schemes' => array(),
115 'methods' => array(),
120 ->expects($this->once())
121 ->method('getMethodAnnotations')
122 ->will($this->returnValue(array($this->getAnnotatedRoute($routeData))))
125 $routeCollection = $this->loader->load($className);
126 $route = $routeCollection->get($routeData['name']);
128 $this->assertSame($routeData['path'], $route->getPath(), '->load preserves path annotation');
130 \count($routeData['requirements']),
131 array_intersect_assoc($routeData['requirements'], $route->getRequirements()),
132 '->load preserves requirements annotation'
135 \count($routeData['options']),
136 array_intersect_assoc($routeData['options'], $route->getOptions()),
137 '->load preserves options annotation'
140 \count($routeData['defaults']),
141 $route->getDefaults(),
142 '->load preserves defaults annotation'
144 $this->assertEquals($routeData['schemes'], $route->getSchemes(), '->load preserves schemes annotation');
145 $this->assertEquals($routeData['methods'], $route->getMethods(), '->load preserves methods annotation');
146 $this->assertSame($routeData['condition'], $route->getCondition(), '->load preserves condition annotation');
149 public function testClassRouteLoad()
151 $classRouteData = array(
154 'schemes' => array('https'),
155 'methods' => array('GET'),
158 $methodRouteData = array(
161 'schemes' => array('http'),
162 'methods' => array('POST', 'PUT'),
166 ->expects($this->once())
167 ->method('getClassAnnotation')
168 ->will($this->returnValue($this->getAnnotatedRoute($classRouteData)))
171 ->expects($this->once())
172 ->method('getMethodAnnotations')
173 ->will($this->returnValue(array($this->getAnnotatedRoute($methodRouteData))))
176 $routeCollection = $this->loader->load('Symfony\Component\Routing\Tests\Fixtures\AnnotatedClasses\BarClass');
177 $route = $routeCollection->get($classRouteData['name'].$methodRouteData['name']);
179 $this->assertSame($classRouteData['path'].$methodRouteData['path'], $route->getPath(), '->load concatenates class and method route path');
180 $this->assertEquals(array_merge($classRouteData['schemes'], $methodRouteData['schemes']), $route->getSchemes(), '->load merges class and method route schemes');
181 $this->assertEquals(array_merge($classRouteData['methods'], $methodRouteData['methods']), $route->getMethods(), '->load merges class and method route methods');
184 public function testInvokableClassRouteLoad()
186 $classRouteData = array(
189 'schemes' => array('https'),
190 'methods' => array('GET'),
194 ->expects($this->exactly(1))
195 ->method('getClassAnnotations')
196 ->will($this->returnValue(array($this->getAnnotatedRoute($classRouteData))))
199 ->expects($this->once())
200 ->method('getMethodAnnotations')
201 ->will($this->returnValue(array()))
204 $routeCollection = $this->loader->load('Symfony\Component\Routing\Tests\Fixtures\AnnotatedClasses\BazClass');
205 $route = $routeCollection->get($classRouteData['name']);
207 $this->assertSame($classRouteData['path'], $route->getPath(), '->load preserves class route path');
208 $this->assertEquals($classRouteData['schemes'], $route->getSchemes(), '->load preserves class route schemes');
209 $this->assertEquals($classRouteData['methods'], $route->getMethods(), '->load preserves class route methods');
212 public function testInvokableClassMultipleRouteLoad()
214 $classRouteData1 = array(
217 'schemes' => array('https'),
218 'methods' => array('GET'),
221 $classRouteData2 = array(
224 'schemes' => array('https'),
225 'methods' => array('GET'),
229 ->expects($this->exactly(1))
230 ->method('getClassAnnotations')
231 ->will($this->returnValue(array($this->getAnnotatedRoute($classRouteData1), $this->getAnnotatedRoute($classRouteData2))))
234 ->expects($this->once())
235 ->method('getMethodAnnotations')
236 ->will($this->returnValue(array()))
239 $routeCollection = $this->loader->load('Symfony\Component\Routing\Tests\Fixtures\AnnotatedClasses\BazClass');
240 $route = $routeCollection->get($classRouteData1['name']);
242 $this->assertSame($classRouteData1['path'], $route->getPath(), '->load preserves class route path');
243 $this->assertEquals($classRouteData1['schemes'], $route->getSchemes(), '->load preserves class route schemes');
244 $this->assertEquals($classRouteData1['methods'], $route->getMethods(), '->load preserves class route methods');
246 $route = $routeCollection->get($classRouteData2['name']);
248 $this->assertSame($classRouteData2['path'], $route->getPath(), '->load preserves class route path');
249 $this->assertEquals($classRouteData2['schemes'], $route->getSchemes(), '->load preserves class route schemes');
250 $this->assertEquals($classRouteData2['methods'], $route->getMethods(), '->load preserves class route methods');
253 public function testInvokableClassWithMethodRouteLoad()
255 $classRouteData = array(
258 'schemes' => array('https'),
259 'methods' => array('GET'),
262 $methodRouteData = array(
265 'schemes' => array('http'),
266 'methods' => array('POST', 'PUT'),
270 ->expects($this->once())
271 ->method('getClassAnnotation')
272 ->will($this->returnValue($this->getAnnotatedRoute($classRouteData)))
275 ->expects($this->once())
276 ->method('getMethodAnnotations')
277 ->will($this->returnValue(array($this->getAnnotatedRoute($methodRouteData))))
280 $routeCollection = $this->loader->load('Symfony\Component\Routing\Tests\Fixtures\AnnotatedClasses\BazClass');
281 $route = $routeCollection->get($classRouteData['name']);
283 $this->assertNull($route, '->load ignores class route');
285 $route = $routeCollection->get($classRouteData['name'].$methodRouteData['name']);
287 $this->assertSame($classRouteData['path'].$methodRouteData['path'], $route->getPath(), '->load concatenates class and method route path');
288 $this->assertEquals(array_merge($classRouteData['schemes'], $methodRouteData['schemes']), $route->getSchemes(), '->load merges class and method route schemes');
289 $this->assertEquals(array_merge($classRouteData['methods'], $methodRouteData['methods']), $route->getMethods(), '->load merges class and method route methods');
292 private function getAnnotatedRoute($data)
294 return new Route($data);