InstallUtilityTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Extensionmanager\Tests\Unit\Utility;
 
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Container\ContainerInterface;
use Psr\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\Yaml\Yaml;
use ‪TYPO3\CMS\Core\Cache\CacheManager;
use ‪TYPO3\CMS\Core\Cache\Frontend\NullFrontend;
use ‪TYPO3\CMS\Core\Configuration\Features;
use ‪TYPO3\CMS\Core\Configuration\SiteConfiguration;
use ‪TYPO3\CMS\Core\Context\Context;
use ‪TYPO3\CMS\Core\Core\BootService;
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\EventDispatcher\NoopEventDispatcher;
use ‪TYPO3\CMS\Core\ExpressionLanguage\DefaultProvider;
use ‪TYPO3\CMS\Core\ExpressionLanguage\ProviderConfigurationLoader;
use ‪TYPO3\CMS\Core\Information\Typo3Version;
use ‪TYPO3\CMS\Core\Package\Package;
use TYPO3\CMS\Core\Package\PackageManager;
use ‪TYPO3\CMS\Core\Registry;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
use ‪TYPO3\CMS\Core\Utility\StringUtility;
use ‪TYPO3\CMS\Extensionmanager\Utility\InstallUtility;
use TYPO3\TestingFramework\Core\AccessibleObjectInterface;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪InstallUtilityTest extends UnitTestCase
{
    protected string ‪$extensionKey;
    protected array ‪$extensionData = [];
 
    protected array ‪$fakedExtensions = [];
 
    protected bool ‪$backupEnvironment = true;
    protected bool ‪$resetSingletonInstances = true;
 
    protected ‪InstallUtility&MockObject&AccessibleObjectInterface ‪$installMock;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $this->extensionKey = 'dummy';
        $this->extensionData = [
            'key' => ‪$this->extensionKey,
            'packagePath' => '',
        ];
        $this->installMock = $this->getAccessibleMock(
            InstallUtility::class,
            [
                'loadExtension',
                'unloadExtension',
                'updateDatabase',
                'importStaticSqlFile',
                'importT3DFile',
                'reloadCaches',
                'processExtensionSetup',
                'saveDefaultConfiguration',
                'getExtensionArray',
                'enrichExtensionWithDetails',
                'importInitialFiles',
            ]
        );
        $eventDispatcher = new ‪NoopEventDispatcher();
        $this->installMock->injectEventDispatcher($eventDispatcher);
        $this->installMock->injectBootService($this->createMock(BootService::class));
        $containerMock = $this->createMock(ContainerInterface::class);
        $containerMock->method('get')->with(EventDispatcherInterface::class)->willReturn($eventDispatcher);
        $bootServiceMock = $this->createMock(BootService::class);
        $bootServiceMock->method('getContainer')->with(false)->willReturn($containerMock);
        $bootServiceMock->method('makeCurrent')->with(self::anything())->willReturn([]);
        $this->installMock->injectBootService($bootServiceMock);
        $this->installMock
            ->method('getExtensionArray')
            ->with($this->extensionKey)
            ->willReturnCallback($this->‪getExtensionData(...));
        $this->installMock
            ->method('enrichExtensionWithDetails')
            ->with($this->extensionKey)
            ->willReturnCallback($this->‪getExtensionData(...));
 
        $cacheManagerMock = $this->createMock(CacheManager::class);
        $cacheManagerMock->method('getCache')->with('core')->willReturn(new ‪NullFrontend('core'));
        GeneralUtility::setSingletonInstance(CacheManager::class, $cacheManagerMock);
    }
 
    protected function ‪tearDown(): void
    {
        foreach ($this->fakedExtensions as $fakeExtkey => $fakeExtension) {
            $this->testFilesToDelete[] = ‪Environment::getVarPath() . '/tests/' . $fakeExtkey;
        }
        parent::tearDown();
    }
 
    public function ‪getExtensionData(): array
    {
        return ‪$this->extensionData;
    }
 
    protected function ‪createFakeExtension(): string
    {
        $extKey = strtolower(‪StringUtility::getUniqueId('testing'));
        $absExtPath = ‪Environment::getVarPath() . '/tests/' . $extKey;
        ‪GeneralUtility::mkdir_deep($absExtPath);
        $this->fakedExtensions[$extKey] = [
            'packagePath' => $absExtPath,
        ];
        return $extKey;
    }
 
    public function ‪installCallsUpdateDatabase(): void
    {
        $this->installMock->expects(self::once())->method('updateDatabase');
 
        $cacheManagerMock = $this->getMockBuilder(CacheManager::class)->getMock();
        $this->installMock->_set('cacheManager', $cacheManagerMock);
        $this->installMock->install($this->extensionKey);
    }
 
    public function ‪installCallsLoadExtension(): void
    {
        $cacheManagerMock = $this->getMockBuilder(CacheManager::class)->getMock();
        $this->installMock->_set('cacheManager', $cacheManagerMock);
        $this->installMock->expects(self::once())->method('loadExtension');
        $this->installMock->install($this->extensionKey);
    }
 
    public function ‪installCallsFlushCaches(): void
    {
        $cacheManagerMock = $this->getMockBuilder(CacheManager::class)->getMock();
        $cacheManagerMock->expects(self::once())->method('flushCaches');
        $this->installMock->_set('cacheManager', $cacheManagerMock);
        $this->installMock->install($this->extensionKey);
    }
 
    public function ‪installCallsReloadCaches(): void
    {
        $cacheManagerMock = $this->getMockBuilder(CacheManager::class)->getMock();
        $this->installMock->_set('cacheManager', $cacheManagerMock);
        $this->installMock->expects(self::once())->method('reloadCaches');
        $this->installMock->install($this->extensionKey);
    }
 
    public function ‪installCallsSaveDefaultConfigurationWithExtensionKey(): void
    {
        $cacheManagerMock = $this->getMockBuilder(CacheManager::class)->getMock();
        $this->installMock->_set('cacheManager', $cacheManagerMock);
        $this->installMock->expects(self::once())->method('saveDefaultConfiguration')->with($this->extensionKey);
        $this->installMock->install($this->extensionKey);
    }
 
    public static function ‪importT3DFileDoesNotImportFileIfAlreadyImportedDataProvider(): array
    {
        return [
            'Import T3D file when T3D was imported before extension to XML' => [
                'data.t3d',
                'dataImported',
                'data.t3d',
            ],
            'Import T3D file when a file was imported after extension to XML' => [
                'data.t3d',
                'data.t3d',
                'dataImported',
            ],
            'Import XML file when T3D was imported before extension to XML' => [
                'data.xml',
                'dataImported',
                'data.t3d',
            ],
            'Import XML file when a file was imported after extension to XML' => [
                'data.xml',
                'data.t3d',
                'dataImported',
            ],
        ];
    }
 
    public function ‪importT3DFileDoesNotImportFileIfAlreadyImported($fileName, $registryNameReturnsFalse, $registryNameReturnsTrue): void
    {
        $extKey = $this->‪createFakeExtension();
        $absPath = $this->fakedExtensions[$extKey]['packagePath'];
        $relPath = ‪PathUtility::stripPathSitePrefix($absPath);
        ‪GeneralUtility::mkdir($absPath . 'Initialisation');
        file_put_contents($absPath . 'Initialisation/' . $fileName, 'DUMMY');
        $registryMock = $this->getMockBuilder(Registry::class)
            ->onlyMethods(['get', 'set'])
            ->getMock();
        $registryMock
            ->method('get')
            ->willReturnMap(
                [
                    ['extensionDataImport', $relPath . 'Initialisation/' . $registryNameReturnsFalse, null, false],
                    ['extensionDataImport', $relPath . 'Initialisation/' . $registryNameReturnsTrue, null, true],
                ]
            );
        ‪$installMock = $this->getAccessibleMock(
            InstallUtility::class,
            ['getRegistry', 'getImportExportUtility'],
            [],
            '',
            false
        );
        ‪$installMock->_set('registry', $registryMock);
        ‪$installMock->expects(self::never())->method('getImportExportUtility');
        ‪$installMock->_call('importT3DFile', $extKey, $this->fakedExtensions[$extKey]['packagePath']);
    }
 
    public function ‪siteConfigGetsMovedIntoPlace(): void
    {
        // prepare an extension with a shipped site config
        $extKey = $this->‪createFakeExtension();
        $absPath = $this->fakedExtensions[$extKey]['packagePath'];
        $config = Yaml::dump(['dummy' => true]);
        ‪$siteIdentifier = 'site_identifier';
        ‪GeneralUtility::mkdir_deep($absPath . 'Initialisation/Site/' . ‪$siteIdentifier);
        file_put_contents($absPath . 'Initialisation/Site/' . ‪$siteIdentifier . '/config.yaml', $config);
 
        GeneralUtility::setSingletonInstance(
            SiteConfiguration::class,
            new ‪SiteConfiguration(
                ‪Environment::getConfigPath() . '/sites',
                new class () implements EventDispatcherInterface {
                    public function dispatch(object $event)
                    {
                        return $event;
                    }
                },
                new ‪NullFrontend('core')
            )
        );
 
        $packageMock = $this->getMockBuilder(Package::class)
            ->disableOriginalConstructor()
            ->getMock();
        $packageManagerMock = $this->getMockBuilder(PackageManager::class)
           ->disableOriginalConstructor()
           ->getMock();
        $packageMock
            ->method('getPackagePath')
            ->willReturn($absPath);
        $packageManagerMock
            ->method('getPackage')
            ->with(self::equalTo($extKey))
            ->willReturn($packageMock);
 
        $subject = new ‪InstallUtility();
        $subject->injectEventDispatcher(new ‪NoopEventDispatcher());
        $subject->injectPackageManager($packageManagerMock);
 
        $registry = $this->createMock(Registry::class);
        $registry->method('get')->willReturnMap([
            ['extensionDataImport', self::anything(), 'some folder name'],
            ['siteConfigImport', self::anything(), null],
        ]);
        $registry->expects(self::atLeastOnce())->method('set')->withConsecutive(
            ['extensionDataImport', self::anything()],
            ['siteConfigImport', self::anything()],
            ['siteConfigImport', ‪$siteIdentifier, 1],
        );
 
        $subject->injectRegistry($registry);
 
        $providerConfigurationLoader = $this->createMock(ProviderConfigurationLoader::class);
        GeneralUtility::addInstance(ProviderConfigurationLoader::class, $providerConfigurationLoader);
        GeneralUtility::addInstance(ProviderConfigurationLoader::class, $providerConfigurationLoader);
        $defaultProvider = new ‪DefaultProvider(new ‪Typo3Version(), new ‪Context(), new ‪Features());
        GeneralUtility::addInstance(DefaultProvider::class, $defaultProvider);
        GeneralUtility::addInstance(DefaultProvider::class, $defaultProvider);
 
        // provide function result inside test output folder
        $environment = new ‪Environment();
        $configDir = $absPath . 'Result/config';
        if (!file_exists($configDir)) {
            ‪GeneralUtility::mkdir_deep($configDir);
        }
        $environment::initialize(
            ‪Environment::getContext(),
            ‪Environment::isCli(),
            ‪Environment::isComposerMode(),
            ‪Environment::getProjectPath(),
            ‪Environment::getPublicPath(),
            ‪Environment::getVarPath(),
            $configDir,
            ‪Environment::getCurrentScript(),
            'UNIX'
        );
        $subject->processExtensionSetup($extKey);
 
        $siteConfigFile = $configDir . '/sites/' . ‪$siteIdentifier . '/config.yaml';
        self::assertFileExists($siteConfigFile);
        self::assertStringEqualsFile($siteConfigFile, $config);
        GeneralUtility::purgeInstances();
    }
 
    public function ‪siteConfigGetsNotOverriddenIfExistsAlready(): void
    {
        // prepare an extension with a shipped site config
        $extKey = $this->‪createFakeExtension();
        $absPath = $this->fakedExtensions[$extKey]['packagePath'];
        ‪$siteIdentifier = 'site_identifier';
        ‪GeneralUtility::mkdir_deep($absPath . 'Initialisation/Site/' . ‪$siteIdentifier);
        file_put_contents($absPath . 'Initialisation/Site/' . ‪$siteIdentifier . '/config.yaml', Yaml::dump(['dummy' => true]));
 
        // fake an already existing site config in test output folder
        $configDir = $absPath . 'Result/config';
        if (!file_exists($configDir)) {
            ‪GeneralUtility::mkdir_deep($configDir);
        }
        $config = Yaml::dump(['foo' => 'bar']);
        $existingSiteConfig = 'sites/' . ‪$siteIdentifier . '/config.yaml';
        ‪GeneralUtility::mkdir_deep($configDir . '/sites/' . ‪$siteIdentifier);
        file_put_contents($configDir . '/' . $existingSiteConfig, $config);
 
        GeneralUtility::setSingletonInstance(
            SiteConfiguration::class,
            new ‪SiteConfiguration(
                ‪Environment::getConfigPath() . '/sites',
                new class () implements EventDispatcherInterface {
                    public function dispatch(object $event)
                    {
                        return $event;
                    }
                },
                new ‪NullFrontend('core')
            )
        );
        $packageMock = $this->getMockBuilder(Package::class)
            ->disableOriginalConstructor()
            ->getMock();
        $packageManagerMock = $this->getMockBuilder(PackageManager::class)
            ->disableOriginalConstructor()
            ->getMock();
        $packageMock
            ->method('getPackagePath')
            ->willReturn($absPath);
        $packageManagerMock
            ->method('getPackage')
            ->with(self::equalTo($extKey))
            ->willReturn($packageMock);
 
        $subject = new ‪InstallUtility();
        $subject->injectEventDispatcher(new ‪NoopEventDispatcher());
        $subject->injectPackageManager($packageManagerMock);
 
        $registry = $this->createMock(Registry::class);
        $registry->method('get')->willReturnMap([
            ['extensionDataImport', self::anything(), 'some folder name'],
            ['siteConfigImport', self::anything(), null],
        ]);
        // Note, that test will fail if `set` is called with `siteConfigImport` as first argument.
        $registry->expects(self::atLeastOnce())->method('set')->with('extensionDataImport', self::anything());
        $subject->injectRegistry($registry);
 
        $providerConfigurationLoader = $this->createMock(ProviderConfigurationLoader::class);
        GeneralUtility::addInstance(ProviderConfigurationLoader::class, $providerConfigurationLoader);
        GeneralUtility::addInstance(ProviderConfigurationLoader::class, $providerConfigurationLoader);
        $defaultProvider = new ‪DefaultProvider(new ‪Typo3Version(), new ‪Context(), new ‪Features());
        GeneralUtility::addInstance(DefaultProvider::class, $defaultProvider);
        GeneralUtility::addInstance(DefaultProvider::class, $defaultProvider);
 
        $environment = new ‪Environment();
 
        $environment::initialize(
            ‪Environment::getContext(),
            ‪Environment::isCli(),
            ‪Environment::isComposerMode(),
            ‪Environment::getProjectPath(),
            ‪Environment::getPublicPath(),
            ‪Environment::getVarPath(),
            $configDir,
            ‪Environment::getCurrentScript(),
            'UNIX'
        );
        $subject->processExtensionSetup($extKey);
 
        $siteConfigFile = $configDir . '/sites/' . ‪$siteIdentifier . '/config.yaml';
        self::assertFileExists($siteConfigFile);
        self::assertStringEqualsFile($siteConfigFile, $config);
        GeneralUtility::purgeInstances();
    }
}