TestCase.php 2.08 KB
Newer Older
1 2 3 4 5
<?php

namespace yii\codeception;

use Yii;
Qiang Xue committed
6
use yii\base\InvalidConfigException;
7
use Codeception\TestCase\Test;
8 9 10 11 12 13 14

/**
 * TestCase is the base class for all codeception unit tests
 *
 * @author Mark Jebri <mark.github@yandex.ru>
 * @since 2.0
 */
15
class TestCase extends Test
16 17
{
	/**
Qiang Xue committed
18 19
	 * @var array|string the application configuration that will be used for creating an application instance for each test.
	 * You can use a string to represent the file path or path alias of a configuration file.
Qiang Xue committed
20 21
	 * The application configuration array may contain an optional `class` element which specifies the class
	 * name of the application instance to be created. By default, a [[yii\web\Application]] instance will be created.
22
	 */
Qiang Xue committed
23
	public $appConfig = '@tests/unit/_config.php';
Qiang Xue committed
24

Qiang Xue committed
25 26 27 28 29 30 31 32
	/**
	 * @inheritdoc
	 */
	protected function setUp()
	{
		parent::setUp();
		$this->mockApplication();
	}
33 34

	/**
Qiang Xue committed
35
	 * @inheritdoc
36 37 38 39 40 41 42
	 */
	protected function tearDown()
	{
		$this->destroyApplication();
		parent::tearDown();
	}

43
	/**
Qiang Xue committed
44 45 46 47
	 * Mocks up the application instance.
	 * @param array $config the configuration that should be used to generate the application instance.
	 * If null, [[appConfig]] will be used.
	 * @return \yii\web\Application|\yii\console\Application the application instance
Qiang Xue committed
48
	 * @throws InvalidConfigException if the application configuration is invalid
49
	 */
Qiang Xue committed
50
	protected function mockApplication($config = null)
51
	{
Qiang Xue committed
52
		$config = $config === null ? $this->appConfig : $config;
Qiang Xue committed
53
		if (is_string($config)) {
Qiang Xue committed
54 55 56 57 58
			$configFile = Yii::getAlias($config);
			if (!is_file($configFile)) {
				throw new InvalidConfigException("The application configuration file does not exist: $config");
			}
			$config = require($configFile);
Qiang Xue committed
59
		}
Qiang Xue committed
60 61 62 63 64 65 66
		if (is_array($config)) {
			if (!isset($config['class'])) {
				$config['class'] = 'yii\web\Application';
			}
			return Yii::createObject($config);
		} else {
			throw new InvalidConfigException('Please provide a configuration array to mock up an application.');
Qiang Xue committed
67
		}
68 69
	}

70
	/**
Qiang Xue committed
71
	 * Destroys the application instance created by [[mockApplication]].
72
	 */
73 74
	protected function destroyApplication()
	{
Qiang Xue committed
75
		Yii::$app = null;
76 77
	}
}