N°3060 - Check consistency between the list of modules and installation.xml

2026-02-28 06:34:14 +01:00 · 2020-08-05 15:25:15 +02:00
parent 8707ae6024
commit dc5ee13ed1
1 changed files with 91 additions and 0 deletions
--- a/test/releaseChecklist/iTopModuleXmlInstallationChecklistTest.php
+++ b/test/releaseChecklist/iTopModuleXmlInstallationChecklistTest.php
@@ -0,0 +1,91 @@
+<?php
+
+namespace Combodo\iTop\Test\UnitTest\Setup;
+
+use Combodo\iTop\Test\UnitTest\ItopTestCase;
+use DOMDocument;
+use iTopDesignFormat;
+
+
+/**
+ * Class iTopDesignFormatChecklistTest
+ * Ticket 3061 - Automatically check the installation.xml consistency
+ * @runTestsInSeparateProcesses
+ * @preserveGlobalState disabled
+ * @backupGlobals disabled
+ *
+ * @covers iTopDesignFormat
+ *
+ * @package Combodo\iTop\Test\UnitTest\Setup
+ */
+class TestForITopDesignFormatClass extends ItopTestCase
+{
+	protected function setUp()
+	{
+		parent::setUp();
+	}
+
+	/**
+	 * make sure installation.xml is provided and respects XML format
+	 */
+	public function testInstallationXmlFormat()
+	{
+		$sInstallationXmlPath = APPROOT . 'datamodels/2.x/installation.xml';
+		$this->assertTrue(is_file($sInstallationXmlPath), "$sInstallationXmlPath does not exist");
+
+		$doc = new \DOMDocument();
+		try{
+			$doc->loadxml(file_get_contents($sInstallationXmlPath));
+		}
+		catch(\Exception $e)
+		{
+			$this->assertFalse(true, "$sInstallationXmlPath is not a valid XML content: "  . $e->getMessage());
+		}
+	}
+
+	/**
+	 * make sure installation.xml includes all packaged modules
+	 */
+	public function testAllModuleAreIncludedInInstallationXml()
+	{
+		$sInstallationXmlPath = APPROOT.'datamodels/2.x/installation.xml';
+		$this->assertTrue(is_file($sInstallationXmlPath), "$sInstallationXmlPath does not exist");
+
+		$sInstallationXmlContent = file_get_contents($sInstallationXmlPath);
+		preg_match_all("|<module>(.*)</module>|", $sInstallationXmlContent, $aMatches);
+		$aDeclaredModules =  [] ;
+		if (!empty($aMatches))
+		{
+			foreach ($aMatches[1] as $sModule)
+			{
+				if (!array_key_exists($sModule, $aDeclaredModules))
+				{
+					$aDeclaredModules[$sModule] = $sModule;
+				}
+			}
+		}
+
+		$this->assertArraySubset($this->GetModulesFromDatamodels(APPROOT.'/datamodels'), $aDeclaredModules, false, "$sInstallationXmlPath does not refer to all provided modules. Refered modules:\n " . var_export($aDeclaredModules, true));
+	}
+
+	public function GetModulesFromDatamodels($sFolder)
+	{
+		$aModules = array();
+		if (is_dir($sFolder))
+		{
+			foreach (glob($sFolder."/*") as $sPath)
+			{
+				if (is_dir($sPath))
+				{
+					$aModules = array_merge($aModules, $this->GetModulesFromDatamodels($sPath));
+				}
+				else if (preg_match("/datamodel\..*\.xml/", basename($sPath)))
+				{
+					$sModule = basename(dirname($sPath));
+					$aModules[$sModule] = $sModule;
+				}
+			}
+		}
+		return $aModules;
+	}
+}