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

2026-03-01 15:14:11 +01:00 · 2023-03-13 10:34:32 +01:00
parent b86d70623e
commit f002aa04cd
10 changed files with 500 additions and 12 deletions
--- a/tests/php-unit-tests/UnitTestRunTimeEnvironment.php
+++ b/tests/php-unit-tests/UnitTestRunTimeEnvironment.php
@@ -0,0 +1,79 @@
+<?php
+
+/*
+ * @copyright   Copyright (C) 2010-2023 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+use Combodo\iTop\Test\UnitTest\ItopCustomDatamodelTestCase;
+
+
+/**
+ * Class UnitTestRunTimeEnvironment
+ *
+ * Runtime env. dedicated to creating an temp. environment for a group of unit tests with XML deltas.
+ *
+ * @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
+ * @since N°6097 2.7.10 3.0.4 3.1.1
+ */
+class UnitTestRunTimeEnvironment extends RunTimeEnvironment
+{
+	/**
+	 * @inheritDoc
+	 */
+	protected function GetMFModulesToCompile($sSourceEnv, $sSourceDir)
+	{
+		$aRet = parent::GetMFModulesToCompile($sSourceEnv, $sSourceDir);
+
+		/** @var string[] $aDeltaFiles Referential of loaded deltas. Mostly to avoid duplicates. */
+		$aDeltaFiles = [];
+		foreach (get_declared_classes() as $sClass) {
+			// Filter on classes derived from this \Combodo\iTop\Test\UnitTest\ItopCustomDatamodelTestCaseItopCustomDatamodelTestCase
+			if (false === is_a($sClass, ItopCustomDatamodelTestCase::class, true)) {
+				continue;
+			}
+
+			$oReflectionClass = new ReflectionClass($sClass);
+			$oReflectionMethod = $oReflectionClass->getMethod('GetDatamodelDeltaAbsPath');
+
+			// Filter on classes with an actual XML delta (eg. not \Combodo\iTop\Test\UnitTest\ItopCustomDatamodelTestCase and maybe some other deriving from a class with a delta)
+			if ($oReflectionMethod->isAbstract()) {
+				continue;
+			}
+
+			/** @var \Combodo\iTop\Test\UnitTest\ItopCustomDatamodelTestCase $oTestClassInstance */
+			$oTestClassInstance = new $sClass();
+
+			// Check test class is for desired environment
+			if ($oTestClassInstance->GetTestEnvironment() !== $this->sFinalEnv) {
+				continue;
+			}
+
+			// Check XML delta actually exists
+			$sDeltaFile = $oTestClassInstance->GetDatamodelDeltaAbsPath();
+			if (false === is_file($sDeltaFile)) {
+				$this->fail("Could not prepare '$this->sFinalEnv' as the XML delta file '$sDeltaFile' (used in $sClass) does not seem to exist");
+			}
+
+			// Avoid duplicates
+			if (in_array($sDeltaFile, $aDeltaFiles)) {
+				continue;
+			}
+
+			// Prepare fake module name for delta
+			$sDeltaName = preg_replace('/[^\d\w]/', '', $sDeltaFile);
+			$oDelta = new MFDeltaModule($sDeltaFile);
+
+			IssueLog::Debug('XML delta found for unit tests', static::class, [
+				'Unit test class' => $sClass,
+				'Delta file path' => $sDeltaFile,
+			]);
+
+			$aDeltaFiles[] = $sDeltaFile;
+			$aRet[$sDeltaName] = $oDelta;
+		}
+
+		return $aRet;
+	}
+
+}