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

N°9144 - Split setup in 2 different step - refactor RuntimeEnv

Browse Source
This commit is contained in:
Eric Espie
2026-03-31 10:57:47 +02:00
parent dec5da0136
commit fb8b4a07b3
6 changed files with 86 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
datamodels/2.x/itop-core-update/src/Service/RunTimeEnvironmentCoreUpdater.php
View File

@@ -29,28 +29,28 @@ class RunTimeEnvironmentCoreUpdater extends RunTimeEnvironment
{
parent::__construct($sEnvironment, $bAutoCommit);
if ($sEnvironment != $this->sTargetEnv) {
if (is_dir(APPROOT.'/env-'.$this->sTargetEnv)) {
SetupUtils::rrmdir(APPROOT.'/env-'.$this->sTargetEnv);
if ($sEnvironment != $this->sBuildEnv) {
if (is_dir(APPROOT.'/env-'.$this->sBuildEnv)) {
SetupUtils::rrmdir(APPROOT.'/env-'.$this->sBuildEnv);
}
if (is_dir(APPROOT.'/data/'.$this->sTargetEnv.'-modules')) {
SetupUtils::rrmdir(APPROOT.'/data/'.$this->sTargetEnv.'-modules');
if (is_dir(APPROOT.'/data/'.$this->sBuildEnv.'-modules')) {
SetupUtils::rrmdir(APPROOT.'/data/'.$this->sBuildEnv.'-modules');
}
SetupUtils::copydir(APPROOT.'/data/'.$sEnvironment.'-modules', APPROOT.'/data/'.$this->sTargetEnv.'-modules');
SetupUtils::copydir(APPROOT.'/data/'.$sEnvironment.'-modules', APPROOT.'/data/'.$this->sBuildEnv.'-modules');
}
}
/**
* @param $sTargetEnv
* @param $sBuildEnv
*
* @throws \Exception
*/
public function CheckDirectories($sTargetEnv)
public function CheckDirectories($sBuildEnv)
{
$sTargetDir = APPROOT.'env-'.$sTargetEnv;
$sBuildDir = $sTargetDir.'-build';
$sBuildDir = APPROOT.'env-'.$sBuildEnv;
$sBuildDir = $sBuildDir.'-build';
self::CheckDirectory($sTargetDir);
self::CheckDirectory($sBuildDir);
self::CheckDirectory($sBuildDir);
}
@@ -85,10 +85,10 @@ class RunTimeEnvironmentCoreUpdater extends RunTimeEnvironment
//
$oConfig = clone($this->GetConfig('production'));
$oConfig->UpdateIncludes('env-'.$this->sTargetEnv);
$oConfig->UpdateIncludes('env-'.$this->sBuildEnv);
if (is_null($sEnvironmentLabel)) {
$sEnvironmentLabel = $this->sTargetEnv;
$sEnvironmentLabel = $this->sBuildEnv;
}
$oConfig->Set('app_env_label', $sEnvironmentLabel, 'application updater');
@@ -104,7 +104,7 @@ class RunTimeEnvironmentCoreUpdater extends RunTimeEnvironment
protected function GetConfig($sEnvironment = null)
{
if (is_null($sEnvironment)) {
$sEnvironment = $this->sTargetEnv;
$sEnvironment = $this->sBuildEnv;
}
$sFile = APPCONF.$sEnvironment.'/'.ITOP_CONFIG_FILE;
if (file_exists($sFile)) {

28
datamodels/2.x/itop-hub-connector/src/setup/hubruntimeenvironment.class.inc.php
View File

@@ -19,29 +19,29 @@ class HubRunTimeEnvironment extends RunTimeEnvironment
{
parent::__construct($sEnvironment, $bAutoCommit);
if ($sEnvironment != $this->sTargetEnv) {
if (is_dir(APPROOT.'/env-'.$this->sTargetEnv)) {
SetupUtils::rrmdir(APPROOT.'/env-'.$this->sTargetEnv);
if ($sEnvironment != $this->sBuildEnv) {
if (is_dir(APPROOT.'/env-'.$this->sBuildEnv)) {
SetupUtils::rrmdir(APPROOT.'/env-'.$this->sBuildEnv);
}
if (is_dir(APPROOT.'/data/'.$this->sTargetEnv.'-modules')) {
SetupUtils::rrmdir(APPROOT.'/data/'.$this->sTargetEnv.'-modules');
if (is_dir(APPROOT.'/data/'.$this->sBuildEnv.'-modules')) {
SetupUtils::rrmdir(APPROOT.'/data/'.$this->sBuildEnv.'-modules');
}
SetupUtils::copydir(APPROOT.'/data/'.$sEnvironment.'-modules', APPROOT.'/data/'.$this->sTargetEnv.'-modules');
SetupUtils::copydir(APPROOT.'/data/'.$sEnvironment.'-modules', APPROOT.'/data/'.$this->sBuildEnv.'-modules');
}
}
/**
* Update the includes for the target environment
* Update the includes for the build environment
*
* @param Config $oConfig
*/
public function UpdateIncludes(Config $oConfig)
{
$oConfig->UpdateIncludes('env-'.$this->sTargetEnv); // TargetEnv != FinalEnv
$oConfig->UpdateIncludes('env-'.$this->sBuildEnv); // BuildEnv != FinalEnv
}
/**
* Move an extension (path to folder of this extension) to the target environment
* Move an extension (path to folder of this extension) to the build environment
*
* @param string $sExtensionDirectory The folder of the extension
*
@@ -49,12 +49,12 @@ class HubRunTimeEnvironment extends RunTimeEnvironment
*/
public function MoveExtension($sExtensionDirectory)
{
if (!is_dir(APPROOT.'/data/'.$this->sTargetEnv.'-modules')) {
if (!mkdir(APPROOT.'/data/'.$this->sTargetEnv.'-modules')) {
throw new Exception("ERROR: failed to create directory:'".(APPROOT.'/data/'.$this->sTargetEnv.'-modules')."'");
if (!is_dir(APPROOT.'/data/'.$this->sBuildEnv.'-modules')) {
if (!mkdir(APPROOT.'/data/'.$this->sBuildEnv.'-modules')) {
throw new Exception("ERROR: failed to create directory:'".(APPROOT.'/data/'.$this->sBuildEnv.'-modules')."'");
}
}
$sDestinationPath = APPROOT.'/data/'.$this->sTargetEnv.'-modules/';
$sDestinationPath = APPROOT.'/data/'.$this->sBuildEnv.'-modules/';
// Make sure that the destination directory of the extension does not already exist
if (is_dir($sDestinationPath.basename($sExtensionDirectory))) {
@@ -67,7 +67,7 @@ class HubRunTimeEnvironment extends RunTimeEnvironment
}
/**
* Move the selected extensions located in the given directory in data/<target-env>-modules
* Move the selected extensions located in the given directory in data/<build-env>-modules
*
* @param string $sDownloadedExtensionsDir The directory to scan
* @param string[] $aSelectedExtensionDirs The list of folders to move

14
setup/feature_removal/DryRemovalRuntimeEnvironment.php
View File

@@ -25,20 +25,20 @@ class DryRemovalRuntimeEnvironment extends RunTimeEnvironment
{
parent::__construct($sSourceEnv, false);
$this->aExtensionsByCode = $aExtensionCodesToRemove;
$this->Prepare($sSourceEnv, $this->sTargetEnv);
$this->Prepare($sSourceEnv, $this->sBuildEnv);
}
/**
* @param string $sSourceEnv
* @param string $sTargetEnv
* @param string $sBuildEnv
* @return void
* @throws \MissingDependencyException
*/
private function Prepare(string $sSourceEnv, string $sTargetEnv)
private function Prepare(string $sSourceEnv, string $sBuildEnv)
{
$this->Cleanup();
SetupUtils::copydir(APPROOT."/data/$sSourceEnv-modules", APPROOT."/data/$sTargetEnv-modules");
SetupUtils::copydir(APPROOT."/conf/$sSourceEnv", APPROOT."/conf/$sTargetEnv");
SetupUtils::copydir(APPROOT."/data/$sSourceEnv-modules", APPROOT."/data/$sBuildEnv-modules");
SetupUtils::copydir(APPROOT."/conf/$sSourceEnv", APPROOT."/conf/$sBuildEnv");
$this->DeclareExtensionAsRemoved($this->aExtensionsByCode);
@@ -57,7 +57,7 @@ class DryRemovalRuntimeEnvironment extends RunTimeEnvironment
private function DeclareExtensionAsRemoved(array $aExtensionCodes): void
{
$oExtensionsMap = new iTopExtensionsMap($this->sTargetEnv);
$oExtensionsMap = new iTopExtensionsMap($this->sBuildEnv);
$oExtensionsMap->DeclareExtensionAsRemoved($aExtensionCodes);
}
@@ -84,7 +84,7 @@ class DryRemovalRuntimeEnvironment extends RunTimeEnvironment
public function Cleanup(): void
{
$sEnv = $this->sTargetEnv;
$sEnv = $this->sBuildEnv;
//keep this folder empty
SetupUtils::tidydir(APPROOT."/env-$sEnv");

96
setup/runtimeenv.class.inc.php
View File

@@ -55,9 +55,9 @@ class RunTimeEnvironment
/**
* Environment into which the build will be performed
* @var string sTargetEnv
* @var string sBuildEnv
*/
protected $sTargetEnv;
protected $sBuildEnv;
/**
* Extensions map of the source environment
@@ -72,12 +72,12 @@ class RunTimeEnvironment
public function InitExtensionMap($aExtraDirs, $oSourceConfig)
{
// Actually read the modules available for the target environment,
// Actually read the modules available for the build environment,
// but get the selection from the source environment and finally
// mark as (automatically) chosen alll the "remote" modules present in the
// target environment (data/<target-env>-modules)
// build environment (data/<build-env>-modules)
// The actual choices will be recorded by RecordInstallation below
$this->oExtensionsMap = new iTopExtensionsMap($this->sTargetEnv, $aExtraDirs);
$this->oExtensionsMap = new iTopExtensionsMap($this->sBuildEnv, $aExtraDirs);
$this->oExtensionsMap->LoadChoicesFromDatabase($oSourceConfig);
}
@@ -85,17 +85,17 @@ class RunTimeEnvironment
* Toolset for building a run-time environment
*
* @param string $sEnvironment (e.g. 'test')
* @param bool $bAutoCommit (make the target environment directly, or build a temporary one)
* @param bool $bAutoCommit (make the final environment directly, or build a temporary one)
*/
public function __construct($sEnvironment = 'production', $bAutoCommit = true)
{
$this->sFinalEnv = $sEnvironment;
if ($bAutoCommit) {
// Build directly onto the requested environment
$this->sTargetEnv = $sEnvironment;
$this->sBuildEnv = $sEnvironment;
} else {
// Build into a temporary target
$this->sTargetEnv = $sEnvironment.'-build';
// Build into a temporary dir
$this->sBuildEnv = $sEnvironment.'-build';
}
$this->oExtensionsMap = null;
}
@@ -106,7 +106,7 @@ class RunTimeEnvironment
*/
public function GetBuildDir()
{
return APPROOT.'env-'.$this->sTargetEnv;
return APPROOT.'env-'.$this->sBuildEnv;
}
/**
@@ -141,20 +141,20 @@ class RunTimeEnvironment
if (!$bUseCache) {
// Reset the cache for the first use !
MetaModel::ResetAllCaches($this->sTargetEnv);
MetaModel::ResetAllCaches($this->sBuildEnv);
}
MetaModel::Startup($oConfig, $bModelOnly, $bUseCache, false /* $bTraceSourceFiles */, $this->sTargetEnv);
MetaModel::Startup($oConfig, $bModelOnly, $bUseCache, false /* $bTraceSourceFiles */, $this->sBuildEnv);
if ($this->oExtensionsMap === null) {
$this->oExtensionsMap = new iTopExtensionsMap($this->sTargetEnv);
$this->oExtensionsMap = new iTopExtensionsMap($this->sBuildEnv);
}
}
/**
* Analyzes the current installation and the possibilities
*
* @param null|Config $oConfig Defines the target environment (DB)
* @param null|Config $oConfig Defines the build environment (DB)
* @param mixed $modulesPath Either a single string or an array of absolute paths
* @param bool $bAbortOnMissingDependency ...
* @param array $aModulesToLoad List of modules to search for, defaults to all if omitted
@@ -196,14 +196,14 @@ class RunTimeEnvironment
public function WriteConfigFileSafe($oConfig)
{
self::MakeDirSafe(APPCONF);
self::MakeDirSafe(APPCONF.$this->sTargetEnv);
self::MakeDirSafe(APPCONF.$this->sBuildEnv);
$sTargetConfigFile = APPCONF.$this->sTargetEnv.'/'.ITOP_CONFIG_FILE;
$sBuildConfigFile = APPCONF.$this->sBuildEnv.'/'.ITOP_CONFIG_FILE;
// Write the config file
@chmod($sTargetConfigFile, 0770); // In case it exists: RWX for owner and group, nothing for others
$oConfig->WriteToFile($sTargetConfigFile);
@chmod($sTargetConfigFile, 0440); // Read-only for owner and group, nothing for others
@chmod($sBuildConfigFile, 0770); // In case it exists: RWX for owner and group, nothing for others
$oConfig->WriteToFile($sBuildConfigFile);
@chmod($sBuildConfigFile, 0440); // Read-only for owner and group, nothing for others
}
/**
@@ -237,7 +237,7 @@ class RunTimeEnvironment
if (is_dir(APPROOT.'extensions')) {
$aDirsToCompile[] = APPROOT.'extensions';
}
$sExtraDir = utils::GetDataPath().$this->sTargetEnv.'-modules/';
$sExtraDir = utils::GetDataPath().$this->sBuildEnv.'-modules/';
if (is_dir($sExtraDir)) {
$aDirsToCompile[] = $sExtraDir;
}
@@ -258,7 +258,7 @@ class RunTimeEnvironment
if (is_dir(APPROOT.'extensions')) {
$aDirsToCompile[] = APPROOT.'extensions';
}
$sExtraDir = utils::GetDataPath().$this->sTargetEnv.'-modules/';
$sExtraDir = utils::GetDataPath().$this->sBuildEnv.'-modules/';
if (is_dir($sExtraDir)) {
$aDirsToCompile[] = $sExtraDir;
}
@@ -271,10 +271,10 @@ class RunTimeEnvironment
$oSourceConfig = new Config(APPCONF.$sSourceEnv.'/'.ITOP_CONFIG_FILE);
$aAvailableModules = $this->AnalyzeInstallation($oSourceConfig, $aDirsToCompile);
// Actually read the modules available for the target environment,
// Actually read the modules available for the build environment,
// but get the selection from the source environment and finally
// mark as (automatically) chosen all the "remote" modules present in the
// target environment (data/<target-env>-modules)
// build environment (data/<build-env>-modules)
// The actual choices will be recorded by RecordInstallation below
$this->InitExtensionMap($aExtraDirs, $oSourceConfig);
$this->GetExtensionMap()->LoadChoicesFromDatabase($oSourceConfig);
@@ -336,7 +336,7 @@ class RunTimeEnvironment
}
} while ($bModuleAdded);
$sDeltaFile = utils::GetDataPath().$this->sTargetEnv.'.delta.xml';
$sDeltaFile = utils::GetDataPath().$this->sBuildEnv.'.delta.xml';
if (file_exists($sDeltaFile)) {
$oDelta = new MFDeltaModule($sDeltaFile);
$aRet[$oDelta->GetName()] = $oDelta;
@@ -347,9 +347,9 @@ class RunTimeEnvironment
/**
* Compile the data model by imitating the given environment
* The list of modules to be installed in the target environment is:
* The list of modules to be installed in the build environment is:
* - the list of modules present in the "source_dir" (defined by the source environment) which are marked as "installed" in the source environment's database
* - plus the list of modules present in the "extra" directory of the target environment: data/<target_environment>-modules/
* - plus the list of modules present in the "extra" directory of the build environment: data/<build_environment>-modules/
*
* @param string $sSourceEnv The name of the source environment to 'imitate'
* @param bool $bUseSymLinks Whether to create symbolic links instead of copies
@@ -371,26 +371,26 @@ class RunTimeEnvironment
if ($oModule instanceof MFDeltaModule) {
// Just before loading the delta, let's save an image of the datamodel
// in case there is no delta the operation will be done after the end of the loop
$oFactory->SaveToFile(utils::GetDataPath().'datamodel-'.$this->sTargetEnv.'.xml');
$oFactory->SaveToFile(utils::GetDataPath().'datamodel-'.$this->sBuildEnv.'.xml');
}
$oFactory->LoadModule($oModule);
}
if (!is_null($oModule) && ($oModule instanceof MFDeltaModule)) {
// A delta was loaded, let's save a second copy of the datamodel
$oFactory->SaveToFile(utils::GetDataPath().'datamodel-'.$this->sTargetEnv.'-with-delta.xml');
$oFactory->SaveToFile(utils::GetDataPath().'datamodel-'.$this->sBuildEnv.'-with-delta.xml');
} else {
// No delta was loaded, let's save the datamodel now
$oFactory->SaveToFile(utils::GetDataPath().'datamodel-'.$this->sTargetEnv.'.xml');
$oFactory->SaveToFile(utils::GetDataPath().'datamodel-'.$this->sBuildEnv.'.xml');
}
$sTargetDir = APPROOT.'env-'.$this->sTargetEnv;
self::MakeDirSafe($sTargetDir);
$bSkipTempDir = ($this->sFinalEnv != $this->sTargetEnv); // No need for a temporary directory if sTargetEnv is already a temporary directory
$sBuildDir = APPROOT.'env-'.$this->sBuildEnv;
self::MakeDirSafe($sBuildDir);
$bSkipTempDir = ($this->sFinalEnv != $this->sBuildEnv); // No need for a temporary directory if sBuildEnv is already a temporary directory
$oMFCompiler = new MFCompiler($oFactory, $this->sFinalEnv);
$oMFCompiler->Compile($sTargetDir, null, $bUseSymLinks, $bSkipTempDir);
$oMFCompiler->Compile($sBuildDir, null, $bUseSymLinks, $bSkipTempDir);
MetaModel::ResetAllCaches($this->sTargetEnv);
MetaModel::ResetAllCaches($this->sBuildEnv);
return array_keys($aModulesToCompile);
}
@@ -752,8 +752,8 @@ class RunTimeEnvironment
public function Commit()
{
if ($this->sFinalEnv != $this->sTargetEnv) {
if (file_exists(utils::GetDataPath().$this->sTargetEnv.'.delta.xml')) {
if ($this->sFinalEnv != $this->sBuildEnv) {
if (file_exists(utils::GetDataPath().$this->sBuildEnv.'.delta.xml')) {
if (file_exists(utils::GetDataPath().$this->sFinalEnv.'.delta.xml')) {
// Make a "previous" file
copy(
@@ -762,31 +762,31 @@ class RunTimeEnvironment
);
}
$this->CommitFile(
utils::GetDataPath().$this->sTargetEnv.'.delta.xml',
utils::GetDataPath().$this->sBuildEnv.'.delta.xml',
utils::GetDataPath().$this->sFinalEnv.'.delta.xml'
);
}
$this->CommitFile(
utils::GetDataPath().'datamodel-'.$this->sTargetEnv.'.xml',
utils::GetDataPath().'datamodel-'.$this->sBuildEnv.'.xml',
utils::GetDataPath().'datamodel-'.$this->sFinalEnv.'.xml'
);
$this->CommitFile(
utils::GetDataPath().'datamodel-'.$this->sTargetEnv.'-with-delta.xml',
utils::GetDataPath().'datamodel-'.$this->sBuildEnv.'-with-delta.xml',
utils::GetDataPath().'datamodel-'.$this->sFinalEnv.'-with-delta.xml',
false
);
$this->CommitDir(
utils::GetDataPath().$this->sTargetEnv.'-modules/',
utils::GetDataPath().$this->sBuildEnv.'-modules/',
utils::GetDataPath().$this->sFinalEnv.'-modules/',
false
);
$this->CommitDir(
utils::GetDataPath().'cache-'.$this->sTargetEnv,
utils::GetDataPath().'cache-'.$this->sBuildEnv,
utils::GetDataPath().'cache-'.$this->sFinalEnv,
false
);
$this->CommitDir(
APPROOT.'env-'.$this->sTargetEnv,
APPROOT.'env-'.$this->sBuildEnv,
APPROOT.'env-'.$this->sFinalEnv,
true,
false
@@ -794,12 +794,12 @@ class RunTimeEnvironment
// Move the config file
//
$sTargetConfig = APPCONF.$this->sTargetEnv.'/config-itop.php';
$sBuildConfig = APPCONF.$this->sBuildEnv.'/config-itop.php';
$sFinalConfig = APPCONF.$this->sFinalEnv.'/config-itop.php';
@chmod($sFinalConfig, 0770); // In case it exists: RWX for owner and group, nothing for others
$this->CommitFile($sTargetConfig, $sFinalConfig);
$this->CommitFile($sBuildConfig, $sFinalConfig);
@chmod($sFinalConfig, 0440); // Read-only for owner and group, nothing for others
@rmdir(dirname($sTargetConfig)); // Cleanup the temporary build dir if empty
@rmdir(dirname($sBuildConfig)); // Cleanup the temporary build dir if empty
MetaModel::ResetAllCaches($this->sFinalEnv);
}
@@ -868,8 +868,8 @@ class RunTimeEnvironment
public function Rollback()
{
if ($this->sFinalEnv != $this->sTargetEnv) {
SetupUtils::tidydir(APPROOT.'env-'.$this->sTargetEnv);
if ($this->sFinalEnv != $this->sBuildEnv) {
SetupUtils::tidydir(APPROOT.'env-'.$this->sBuildEnv);
}
}
@@ -953,7 +953,7 @@ class RunTimeEnvironment
continue;
}
$sRelativePath = 'env-'.$this->sTargetEnv.'/'.basename($aModule['root_dir']);
$sRelativePath = 'env-'.$this->sBuildEnv.'/'.basename($aModule['root_dir']);
// Load data only for selected AND newly installed modules
if (is_null($aSelectedModules) || in_array($sModuleId, $aSelectedModules)) {
if ($aModule['installed_version'] != '') {

2
setup/wizardsteps/WizStepInstall.php
View File

@@ -17,6 +17,7 @@
*
* You should have received a copy of the GNU Affero General Public License
*/
use Combodo\iTop\Application\WebPage\WebPage;
require_once(APPROOT.'setup/sequencers/ApplicationInstallSequencer.php');
@@ -122,6 +123,7 @@ JS);
$sStep = $aParameters['installer_step'];
$sJSONParameters = $aParameters['installer_config'];
$oParameters->LoadFromHash(json_decode($sJSONParameters, true /* bAssoc */));
/** @var StepSequencer $oInstaller */
$oInstaller = new (static::SequencerClass)($oParameters);
$aRes = $oInstaller->ExecuteStep($sStep);
if (($aRes['status'] != $oInstaller::ERROR) && ($aRes['next-step'] != '')) {

2
tests/php-unit-tests/src/Service/UnitTestRunTimeEnvironment.php
View File

@@ -50,7 +50,7 @@ class UnitTestRunTimeEnvironment extends RunTimeEnvironment
public function CompileFrom($sSourceEnv, $bUseSymLinks = null)
{
$sDestModulesDir = APPROOT.'data/'.$this->sTargetEnv.'-modules/';
$sDestModulesDir = APPROOT.'data/'.$this->sBuildEnv.'-modules/';
if (is_dir($sDestModulesDir)) {
SetupUtils::rrmdir($sDestModulesDir);
}