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

N°8764 - fix setup wizards transitions

Browse Source
This commit is contained in:
odain
2026-01-23 09:28:54 +01:00
parent 03e59c9749
commit 97828225db
3 changed files with 145 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
setup/wizardsteps.class.inc.php
View File

@@ -1894,7 +1894,6 @@ EOF
$index = $idx ?? $this->GetStepIndex();
if (is_null($this->aSteps)) {
$this->aSteps = [];
$this->oWizard->SetParameter('additional_extensions_modules', json_encode([])); // Default value, no additional extensions
$aOptions = $this->oExtensionsMap->GetAllExtensionsOptionInfo();
@@ -1903,29 +1902,27 @@ EOF
$aParams = new XMLParameters($this->GetSourceFilePath());
$this->aSteps = $aParams->Get('steps', []);
// Additional step for the "extensions"
$aStepDefinition = [
'title' => 'Extensions',
'description' => '<h2>Select additional extensions to install. You can launch the installation again to install new extensions or remove installed ones.</h2>',
'banner' => '/images/icons/icons8-puzzle.svg',
'options' => $aOptions,
];
// Display this step of the wizard only if there is something to display
if (count($aOptions) > 0) {
$this->aSteps[] = [
'title' => 'Extensions',
'description' => '<h2>Select additional extensions to install. You can launch the installation again to install new extensions or remove installed ones.</h2>',
'banner' => '/images/icons/icons8-puzzle.svg',
'options' => $aOptions,
];
$this->oWizard->SetParameter('additional_extensions_modules', json_encode($aOptions));
}
} else {
// No wizard configuration provided, build a standard one with just one big list. All items are mandatory, only works when there are no conflicted modules.
$aStepDefinition = [
$this->aSteps = [
[
'title' => 'Modules Selection',
'description' => '<h2>Select the modules to install. You can launch the installation again to install new modules, but you cannot remove already installed modules.</h2>',
'banner' => '/images/icons/icons8-apps-tab.svg',
'options' => $aOptions,
],
];
}
$this->aSteps[] = $aStepDefinition;
}
return $this->aSteps[$index] ?? null;

3
tests/php-unit-tests/unitary-tests/setup/WizStepModulesChoiceFake.php
View File

@@ -4,7 +4,8 @@ class WizStepModulesChoiceFake extends WizStepModulesChoice
{
public function __construct(WizardController $oWizard, $sCurrentState)
{
$this->oWizard = $oWizard;
$this->sCurrentState = $sCurrentState;
}
public function setExtensionMap(iTopExtensionsMap $oMap)

136
tests/php-unit-tests/unitary-tests/setup/WizStepModulesChoiceTest.php
View File

@@ -3,13 +3,16 @@
namespace Combodo\iTop\Test\UnitTest\Integration;
use Combodo\iTop\Test\UnitTest\ItopTestCase;
use ItopExtensionsMap;
use iTopExtensionsMap;
use iTopExtensionsMapFake;
use ModuleDiscovery;
use WizardController;
use WizStepModulesChoiceFake;
use XMLParameters;
class WizStepModulesChoiceTest extends ItopTestCase
{
private WizStepModulesChoiceFake $oStep;
protected function setUp(): void
{
parent::setUp();
@@ -17,7 +20,7 @@ class WizStepModulesChoiceTest extends ItopTestCase
require_once __DIR__.'/iTopExtensionsMapFake.php';
require_once __DIR__.'/WizStepModulesChoiceFake.php';
$this->oStep = new \WizStepModulesChoiceFake(new WizardController('', ''), '');
$this->oStep = new WizStepModulesChoiceFake(new WizardController('', ''), '');
ModuleDiscovery::ResetCache();
}
@@ -350,4 +353,133 @@ class WizStepModulesChoiceTest extends ItopTestCase
$this->assertEquals($aExpectedRemovedList, $aRemovedList);
}
public function testGetStepInfo_PackageWithoutInstallationXML()
{
$aExtensionsOnDiskOrDb = [
'itop-ext-added1' => [
'installed' => false,
],
'itop-ext-added2' => [
'installed' => false,
],
];
$oWizStepModulesChoice = $this->GivenWizStepModulesChoice($aExtensionsOnDiskOrDb);
$expected = [
'title' => 'Modules Selection',
'description' => '<h2>Select the modules to install. You can launch the installation again to install new modules, but you cannot remove already installed modules.</h2>',
'banner' => '/images/icons/icons8-apps-tab.svg',
'options' => $aExtensionsOnDiskOrDb,
];
$this->CallAndCheckTwice($oWizStepModulesChoice, [], $expected);
$this->CallAndCheckTwice($oWizStepModulesChoice, [1], null);
}
public static function PackageWithInstallationXMLProvider()
{
require_once __DIR__.'/../../../../approot.inc.php';
require_once APPROOT.'setup/parameters.class.inc.php';
$aExtensionsOnDiskOrDb = [
'itop-ext-added1' => [
'installed' => false,
],
'itop-ext-added2' => [
'installed' => false,
],
];
$aUsecases = [];
$expected = self::GetStep(0);
$aUsecases["[no step] with extensions"] = [
'aExtensionsOnDiskOrDb' => $aExtensionsOnDiskOrDb,
'aArgs' => [],
'expected' => $expected,
];
for ($i = 0; $i < 5; $i++) {
$expected = self::GetStep($i);
$aUsecases["[step $i] with extensions"] = [
'aExtensionsOnDiskOrDb' => $aExtensionsOnDiskOrDb,
'aArgs' => [$i],
'expected' => $expected,
];
}
$expected = [
'title' => 'Extensions',
'description' => '<h2>Select additional extensions to install. You can launch the installation again to install new extensions or remove installed ones.</h2>',
'banner' => '/images/icons/icons8-puzzle.svg',
'options' => $aExtensionsOnDiskOrDb,
];
$aUsecases["[step 5] with extensions => EXTENSION STEP"] = [
'aExtensionsOnDiskOrDb' => $aExtensionsOnDiskOrDb,
'aArgs' => [5],
'expected' => $expected,
];
$aUsecases["[step 6] with extensions => NO STEP ANYMORE"] = [
'aExtensionsOnDiskOrDb' => $aExtensionsOnDiskOrDb,
'aArgs' => [6],
'expected' => null,
];
$aUsecases["[step 5] without extensions => NO STEP ANYMORE"] = [
'aExtensionsOnDiskOrDb' => [],
'aArgs' => [5],
'expected' => null,
];
return $aUsecases;
}
/**
* @dataProvider PackageWithInstallationXMLProvider
*/
public function testGetStepInfo_PackageWithInstallationXML($aExtensionsOnDiskOrDb, $aArgs, $expected)
{
$oWizStepModulesChoice = $this->GivenWizStepModulesChoice($aExtensionsOnDiskOrDb, true);
$this->CallAndCheckTwice($oWizStepModulesChoice, $aArgs, $expected);
}
private function GivenWizStepModulesChoice(array $aExtensionsOnDiskOrDb, $bInstallationXmlProvided = false): WizStepModulesChoiceFake
{
$oExtensionsMap = $this->createMock(iTopExtensionsMap::class);
$oExtensionsMap->expects($this->once())
->method('GetAllExtensionsOptionInfo')
->willReturn($aExtensionsOnDiskOrDb);
$oWizard = new WizardController('', '');
if ($bInstallationXmlProvided) {
//needed to find installation.xml
$oWizard->SetParameter('source_dir', __DIR__.'/ressources');
}
$oWizStepModulesChoice = new WizStepModulesChoiceFake($oWizard, '');
$oWizStepModulesChoice->setExtensionMap($oExtensionsMap);
return $oWizStepModulesChoice;
}
private function CallAndCheckTwice($oStep, $aArgs, $expected)
{
$aRes = $this->InvokeNonPublicMethod(WizStepModulesChoiceFake::class, 'GetStepInfo', $oStep, $aArgs);
$this->assertEquals($expected, $aRes, "step:".var_export($aArgs, true));
$aRes = $this->InvokeNonPublicMethod(WizStepModulesChoiceFake::class, 'GetStepInfo', $oStep, $aArgs);
$this->assertEquals($expected, $aRes, "(2nd call) step:".var_export($aArgs, true));
}
private static function GetStep($index)
{
$aParams = new XMLParameters(__DIR__.'/ressources/installation.xml');
$aSteps = $aParams->Get('steps', []);
return $aSteps[$index] ?? null;
}
}