composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-05-18 06:48:50 +02:00
Code Issues Packages Projects Releases Wiki Activity

N°6275 - Add configured sorted list of iOrmCaseLogExtension : ormcaselog_extension_classes

Browse Source
This commit is contained in:
odain
2023-05-11 09:11:44 +02:00
parent 99a4260287
commit 7b36b5f10f
5 changed files with 186 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
core/config.class.inc.php
View File

@@ -1523,6 +1523,14 @@ class Config
'source_of_value' => '',
'show_in_conf_sample' => false,
],
'ormcaselog_extension_classes' => [
'type' => 'array',
'description' => 'Sorted list of enabled iOrmCaseLogExtension implementation classes',
'default' => [],
'value' => [],
'source_of_value' => '',
'show_in_conf_sample' => false,
],
'regenerate_session_id_enabled' => [
'type' => 'bool',
'description' => 'If true then session id will be regenerated on each login, to prevent session fixation.',

28
core/ormcaselogservice.inc.php
View File

@@ -15,23 +15,31 @@ class ormCaseLogService
* Array of "providers" of welcome popup messages
* @var iOrmCaseLogExtension[]
*/
protected $aOrmCaseLogExtension = null;
protected $aOrmCaseLogExtensions = null;
public function __construct(array $aOrmCaseLogExtensions=null)
{
$this->aOrmCaseLogExtension = $aOrmCaseLogExtensions;
$this->aOrmCaseLogExtensions = $aOrmCaseLogExtensions;
}
protected function LoadCaseLogExtensions()
protected function LoadCaseLogExtensions($aClassesForInterfaceOrmCaseLog=null) : array
{
if ($this->aOrmCaseLogExtension !== null) return;
if ($this->aOrmCaseLogExtensions !== null) return $this->aOrmCaseLogExtensions;
$aOrmCaseLogExtensions = [];
$aOrmCaseLogExtensionClasses = \utils::GetClassesForInterface(iOrmCaseLogExtension::class, '', array('[\\\\/]lib[\\\\/]', '[\\\\/]node_modules[\\\\/]', '[\\\\/]test[\\\\/]', '[\\\\/]tests[\\\\/]'));
foreach($aOrmCaseLogExtensionClasses as $sOrmCaseLogExtensionClass) {
$aOrmCaseLogExtensions[] = new $sOrmCaseLogExtensionClass();
if ($aClassesForInterfaceOrmCaseLog === null) {
$aClassesForInterfaceOrmCaseLog = \utils::GetClassesForInterface(iOrmCaseLogExtension::class, '',
array('[\\\\/]lib[\\\\/]', '[\\\\/]node_modules[\\\\/]', '[\\\\/]test[\\\\/]', '[\\\\/]tests[\\\\/]'));
}
$this->aOrmCaseLogExtension = $aOrmCaseLogExtensions;
$aConfiguredOrmCaseLogExtensionClasses = MetaModel::GetConfig()->Get('ormcaselog_extension_classes');
$this->aOrmCaseLogExtensions = [];
foreach ($aConfiguredOrmCaseLogExtensionClasses as $sConfiguredOrmCaseLogExtensionClass) {
if (in_array($sConfiguredOrmCaseLogExtensionClass, $aClassesForInterfaceOrmCaseLog)){
$this->aOrmCaseLogExtensions[] = new $sConfiguredOrmCaseLogExtensionClass();
}
}
return $this->aOrmCaseLogExtensions;
}
/**
@@ -45,7 +53,7 @@ class ormCaseLogService
$this->LoadCaseLogExtensions();
$bTouched = false;
foreach ($this->aOrmCaseLogExtension as $oOrmCaseLogExtension){
foreach ($this->aOrmCaseLogExtensions as $oOrmCaseLogExtension){
/** var iOrmCaseLogExtension $oOrmCaseLogExtension */
$bTouched = $bTouched || $oOrmCaseLogExtension->Rebuild($sLog, $aIndex);
}

13
tests/php-unit-tests/unitary-tests/core/OrmCaseLogExtensionForTest.php
View File

@@ -1,5 +1,7 @@
<?php
namespace Combodo\iTop\Test;
class OrmCaseLogExtensionForTest implements \iOrmCaseLogExtension
{
private $sReturnedLog;
@@ -22,3 +24,14 @@ class OrmCaseLogExtensionForTest implements \iOrmCaseLogExtension
}
}
class FakeOrmCaseLogExtension1 extends \AbstractOrmCaseLogExtension
{
}
class FakeOrmCaseLogExtension2 extends \AbstractOrmCaseLogExtension
{
}
class FakeOrmCaseLogExtension3 extends \AbstractOrmCaseLogExtension
{
}

140
tests/php-unit-tests/unitary-tests/core/ormCaseLogServiceTest.php Normal file
View File

@@ -0,0 +1,140 @@
<?php
/*
* @copyright Copyright (C) 2010-2023 Combodo SARL
* @license http://opensource.org/licenses/AGPL-3.0
*/
namespace Combodo\iTop\Test\UnitTest\Core;
use Combodo\iTop\Test\UnitTest\ItopDataTestCase;
/**
* Tests of the ormCaseLog class
*
* @covers \ormCaseLog
*
* @runTestsInSeparateProcesses
* @preserveGlobalState disabled
* @backupGlobals disabled
*/
class ormCaseLogTest extends ItopDataTestCase
{
public function setUp() :void{
parent::setUp(); // TODO: Change the autogenerated stub
require_once __DIR__ . "/OrmCaseLogExtensionForTest.php";
require_once APPROOT . "core/ormcaselogservice.inc.php";
}
public function LoadCaseLogExtensionsProvider() {
$sNamespace = 'Combodo\\iTop\\Test\\';
$sExtensionClass1 = $sNamespace . \FakeOrmCaseLogExtension1::class;
$sExtensionClass2 = $sNamespace . \FakeOrmCaseLogExtension2::class;
$sExtensionClass3 = $sNamespace . \FakeOrmCaseLogExtension3::class;
return [
'default conf' => [
'aClassesForInterfaceOrmCaseLog' => [],
'ormcaselog_extension_classes' => null,
'aExpectedOrmCaseLogExtensions' => [],
],
'default conf with extension implemented' => [
'aClassesForInterfaceOrmCaseLog' => [$sExtensionClass1],
'ormcaselog_extension_classes' => null,
'aExpectedOrmCaseLogExtensions' => [],
],
'conf but not extension implemented' => [
'aClassesForInterfaceOrmCaseLog' => [],
'ormcaselog_extension_classes' => [ $sExtensionClass1 ],
'aExpectedOrmCaseLogExtensions' => [],
],
'one extension configured/implemented' => [
'aClassesForInterfaceOrmCaseLog' => [$sExtensionClass1],
'ormcaselog_extension_classes' => [ $sExtensionClass1 ],
'aExpectedOrmCaseLogExtensions' => [$sExtensionClass1],
],
'one extension configured' => [
'aClassesForInterfaceOrmCaseLog' => [
$sExtensionClass3,
$sExtensionClass1,
$sExtensionClass2,
],
'ormcaselog_extension_classes' => [ $sExtensionClass1 ],
'aExpectedOrmCaseLogExtensions' => [$sExtensionClass1],
],
'3 sorted extensions' => [
'aClassesForInterfaceOrmCaseLog' => [
$sExtensionClass3,
$sExtensionClass1,
$sExtensionClass2,
],
'ormcaselog_extension_classes' => [
$sExtensionClass1,
$sExtensionClass2,
$sExtensionClass3
],
'aExpectedOrmCaseLogExtensions' => [
$sExtensionClass1,
$sExtensionClass2,
$sExtensionClass3
],
],
];
}
/**
* @dataProvider LoadCaseLogExtensionsProvider
*/
public function testLoadCaseLogExtensions($aClassesForInterfaceOrmCaseLog, $aDedicatedParamConf, $aExpectedOrmCaseLogExtensions) {
if (!is_null($aDedicatedParamConf)){
\MetaModel::GetConfig()->Set('ormcaselog_extension_classes', $aDedicatedParamConf);
var_dump($aDedicatedParamConf);
}
$oOrmCaseLogService = new \ormCaseLogService();
$aRes = $this->InvokeNonPublicMethod(\ormCaseLogService::class, "LoadCaseLogExtensions", $oOrmCaseLogService,
[$aClassesForInterfaceOrmCaseLog]);
$this->assertEquals(sizeof($aExpectedOrmCaseLogExtensions), sizeof($aRes));
foreach ($aRes as $i => $aExtensionObject){
$sExpectedClass = $aExpectedOrmCaseLogExtensions[$i];
$this->assertEquals($sExpectedClass, get_class($aExtensionObject));
}
}
public function testDefaultLoadCaseLogExtensions() {
$oOrmCaseLogService = new \ormCaseLogService();
$aRes = $this->InvokeNonPublicMethod(\ormCaseLogService::class, "LoadCaseLogExtensions", $oOrmCaseLogService,
[]);
$this->assertEquals(0, sizeof($aRes), 'no extension running by default on iTop');
}
public function testLoadCaseLogExtensions_Memorize() {
$sNamespace = 'Combodo\\iTop\\Test\\';
$sExtensionClass1 = $sNamespace . \FakeOrmCaseLogExtension1::class;
$sExtensionClass2 = $sNamespace . \FakeOrmCaseLogExtension2::class;
$aExtensions = [$sExtensionClass1];
\MetaModel::GetConfig()->Set('ormcaselog_extension_classes', $aExtensions);
$oOrmCaseLogService = new \ormCaseLogService();
$aRes = $this->InvokeNonPublicMethod(\ormCaseLogService::class, "LoadCaseLogExtensions", $oOrmCaseLogService,
[$aExtensions]);
//load first time
$this->assertEquals(sizeof($aExtensions), sizeof($aRes));
$aMoreExtensions = [$sExtensionClass1, $sExtensionClass2];
\MetaModel::GetConfig()->Set('ormcaselog_extension_classes', $aMoreExtensions);
$aRes = $this->InvokeNonPublicMethod(\ormCaseLogService::class, "LoadCaseLogExtensions", $oOrmCaseLogService,
[$aMoreExtensions]);
$this->assertEquals(sizeof($aExtensions), sizeof($aRes), 'should still have one extension (memorized)');
$oOrmCaseLogService = new \ormCaseLogService();
$aRes = $this->InvokeNonPublicMethod(\ormCaseLogService::class, "LoadCaseLogExtensions", $oOrmCaseLogService,
[$aMoreExtensions]);
$this->assertEquals(sizeof($aMoreExtensions), sizeof($aRes), 'first time load');
}
}

11
tests/php-unit-tests/unitary-tests/core/ormCaseLogTest.php
View File

@@ -125,6 +125,9 @@ class ormCaseLogTest extends ItopDataTestCase
);
$oJson = json_decode($sJson);
//create a real service with no extension to speed up treatment and avoid +1s delta in history diff
$oOrmCaseLogService = new \ormCaseLogService([]);
$iUserId = \UserRights::GetUserId();
$sOnBehalfOf = \UserRights::GetUserFriendlyName();
$sDate = date(\AttributeDateTime::GetInternalFormat());
@@ -142,8 +145,6 @@ class ormCaseLogTest extends ItopDataTestCase
]
];
//create a real service with no extension to speed up treatment and avoid +1s delta in history diff
$oOrmCaseLogService = new \ormCaseLogService([]);
$oLog = new ormCaseLog('', [], $oOrmCaseLogService);
$oOrmCaseLogService = $this->createMock(\ormCaseLogService::class);
@@ -181,6 +182,9 @@ class ormCaseLogTest extends ItopDataTestCase
);
$oJson = json_decode($sJson);
//create a real service with no extension to speed up treatment and avoid +1s delta in history diff
$oOrmCaseLogService = new \ormCaseLogService([]);
$iUserId = \UserRights::GetUserId();
$sOnBehalfOf = \UserRights::GetUserFriendlyName();
$sDate = date(\AttributeDateTime::GetInternalFormat());
@@ -197,8 +201,6 @@ class ormCaseLogTest extends ItopDataTestCase
]
];
//create a real service with no extension to speed up treatment and avoid +1s delta in history diff
$oOrmCaseLogService = new \ormCaseLogService([]);
$oLog = new ormCaseLog('', [], $oOrmCaseLogService);
$oOrmCaseLogService = $this->createMock(\ormCaseLogService::class);
@@ -262,5 +264,6 @@ class ormCaseLogTest extends ItopDataTestCase
$this->assertEquals($aInitialIndex, $oLog->GetIndex());
$this->assertEquals($sLog, $oLog->GetText());
}
$this->assertEquals($bTouched, $this->GetNonPublicProperty($oLog, 'm_bModified'));
}
}