Merge remote-tracking branch 'origin/support/3.0' into support/3.1

# Conflicts: # tests/php-unit-tests/src/BaseTestCase/ItopTestCase.php
2026-05-01 06:28:46 +02:00 · 2023-08-17 17:45:40 +02:00
parent f238593966 65bb76b9e3
commit ebd0136773
85 changed files with 1128 additions and 903 deletions
--- a/tests/php-unit-tests/unitary-tests/application/Session/SessionTest.php
+++ b/tests/php-unit-tests/unitary-tests/application/Session/SessionTest.php
@@ -7,8 +7,6 @@ use Combodo\iTop\Test\UnitTest\ItopTestCase;

 /**
 * @runTestsInSeparateProcesses
- * @preserveGlobalState disabled
- * @backupGlobals disabled
 */
 class SessionTest extends ItopTestCase
 {
--- a/tests/php-unit-tests/unitary-tests/application/ThemeHandlerTest.php
+++ b/tests/php-unit-tests/unitary-tests/application/ThemeHandlerTest.php
@@ -7,9 +7,6 @@ use FindStylesheetObject;
 use ThemeHandler;

 /**
- * @runTestsInSeparateProcesses
- * @preserveGlobalState disabled
- * @backupGlobals disabled
 * @covers ThemeHandler
 */
 class ThemeHandlerTest extends ItopTestCase
--- a/tests/php-unit-tests/unitary-tests/application/UI/Base/Layout/NavigationMenuTest.php
+++ b/tests/php-unit-tests/unitary-tests/application/UI/Base/Layout/NavigationMenuTest.php
@@ -9,9 +9,6 @@ use Combodo\iTop\Test\UnitTest\ItopDataTestCase;

 /**
 *
- * @runTestsInSeparateProcesses
- * @preserveGlobalState disabled
- * @backupGlobals disabled
 * Class NavigationMenuTest
 *
 * @package UI\Base\Layout
--- a/tests/php-unit-tests/unitary-tests/application/cmdbAbstractObjectTest.php
+++ b/tests/php-unit-tests/unitary-tests/application/cmdbAbstractObjectTest.php
@@ -4,11 +4,6 @@ use Combodo\iTop\Service\Events\EventData;
 use Combodo\iTop\Service\Events\EventService;
 use Combodo\iTop\Test\UnitTest\ItopDataTestCase;

-/**
- * @runTestsInSeparateProcesses
- * @preserveGlobalState disabled
- * @backupGlobals disabled
- */
 class cmdbAbstractObjectTest extends ItopDataTestCase {
 	const USE_TRANSACTION = true;
 	const CREATE_TEST_ORG = true;
@@ -18,6 +13,8 @@ class cmdbAbstractObjectTest extends ItopDataTestCase {

 	protected function setUp(): void
 	{
+		static::$aEventCalls = [];
+		static::$iEventCalls = 0;
 		parent::setUp();
 	}

@@ -80,6 +77,9 @@ class cmdbAbstractObjectTest extends ItopDataTestCase {
 		self::assertSame($aExpectedLinkStack, $aLinkModificationsStack);
 	}

+	/**
+	 * @runInSeparateProcess
+	 */
 	public function testProcessClassIdDeferredUpdate()
 	{
 		// Create the team
@@ -157,6 +157,7 @@ class cmdbAbstractObjectTest extends ItopDataTestCase {
 	}

 	/**
+	 * @runInSeparateProcess
 	 * Check that EVENT_DB_LINKS_CHANGED events are not sent to the current updated/created object (Team)
 	 * the events are sent to the other side (Person)
 	 *
@@ -188,7 +189,7 @@ class cmdbAbstractObjectTest extends ItopDataTestCase {

 		$this->debug("\n-------------> Test Starts HERE\n");

-		$oEventReceiver = new LinksEventReceiver();
+		$oEventReceiver = new LinksEventReceiver($this);
 		$oEventReceiver->RegisterCRUDListeners();

 		$oTeam = MetaModel::NewObject(Team::class, ['name' => 'TestTeam1', 'persons_list' => $oLinkSet, 'org_id' => $this->getTestOrgId()]);
@@ -200,6 +201,8 @@ class cmdbAbstractObjectTest extends ItopDataTestCase {
 	}

 	/**
+	 * @runInSeparateProcess
+	 *
 	 * Check that EVENT_DB_LINKS_CHANGED events are sent to all the linked objects when creating a new lnk object
 	 *
 	 * @return void
@@ -223,7 +226,7 @@ class cmdbAbstractObjectTest extends ItopDataTestCase {
 		$this->assertIsObject($oTeam);

 		$this->debug("\n-------------> Test Starts HERE\n");
-		$oEventReceiver = new LinksEventReceiver();
+		$oEventReceiver = new LinksEventReceiver($this);
 		$oEventReceiver->RegisterCRUDListeners();

 		// The link creation will signal both the Person an the Team
@@ -235,6 +238,7 @@ class cmdbAbstractObjectTest extends ItopDataTestCase {
 	}

 	/**
+	 * @runInSeparateProcess
 	 * Check that EVENT_DB_LINKS_CHANGED events are sent to all the linked objects when updating an existing lnk object
 	 *
 	 * @return void
@@ -262,7 +266,7 @@ class cmdbAbstractObjectTest extends ItopDataTestCase {
 		$oLink->DBInsert();

 		$this->debug("\n-------------> Test Starts HERE\n");
-		$oEventReceiver = new LinksEventReceiver();
+		$oEventReceiver = new LinksEventReceiver($this);
 		$oEventReceiver->RegisterCRUDListeners();

 		// The link update will signal both the Person, the Team and the ContactType
@@ -277,6 +281,7 @@ class cmdbAbstractObjectTest extends ItopDataTestCase {
 	}

 	/**
+	 * @runInSeparateProcess
 	 * Check that when a link changes from an object to another, then both objects are notified
 	 *
 	 * @return void
@@ -307,7 +312,7 @@ class cmdbAbstractObjectTest extends ItopDataTestCase {
 		$oLink->DBInsert();

 		$this->debug("\n-------------> Test Starts HERE\n");
-		$oEventReceiver = new LinksEventReceiver();
+		$oEventReceiver = new LinksEventReceiver($this);
 		$oEventReceiver->RegisterCRUDListeners();

 		// The link update will signal both the Persons and the Team
@@ -320,6 +325,7 @@ class cmdbAbstractObjectTest extends ItopDataTestCase {
 	}

 	/**
+	 * @runInSeparateProcess
 	 * Check that EVENT_DB_LINKS_CHANGED events are sent to all the linked objects when deleting an existing lnk object
 	 *
 	 * @return void
@@ -347,7 +353,7 @@ class cmdbAbstractObjectTest extends ItopDataTestCase {
 		$oLink->DBInsert();

 		$this->debug("\n-------------> Test Starts HERE\n");
-		$oEventReceiver = new LinksEventReceiver();
+		$oEventReceiver = new LinksEventReceiver($this);
 		$oEventReceiver->RegisterCRUDListeners();

 		// The link delete will signal both the Person an the Team
@@ -383,10 +389,16 @@ class cmdbAbstractObjectTest extends ItopDataTestCase {
 */
 class LinksEventReceiver
 {
+	private $oTestCase;
 	private $aCallbacks = [];

 	public static $bIsObjectInCrudStack;

+	public function __construct(ItopDataTestCase $oTestCase)
+	{
+		$this->oTestCase = $oTestCase;
+	}
+
 	public function AddCallback(string $sEvent, string $sClass, string $sFct, int $iCount = 1): void
 	{
 		$this->aCallbacks[$sEvent][$sClass] = [
@@ -423,53 +435,10 @@ class LinksEventReceiver
 	{
 		$this->Debug('Registering Test event listeners');
 		if (is_null($sEvent)) {
-			EventService::RegisterListener(EVENT_DB_LINKS_CHANGED, [$this, 'OnEvent']);
+			$this->oTestCase->EventService_RegisterListener(EVENT_DB_LINKS_CHANGED, [$this, 'OnEvent']);
 			return;
 		}
-		EventService::RegisterListener($sEvent, [$this, 'OnEvent'], $mEventSource);
-	}
-
-	/**
-	 * @param $oObject
-	 *
-	 * @return void
-	 * @throws \ArchivedObjectException
-	 * @throws \CoreCannotSaveObjectException
-	 * @throws \CoreException
-	 * @throws \CoreUnexpectedValue
-	 * @throws \CoreWarning
-	 * @throws \MySQLException
-	 * @throws \OQLException
-	 */
-	private function AddRoleToLink($oObject): void
-	{
-		$this->Debug(__METHOD__);
-		$oContactType = MetaModel::NewObject(ContactType::class, ['name' => 'test_'.$oObject->GetKey()]);
-		$oContactType->DBInsert();
-		$oObject->Set('role_id', $oContactType->GetKey());
-	}
-
-	private function SetPersonFunction($oObject): void
-	{
-		$this->Debug(__METHOD__);
-		$oObject->Set('function', 'CRUD_function_'.rand());
-	}
-
-	private function SetPersonFirstName($oObject): void
-	{
-		$this->Debug(__METHOD__);
-		$oObject->Set('first_name', 'CRUD_first_name_'.rand());
-	}
-
-	private function CheckCrudStack(DBObject $oObject): void
-	{
-		self::$bIsObjectInCrudStack = DBObject::IsObjectCurrentlyInCrud(get_class($oObject), $oObject->GetKey());
-	}
-
-	private function CheckUpdateInLnk(lnkPersonToTeam $oLnkPersonToTeam)
-	{
-		$iTeamId = $oLnkPersonToTeam->Get('team_id');
-		self::$bIsObjectInCrudStack = DBObject::IsObjectCurrentlyInCrud(Team::class, $iTeamId);
+		$this->oTestCase->EventService_RegisterListener($sEvent, [$this, 'OnEvent'], $mEventSource);
 	}

 	private function Debug($msg)
--- a/tests/php-unit-tests/unitary-tests/application/privUITransactionFileTest.php
+++ b/tests/php-unit-tests/unitary-tests/application/privUITransactionFileTest.php
@@ -25,10 +25,6 @@ use privUITransactionFile;
 use UserRights;

 /**
- * @runTestsInSeparateProcesses
- * @preserveGlobalState disabled
- * @backupGlobals disabled
- *
 * @covers utils
 * @group sampleDataNeeded
 * @group defaultProfiles
@@ -180,7 +176,7 @@ class privUITransactionFileTest extends ItopDataTestCase
 		$this->assertTrue($bResult, 'Token created by support user must be removed in the support user context');

 		// test when no user logged (combodo-unauthenticated-form module for example)
-		UserRights::_ResetSessionCache();
+		UserRights::Logoff();
 		$sTransactionIdUnauthenticatedUser = privUITransactionFile::GetNewTransactionId();
 		$bResult = privUITransactionFile::IsTransactionValid($sTransactionIdUnauthenticatedUser, false);
 		$this->assertTrue($bResult, 'Token created by unauthenticated user must be valid when no user logged');
--- a/tests/php-unit-tests/unitary-tests/application/query/QueryTest.php
+++ b/tests/php-unit-tests/unitary-tests/application/query/QueryTest.php
@@ -33,9 +33,6 @@ use QueryOQL;
 * All objects created in this test will be deleted by the test.
 *
 * @group iTopQuery
- * @runTestsInSeparateProcesses
- * @preserveGlobalState disabled
- * @backupGlobals disabled
 */
 class QueryTest extends ItopDataTestCase
 {
--- a/tests/php-unit-tests/unitary-tests/application/utilsTest.php
+++ b/tests/php-unit-tests/unitary-tests/application/utilsTest.php
@@ -25,6 +25,7 @@ use Combodo\iTop\Test\UnitTest\ItopTestCase;
 use utils;

 /**
+ * @runClassInSeparateProcess
 * @covers utils
 */
 class utilsTest extends ItopTestCase
@@ -68,36 +69,36 @@ class utilsTest extends ItopTestCase

 	public function realPathDataProvider()
 	{
-		parent::setUp(); // if not called, APPROOT won't be defined :(
+		$sAppRoot = static::GetAppRoot();

 		$sSep = DIRECTORY_SEPARATOR;
-		$sItopRootRealPath = realpath(APPROOT).$sSep;
+		$sItopRootRealPath = realpath($sAppRoot).$sSep;
 		$sLicenseFileName = 'license.txt';
-		if (!is_file(APPROOT.$sLicenseFileName))
+		if (!is_file($sAppRoot.$sLicenseFileName))
 		{
 			$sLicenseFileName = 'LICENSE';
 		}

 		return [
-			$sLicenseFileName => [APPROOT.$sLicenseFileName, APPROOT, $sItopRootRealPath.$sLicenseFileName],
-			'unexisting file' => [APPROOT.'license_DOES_NOT_EXIST.txt', APPROOT, false],
-			'/'.$sLicenseFileName => [APPROOT.$sSep.$sLicenseFileName, APPROOT, $sItopRootRealPath.$sLicenseFileName],
-			'%2f'.$sLicenseFileName => [APPROOT.'%2f'. $sLicenseFileName, APPROOT, false],
-			'../'.$sLicenseFileName => [APPROOT.'..'.$sSep.$sLicenseFileName, APPROOT, false],
-			'%2e%2e%2f'.$sLicenseFileName => [APPROOT.'%2e%2e%2f'.$sLicenseFileName, APPROOT, false],
+			$sLicenseFileName => [$sAppRoot.$sLicenseFileName, $sAppRoot, $sItopRootRealPath.$sLicenseFileName],
+			'unexisting file' => [$sAppRoot.'license_DOES_NOT_EXIST.txt', $sAppRoot, false],
+			'/'.$sLicenseFileName => [$sAppRoot.$sSep.$sLicenseFileName, $sAppRoot, $sItopRootRealPath.$sLicenseFileName],
+			'%2f'.$sLicenseFileName => [$sAppRoot.'%2f'. $sLicenseFileName, $sAppRoot, false],
+			'../'.$sLicenseFileName => [$sAppRoot.'..'.$sSep.$sLicenseFileName, $sAppRoot, false],
+			'%2e%2e%2f'.$sLicenseFileName => [$sAppRoot.'%2e%2e%2f'.$sLicenseFileName, $sAppRoot, false],
 			'application/utils.inc.php with basepath=APPROOT' => [
-				APPROOT.'application/utils.inc.php',
-				APPROOT,
+				$sAppRoot.'application/utils.inc.php',
+				$sAppRoot,
 				$sItopRootRealPath.'application'.$sSep.'utils.inc.php',
 			],
 			'application/utils.inc.php with basepath=APPROOT/application' => [
-				APPROOT.'application/utils.inc.php',
-				APPROOT.'application',
+				$sAppRoot.'application/utils.inc.php',
+				$sAppRoot.'application',
 				$sItopRootRealPath.'application'.$sSep.'utils.inc.php',
 			],
 			'basepath containing / and \\' => [
-				APPROOT.'sources/Form/Form.php',
-				APPROOT.'sources/Form\\Form.php',
+				$sAppRoot.'sources/Form/Form.php',
+				$sAppRoot.'sources/Form\\Form.php',
 				$sItopRootRealPath.'sources'.$sSep.'Form'.$sSep.'Form.php',
 			],
 		];
@@ -117,13 +118,14 @@ class utilsTest extends ItopTestCase

 	public function LocalPathProvider()
 	{
+		$sAppRoot = static::GetAppRoot();
 		return array(
 			'index.php' => array(
-				'sAbsolutePath' => APPROOT.'index.php',
+				'sAbsolutePath' => $sAppRoot.'index.php',
 				'expected' => 'index.php',
 			),
 			'non existing' => array(
-				'sAbsolutePath' => APPROOT.'nonexisting/nonexisting',
+				'sAbsolutePath' => $sAppRoot.'nonexisting/nonexisting',
 				'expected' => false,
 			),
 			'outside' => array(
@@ -131,15 +133,15 @@ class utilsTest extends ItopTestCase
 				'expected' => false,
 			),
 			'application/cmdbabstract.class.inc.php' => array(
-				'sAbsolutePath' => APPROOT.'application/cmdbabstract.class.inc.php',
+				'sAbsolutePath' => $sAppRoot.'application/cmdbabstract.class.inc.php',
 				'expected' => 'application/cmdbabstract.class.inc.php',
 			),
 			'dir' => array(
-				'sAbsolutePath' => APPROOT.'application/.',
+				'sAbsolutePath' => $sAppRoot.'application/.',
 				'expected' => 'application',
 			),
 			'root' => array(
-				'sAbsolutePath' => APPROOT.'.',
+				'sAbsolutePath' => $sAppRoot.'.',
 				'expected' => '',
 			),
 		);
@@ -288,7 +290,7 @@ class utilsTest extends ItopTestCase

 	public function GetDefaultUrlAppRootProvider()
 	{
-		$this->setUp();
+		$sAppRoot = static::GetAppRoot();

 		$baseServerVar = [
 			'REMOTE_ADDR' => '127.0.0.1', //is not set, disable IsProxyTrusted
@@ -298,7 +300,7 @@ class utilsTest extends ItopTestCase
 			'HTTP_X_FORWARDED_PORT' => null,
 			'REQUEST_URI' => '/index.php?baz=1',
 			'SCRIPT_NAME' => '/index.php',
-			'SCRIPT_FILENAME' => APPROOT.'index.php',
+			'SCRIPT_FILENAME' => $sAppRoot.'index.php',
 			'QUERY_STRING' => 'baz=1',
 			'HTTP_X_FORWARDED_PROTO' => null,
 			'HTTP_X_FORWARDED_PROTOCOL' => null,
@@ -629,23 +631,21 @@ class utilsTest extends ItopTestCase
 	}

 	/**
-	 * @dataProvider GetMentionedObjectsFromTextProvider
 	 * @covers       utils::GetMentionedObjectsFromText
 	 *
-	 * @param string $sInput
-	 * @param string $sFormat
-	 * @param array $aExceptedMentionedObjects
-	 *
 	 * @throws \Exception
 	 */
-	public function testGetMentionedObjectsFromText(string $sInput, string $sFormat, array $aExceptedMentionedObjects)
+	public function testGetMentionedObjectsFromText()
 	{
-		$aTestedMentionedObjects = utils::GetMentionedObjectsFromText($sInput, $sFormat);
+		// Emulate the "Case provider mechanism" (reason: the data provider requires utils constants not available before the application startup)
+		foreach ($this->GetMentionedObjectsFromTextProvider() as $sCase => list($sInput, $sFormat, $aExceptedMentionedObjects)) {
+			$aTestedMentionedObjects = utils::GetMentionedObjectsFromText($sInput, $sFormat);

-		$sExpectedAsString = print_r($aExceptedMentionedObjects, true);
-		$sTestedAsString = print_r($aTestedMentionedObjects, true);
+			$sExpectedAsString = print_r($aExceptedMentionedObjects, true);
+			$sTestedAsString = print_r($aTestedMentionedObjects, true);

-		$this->assertEquals($sTestedAsString, $sExpectedAsString, "Found mentioned objects don't match. Got: $sTestedAsString, expected $sExpectedAsString");
+			$this->assertEquals($sTestedAsString, $sExpectedAsString, "Case '$sCase': Found mentioned objects don't match. Got: $sTestedAsString, expected $sExpectedAsString");
+		}
 	}

 	/**
@@ -779,17 +779,13 @@ class utilsTest extends ItopTestCase
 	/**
 	 * Test sanitizer.
 	 *
-	 * @param $type string type of sanitizer
-	 * @param $valueToSanitize ? value to sanitize
-	 * @param $expectedResult ? expected result
-	 *
-	 * @return void
-	 *
-	 * @dataProvider sanitizerDataProvider
 	 */
-	public function testSanitizer($type, $valueToSanitize, $expectedResult)
+	public function testSanitizer()
 	{
-		$this->assertEquals($expectedResult, utils::Sanitize($valueToSanitize, null, $type), 'url sanitize failed');
+		// Emulate the "Case provider mechanism" (reason: the data provider requires utils constants not available before the application startup)
+		foreach ($this->sanitizerDataProvider() as $sCase => list($type, $valueToSanitize, $expectedResult)) {
+			$this->assertEquals($expectedResult, utils::Sanitize($valueToSanitize, null, $type), "Case '$sCase': url sanitize failed");
+		}
 	}

 	/**