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