N°9205 - Show progress messages in setup sequencer (#906)

* N°9205 - Show progress messages in setup sequencer

* N°9205 - Fix unit tests

css/setup.scss

@@ -700,9 +700,12 @@ body {
 }
 
   #progress_content {
-    height: 200px;
+    min-height: 200px;
     overflow: auto;
     text-align: center;
+    *:not(.message) + .message  {
+      margin-top: 1.5rem;
+    }
   }
   #fresh_content{
     border: 0;

setup/sequencers/ApplicationInstallSequencer.php

@@ -51,6 +51,16 @@ class ApplicationInstallSequencer extends StepSequencer
 		'create-config' => 'Creating the configuration File',
 		'commit' => 'Finalize',
 	];
+	protected const SUCCESS_LABELS = [
+		'log-parameters' => 'Parameters logged',
+		'backup' => 'Database backup completed',
+		'migrate-before' => 'Pre-upgrade data migration completed',
+		'db-schema' => 'Database schema updated',
+		'migrate-after' => 'Post-upgrade data migration completed',
+		'after-db-create' => 'Post-creation data loaded',
+		'load-data' => 'Data loaded',
+		'create-config' => 'Configuration file created',
+	];
 
 	/**
 	 * @inherit
@@ -120,7 +130,7 @@ class ApplicationInstallSequencer extends StepSequencer
 
 					$this->oRunTimeEnvironment->DoLoadData($this->GetConfig(), $bSampleData, $aSelectedModules);
 
-					return $this->ComputeNextStep($sStep, 'All data loaded');
+					return $this->ComputeNextStep($sStep);
 
 				case 'create-config':
 					$sDataModelVersion = $this->oParams->Get('datamodel_version', '0.0.0');
@@ -144,11 +154,11 @@ class ApplicationInstallSequencer extends StepSequencer
 					return $this->GetNextStep('', 'Completed', 100);
 
 				default:
-					return $this->GetNextStep('', "Unknown setup step '$sStep'.", 100, '', self::ERROR);
+					return $this->GetNextStep('', "Unknown setup step '$sStep'.", 100, '', '', self::ERROR);
 			}
 		} catch (Exception $e) {
 			SetupLog::Exception("$sStep failed", $e);
-			$aResult = $this->GetNextStep('', '', 100, $e->getMessage(), self::ERROR);
+			$aResult = $this->GetNextStep('', '', 100, $e->getMessage(), '', self::ERROR);
 			$aResult['error_code'] = $e->getCode();
 			return $aResult;
 		} finally {
@@ -229,6 +239,7 @@ class ApplicationInstallSequencer extends StepSequencer
 	{
 		[$sNextStep, $iPercent] = $this->GetStepAfterWithPercent($sCurrentStep);
 		$sLabel = self::LABELS[$sNextStep] ?? '';
-		return $this->GetNextStep($sNextStep, $sLabel, $iPercent, $sMessage);
+		$sCurrentStepSuccessMessage = self::SUCCESS_LABELS[$sCurrentStep] ?? '';
+		return $this->GetNextStep($sNextStep, $sLabel, $iPercent, $sMessage, $sCurrentStepSuccessMessage);
 	}
 }

setup/sequencers/DataAuditSequencer.php

@@ -47,7 +47,7 @@ class DataAuditSequencer extends StepSequencer
 
 				case 'copy':
 					$this->oRunTimeEnvironment->CopySetupFiles();
-					return $this->GetNextStep('compile', 'Compiling the data model', 20, 'Copying...');
+					return $this->GetNextStep('compile', 'Compiling the data model', 20, 'Copying...', 'Data model files copied');
 
 				case 'compile':
 					$aSelectedModules = $this->oParams->Get('selected_modules', []);
@@ -65,25 +65,25 @@ class DataAuditSequencer extends StepSequencer
 					);
 
 					if ($this->IsDataAuditRequired()) {
-						return $this->GetNextStep('setup-audit', 'Checking data consistency with the new data model', 70, $sMessage);
+						return $this->GetNextStep('setup-audit', 'Checking data consistency with the new data model', 70, $sMessage, 'Data model compilation completed');
 					}
-					return $this->GetNextStep('complete', 'Check Completed', 100);
+					return $this->GetNextStep('complete', 'Check Completed', 100, '', 'Data model compilation completed');
 
 				case 'setup-audit':
 					if ($this->IsDataAuditRequired()) {
 						$this->oRunTimeEnvironment->DataToCleanupAudit();
 					}
-					return $this->GetNextStep('complete', 'Check Completed', 100);
+					return $this->GetNextStep('complete', 'Check Completed', 100, '', 'Data consistency check completed');
 
 				case 'complete':
-					return $this->GetNextStep('', 'Completed', 100);
+					return $this->GetNextStep('', 'Completed', 100, '', 'All checks completed');
 
 				default:
-					return $this->GetNextStep('', "Unknown setup step '$sStep'.", 100, '', self::ERROR);
+					return $this->GetNextStep('', "Unknown setup step '$sStep'.", 100, '', '', self::ERROR);
 			}
 		} catch (Exception $e) {
 			SetupLog::Exception("$sStep failed", $e);
-			$aResult = $this->GetNextStep('', '', 100, $e->getMessage(), self::ERROR);
+			$aResult = $this->GetNextStep('', '', 100, $e->getMessage(), '', self::ERROR);
 			$aResult['error_code'] = $e->getCode();
 			return $aResult;
 		} finally {

setup/sequencers/StepSequencer.php

@@ -127,13 +127,14 @@ abstract class StepSequencer
 		return ($iOverallStatus == self::OK);
 	}
 
-	protected function GetNextStep(string $sNextStep, string $sNextStepLabel, int $iPercentComplete, string $sMessage = '', int $iStatus = self::OK): array
+	protected function GetNextStep(string $sNextStep, string $sNextStepLabel, int $iPercentComplete, string $sMessage = '', string $sPrevStepSuccessMessage = '', int $iStatus = self::OK): array
 	{
 		return [
 			'status' => $iStatus,
 			'message' => $sMessage,
 			'next-step' => $sNextStep,
 			'next-step-label' => $sNextStepLabel,
+			'prev-step-success-message' => $sPrevStepSuccessMessage,
 			'percentage-completed' => $iPercentComplete,
 		];
 	}

setup/wizardsteps/WizStepInstall.php

@@ -70,6 +70,20 @@ class WizStepInstall extends AbstractWizStepInstall
 		$oPage->add("<div class=\"message message-error ibo-is-html-content\" style=\"display:none;\" id=\"setup_error\"></div>");
 	}
 
+	protected function AddPrevStepSuccessMessage(WebPage $oPage, string $sPrevStepSuccessMessage): void
+	{
+		if ($sPrevStepSuccessMessage === '') {
+			return;
+		}
+
+		$sPrevStepSuccessMessage = addslashes(utils::EscapeHtml($sPrevStepSuccessMessage));
+		$oPage->add_ready_script(
+			<<<EOF
+	$('<div class="message message-valid ibo-is-html-content">').html('$sPrevStepSuccessMessage').appendTo("#progress_content");
+EOF
+		);
+	}
+
 	public function Display(SetupPage $oPage): void
 	{
 		$aInstallParams = $this->BuildConfig();
@@ -121,6 +135,7 @@ JS);
 	ExecuteStep('{$aRes['next-step']}');
 EOF
 			);
+			static::AddPrevStepSuccessMessage($oPage, $aRes['prev-step-success-message']);
 		} elseif ($aRes['status'] !== StepSequencer::ERROR) {
 			// Installation complete, move to the next step of the wizard
 			$oPage->add_ready_script(
@@ -132,6 +147,7 @@ EOF
 	$("#btn_next").trigger('click');
 EOF
 			);
+			static::AddPrevStepSuccessMessage($oPage, $aRes['prev-step-success-message']);
 		} else {
 			//Error case
 			$sMessage = addslashes(utils::EscapeHtml($aRes['message']));

tests/php-unit-tests/unitary-tests/setup/sequencers/ApplicationInstallerSequencerTest.php

@@ -33,12 +33,14 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 			'next is db-update' => [
 				'next-step' => 'db-schema',
 				'next-step-label' => 'Updating database schema',
+				'prev-step-success-message' => '',
 				'percentage-completed' => 16,
 				'optional_steps' => [],
 			],
 			'next is log-parameters' => [
 				'next-step' => 'log-parameters',
 				'next-step-label' => 'Log parameters',
+				'prev-step-success-message' => '',
 				'percentage-completed' => 11,
 				'optional_steps' => [
 					'log-parameters' => true,
@@ -49,6 +51,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 			'next is backup' => [
 				'next-step' => 'backup',
 				'next-step-label' => 'Performing a backup of the database',
+				'prev-step-success-message' => '',
 				'percentage-completed' => 12,
 				'optional_steps' => [
 					'backup' => true,
@@ -58,6 +61,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 			'next is migrate-before' => [
 				'next-step' => 'migrate-before',
 				'next-step-label' => 'Migrate data before database upgrade',
+				'prev-step-success-message' => '',
 				'percentage-completed' => 14,
 				'optional_steps' => [
 					'migrate-before' => true,
@@ -70,7 +74,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 	/**
 	 * @dataProvider FirstStepProvider
 	 */
-	public function testFirstStep($sNextStep, $sNextLabel, $iPercent, $aOptionalSteps, bool $bCallEnterMaintenanceMode = false, bool $bCallExitMaintenanceMode = false)
+	public function testFirstStep($sNextStep, $sNextLabel, $sPrevStepSuccessMessage, $iPercent, $aOptionalSteps, bool $bCallEnterMaintenanceMode = false, bool $bCallExitMaintenanceMode = false)
 	{
 		$aAdditionalParams = [
 			'optional_steps' => $aOptionalSteps,
@@ -83,6 +87,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => $sNextStep,
 			'next-step-label' => $sNextLabel,
+			'prev-step-success-message' => $sPrevStepSuccessMessage,
 			'percentage-completed' => $iPercent,
 		];
 		$this->assertEquals($aExpected, $aRes);
@@ -98,6 +103,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => 'db-schema',
 			'next-step-label' => 'Updating database schema',
+			'prev-step-success-message' => 'Parameters logged',
 			'percentage-completed' => 16,
 		];
 		$this->assertEquals($aExpected, $aRes);
@@ -109,6 +115,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 			'next is db-update' => [
 				'next-step' => 'db-schema',
 				'next-step-label' => 'Updating database schema',
+				'prev-step-success-message' => 'Database backup completed',
 				'percentage-completed' => 28,
 				'optional_steps' => [
 					'backup' => true,
@@ -117,6 +124,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 			'next is migrate-before' => [
 				'next-step' => 'migrate-before',
 				'next-step-label' => 'Migrate data before database upgrade',
+				'prev-step-success-message' => 'Database backup completed',
 				'percentage-completed' => 25,
 				'optional_steps' => [
 					'backup' => true,
@@ -129,7 +137,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 	/**
 	 * @dataProvider BackupStepProvider
 	 */
-	public function testBackup($sNextStep, $sNextLabel, $iPercent, $aOptionalSteps)
+	public function testBackup($sNextStep, $sNextLabel, $sPrevStepSuccessMessage, $iPercent, $aOptionalSteps)
 	{
 		$aAdditionalParams = [
 			'optional_steps' => $aOptionalSteps,
@@ -149,6 +157,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => $sNextStep,
 			'next-step-label' => $sNextLabel,
+			'prev-step-success-message' => $sPrevStepSuccessMessage,
 			'percentage-completed' => $iPercent,
 		];
 		$this->assertEquals($aExpected, $aRes);
@@ -172,6 +181,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => 'db-schema',
 			'next-step-label' => 'Updating database schema',
+			'prev-step-success-message' => 'Pre-upgrade data migration completed',
 			'percentage-completed' => 28,
 		];
 		$this->assertEquals($aExpected, $aRes);
@@ -183,6 +193,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 			'next is migrate-after' => [
 				'next-step' => 'migrate-after',
 				'next-step-label' => 'Migrate data after database upgrade',
+				'prev-step-success-message' => 'Database schema updated',
 				'percentage-completed' => 28,
 				'optional_steps' => [
 					'migrate-after' => true,
@@ -191,6 +202,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 			'next is after-db-create' => [
 				'next-step' => 'after-db-create',
 				'next-step-label' => 'Load data after database create',
+				'prev-step-success-message' => 'Database schema updated',
 				'percentage-completed' => 33,
 				'optional_steps' => [],
 			],
@@ -200,7 +212,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 	/**
 	 * @dataProvider DbUpdateStepProvider
 	 */
-	public function testDbUpdate($sNextStep, $sNextLabel, $iPercent, $aOptionalSteps)
+	public function testDbUpdate($sNextStep, $sNextLabel, $sPrevStepSuccessMessage, $iPercent, $aOptionalSteps)
 	{
 		$aAdditionalParams = [
 			'selected_modules' => ["a" => "b"],
@@ -219,6 +231,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => $sNextStep,
 			'next-step-label' => $sNextLabel,
+			'prev-step-success-message' => $sPrevStepSuccessMessage,
 			'percentage-completed' => $iPercent,
 		];
 		$this->assertEquals($aExpected, $aRes);
@@ -242,6 +255,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => 'after-db-create',
 			'next-step-label' => 'Load data after database create',
+			'prev-step-success-message' => 'Post-upgrade data migration completed',
 			'percentage-completed' => 42,
 		];
 		$this->assertEquals($aExpected, $aRes);
@@ -269,6 +283,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => 'load-data',
 			'next-step-label' => 'Loading data',
+			'prev-step-success-message' => 'Post-creation data loaded',
 			'percentage-completed' => 50,
 		];
 		$this->assertEquals($aExpected, $aRes);
@@ -287,9 +302,10 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 
 		$aRes = $this->oSequencer->ExecuteStep('load-data');
 		$aExpected = [
-			'message' => 'All data loaded',
+			'message' => '',
 			'next-step' => 'create-config',
 			'next-step-label' => 'Creating the configuration File',
+			'prev-step-success-message' => 'Data loaded',
 			'percentage-completed' => 66,
 			'status' => 1,
 		];
@@ -313,6 +329,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => 'commit',
 			'next-step-label' => 'Finalize',
+			'prev-step-success-message' => 'Configuration file created',
 			'percentage-completed' => 83,
 			'status' => 1,
 		];
@@ -330,6 +347,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => '',
 			'next-step-label' => 'Completed',
+			'prev-step-success-message' => '',
 			'percentage-completed' => 100,
 			'status' => 1,
 		];
@@ -348,6 +366,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 			'message' => 'SHADOK MSG',
 			'next-step' => '',
 			'next-step-label' => '',
+			'prev-step-success-message' => '',
 			'percentage-completed' => 100,
 			'error_code' => 0,
 		];
@@ -363,6 +382,7 @@ class ApplicationInstallerSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => '',
 			'next-step-label' => 'Unknown setup step \'gabuzomeu\'.',
+			'prev-step-success-message' => '',
 			'percentage-completed' => 100,
 		];
 		$this->assertEquals($aExpected, $aRes);

tests/php-unit-tests/unitary-tests/setup/sequencers/DataAuditSequencerTest.php

@@ -36,6 +36,7 @@ class DataAuditSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => 'copy',
 			'next-step-label' => 'Copying data model files',
+			'prev-step-success-message' => '',
 			'percentage-completed' => 5,
 		];
 		$this->assertEquals($aExpected, $aRes);
@@ -54,6 +55,7 @@ class DataAuditSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => '',
 			'next-step-label' => 'Unknown setup step \'gabuzomeu\'.',
+			'prev-step-success-message' => '',
 			'percentage-completed' => 100,
 		];
 		$this->assertEquals($aExpected, $aRes);
@@ -71,6 +73,7 @@ class DataAuditSequencerTest extends ItopTestCase
 			'message' => 'Copying...',
 			'next-step' => 'compile',
 			'next-step-label' => 'Compiling the data model',
+			'prev-step-success-message' => 'Data model files copied',
 			'percentage-completed' => 20,
 		];
 		$this->assertEquals($aExpected, $aRes);
@@ -97,6 +100,7 @@ class DataAuditSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => 'setup-audit',
 			'next-step-label' => 'Checking data consistency with the new data model',
+			'prev-step-success-message' => 'Data model compilation completed',
 			'percentage-completed' => 70,
 		];
 		$this->assertEquals($aExpected, $aRes);
@@ -121,6 +125,7 @@ class DataAuditSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => 'complete',
 			'next-step-label' => 'Check Completed',
+			'prev-step-success-message' => 'Data model compilation completed',
 			'percentage-completed' => 100,
 		];
 		$this->assertEquals($aExpected, $aRes);
@@ -138,6 +143,7 @@ class DataAuditSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => 'complete',
 			'next-step-label' => 'Check Completed',
+			'prev-step-success-message' => 'Data model compilation completed',
 			'percentage-completed' => 100,
 		];
 		$this->assertEquals($aExpected, $aRes);
@@ -164,6 +170,7 @@ class DataAuditSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => 'complete',
 			'next-step-label' => 'Check Completed',
+			'prev-step-success-message' => 'Data model compilation completed',
 			'percentage-completed' => 100,
 		];
 		$this->assertEquals($aExpected, $aRes);
@@ -182,6 +189,7 @@ class DataAuditSequencerTest extends ItopTestCase
 			'message' => 'SHADOK MSG',
 			'next-step' => '',
 			'next-step-label' => '',
+			'prev-step-success-message' => '',
 			'percentage-completed' => 100,
 			'error_code' => 0,
 		];
@@ -209,6 +217,7 @@ class DataAuditSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => 'complete',
 			'next-step-label' => 'Check Completed',
+			'prev-step-success-message' => 'Data consistency check completed',
 			'percentage-completed' => 100,
 		];
 		$this->assertEquals($aExpected, $aRes);
@@ -234,6 +243,7 @@ class DataAuditSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => 'complete',
 			'next-step-label' => 'Check Completed',
+			'prev-step-success-message' => 'Data consistency check completed',
 			'percentage-completed' => 100,
 		];
 		$this->assertEquals($aExpected, $aRes);
@@ -254,6 +264,7 @@ class DataAuditSequencerTest extends ItopTestCase
 			'message' => '',
 			'next-step' => 'complete',
 			'next-step-label' => 'Check Completed',
+			'prev-step-success-message' => 'Data consistency check completed',
 			'percentage-completed' => 100,
 		];
 		$this->assertEquals($aExpected, $aRes);