N°6097 - Tests: Refactor base test classes for better extensibility

tests/php-unit-tests/ItopDataTestCase.php

@@ -1,5 +1,5 @@
 <?php
-// Copyright (c) 2010-2017 Combodo SARL
+// Copyright (c) 2010-2021 Combodo SARL
 //
 //   This file is part of iTop.
 //
@@ -42,10 +42,12 @@ use lnkFunctionalCIToTicket;
 use MetaModel;
 use Person;
 use Server;
+use SetupUtils;
 use TagSetFieldData;
 use Ticket;
 use URP_UserProfile;
 use User;
+use utils;
 use VirtualHost;
 use VirtualMachine;
 
@@ -55,6 +57,8 @@ define('TAG_CLASS', 'FAQ');
 define('TAG_ATTCODE', 'domains');
 
 /**
+ * Class ItopDataTestCase
+ *
  * Helper class to extend for tests needing access to iTop's metamodel
  *
  * **⚠ Warning** Each class extending this one needs to add the following annotations :
@@ -66,7 +70,7 @@ define('TAG_ATTCODE', 'domains');
  * @since 2.7.7 3.0.1 3.1.0 N°4624 processIsolation is disabled by default and must be enabled in each test needing it (basically all tests using
  * iTop datamodel)
  */
-class ItopDataTestCase extends ItopTestCase
+abstract class ItopDataTestCase extends ItopTestCase
 {
 	private $iTestOrgId;
 	// For cleanup
@@ -81,12 +85,8 @@ class ItopDataTestCase extends ItopTestCase
 	protected function setUp(): void
 	{
 		parent::setUp();
-		$this->RequireOnceItopFile('application/startup.inc.php');
-		$this->RequireOnceItopFile('application/utils.inc.php');
 
-		$sEnv = 'production';
-		$sConfigFile = APPCONF.$sEnv.'/'.ITOP_CONFIG_FILE;
-		MetaModel::Startup($sConfigFile, false /* $bModelOnly */, true /* $bAllowCache */, false /* $bTraceSourceFiles */, $sEnv);
+		$this->PrepareEnvironment();
 
 		if (static::USE_TRANSACTION)
 		{
@@ -128,6 +128,51 @@ class ItopDataTestCase extends ItopTestCase
 		parent::tearDown();
 	}
 
+	/**
+	 * @inheritDoc
+	 */
+	protected function LoadRequiredFiles(): void
+	{
+		$this->RequireOnceItopFile('application/startup.inc.php');
+		$this->RequireOnceItopFile('application/utils.inc.php');
+	}
+
+	/**
+	 * @return string Environment in the test will run
+	 * @since 2.7.9 3.0.4 3.1.0
+	 */
+	protected function GetTestEnvironment(): string
+	{
+		return 'production';
+	}
+
+	/**
+	 * @return string Absolute path of the configuration file used for the test
+	 * @since 2.7.9 3.0.4 3.1.0
+	 */
+	protected function GetConfigFileAbsPath(): string
+	{
+		return utils::GetConfigFilePath($this->GetTestEnvironment());
+	}
+
+	/**
+	 * Prepare the iTop environment for test to run
+	 *
+	 * @return void
+	 * @throws \CoreException
+	 * @throws \DictExceptionUnknownLanguage
+	 * @throws \MySQLException
+	 * @since 2.7.9 3.0.4 3.1.0
+	 */
+	protected function PrepareEnvironment(): void
+	{
+		$sEnv = $this->GetTestEnvironment();
+		$sConfigFile = $this->GetConfigFileAbsPath();
+
+		// Start MetaModel for the prepared environment
+		MetaModel::Startup($sConfigFile, false /* $bModelOnly */, true /* $bAllowCache */, false /* $bTraceSourceFiles */, $sEnv);
+	}
+
 	/**
 	 * @return mixed
 	 */

tests/php-unit-tests/ItopTestCase.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (C) 2013-2019 Combodo SARL
+ * Copyright (C) 2013-2021 Combodo SARL
  *
  * This file is part of iTop.
  *
@@ -18,12 +18,6 @@
  */
 
 namespace Combodo\iTop\Test\UnitTest;
-/**
- * Created by PhpStorm.
- * User: Eric
- * Date: 20/11/2017
- * Time: 11:21
- */
 
 use CMDBSource;
 use MySQLTransactionNotClosedException;
@@ -32,7 +26,15 @@ use SetupUtils;
 
 define('DEBUG_UNIT_TEST', true);
 
-class ItopTestCase extends TestCase
+/**
+ * Class ItopTestCase
+ *
+ * Helper class to extend for tests that DO NOT need to access the DataModel or the Database
+ *
+ * @author Eric Espie <eric.espie@combodo.com>
+ * @package Combodo\iTop\Test\UnitTest
+ */
+abstract class ItopTestCase extends TestCase
 {
 	const TEST_LOG_DIR = 'test';
 
@@ -49,6 +51,8 @@ class ItopTestCase extends TestCase
 
 			$sAppRootRelPath = $sDepthSeparator.$sAppRootRelPath;
 		}
+
+		$this->LoadRequiredFiles();
 	}
 
 	/**
@@ -65,6 +69,17 @@ class ItopTestCase extends TestCase
 		}
 	}
 
+	/**
+	 * Overload this method to require necessary files through {@see \Combodo\iTop\Test\UnitTest\ItopTestCase::RequireOnceItopFile()} and {@see \Combodo\iTop\Test\UnitTest\ItopTestCase::RequireOnceUnitTestFile()}
+	 *
+	 * @return void
+	 * @since 2.7.9 3.0.4 3.1.0
+	 */
+	protected function LoadRequiredFiles(): void
+	{
+		// Empty until we actually need to require some files in the class
+	}
+
 	/**
 	 * Require once an iTop file (core or extension) from its relative path to the iTop root dir.
 	 * This ensure to always use the right absolute path, especially in {@see \Combodo\iTop\Test\UnitTest\ItopTestCase::RequireOnceUnitTestFile()}