tests/src/App/RouterTest.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   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\Cache\ICache;
  26 use Friendica\Core\L10n;
  27 use Friendica\Core\Lock\ILock;
  28 use Friendica\Module;
  29 use Friendica\Network\HTTPException\MethodNotAllowedException;
  30 use Friendica\Network\HTTPException\NotFoundException;
  31 use Mockery;
  32 use Mockery\MockInterface;
  33 use PHPUnit\Framework\TestCase;
  34
  35 class RouterTest extends TestCase
  36 {
  37         /** @var L10n|MockInterface */
  38         private $l10n;
  39         /**
  40          * @var ICache
  41          */
  42         private $cache;
  43         /**
  44          * @var ILock
  45          */
  46         private $lock;
  47
  48         protected function setUp() : void
  49         {
  50                 parent::setUp();
  51
  52                 $this->l10n = Mockery::mock(L10n::class);
  53                 $this->l10n->shouldReceive('t')->andReturnUsing(function ($args) { return $args; });
  54
  55                 $this->cache = Mockery::mock(ICache::class);
  56                 $this->cache->shouldReceive('get')->andReturn(null);
  57                 $this->cache->shouldReceive('set')->andReturn(false);
  58
  59                 $this->lock = Mockery::mock(ILock::class);
  60         }
  61
  62         public function testGetModuleClass()
  63         {
  64                 $router = new Router(['REQUEST_METHOD' => Router::GET], '', $this->l10n, $this->cache, $this->lock);
  65
  66                 $routeCollector = $router->getRouteCollector();
  67                 $routeCollector->addRoute([Router::GET], '/', 'IndexModuleClassName');
  68                 $routeCollector->addRoute([Router::GET], '/test', 'TestModuleClassName');
  69                 $routeCollector->addRoute([Router::GET, Router::POST], '/testgetpost', 'TestGetPostModuleClassName');
  70                 $routeCollector->addRoute([Router::GET], '/test/sub', 'TestSubModuleClassName');
  71                 $routeCollector->addRoute([Router::GET], '/optional[/option]', 'OptionalModuleClassName');
  72                 $routeCollector->addRoute([Router::GET], '/variable/{var}', 'VariableModuleClassName');
  73                 $routeCollector->addRoute([Router::GET], '/optionalvariable[/{option}]', 'OptionalVariableModuleClassName');
  74
  75                 self::assertEquals('IndexModuleClassName', $router->getModuleClass('/'));
  76                 self::assertEquals('TestModuleClassName', $router->getModuleClass('/test'));
  77                 self::assertEquals('TestGetPostModuleClassName', $router->getModuleClass('/testgetpost'));
  78                 self::assertEquals('TestSubModuleClassName', $router->getModuleClass('/test/sub'));
  79                 self::assertEquals('OptionalModuleClassName', $router->getModuleClass('/optional'));
  80                 self::assertEquals('OptionalModuleClassName', $router->getModuleClass('/optional/option'));
  81                 self::assertEquals('VariableModuleClassName', $router->getModuleClass('/variable/123abc'));
  82                 self::assertEquals('OptionalVariableModuleClassName', $router->getModuleClass('/optionalvariable'));
  83                 self::assertEquals('OptionalVariableModuleClassName', $router->getModuleClass('/optionalvariable/123abc'));
  84         }
  85
  86         public function testPostModuleClass()
  87         {
  88                 $router = new Router(['REQUEST_METHOD' => Router::POST], '', $this->l10n, $this->cache, $this->lock);
  89
  90                 $routeCollector = $router->getRouteCollector();
  91                 $routeCollector->addRoute([Router::POST], '/', 'IndexModuleClassName');
  92                 $routeCollector->addRoute([Router::POST], '/test', 'TestModuleClassName');
  93                 $routeCollector->addRoute([Router::GET, Router::POST], '/testgetpost', 'TestGetPostModuleClassName');
  94                 $routeCollector->addRoute([Router::POST], '/test/sub', 'TestSubModuleClassName');
  95                 $routeCollector->addRoute([Router::POST], '/optional[/option]', 'OptionalModuleClassName');
  96                 $routeCollector->addRoute([Router::POST], '/variable/{var}', 'VariableModuleClassName');
  97                 $routeCollector->addRoute([Router::POST], '/optionalvariable[/{option}]', 'OptionalVariableModuleClassName');
  98
  99                 self::assertEquals('IndexModuleClassName', $router->getModuleClass('/'));
 100                 self::assertEquals('TestModuleClassName', $router->getModuleClass('/test'));
 101                 self::assertEquals('TestGetPostModuleClassName', $router->getModuleClass('/testgetpost'));
 102                 self::assertEquals('TestSubModuleClassName', $router->getModuleClass('/test/sub'));
 103                 self::assertEquals('OptionalModuleClassName', $router->getModuleClass('/optional'));
 104                 self::assertEquals('OptionalModuleClassName', $router->getModuleClass('/optional/option'));
 105                 self::assertEquals('VariableModuleClassName', $router->getModuleClass('/variable/123abc'));
 106                 self::assertEquals('OptionalVariableModuleClassName', $router->getModuleClass('/optionalvariable'));
 107                 self::assertEquals('OptionalVariableModuleClassName', $router->getModuleClass('/optionalvariable/123abc'));
 108         }
 109
 110         public function testGetModuleClassNotFound()
 111         {
 112                 $this->expectException(NotFoundException::class);
 113
 114                 $router = new Router(['REQUEST_METHOD' => Router::GET], '', $this->l10n, $this->cache, $this->lock);
 115
 116                 $router->getModuleClass('/unsupported');
 117         }
 118
 119         public function testGetModuleClassNotFoundTypo()
 120         {
 121                 $this->expectException(NotFoundException::class);
 122
 123                 $router = new Router(['REQUEST_METHOD' => Router::GET], '', $this->l10n, $this->cache, $this->lock);
 124
 125                 $routeCollector = $router->getRouteCollector();
 126                 $routeCollector->addRoute([Router::GET], '/test', 'TestModuleClassName');
 127
 128                 $router->getModuleClass('/tes');
 129         }
 130
 131         public function testGetModuleClassNotFoundOptional()
 132         {
 133                 $this->expectException(NotFoundException::class);
 134
 135                 $router = new Router(['REQUEST_METHOD' => Router::GET], '', $this->l10n, $this->cache, $this->lock);
 136
 137                 $routeCollector = $router->getRouteCollector();
 138                 $routeCollector->addRoute([Router::GET], '/optional[/option]', 'OptionalModuleClassName');
 139
 140                 $router->getModuleClass('/optional/opt');
 141         }
 142
 143         public function testGetModuleClassNotFoundVariable()
 144         {
 145                 $this->expectException(NotFoundException::class);
 146
 147                 $router = new Router(['REQUEST_METHOD' => Router::GET], '', $this->l10n, $this->cache, $this->lock);
 148
 149                 $routeCollector = $router->getRouteCollector();
 150                 $routeCollector->addRoute([Router::GET], '/variable/{var}', 'VariableModuleClassName');
 151
 152                 $router->getModuleClass('/variable');
 153         }
 154
 155         public function testGetModuleClassMethodNotAllowed()
 156         {
 157                 $this->expectException(MethodNotAllowedException::class);
 158
 159                 $router = new Router(['REQUEST_METHOD' => Router::POST], '', $this->l10n, $this->cache, $this->lock);
 160
 161                 $routeCollector = $router->getRouteCollector();
 162                 $routeCollector->addRoute([Router::GET], '/test', 'TestModuleClassName');
 163
 164                 $router->getModuleClass('/test');
 165         }
 166
 167         public function testPostModuleClassMethodNotAllowed()
 168         {
 169                 $this->expectException(MethodNotAllowedException::class);
 170
 171                 $router = new Router(['REQUEST_METHOD' => Router::GET], '', $this->l10n, $this->cache, $this->lock);
 172
 173                 $routeCollector = $router->getRouteCollector();
 174                 $routeCollector->addRoute([Router::POST], '/test', 'TestModuleClassName');
 175
 176                 $router->getModuleClass('/test');
 177         }
 178
 179         public function dataRoutes()
 180         {
 181                 return [
 182                         'default' => [
 183                                 'routes' => [
 184                                         '/'       => [Module\Home::class, [Router::GET]],
 185                                         '/group'  => [
 186                                                 '/route' => [Module\Friendica::class, [Router::GET]],
 187                                         ],
 188
 189
 190                                         '/group2' => [
 191                                                 '/group3' => [
 192                                                         '/route' => [Module\Xrd::class, [Router::GET]],
 193                                                 ],
 194                                         ],
 195                                         '/post' => [
 196                                                 '/it' => [Module\WellKnown\NodeInfo::class, [Router::POST]],
 197                                         ],
 198                                         '/double' => [Module\Profile\Index::class, [Router::GET, Router::POST]]
 199                                 ],
 200                         ],
 201                 ];
 202         }
 203
 204         /**
 205          * @dataProvider dataRoutes
 206          */
 207         public function testGetRoutes(array $routes)
 208         {
 209                 $router = (new Router(
 210                         ['REQUEST_METHOD' => Router::GET],
 211                         '',
 212                         $this->l10n,
 213                         $this->cache,
 214                         $this->lock
 215                 ))->loadRoutes($routes);
 216
 217                 self::assertEquals(Module\Home::class, $router->getModuleClass('/'));
 218                 self::assertEquals(Module\Friendica::class, $router->getModuleClass('/group/route'));
 219                 self::assertEquals(Module\Xrd::class, $router->getModuleClass('/group2/group3/route'));
 220                 self::assertEquals(Module\Profile\Index::class, $router->getModuleClass('/double'));
 221         }
 222
 223         /**
 224          * @dataProvider dataRoutes
 225          */
 226         public function testPostRouter(array $routes)
 227         {
 228                 $router = (new Router([
 229                         'REQUEST_METHOD' => Router::POST
 230                 ], '', $this->l10n, $this->cache, $this->lock))->loadRoutes($routes);
 231
 232                 // Don't find GET
 233                 self::assertEquals(Module\WellKnown\NodeInfo::class, $router->getModuleClass('/post/it'));
 234                 self::assertEquals(Module\Profile\Index::class, $router->getModuleClass('/double'));
 235         }
 236 }