composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-25 11:38:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

N°6208 - Router: Move to Service folder

Browse Source
This commit is contained in:
Molkobain
2023-04-19 17:14:16 +02:00
parent e3252da5a9
commit f026e6f4b8
16 changed files with 47 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

303
tests/php-unit-tests/unitary-tests/sources/Service/Router/RouterTest.php Normal file
View File

@@ -0,0 +1,303 @@
<?php
/*
* @copyright Copyright (C) 2010-2023 Combodo SARL
* @license http://opensource.org/licenses/AGPL-3.0
*/
namespace Combodo\iTop\Test\UnitTest\Service\Router;
use Combodo\iTop\Service\Router\Exception\RouteNotFoundException;
use Combodo\iTop\Service\Router\Router;
use Combodo\iTop\Test\UnitTest\ItopTestCase;
use utils;
/**
* Class RouterTest
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @since 3.1.0
* @covers \Combodo\iTop\Service\Router\Router
*/
class RouterTest extends ItopTestCase
{
/**
* @covers \Combodo\iTop\Service\Router\Router::GenerateUrl
* @dataProvider GenerateUrlProvider
*
* @param string $sExpectedUrl URL contains a <APP_ROOT_URL> placeholder that will be replaced with the real app root url at run time
* @param bool $bValid
* @param string $sRoute
* @param array $aParams
* @param bool $bAbsoluteUrl
*
* @return void
* @throws \Exception
*/
public function testGenerateUrl(string $sExpectedUrl, bool $bValid, string $sRoute, array $aParams, bool $bAbsoluteUrl = true): void
{
$oRouter = Router::GetInstance();
if (false === $bValid) {
$this->expectException(RouteNotFoundException::class);
}
$sTestedUrl = $oRouter->GenerateUrl($sRoute, $aParams, $bAbsoluteUrl);
$sExpectedUrl = str_ireplace('<APP_ROOT_URL>', utils::GetAbsoluteUrlAppRoot(), $sExpectedUrl);
$this->assertEquals($sTestedUrl, $sExpectedUrl, 'Generated URL does not match');
}
public function GenerateUrlProvider(): array
{
return [
'invalid route' => [
'',
false,
'foo.bar',
[],
true,
],
'relative route with no params' => [
'pages/UI.php?route=object.modify',
true,
'object.modify',
[],
false,
],
'absolute route with no params' => [
'<APP_ROOT_URL>pages/UI.php?route=object.modify',
true,
'object.modify',
[],
true,
],
'absolute route with scalar params' => [
'<APP_ROOT_URL>pages/UI.php?route=object.modify&class=Person&id=123',
true,
'object.modify',
[
'class' => 'Person',
'id' => 123
],
true,
],
'absolute route with 1 dimension array params' => [
'<APP_ROOT_URL>pages/UI.php?route=object.modify&class=Person&id=123&default%5Bname%5D=Castor&default%5Bfirst_name%5D=P%C3%A8re',
true,
'object.modify',
[
'class' => 'Person',
'id' => 123,
'default' => [
'name' => 'Castor',
'first_name' => 'Père',
],
],
true,
],
'absolute route with 2 dimensions array params' => [
'<APP_ROOT_URL>pages/UI.php?route=object.modify&class=Person&id=123&default%5Bname%5D=Castor&default%5Bfirst_name%5D=P%C3%A8re&foo%5Bfirst%5D%5B0%5D=10&foo%5Bfirst%5D%5B1%5D=20&foo%5Bsecond%5D%5B0%5D=30&foo%5Bsecond%5D%5B1%5D=40',
true,
'object.modify',
[
'class' => 'Person',
'id' => 123,
'default' => [
'name' => 'Castor',
'first_name' => 'Père',
],
'foo' => [
'first' => ['10', '20'],
'second' => ['30', '40'],
],
],
true,
],
];
}
/**
* @dataProvider CanDispatchRouteProvider
* @covers \Combodo\iTop\Service\Router\Router::CanDispatchRoute
*
* @param string $sRoute
* @param $bExpectedResult
*
* @return void
*/
// public function testCanDispatchRoute(string $sRoute, $bExpectedResult): void
// {
// $oRouter = Router::GetInstance();
// $bTestedResult = $oRouter->CanDispatchRoute($sRoute);
//
// $sRouteNamespace = $oRouter->GetRouteNamespace($sRoute);
// $sRouteOperation = $oRouter->GetRouteOperation($sRoute);
// $aRouteParts = $oRouter->GetRouteParts($sRoute);
// $sControllerFQCN = $this->InvokeNonPublicMethod(get_class($oRouter), 'FindControllerFromRouteNamespace', $oRouter, ['object']);
// $sMethodName = $this->InvokeNonPublicMethod(get_class($oRouter), 'MakeOperationMethodNameFromOperation', $oRouter, ['modify']);
// $aDispatchSpecs = $oRouter->GetDispatchSpecsForRoute($sRoute);
//
//$this->debug($sRoute);
//$this->debug($sRouteNamespace);
//$this->debug($sRouteOperation);
//$this->debug($aRouteParts);
//$this->debug($sControllerFQCN);
//$this->debug($sMethodName);
//$this->debug(is_callable([$sControllerFQCN, $sMethodName]) ? 'true' : 'false');
//$this->debug($aDispatchSpecs);
//$this->debug($bTestedResult);
// $this->assertEquals($bExpectedResult, $bTestedResult, "Dispatch capability for '$sRoute' was not the expected one. Got ".var_export($bTestedResult, true).", expected ".var_export($bExpectedResult, true));
// }
public function CanDispatchRouteProvider(): array
{
return [
'Existing handler' => [
'object.modify',
true,
],
'Existing controller but unknown operation' => [
'object.modify_me_please',
false,
],
'Unknown controller' => [
'foo.bar',
false,
],
];
}
/**
* @dataProvider GetRouteNamespaceProvider
* @covers \Combodo\iTop\Service\Router\Router::GetRouteNamespace
*
* @param string $sRoute
* @param string|null $sExpectedNamespace
*
* @return void
*/
public function testGetRouteNamespace(string $sRoute, ?string $sExpectedNamespace): void
{
$oRouter = Router::GetInstance();
$sTestedNamespace = $oRouter->GetRouteNamespace($sRoute);
$this->assertEquals($sExpectedNamespace, $sTestedNamespace, "Namespace found for '$sRoute' was not the expected one. Got '$sTestedNamespace', expected '$sExpectedNamespace'.");
}
public function GetRouteNamespaceProvider(): array
{
return [
'Operation without namespace' => [
'some_operation',
null,
],
'Operation with namespace' => [
'some_namespace.some_operation',
'some_namespace',
],
'Operation with multi-levels namespace' => [
'some.deep.namespace.some_operation',
'some.deep.namespace',
],
];
}
/**
* @dataProvider GetRouteOperationProvider
* @covers \Combodo\iTop\Service\Router\Router::GetRouteOperation
*
* @param string $sRoute
* @param string|null $sExpectedOperation
*
* @return void
*/
public function testGetRouteOperation(string $sRoute, ?string $sExpectedOperation): void
{
$oRouter = Router::GetInstance();
$sTestedOperation = $oRouter->GetRouteOperation($sRoute);
$this->assertEquals($sExpectedOperation, $sTestedOperation, "Operation found for '$sRoute' was not the expected one. Got '$sTestedOperation', expected '$sExpectedOperation'.");
}
public function GetRouteOperationProvider(): array
{
return [
'Operation without namespace' => [
'some_operation',
null,
],
'Operation with namespace' => [
'some_namespace.some_operation',
'some_operation',
],
'Operation with multi-levels namespace' => [
'some.deep.namespace.some_operation',
'some_operation',
],
];
}
/**
* @dataProvider FindControllerFromRouteNamespaceProvider
* @covers \Combodo\iTop\Service\Router\Router::FindControllerFromRouteNamespace
*
* @param string $sRouteNamespace
* @param string $sExpectedControllerFQCN
*
* @return void
*/
public function testFindControllerFromRouteNamespace(string $sRoute, ?string $sExpectedControllerFQCN): void
{
$oRouter = Router::GetInstance();
$sRouteNamespace = $oRouter->GetRouteNamespace($sRoute);
$sTestedControllerFQCN = $this->InvokeNonPublicMethod(get_class($oRouter), 'FindControllerFromRouteNamespace', $oRouter, [$sRouteNamespace]);
$this->assertEquals($sExpectedControllerFQCN, $sTestedControllerFQCN, "Controller found for '$sRouteNamespace' was not the expected one. Got '$sTestedControllerFQCN', expected '$sExpectedControllerFQCN'.");
}
public function FindControllerFromRouteNamespaceProvider(): array
{
return [
'Object controller' => [
'object.modify',
'Combodo\iTop\Controller\Base\Layout\ObjectController',
],
'Unknown controller' => [
'something_that_should_not_exist_in_the_default_package.foo',
null,
],
];
}
/**
* @dataProvider GetOperationMethodNameFromRouteOperationProvider
* @covers \Combodo\iTop\Service\Router\Router::MakeOperationMethodNameFromOperation
*
* @param string $sRoute
* @param string $sExpectedMethodName
*
* @return void
*/
public function testGetOperationMethodNameFromRouteOperation(string $sRoute, string $sExpectedMethodName): void
{
$oRouter = Router::GetInstance();
$aRouteParts = $oRouter->GetRouteParts($sRoute);
$sTestedMethodName = $this->InvokeNonPublicMethod(get_class($oRouter), 'MakeOperationMethodNameFromOperation', $oRouter, [$aRouteParts['operation']]);
$this->assertEquals($sExpectedMethodName, $sTestedMethodName, "Operation method name '".$aRouteParts['operation']."' was not matching the expected one. Got '$sTestedMethodName', expected '$sExpectedMethodName'.");
}
public function GetOperationMethodNameFromRouteOperationProvider(): array
{
return [
'Simple operation' => [
'object.modify',
'OperationModify',
],
'Operation with an underscore' => [
'object.apply_modify',
'OperationApplyModify',
],
];
}
}