3 * @copyright Copyright (C) 2020, Friendica
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Test\src\App;
24 use Friendica\App\Router;
25 use Friendica\Core\L10n;
27 use Friendica\Network\HTTPException\MethodNotAllowedException;
28 use Friendica\Network\HTTPException\NotFoundException;
29 use Mockery\MockInterface;
30 use PHPUnit\Framework\TestCase;
32 class RouterTest extends TestCase
34 /** @var L10n|MockInterface */
37 protected function setUp()
41 $this->l10n = \Mockery::mock(L10n::class);
42 $this->l10n->shouldReceive('t')->andReturnUsing(function ($args) { return $args; });
45 public function testGetModuleClass()
47 $router = new Router(['REQUEST_METHOD' => Router::GET], $this->l10n);
49 $routeCollector = $router->getRouteCollector();
50 $routeCollector->addRoute([Router::GET], '/', 'IndexModuleClassName');
51 $routeCollector->addRoute([Router::GET], '/test', 'TestModuleClassName');
52 $routeCollector->addRoute([Router::GET, Router::POST], '/testgetpost', 'TestGetPostModuleClassName');
53 $routeCollector->addRoute([Router::GET], '/test/sub', 'TestSubModuleClassName');
54 $routeCollector->addRoute([Router::GET], '/optional[/option]', 'OptionalModuleClassName');
55 $routeCollector->addRoute([Router::GET], '/variable/{var}', 'VariableModuleClassName');
56 $routeCollector->addRoute([Router::GET], '/optionalvariable[/{option}]', 'OptionalVariableModuleClassName');
58 $this->assertEquals('IndexModuleClassName', $router->getModuleClass('/'));
59 $this->assertEquals('TestModuleClassName', $router->getModuleClass('/test'));
60 $this->assertEquals('TestGetPostModuleClassName', $router->getModuleClass('/testgetpost'));
61 $this->assertEquals('TestSubModuleClassName', $router->getModuleClass('/test/sub'));
62 $this->assertEquals('OptionalModuleClassName', $router->getModuleClass('/optional'));
63 $this->assertEquals('OptionalModuleClassName', $router->getModuleClass('/optional/option'));
64 $this->assertEquals('VariableModuleClassName', $router->getModuleClass('/variable/123abc'));
65 $this->assertEquals('OptionalVariableModuleClassName', $router->getModuleClass('/optionalvariable'));
66 $this->assertEquals('OptionalVariableModuleClassName', $router->getModuleClass('/optionalvariable/123abc'));
69 public function testPostModuleClass()
71 $router = new Router(['REQUEST_METHOD' => Router::POST], $this->l10n);
73 $routeCollector = $router->getRouteCollector();
74 $routeCollector->addRoute([Router::POST], '/', 'IndexModuleClassName');
75 $routeCollector->addRoute([Router::POST], '/test', 'TestModuleClassName');
76 $routeCollector->addRoute([Router::GET, Router::POST], '/testgetpost', 'TestGetPostModuleClassName');
77 $routeCollector->addRoute([Router::POST], '/test/sub', 'TestSubModuleClassName');
78 $routeCollector->addRoute([Router::POST], '/optional[/option]', 'OptionalModuleClassName');
79 $routeCollector->addRoute([Router::POST], '/variable/{var}', 'VariableModuleClassName');
80 $routeCollector->addRoute([Router::POST], '/optionalvariable[/{option}]', 'OptionalVariableModuleClassName');
82 $this->assertEquals('IndexModuleClassName', $router->getModuleClass('/'));
83 $this->assertEquals('TestModuleClassName', $router->getModuleClass('/test'));
84 $this->assertEquals('TestGetPostModuleClassName', $router->getModuleClass('/testgetpost'));
85 $this->assertEquals('TestSubModuleClassName', $router->getModuleClass('/test/sub'));
86 $this->assertEquals('OptionalModuleClassName', $router->getModuleClass('/optional'));
87 $this->assertEquals('OptionalModuleClassName', $router->getModuleClass('/optional/option'));
88 $this->assertEquals('VariableModuleClassName', $router->getModuleClass('/variable/123abc'));
89 $this->assertEquals('OptionalVariableModuleClassName', $router->getModuleClass('/optionalvariable'));
90 $this->assertEquals('OptionalVariableModuleClassName', $router->getModuleClass('/optionalvariable/123abc'));
93 public function testGetModuleClassNotFound()
95 $this->expectException(NotFoundException::class);
97 $router = new Router(['REQUEST_METHOD' => Router::GET], $this->l10n);
99 $router->getModuleClass('/unsupported');
102 public function testGetModuleClassNotFoundTypo()
104 $this->expectException(NotFoundException::class);
106 $router = new Router(['REQUEST_METHOD' => Router::GET], $this->l10n);
108 $routeCollector = $router->getRouteCollector();
109 $routeCollector->addRoute([Router::GET], '/test', 'TestModuleClassName');
111 $router->getModuleClass('/tes');
114 public function testGetModuleClassNotFoundOptional()
116 $this->expectException(NotFoundException::class);
118 $router = new Router(['REQUEST_METHOD' => Router::GET], $this->l10n);
120 $routeCollector = $router->getRouteCollector();
121 $routeCollector->addRoute([Router::GET], '/optional[/option]', 'OptionalModuleClassName');
123 $router->getModuleClass('/optional/opt');
126 public function testGetModuleClassNotFoundVariable()
128 $this->expectException(NotFoundException::class);
130 $router = new Router(['REQUEST_METHOD' => Router::GET], $this->l10n);
132 $routeCollector = $router->getRouteCollector();
133 $routeCollector->addRoute([Router::GET], '/variable/{var}', 'VariableModuleClassName');
135 $router->getModuleClass('/variable');
138 public function testGetModuleClassMethodNotAllowed()
140 $this->expectException(MethodNotAllowedException::class);
142 $router = new Router(['REQUEST_METHOD' => Router::POST], $this->l10n);
144 $routeCollector = $router->getRouteCollector();
145 $routeCollector->addRoute([Router::GET], '/test', 'TestModuleClassName');
147 $router->getModuleClass('/test');
150 public function testPostModuleClassMethodNotAllowed()
152 $this->expectException(MethodNotAllowedException::class);
154 $router = new Router(['REQUEST_METHOD' => Router::GET], $this->l10n);
156 $routeCollector = $router->getRouteCollector();
157 $routeCollector->addRoute([Router::POST], '/test', 'TestModuleClassName');
159 $router->getModuleClass('/test');
162 public function dataRoutes()
167 '/' => [Module\Home::class, [Router::GET]],
169 '/route' => [Module\Friendica::class, [Router::GET]],
175 '/route' => [Module\Xrd::class, [Router::GET]],
179 '/it' => [Module\NodeInfo::class, [Router::POST]],
181 '/double' => [Module\Profile\Index::class, [Router::GET, Router::POST]]
188 * @dataProvider dataRoutes
190 public function testGetRoutes(array $routes)
192 $router = (new Router([
193 'REQUEST_METHOD' => Router::GET
194 ], $this->l10n))->loadRoutes($routes);
196 $this->assertEquals(Module\Home::class, $router->getModuleClass('/'));
197 $this->assertEquals(Module\Friendica::class, $router->getModuleClass('/group/route'));
198 $this->assertEquals(Module\Xrd::class, $router->getModuleClass('/group2/group3/route'));
199 $this->assertEquals(Module\Profile\Index::class, $router->getModuleClass('/double'));
203 * @dataProvider dataRoutes
205 public function testPostRouter(array $routes)
207 $router = (new Router([
208 'REQUEST_METHOD' => Router::POST
209 ], $this->l10n))->loadRoutes($routes);
212 $this->assertEquals(Module\NodeInfo::class, $router->getModuleClass('/post/it'));
213 $this->assertEquals(Module\Profile\Index::class, $router->getModuleClass('/double'));