From e107be56e402e86225998ece858d0abb4a9e5870 Mon Sep 17 00:00:00 2001
From: Molkobain <lajarige.guillaume@free.fr>
Date: Fri, 18 Aug 2023 09:51:15 +0200
Subject: [PATCH 1/3] =?UTF-8?q?N=C2=B06097=20-=20Tests:=20Fix=20missing=20?=
 =?UTF-8?q?hook=20entry=20in=20PHPUnit=20XML=20file=20that=20led=20to=20co?=
 =?UTF-8?q?mpiled=20environment=20being=20re-build=20for=20each=20test=20c?=
 =?UTF-8?q?ase?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 tests/php-unit-tests/phpunit.xml.dist               | 4 ++++
 tests/php-unit-tests/postbuild_integration.xml.dist | 4 ++++
 2 files changed, 8 insertions(+)

diff --git a/tests/php-unit-tests/phpunit.xml.dist b/tests/php-unit-tests/phpunit.xml.dist
index f16e89560..e116a1417 100644
--- a/tests/php-unit-tests/phpunit.xml.dist
+++ b/tests/php-unit-tests/phpunit.xml.dist
@@ -19,6 +19,10 @@
         printerClass="Sempro\PHPUnitPrettyPrinter\PrettyPrinter"
 >
 
+  <extensions>
+    <extension class="Combodo\iTop\Test\UnitTest\Hook\TestsRunStartHook" />
+  </extensions>
+
   <php>
     <ini name="error_reporting" value="E_ALL"/>
     <ini name="display_errors" value="On"/>
diff --git a/tests/php-unit-tests/postbuild_integration.xml.dist b/tests/php-unit-tests/postbuild_integration.xml.dist
index 444df800f..a29e2eeec 100644
--- a/tests/php-unit-tests/postbuild_integration.xml.dist
+++ b/tests/php-unit-tests/postbuild_integration.xml.dist
@@ -19,6 +19,10 @@
         printerClass="Sempro\PHPUnitPrettyPrinter\PrettyPrinter"
 >
 
+  <extensions>
+    <extension class="Combodo\iTop\Test\UnitTest\Hook\TestsRunStartHook" />
+  </extensions>
+
     <php>
         <ini name="error_reporting" value="E_ALL"/>
         <ini name="display_errors" value="On"/>

From 1990ccb5d84849d8f1f0eaebe00eea794b88dcfb Mon Sep 17 00:00:00 2001
From: Molkobain <lajarige.guillaume@free.fr>
Date: Fri, 18 Aug 2023 09:52:55 +0200
Subject: [PATCH 2/3] =?UTF-8?q?N=C2=B06436=20-=20Move=20interfaces=20enume?=
 =?UTF-8?q?ration=20from=201=20line=20to=201=20line=20/=20interface=20(and?=
 =?UTF-8?q?=20re-ordered=20them)=20for=20easier=20merges=20in=20newer=20br?=
 =?UTF-8?q?anches?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 core/metamodel.class.php | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/core/metamodel.class.php b/core/metamodel.class.php
index 8f987efd2..3ff134fe6 100644
--- a/core/metamodel.class.php
+++ b/core/metamodel.class.php
@@ -2778,7 +2778,23 @@ abstract class MetaModel
 
 		// Build the list of available extensions
 		//
-		$aInterfaces = array('iApplicationUIExtension', 'iPreferencesExtension', 'iApplicationObjectExtension', 'iLoginFSMExtension', 'iLoginUIExtension', 'iLogoutExtension', 'iQueryModifier', 'iOnClassInitialization', 'iPopupMenuExtension', 'iPageUIExtension', 'iPortalUIExtension', 'ModuleHandlerApiInterface', 'iNewsroomProvider', 'iModuleExtension', 'iKPILoggerExtension');
+		$aInterfaces = [
+			'iLoginFSMExtension',
+			'iLogoutExtension',
+			'iLoginUIExtension',
+			'iPreferencesExtension',
+			'iApplicationUIExtension',
+			'iApplicationObjectExtension',
+			'iPopupMenuExtension',
+			'iPageUIExtension',
+			'iPortalUIExtension',
+			'iQueryModifier',
+			'iOnClassInitialization',
+			'iModuleExtension',
+			'iKPILoggerExtension',
+			'ModuleHandlerApiInterface',
+			'iNewsroomProvider',
+		];
 		foreach($aInterfaces as $sInterface)
 		{
 			self::$m_aExtensionClasses[$sInterface] = array();

From a8c689c6c00621ae82c3f34a886c96ffff3cc344 Mon Sep 17 00:00:00 2001
From: Molkobain <lajarige.guillaume@free.fr>
Date: Fri, 18 Aug 2023 09:55:45 +0200
Subject: [PATCH 3/3] =?UTF-8?q?N=C2=B06436=20-=20Add=20unit=20test=20to=20?=
 =?UTF-8?q?ensure=20that=20we=20don't=20lose=20an=20API=20during=20merge?=
 =?UTF-8?q?=20between=20branches?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../ApplicationExtensionTest.php              | 124 ++++++++++
 ...plication-extension-usages-in-snippets.xml | 233 ++++++++++++++++++
 2 files changed, 357 insertions(+)
 create mode 100644 tests/php-unit-tests/unitary-tests/application/applicationextension/ApplicationExtensionTest.php
 create mode 100644 tests/php-unit-tests/unitary-tests/application/applicationextension/Delta/application-extension-usages-in-snippets.xml

diff --git a/tests/php-unit-tests/unitary-tests/application/applicationextension/ApplicationExtensionTest.php b/tests/php-unit-tests/unitary-tests/application/applicationextension/ApplicationExtensionTest.php
new file mode 100644
index 000000000..997a52258
--- /dev/null
+++ b/tests/php-unit-tests/unitary-tests/application/applicationextension/ApplicationExtensionTest.php
@@ -0,0 +1,124 @@
+<?php
+/*
+ * @copyright   Copyright (C) 2010-2023 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+namespace Combodo\iTop\Test\UnitTest\Application;
+
+use Combodo\iTop\Test\UnitTest\ItopCustomDatamodelTestCase;
+use MetaModel;
+use utils;
+
+/**
+ * @covers \iBackofficeLinkedScriptsExtension
+ */
+class ApplicationExtensionTest extends ItopCustomDatamodelTestCase
+{
+	protected const ENUM_API_CALL_METHOD_ENUMPLUGINS = 'MetaModel::EnumPlugins';
+	protected const ENUM_API_CALL_METHOD_GETCLASSESFORINTERFACE = 'utils::GetClassesForInterface';
+
+	/**
+	 * @inheritDoc
+	 */
+	public function GetDatamodelDeltaAbsPath(): string
+	{
+		return __DIR__ . '/Delta/application-extension-usages-in-snippets.xml';
+	}
+
+	/**
+	 * This test ensures that APIs are discovered / registered / called.
+	 *
+	 * It was introduced after {@since N°6436} when some APIs registration in \MetaModel::InitClasses() were lost during a merge {@link https://github.com/Combodo/iTop/commit/6432678de9f635990e22a6512e5b30713c22204a#diff-c94890a26989b5a5ce638f82e8cc7d4c7aa24e6fbb9c2ca89850e8fa4e0e9adaL3004} preventing them from being called when requested. This was hard to detect as it needed an extension to use the lost API to witness that it was no longer called.
+	 *
+	 * For each new API, a new test case should be added here to ensure that we don't lose it later.
+	 * To do so:
+	 * - Add the API to the provider
+	 * - Add a class extending / implementing the API in ./Delta/application-extension-usages-in-snippets.xml
+	 *
+	 * @param string $sAPIFQCN
+	 * @param string $sCallMethod
+	 *
+	 * @return void
+	 * @dataProvider ExtensionAPIRegisteredAndCalledProvider
+	 */
+	public function testExtensionAPIRegisteredAndCalled(string $sAPIFQCN, string $sCallMethod)
+	{
+		if ($sCallMethod === static::ENUM_API_CALL_METHOD_ENUMPLUGINS) {
+			$iExtendingClassesCount = count(MetaModel::EnumPlugins($sAPIFQCN));
+		} else {
+			$iExtendingClassesCount = count(utils::GetClassesForInterface($sAPIFQCN, '', ['[\\\\/]lib[\\\\/]', '[\\\\/]node_modules[\\\\/]', '[\\\\/]test[\\\\/]', '[\\\\/]tests[\\\\/]']));
+		}
+		$this->assertGreaterThan(0, $iExtendingClassesCount, "Found no class extending the $sAPIFQCN API");
+	}
+
+	public function ExtensionAPIRegisteredAndCalledProvider(): array
+	{
+		// APIs not concerned by this test:
+		// * \iRestServiceProvider as it is discovered by iterating over declared classes directly
+		// * \iLoginUIExtension as it is not iterated directly, only its derived interfaces
+
+		return [
+			\iLoginFSMExtension::class => [
+				\iLoginFSMExtension::class,
+				static::ENUM_API_CALL_METHOD_ENUMPLUGINS,
+			],
+			\iLogoutExtension::class => [
+				\iLogoutExtension::class,
+				static::ENUM_API_CALL_METHOD_ENUMPLUGINS,
+			],
+			\iLoginUIExtension::class => [
+				\iLoginUIExtension::class,
+				static::ENUM_API_CALL_METHOD_ENUMPLUGINS,
+			],
+			\iPreferencesExtension::class => [
+				\iPreferencesExtension::class,
+				static::ENUM_API_CALL_METHOD_ENUMPLUGINS,
+			],
+			\iApplicationUIExtension::class => [
+				\iApplicationUIExtension::class,
+				static::ENUM_API_CALL_METHOD_ENUMPLUGINS,
+			],
+			\iApplicationObjectExtension::class => [
+				\iApplicationObjectExtension::class,
+				static::ENUM_API_CALL_METHOD_ENUMPLUGINS,
+			],
+			\iPopupMenuExtension::class => [
+				\iPopupMenuExtension::class,
+				static::ENUM_API_CALL_METHOD_ENUMPLUGINS,
+			],
+			\iPageUIExtension::class => [
+				\iPageUIExtension::class,
+				static::ENUM_API_CALL_METHOD_ENUMPLUGINS,
+			],
+			\iPortalUIExtension::class => [
+				\iPortalUIExtension::class,
+				static::ENUM_API_CALL_METHOD_ENUMPLUGINS,
+			],
+			\iQueryModifier::class => [
+				\iQueryModifier::class,
+				static::ENUM_API_CALL_METHOD_ENUMPLUGINS,
+			],
+			\iOnClassInitialization::class => [
+				\iOnClassInitialization::class,
+				static::ENUM_API_CALL_METHOD_ENUMPLUGINS,
+			],
+			\iModuleExtension::class => [
+				\iModuleExtension::class,
+				static::ENUM_API_CALL_METHOD_ENUMPLUGINS,
+			],
+			\iKPILoggerExtension::class => [
+				\iKPILoggerExtension::class,
+				static::ENUM_API_CALL_METHOD_ENUMPLUGINS,
+			],
+			\ModuleHandlerApiInterface::class => [
+				\ModuleHandlerApiInterface::class,
+				static::ENUM_API_CALL_METHOD_ENUMPLUGINS,
+			],
+			\iNewsroomProvider::class => [
+				\iNewsroomProvider::class,
+				static::ENUM_API_CALL_METHOD_ENUMPLUGINS,
+			],
+		];
+	}
+}
diff --git a/tests/php-unit-tests/unitary-tests/application/applicationextension/Delta/application-extension-usages-in-snippets.xml b/tests/php-unit-tests/unitary-tests/application/applicationextension/Delta/application-extension-usages-in-snippets.xml
new file mode 100644
index 000000000..e404ac49d
--- /dev/null
+++ b/tests/php-unit-tests/unitary-tests/application/applicationextension/Delta/application-extension-usages-in-snippets.xml
@@ -0,0 +1,233 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<itop_design xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.7">
+  <snippets>
+    <!-- These snippets just implements application/applicationextension.inc.php APIs for the ApplicationExtensionTest unit test -->
+    <snippet id="ExampleFor_iLoginFSMExtension" _delta="define">
+      <placement>core</placement>
+      <rank>0</rank>
+      <content><![CDATA[
+class ExampleFor_iLoginFSMExtension extends \AbstractLoginFSMExtension
+{
+	public function ListSupportedLoginModes()
+	{
+		// Do nothing, we just need the class to exists for the unit test
+	}
+}
+      ]]></content>
+    </snippet>
+    <snippet id="ExampleFor_iLogoutExtension" _delta="define">
+      <placement>core</placement>
+      <rank>0</rank>
+      <content><![CDATA[
+class ExampleFor_iLogoutExtension implements \iLogoutExtension
+{
+	public function LogoutAction()
+	{
+		// Do nothing, we just need the class to exists for the unit test
+	}
+
+	public function ListSupportedLoginModes()
+	{
+		// Do nothing, we just need the class to exists for the unit test
+	}
+}
+      ]]></content>
+    </snippet>
+    <snippet id="ExampleFor_iLoginUIExtension" _delta="define">
+      <placement>core</placement>
+      <rank>0</rank>
+      <content><![CDATA[
+class ExampleFor_iLoginUIExtension implements \iLoginUIExtension
+{
+	public function GetTwigContext()
+	{
+		// Do nothing, we just need the class to exists for the unit test
+	}
+
+	public function ListSupportedLoginModes()
+	{
+		// Do nothing, we just need the class to exists for the unit test
+	}
+}
+      ]]></content>
+    </snippet>
+    <snippet id="ExampleFor_iPreferencesExtension" _delta="define">
+      <placement>core</placement>
+      <rank>0</rank>
+      <content><![CDATA[
+class ExampleFor_iPreferencesExtension extends \AbstractPreferencesExtension
+{
+	// Do nothing, we just need the class to exists for the unit test
+}
+      ]]></content>
+    </snippet>
+    <snippet id="ExampleFor_iApplicationUIExtension" _delta="define">
+      <placement>core</placement>
+      <rank>0</rank>
+      <content><![CDATA[
+class ExampleFor_iApplicationUIExtension extends \AbstractApplicationUIExtension
+{
+	// Do nothing, we just need the class to exists for the unit test
+}
+      ]]></content>
+    </snippet>
+    <snippet id="ExampleFor_iApplicationObjectExtension" _delta="define">
+      <placement>core</placement>
+      <rank>0</rank>
+      <content><![CDATA[
+class ExampleFor_iApplicationObjectExtension extends \AbstractApplicationObjectExtension
+{
+	// Do nothing, we just need the class to exists for the unit test
+}
+      ]]></content>
+    </snippet>
+    <snippet id="ExampleFor_iPopupMenuExtension" _delta="define">
+      <placement>core</placement>
+      <rank>0</rank>
+      <content><![CDATA[
+class ExampleFor_iPopupMenuExtension implements \iPopupMenuExtension
+{
+  public static function EnumItems($iMenuId, $param)
+  {
+	  // Do nothing, we just need the class to exists for the unit test
+  }
+}
+      ]]></content>
+    </snippet>
+    <snippet id="ExampleFor_ApplicationPopupMenuItem" _delta="define">
+      <placement>core</placement>
+      <rank>0</rank>
+      <content><![CDATA[
+class ExampleFor_ApplicationPopupMenuItem extends \ApplicationPopupMenuItem
+{
+  public function GetMenuItem()
+  {
+	  // Do nothing, we just need the class to exists for the unit test
+  }
+}
+      ]]></content>
+    </snippet>
+    <snippet id="ExampleFor_iPageUIExtension" _delta="define">
+      <placement>core</placement>
+      <rank>0</rank>
+      <content><![CDATA[
+class ExampleFor_iPageUIExtension extends \AbstractPageUIExtension
+{
+	// Do nothing, we just need the class to exists for the unit test
+}
+      ]]></content>
+    </snippet>
+    <snippet id="ExampleFor_iPortalUIExtension" _delta="define">
+      <placement>core</placement>
+      <rank>0</rank>
+      <content><![CDATA[
+class ExampleFor_iPortalUIExtension extends \AbstractPortalUIExtension
+{
+	// Do nothing, we just need the class to exists for the unit test
+}
+      ]]></content>
+    </snippet>
+    <snippet id="ExampleFor_iQueryModifier" _delta="define">
+      <placement>core</placement>
+      <rank>0</rank>
+      <content><![CDATA[
+class ExampleFor_iQueryModifier implements \iQueryModifier
+{
+	public function __construct()
+	{
+	  // Do nothing, we just need the class to exists for the unit test
+	}
+
+	public function GetFieldExpression(QueryBuilderContext &$oBuild, $sClass, $sAttCode, $sColId, Expression $oFieldSQLExp, SQLQuery &$oSelect)
+	{
+	  // Do nothing, we just need the class to exists for the unit test
+	}
+}
+      ]]></content>
+    </snippet>
+    <snippet id="ExampleFor_iOnClassInitialization" _delta="define">
+      <placement>core</placement>
+      <rank>0</rank>
+      <content><![CDATA[
+class ExampleFor_iOnClassInitialization implements \iOnClassInitialization
+{
+	public function OnAfterClassInitialization($sClass)
+	{
+	  // Do nothing, we just need the class to exists for the unit test
+	}
+}
+      ]]></content>
+    </snippet>
+    <snippet id="ExampleFor_iModuleExtension" _delta="define">
+      <placement>core</placement>
+      <rank>0</rank>
+      <content><![CDATA[
+class ExampleFor_iModuleExtension implements \iModuleExtension
+{
+	public function __construct()
+	{
+	  // Do nothing, we just need the class to exists for the unit test
+	}
+}
+      ]]></content>
+    </snippet>
+    <snippet id="ExampleFor_iKPILoggerExtension" _delta="define">
+      <placement>core</placement>
+      <rank>0</rank>
+      <content><![CDATA[
+class ExampleFor_iKPILoggerExtension implements \iKPILoggerExtension
+{
+	public function InitStats()
+	{
+		// Do nothing, we just need the class to exists for the unit test
+	}
+
+	public function LogOperation($oKpiLogData)
+	{
+	  // Do nothing, we just need the class to exists for the unit test
+	}
+}
+      ]]></content>
+    </snippet>
+    <!-- These snippets just implements core/modulehandler.class.inc.php APIs for the ApplicationExtensionTest unit test -->
+    <snippet id="ExampleFor_ModuleHandlerApiInterface" _delta="define">
+      <placement>core</placement>
+      <rank>0</rank>
+      <content><![CDATA[
+class ExampleFor_ModuleHandlerApiInterface extends \ModuleHandlerAPI
+{
+	// Do nothing, we just need the class to exists for the unit test
+}
+      ]]></content>
+    </snippet>
+    <!-- These snippets just implements application/newsroomprovider.class.inc.php APIs for the ApplicationExtensionTest unit test -->
+    <snippet id="ExampleFor_iNewsroomProvider" _delta="define">
+      <placement>core</placement>
+      <rank>0</rank>
+      <content><![CDATA[
+class ExampleFor_iNewsroomProvider extends \NewsroomProviderBase
+{
+	public function GetLabel()
+	{
+	  // Do nothing, we just need the class to exists for the unit test
+  }
+
+	public function GetFetchURL()
+	{
+	  // Do nothing, we just need the class to exists for the unit test
+  }
+
+	public function GetMarkAllAsReadURL()
+	{
+	  // Do nothing, we just need the class to exists for the unit test
+  }
+
+	public function GetViewAllURL()
+	{
+	  // Do nothing, we just need the class to exists for the unit test
+  }
+}
+      ]]></content>
+    </snippet>
+  </snippets>
+</itop_design>
\ No newline at end of file