composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-02-27 06:04:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

module dependency optimization - refacto + dependency new sort order

Browse Source
This commit is contained in:
odain
2025-03-10 15:10:22 +01:00
parent dd68017020
commit 460a3e356e
6 changed files with 990 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files

213
tests/php-unit-tests/unitary-tests/setup/ModuleDiscoveryTest.php
View File

@@ -2,45 +2,18 @@
namespace Combodo\iTop\Test\UnitTest\Setup;
use Combodo\iTop\Test\UnitTest\ItopTestCase;
use Combodo\iTop\Test\UnitTest\ItopDataTestCase;
use ModuleDiscovery;
class ModuleDiscoveryTest extends ItopTestCase
class ModuleDiscoveryTest extends ItopDataTestCase
{
public function setUp(): void {
parent::setUp();
$this->RequireOnceItopFile('setup/modulediscovery.class.inc.php');
}
public function testSortModulesByCountOfDepencenciesDescending()
{
$aOngoingDependencies=[];
$aExpectedKeys=[];
for($i=5; $i>0; $i--){
$sKey = "k$i";
$aExpectedKeys[]=$sKey;
$aDeps=[];
for ($j=0; $j<$i; $j++){
$aDeps[]=$j;
}
$aOngoingDependencies[$sKey]=$aDeps;
}
sort($aExpectedKeys);
\ModuleDiscovery::SortModulesByCountOfDepencenciesDescending($aOngoingDependencies);
$this->assertEquals($aExpectedKeys, array_keys($aOngoingDependencies));
}
public function testOrderModulesByDependencies_CheckMissingDependenciesAreCorrectlyOrderedInTheException()
{
$sExpectedMessage = <<<MSG
The following modules have unmet dependencies:
label2 (id: id2/456) depends on: ❌ id3/666,
label1 (id: id1/123) depends on: ❌ id3/666 + ❌ id4/666
MSG;
$this->expectExceptionMessage($sExpectedMessage);
$aModules=[
"id1/123" => [
'dependencies' => [ 'id3/666', 'id4/666'],
@@ -51,34 +24,115 @@ MSG;
'label' => 'label2',
],
];
\ModuleDiscovery::OrderModulesByDependencies($aModules, true);
$iLoopCount=0;
try{
ModuleDiscovery::OrderModulesByDependencies($aModules, true, null, $iLoopCount);
} catch(\MissingDependencyException $e){
$sExpectedMessage = <<<MSG
The following modules have unmet dependencies:
label2 (id: id2/456) depends on: ❌ id3/666,
label1 (id: id1/123) depends on: ❌ id3/666 + ❌ id4/666
MSG;
$this->assertEquals($sExpectedMessage, $e->getMessage());
$this->assertEquals(1, $iLoopCount);
}
}
public function testOrderModulesByDependencies_ValidateExceptionWithSomeDependenciesResolved()
{
$sExpectedMessage = <<<MSG
The following modules have unmet dependencies:
label1 (id: id1/123) depends on: ✅ id2/456 + ❌ id4/666
MSG;
$this->expectExceptionMessage($sExpectedMessage);
$aModules=[
"id1/123" => [
'dependencies' => [ 'id2/456', 'id4/666'],
'dependencies' => [ 'id2/456', 'id4/666', 'id3/789'],
'label' => 'label1',
],
"id2/456" => [
'dependencies' => [],
'label' => 'label2',
],
"id3/789" => [
'dependencies' => [ 'id2/456', 'id4/666'],
'label' => 'label3',
],
];
\ModuleDiscovery::OrderModulesByDependencies($aModules, true);
$iLoopCount=0;
try{
ModuleDiscovery::OrderModulesByDependencies($aModules, true, null, $iLoopCount);
} catch(\MissingDependencyException $e){
$sExpectedMessage = <<<MSG
The following modules have unmet dependencies:
label3 (id: id3/789) depends on: ✅ id2/456 + ❌ id4/666,
label1 (id: id1/123) depends on: ✅ id2/456 + ❌ id4/666 + ❌ id3/789
MSG;
$this->assertEquals($sExpectedMessage, $e->getMessage());
$this->assertEquals(2, $iLoopCount);
}
}
public function testOrderModulesByDependencies_KeepGoingEvenWithFailure_WithSomeDependenciesResolved()
{
$aModules=[
"id1/123" => [
'dependencies' => [ 'id2/456', 'id4/666', 'id3/789'],
'label' => 'label1',
],
"id2/456" => [
'dependencies' => [],
'label' => 'label2',
],
"id3/789" => [
'dependencies' => [ 'id2/456', 'id4/666'],
'label' => 'label3',
],
];
$iLoopCount=0;
$aResult = ModuleDiscovery::OrderModulesByDependencies($aModules, false, null, $iLoopCount);
$aExpected = [
'id2/456'
];
$this->assertEquals($aExpected, array_keys($aResult));
$this->assertEquals(2, $iLoopCount);
}
public function testOrderModulesByDependencies_UnResolveWithCircularDependency()
{
$aModules=[
"id1/1" => [
'dependencies' => [ 'id2/2'],
'label' => 'label1',
],
"id2/2" => [
'dependencies' => ['id3/3'],
'label' => 'label2',
],
"id3/3" => [
'dependencies' => ['id4/4'],
'label' => 'label3',
],
"id4/4" => [
'dependencies' => ['id1/1'],
'label' => 'label4',
],
];
$iLoopCount=0;
try{
ModuleDiscovery::OrderModulesByDependencies($aModules, true, null, $iLoopCount);
} catch(\MissingDependencyException $e){
$sExpectedMessage = <<<MSG
The following modules have unmet dependencies:
label1 (id: id1/1) depends on: ❌ id2/2,
label4 (id: id4/4) depends on: ❌ id1/1,
label3 (id: id3/3) depends on: ❌ id4/4,
label2 (id: id2/2) depends on: ❌ id3/3
MSG;
$this->assertEquals($sExpectedMessage, $e->getMessage());
$this->assertEquals(1, $iLoopCount);
}
}
public function testOrderModulesByDependencies_ResolveOk()
{
$aModules=[
"id1/1" => [
'dependencies' => [ 'id2/2'],
@@ -97,7 +151,8 @@ MSG;
'label' => 'label4',
],
];
$aResult = \ModuleDiscovery::OrderModulesByDependencies($aModules, true);
$iLoopCount=0;
$aResult = ModuleDiscovery::OrderModulesByDependencies($aModules, true, null, $iLoopCount);
$aExpected = [
"id4/4",
@@ -106,5 +161,79 @@ MSG;
"id1/1",
];
$this->assertEquals($aExpected, array_keys($aResult));
$this->assertEquals(1, $iLoopCount);
}
public function testOrderModulesByDependencies_RealExample(){
$aModules = json_decode(file_get_contents(__DIR__ . '/ressources/module_deps.json'), true);
$iLoopCount=0;
$aResult = ModuleDiscovery::OrderModulesByDependencies($aModules, true, null, $iLoopCount);
$aExpected = json_decode(file_get_contents(__DIR__ . '/ressources/expected_ordered_module_ids.json'), true);
$this->assertEquals($aExpected, array_keys($aResult));
$this->assertEquals(1, $iLoopCount);
}
public function testSortModulesByCountOfDepencenciesDescending_NoDependencies(){
$aUnresolvedDependencyModules = [];
foreach (['a', 'b', 'c'] as $sModuleId){
$this->AddModule($aUnresolvedDependencyModules, $sModuleId, []);
}
ModuleDiscovery::SortModulesByCountOfDepencenciesDescending($aUnresolvedDependencyModules);
$this->assertEquals(['a', 'b', 'c'], array_keys($aUnresolvedDependencyModules));
}
public function testSortModulesByCountOfDepencenciesDescending_NominalUseCase(){
$aUnresolvedDependencyModules = [];
$this->AddModule($aUnresolvedDependencyModules, 'itop-change-mgmt/456', ['itop-config-mgmt/2.2.0', 'itop-tickets/2.0.0']);
$this->AddModule($aUnresolvedDependencyModules, 'itop-tickets/2.0.0', ['itop-structure/2.7.1']);
$this->AddModule($aUnresolvedDependencyModules, 'itop-config-mgmt/123', ['itop-structure/2.7.1']);
$this->AddModule($aUnresolvedDependencyModules, 'itop-structure/2.7.1', []);
ModuleDiscovery::SortModulesByCountOfDepencenciesDescending($aUnresolvedDependencyModules);
$this->assertEquals(
[
'itop-structure/2.7.1',
'itop-tickets/2.0.0',
'itop-config-mgmt/123',
'itop-change-mgmt/456',
], array_keys($aUnresolvedDependencyModules));
}
public function testSortModulesByCountOfDepencenciesDescending_NominalUseCaseWithMissingDependency(){
$aUnresolvedDependencyModules = [];
$this->AddModule($aUnresolvedDependencyModules, 'itop-change-mgmt/456', ['itop-config-mgmt/2.2.0', 'itop-tickets/2.0.0']);
$this->AddModule($aUnresolvedDependencyModules, 'itop-tickets/2.0.0', ['itop-structure/2.7.1']);
$this->AddModule($aUnresolvedDependencyModules, 'itop-config-mgmt/123', ['itop-structure/2.7.1']);
ModuleDiscovery::SortModulesByCountOfDepencenciesDescending($aUnresolvedDependencyModules);
$this->assertEquals(
[
'itop-tickets/2.0.0',
'itop-config-mgmt/123',
'itop-change-mgmt/456',
],
array_keys($aUnresolvedDependencyModules));
}
private function AddModule(array &$aUnresolvedDependencyModules, string $sModuleId, array $aDeps){
$oModule = new \Module($sModuleId);
$oModule->SetDependencies($aDeps);
$aUnresolvedDependencyModules[$sModuleId]= $oModule;
}
public function testSortModulesByCountOfDepencenciesDescending_RealExample(){
$aUnresolvedDependencyModules = [];
$aDependencies = json_decode(file_get_contents(__DIR__ . '/ressources/module_deps.json'), true);
foreach ($aDependencies as $sModuleId => $aModuleData){
$this->AddModule($aUnresolvedDependencyModules, $sModuleId, $aModuleData['dependencies']);
}
ModuleDiscovery::SortModulesByCountOfDepencenciesDescending($aUnresolvedDependencyModules);
$aExpected = json_decode(file_get_contents(__DIR__ . '/ressources/expected_ordered_module_ids.json'), true);
$this->assertEquals(
$aExpected,
array_keys($aUnresolvedDependencyModules));
}
}