FrontendConfigurationManagerTest.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\Extbase\Tests\Unit\Configuration;
 
use PHPUnit\Framework\MockObject\MockObject;
use ‪TYPO3\CMS\Core\Service\FlexFormService;
use ‪TYPO3\CMS\Core\TypoScript\TypoScriptService;
use ‪TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager;
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
use TYPO3\TestingFramework\Core\AccessibleObjectInterface;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪FrontendConfigurationManagerTest extends UnitTestCase
{
    protected ‪$mockContentObject;
 
    protected ‪$frontendConfigurationManager;
 
    protected ‪$mockTypoScriptService;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        ‪$GLOBALS['TSFE'] = new \stdClass();
        ‪$GLOBALS['TSFE']->tmpl = new \stdClass();
        $this->mockContentObject = $this->getMockBuilder(ContentObjectRenderer::class)
            ->onlyMethods(['getTreeList'])
            ->getMock();
        $this->frontendConfigurationManager = $this->getAccessibleMock(
            FrontendConfigurationManager::class,
            ['dummy'],
            [],
            '',
            false
        );
        $this->frontendConfigurationManager->_set('contentObject', $this->mockContentObject);
        $this->mockTypoScriptService = $this->getMockBuilder(TypoScriptService::class)->getMock();
        $this->frontendConfigurationManager->_set('typoScriptService', $this->mockTypoScriptService);
    }
 
    public function ‪getTypoScriptSetupReturnsSetupFromTsfe(): void
    {
        ‪$GLOBALS['TSFE']->tmpl->setup = ['foo' => 'bar'];
        self::assertEquals(['foo' => 'bar'], $this->frontendConfigurationManager->_call('getTypoScriptSetup'));
    }
 
    public function ‪getPluginConfigurationReturnsEmptyArrayIfNoPluginConfigurationWasFound(): void
    {
        ‪$GLOBALS['TSFE']->tmpl->setup = ['foo' => 'bar'];
        $expectedResult = [];
        $actualResult = $this->frontendConfigurationManager->_call(
            'getPluginConfiguration',
            'SomeExtensionName',
            'SomePluginName'
        );
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getPluginConfigurationReturnsExtensionConfiguration(): void
    {
        $testSettings = [
            'settings.' => [
                'foo' => 'bar',
            ],
        ];
        $testSettingsConverted = [
            'settings' => [
                'foo' => 'bar',
            ],
        ];
        $testSetup = [
            'plugin.' => [
                'tx_someextensionname.' => $testSettings,
            ],
        ];
        $this->mockTypoScriptService->method('convertTypoScriptArrayToPlainArray')->with($testSettings)->willReturn($testSettingsConverted);
        ‪$GLOBALS['TSFE']->tmpl->setup = $testSetup;
        $expectedResult = [
            'settings' => [
                'foo' => 'bar',
            ],
        ];
        $actualResult = $this->frontendConfigurationManager->_call('getPluginConfiguration', 'SomeExtensionName');
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getPluginConfigurationReturnsPluginConfiguration(): void
    {
        $testSettings = [
            'settings.' => [
                'foo' => 'bar',
            ],
        ];
        $testSettingsConverted = [
            'settings' => [
                'foo' => 'bar',
            ],
        ];
        $testSetup = [
            'plugin.' => [
                'tx_someextensionname_somepluginname.' => $testSettings,
            ],
        ];
        $this->mockTypoScriptService->method('convertTypoScriptArrayToPlainArray')->with($testSettings)->willReturn($testSettingsConverted);
        ‪$GLOBALS['TSFE']->tmpl->setup = $testSetup;
        $expectedResult = [
            'settings' => [
                'foo' => 'bar',
            ],
        ];
        $actualResult = $this->frontendConfigurationManager->_call(
            'getPluginConfiguration',
            'SomeExtensionName',
            'SomePluginName'
        );
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getPluginConfigurationRecursivelyMergesExtensionAndPluginConfiguration(): void
    {
        $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 = [
            'plugin.' => [
                'tx_someextensionname.' => $testExtensionSettings,
                'tx_someextensionname_somepluginname.' => $testPluginSettings,
            ],
        ];
        $this->mockTypoScriptService->expects(self::exactly(2))->method('convertTypoScriptArrayToPlainArray')
            ->withConsecutive([$testExtensionSettings], [$testPluginSettings])
            ->willReturnOnConsecutiveCalls($testExtensionSettingsConverted, $testPluginSettingsConverted);
        ‪$GLOBALS['TSFE']->tmpl->setup = $testSetup;
        $expectedResult = [
            'settings' => [
                'foo' => 'bar',
                'some' => [
                    'nested' => 'valueOverride',
                    'new' => 'value',
                ],
            ],
        ];
        $actualResult = $this->frontendConfigurationManager->_call(
            'getPluginConfiguration',
            'SomeExtensionName',
            'SomePluginName'
        );
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getControllerConfigurationReturnsEmptyArrayByDefault(): void
    {
        ‪$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['extbase'] = null;
        $expectedResult = [];
        $actualResult = $this->frontendConfigurationManager->_call(
            'getControllerConfiguration',
            'SomeExtensionName',
            'SomePluginName'
        );
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getControllerConfigurationReturnsConfigurationStoredInExtconf(): void
    {
        $controllerConfiguration = [
            'Controller1' => [
                'actions' => [
                    'action1',
                    'action2',
                ],
                'nonCacheableActions' => [
                    'action1',
                ],
            ],
            'Controller2' => [
                'actions' => [
                    'action3',
                    'action4',
                ],
            ],
        ];
        ‪$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['extbase']['extensions']['SomeExtensionName']['plugins']['SomePluginName']['controllers'] = $controllerConfiguration;
        $expectedResult = $controllerConfiguration;
        $actualResult = $this->frontendConfigurationManager->_call(
            'getControllerConfiguration',
            'SomeExtensionName',
            'SomePluginName'
        );
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getContextSpecificFrameworkConfigurationCorrectlyCallsOverrideMethods(): void
    {
        $frameworkConfiguration = [
            'some' => [
                'framework' => 'configuration',
            ],
        ];
        ‪$frontendConfigurationManager = $this->getAccessibleMock(
            FrontendConfigurationManager::class,
            [
                'overrideStoragePidIfStartingPointIsSet',
                'overrideConfigurationFromPlugin',
                'overrideConfigurationFromFlexForm',
            ],
            [],
            '',
            false
        );
        ‪$frontendConfigurationManager->expects(self::once())->method('overrideStoragePidIfStartingPointIsSet')->with($frameworkConfiguration)->willReturn(['overridden' => 'storagePid']);
        ‪$frontendConfigurationManager->expects(self::once())->method('overrideConfigurationFromPlugin')->with(['overridden' => 'storagePid'])->willReturn(['overridden' => 'pluginConfiguration']);
        ‪$frontendConfigurationManager->expects(self::once())->method('overrideConfigurationFromFlexForm')->with(['overridden' => 'pluginConfiguration'])->willReturn(['overridden' => 'flexFormConfiguration']);
        $expectedResult = ['overridden' => 'flexFormConfiguration'];
        $actualResult = ‪$frontendConfigurationManager->_call(
            'getContextSpecificFrameworkConfiguration',
            $frameworkConfiguration
        );
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪storagePidsAreExtendedIfRecursiveSearchIsConfigured(): void
    {
        $storagePids = [3, 5, 9];
        $recursive = 99;
        $abstractConfigurationManager = $this->getAccessibleMock(
            FrontendConfigurationManager::class,
            [
                'getContextSpecificFrameworkConfiguration',
                'getTypoScriptSetup',
                'getPluginConfiguration',
                'getControllerConfiguration',
            ],
            [],
            '',
            false
        );
        $cObjectMock = $this->createMock(ContentObjectRenderer::class);
        $cObjectMock
            ->method('getTreeList')
            ->will(self::onConsecutiveCalls('4', '', '898,12'));
        $abstractConfigurationManager->setContentObject($cObjectMock);
 
        $expectedResult = [4, 898, 12];
        $actualResult = $abstractConfigurationManager->_call('getRecursiveStoragePids', $storagePids, $recursive);
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪storagePidsAreExtendedIfRecursiveSearchIsConfiguredAndWithPidIncludedForNegativePid(): void
    {
        $storagePids = [-3, 5, 9];
        $recursive = 99;
        $abstractConfigurationManager = $this->getAccessibleMock(
            FrontendConfigurationManager::class,
            [
                'getContextSpecificFrameworkConfiguration',
                'getTypoScriptSetup',
                'getPluginConfiguration',
                'getControllerConfiguration',
            ],
            [],
            '',
            false
        );
        $cObjectMock = $this->createMock(ContentObjectRenderer::class);
        $cObjectMock
            ->method('getTreeList')
            ->will(self::onConsecutiveCalls('3,4', '', '898,12'));
        $abstractConfigurationManager->setContentObject($cObjectMock);
 
        $expectedResult = [3, 4, 898, 12];
        $actualResult = $abstractConfigurationManager->_call('getRecursiveStoragePids', $storagePids, $recursive);
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪storagePidsAreNotExtendedIfRecursiveSearchIsNotConfigured(): void
    {
        $storagePids = [1, 2, 3];
 
        $abstractConfigurationManager = $this->getAccessibleMock(
            FrontendConfigurationManager::class,
            [
                'getContextSpecificFrameworkConfiguration',
                'getTypoScriptSetup',
                'getPluginConfiguration',
                'getControllerConfiguration',
            ],
            [],
            '',
            false
        );
        $cObjectMock = $this->createMock(ContentObjectRenderer::class);
        $cObjectMock->expects(self::never())->method('getTreeList');
        $abstractConfigurationManager->setContentObject($cObjectMock);
 
        $expectedResult = [1, 2, 3];
        $actualResult = $abstractConfigurationManager->_call('getRecursiveStoragePids', $storagePids);
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪storagePidsAreNotExtendedIfRecursiveSearchIsConfiguredForZeroLevels(): void
    {
        $storagePids = [1, 2, 3];
        $recursive = 0;
 
        $abstractConfigurationManager = $this->getAccessibleMock(
            FrontendConfigurationManager::class,
            [
                'getContextSpecificFrameworkConfiguration',
                'getTypoScriptSetup',
                'getPluginConfiguration',
                'getControllerConfiguration',
            ],
            [],
            '',
            false
        );
 
        $cObjectMock = $this->createMock(ContentObjectRenderer::class);
        $cObjectMock->expects(self::never())->method('getTreeList');
        $abstractConfigurationManager->setContentObject($cObjectMock);
 
        $expectedResult = [1, 2, 3];
        $actualResult = $abstractConfigurationManager->_call('getRecursiveStoragePids', $storagePids, $recursive);
        self::assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪mergeConfigurationIntoFrameworkConfigurationWorksAsExpected(): void
    {
        $configuration = [
            'persistence' => [
                'storagePid' => '0,1,2,3',
            ],
        ];
 
        $frameworkConfiguration = ['persistence' => ['storagePid' => '98']];
        self::assertSame(
            ['persistence' => ['storagePid' => '0,1,2,3']],
            $this->frontendConfigurationManager->_call(
                'mergeConfigurationIntoFrameworkConfiguration',
                $frameworkConfiguration,
                $configuration,
                'persistence'
            )
        );
    }
 
    public function ‪overrideStoragePidIfStartingPointIsSetOverridesCorrectly(): void
    {
        $this->mockContentObject->method('getTreeList')->willReturn('1,2,3');
        $this->mockContentObject->data = ['pages' => '0', 'recursive' => 1];
 
        $frameworkConfiguration = ['persistence' => ['storagePid' => '98']];
        self::assertSame(
            ['persistence' => ['storagePid' => '0,1,2,3']],
            $this->frontendConfigurationManager->_call(
                'overrideStoragePidIfStartingPointIsSet',
                $frameworkConfiguration
            )
        );
    }
 
    public function ‪overrideStoragePidIfStartingPointIsSetCorrectlyHandlesEmptyValuesFromGetTreeList(): void
    {
        $this->mockContentObject->method('getTreeList')->willReturn('');
        $this->mockContentObject->data = ['pages' => '0', 'recursive' => 1];
 
        $frameworkConfiguration = ['persistence' => ['storagePid' => '98']];
        self::assertSame(
            ['persistence' => ['storagePid' => '0']],
            $this->frontendConfigurationManager->_call(
                'overrideStoragePidIfStartingPointIsSet',
                $frameworkConfiguration
            )
        );
    }
 
    public function ‪overrideConfigurationFromFlexFormChecksForDataIsString(): void
    {
        $flexFormService = $this->getMockBuilder(FlexFormService::class)
            ->onlyMethods(['convertFlexFormContentToArray'])
            ->getMock();
        $flexFormService->expects(self::once())->method('convertFlexFormContentToArray')->willReturn([
            'persistence' => [
                'storagePid' => '0,1,2,3',
            ],
        ]);
 
        $this->frontendConfigurationManager->_set('flexFormService', $flexFormService);
        $this->mockContentObject->data = ['pi_flexform' => '<XML_ARRAY>'];
 
        $frameworkConfiguration = ['persistence' => ['storagePid' => '98']];
        self::assertSame(
            ['persistence' => ['storagePid' => '0,1,2,3']],
            $this->frontendConfigurationManager->_call('overrideConfigurationFromFlexForm', $frameworkConfiguration)
        );
    }
 
    public function ‪overrideConfigurationFromFlexFormChecksForDataIsStringAndEmpty(): void
    {
        $flexFormService = $this->getMockBuilder(FlexFormService::class)
            ->onlyMethods(['convertFlexFormContentToArray'])
            ->getMock();
        $flexFormService->expects(self::never())->method('convertFlexFormContentToArray');
 
        $this->frontendConfigurationManager->_set('flexFormService', $flexFormService);
        $this->mockContentObject->data = ['pi_flexform' => ''];
 
        $frameworkConfiguration = ['persistence' => ['storagePid' => '98']];
        self::assertSame(
            ['persistence' => ['storagePid' => '98']],
            $this->frontendConfigurationManager->_call('overrideConfigurationFromFlexForm', $frameworkConfiguration)
        );
    }
 
    public function ‪overrideConfigurationFromFlexFormChecksForDataIsArray(): void
    {
        $flexFormService = $this->getMockBuilder(FlexFormService::class)
            ->onlyMethods(['convertFlexFormContentToArray'])
            ->getMock();
        $flexFormService->expects(self::never())->method('convertFlexFormContentToArray');
 
        $this->frontendConfigurationManager->_set('flexFormService', $flexFormService);
        $this->mockContentObject->data = ['pi_flexform' => ['persistence' => ['storagePid' => '0,1,2,3']]];
 
        $frameworkConfiguration = ['persistence' => ['storagePid' => '98']];
        self::assertSame(
            ['persistence' => ['storagePid' => '0,1,2,3']],
            $this->frontendConfigurationManager->_call('overrideConfigurationFromFlexForm', $frameworkConfiguration)
        );
    }
 
    public function ‪overrideConfigurationFromFlexFormChecksForDataIsArrayAndEmpty(): void
    {
        $flexFormService = $this->getMockBuilder(FlexFormService::class)
            ->onlyMethods(['convertFlexFormContentToArray'])
            ->getMock();
        $flexFormService->expects(self::never())->method('convertFlexFormContentToArray');
 
        $this->frontendConfigurationManager->_set('flexFormService', $flexFormService);
        $this->mockContentObject->data = ['pi_flexform' => []];
 
        $frameworkConfiguration = ['persistence' => ['storagePid' => '98']];
        self::assertSame(
            ['persistence' => ['storagePid' => '98']],
            $this->frontendConfigurationManager->_call('overrideConfigurationFromFlexForm', $frameworkConfiguration)
        );
    }
 
    public function ‪overrideConfigurationFromPluginOverridesCorrectly(): void
    {
        ‪$frontendConfigurationManager = $this->getAccessibleMock(
            FrontendConfigurationManager::class,
            ['getTypoScriptSetup'],
            [],
            '',
            false
        );
        ‪$frontendConfigurationManager->_set('contentObject', $this->mockContentObject);
        ‪$frontendConfigurationManager->_set('typoScriptService', $this->mockTypoScriptService);
 
        $this->mockTypoScriptService->expects(self::once())->method('convertTypoScriptArrayToPlainArray')->willReturn([
            'persistence' => [
                'storagePid' => '0,1,2,3',
            ],
            'settings' => [
                'foo' => 'bar',
            ],
            'view' => [
                'foo' => 'bar',
            ],
        ]);
        ‪$frontendConfigurationManager->method('getTypoScriptSetup')->willReturn([
            'plugin.' => [
                'tx_ext_pi1.' => [
                    'persistence.' => [
                        'storagePid' => '0,1,2,3',
                    ],
                    'settings.' => [
                        'foo' => 'bar',
                    ],
                    'view.' => [
                        'foo' => 'bar',
                    ],
                ],
            ],
        ]);
 
        $frameworkConfiguration = [
            'extensionName' => 'ext',
            'pluginName' => 'pi1',
            'persistence' => [
                'storagePid' => '1',
            ],
            'settings' => [
                'foo' => 'qux',
            ],
            'view' => [
                'foo' => 'qux',
            ],
        ];
        self::assertSame(
            [
                'extensionName' => 'ext',
                'pluginName' => 'pi1',
                'persistence' => [
                    'storagePid' => '0,1,2,3',
                ],
                'settings' => [
                    'foo' => 'bar',
                ],
                'view' => [
                    'foo' => 'bar',
                ],
            ],
            ‪$frontendConfigurationManager->_call('overrideConfigurationFromPlugin', $frameworkConfiguration)
        );
    }
}