N°8724 - Enhance setup feedback in case of module dependency issue (#700)

code style

last test cleanup

review + enhance UI output and display only failed module dependencies

real life test cleanup

review: add more tests + refacto

code review: enhance algo and APIs

review: renaming

enhance test coverage

refactoring

renaming + reorder functions/tests

compute GetDependencyResolutionFeedback in Module class

review2 : renaming things

fix rebase + code formatting

fix code formatting

review changes

refactoring: code cleanup/standardization/remove all prototype stuffs

refactoring: code cleanup/standardization/remove all prototype stuffs

add deps validation to extension ci job

fix ci

fix ci: test broken when dir to scan did not exist like production-modules

fix tests

module dependency validation moved in a core folder + cleanup dedicated unit/integration tests

forget dependency computation optimization seen as too risky + keep only user friendly sort in case of setup error

rebase on develop + split new sort computation apart from modulediscovery

revert to previous legacy order + gather new module computation classes in a dedicated folder

make validation work (dirty way) + cleanup

make setup deterministic: complete dependency order with alphabetical one when 2 module elements are at same position

final deps validation bases on DM and PHP classes

init in beforeclass + read defined classes/interfaces by module

module discovery classes renaming to avoid collision with customer DM definitions

read module file data apart from ModuleDiscovery

cleanup

cleanup

fix inconsistent module dependencies

fix integration check

save tmp work before trying to fetch other wml deps

fix module dependencies

fix DM filename typo

rename ModuleXXX classes by iTopCoreModuleXXX to reduce collisions with extensions

add phpdoc + add more tests

module dependency optimization - refacto + dependency new sort order

module dependency optimization - stop computation when no new dependency is resolved

enhance module dependency computation for optimization and admin feedback

tests/php-unit-tests/module_integration.xml.dist

@@ -31,6 +31,7 @@
       <testsuite name="ModuleIntegration">
         <file>integration-tests/DictionariesConsistencyAfterSetupTest.php</file>
         <file>integration-tests/DictionariesConsistencyTest.php</file>
+        <file>integration-tests/iTopModulesDependencyValidationServiceTest.php</file>
       </testsuite>
   </testsuites>
 

tests/php-unit-tests/unitary-tests/setup/ModuleDiscoveryTest.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace Combodo\iTop\Test\UnitTest\Setup;
+
+use Combodo\iTop\Test\UnitTest\ItopTestCase;
+use MissingDependencyException;
+use ModuleDiscovery;
+
+class ModuleDiscoveryTest extends ItopTestCase
+{
+	public function setUp(): void
+	{
+		parent::setUp();
+		$this->RequireOnceItopFile('setup/runtimeenv.class.inc.php');
+		$this->RequireOnceItopFile('setup/modulediscovery.class.inc.php');
+	}
+
+	public function testOrderModulesByDependencies_RealExample()
+	{
+		$aModules = json_decode(file_get_contents(__DIR__.'/ressources/reallife_discovered_modules.json'), true);
+
+		$aResult = ModuleDiscovery::OrderModulesByDependencies($aModules, true);
+
+		$aExpected = json_decode(file_get_contents(__DIR__.'/ressources/reallife_expected_ordered_modules.json'), true);
+		$this->assertEquals($aExpected, array_keys($aResult));
+	}
+
+	public function testOrderModulesByDependencies_LoadOnlyChoosenModules()
+	{
+		$aChoices = ['id1', 'id2'];
+
+		$aModules = [
+			"id1/1" => [
+				'dependencies' => [ 'id2/2'],
+				'label' => 'label1',
+			],
+			"id2/2" => [
+				'dependencies' => [],
+				'label' => 'label2',
+			],
+			"id3/3" => [
+				'dependencies' => [],
+				'label' => 'label3',
+			],
+		];
+
+		$aResult = ModuleDiscovery::OrderModulesByDependencies($aModules, true, $aChoices);
+
+		$aExpected = [
+			"id2/2",
+			"id1/1",
+		];
+		$this->assertEquals($aExpected, array_keys($aResult));
+	}
+
+	public function testOrderModulesByDependencies_FailWhenChoosenModuleDependsOnUnchoosenModule()
+	{
+		$aChoices = ['id1'];
+
+		$aModules = [
+			"id1/1" => [
+				'dependencies' => [ 'id2/2'],
+				'label' => 'label1',
+			],
+			"id2/2" => [
+				'dependencies' => [],
+				'label' => 'label2',
+			],
+		];
+
+		$sExpectedMessage = <<<TXT
+The following modules have unmet dependencies:
+label1 (id: id1/1) depends on: ❌ id2/2
+TXT;
+		$this->expectException(MissingDependencyException::class);
+		$this->expectExceptionMessage($sExpectedMessage);
+
+		ModuleDiscovery::OrderModulesByDependencies($aModules, true, $aChoices);
+	}
+}

tests/php-unit-tests/unitary-tests/setup/moduledependency/DependencyExpressionTest.php

@@ -0,0 +1,189 @@
+<?php
+
+namespace Combodo\iTop\Test\UnitTest\Setup;
+
+use Combodo\iTop\Setup\ModuleDependency\DependencyExpression;
+use Combodo\iTop\Test\UnitTest\ItopTestCase;
+
+class DependencyExpressionTest extends ItopTestCase
+{
+	public function setUp(): void
+	{
+		parent::setUp();
+		$this->RequireOnceItopFile('setup/moduledependency/dependencyexpression.class.inc.php');
+	}
+
+	public function testModuleDependencyInit_Invalid()
+	{
+		$oModuleDependency = new DependencyExpression('||');
+		$this->assertFalse($oModuleDependency->IsValid());
+		$this->assertFalse($oModuleDependency->IsResolved());
+	}
+
+	public static function WithOperatorProvider()
+	{
+		return [
+			"nominal case" => [
+				"dep" => "itop-config-mgmt/2.4.0",
+				'expected_operator' => '>=',
+			],
+			">" => [
+				"dep" => "itop-config-mgmt/>2.4.0",
+				'expected_operator' => '>',
+			],
+			">=" => [
+				"dep" => "itop-config-mgmt/>=2.4.0",
+				'expected_operator' => '>=',
+			],
+			"<" => [
+				"dep" => "itop-config-mgmt/<2.4.0",
+				'expected_operator' => '<',
+			],
+			"<=" => [
+				"dep" => "itop-config-mgmt/<=2.4.0",
+				'expected_operator' => '<=',
+			],
+		];
+	}
+
+	/**
+	 * @dataProvider WithOperatorProvider
+	 */
+	public function testModuleDependencyInit_WithOperator($sDepId, $sExpectedOperator)
+	{
+		$oModuleDependency = new DependencyExpression($sDepId);
+		$this->assertEquals([$sDepId => ['itop-config-mgmt', $sExpectedOperator, '2.4.0']], $this->GetNonPublicProperty($oModuleDependency, 'aParamsPerModuleId'));
+		$this->assertTrue($oModuleDependency->IsValid());
+		$this->assertFalse($oModuleDependency->IsResolved());
+		;
+		$this->assertEquals(['itop-config-mgmt'], $oModuleDependency->GetRemainingModuleNamesToResolve());
+	}
+
+	public static function WithOperatorOperandProvider()
+	{
+		$aInternalStructure = ['itop-structure/3.0.0' => [ 'itop-structure',  ">=", '3.0.0'], 'itop-portal/<3.2.1' => [ 'itop-portal',  "<", '3.2.1']];
+		return [
+			'&&' => [
+				'sDepId' => 'itop-structure/3.0.0 && itop-portal/<3.2.1',
+				'expected_structure' => $aInternalStructure,
+			],
+			'&& with parenthesis' => [
+				'sDepId' => '(itop-structure/3.0.0) && (itop-portal/<3.2.1)',
+				'expected_structure' => $aInternalStructure,
+			],
+			'||' => [
+				'sDepId' => 'itop-structure/3.0.0 || itop-portal/<3.2.1',
+				'expected_structure' => $aInternalStructure,
+			],
+			'|| with parenthesis' => [
+				'sDepId' => '(itop-structure/3.0.0) || (itop-portal/<3.2.1)',
+				'expected_structure' => $aInternalStructure,
+			],
+		];
+	}
+
+	/**
+	 * @dataProvider WithOperatorOperandProvider
+	 */
+	public function testModuleDependencyInit_WithOperand($sDepId, $sExpected)
+	{
+		$oModuleDependency = new DependencyExpression($sDepId);
+		$this->assertEquals($sExpected, $this->GetNonPublicProperty($oModuleDependency, 'aParamsPerModuleId'));
+		$this->assertTrue($oModuleDependency->IsValid());
+		;
+		$this->assertEquals(['itop-structure', 'itop-portal'], $oModuleDependency->GetRemainingModuleNamesToResolve());
+	}
+
+	public static function SimpleDependencyExpressionIsResolvedProvider()
+	{
+		return [
+			'unresolved with major version' => [
+				'expr' => 'itop-config-mgmt/2.4.0',
+				'module_versions' => ['itop-config-mgmt' => '1.2.3'],
+				'expected_is_resolved' => false,
+			],
+			'unresolved with minor version' => [
+				'expr' => 'itop-config-mgmt/2.4.1',
+				'module_versions' => ['itop-config-mgmt' => '2.4.0-1'],
+				'expected_is_resolved' => false,
+			],
+			'resolution OK with major version' => [
+				'expr' => 'itop-config-mgmt/2.4.0',
+				'module_versions' => ['itop-config-mgmt' => '2.4.2'],
+				'expected_is_resolved' => true,
+			],
+			'resolution OK with minor version' => [
+				'expr' => 'itop-config-mgmt/2.4.0',
+				'module_versions' => ['itop-config-mgmt' => '2.4.0-1'],
+				'expected_is_resolved' => true,
+			],
+			'unproper use of api' => [
+				'expr' => 'itop-config-mgmt/2.4.0',
+				'module_versions' => [],
+				'expected_is_resolved' => false,
+			],
+		];
+	}
+
+	/**
+	 * @dataProvider SimpleDependencyExpressionIsResolvedProvider
+	 */
+	public function testSimpleDependencyExpressionIsResolved($sExpression, $aModuleVersions, $bExpectedResolved)
+	{
+		$oModuleDependency = new DependencyExpression($sExpression);
+		$oModuleDependency->UpdateModuleResolutionState($aModuleVersions, ['itop-config-mgmt' => true]);
+		$this->assertEquals($bExpectedResolved, $oModuleDependency->IsResolved());
+		if ($bExpectedResolved) {
+			$this->assertEquals([], $oModuleDependency->GetRemainingModuleNamesToResolve());
+		}
+	}
+
+	public static function ComplexDependencyExpressionIsResolvedProvider()
+	{
+		return [
+			'and + unresolved due to missing itop-portal' => [
+				'expr' => 'itop-structure/3.0.0 && itop-portal/3.2.1',
+				'module_versions' => ['itop-structure' => '3.0.0'],
+				'expected_is_resolved' => false,
+				'remaining_module_names' => ['itop-portal'],
+			],
+			'and + unresolved due to unsifficient itop-portal version' => [
+				'expr' => 'itop-structure/3.0.0 && itop-portal/3.2.1',
+				'module_versions' => ['itop-structure' => '3.0.0', 'itop-portal' => '1.0.0'],
+				'expected_is_resolved' => false,
+				'remaining_module_names' => ['itop-portal'],
+			],
+			'and + resolved' => [
+				'expr' => 'itop-structure/3.0.0 && itop-portal/3.2.1',
+				'module_versions' => ['itop-structure' => '3.0.0', 'itop-portal' => '3.3.3'],
+				'expected_is_resolved' => true,
+				'remaining_module_names' => [],
+			],
+			'or + resolved' => [
+				'expr' => 'itop-structure/3.0.0 || itop-portal/3.2.1',
+				'module_versions' => ['itop-structure' => '3.0.0'],
+				'expected_is_resolved' => false,
+				'remaining_module_names' => ['itop-portal'],
+			],
+			'or + resolved with less prerequisites' => [
+				'expr' => 'itop-structure/3.0.0 || itop-portal/3.2.1',
+				'module_versions' => ['itop-structure' => '3.0.0'],
+				'expected_is_resolved' => true,
+				'remaining_module_names' => ['itop-portal'],
+				'prerequisites' => ['itop-structure' => true],
+			],
+		];
+	}
+
+	/**
+	 * @dataProvider ComplexDependencyExpressionIsResolvedProvider
+	 */
+	public function testComplexDependencyExpressionIsResolved($sExpression, $aModuleVersions, $bExpectedResolved, $aRemainingModuleNames, $aPrerequisites = ['itop-structure' => true, 'itop-portal' => true])
+	{
+		$oModuleDependency = new DependencyExpression($sExpression);
+
+		$oModuleDependency->UpdateModuleResolutionState($aModuleVersions, $aPrerequisites);
+		$this->assertEquals($aRemainingModuleNames, $oModuleDependency->GetRemainingModuleNamesToResolve());
+		$this->assertEquals($bExpectedResolved, $oModuleDependency->IsResolved());
+	}
+}

tests/php-unit-tests/unitary-tests/setup/moduledependency/ModuleDependencySortTest.php

@@ -0,0 +1,374 @@
+<?php
+
+namespace Combodo\iTop\Test\Setup\ModuleDependency;
+
+use Combodo\iTop\Setup\ModuleDependency\Module;
+use Combodo\iTop\Setup\ModuleDependency\ModuleDependencySort;
+use Combodo\iTop\Test\UnitTest\ItopTestCase;
+use MissingDependencyException;
+
+class ModuleDependencySortTest extends ItopTestCase
+{
+	public function setUp(): void
+	{
+		parent::setUp();
+
+		$this->RequireOnceItopFile('setup/modulediscovery.class.inc.php');
+		$this->RequireOnceItopFile('setup/moduledependency/moduledependencysort.class.inc.php');
+	}
+
+	public function testOrderModulesByDependencies_CheckExceptionWhenAllModuleUnresolved()
+	{
+		$aModules = [
+			"id1/123" => [
+				'dependencies' => [ 'id3/666', 'id4/666'],
+				'label' => 'label1',
+			],
+			"id2/456" => [
+				'dependencies' => ['id3/666'],
+				'label' => 'label2',
+			],
+		];
+
+		$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->expectException(MissingDependencyException::class);
+		$this->expectExceptionMessage($sExpectedMessage);
+
+		ModuleDependencySort::GetInstance()->GetModulesOrderedForInstallation($aModules, true);
+	}
+
+	public function testOrderModulesByDependencies_CheckExceptionWhenSomeModuleUnresolved()
+	{
+		$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',
+			],
+		];
+
+		$sExpectedMessage = <<<MSG
+The following modules have unmet dependencies:
+label3 (id: id3/789) depends on: ❌ id4/666,
+label1 (id: id1/123) depends on: ❌ id4/666 + ❌ id3/789
+MSG;
+		$this->expectException(MissingDependencyException::class);
+		$this->expectExceptionMessage($sExpectedMessage);
+
+		ModuleDependencySort::GetInstance()->GetModulesOrderedForInstallation($aModules, true);
+	}
+
+	public function testOrderModulesByDependencies_CheckExceptionWhenCircularDependencies()
+	{
+		$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',
+			],
+		];
+
+		$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->expectException(MissingDependencyException::class);
+		$this->expectExceptionMessage($sExpectedMessage);
+
+		ModuleDependencySort::GetInstance()->GetModulesOrderedForInstallation($aModules, true);
+	}
+
+	public function testOrderModulesByDependencies_KeepGoingEvenWithFailure()
+	{
+		$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',
+			],
+		];
+
+		$aResult = ModuleDependencySort::GetInstance()->GetModulesOrderedForInstallation($aModules, false);
+
+		$aExpected = [
+			'id2/456',
+		];
+
+		$this->assertEquals($aExpected, array_keys($aResult));
+	}
+
+	public function testOrderModulesByDependencies_Nominalcase()
+	{
+		$aModules = [
+			"id0/1" => [
+				'dependencies' => [ 'id2/2'],
+				'label' => 'label1',
+			],
+			"id1/1" => [
+				'dependencies' => [ 'id2/2'],
+				'label' => 'label1',
+			],
+			"id2/2" => [
+				'dependencies' => ['id3/3'],
+				'label' => 'label2',
+			],
+			"id3/3" => [
+				'dependencies' => ['id4/4'],
+				'label' => 'label3',
+			],
+			"id4/4" => [
+				'dependencies' => [],
+				'label' => 'label4',
+			],
+		];
+
+		$aExpected = [
+			"id4/4",
+			"id3/3",
+			"id2/2",
+			"id0/1",
+			"id1/1",
+		];
+
+		$aResult = ModuleDependencySort::GetInstance()->GetModulesOrderedForInstallation($aModules, true);
+
+		$this->assertEquals($aExpected, array_keys($aResult));
+	}
+
+	//warning : tricky usecase
+	public function testOrderModulesByDependencies_AllTermsOfOrExpressionWillImpactTheOrder()
+	{
+		$aModules = [
+			"id0/1" => [
+				'dependencies' => [ 'id2/2 || id1/1'],
+				'label' => 'label1',
+			],
+			"id1/1" => [
+				'dependencies' => [ 'id2/2'],
+				'label' => 'label1',
+			],
+			"id2/2" => [
+				'dependencies' => [],
+				'label' => 'label2',
+			],
+		];
+
+		$aExpected = [
+			"id2/2",
+			"id1/1",
+			"id0/1",
+		];
+
+		$aResult = ModuleDependencySort::GetInstance()->GetModulesOrderedForInstallation($aModules, true);
+
+		$this->assertEquals($aExpected, array_keys($aResult));
+	}
+
+	//WARNING: alphabetical order make setup are determinititic
+	public function testOrderModulesByDependencies_ResolveNoDependendenciesOrderByAlphabeticalOrder()
+	{
+		$aModules = [
+			"id2/2" => [
+				'dependencies' => [],
+				'label' => 'label2',
+			],
+			"id1/1" => [
+				'dependencies' => [],
+				'label' => 'label1',
+			],
+			"id3/3" => [
+				'dependencies' => [],
+				'label' => 'label3',
+			],
+			"id4/4" => [
+				'dependencies' => [],
+				'label' => 'label4',
+			],
+			"id0/1" => [
+				'dependencies' => [],
+				'label' => 'label0',
+			],
+		];
+
+		$aExpected = [
+			"id0/1",
+			"id1/1",
+			"id2/2",
+			"id3/3",
+			"id4/4",
+		];
+
+		$aResult = ModuleDependencySort::GetInstance()->GetModulesOrderedForInstallation($aModules, true);
+
+		$this->assertEquals($aExpected, array_keys($aResult));
+	}
+
+	public function testOrderModulesByDependencies_AlphabeticalOrderWithDependencies()
+	{
+		$aModules = [
+			"id2/2" => [
+				'dependencies' => ["id1/1"],
+				'label' => 'label2',
+			],
+			"id1/1" => [
+				'dependencies' => [],
+				'label' => 'label1',
+			],
+			"id3/3" => [
+				'dependencies' => ["id1/1"],
+				'label' => 'label3',
+			],
+		];
+
+		$aExpected = [
+			"id1/1",
+			"id2/2",
+			"id3/3",
+		];
+
+		$aResult = ModuleDependencySort::GetInstance()->GetModulesOrderedForInstallation($aModules, true);
+
+		$this->assertEquals($aExpected, array_keys($aResult));
+	}
+
+	public function testOrderModulesByDependencies_AlphabeticalOrderWithDependencies2()
+	{
+		$aModules = [
+			"z_id2/2" => [ //difference here
+				'dependencies' => ["id1/1"],
+				'label' => 'label2',
+			],
+			"id1/1" => [
+				'dependencies' => [],
+				'label' => 'label1',
+			],
+			"id3/3" => [
+				'dependencies' => ["id1/1"],
+				'label' => 'label3',
+			],
+		];
+
+		$aExpected = [
+			"id1/1",
+			"id3/3",
+			"z_id2/2",
+		];
+
+		$aResult = ModuleDependencySort::GetInstance()->GetModulesOrderedForInstallation($aModules, true);
+
+		$this->assertEquals($aExpected, array_keys($aResult));
+	}
+
+	public function testSortModulesByCountOfDepencenciesDescending_NoDependencies()
+	{
+		$aUnresolvedDependencyModules = [];
+		$this->AddModule($aUnresolvedDependencyModules, 'c', []);
+		$this->AddModule($aUnresolvedDependencyModules, 'b', []);
+		$this->AddModule($aUnresolvedDependencyModules, 'a', []);
+
+		$this->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', []);
+
+		$this->SortModulesByCountOfDepencenciesDescending($aUnresolvedDependencyModules);
+		$this->assertEquals(
+			[
+				'itop-structure/2.7.1',
+				'itop-config-mgmt/123',
+				'itop-tickets/2.0.0',
+				'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']);
+
+		$this->SortModulesByCountOfDepencenciesDescending($aUnresolvedDependencyModules);
+		$this->assertEquals(
+			[
+				'itop-config-mgmt/123',
+				'itop-tickets/2.0.0',
+				'itop-change-mgmt/456',
+			],
+			array_keys($aUnresolvedDependencyModules)
+		);
+	}
+
+	public function testSortModulesByCountOfDepencenciesDescending_FurtherVersionsOfSameModule()
+	{
+		$aUnresolvedDependencyModules = [];
+		$this->AddModule($aUnresolvedDependencyModules, 'moduleA/1', []);
+		$this->AddModule($aUnresolvedDependencyModules, 'moduleA/2', ['moduleC/1']);
+		$this->AddModule($aUnresolvedDependencyModules, 'moduleB/1', ['moduleA/1']);
+		$this->AddModule($aUnresolvedDependencyModules, 'moduleC/1', []);
+
+		$this->SortModulesByCountOfDepencenciesDescending($aUnresolvedDependencyModules);
+		$this->assertEquals(
+			[
+				'moduleA/1',
+				'moduleC/1',
+				'moduleA/2',
+				'moduleB/1',
+			],
+			array_keys($aUnresolvedDependencyModules)
+		);
+	}
+
+	private function AddModule(array &$aUnresolvedDependencyModules, string $sModuleId, array $aDeps)
+	{
+		$oModule = new Module($sModuleId);
+		$oModule->SetDependencies($aDeps);
+		$aUnresolvedDependencyModules[$sModuleId] = $oModule;
+	}
+
+	private function SortModulesByCountOfDepencenciesDescending(array &$aUnresolvedDependencyModules)
+	{
+		$this->InvokeNonPublicMethod(ModuleDependencySort::class, 'SortModulesByCountOfDepencenciesDescending', ModuleDependencySort::GetInstance(), [&$aUnresolvedDependencyModules]);
+	}
+}

tests/php-unit-tests/unitary-tests/setup/moduledependency/ModuleTest.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Combodo\iTop\Test\UnitTest\Setup;
+
+use Combodo\iTop\Setup\ModuleDependency\Module;
+use Combodo\iTop\Test\UnitTest\ItopTestCase;
+
+class ModuleTest extends ItopTestCase
+{
+	public function setUp(): void
+	{
+		parent::setUp();
+		$this->RequireOnceItopFile('setup/moduledependency/module.class.inc.php');
+	}
+
+	public function testModuleInit()
+	{
+		$oModule = new Module("itop-config-mgmt/2.4.0");
+		$this->assertEquals("itop-config-mgmt", $oModule->GetModuleName());
+		$this->assertEquals("2.4.0", $oModule->GetVersion());
+		$this->assertEquals("itop-config-mgmt/2.4.0", $oModule->GetModuleId());
+	}
+
+	public function testModuleInit_NoVersion()
+	{
+		$oModule = new Module("itop-config-mgmt");
+		$this->assertEquals("itop-config-mgmt", $oModule->GetModuleName());
+		$this->assertEquals("1.0.0", $oModule->GetVersion());
+		$this->assertEquals("itop-config-mgmt", $oModule->GetModuleId());
+	}
+
+	public function testSetDependencies_ComplexExpressionsParsing()
+	{
+		$oModule = new Module("itop-bridge-datacenter-mgmt-services");
+		$oModule->SetDependencies([
+			'itop-config-mgmt/>2.7.1',
+			'itop-service-mgmt/=2.7.1 || itop-service-mgmt-provider/<=2.7.1',
+			'itop-datacenter-mgmt/3.1.0 || true && false',
+		]);
+		$this->assertEquals(
+			['itop-config-mgmt', 'itop-service-mgmt', 'itop-service-mgmt-provider', 'itop-datacenter-mgmt' ],
+			$oModule->GetUnresolvedDependencyModuleNames()
+		);
+	}
+
+	public function testIsResolved_Unresolved()
+	{
+		$oModule = new Module("itop-bridge-cmdb-ticket");
+		$oModule->SetDependencies(['itop-config-mgmt/2.7.1', 'itop-tickets/2.7.0']);
+		$this->assertEquals(['itop-config-mgmt', 'itop-tickets'], $oModule->GetUnresolvedDependencyModuleNames(), "all dependencies are unresolved");
+		$this->assertFalse($oModule->IsResolved());
+
+		$oModule->UpdateModuleResolutionState([], []);
+		$this->assertFalse($oModule->IsResolved(), "all dependencies are still unresolved");
+	}
+
+	public function testIsResolved_PartialResolution()
+	{
+		$oModule = new Module("itop-bridge-cmdb-ticket");
+		$oModule->SetDependencies(['itop-config-mgmt/2.7.1', 'itop-tickets/2.7.0']);
+
+		$oModule->UpdateModuleResolutionState(['itop-config-mgmt' => '2.7.1'], ['itop-config-mgmt' => true]);
+		$this->assertFalse($oModule->IsResolved(), "some dependencies are still unresolved");
+		$this->assertEquals(['itop-tickets'], $oModule->GetUnresolvedDependencyModuleNames(), 'one dependency is remaining');
+	}
+
+	public function testIsResolved_OK()
+	{
+		$oModule = new Module("itop-bridge-cmdb-ticket");
+		$oModule->SetDependencies(['itop-config-mgmt/2.7.1', 'itop-tickets/2.7.0']);
+
+		$oModule->UpdateModuleResolutionState(['itop-config-mgmt' => '2.7.1', 'itop-tickets' => '2.7.0'], ['itop-config-mgmt' => true, 'itop-tickets' => true]);
+		$this->assertTrue($oModule->IsResolved());
+		$this->assertEquals([], $oModule->GetUnresolvedDependencyModuleNames());
+	}
+}

tests/php-unit-tests/unitary-tests/setup/ressources/reallife_discovered_modules.json

@@ -0,0 +1,267 @@
+{
+    "authent-cas\/3.2.1": {
+        "label": "CAS SSO",
+        "dependencies": []
+    },
+    "authent-external\/3.2.1": {
+        "label": "External user authentication",
+        "dependencies": []
+    },
+    "authent-ldap\/3.2.1": {
+        "label": "User authentication based on LDAP",
+        "dependencies": []
+    },
+    "authent-local\/3.2.1": {
+        "label": "User authentication based on the local DB",
+        "dependencies": []
+    },
+    "combodo-backoffice-darkmoon-theme\/3.2.1": {
+        "label": "Backoffice: Darkmoon theme",
+        "dependencies": []
+    },
+    "combodo-backoffice-fullmoon-high-contrast-theme\/3.2.1": {
+        "label": "Backoffice: Fullmoon with high contrast accessibility theme",
+        "dependencies": []
+    },
+    "combodo-backoffice-fullmoon-protanopia-deuteranopia-theme\/3.2.1": {
+        "label": "Backoffice: Fullmoon with protonopia & deuteranopia accessibility theme",
+        "dependencies": []
+    },
+    "combodo-backoffice-fullmoon-tritanopia-theme\/3.2.1": {
+        "label": "Backoffice: Fullmoon with tritanopia accessibility theme",
+        "dependencies": []
+    },
+    "combodo-db-tools\/3.2.1": {
+        "label": "Database maintenance tools",
+        "dependencies": [
+            "itop-structure\/3.0.0"
+        ]
+    },
+    "itop-attachments\/3.2.1": {
+        "label": "Tickets Attachments",
+        "dependencies": []
+    },
+    "itop-backup\/3.2.1": {
+        "label": "Backup utilities",
+        "dependencies": []
+    },
+    "itop-bridge-cmdb-services\/3.2.1": {
+        "label": "Bridge for CMDB and Services",
+        "dependencies": [
+            "itop-config-mgmt\/2.7.1",
+            "itop-service-mgmt\/2.7.1 || itop-service-mgmt-provider\/2.7.1"
+        ]
+    },
+    "itop-bridge-cmdb-ticket\/3.2.1": {
+        "label": "Bridge for CMDB and Ticket",
+        "dependencies": [
+            "itop-config-mgmt\/2.7.1",
+            "itop-tickets\/2.7.0"
+        ]
+    },
+    "itop-bridge-datacenter-mgmt-services\/3.2.1": {
+        "label": "Bridge for CMDB Virtualization objects and Services",
+        "dependencies": [
+            "itop-config-mgmt\/2.7.1",
+            "itop-service-mgmt\/2.7.1 || itop-service-mgmt-provider\/2.7.1",
+            "itop-datacenter-mgmt\/3.1.0"
+        ]
+    },
+    "itop-bridge-endusers-devices-services\/3.2.1": {
+        "label": "Bridge for CMDB endusers objects and Services",
+        "dependencies": [
+            "itop-config-mgmt\/2.7.1",
+            "itop-service-mgmt\/2.7.1 || itop-service-mgmt-provider\/2.7.1",
+            "itop-endusers-devices\/3.1.0"
+        ]
+    },
+    "itop-bridge-storage-mgmt-services\/3.2.1": {
+        "label": "Bridge for CMDB Virtualization objects and Services",
+        "dependencies": [
+            "itop-config-mgmt\/2.7.1",
+            "itop-service-mgmt\/2.7.1 || itop-service-mgmt-provider\/2.7.1",
+            "itop-storage-mgmt\/3.1.0"
+        ]
+    },
+    "itop-bridge-virtualization-mgmt-services\/3.2.1": {
+        "label": "Bridge for CMDB Virtualization objects and Services",
+        "dependencies": [
+            "itop-config-mgmt\/2.7.1",
+            "itop-service-mgmt\/2.7.1 || itop-service-mgmt-provider\/2.7.1",
+            "itop-virtualization-mgmt\/3.1.0"
+        ]
+    },
+    "itop-bridge-virtualization-storage\/3.2.1": {
+        "label": "Links between virtualization and storage",
+        "dependencies": [
+            "itop-storage-mgmt\/2.2.0",
+            "itop-virtualization-mgmt\/2.2.0"
+        ]
+    },
+    "itop-change-mgmt-itil\/3.2.1": {
+        "label": "Change Management ITIL",
+        "dependencies": [
+            "itop-config-mgmt\/2.2.0",
+            "itop-tickets\/2.0.0"
+        ]
+    },
+    "itop-change-mgmt\/3.2.1": {
+        "label": "Change Management",
+        "dependencies": [
+            "itop-config-mgmt\/2.2.0",
+            "itop-tickets\/2.0.0"
+        ]
+    },
+    "itop-config-mgmt\/3.2.1": {
+        "label": "Configuration Management (CMDB)",
+        "dependencies": [
+            "itop-structure\/2.7.1"
+        ]
+    },
+    "itop-config\/3.2.1": {
+        "label": "Configuration editor",
+        "dependencies": []
+    },
+    "itop-core-update\/3.2.1": {
+        "label": "iTop Core Update",
+        "dependencies": [
+            "itop-files-information\/2.7.0",
+            "combodo-db-tools\/2.7.0"
+        ]
+    },
+    "itop-datacenter-mgmt\/3.2.1": {
+        "label": "Datacenter Management",
+        "dependencies": [
+            "itop-config-mgmt\/2.2.0"
+        ]
+    },
+    "itop-endusers-devices\/3.2.1": {
+        "label": "End-user Devices Management",
+        "dependencies": [
+            "itop-config-mgmt\/2.2.0"
+        ]
+    },
+    "itop-faq-light\/3.2.1": {
+        "label": "Frequently Asked Questions Database",
+        "dependencies": [
+            "itop-structure\/3.0.0 || itop-portal\/3.0.0"
+        ]
+    },
+    "itop-files-information\/3.2.1": {
+        "label": "iTop files information",
+        "dependencies": []
+    },
+    "itop-full-itil\/3.2.1": {
+        "label": "Bridge - Request management ITIL + Incident management ITIL",
+        "dependencies": [
+            "itop-request-mgmt-itil\/2.3.0",
+            "itop-incident-mgmt-itil\/2.3.0"
+        ]
+    },
+    "itop-hub-connector\/3.2.1": {
+        "label": "iTop Hub Connector",
+        "dependencies": [
+            "itop-config-mgmt\/2.4.0"
+        ]
+    },
+    "itop-incident-mgmt-itil\/3.2.1": {
+        "label": "Incident Management ITIL",
+        "dependencies": [
+            "itop-config-mgmt\/2.4.0",
+            "itop-tickets\/2.4.0",
+            "itop-profiles-itil\/2.3.0"
+        ]
+    },
+    "itop-knownerror-mgmt\/3.2.1": {
+        "label": "Known Errors Database",
+        "dependencies": [
+            "itop-config-mgmt\/2.2.0"
+        ]
+    },
+    "itop-oauth-client\/3.2.1": {
+        "label": "OAuth 2.0 client",
+        "dependencies": [
+            "itop-welcome-itil\/3.1.0,"
+        ]
+    },
+    "itop-portal-base\/3.2.1": {
+        "label": "Portal Development Library",
+        "dependencies": []
+    },
+    "itop-portal\/3.2.1": {
+        "label": "Enhanced Customer Portal",
+        "dependencies": [
+            "itop-portal-base\/2.7.0"
+        ]
+    },
+    "itop-problem-mgmt\/3.2.1": {
+        "label": "Problem Management",
+        "dependencies": [
+            "itop-tickets\/2.0.0"
+        ]
+    },
+    "itop-profiles-itil\/3.2.1": {
+        "label": "Create standard ITIL profiles",
+        "dependencies": []
+    },
+    "itop-request-mgmt-itil\/3.2.1": {
+        "label": "User request Management ITIL",
+        "dependencies": [
+            "itop-tickets\/2.4.0"
+        ]
+    },
+    "itop-request-mgmt\/3.2.1": {
+        "label": "Simple Ticket Management",
+        "dependencies": [
+            "itop-tickets\/2.4.0"
+        ]
+    },
+    "itop-service-mgmt-provider\/3.2.1": {
+        "label": "Service Management for Service Providers",
+        "dependencies": [
+            "itop-tickets\/2.0.0"
+        ]
+    },
+    "itop-service-mgmt\/3.2.1": {
+        "label": "Service Management",
+        "dependencies": [
+            "itop-tickets\/2.0.0"
+        ]
+    },
+    "itop-sla-computation\/3.2.1": {
+        "label": "SLA Computation",
+        "dependencies": []
+    },
+    "itop-storage-mgmt\/3.2.1": {
+        "label": "Advanced Storage Management",
+        "dependencies": [
+            "itop-config-mgmt\/2.4.0"
+        ]
+    },
+    "itop-structure\/3.2.1": {
+        "label": "Core iTop Structure",
+        "dependencies": []
+    },
+    "itop-themes-compat\/3.2.1": {
+        "label": "Light grey and Test red themes compatibility",
+        "dependencies": [
+            "itop-structure\/3.1.0"
+        ]
+    },
+    "itop-tickets\/3.2.1": {
+        "label": "Tickets Management",
+        "dependencies": [
+            "itop-structure\/2.7.1"
+        ]
+    },
+    "itop-virtualization-mgmt\/3.2.1": {
+        "label": "Virtualization Management",
+        "dependencies": [
+            "itop-config-mgmt\/2.4.0"
+        ]
+    },
+    "itop-welcome-itil\/3.2.1": {
+        "label": "ITIL skin",
+        "dependencies": []
+    }
+}

tests/php-unit-tests/unitary-tests/setup/ressources/reallife_expected_ordered_modules.json

@@ -0,0 +1 @@
+["authent-cas\/3.2.1","authent-external\/3.2.1","authent-ldap\/3.2.1","authent-local\/3.2.1","combodo-backoffice-darkmoon-theme\/3.2.1","combodo-backoffice-fullmoon-high-contrast-theme\/3.2.1","combodo-backoffice-fullmoon-protanopia-deuteranopia-theme\/3.2.1","combodo-backoffice-fullmoon-tritanopia-theme\/3.2.1","itop-attachments\/3.2.1","itop-backup\/3.2.1","itop-config\/3.2.1","itop-files-information\/3.2.1","itop-portal-base\/3.2.1","itop-portal\/3.2.1","itop-profiles-itil\/3.2.1","itop-sla-computation\/3.2.1","itop-structure\/3.2.1","itop-themes-compat\/3.2.1","itop-tickets\/3.2.1","itop-welcome-itil\/3.2.1","combodo-db-tools\/3.2.1","itop-config-mgmt\/3.2.1","itop-core-update\/3.2.1","itop-datacenter-mgmt\/3.2.1","itop-endusers-devices\/3.2.1","itop-faq-light\/3.2.1","itop-hub-connector\/3.2.1","itop-incident-mgmt-itil\/3.2.1","itop-knownerror-mgmt\/3.2.1","itop-oauth-client\/3.2.1","itop-problem-mgmt\/3.2.1","itop-request-mgmt-itil\/3.2.1","itop-request-mgmt\/3.2.1","itop-service-mgmt-provider\/3.2.1","itop-service-mgmt\/3.2.1","itop-storage-mgmt\/3.2.1","itop-virtualization-mgmt\/3.2.1","itop-bridge-cmdb-services\/3.2.1","itop-bridge-cmdb-ticket\/3.2.1","itop-bridge-datacenter-mgmt-services\/3.2.1","itop-bridge-endusers-devices-services\/3.2.1","itop-bridge-storage-mgmt-services\/3.2.1","itop-bridge-virtualization-mgmt-services\/3.2.1","itop-bridge-virtualization-storage\/3.2.1","itop-change-mgmt-itil\/3.2.1","itop-change-mgmt\/3.2.1","itop-full-itil\/3.2.1"]