kdn\yii2\TestCase

Complexity

Total Complexity

11

Size/Duplication

Total Lines	149
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	2
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	5	1
A	tearDown()	0	5	1
A	mockWebApplication()	0	22	1
A	getVendorPath()	0	4	1
A	getTestsRuntimePath()	0	4	1
A	destroyApplication()	0	4	1
A	assertStringEqualsHtmlFile()	0	15	1
A	assertStringEqualsJsFile()	0	15	1
A	catchOutput()	0	17	3

<?php

namespace kdn\yii2;

use PHPUnit_Framework_TestCase;
use Yii;
use yii\helpers\ArrayHelper;

/**
 * Class TestCase.
 * @package kdn\yii2
 */
abstract class TestCase extends PHPUnit_Framework_TestCase
{
    /**
     * Mock Yii application.
     */
    protected function setUp()
    {
        parent::setUp();
        static::mockWebApplication();
    }

    /**
     * Clean up after test.
     * By default the application created with [[mockWebApplication]] will be destroyed.
     */
    protected function tearDown()
    {
        parent::tearDown();
        static::destroyApplication();
    }

    /**
     * Populates Yii::$app with a new application.
     * The application will be destroyed on tearDown() automatically.
     * @param array $config the application configuration, if needed
     * @param string $appClass name of the application class to create
     */
    protected static function mockWebApplication($config = [], $appClass = 'yii\web\Application')
    {
        new $appClass(
            ArrayHelper::merge(
                [
                    'id' => 'test-app',
                    'basePath' => __DIR__,
                    'components' => [
                        'assetManager' => [
                            'linkAssets' => true,
                        ],
                        'request' => [
                            'scriptFile' => static::getTestsRuntimePath() . '/index.php',
                            'scriptUrl' => '/index.php',
                        ],
                    ],
                    'vendorPath' => static::getVendorPath(),
                ],
                $config
            )
        );
    }

    /**
     * Get path to "vendor" directory.
     * @return string path to "vendor" directory.
     */
    protected static function getVendorPath()
    {
        return dirname(__DIR__) . '/vendor';
    }

    /**
     * Get path to tests "runtime" directory.
     * @return string path to tests "runtime" directory.
     */
    protected static function getTestsRuntimePath()
    {
        return __DIR__ . '/runtime';
    }

    /**
     * Destroys application in Yii::$app by setting it to null.
     */
    protected static function destroyApplication()
    {
        Yii::$app = null;
    }

    /**
     * Asserts that the contents of a string is equal to the contents of a HTML file.
     * @param string $methodName name of test method
     * @param string $actualString
     * @param string $message
     * @param boolean $canonicalize
     * @param boolean $ignoreCase
     */
    public static function assertStringEqualsHtmlFile(
        $methodName,
        $actualString,
        $message = '',
        $canonicalize = false,
        $ignoreCase = false
    ) {
        static::assertStringEqualsFile(
            __DIR__ . "/expected/$methodName.html",
            $actualString,
            $message,
            $canonicalize,
            $ignoreCase
        );
    }

    /**
     * Asserts that the contents of a string is equal to the contents of a JavaScript file.
     * @param string $methodName name of test method
     * @param string $actualString
     * @param string $message
     * @param boolean $canonicalize
     * @param boolean $ignoreCase
     */
    public static function assertStringEqualsJsFile(
        $methodName,
        $actualString,
        $message = '',
        $canonicalize = false,
        $ignoreCase = false
    ) {
        static::assertStringEqualsFile(
            __DIR__ . "/expected/$methodName.js",
            $actualString,
            $message,
            $canonicalize,
            $ignoreCase
        );
    }

    /**
     * Call a user function given with an array of parameters and catch its output.
     * @param callable $callback function to be called
     * @param array $arguments parameters to be passed to the function, as an indexed array
     * @return array array containing result returned by function and its output.
     * @throws \Exception
     */
    public static function catchOutput($callback, $arguments = [])
    {
        $result = [];
        ob_start();
        ob_implicit_flush(false);
        try {
            $result['result'] = call_user_func_array($callback, $arguments);
        } catch (\Exception $e) {
            // close the output buffer opened above if it has not been closed already
            if (ob_get_level() > 0) {
                ob_end_clean();
            }
            throw $e;
        }
        $result['output'] = ob_get_clean();
        return $result;
    }
}