Tests: replace config with test config for database tests

Database is prevented from auto-connecting in all cases, as the test tables may not exist yet.

Author: svivian

qa-tests/Q2A_TestsSetup.php

@@ -2,18 +2,71 @@
 
 class Q2A_TestsSetup
 {
-	private $useDatabase = true;
+	private $useDatabase = false;
+	private $qaConfig = __DIR__ . '/../qa-config.php';
+	private $qaConfigBackup = __DIR__ . '/../qa-config.php.bak';
+	private $phpunitConfig = __DIR__ . '/phpunit-qa-config.php';
 
 	public function run()
 	{
+		if (!$this->databaseIsNeeded()) {
+			$this->initialConfiguration();
+			return;
+		}
+
+		// If we're using the database, replace config with a stand-in before loading Q2A
+		$this->useDatabase = true;
+		$this->replaceConfig();
+		// This ensures it's restored after PHPUnit finishes
+		register_shutdown_function(function() {
+			$this->restoreConfig();
+		});
+
 		$this->initialConfiguration();
 		$this->recreateTables();
 		$this->createContent();
 	}
 
+	/**
+	 * Backup config file, overwrite with phpunit stand-in.
+	 */
+	private function replaceConfig()
+	{
+		if (!is_file($this->qaConfig)) {
+			throw new Exception("Q2A config file {$this->qaConfig} could not be found.");
+		}
+		if (!is_file($this->phpunitConfig)) {
+			throw new Exception("PHPUnit stand-in config file {$this->phpunitConfig} could not be found.");
+		}
+
+		if (!copy($this->qaConfig, $this->qaConfigBackup)) {
+			throw new Exception("Could not backup Q2A config file; tests will not be run.");
+		}
+		if (!copy($this->phpunitConfig, $this->qaConfig)) {
+			throw new Exception("Could not replace Q2A config file with PHPUnit stand-in; tests will not be run.");
+		}
+	}
+
+	/**
+	 * Remove phpunit stand-in, restore original config file.
+	 */
+	private function restoreConfig()
+	{
+		if (!is_file($this->qaConfigBackup)) {
+			throw new Exception("Q2A config backup file {$this->qaConfigBackup} could not be found.");
+		}
+
+		if (copy($this->qaConfigBackup, $this->qaConfig)) {
+			unlink($this->qaConfigBackup);
+		}
+	}
+
 	private function initialConfiguration()
 	{
-		$this->disableDatabaseIfNeeded();
+		// Prevent accessing database before we're ready (required in the case of the test database not set up yet)
+		global $qa_options_cache, $qa_autoconnect;
+		$qa_autoconnect = false;
+		$qa_options_cache['enabled_plugins'] = '';
 
 		// currently, all Q2A code depends on qa-base
 		require_once __DIR__ . '/../qa-include/qa-base.php';
@@ -29,23 +82,22 @@ private function initialConfiguration()
 
 	/**
 	 * Detect whether Q2A should access the database while testing or not. This reads the command line
-	 * used to run PHPUnit and, if the database tests were explicitly excluded there, then the database
-	 * access is disabled. These are two example command lines with and without the exclusion:
+	 * used to run PHPUnit, and if the database tests were explicitly excluded there then the test
+	 * database is not generated. These are two example command lines with and without the exclusion:
 	 * `phpunit --bootstrap qa-tests/autoload.php qa-tests`
 	 * `phpunit --bootstrap qa-tests/autoload.php --exclude-group database qa-tests`
 	 */
-	private function disableDatabaseIfNeeded()
+	private function databaseIsNeeded()
 	{
-		global $qa_options_cache, $qa_autoconnect, $argv;
+		global $argv;
 
 		foreach ($argv as $index => $arg) {
 			if ($arg === '--exclude-group' && isset($argv[$index + 1]) && $argv[$index + 1] === 'database') {
-				$qa_autoconnect = false;
-				$qa_options_cache['enabled_plugins'] = '';
-				$this->useDatabase = false;
-				break;
+				return false;
 			}
 		}
+
+		return true;
 	}
 
 	private function recreateTables()