FunctionalTestCaseBootstrapUtility.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!
 */

class FunctionalTestCaseBootstrapUtility
{
    protected $identifier;

    protected $instancePath;

    protected $databaseName;

    protected $originalDatabaseName;

    protected $defaultActivatedCoreExtensions = [
        'core',
        'backend',
        'frontend',
        'lang',
        'extbase',
        'install',
    ];

    protected $defaultFoldersToCreate = [
        '',
        '/fileadmin',
        '/typo3temp',
        '/typo3conf',
        '/typo3conf/ext',
        '/uploads'
    ];

    public static function getInstanceIdentifier($testCaseClassName)
    {
        // 7 characters of sha1 should be enough for a unique identification
        return substr(sha1($testCaseClassName), 0, 7);
    }

    public static function getInstancePath($testCaseClassName)
    {
        return ORIGINAL_ROOT . 'typo3temp/functional-' . static::getInstanceIdentifier($testCaseClassName);
    }

    public function setUp(
        $testCaseClassName,
        array $coreExtensionsToLoad,
        array $testExtensionsToLoad,
        array $pathsToLinkInTestInstance,
        array $configurationToUse,
        array $additionalFoldersToCreate
    ) {
        $this->setUpIdentifier($testCaseClassName);
        $this->setUpInstancePath($testCaseClassName);
        if ($this->recentTestInstanceExists()) {
            $this->setUpBasicTypo3Bootstrap();
            $this->initializeTestDatabase();
            \TYPO3\CMS\Core\Core\Bootstrap::getInstance()->loadExtensionTables(true);
        } else {
            $this->removeOldInstanceIfExists();
            $this->setUpInstanceDirectories($additionalFoldersToCreate);
            $this->setUpInstanceCoreLinks();
            $this->linkTestExtensionsToInstance($testExtensionsToLoad);
            $this->linkPathsInTestInstance($pathsToLinkInTestInstance);
            $this->setUpLocalConfiguration($configurationToUse);
            $this->setUpPackageStates($coreExtensionsToLoad, $testExtensionsToLoad);
            $this->setUpBasicTypo3Bootstrap();
            $this->setUpTestDatabase();
            \TYPO3\CMS\Core\Core\Bootstrap::getInstance()->loadExtensionTables(true);
            $this->createDatabaseStructure();
        }

        return $this->instancePath;
    }

    protected function recentTestInstanceExists()
    {
        if (@file_get_contents($this->instancePath . '/last_run.txt') <= (time() - 300)) {
            return false;
        } else {
            // Test instance exists and is pretty young -> re-use
            return true;
        }
    }

    protected function setUpIdentifier($testCaseClassName)
    {
        $this->identifier = static::getInstanceIdentifier($testCaseClassName);
    }

    protected function setUpInstancePath($testCaseClassName)
    {
        $this->instancePath = static::getInstancePath($testCaseClassName);
    }

    protected function removeOldInstanceIfExists()
    {
        if (is_dir($this->instancePath)) {
            $this->removeInstance();
        }
    }

    protected function setUpInstanceDirectories(array $additionalFoldersToCreate = [])
    {
        $foldersToCreate = array_merge($this->defaultFoldersToCreate, $additionalFoldersToCreate);
        foreach ($foldersToCreate as $folder) {
            $success = mkdir($this->instancePath . $folder);
            if (!$success) {
                throw new Exception(
                    'Creating directory failed: ' . $this->instancePath . $folder,
                    1376657189
                );
            }
        }

        // Store the time we created this directory
        file_put_contents($this->instancePath . '/last_run.txt', time());
    }

    protected function setUpInstanceCoreLinks()
    {
        $linksToSet = [
            ORIGINAL_ROOT . 'typo3' => $this->instancePath . '/typo3',
            ORIGINAL_ROOT . 'index.php' => $this->instancePath . '/index.php'
        ];
        foreach ($linksToSet as $from => $to) {
            $success = symlink($from, $to);
            if (!$success) {
                throw new Exception(
                    'Creating link failed: from ' . $from . ' to: ' . $to,
                    1376657199
                );
            }
        }
    }

    protected function linkTestExtensionsToInstance(array $extensionPaths)
    {
        foreach ($extensionPaths as $extensionPath) {
            $absoluteExtensionPath = ORIGINAL_ROOT . $extensionPath;
            if (!is_dir($absoluteExtensionPath)) {
                throw new Exception(
                    'Test extension path ' . $absoluteExtensionPath . ' not found',
                    1376745645
                );
            }
            $destinationPath = $this->instancePath . '/typo3conf/ext/' . basename($absoluteExtensionPath);
            $success = symlink($absoluteExtensionPath, $destinationPath);
            if (!$success) {
                throw new Exception(
                    'Can not link extension folder: ' . $absoluteExtensionPath . ' to ' . $destinationPath,
                    1376657142
                );
            }
        }
    }

    protected function linkPathsInTestInstance(array $pathsToLinkInTestInstance)
    {
        foreach ($pathsToLinkInTestInstance as $sourcePathToLinkInTestInstance => $destinationPathToLinkInTestInstance) {
            $sourcePath = $this->instancePath . '/' . ltrim($sourcePathToLinkInTestInstance, '/');
            if (!file_exists($sourcePath)) {
                throw new Exception(
                    'Path ' . $sourcePath . ' not found',
                    1376745645
                );
            }
            $destinationPath = $this->instancePath . '/' . ltrim($destinationPathToLinkInTestInstance, '/');
            $success = symlink($sourcePath, $destinationPath);
            if (!$success) {
                throw new Exception(
                    'Can not link the path ' . $sourcePath . ' to ' . $destinationPath,
                    1389969623
                );
            }
        }
    }

    protected function setUpLocalConfiguration(array $configurationToMerge)
    {
        $databaseName = trim(getenv('typo3DatabaseName'));
        $databaseHost = trim(getenv('typo3DatabaseHost'));
        $databaseUsername = trim(getenv('typo3DatabaseUsername'));
        $databasePassword = trim(getenv('typo3DatabasePassword'));
        $databasePort = trim(getenv('typo3DatabasePort'));
        $databaseSocket = trim(getenv('typo3DatabaseSocket'));
        if ($databaseName || $databaseHost || $databaseUsername || $databasePassword || $databasePort || $databaseSocket) {
            // Try to get database credentials from environment variables first
            $originalConfigurationArray = [
                'DB' => [],
            ];
            if ($databaseName) {
                $originalConfigurationArray['DB']['database'] = $databaseName;
            }
            if ($databaseHost) {
                $originalConfigurationArray['DB']['host'] = $databaseHost;
            }
            if ($databaseUsername) {
                $originalConfigurationArray['DB']['username'] = $databaseUsername;
            }
            if ($databasePassword) {
                $originalConfigurationArray['DB']['password'] = $databasePassword;
            }
            if ($databasePort) {
                $originalConfigurationArray['DB']['port'] = $databasePort;
            }
            if ($databaseSocket) {
                $originalConfigurationArray['DB']['socket'] = $databaseSocket;
            }
        } elseif (file_exists(ORIGINAL_ROOT . 'typo3conf/LocalConfiguration.php')) {
            // See if a LocalConfiguration file exists in "parent" instance to get db credentials from
            $originalConfigurationArray = require ORIGINAL_ROOT . 'typo3conf/LocalConfiguration.php';
        } else {
            throw new Exception(
                'Database credentials for functional tests are neither set through environment'
                . ' variables, and can not be found in an existing LocalConfiguration file',
                1397406356
            );
        }

        // Base of final LocalConfiguration is core factory configuration
        $finalConfigurationArray = require ORIGINAL_ROOT . 'typo3/sysext/core/Configuration/FactoryConfiguration.php';

        $this->mergeRecursiveWithOverrule($finalConfigurationArray, require ORIGINAL_ROOT . 'typo3/sysext/core/Build/Configuration/FunctionalTestsConfiguration.php');
        $this->mergeRecursiveWithOverrule($finalConfigurationArray, $configurationToMerge);
        $finalConfigurationArray['DB'] = $originalConfigurationArray['DB'];
        // Calculate and set new database name
        $this->originalDatabaseName = $originalConfigurationArray['DB']['database'];
        $this->databaseName = $this->originalDatabaseName . '_ft' . $this->identifier;

        // Maximum database name length for mysql is 64 characters
        if (strlen($this->databaseName) > 64) {
            $maximumOriginalDatabaseName = 64 - strlen('_ft' . $this->identifier);
            throw new Exception(
                'The name of the database that is used for the functional test (' . $this->databaseName . ')' .
                ' exceeds the maximum length of 64 character allowed by MySQL. You have to shorten your' .
                ' original database name to ' . $maximumOriginalDatabaseName . ' characters',
                1377600104
            );
        }

        $finalConfigurationArray['DB']['database'] = $this->databaseName;

        $result = $this->writeFile(
            $this->instancePath . '/typo3conf/LocalConfiguration.php',
            '<?php' . chr(10) .
            'return ' .
            $this->arrayExport(
                $finalConfigurationArray
            ) .
            ';' . chr(10) .
            '?>'
        );
        if (!$result) {
            throw new Exception('Can not write local configuration', 1376657277);
        }
    }

    protected function setUpPackageStates(array $coreExtensionsToLoad, array $testExtensionPaths)
    {
        $packageStates = [
            'packages' => [],
            'version' => 4,
        ];

        // Register default list of extensions and set active
        foreach ($this->defaultActivatedCoreExtensions as $extensionName) {
            $packageStates['packages'][$extensionName] = [
                'state' => 'active',
                'packagePath' => 'typo3/sysext/' . $extensionName . '/',
                'classesPath' => 'Classes/',
            ];
        }

        // Register additional core extensions and set active
        foreach ($coreExtensionsToLoad as $extensionName) {
            if (isset($packageSates['packages'][$extensionName])) {
                throw new Exception(
                    $extensionName . ' is already registered as default core extension to load, no need to load it explicitly',
                    1390913893
                );
            }
            $packageStates['packages'][$extensionName] = [
                'state' => 'active',
                'packagePath' => 'typo3/sysext/' . $extensionName . '/',
                'classesPath' => 'Classes/',
            ];
        }

        // Activate test extensions that have been symlinked before
        foreach ($testExtensionPaths as $extensionPath) {
            $extensionName = basename($extensionPath);
            if (isset($packageSates['packages'][$extensionName])) {
                throw new Exception(
                    $extensionName . ' is already registered as extension to load, no need to load it explicitly',
                    1390913894
                );
            }
            $packageStates['packages'][$extensionName] = [
                'state' => 'active',
                'packagePath' => 'typo3conf/ext/' . $extensionName . '/',
                'classesPath' => 'Classes/',
            ];
        }

        $result = $this->writeFile(
            $this->instancePath . '/typo3conf/PackageStates.php',
            '<?php' . chr(10) .
            'return ' .
            $this->arrayExport(
                $packageStates
            ) .
            ';' . chr(10) .
            '?>'
        );
        if (!$result) {
            throw new Exception('Can not write PackageStates', 1381612729);
        }
    }

    protected function setUpBasicTypo3Bootstrap()
    {
        $_SERVER['PWD'] = $this->instancePath;
        $_SERVER['argv'][0] = 'index.php';

        define('TYPO3_MODE', 'BE');
        define('TYPO3_cliMode', true);

        $classLoader = require rtrim(realpath($this->instancePath . '/typo3'), '\\/') . '/../vendor/autoload.php';
        \TYPO3\CMS\Core\Core\Bootstrap::getInstance()
            ->initializeClassLoader($classLoader)
            ->baseSetup('')
            ->loadConfigurationAndInitialize(true)
            ->loadTypo3LoadedExtAndExtLocalconf(true)
            ->setFinalCachingFrameworkCacheConfiguration()
            ->defineLoggingAndExceptionConstants()
            ->unsetReservedGlobalVariables();
    }

    protected function setUpTestDatabase()
    {
        \TYPO3\CMS\Core\Core\Bootstrap::getInstance()->initializeTypo3DbGlobal();
        $database = $GLOBALS['TYPO3_DB'];
        if (!$database->sql_pconnect()) {
            throw new Exception(
                'TYPO3 Fatal Error: The current username, password or host was not accepted when the'
                . ' connection to the database was attempted to be established!',
                1377620117
            );
        }

        // Drop database in case a previous test had a fatal and did not clean up properly
        $database->admin_query('DROP DATABASE IF EXISTS `' . $this->databaseName . '`');
        $createDatabaseResult = $database->admin_query('CREATE DATABASE `' . $this->databaseName . '`');
        if (!$createDatabaseResult) {
            $user = $GLOBALS['TYPO3_CONF_VARS']['DB']['username'];
            $host = $GLOBALS['TYPO3_CONF_VARS']['DB']['host'];
            throw new Exception(
                'Unable to create database with name ' . $this->databaseName . '. This is probably a permission problem.'
                . ' For this instance this could be fixed executing'
                . ' "GRANT ALL ON `' . $this->originalDatabaseName . '_ft%`.* TO `' . $user . '`@`' . $host . '`;"',
                1376579070
            );
        }
        $database->setDatabaseName($this->databaseName);
        // On windows, this still works, but throws a warning, which we need to discard.
        @$database->sql_select_db();
    }

    protected function initializeTestDatabase()
    {
        \TYPO3\CMS\Core\Core\Bootstrap::getInstance()->initializeTypo3DbGlobal();
        $database = $GLOBALS['TYPO3_DB'];
        if (!$database->sql_pconnect()) {
            throw new Exception(
                'TYPO3 Fatal Error: The current username, password or host was not accepted when the'
                . ' connection to the database was attempted to be established!',
                1377620117
            );
        }
        $this->databaseName = $GLOBALS['TYPO3_CONF_VARS']['DB']['database'];
        $database->setDatabaseName($this->databaseName);
        $database->sql_select_db();
        foreach ($database->admin_get_tables() as $table) {
            $database->admin_query('TRUNCATE ' . $table['Name'] . ';');
        }
    }

    protected function createDatabaseStructure()
    {
        $schemaMigrationService = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Install\Service\SqlSchemaMigrationService::class);
        $objectManager = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Extbase\Object\ObjectManager::class);
        $expectedSchemaService = $objectManager->get(\TYPO3\CMS\Install\Service\SqlExpectedSchemaService::class);

        // Raw concatenated ext_tables.sql and friends string
        $expectedSchemaString = $expectedSchemaService->getTablesDefinitionString(true);
        $statements = $schemaMigrationService->getStatementArray($expectedSchemaString, true);
        list($_, $insertCount) = $schemaMigrationService->getCreateTables($statements, true);

        $fieldDefinitionsFile = $schemaMigrationService->getFieldDefinitions_fileContent($expectedSchemaString);
        $fieldDefinitionsDatabase = $schemaMigrationService->getFieldDefinitions_database();
        $difference = $schemaMigrationService->getDatabaseExtra($fieldDefinitionsFile, $fieldDefinitionsDatabase);
        $updateStatements = $schemaMigrationService->getUpdateSuggestions($difference);

        $schemaMigrationService->performUpdateQueries($updateStatements['add'], $updateStatements['add']);
        $schemaMigrationService->performUpdateQueries($updateStatements['change'], $updateStatements['change']);
        $schemaMigrationService->performUpdateQueries($updateStatements['create_table'], $updateStatements['create_table']);

        foreach ($insertCount as $table => $count) {
            $insertStatements = $schemaMigrationService->getTableInsertStatements($statements, $table);
            foreach ($insertStatements as $insertQuery) {
                $insertQuery = rtrim($insertQuery, ';');
                $database = $GLOBALS['TYPO3_DB'];
                $database->admin_query($insertQuery);
            }
        }
    }

    protected function tearDownTestDatabase()
    {
        $database = $GLOBALS['TYPO3_DB'];
        $result = $database->admin_query('DROP DATABASE `' . $this->databaseName . '`');
        if (!$result) {
            throw new Exception(
                'Dropping test database ' . $this->databaseName . ' failed',
                1376583188
            );
        }
    }

    protected function removeInstance()
    {
        $success = $this->rmdir($this->instancePath, true);
        if (!$success) {
            throw new Exception(
                'Can not remove folder: ' . $this->instancePath,
                1376657210
            );
        }
    }

    protected function rmdir($path, $removeNonEmpty = false)
    {
        $OK = false;
        // Remove trailing slash
        $path = preg_replace('|/$|', '', $path);
        if (file_exists($path)) {
            $OK = true;
            if (!is_link($path) && is_dir($path)) {
                if ($removeNonEmpty == true && ($handle = opendir($path))) {
                    while ($OK && false !== ($file = readdir($handle))) {
                        if ($file == '.' || $file == '..') {
                            continue;
                        }
                        $OK = $this->rmdir($path . '/' . $file, $removeNonEmpty);
                    }
                    closedir($handle);
                }
                if ($OK) {
                    $OK = @rmdir($path);
                }
            } else {
                // If $path is a symlink to a folder we need rmdir() on Windows systems
                if (!stristr(PHP_OS, 'darwin') && stristr(PHP_OS, 'win') && is_link($path) && is_dir($path . '/')) {
                    $OK = rmdir($path);
                } else {
                    $OK = unlink($path);
                }
            }
            clearstatcache();
        } elseif (is_link($path)) {
            $OK = unlink($path);
            clearstatcache();
        }
        return $OK;
    }

    protected function writeFile($file, $content)
    {
        if ($fd = fopen($file, 'wb')) {
            $res = fwrite($fd, $content);
            fclose($fd);
            if ($res === false) {
                return false;
            }
            return true;
        }
        return false;
    }

    protected function arrayExport(array $array = [], $level = 0)
    {
        $lines = 'array(' . chr(10);
        $level++;
        $writeKeyIndex = false;
        $expectedKeyIndex = 0;
        foreach ($array as $key => $value) {
            if ($key === $expectedKeyIndex) {
                $expectedKeyIndex++;
            } else {
                // Found a non integer or non consecutive key, so we can break here
                $writeKeyIndex = true;
                break;
            }
        }
        foreach ($array as $key => $value) {
            // Indention
            $lines .= str_repeat(chr(9), $level);
            if ($writeKeyIndex) {
                // Numeric / string keys
                $lines .= is_int($key) ? $key . ' => ' : '\'' . $key . '\' => ';
            }
            if (is_array($value)) {
                if (!empty($value)) {
                    $lines .= $this->arrayExport($value, $level);
                } else {
                    $lines .= 'array(),' . chr(10);
                }
            } elseif (is_int($value) || is_float($value)) {
                $lines .= $value . ',' . chr(10);
            } elseif (is_null($value)) {
                $lines .= 'NULL' . ',' . chr(10);
            } elseif (is_bool($value)) {
                $lines .= $value ? 'TRUE' : 'FALSE';
                $lines .= ',' . chr(10);
            } elseif (is_string($value)) {
                // Quote \ to \\
                $stringContent = str_replace('\\', '\\\\', $value);
                // Quote ' to \'
                $stringContent = str_replace('\'', '\\\'', $stringContent);
                $lines .= '\'' . $stringContent . '\'' . ',' . chr(10);
            } else {
                throw new \RuntimeException('Objects are not supported', 1342294986);
            }
        }
        $lines .= str_repeat(chr(9), ($level - 1)) . ')' . ($level - 1 == 0 ? '' : ',' . chr(10));
        return $lines;
    }

    protected function mergeRecursiveWithOverrule(array &$original, array $overrule, $addKeys = true, $includeEmptyValues = true, $enableUnsetFeature = true)
    {
        foreach ($overrule as $key => $_) {
            if ($enableUnsetFeature && $overrule[$key] === '__UNSET') {
                unset($original[$key]);
                continue;
            }
            if (isset($original[$key]) && is_array($original[$key])) {
                if (is_array($overrule[$key])) {
                    self::mergeRecursiveWithOverrule($original[$key], $overrule[$key], $addKeys, $includeEmptyValues, $enableUnsetFeature);
                }
            } elseif (
                ($addKeys || isset($original[$key])) &&
                ($includeEmptyValues || $overrule[$key])
            ) {
                $original[$key] = $overrule[$key];
            }
        }
        // This line is kept for backward compatibility reasons.
        reset($original);
    }
}