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
  60         public function testGetModuleClass()
  61         {
  62                 $router = new Router(['REQUEST_METHOD' => Router::GET], '', $this->l10n, $this->cache, $this->lock);
  63
  64                 $routeCollector = $router->getRouteCollector();
  65                 $routeCollector->addRoute([Router::GET], '/', 'IndexModuleClassName');
  66                 $routeCollector->addRoute([Router::GET], '/test', 'TestModuleClassName');
  67                 $routeCollector->addRoute([Router::GET, Router::POST], '/testgetpost', 'TestGetPostModuleClassName');
  68                 $routeCollector->addRoute([Router::GET], '/test/sub', 'TestSubModuleClassName');
  69                 $routeCollector->addRoute([Router::GET], '/optional[/option]', 'OptionalModuleClassName');
  70                 $routeCollector->addRoute([Router::GET], '/variable/{var}', 'VariableModuleClassName');
  71                 $routeCollector->addRoute([Router::GET], '/optionalvariable[/{option}]', 'OptionalVariableModuleClassName');
  72
  73                 self::assertEquals('IndexModuleClassName', $router->getModuleClass('/'));
  74                 self::assertEquals('TestModuleClassName', $router->getModuleClass('/test'));
  75                 self::assertEquals('TestGetPostModuleClassName', $router->getModuleClass('/testgetpost'));
  76                 self::assertEquals('TestSubModuleClassName', $router->getModuleClass('/test/sub'));
  77                 self::assertEquals('OptionalModuleClassName', $router->getModuleClass('/optional'));
  78                 self::assertEquals('OptionalModuleClassName', $router->getModuleClass('/optional/option'));
  79                 self::assertEquals('VariableModuleClassName', $router->getModuleClass('/variable/123abc'));
  80                 self::assertEquals('OptionalVariableModuleClassName', $router->getModuleClass('/optionalvariable'));
  81                 self::assertEquals('OptionalVariableModuleClassName', $router->getModuleClass('/optionalvariable/123abc'));
  82         }
  83
  84         public function testPostModuleClass()
  85         {
  86                 $router = new Router(['REQUEST_METHOD' => Router::POST], '', $this->l10n, $this->cache, $this->lock);
  87
  88                 $routeCollector = $router->getRouteCollector();
  89                 $routeCollector->addRoute([Router::POST], '/', 'IndexModuleClassName');
  90                 $routeCollector->addRoute([Router::POST], '/test', 'TestModuleClassName');
  91                 $routeCollector->addRoute([Router::GET, Router::POST], '/testgetpost', 'TestGetPostModuleClassName');
  92                 $routeCollector->addRoute([Router::POST], '/test/sub', 'TestSubModuleClassName');
  93                 $routeCollector->addRoute([Router::POST], '/optional[/option]', 'OptionalModuleClassName');
  94                 $routeCollector->addRoute([Router::POST], '/variable/{var}', 'VariableModuleClassName');
  95                 $routeCollector->addRoute([Router::POST], '/optionalvariable[/{option}]', 'OptionalVariableModuleClassName');
  96
  97                 self::assertEquals('IndexModuleClassName', $router->getModuleClass('/'));
  98                 self::assertEquals('TestModuleClassName', $router->getModuleClass('/test'));
  99                 self::assertEquals('TestGetPostModuleClassName', $router->getModuleClass('/testgetpost'));
 100                 self::assertEquals('TestSubModuleClassName', $router->getModuleClass('/test/sub'));
 101                 self::assertEquals('OptionalModuleClassName', $router->getModuleClass('/optional'));
 102                 self::assertEquals('OptionalModuleClassName', $router->getModuleClass('/optional/option'));
 103                 self::assertEquals('VariableModuleClassName', $router->getModuleClass('/variable/123abc'));
 104                 self::assertEquals('OptionalVariableModuleClassName', $router->getModuleClass('/optionalvariable'));
 105                 self::assertEquals('OptionalVariableModuleClassName', $router->getModuleClass('/optionalvariable/123abc'));
 106         }
 107
 108         public function testGetModuleClassNotFound()
 109         {
 110                 $this->expectException(NotFoundException::class);
 111
 112                 $router = new Router(['REQUEST_METHOD' => Router::GET], '', $this->l10n, $this->cache, $this->lock);
 113
 114                 $router->getModuleClass('/unsupported');
 115         }
 116
 117         public function testGetModuleClassNotFoundTypo()
 118         {
 119                 $this->expectException(NotFoundException::class);
 120
 121                 $router = new Router(['REQUEST_METHOD' => Router::GET], '', $this->l10n, $this->cache, $this->lock);
 122
 123                 $routeCollector = $router->getRouteCollector();
 124                 $routeCollector->addRoute([Router::GET], '/test', 'TestModuleClassName');
 125
 126                 $router->getModuleClass('/tes');
 127         }
 128
 129         public function testGetModuleClassNotFoundOptional()
 130         {
 131                 $this->expectException(NotFoundException::class);
 132
 133                 $router = new Router(['REQUEST_METHOD' => Router::GET], '', $this->l10n, $this->cache, $this->lock);
 134
 135                 $routeCollector = $router->getRouteCollector();
 136                 $routeCollector->addRoute([Router::GET], '/optional[/option]', 'OptionalModuleClassName');
 137
 138                 $router->getModuleClass('/optional/opt');
 139         }
 140
 141         public function testGetModuleClassNotFoundVariable()
 142         {
 143                 $this->expectException(NotFoundException::class);
 144
 145                 $router = new Router(['REQUEST_METHOD' => Router::GET], '', $this->l10n, $this->cache, $this->lock);
 146
 147                 $routeCollector = $router->getRouteCollector();
 148                 $routeCollector->addRoute([Router::GET], '/variable/{var}', 'VariableModuleClassName');
 149
 150                 $router->getModuleClass('/variable');
 151         }
 152
 153         public function testGetModuleClassMethodNotAllowed()
 154         {
 155                 $this->expectException(MethodNotAllowedException::class);
 156
 157                 $router = new Router(['REQUEST_METHOD' => Router::POST], '', $this->l10n, $this->cache, $this->lock);
 158
 159                 $routeCollector = $router->getRouteCollector();
 160                 $routeCollector->addRoute([Router::GET], '/test', 'TestModuleClassName');
 161
 162                 $router->getModuleClass('/test');
 163         }
 164
 165         public function testPostModuleClassMethodNotAllowed()
 166         {
 167                 $this->expectException(MethodNotAllowedException::class);
 168
 169                 $router = new Router(['REQUEST_METHOD' => Router::GET], '', $this->l10n, $this->cache, $this->lock);
 170
 171                 $routeCollector = $router->getRouteCollector();
 172                 $routeCollector->addRoute([Router::POST], '/test', 'TestModuleClassName');
 173
 174                 $router->getModuleClass('/test');
 175         }
 176
 177         public function dataRoutes()
 178         {
 179                 return [
 180                         'default' => [
 181                                 'routes' => [
 182                                         '/'       => [Module\Home::class, [Router::GET]],
 183                                         '/group'  => [
 184                                                 '/route' => [Module\Friendica::class, [Router::GET]],
 185                                         ],
 186
 187
 188                                         '/group2' => [
 189                                                 '/group3' => [
 190                                                         '/route' => [Module\Xrd::class, [Router::GET]],
 191                                                 ],
 192                                         ],
 193                                         '/post' => [
 194                                                 '/it' => [Module\WellKnown\NodeInfo::class, [Router::POST]],
 195                                         ],
 196                                         '/double' => [Module\Profile\Index::class, [Router::GET, Router::POST]]
 197                                 ],
 198                         ],
 199                 ];
 200         }
 201
 202         /**
 203          * @dataProvider dataRoutes
 204          */
 205         public function testGetRoutes(array $routes)
 206         {
 207                 $router = (new Router(
 208                         ['REQUEST_METHOD' => Router::GET],
 209                         '',
 210                         $this->l10n,
 211                         $this->cache,
 212                         $this->lock
 213                 ))->loadRoutes($routes);
 214
 215                 self::assertEquals(Module\Home::class, $router->getModuleClass('/'));
 216                 self::assertEquals(Module\Friendica::class, $router->getModuleClass('/group/route'));
 217                 self::assertEquals(Module\Xrd::class, $router->getModuleClass('/group2/group3/route'));
 218                 self::assertEquals(Module\Profile\Index::class, $router->getModuleClass('/double'));
 219         }
 220
 221         /**
 222          * @dataProvider dataRoutes
 223          */
 224         public function testPostRouter(array $routes)
 225         {
 226                 $router = (new Router([
 227                         'REQUEST_METHOD' => Router::POST
 228                 ], '', $this->l10n, $this->cache, $this->lock))->loadRoutes($routes);
 229
 230                 // Don't find GET
 231                 self::assertEquals(Module\WellKnown\NodeInfo::class, $router->getModuleClass('/post/it'));
 232                 self::assertEquals(Module\Profile\Index::class, $router->getModuleClass('/double'));
 233         }
 234 }