N98\Magento\TestApplication

Complexity

Total Complexity

22

Size/Duplication

Total Lines	188
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
C	getTestMagentoRootFromEnvironment()	0	30	8
A	getConfig()	0	7	1
A	__construct()	0	11	3
A	getTestMagentoRoot()	0	18	3
B	getApplication()	0	31	4
A	any()	0	4	1
A	returnValue()	0	4	1
A	markTestSkipped()	0	4	1

<?php
/*
 * this file is part of magerun
 *
 * @author Tom Klingenberg <https://github.com/ktomk>
 */

namespace N98\Magento;

use PHPUnit_Framework_MockObject_Generator;
use PHPUnit_Framework_MockObject_Matcher_AnyInvokedCount;
use PHPUnit_Framework_MockObject_MockObject;
use PHPUnit_Framework_MockObject_Stub_Return;
use PHPUnit_Framework_SkippedTestError;
use RuntimeException;

/**
 * Magento test-application, the one used in unit and integration testing.
 *
 * @package N98\Magento
 */
class TestApplication
{
    /**
     * @var Application
     */
    private $application;

    /**
     * @var string|null
     */
    private $root;

    /**
     * @var string
     */
    private $varname;

    /**
     * @var string
     */
    private $basename;

    /**
     * @param string $varname name of the environment variable containing the test-root
     * @param string $basename name of the stopfile containing the test-root
     *
     * @return string|null
     */
    public static function getTestMagentoRootFromEnvironment($varname, $basename)
    {
        $root = getenv($varname);
        if (empty($root) && strlen($basename)) {
            $stopfile = getcwd() . '/' . $basename;
            if (is_readable($stopfile) && $buffer = rtrim(file_get_contents($stopfile))) {
                $root = $buffer;
            }
        }
        if (empty($root)) {
            return;
        }

        # directory test
        if (!is_dir($root)) {
            throw new RuntimeException(
                sprintf("%s path '%s' is not a directory", $varname, $root)
            );
        }

        # resolve root to realpath to be independent to current working directory
        $rootRealpath = realpath($root);
        if (false === $rootRealpath) {
            throw new RuntimeException(
                sprintf("Failed to resolve %s path '%s' with realpath()", $varname, $root)
            );
        }

        return $rootRealpath;
    }

    /**
     * @return array
     */
    public static function getConfig()
    {
        $testApplication = new TestApplication();
        $config = $testApplication->getApplication()->getConfig();

The method getConfig does only exist in N98\Magento\Application, but not in PHPUnit_Framework_MockObject_MockObject.

        return $config;
    }

    /**
     * TestApplication constructor.
     *
     * @param string $varname [optional] name of the environment variable containing the path to magento-root

Should the type for parameter $varname not be string|null?

     */
    public function __construct($varname = null, $basename = null)
    {
        if (null === $varname) {
            $varname = 'N98_MAGERUN2_TEST_MAGENTO_ROOT';
        }
        if (null === $basename) {
            $basename = '.n98-magerun2';
        }
        $this->varname = $varname;
        $this->basename = $basename;
    }

    /**
     * getter for the magento root directory of the test-suite
     *
     * @see ApplicationTest::testExecute
     *
     * @return string

Should the return type not be string|null?

     */
    public function getTestMagentoRoot()
    {
        if ($this->root) {

The expression $this->root of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            return $this->root;
        }

        $varname = $this->varname;

        $root = self::getTestMagentoRootFromEnvironment($varname, $this->basename);

        if (null === $root) {
            $this->markTestSkipped(
                "Please specify environment variable $varname with path to your test magento installation!"
            );
        }

        return $this->root = $root;
    }

    /**
     * @return Application|PHPUnit_Framework_MockObject_MockObject
     */
    public function getApplication()
    {
        if ($this->application === null) {
            $root = $this->getTestMagentoRoot();

            $mockObjectGenerator = new PHPUnit_Framework_MockObject_Generator;

            /** @var Application|PHPUnit_Framework_MockObject_MockObject $application */
            $application = $mockObjectGenerator->getMock('N98\Magento\Application', array('getMagentoRootFolder'));

            // Get the composer bootstraph
            if (defined('PHPUNIT_COMPOSER_INSTALL')) {
                $loader = require PHPUNIT_COMPOSER_INSTALL;
            } elseif (file_exists(__DIR__ . '/../../../../../autoload.php')) {
                // Installed via composer, already in vendor
                $loader = require __DIR__ . '/../../../../../autoload.php';
            } else {
                // Check if testing root package without PHPUnit
                $loader = require __DIR__ . '/../../../vendor/autoload.php';
            }

            $application->setAutoloader($loader);

The method setAutoloader does only exist in N98\Magento\Application, but not in PHPUnit_Framework_MockObject_MockObject.

            $application->expects($this->any())->method('getMagentoRootFolder')->will($this->returnValue($root));

The method expects does only exist in PHPUnit_Framework_MockObject_MockObject, but not in N98\Magento\Application.

            $application->init();

The method init does only exist in N98\Magento\Application, but not in PHPUnit_Framework_MockObject_MockObject.

            $application->initMagento();

The method initMagento does only exist in N98\Magento\Application, but not in PHPUnit_Framework_MockObject_MockObject.

            $this->application = $application;

It seems like $application can also be of type object<PHPUnit_Framework_MockObject_MockObject>. However, the property $application is declared as type object<N98\Magento\Application>. Maybe add an additional type check?

        }

        return $this->application;
    }

    /*
     * PHPUnit TestCase methods
     */

    /**
     * Returns a matcher that matches when the method it is evaluated for
     * is executed zero or more times.
     *
     * @return PHPUnit_Framework_MockObject_Matcher_AnyInvokedCount
     * @since  Method available since Release 3.0.0
     */
    public static function any()
    {
        return new PHPUnit_Framework_MockObject_Matcher_AnyInvokedCount;
    }

    /**
     *
     *
     * @param  mixed $value
     * @return PHPUnit_Framework_MockObject_Stub_Return
     * @since  Method available since Release 3.0.0
     */
    public static function returnValue($value)
    {
        return new PHPUnit_Framework_MockObject_Stub_Return($value);
    }

    /**
     * Mark the test as skipped.
     *
     * @param  string $message
     * @throws PHPUnit_Framework_SkippedTestError
     * @since  Method available since Release 3.0.0
     */
    public static function markTestSkipped($message = '')
    {
        throw new PHPUnit_Framework_SkippedTestError($message);
    }
}