friendica/tests/DatabaseTest.php

<?php
/**
 * DatabaseTest class.
 */

namespace Friendica\Test;

use dba;
use Friendica\App;
use Friendica\Core\Config;
use Friendica\Database\DBStructure;
use PHPUnit_Extensions_Database_DB_IDatabaseConnection;
use PHPUnit\DbUnit\DataSet\YamlDataSet;
use PHPUnit\DbUnit\TestCaseTrait;
use PHPUnit\Framework\TestCase;

/**
 * Abstract class used by tests that need a database.
 */
abstract class DatabaseTest extends TestCase
{
	/**
	 * @var \Friendica\App
	 */
	protected $app;

	use TestCaseTrait;

	/**
	 * Creates basic instances for testing with databases
	 *
	 * @throws \Exception
	 */
	protected function setUp()
	{
		global $a;
		parent::setUp();

		// Reusable App object
		$this->app = new App(__DIR__.'/../');
		$a = $this->app;

		// Default config
		Config::set('config', 'hostname', 'localhost');
		Config::set('system', 'throttle_limit_day', 100);
		Config::set('system', 'throttle_limit_week', 100);
		Config::set('system', 'throttle_limit_month', 100);
		Config::set('system', 'theme', 'system_theme');
	}

	/**
	 * Renames an eventually existing .htconfig.php to .htconfig.php.tmp
	 * Creates a new .htconfig.php for bin/worker.php execution
	 */
	public static function setUpBeforeClass()
	{
		parent::setUpBeforeClass();

		$base_config_file_name = 'htconfig.php';
		$config_file_name = '.htconfig.php';

		$base_config_file_path = stream_resolve_include_path($base_config_file_name);
		$config_file_path = dirname($base_config_file_path) . DIRECTORY_SEPARATOR . $config_file_name;
		$config_file_path_tmp = $config_file_path . '.tmp';

		if (file_exists($config_file_path)) {
			rename($config_file_path, $config_file_path_tmp);
		}

		$config_string = file_get_contents($base_config_file_path);

		$config_string = str_replace('die(', '// die(', $config_string);

		file_put_contents($config_file_path, $config_string);
	}

	/**
	 * Delete the created .htconfig.php
	 * Renames an eventually existing .htconfig.php.tmp to .htconfig.php
	 */
	public static function tearDownAfterClass()
	{
		$base_config_file_name = 'htconfig.php';
		$config_file_name = '.htconfig.php';

		$base_config_file_path = stream_resolve_include_path($base_config_file_name);
		$config_file_path = dirname($base_config_file_path) . DIRECTORY_SEPARATOR . $config_file_name;
		$config_file_path_tmp = $config_file_path . '.tmp';

		if (file_exists($config_file_path)) {
			unlink($config_file_path);
		}

		if (file_exists($config_file_path_tmp)) {
			rename($config_file_path_tmp, $config_file_path);
		}
	}

	/**
	 * Get database connection.
	 *
	 * This function is executed before each test in order to get a database connection that can be used by tests.
	 * If no prior connection is available, it tries to create one using the USER, PASS and DB environment variables.
	 *
	 * If it could not connect to the database, the test is skipped.
	 *
	 * @return PHPUnit_Extensions_Database_DB_IDatabaseConnection
	 * @see https://phpunit.de/manual/5.7/en/database.html
	 */
	protected function getConnection()
	{
		if (!dba::$connected) {
			dba::connect(getenv('MYSQL_HOST') . ':' . getenv('MYSQL_PORT'), getenv('MYSQL_USERNAME'), getenv('MYSQL_PASSWORD'), getenv('MYSQL_DATABASE'));

			if (dba::$connected) {
				$app = get_app();
				// We need to do this in order to disable logging
				$app->mode = \Friendica\App::MODE_INSTALL;

				// Create database structure
				DBStructure::update(false, true, true);

				$app->mode = \Friendica\App::MODE_NORMAL;
			} else {
				$this->markTestSkipped('Could not connect to the database. Please check the MYSQL_* environment variables.');
			}
		}

		return $this->createDefaultDBConnection(dba::get_db(), getenv('MYSQL_DATABASE'));
	}

	/**
	 * Get dataset to populate the database with.
	 * @return YamlDataSet
	 * @see https://phpunit.de/manual/5.7/en/database.html
	 */
	protected function getDataSet()
	{
		return new YamlDataSet(__DIR__ . '/datasets/api.yml');
	}
}