From 31e29506fa8f4ab799f64712b5a97d36316d14bc Mon Sep 17 00:00:00 2001
From: Pierre Goiffon <pierre.goiffon@combodo.com>
Date: Tue, 16 Jan 2024 10:18:50 +0100
Subject: [PATCH 1/2] =?UTF-8?q?N=C2=B07143=20DictionariesConsistencyTest::?=
 =?UTF-8?q?testNoDictFileInDatamodelsModuleRootDirectory=20Add=20exclusion?=
 =?UTF-8?q?=20list=20to=20remove=20modules=20that=20must=20be=20compatible?=
 =?UTF-8?q?=20with=20iTop=202.7?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../DictionariesConsistencyTest.php           | 75 ++++++++++++++++++-
 1 file changed, 73 insertions(+), 2 deletions(-)

diff --git a/tests/php-unit-tests/integration-tests/DictionariesConsistencyTest.php b/tests/php-unit-tests/integration-tests/DictionariesConsistencyTest.php
index 41772368c..cf35b88fd 100644
--- a/tests/php-unit-tests/integration-tests/DictionariesConsistencyTest.php
+++ b/tests/php-unit-tests/integration-tests/DictionariesConsistencyTest.php
@@ -189,12 +189,83 @@ class DictionariesConsistencyTest extends ItopTestCase
 		$this->assertTrue(true);
 	}
 
+	/**
+	 * Since 3.0.0 and N°2969 it is possible to have a dictionaries directory in modules. We want to ensure that core modules use this functionality !
+	 *
+	 * @since 2.7.11 3.0.5 3.1.2 3.2.0 N°7143
+	 */
 	public function testNoDictFileInDatamodelsModuleRootDirectory():void {
 		$sAppRoot = static::GetAppRoot();
 		$aDictFilesInDatamodelsModuleRootDir = glob($sAppRoot.'datamodels/2.x/*/*.dict*.php');
-
 		$this->assertNotFalse($aDictFilesInDatamodelsModuleRootDir, 'Searching for files returned an error');
+
+		$aExcludedModulesList = $this->GetLtsCompatibleModulesList();
+		$aDictFilesInDatamodelsModuleRootDir = array_filter(
+			$aDictFilesInDatamodelsModuleRootDir,
+			function($sDictFileFullPath) use ($aExcludedModulesList) {
+				$sModuleFullPath = dirname($sDictFileFullPath);
+				$sModuleDirectory = basename($sModuleFullPath);
+				echo $sModuleDirectory;
+				return !in_array($sModuleDirectory, $aExcludedModulesList);
+			}
+		);
+
+		$sDictFilesInDatamodelsModuleRootDirList = var_export($aDictFilesInDatamodelsModuleRootDir, true);
 		$this->assertCount(0, $aDictFilesInDatamodelsModuleRootDir,
-			"There are some files in datamodels module root dirs ! You must move them to the `dictionaries` module subfolder. \n List of files: ".var_export($aDictFilesInDatamodelsModuleRootDir, true));
+			<<<EOF
+There are some files in datamodels module root dirs ! You must either: 
+- add the module in the GetLtsCompatibleModulesList method (if the module needs to keep compatibility with iTop 2.7)
+- or move the dict files to the `dictionaries` module subfolder (if it can be set to iTop min 3.0.0)
+
+List of directories: 
+$sDictFilesInDatamodelsModuleRootDirList
+EOF
+		);
+	}
+
+	/**
+	 * @return string[] List of modules that we want to ignore in {@link testNoDictFileInDatamodelsModuleRootDirectory}
+	 *            Indeed multiple targets will add modules that must remain compatible with iTop 2.7 LTS, though with dict files in their root dir
+	 *            The dictionaries directory in modules was added in 3.0.0 with N°2969
+	 */
+	private function GetLtsCompatibleModulesList(): array {
+		return [
+			'approval-base',
+			'authent-token',
+			'combodo-approval-extended',
+			'combodo-approval-light',
+			'combodo-autoclose-ticket',
+			'combodo-autodispatch-ticket',
+			'combodo-calendar-view',
+			'combodo-coverage-windows-computation',
+			'combodo-custom-hyperlinks',
+			'combodo-dispatch-incident',
+			'combodo-dispatch-userrequest',
+			'combodo-email-synchro',
+			'combodo-hybridauth',
+			'combodo-impersonate',
+			'combodo-notify-on-expiration',
+			'combodo-oauth-email-synchro',
+			'combodo-password-expiration',
+			'combodo-portal-dynamic-branding-logo',
+			'combodo-saml',
+			'combodo-sla-computation',
+			'combodo-webhook-integration',
+			'combodo-workflow-graphical-view',
+			'customer-survey',
+			'email-reply',
+			'itop-approval-portal',
+			'itop-communications',
+			'itop-fence',
+			'itop-log-mgmt',
+			'itop-object-copier',
+			'itop-request-template',
+			'itop-standard-email-synchro',
+			'itop-system-information',
+			'itsm-designer-connector',
+			'precanned-replies-pro',
+			'precanned-replies',
+			'templates-base',
+		];
 	}
 }

From a5aac0caad4bb1dd6b7b137d888ed5bb1d3301dd Mon Sep 17 00:00:00 2001
From: Pierre Goiffon <pierre.goiffon@combodo.com>
Date: Tue, 16 Jan 2024 10:25:28 +0100
Subject: [PATCH 2/2] =?UTF-8?q?N=C2=B07143=20Woops=20removed=20forgotten?=
 =?UTF-8?q?=20echo?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../integration-tests/DictionariesConsistencyTest.php            | 1 -
 1 file changed, 1 deletion(-)

diff --git a/tests/php-unit-tests/integration-tests/DictionariesConsistencyTest.php b/tests/php-unit-tests/integration-tests/DictionariesConsistencyTest.php
index cf35b88fd..b5aaa35b2 100644
--- a/tests/php-unit-tests/integration-tests/DictionariesConsistencyTest.php
+++ b/tests/php-unit-tests/integration-tests/DictionariesConsistencyTest.php
@@ -205,7 +205,6 @@ class DictionariesConsistencyTest extends ItopTestCase
 			function($sDictFileFullPath) use ($aExcludedModulesList) {
 				$sModuleFullPath = dirname($sDictFileFullPath);
 				$sModuleDirectory = basename($sModuleFullPath);
-				echo $sModuleDirectory;
 				return !in_array($sModuleDirectory, $aExcludedModulesList);
 			}
 		);