BackendConfigurationManagerTest.php

Go to the documentation of this file.

<?php
 
/*
 * 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\Extbase\Tests\Unit\Configuration;
 
use Prophecy\Prophecy\ObjectProphecy;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Database\QueryGenerator;
use ‪TYPO3\CMS\Core\TypoScript\TypoScriptService;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Configuration\BackendConfigurationManager;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪BackendConfigurationManagerTest extends UnitTestCase
{
    protected ‪$backendConfigurationManager;
 
    protected ‪$mockTypoScriptService;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $this->backendConfigurationManager = $this->getAccessibleMock(
            BackendConfigurationManager::class,
            ['getTypoScriptSetup'],
            [],
            '',
            false
        );
        $this->mockTypoScriptService = $this->getMockBuilder(TypoScriptService::class)->getMock();
        $this->backendConfigurationManager->_set('typoScriptService', $this->mockTypoScriptService);
    }
 
    public function ‪getCurrentPageIdReturnsPageIdFromGet()
    {
        $_GET['id'] = 123;
        $expectedResult = 123;
        $actualResult = $this->backendConfigurationManager->_call('getCurrentPageId');
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getCurrentPageIdReturnsPageIdFromPost()
    {
        $_GET['id'] = 123;
        $_POST['id'] = 321;
        $expectedResult = 321;
        $actualResult = $this->backendConfigurationManager->_call('getCurrentPageId');
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getPluginConfigurationReturnsEmptyArrayIfNoPluginConfigurationWasFound()
    {
        $this->backendConfigurationManager->expects(self::once())->method('getTypoScriptSetup')->willReturn(['foo' => 'bar']);
        $expectedResult = [];
        $actualResult = $this->backendConfigurationManager->_call('getPluginConfiguration', 'SomeExtensionName', 'SomePluginName');
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getPluginConfigurationReturnsExtensionConfiguration()
    {
        $testSettings = [
            'settings.' => [
                'foo' => 'bar'
            ]
        ];
        $testSettingsConverted = [
            'settings' => [
                'foo' => 'bar'
            ]
        ];
        $testSetup = [
            'module.' => [
                'tx_someextensionname.' => $testSettings
            ]
        ];
        $this->mockTypoScriptService->expects(self::any())->method('convertTypoScriptArrayToPlainArray')->with($testSettings)->willReturn($testSettingsConverted);
        $this->backendConfigurationManager->expects(self::once())->method('getTypoScriptSetup')->willReturn($testSetup);
        $expectedResult = [
            'settings' => [
                'foo' => 'bar'
            ]
        ];
        $actualResult = $this->backendConfigurationManager->_call('getPluginConfiguration', 'SomeExtensionName');
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getPluginConfigurationReturnsPluginConfiguration()
    {
        $testSettings = [
            'settings.' => [
                'foo' => 'bar'
            ]
        ];
        $testSettingsConverted = [
            'settings' => [
                'foo' => 'bar'
            ]
        ];
        $testSetup = [
            'module.' => [
                'tx_someextensionname_somepluginname.' => $testSettings
            ]
        ];
        $this->mockTypoScriptService->expects(self::any())->method('convertTypoScriptArrayToPlainArray')->with($testSettings)->willReturn($testSettingsConverted);
        $this->backendConfigurationManager->expects(self::once())->method('getTypoScriptSetup')->willReturn($testSetup);
        $expectedResult = [
            'settings' => [
                'foo' => 'bar'
            ]
        ];
        $actualResult = $this->backendConfigurationManager->_call('getPluginConfiguration', 'SomeExtensionName', 'SomePluginName');
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getPluginConfigurationRecursivelyMergesExtensionAndPluginConfiguration()
    {
        $testExtensionSettings = [
            'settings.' => [
                'foo' => 'bar',
                'some.' => [
                    'nested' => 'value'
                ]
            ]
        ];
        $testExtensionSettingsConverted = [
            'settings' => [
                'foo' => 'bar',
                'some' => [
                    'nested' => 'value'
                ]
            ]
        ];
        $testPluginSettings = [
            'settings.' => [
                'some.' => [
                    'nested' => 'valueOverride',
                    'new' => 'value'
                ]
            ]
        ];
        $testPluginSettingsConverted = [
            'settings' => [
                'some' => [
                    'nested' => 'valueOverride',
                    'new' => 'value'
                ]
            ]
        ];
        $testSetup = [
            'module.' => [
                'tx_someextensionname.' => $testExtensionSettings,
                'tx_someextensionname_somepluginname.' => $testPluginSettings
            ]
        ];
        $this->mockTypoScriptService->expects(self::exactly(2))->method('convertTypoScriptArrayToPlainArray')
            ->withConsecutive([$testExtensionSettings], [$testPluginSettings])
            ->willReturnOnConsecutiveCalls($testExtensionSettingsConverted, $testPluginSettingsConverted);
        $this->backendConfigurationManager->expects(self::once())->method('getTypoScriptSetup')->willReturn($testSetup);
        $expectedResult = [
            'settings' => [
                'foo' => 'bar',
                'some' => [
                    'nested' => 'valueOverride',
                    'new' => 'value'
                ]
            ]
        ];
        $actualResult = $this->backendConfigurationManager->_call('getPluginConfiguration', 'SomeExtensionName', 'SomePluginName');
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getControllerConfigurationReturnsEmptyArrayByDefault()
    {
        ‪$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['extbase'] = null;
        $expectedResult = [];
        $actualResult = $this->backendConfigurationManager->_call('getControllerConfiguration', 'SomeExtensionName', 'SomePluginName');
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getControllerConfigurationReturnsConfigurationStoredInExtconf()
    {
        $controllerConfiguration = [
            'Controller1' => [
                'actions' => [
                    'action1',
                    'action2'
                ],
                'nonCacheableActions' => [
                    'action1'
                ]
            ],
            'Controller2' => [
                'actions' => [
                    'action3',
                    'action4'
                ]
            ]
        ];
        ‪$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['extbase']['extensions']['SomeExtensionName']['modules']['SomePluginName']['controllers'] = $controllerConfiguration;
        $expectedResult = $controllerConfiguration;
        $actualResult = $this->backendConfigurationManager->_call('getControllerConfiguration', 'SomeExtensionName', 'SomePluginName');
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪storagePidsAreExtendedIfRecursiveSearchIsConfigured()
    {
        $storagePids = [1, 2, 3];
        $recursive = 99;
 
        $beUserAuthentication = $this->prophesize(BackendUserAuthentication::class);
        $beUserAuthentication->getPagePermsClause(1)->willReturn('1=1');
        ‪$GLOBALS['BE_USER'] = $beUserAuthentication->reveal();
 
        $abstractConfigurationManager = $this->getAccessibleMock(
            BackendConfigurationManager::class,
            ['getContextSpecificFrameworkConfiguration', 'getTypoScriptSetup', 'getPluginConfiguration', 'getControllerConfiguration'],
            [],
            '',
            false
        );
        $queryGenerator = $this->createMock(QueryGenerator::class);
        $queryGenerator->expects(self::any())
            ->method('getTreeList')
            ->will(self::onConsecutiveCalls('4', '', '5,6'));
        GeneralUtility::addInstance(QueryGenerator::class, $queryGenerator);
 
        $expectedResult = [4, 5, 6];
        $actualResult = $abstractConfigurationManager->_call('getRecursiveStoragePids', $storagePids, $recursive);
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪storagePidsAreExtendedIfRecursiveSearchIsConfiguredAndWithPidIncludedForNegativePid()
    {
        $storagePids = [1, 2, -3];
        $recursive = 99;
 
        $beUserAuthentication = $this->prophesize(BackendUserAuthentication::class);
        $beUserAuthentication->getPagePermsClause(1)->willReturn('1=1');
        ‪$GLOBALS['BE_USER'] = $beUserAuthentication->reveal();
 
        $abstractConfigurationManager = $this->getAccessibleMock(
            BackendConfigurationManager::class,
            ['getContextSpecificFrameworkConfiguration', 'getTypoScriptSetup', 'getPluginConfiguration', 'getControllerConfiguration', 'getQueryGenerator'],
            [],
            '',
            false
        );
        $queryGenerator = $this->createMock(QueryGenerator::class);
        $queryGenerator->expects(self::any())
            ->method('getTreeList')
            ->will(self::onConsecutiveCalls('4', '', '3,5,6'));
        GeneralUtility::addInstance(QueryGenerator::class, $queryGenerator);
 
        $expectedResult = [4, 3, 5, 6];
        $actualResult = $abstractConfigurationManager->_call('getRecursiveStoragePids', $storagePids, $recursive);
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪storagePidsAreNotExtendedIfRecursiveSearchIsNotConfigured()
    {
        $storagePids = [1, 2, 3];
 
        $abstractConfigurationManager = $this->getAccessibleMock(
            BackendConfigurationManager::class,
            ['getContextSpecificFrameworkConfiguration', 'getTypoScriptSetup', 'getPluginConfiguration', 'getControllerConfiguration'],
            [],
            '',
            false
        );
 
        $expectedResult = [1, 2, 3];
        $actualResult = $abstractConfigurationManager->_call('getRecursiveStoragePids', $storagePids);
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪storagePidsAreNotExtendedIfRecursiveSearchIsConfiguredForZeroLevels()
    {
        $storagePids = [1, 2, 3];
        $recursive = 0;
 
        $abstractConfigurationManager = $this->getAccessibleMock(
            BackendConfigurationManager::class,
            ['getContextSpecificFrameworkConfiguration', 'getTypoScriptSetup', 'getPluginConfiguration', 'getControllerConfiguration'],
            [],
            '',
            false
        );
 
        $expectedResult = [1, 2, 3];
        $actualResult = $abstractConfigurationManager->_call('getRecursiveStoragePids', $storagePids, $recursive);
        self::assertEquals($expectedResult, $actualResult);
    }
}