BaseTestCase.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Tests;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Core\Utility\StringUtility;

abstract class BaseTestCase extends \PHPUnit_Framework_TestCase
{
    protected $backupGlobals = true;

    protected $backupStaticAttributes = false;

    protected function getAccessibleMock(
        $originalClassName, $methods = [], array $arguments = [], $mockClassName = '',
        $callOriginalConstructor = true, $callOriginalClone = true, $callAutoload = true
    ) {
        if ($originalClassName === '') {
            throw new \InvalidArgumentException('$originalClassName must not be empty.', 1334701880);
        }

        return $this->getMock(
            $this->buildAccessibleProxy($originalClassName),
            $methods,
            $arguments,
            $mockClassName,
            $callOriginalConstructor,
            $callOriginalClone,
            $callAutoload
        );
    }

    protected function getAccessibleMockForAbstractClass(
        $originalClassName, array $arguments = [], $mockClassName = '',
        $callOriginalConstructor = true, $callOriginalClone = true, $callAutoload = true, $mockedMethods = []
    ) {
        if ($originalClassName === '') {
            throw new \InvalidArgumentException('$originalClassName must not be empty.', 1384268260);
        }

        return $this->getMockForAbstractClass(
            $this->buildAccessibleProxy($originalClassName),
            $arguments,
            $mockClassName,
            $callOriginalConstructor,
            $callOriginalClone,
            $callAutoload,
            $mockedMethods
        );
    }

    protected function buildAccessibleProxy($className)
    {
        $accessibleClassName = $this->getUniqueId('Tx_Phpunit_AccessibleProxy');
        $class = new \ReflectionClass($className);
        $abstractModifier = $class->isAbstract() ? 'abstract ' : '';

        eval(
            $abstractModifier . 'class ' . $accessibleClassName .
                ' extends ' . $className . ' implements ' . \TYPO3\CMS\Core\Tests\AccessibleObjectInterface::class . ' {' .
                    'public function _call($methodName) {' .
                        'if ($methodName === \'\') {' .
                            'throw new \InvalidArgumentException(\'$methodName must not be empty.\', 1334663993);' .
                        '}' .
                        '$args = func_get_args();' .
                        'return call_user_func_array(array($this, $methodName), array_slice($args, 1));' .
                    '}' .
                    'public function _callRef(' .
                        '$methodName, &$arg1 = NULL, &$arg2 = NULL, &$arg3 = NULL, &$arg4 = NULL, &$arg5= NULL, &$arg6 = NULL, ' .
                        '&$arg7 = NULL, &$arg8 = NULL, &$arg9 = NULL' .
                    ') {' .
                        'if ($methodName === \'\') {' .
                            'throw new \InvalidArgumentException(\'$methodName must not be empty.\', 1334664210);' .
                        '}' .
                        'switch (func_num_args()) {' .
                            'case 0:' .
                                'throw new RuntimeException(\'The case of 0 arguments is not supposed to happen.\', 1334703124);' .
                                'break;' .
                            'case 1:' .
                                '$returnValue = $this->$methodName();' .
                                'break;' .
                            'case 2:' .
                                '$returnValue = $this->$methodName($arg1);' .
                                'break;' .
                            'case 3:' .
                                '$returnValue = $this->$methodName($arg1, $arg2);' .
                                'break;' .
                            'case 4:' .
                                '$returnValue = $this->$methodName($arg1, $arg2, $arg3);' .
                                'break;' .
                            'case 5:' .
                                '$returnValue = $this->$methodName($arg1, $arg2, $arg3, $arg4);' .
                                'break;' .
                            'case 6:' .
                                '$returnValue = $this->$methodName($arg1, $arg2, $arg3, $arg4, $arg5);' .
                                'break;' .
                            'case 7:' .
                                '$returnValue = $this->$methodName($arg1, $arg2, $arg3, $arg4, $arg5, $arg6);' .
                                'break;' .
                            'case 8:' .
                                '$returnValue = $this->$methodName($arg1, $arg2, $arg3, $arg4, $arg5, $arg6, $arg7);' .
                                'break;' .
                            'case 9:' .
                                '$returnValue = $this->$methodName($arg1, $arg2, $arg3, $arg4, $arg5, $arg6, $arg7, $arg8);' .
                                'break;' .
                            'case 10:' .
                                '$returnValue = $this->$methodName(' .
                                    '$arg1, $arg2, $arg3, $arg4, $arg5, $arg6, $arg7, $arg8, $arg9' .
                                ');' .
                                'break;' .
                            'default:' .
                                'throw new \InvalidArgumentException(' .
                                    '\'_callRef currently only allows calls to methods with no more than 9 parameters.\'' .
                                ');' .
                        '}' .
                        'return $returnValue;' .
                    '}' .
                    'public function _set($propertyName, $value) {' .
                        'if ($propertyName === \'\') {' .
                            'throw new \InvalidArgumentException(\'$propertyName must not be empty.\', 1334664355);' .
                        '}' .
                        '$this->$propertyName = $value;' .
                    '}' .
                    'public function _setRef($propertyName, &$value) {' .
                        'if ($propertyName === \'\') {' .
                            'throw new \InvalidArgumentException(\'$propertyName must not be empty.\', 1334664545);' .
                        '}' .
                        '$this->$propertyName = $value;' .
                    '}' .
                    'public function _setStatic($propertyName, $value) {' .
                        'if ($propertyName === \'\') {' .
                            'throw new \InvalidArgumentException(\'$propertyName must not be empty.\', 1344242602);' .
                        '}' .
                        'self::$$propertyName = $value;' .
                    '}' .
                    'public function _get($propertyName) {' .
                        'if ($propertyName === \'\') {' .
                            'throw new \InvalidArgumentException(\'$propertyName must not be empty.\', 1334664967);' .
                        '}' .
                        'return $this->$propertyName;' .
                    '}' .
                    'public function _getStatic($propertyName) {' .
                        'if ($propertyName === \'\') {' .
                            'throw new \InvalidArgumentException(\'$propertyName must not be empty.\', 1344242603);' .
                        '}' .
                        'return self::$$propertyName;' .
                    '}' .
            '}'
        );

        return $accessibleClassName;
    }

    protected function callInaccessibleMethod($object, $name)
    {
        // Remove first two arguments ($object and $name)
        $arguments = func_get_args();
        array_splice($arguments, 0, 2);

        $reflectionObject = new \ReflectionObject($object);
        $reflectionMethod = $reflectionObject->getMethod($name);
        $reflectionMethod->setAccessible(true);
        return $reflectionMethod->invokeArgs($object, $arguments);
    }

    protected function inject($target, $name, $dependency)
    {
        if (!is_object($target)) {
            throw new \InvalidArgumentException('Wrong type for argument $target, must be object.');
        }

        $objectReflection = new \ReflectionObject($target);
        $methodNamePart = strtoupper($name[0]) . substr($name, 1);
        if ($objectReflection->hasMethod('set' . $methodNamePart)) {
            $methodName = 'set' . $methodNamePart;
            $target->$methodName($dependency);
        } elseif ($objectReflection->hasMethod('inject' . $methodNamePart)) {
            $methodName = 'inject' . $methodNamePart;
            $target->$methodName($dependency);
        } elseif ($objectReflection->hasProperty($name)) {
            $property = $objectReflection->getProperty($name);
            $property->setAccessible(true);
            $property->setValue($target, $dependency);
        } else {
            throw new \RuntimeException('Could not inject ' . $name . ' into object of type ' . get_class($target));
        }
    }

    protected function getUniqueId($prefix = '')
    {
        return $prefix . StringUtility::getUniqueId(mt_rand());
    }
}