UnitTestsBootstrap.php

Go to the documentation of this file.

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

/*
 * 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\Core\Bootstrap;

class UnitTestsBootstrap
{
    public function bootstrapSystem()
    {
        $this->enableDisplayErrors()
            ->checkForCliDispatch()
            ->defineSitePath()
            ->setTypo3Context()
            ->createNecessaryDirectoriesInDocumentRoot()
            ->includeAndStartCoreBootstrap()
            ->initializeConfiguration()
            ->finishCoreBootstrap();
    }

    protected function enableDisplayErrors()
    {
        @ini_set('display_errors', 1);
        return $this;
    }

    protected function checkForCliDispatch()
    {
        if (!defined('TYPO3_MODE')) {
            return $this;
        }

        array_shift($_SERVER['argv']);
        $flatArguments = implode(' ', $_SERVER['argv']);
        echo 'Please run the unit tests using the following command:' . chr(10) .
            sprintf('typo3/../bin/phpunit %s', $flatArguments) . chr(10) .
            chr(10);

        exit(1);
    }

    protected function defineSitePath()
    {
        define('PATH_site', $this->getWebRoot());
        define('PATH_thisScript', PATH_site . 'typo3/cli_dispatch.phpsh');
        $_SERVER['SCRIPT_NAME'] = PATH_thisScript;

        if (!file_exists(PATH_thisScript)) {
            $this->exitWithMessage('Unable to determine path to entry script. Please check your path or set an environment variable \'TYPO3_PATH_WEB\' to your root path.');
        }

        return $this;
    }

    protected function getWebRoot()
    {
        if (getenv('TYPO3_PATH_WEB')) {
            $webRoot = getenv('TYPO3_PATH_WEB');
        } else {
            $webRoot = getcwd();
        }
        return rtrim(strtr($webRoot, '\\', '/'), '/') . '/';
    }

    protected function setTypo3Context()
    {
        define('TYPO3_MODE', 'BE');
        define('TYPO3_cliMode', true);
        putenv('TYPO3_CONTEXT=Testing');

        // Set TYPO3_AJAX and define TYPO3_REQUESSTTYPE's to prevent PHP 7.2 warnings
        $GLOBALS['TYPO3_AJAX'] = '';
        Bootstrap::getInstance()->defineTypo3RequestTypes();

        return $this;
    }

    protected function createNecessaryDirectoriesInDocumentRoot()
    {
        $this->createDirectory(PATH_site . 'uploads');
        $this->createDirectory(PATH_site . 'typo3temp');
        $this->createDirectory(PATH_site . 'typo3conf/ext');

        return $this;
    }

    protected function createDirectory($directory)
    {
        if (is_dir($directory)) {
            return;
        }
        @mkdir($directory, 0777, true);
        clearstatcache();
        if (!is_dir($directory)) {
            throw new \RuntimeException('Directory "' . $directory . '" could not be created', 1423043755);
        }
    }

    protected function includeAndStartCoreBootstrap()
    {
        $classLoaderFilepath = __DIR__ . '/../../../../vendor/autoload.php';
        if (!file_exists($classLoaderFilepath)) {
            $this->exitWithMessage('ClassLoader can\'t be loaded. Please check your path or set an environment variable \'TYPO3_PATH_WEB\' to your root path.');
        }
        $classLoader = require $classLoaderFilepath;

        Bootstrap::getInstance()
            ->initializeClassLoader($classLoader)
            ->baseSetup();

        return $this;
    }

    protected function initializeConfiguration()
    {
        $configurationManager = new \TYPO3\CMS\Core\Configuration\ConfigurationManager();
        $GLOBALS['TYPO3_CONF_VARS'] = $configurationManager->getDefaultConfiguration();

        // avoid failing tests that rely on HTTP_HOST retrieval
        $GLOBALS['TYPO3_CONF_VARS']['SYS']['trustedHostsPattern'] = '.*';

        return $this;
    }

    protected function finishCoreBootstrap()
    {
        Bootstrap::getInstance()
            ->disableCoreCache()
            ->initializeCachingFramework()
            ->initializePackageManagement(\TYPO3\CMS\Core\Package\UnitTestPackageManager::class)
            ->ensureClassLoadingInformationExists();

        return $this;
    }

    protected function exitWithMessage($message)
    {
        echo $message . chr(10);
        exit(1);
    }
}

if (PHP_SAPI !== 'cli') {
    die('This script supports command line usage only. Please check your command.');
}
$bootstrap = new UnitTestsBootstrap();
$bootstrap->bootstrapSystem();
unset($bootstrap);