redaxscript / redaxscript

tests/unit/TestCaseAbstract.php

<?php
namespace Redaxscript\Tests;

use PHPUnitProviderAutoloader;
use Redaxscript\Config;
use Redaxscript\Db;
use Redaxscript\Installer;
use Redaxscript\Language;
use Redaxscript\Model;
use Redaxscript\Modules\TestDummy;
use Redaxscript\Registry;
use Redaxscript\Request;
use ReflectionClass;
use function chr;
use function file_exists;
use function file_get_contents;
use function function_exists;
use function getenv;
use function json_decode;
use function str_replace;
use function xdebug_get_headers;

/**
 * TestCaseAbstract
 *
 * @since 2.2.0
 *
 * @package Redaxscript
 * @category Tests
 * @author Henry Ruhs
 */

abstract class TestCaseAbstract extends PHPUnitProviderAutoloader\TestCaseAbstract

The type Redaxscript\Tests\TestCaseAbstract has been defined more than once; this definition is ignored, only the first definition in tests/acceptance/TestCaseAbstract.php (L24-116) is considered.

{
	/**
	 * instance of the registry class
	 *
	 * @var Registry
	 */

	protected $_registry;

	/**
	 * instance of the request class
	 *
	 * @var Request
	 */

	protected $_request;

	/**
	 * instance of the language class
	 *
	 * @var Language
	 */

	protected $_language;

	/**
	 * instance of the config class
	 *
	 * @var Config
	 */

	protected $_config;

	/**
	 * directory of the provider
	 *
	 * @var string
	 */

	protected $_providerDirectory = 'tests' . DIRECTORY_SEPARATOR . 'unit-provider';

	/**
	 * namespace of the testing suite
	 *
	 * @var string
	 */

	protected $_testNamespace = __NAMESPACE__;

	/**
	 * setUp
	 *
	 * @since 3.1.0
	 */

	public function setUp() : void
	{
		Db::clearCache();
		$this->_registry = Registry::getInstance();
		$this->_request = Request::getInstance();
		$this->_language = Language::getInstance();
		$this->_config = Config::getInstance();
	}

	/**
	 * installerFactory
	 *
	 * @since 3.1.0
	 *
	 * @return Installer
	 */

	public function installerFactory() : Installer
	{
		return new Installer($this->_registry, $this->_request, $this->_language, $this->_config);
	}

	/**
	 * settingFactory
	 *
	 * @since 3.3.0
	 *
	 * @return Model\Setting
	 */

	public function settingFactory() : Model\Setting
	{
		return new Model\Setting();
	}

	/**
	 * createDatabase
	 *
	 * @since 4.0.0
	 */

	public function createDatabase() : void
	{
		$installer = $this->installerFactory();
		$installer->init();
		$installer->rawCreate();
	}

	/**
	 * dropDatabase
	 *
	 * @since 4.0.0
	 */

	public function dropDatabase() : void
	{
		$installer = $this->installerFactory();
		$installer->init();
		$installer->rawDrop();
	}
	/**
	 * getOptionArray
	 *
	 * @since 4.1.0
	 */

	public function getOptionArray() : array
	{
		return
		[
			'adminName' => 'Test',
			'adminUser' => 'test',
			'adminPassword' => 'test',
			'adminEmail' => 'test@test.com'
		];
	}

	/**
	 * installTestDummy
	 *
	 * @since 4.0.0
	 */

	public function installTestDummy() : void
	{
		$testDummy = new TestDummy\TestDummy($this->_registry, $this->_request, $this->_language, $this->_config);
		$testDummy->install();
	}

	/**
	 * uninstallTestDummy
	 *
	 * @since 4.0.0
	 */

	public function uninstallTestDummy() : void
	{
		$testDummy = new TestDummy\TestDummy($this->_registry, $this->_request, $this->_language, $this->_config);
		$testDummy->clearNotification('success');
		$testDummy->clearNotification('warning');
		$testDummy->clearNotification('error');
		$testDummy->clearNotification('info');
		$testDummy->uninstall();
	}

	/**
	 * getJSON
	 *
	 * @since 4.0.0
	 *
	 * @param string $file
	 *
	 * @return array|null
	 */

	public function getJSON(string $file = null) : ?array
	{
		if (file_exists($file))
		{
			$content = file_get_contents($file);
			return json_decode($content, true);
		}
	}

	/**
	 * getProperty
	 *
	 * @since 3.0.0
	 *
	 * @param object $object
	 * @param string $property
	 *
	 * @return array|object
	 */

	public function getProperty(object $object = null, string $property = null)
	{
		$reflection = new ReflectionClass($object);
		$reflectionProperty = $reflection->getProperty($property);
		$reflectionProperty->setAccessible(true);
		return $reflectionProperty->getValue($object);
	}

	/**
	 * callMethod
	 *
	 * @since 3.0.0
	 *
	 * @param object $object
	 * @param string $method
	 * @param array $argumentArray
	 *
	 * @return array|object
	 */

	public function callMethod(object $object = null, string $method = null, array $argumentArray = [])
	{
		$reflection = new ReflectionClass($object);
		$reflectionMethod = $reflection->getMethod($method);
		$reflectionMethod->setAccessible(true);
		return $reflectionMethod->invokeArgs($object, $argumentArray);
	}

	/**
	 * normalizeSeparator
	 *
	 * @since 3.2.0
	 *
	 * @param string $actual
	 *
	 * @return string
	 */

	public function normalizeSeparator(string $actual = null) : string
	{
		return str_replace(DIRECTORY_SEPARATOR, chr(47), $actual);
	}

	/**
	 * normalizeNewline
	 *
	 * @since 3.0.0
	 *
	 * @param string $actual
	 *
	 * @return string
	 */

	public function normalizeNewline(string $actual = null) : string
	{
		return str_replace(PHP_EOL, chr(10), $actual);
	}

	/**
	 * getHeaderArray
	 *
	 * @since 3.0.0
	 *
	 * @return array|null
	 */

	public function getHeaderArray() : ?array
	{
		if (function_exists('xdebug_get_headers'))
		{
			return xdebug_get_headers();
		}
		$this->markTestSkipped();
		return null;
	}

	/**
	 * skipOnEnv
	 *
	 * @since 4.0.0
	 *
	 * @param string|null $env
	 */

	public function skipOnEnv(string $env = null) : void
	{
		if (getenv($env))
		{
			$this->markTestSkipped();
		}
	}
}