N°5779 update-xml : check we are indeed targeting all of the design files

2026-02-13 07:24:13 +01:00 · 2022-12-09 18:17:27 +01:00
parent 3270c3f775
commit e4e654100e
1 changed files with 103 additions and 0 deletions
--- a/test/.make/release/DatamodelsXmlFilesTest.php
+++ b/test/.make/release/DatamodelsXmlFilesTest.php
@@ -28,4 +28,107 @@ class DatamodelsXmlFilesTest extends ItopTestCase
 		$this->assertNotNull($sVersionForLatest);
 		$this->assertSame($sPreviousDesignVersion, $sVersionForLatest);
 	}
+
+	public function testAllItopXmlFilesCovered()
+	{
+		$oXmlUpdate = new DatamodelsXmlFiles();
+		$aITopDesignFilesFromScript = $oXmlUpdate->GetFiles();
+		$aITopDesignFilesFromScript = array_map(function ($value) {
+			return str_replace('\\', '/', $value);
+		}, $aITopDesignFilesFromScript);
+
+		$oDirectoryIterator = new RecursiveDirectoryIterator(APPROOT,
+			FilesystemIterator::KEY_AS_PATHNAME
+			| FilesystemIterator::CURRENT_AS_FILEINFO
+			| FilesystemIterator::SKIP_DOTS
+			| FilesystemIterator::UNIX_PATHS
+		);
+		$iterator = new RecursiveIteratorIterator(
+			$oDirectoryIterator,
+			RecursiveIteratorIterator::CHILD_FIRST);
+
+		$aITopDesignFilesFromDisk = [];
+		$aDirectoriesToExclude = $this->GetAllDirectoriesToIgnoreForITopDesignFilesSearch();
+		$aDirectoriesToExclude = array_map(function ($value) {
+			$sRawDir = APPROOT.$value;
+
+			return str_replace('\\', '/', $sRawDir);
+		}, $aDirectoriesToExclude);
+
+		/** @var DirectoryIterator $file */
+		foreach ($iterator as $file) {
+			if ($file->isDir()) {
+				continue;
+			}
+			$sFilePath = str_replace('\\', '/', $file->getPathname());
+			if (substr($sFilePath, -4) !== '.xml') {
+				continue;
+			}
+
+			$bIsPartOfADirToExclude = false;
+			foreach ($aDirectoriesToExclude as $sDirToExclude) {
+				if (strpos($sFilePath, $sDirToExclude) === 0) {
+					$bIsPartOfADirToExclude = true;
+					break;
+				}
+			}
+			if ($bIsPartOfADirToExclude) {
+				continue;
+			}
+
+			if (false === $this->IsITopDesignFile($sFilePath)) {
+				continue;
+			}
+
+			$aITopDesignFilesFromDisk[] = $sFilePath;
+		}
+
+		sort($aITopDesignFilesFromScript);
+		sort($aITopDesignFilesFromDisk);
+		$this->assertEquals($aITopDesignFilesFromDisk, $aITopDesignFilesFromScript, 'The XML files update script is not targeting some iTop design files ! '.DatamodelsXmlFiles::class.' must be updated !');
+	}
+
+	private function GetAllDirectoriesToIgnoreForITopDesignFilesSearch(): array
+	{
+		return [
+			// iTop repo excluded dirs
+			'.doc',
+			'data/', // trailing slash to avoid confusion with datamodels dir
+			'env-',
+			'extensions',
+			'test',
+
+			// clones specificities
+			'toolkit',
+			'toolkit-pro',
+			'.delta',
+			'.hacks',
+		];
+	}
+
+	private function IsITopDesignFile($sFilePath)
+	{
+		$oXmlFile = fopen($sFilePath, 'r');
+		if (false === $oXmlFile) {
+			return false;
+		}
+
+		$sLine1 = fgets($oXmlFile);
+		if (strpos($sLine1, '<?xml version="1.0" encoding="UTF-8"?>') !== 0) {
+			fclose($oXmlFile);
+
+			return false;
+		}
+		$sLine2 = fgets($oXmlFile);
+		$sITopDesignRootNode = '<itop_design ';
+		if (strpos($sLine2, $sITopDesignRootNode) !== 0) {
+			fclose($oXmlFile);
+
+			return false;
+		}
+
+		fclose($oXmlFile);
+
+		return true;
+	}
 }