TestCase.php 2.18 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;
Qiang Xue committed
8
use yii\test\FixtureTrait;
9 10 11 12 13 14 15

/**
 * TestCase is the base class for all codeception unit tests
 *
 * @author Mark Jebri <mark.github@yandex.ru>
 * @since 2.0
 */
16
class TestCase extends Test
17
{
Qiang Xue committed
18 19
	use FixtureTrait;

20
	/**
Qiang Xue committed
21 22
	 * @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
23
	 * The application configuration array may contain an optional `class` element which specifies the class
Carsten Brandt committed
24
	 * name of the application instance to be created. By default, a [[\yii\web\Application]] instance will be created.
25
	 */
Qiang Xue committed
26
	public $appConfig = '@tests/unit/_config.php';
Qiang Xue committed
27

Qiang Xue committed
28 29 30 31 32 33 34
	/**
	 * @inheritdoc
	 */
	protected function setUp()
	{
		parent::setUp();
		$this->mockApplication();
Qiang Xue committed
35
		$this->loadFixtures();
Qiang Xue committed
36
	}
37 38

	/**
Qiang Xue committed
39
	 * @inheritdoc
40 41 42
	 */
	protected function tearDown()
	{
Qiang Xue committed
43
		$this->unloadFixtures();
44 45 46 47
		$this->destroyApplication();
		parent::tearDown();
	}

48
	/**
Qiang Xue committed
49 50 51 52
	 * 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
53
	 * @throws InvalidConfigException if the application configuration is invalid
54
	 */
Qiang Xue committed
55
	protected function mockApplication($config = null)
56
	{
Qiang Xue committed
57
		$config = $config === null ? $this->appConfig : $config;
Qiang Xue committed
58
		if (is_string($config)) {
Qiang Xue committed
59 60 61 62 63
			$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
64
		}
Qiang Xue committed
65 66 67 68 69 70 71
		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
72
		}
73 74
	}

75
	/**
Qiang Xue committed
76
	 * Destroys the application instance created by [[mockApplication]].
77
	 */
78 79
	protected function destroyApplication()
	{
Qiang Xue committed
80
		Yii::$app = null;
81 82
	}
}