9.5/_utility_2_install_utility_test_8php_source.html

<?php

declare(strict_types = 1);

namespace ‪TYPO3\CMS\Extensionmanager\Tests\Unit\Utility;


/*

 * 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\Cache\CacheManager;

use ‪TYPO3\CMS\Core\Core\Environment;

use ‪TYPO3\CMS\Core\Registry;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use ‪TYPO3\CMS\Extensionmanager\Utility\DependencyUtility;

use ‪TYPO3\CMS\Extensionmanager\Utility\InstallUtility;

use TYPO3\TestingFramework\Core\Unit\UnitTestCase;


class ‪InstallUtilityTest extends UnitTestCase

{

    protected ‪$extensionKey;


    protected ‪$extensionData = [];


    protected ‪$fakedExtensions = [];


    protected ‪$installMock;


    protected function ‪setUp()

    {

        $this->extensionKey = 'dummy';

        $this->extensionData = [

            'key' => ‪$this->extensionKey,

            'siteRelPath' => '',

        ];

        $this->installMock = $this->getAccessibleMock(

            InstallUtility::class,

            [

                'isLoaded',

                'loadExtension',

                'unloadExtension',

                'updateDatabase',

                'importStaticSqlFile',

                'importT3DFile',

                'reloadCaches',

                'processCachingFrameworkUpdates',

                'saveDefaultConfiguration',

                'getExtensionArray',

                'enrichExtensionWithDetails',

                'ensureConfiguredDirectoriesExist',

                'importInitialFiles',

                'emitAfterExtensionInstallSignal',

            ],

            [],

            '',

            false

        );

        $dependencyUtility = $this->getMockBuilder(DependencyUtility::class)->getMock();

        $this->installMock->_set('dependencyUtility', $dependencyUtility);

        $this->installMock->expects($this->any())

            ->method('getExtensionArray')

            ->with($this->extensionKey)

            ->will($this->returnCallback([$this, 'getExtensionData']));

        $this->installMock->expects($this->any())

            ->method('enrichExtensionWithDetails')

            ->with($this->extensionKey)

            ->will($this->returnCallback([$this, 'getExtensionData']));

    }


    public function ‪getExtensionData(): array

    {

        return ‪$this->extensionData;

    }


    protected function ‪tearDown()

    {

        foreach ($this->fakedExtensions as $fakeExtkey => $fakeExtension) {

            $this->testFilesToDelete[] = ‪Environment::getVarPath() . '/tests/' . $fakeExtkey;

        }

        parent::tearDown();

    }


    protected function ‪createFakeExtension(): string

    {

        $extKey = strtolower($this->getUniqueId('testing'));

        $absExtPath = ‪Environment::getVarPath() . '/tests/' . $extKey;

        $relPath = 'typo3temp/var/tests/' . $extKey . '/';

        GeneralUtility::mkdir($absExtPath);

        $this->fakedExtensions[$extKey] = [

            'siteRelPath' => $relPath

        ];

        return $extKey;

    }


    public function ‪installCallsUpdateDatabase()

    {

        $this->installMock->expects($this->once())

            ->method('updateDatabase')

            ->with([$this->extensionKey]);


        $cacheManagerMock = $this->getMockBuilder(CacheManager::class)->getMock();

        $cacheManagerMock->expects($this->once())->method('flushCachesInGroup');

        $this->installMock->_set('cacheManager', $cacheManagerMock);

        $this->installMock->install($this->extensionKey);

    }


    public function ‪installCallsLoadExtension()

    {

        $cacheManagerMock = $this->getMockBuilder(CacheManager::class)->getMock();

        $cacheManagerMock->expects($this->once())->method('flushCachesInGroup');

        $this->installMock->_set('cacheManager', $cacheManagerMock);

        $this->installMock->expects($this->once())->method('loadExtension');

        $this->installMock->install($this->extensionKey);

    }


    public function ‪installCallsFlushCachesIfClearCacheOnLoadIsSet()

    {

        $this->extensionData['clearcacheonload'] = true;

        $cacheManagerMock = $this->getMockBuilder(CacheManager::class)->getMock();

        $cacheManagerMock->expects($this->once())->method('flushCaches');

        $this->installMock->_set('cacheManager', $cacheManagerMock);

        $this->installMock->install($this->extensionKey);

    }


    public function ‪installCallsFlushCachesIfClearCacheOnLoadCamelCasedIsSet()

    {

        $this->extensionData['clearCacheOnLoad'] = true;

        $cacheManagerMock = $this->getMockBuilder(CacheManager::class)->getMock();

        $cacheManagerMock->expects($this->once())->method('flushCaches');

        $this->installMock->_set('cacheManager', $cacheManagerMock);

        $this->installMock->install($this->extensionKey);

    }


    public function ‪installationOfAnExtensionWillCallEnsureThatDirectoriesExist()

    {

        $cacheManagerMock = $this->getMockBuilder(CacheManager::class)->getMock();

        $cacheManagerMock->expects($this->once())->method('flushCachesInGroup');

        $this->installMock->_set('cacheManager', $cacheManagerMock);

        $this->installMock->expects($this->once())->method('ensureConfiguredDirectoriesExist');

        $this->installMock->install($this->extensionKey);

    }


    public function ‪installCallsReloadCaches()

    {

        $cacheManagerMock = $this->getMockBuilder(CacheManager::class)->getMock();

        $cacheManagerMock->expects($this->once())->method('flushCachesInGroup');

        $this->installMock->_set('cacheManager', $cacheManagerMock);

        $this->installMock->expects($this->once())->method('reloadCaches');

        $this->installMock->install($this->extensionKey);

    }


    public function ‪installCallsSaveDefaultConfigurationWithExtensionKey()

    {

        $cacheManagerMock = $this->getMockBuilder(CacheManager::class)->getMock();

        $cacheManagerMock->expects($this->once())->method('flushCachesInGroup');

        $this->installMock->_set('cacheManager', $cacheManagerMock);

        $this->installMock->expects($this->once())->method('saveDefaultConfiguration')->with($this->extensionKey);

        $this->installMock->install($this->extensionKey);

    }


    public function ‪uninstallCallsUnloadExtension()

    {

        $this->installMock->expects($this->once())->method('unloadExtension');

        $this->installMock->uninstall($this->extensionKey);

    }


    public 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)

    {

        $extKey = $this->‪createFakeExtension();

        $absPath = ‪Environment::getPublicPath() . '/' . $this->fakedExtensions[$extKey]['siteRelPath'];

        GeneralUtility::mkdir($absPath . 'Initialisation');

        file_put_contents($absPath . 'Initialisation/' . $fileName, 'DUMMY');

        $registryMock = $this->getMockBuilder(Registry::class)

            ->setMethods(['get', 'set'])

            ->getMock();

        $registryMock

            ->expects($this->any())

            ->method('get')

            ->will($this->returnValueMap(

                [

                    ['extensionDataImport', $this->fakedExtensions[$extKey]['siteRelPath'] . 'Initialisation/' . $registryNameReturnsFalse, null, false],

                    ['extensionDataImport', $this->fakedExtensions[$extKey]['siteRelPath'] . 'Initialisation/' . $registryNameReturnsTrue, null, true],

                ]

            ));

        ‪$installMock = $this->getAccessibleMock(

            InstallUtility::class,

            ['getRegistry', 'getImportExportUtility'],

            [],

            '',

            false

        );

        $dependencyUtility = $this->getMockBuilder(DependencyUtility::class)->getMock();

        ‪$installMock->_set('dependencyUtility', $dependencyUtility);

        ‪$installMock->_set('registry', $registryMock);

        ‪$installMock->expects($this->never())->method('getImportExportUtility');

        ‪$installMock->_call('importT3DFile', $this->fakedExtensions[$extKey]['siteRelPath']);

    }

}