N°6097 - Tests: Enable PHP unit tests on a custom DataModel

tests/php-unit-tests/src/BaseTestCase/ItopCustomDatamodelTestCase.php

@@ -0,0 +1,200 @@
+<?php
+/*
+ * @copyright   Copyright (C) 2010-2023 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+namespace Combodo\iTop\Test\UnitTest;
+
+use CMDBSource;
+use Combodo\iTop\Test\UnitTest\Hook\TestsRunStartHook;
+use Combodo\iTop\Test\UnitTest\Service\UnitTestRunTimeEnvironment;
+use Config;
+use Exception;
+use IssueLog;
+use MetaModel;
+use SetupUtils;
+use utils;
+
+
+/**
+ * Class ItopCustomDatamodelTestCase
+ *
+ * Helper class to extend for tests needing a custom DataModel (eg. classes, attributes, etc conditions not available in the standard DM)
+ * Usage:
+ *   - Create a test case class extending this one
+ *   - Override the {@see ItopCustomDatamodelTestCase::GetDatamodelDeltaAbsPath()} method to define where you XML delta is
+ *   - Implement your test case methods as usual
+ *
+ * @since N°6097 2.7.9 3.0.4 3.1.0
+ */
+abstract class ItopCustomDatamodelTestCase extends ItopDataTestCase
+{
+	/**
+	 * @var bool[]
+	 */
+	protected static $aReadyCustomEnvironments = [];
+
+	/**
+	 * @inheritDoc
+	 * @since N°6097 Workaround to make the "runClassInSeparateProcess" directive work
+	 */
+	public function __construct($name = null, array $data = [], $dataName = '')
+	{
+		parent::__construct($name, $data, $dataName);
+
+		// Ensure that a test class derived from this one runs in a dedicated process as it changes the MetaModel / environment on the fly and
+		// for now we have no way of switching environments properly in memory and it will result in other (regular) test classes to fail as they won't be on the expected environment.
+		//
+		// If we don't do this, we would have to add the `@runTestsInSeparateProcesses` on *each* test classes which we want to avoid for obvious possible mistakes.
+		// Note that the `@runClassInSeparateProcess` don't work in PHPUnit yet.
+		$this->setRunClassInSeparateProcess(true);
+	}
+
+	/**
+	 * @return string Abs path to the XML delta to use for the tests of that class
+	 */
+	abstract public function GetDatamodelDeltaAbsPath(): string;
+
+	/**
+	 * @inheritDoc
+	 */
+	protected function LoadRequiredItopFiles(): void
+	{
+		parent::LoadRequiredItopFiles();
+
+		$this->RequireOnceItopFile('setup/setuputils.class.inc.php');
+		$this->RequireOnceItopFile('setup/runtimeenv.class.inc.php');
+	}
+
+	/**
+	 * @return string Environment used as a base (conf. file, modules, DB, ...) to prepare the test environment
+	 */
+	protected function GetSourceEnvironment(): string
+	{
+		return static::DEFAULT_TEST_ENVIRONMENT;
+	}
+
+	/**
+	 * @inheritDoc
+	 * @warning This should ONLY be overloaded if your test case XML deltas are NOT compatible with the others, as it will create / compile another environment, increasing the global testing time.
+	 */
+	public function GetTestEnvironment(): string
+	{
+		return 'php-unit-tests';
+	}
+
+	/**
+	 * @return string Absolute path to the {@see \Combodo\iTop\Test\UnitTest\ItopCustomDatamodelTestCase::GetTestEnvironment()} folder
+	 */
+	final private function GetTestEnvironmentFolderAbsPath(): string
+	{
+		return APPROOT.'env-'.$this->GetTestEnvironment().'/';
+	}
+
+	/**
+	 * Mark {@see \Combodo\iTop\Test\UnitTest\ItopDataTestCase::GetTestEnvironment()} as ready (compiled)
+	 *
+	 * @return void
+	 */
+	final private function MarkEnvironmentReady(): void
+	{
+		if (false === $this->IsEnvironmentReady()) {
+			touch(static::GetTestEnvironmentFolderAbsPath());
+		}
+	}
+
+	/**
+	 * @return bool True if the {@see \Combodo\iTop\Test\UnitTest\ItopDataTestCase::GetTestEnvironment()} is ready (compiled, but not started)
+	 *
+	 * @details Having the environment ready means that it has been compiled for this global tests run, not that it is a relic from a previous global tests run
+	 */
+	final private function IsEnvironmentReady(): bool
+	{
+		// As these test cases run in separate processes, the best way we found to let know a process if its environment was already prepared for **this run** was to compare the modification times of:
+		// - its own env-<ENV> folder
+		// - a file generated at the beginning of the global test run {@see \Combodo\iTop\Test\UnitTest\Hook\TestsRunStartHook}
+		$sRunStartedFilePath = TestsRunStartHook::GetRunStartedFileAbsPath();
+		$sEnvFolderPath = static::GetTestEnvironmentFolderAbsPath();
+
+		clearstatcache();
+		if (false === file_exists($sRunStartedFilePath) || false === file_exists($sEnvFolderPath)) {
+			return false;
+		}
+
+		$iRunStartedFileModificationTime = filemtime($sRunStartedFilePath);
+		$iEnvFolderModificationTime = filemtime($sEnvFolderPath);
+
+		return $iEnvFolderModificationTime >= $iRunStartedFileModificationTime;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	protected function PrepareEnvironment(): void
+	{
+		$sSourceEnv = $this->GetSourceEnvironment();
+		$sTestEnv = $this->GetTestEnvironment();
+
+		// Check if test env. is already set and only prepare it if it's not up-to-date
+		//
+		// Note: To improve performances, we compile all XML deltas from test cases derived from this class and make a single environment where everything will be ran at once.
+		//       This requires XML deltas to be compatible, but it is a known and accepted trade-off. See PR #457
+		if (false === $this->IsEnvironmentReady()) {
+			//----------------------------------------------------
+			// Clear any previous "$sTestEnv" environment
+			//----------------------------------------------------
+
+			// - Configuration file
+			$sConfFile = utils::GetConfigFilePath($sTestEnv);
+			$sConfFolder = dirname($sConfFile);
+			if (is_file($sConfFile)) {
+				chmod($sConfFile, 0777);
+				SetupUtils::tidydir($sConfFolder);
+			}
+
+			// - Datamodel delta files
+			// - Cache folder
+			// - Compiled folder
+			// We don't need to clean them as they are already by the compilation
+
+			// - Drop database
+			// We don't do that now, it will be done before re-creating the DB, once the metamodel is started
+
+			//----------------------------------------------------
+			// Prepare "$sTestEnv" environment
+			//----------------------------------------------------
+
+			// All the following is greatly inspired by the toolkit's sandbox script
+			// - Prepare config file
+			$oSourceConf = new Config(utils::GetConfigFilePath($sSourceEnv));
+			if ($oSourceConf->Get('source_dir') === '') {
+				throw new Exception('Missing entry source_dir from the config file');
+			}
+
+			$oTestConfig = clone($oSourceConf);
+			$oTestConfig->ChangeModulesPath($sSourceEnv, $sTestEnv);
+			// - Switch DB name to a dedicated one so we don't mess with the original one
+			$sTestEnvSanitizedForDBName = preg_replace('/[^\d\w]/', '', $sTestEnv);
+			$oTestConfig->Set('db_name', $oTestConfig->Get('db_name').'_'.$sTestEnvSanitizedForDBName);
+
+			// - Compile env. based on the existing 'production' env.
+			$oEnvironment = new UnitTestRunTimeEnvironment($sTestEnv);
+			$oEnvironment->WriteConfigFileSafe($oTestConfig);
+			$oEnvironment->CompileFrom($sSourceEnv, false);
+
+			// - Force re-creating a fresh DB
+			CMDBSource::InitFromConfig($oTestConfig);
+			if (CMDBSource::IsDB($oTestConfig->Get('db_name'))) {
+				CMDBSource::DropDB();
+			}
+			CMDBSource::CreateDB($oTestConfig->Get('db_name'));
+			MetaModel::Startup($sConfFile, false /* $bModelOnly */, true /* $bAllowCache */, false /* $bTraceSourceFiles */, $sTestEnv);
+
+			$this->MarkEnvironmentReady();
+			$this->debug('Preparation of custom environment "'.$sTestEnv.'" done.');
+		}
+
+		parent::PrepareEnvironment();
+	}
+}