tests/src/App/RouterTest.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2020, Friendica
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  *
  20  */
  21
  22 namespace Friendica\Test\src\App;
  23
  24 use Friendica\App\Router;
  25 use Friendica\Core\L10n;
  26 use Friendica\Module;
  27 use Friendica\Network\HTTPException\MethodNotAllowedException;
  28 use Friendica\Network\HTTPException\NotFoundException;
  29 use Mockery\MockInterface;
  30 use PHPUnit\Framework\TestCase;
  31
  32 class RouterTest extends TestCase
  33 {
  34         /** @var L10n|MockInterface */
  35         private $l10n;
  36
  37         protected function setUp()
  38         {
  39                 parent::setUp();
  40
  41                 $this->l10n = \Mockery::mock(L10n::class);
  42                 $this->l10n->shouldReceive('t')->andReturnUsing(function ($args) { return $args; });
  43         }
  44
  45         public function testGetModuleClass()
  46         {
  47                 $router = new Router(['REQUEST_METHOD' => Router::GET], $this->l10n);
  48
  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');
  57
  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'));
  67         }
  68
  69         public function testPostModuleClass()
  70         {
  71                 $router = new Router(['REQUEST_METHOD' => Router::POST], $this->l10n);
  72
  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');
  81
  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'));
  91         }
  92
  93         public function testGetModuleClassNotFound()
  94         {
  95                 $this->expectException(NotFoundException::class);
  96
  97                 $router = new Router(['REQUEST_METHOD' => Router::GET], $this->l10n);
  98
  99                 $router->getModuleClass('/unsupported');
 100         }
 101
 102         public function testGetModuleClassNotFoundTypo()
 103         {
 104                 $this->expectException(NotFoundException::class);
 105
 106                 $router = new Router(['REQUEST_METHOD' => Router::GET], $this->l10n);
 107
 108                 $routeCollector = $router->getRouteCollector();
 109                 $routeCollector->addRoute([Router::GET], '/test', 'TestModuleClassName');
 110
 111                 $router->getModuleClass('/tes');
 112         }
 113
 114         public function testGetModuleClassNotFoundOptional()
 115         {
 116                 $this->expectException(NotFoundException::class);
 117
 118                 $router = new Router(['REQUEST_METHOD' => Router::GET], $this->l10n);
 119
 120                 $routeCollector = $router->getRouteCollector();
 121                 $routeCollector->addRoute([Router::GET], '/optional[/option]', 'OptionalModuleClassName');
 122
 123                 $router->getModuleClass('/optional/opt');
 124         }
 125
 126         public function testGetModuleClassNotFoundVariable()
 127         {
 128                 $this->expectException(NotFoundException::class);
 129
 130                 $router = new Router(['REQUEST_METHOD' => Router::GET], $this->l10n);
 131
 132                 $routeCollector = $router->getRouteCollector();
 133                 $routeCollector->addRoute([Router::GET], '/variable/{var}', 'VariableModuleClassName');
 134
 135                 $router->getModuleClass('/variable');
 136         }
 137
 138         public function testGetModuleClassMethodNotAllowed()
 139         {
 140                 $this->expectException(MethodNotAllowedException::class);
 141
 142                 $router = new Router(['REQUEST_METHOD' => Router::POST], $this->l10n);
 143
 144                 $routeCollector = $router->getRouteCollector();
 145                 $routeCollector->addRoute([Router::GET], '/test', 'TestModuleClassName');
 146
 147                 $router->getModuleClass('/test');
 148         }
 149
 150         public function testPostModuleClassMethodNotAllowed()
 151         {
 152                 $this->expectException(MethodNotAllowedException::class);
 153
 154                 $router = new Router(['REQUEST_METHOD' => Router::GET], $this->l10n);
 155
 156                 $routeCollector = $router->getRouteCollector();
 157                 $routeCollector->addRoute([Router::POST], '/test', 'TestModuleClassName');
 158
 159                 $router->getModuleClass('/test');
 160         }
 161
 162         public function dataRoutes()
 163         {
 164                 return [
 165                         'default' => [
 166                                 'routes' => [
 167                                         '/'       => [Module\Home::class, [Router::GET]],
 168                                         '/group'  => [
 169                                                 '/route' => [Module\Friendica::class, [Router::GET]],
 170                                         ],
 171
 172
 173                                         '/group2' => [
 174                                                 '/group3' => [
 175                                                         '/route' => [Module\Xrd::class, [Router::GET]],
 176                                                 ],
 177                                         ],
 178                                         '/post' => [
 179                                                 '/it' => [Module\NodeInfo::class, [Router::POST]],
 180                                         ],
 181                                         '/double' => [Module\Profile\Index::class, [Router::GET, Router::POST]]
 182                                 ],
 183                         ],
 184                 ];
 185         }
 186
 187         /**
 188          * @dataProvider dataRoutes
 189          */
 190         public function testGetRoutes(array $routes)
 191         {
 192                 $router = (new Router([
 193                         'REQUEST_METHOD' => Router::GET
 194                 ], $this->l10n))->loadRoutes($routes);
 195
 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'));
 200         }
 201
 202         /**
 203          * @dataProvider dataRoutes
 204          */
 205         public function testPostRouter(array $routes)
 206         {
 207                 $router = (new Router([
 208                         'REQUEST_METHOD' => Router::POST
 209                 ], $this->l10n))->loadRoutes($routes);
 210
 211                 // Don't find GET
 212                 $this->assertEquals(Module\NodeInfo::class, $router->getModuleClass('/post/it'));
 213                 $this->assertEquals(Module\Profile\Index::class, $router->getModuleClass('/double'));
 214         }
 215 }