Add few APIs to ease tests (#788)

* add few APIs to ease tests

* code style

* log testname via IssueLog only through ItopDataTestCase

* code style

* ci: phpunit fix fatal error

tests/php-unit-tests/src/BaseTestCase/ItopDataTestCase.php

@@ -18,6 +18,7 @@ use ArchivedObjectException;
 use CMDBObject;
 use CMDBSource;
 use Combodo\iTop\Service\Events\EventService;
+use Config;
 use Contact;
 use DBObject;
 use DBObjectSet;
@@ -65,6 +66,9 @@ abstract class ItopDataTestCase extends ItopTestCase
 	private $aCreatedObjects = [];
 	private $aEventListeners = [];
 
+	protected ?string $sConfigTmpBackupFile = null;
+	protected ?Config $oiTopConfig = null;
+
 	/**
 	 * @var bool When testing with silo, there are some cache we need to update on tearDown. Doing it all the time will cost too much, so it's opt-in !
 	 * @see tearDown
@@ -119,6 +123,8 @@ abstract class ItopDataTestCase extends ItopTestCase
 	{
 		parent::setUp();
 
+		\IssueLog::Error($this->getName());
+
 		$this->PrepareEnvironment();
 
 		if (static::USE_TRANSACTION) {
@@ -185,6 +191,8 @@ abstract class ItopDataTestCase extends ItopTestCase
 
 		CMDBObject::SetCurrentChange(null);
 
+		$this->RestoreConfiguration();
+
 		parent::tearDown();
 	}
 
@@ -1434,4 +1442,35 @@ abstract class ItopDataTestCase extends ItopTestCase
 		$oObject->Set($sStopwatchAttCode, $oStopwatch);
 	}
 
+	protected function BackupConfiguration(): void
+	{
+		$sConfigPath = MetaModel::GetConfig()->GetLoadedFile();
+		clearstatcache();
+		echo sprintf("rights via ls on %s:\n %s \n", $sConfigPath, exec("ls -al $sConfigPath"));
+		$sFilePermOutput = substr(sprintf('%o', fileperms('/etc/passwd')), -4);
+		echo sprintf("rights via fileperms on %s:\n %s \n", $sConfigPath, $sFilePermOutput);
+
+		$this->sConfigTmpBackupFile = tempnam(sys_get_temp_dir(), "config_");
+		MetaModel::GetConfig()->WriteToFile($this->sConfigTmpBackupFile);
+		$this->oiTopConfig = new Config($sConfigPath);
+	}
+
+	protected function RestoreConfiguration(): void
+	{
+		if (is_null($this->sConfigTmpBackupFile) || ! is_file($this->sConfigTmpBackupFile)) {
+			return;
+		}
+
+		if (is_null($this->oiTopConfig)) {
+			return;
+		}
+
+		//put config back
+		$sConfigPath = $this->oiTopConfig->GetLoadedFile();
+		@chmod($sConfigPath, 0770);
+		$oConfig = new Config($this->sConfigTmpBackupFile);
+		$oConfig->WriteToFile($sConfigPath);
+		@chmod($sConfigPath, 0440);
+		@unlink($this->sConfigTmpBackupFile);
+	}
 }

tests/php-unit-tests/src/BaseTestCase/ItopTestCase.php

@@ -10,9 +10,9 @@ namespace Combodo\iTop\Test\UnitTest;
 use CMDBSource;
 use DeprecatedCallsLog;
 use MySQLTransactionNotClosedException;
-use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use ReflectionMethod;
 use SetupUtils;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Symfony\Component\HttpKernel\KernelInterface;
 
 use const DEBUG_BACKTRACE_IGNORE_ARGS;
@@ -28,6 +28,7 @@ use const DEBUG_BACKTRACE_IGNORE_ARGS;
 abstract class ItopTestCase extends KernelTestCase
 {
 	public const TEST_LOG_DIR = 'test';
+	protected array $aFileToClean = [];
 
 	/**
 	 * @var bool
@@ -36,7 +37,7 @@ abstract class ItopTestCase extends KernelTestCase
 	public const DISABLE_DEPRECATEDCALLSLOG_ERRORHANDLER = true;
 	public static $DEBUG_UNIT_TEST = false;
 	protected static $aBackupStaticProperties = [];
-
+	public ?array $aLastCurlGetInfo = null;
 	/**
 	 * @link https://docs.phpunit.de/en/9.6/annotations.html#preserveglobalstate PHPUnit `preserveGlobalState` annotation documentation
 	 *
@@ -174,6 +175,15 @@ abstract class ItopTestCase extends KernelTestCase
 			}
 			throw new MySQLTransactionNotClosedException('Some DB transactions were opened but not closed ! Fix the code by adding ROLLBACK or COMMIT statements !', []);
 		}
+
+		foreach ($this->aFileToClean as $sPath) {
+			if (is_file($sPath)) {
+				@unlink($sPath);
+				continue;
+			}
+
+			SetupUtils::tidydir($sPath);
+		}
 	}
 
 	/**
@@ -631,4 +641,52 @@ abstract class ItopTestCase extends KernelTestCase
 		fclose($handle);
 		return array_reverse($aLines);
 	}
+
+	/**
+	* @param $sUrl
+	* @param array|null $aPostFields
+	* @param array|null $aCurlOptions
+	* @param $bXDebugEnabled
+	* @return string
+	 */
+	protected function CallItopUrl($sUrl, ?array $aPostFields = [], ?array $aCurlOptions = [], $bXDebugEnabled = false): string
+	{
+		$ch = curl_init();
+		if ($bXDebugEnabled) {
+			curl_setopt($ch, CURLOPT_COOKIE, "XDEBUG_SESSION=phpstorm");
+		}
+
+		curl_setopt($ch, CURLOPT_URL, $sUrl);
+		curl_setopt($ch, CURLOPT_POST, 1);// set post data to true
+		if (!is_array($aPostFields)) {
+			var_dump($aPostFields);
+		}
+		curl_setopt($ch, CURLOPT_POSTFIELDS, $aPostFields);
+		curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+		// Force disable of certificate check as most of dev / test env have a self-signed certificate
+		curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
+		curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
+
+		var_dump($aCurlOptions);
+		curl_setopt_array($ch, $aCurlOptions);
+
+		$sOutput = curl_exec($ch);
+		//\IssueLog::Info("$sUrl error code:", null, ['error' => curl_error($ch)]);
+
+		$info = curl_getinfo($ch);
+		$this->aLastCurlGetInfo = $info;
+		$sErrorMsg = curl_error($ch);
+		$iErrorCode = curl_errno($ch);
+		curl_close($ch);
+
+		\IssueLog::Info(__METHOD__, null, ['url' => $sUrl, 'error' => $sErrorMsg, 'error_code' => $iErrorCode, 'post_fields' => $aPostFields, 'info' => $info]);
+
+		return $sOutput;
+	}
+
+	protected function CallItopUri(string $sUri, ?array $aPostFields = [], ?array $aCurlOptions = [], $bXDebugEnabled = false): string
+	{
+		$sUrl = \MetaModel::GetConfig()->Get('app_root_url')."/$sUri";
+		return $this->CallItopUrl($sUrl, $aPostFields, $aCurlOptions, $bXDebugEnabled);
+	}
 }