AbstractConfigurationManagerTest.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
 
namespace ‪TYPO3\CMS\Extbase\Tests\Unit\Configuration;
 
/*
 * 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\TypoScript\TypoScriptService;
use ‪TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager;
use ‪TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
use TYPO3\TestingFramework\Core\AccessibleObjectInterface;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪AbstractConfigurationManagerTest extends UnitTestCase
{
    protected ‪$abstractConfigurationManager;
 
    protected ‪$mockTypoScriptService;
 
    protected ‪$testTypoScriptSetup = [
        'foo.' => [
            'bar' => 'baz'
        ],
        'config.' => [
            'tx_extbase.' => [
                'settings.' => [
                    'setting1' => 'value1',
                    'setting2' => 'value2'
                ],
                'view.' => [
                    'viewSub.' => [
                        'key1' => 'value1',
                        'key2' => 'value2'
                    ]
                ]
            ]
        ]
    ];
 
    protected ‪$testTypoScriptSetupConverted = [
        'foo' => [
            'bar' => 'baz'
        ],
        'config' => [
            'tx_extbase' => [
                'settings' => [
                    'setting1' => 'value1',
                    'setting2' => 'value2'
                ],
                'view' => [
                    'viewSub' => [
                        'key1' => 'value1',
                        'key2' => 'value2'
                    ]
                ]
            ]
        ]
    ];
 
    protected ‪$testPluginConfiguration = [
        'settings' => [
            'setting1' => 'overriddenValue1',
            'setting3' => 'additionalValue'
        ],
        'view' => [
            'viewSub' => [
                'key1' => 'overridden',
                'key3' => 'new key'
            ]
        ],
        'persistence' => [
            'storagePid' => '123'
        ]
    ];
 
    protected ‪$testSwitchableControllerActions = [
        'Controller1' => [
            'actions' => ['action1', 'action2', 'action3']
        ],
        'Controller2' => [
            'actions' => ['action4', 'action5', 'action6'],
            'nonCacheableActions' => ['action4', 'action6']
        ]
    ];
 
    protected function ‪setUp(): void
    {
        $this->abstractConfigurationManager = $this->getAccessibleMock(
            AbstractConfigurationManager::class,
            [
                'getContextSpecificFrameworkConfiguration',
                'getTypoScriptSetup',
                'getPluginConfiguration',
                'getSwitchableControllerActions',
                'getRecursiveStoragePids'
            ]
        );
        $this->mockTypoScriptService = $this->getAccessibleMock(TypoScriptService::class);
        $this->abstractConfigurationManager->_set('typoScriptService', $this->mockTypoScriptService);
    }
 
    public function ‪setConfigurationResetsConfigurationCache(): void
    {
        $this->abstractConfigurationManager->_set('configurationCache', ['foo' => 'bar']);
        $this->abstractConfigurationManager->setConfiguration([]);
        $this->assertEquals([], $this->abstractConfigurationManager->_get('configurationCache'));
    }
 
    public function ‪setConfigurationSetsExtensionAndPluginName(): void
    {
        $configuration = [
            'extensionName' => 'SomeExtensionName',
            'pluginName' => 'SomePluginName'
        ];
        $this->abstractConfigurationManager->setConfiguration($configuration);
        $this->assertEquals('SomeExtensionName', $this->abstractConfigurationManager->_get('extensionName'));
        $this->assertEquals('SomePluginName', $this->abstractConfigurationManager->_get('pluginName'));
    }
 
    public function ‪setConfigurationConvertsTypoScriptArrayToPlainArray(): void
    {
        $configuration = [
            'foo' => 'bar',
            'settings.' => ['foo' => 'bar'],
            'view.' => ['subkey.' => ['subsubkey' => 'subsubvalue']]
        ];
        $expectedResult = [
            'foo' => 'bar',
            'settings' => ['foo' => 'bar'],
            'view' => ['subkey' => ['subsubkey' => 'subsubvalue']]
        ];
        $this->mockTypoScriptService->expects($this->atLeastOnce())->method('convertTypoScriptArrayToPlainArray')->with($configuration)->will($this->returnValue($expectedResult));
        $this->abstractConfigurationManager->setConfiguration($configuration);
        $this->assertEquals($expectedResult, $this->abstractConfigurationManager->_get('configuration'));
    }
 
    public function ‪getConfigurationReturnsCachedResultOfCurrentPlugin(): void
    {
        $this->abstractConfigurationManager->_set('extensionName', 'CurrentExtensionName');
        $this->abstractConfigurationManager->_set('pluginName', 'CurrentPluginName');
        $this->abstractConfigurationManager->_set('configurationCache', [
            'currentextensionname_currentpluginname' => ['foo' => 'bar'],
            'someotherextension_somepluginname' => ['baz' => 'shouldnotbereturned']
        ]);
        $expectedResult = ['foo' => 'bar'];
        $actualResult = $this->abstractConfigurationManager->getConfiguration();
        $this->assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getConfigurationReturnsCachedResultForGivenExtension(): void
    {
        $this->abstractConfigurationManager->_set('configurationCache', [
            'someextensionname_somepluginname' => ['foo' => 'bar'],
            'someotherextension_somepluginname' => ['baz' => 'shouldnotbereturned']
        ]);
        $expectedResult = ['foo' => 'bar'];
        $actualResult = $this->abstractConfigurationManager->getConfiguration('SomeExtensionName', 'SomePluginName');
        $this->assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getConfigurationRecursivelyMergesCurrentPluginConfigurationWithFrameworkConfiguration(): void
    {
        $this->abstractConfigurationManager->_set('extensionName', 'CurrentExtensionName');
        $this->abstractConfigurationManager->_set('pluginName', 'CurrentPluginName');
        $this->abstractConfigurationManager->expects($this->once())->method('getTypoScriptSetup')->will($this->returnValue($this->testTypoScriptSetup));
        $this->mockTypoScriptService->expects($this->atLeastOnce())->method('convertTypoScriptArrayToPlainArray')->with($this->testTypoScriptSetup['config.']['tx_extbase.'])->will($this->returnValue($this->testTypoScriptSetupConverted['config']['tx_extbase']));
        $this->abstractConfigurationManager->expects($this->once())->method('getPluginConfiguration')->with(
            'CurrentExtensionName',
            'CurrentPluginName'
        )->will($this->returnValue($this->testPluginConfiguration));
        $expectedResult = [
            'settings' => [
                'setting1' => 'overriddenValue1',
                'setting2' => 'value2',
                'setting3' => 'additionalValue'
            ],
            'view' => [
                'viewSub' => [
                    'key1' => 'overridden',
                    'key2' => 'value2',
                    'key3' => 'new key'
                ]
            ],
            'persistence' => [
                'storagePid' => '123'
            ],
            'controllerConfiguration' => null
        ];
        $this->abstractConfigurationManager->expects($this->once())->method('getContextSpecificFrameworkConfiguration')->with($expectedResult)->will($this->returnValue($expectedResult));
        $actualResult = $this->abstractConfigurationManager->getConfiguration();
        $this->assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getConfigurationRecursivelyMergesPluginConfigurationOfSpecifiedPluginWithFrameworkConfiguration(
    ): void {
        $this->abstractConfigurationManager->expects($this->once())->method('getTypoScriptSetup')->will($this->returnValue($this->testTypoScriptSetup));
        $this->abstractConfigurationManager->expects($this->once())->method('getPluginConfiguration')->with(
            'SomeExtensionName',
            'SomePluginName'
        )->will($this->returnValue($this->testPluginConfiguration));
        $this->mockTypoScriptService->expects($this->atLeastOnce())->method('convertTypoScriptArrayToPlainArray')->with($this->testTypoScriptSetup['config.']['tx_extbase.'])->will($this->returnValue($this->testTypoScriptSetupConverted['config']['tx_extbase']));
        $expectedResult = [
            'settings' => [
                'setting1' => 'overriddenValue1',
                'setting2' => 'value2',
                'setting3' => 'additionalValue'
            ],
            'view' => [
                'viewSub' => [
                    'key1' => 'overridden',
                    'key2' => 'value2',
                    'key3' => 'new key'
                ]
            ],
            'persistence' => [
                'storagePid' => '123'
            ],
            'controllerConfiguration' => null
        ];
        $this->abstractConfigurationManager->expects($this->never())->method('getContextSpecificFrameworkConfiguration');
        $actualResult = $this->abstractConfigurationManager->getConfiguration('SomeExtensionName', 'SomePluginName');
        $this->assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getConfigurationDoesNotOverrideConfigurationWithContextSpecificFrameworkConfigurationIfDifferentPluginIsSpecified(
    ): void {
        $this->abstractConfigurationManager->expects($this->never())->method('getContextSpecificFrameworkConfiguration');
        $this->abstractConfigurationManager->getConfiguration('SomeExtensionName', 'SomePluginName');
    }
 
    public function ‪getConfigurationOverridesConfigurationWithContextSpecificFrameworkConfigurationIfNoPluginWasSpecified(
    ): void {
        $this->abstractConfigurationManager->expects($this->once())->method('getTypoScriptSetup')->will($this->returnValue($this->testTypoScriptSetup));
        $this->abstractConfigurationManager->expects($this->once())->method('getPluginConfiguration')->with()->will($this->returnValue($this->testPluginConfiguration));
        $contextSpecifixFrameworkConfiguration = [
            'context' => [
                'specific' => 'framwork',
                'conf' => 'iguration'
            ]
        ];
        $this->abstractConfigurationManager->expects($this->once())->method('getContextSpecificFrameworkConfiguration')->will($this->returnValue($contextSpecifixFrameworkConfiguration));
        $actualResult = $this->abstractConfigurationManager->getConfiguration();
        $this->assertEquals($contextSpecifixFrameworkConfiguration, $actualResult);
    }
 
    public function ‪getConfigurationOverridesConfigurationWithContextSpecificFrameworkConfigurationIfSpecifiedPluginIsTheCurrentPlugin(
    ): void {
        $this->abstractConfigurationManager->_set('extensionName', 'CurrentExtensionName');
        $this->abstractConfigurationManager->_set('pluginName', 'CurrentPluginName');
        $this->abstractConfigurationManager->expects($this->once())->method('getTypoScriptSetup')->will($this->returnValue($this->testTypoScriptSetup));
        $this->abstractConfigurationManager->expects($this->once())->method('getPluginConfiguration')->with(
            'CurrentExtensionName',
            'CurrentPluginName'
        )->will($this->returnValue($this->testPluginConfiguration));
        $contextSpecifixFrameworkConfiguration = [
            'context' => [
                'specific' => 'framwork',
                'conf' => 'iguration'
            ]
        ];
        $this->abstractConfigurationManager->expects($this->once())->method('getContextSpecificFrameworkConfiguration')->will($this->returnValue($contextSpecifixFrameworkConfiguration));
        $actualResult = $this->abstractConfigurationManager->getConfiguration(
            'CurrentExtensionName',
            'CurrentPluginName'
        );
        $this->assertEquals($contextSpecifixFrameworkConfiguration, $actualResult);
    }
 
    public function ‪getConfigurationStoresResultInConfigurationCache(): void
    {
        $this->abstractConfigurationManager->_set('extensionName', 'CurrentExtensionName');
        $this->abstractConfigurationManager->_set('pluginName', 'CurrentPluginName');
        $this->abstractConfigurationManager->expects($this->any())->method('getPluginConfiguration')->will($this->returnValue(['foo' => 'bar']));
        $this->abstractConfigurationManager->getConfiguration();
        $this->abstractConfigurationManager->getConfiguration('SomeOtherExtensionName', 'SomeOtherCurrentPluginName');
        $expectedResult = [
            'currentextensionname_currentpluginname',
            'someotherextensionname_someothercurrentpluginname'
        ];
        $actualResult = array_keys($this->abstractConfigurationManager->_get('configurationCache'));
        $this->assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getConfigurationRetrievesStoragePidIncludingGivenStoragePidWithRecursiveSetForSingleStoragePid(
    ): void {
        $pluginConfiguration = [
            'persistence' => [
                'storagePid' => 1,
                'recursive' => 99
            ]
        ];
        $this->abstractConfigurationManager->expects($this->once())->method('getPluginConfiguration')->will($this->returnValue($pluginConfiguration));
        $this->abstractConfigurationManager->expects($this->once())->method('getRecursiveStoragePids')->with('-1');
        $this->abstractConfigurationManager->getConfiguration('SomeOtherExtensionName', 'SomeOtherCurrentPluginName');
    }
 
    public function ‪getConfigurationRetrievesStoragePidIncludingGivenStoragePidWithRecursiveSetForMultipleStoragePid(
    ): void {
        $pluginConfiguration = [
            'persistence' => [
                'storagePid' => '1,25',
                'recursive' => 99
            ]
        ];
        $this->abstractConfigurationManager->expects($this->once())->method('getPluginConfiguration')->will($this->returnValue($pluginConfiguration));
        $this->abstractConfigurationManager->expects($this->once())->method('getRecursiveStoragePids')->with('-1,-25');
        $this->abstractConfigurationManager->getConfiguration('SomeOtherExtensionName', 'SomeOtherCurrentPluginName');
    }
 
    public function ‪switchableControllerActionsAreNotOverriddenIfPluginNameIsSpecified(): void
    {
        ‪$abstractConfigurationManager = $this->getAccessibleMock(
            AbstractConfigurationManager::class,
            [
                'overrideSwitchableControllerActions',
                'getContextSpecificFrameworkConfiguration',
                'getTypoScriptSetup',
                'getPluginConfiguration',
                'getSwitchableControllerActions',
                'getRecursiveStoragePids'
            ]
        );
        ‪$abstractConfigurationManager->_set('typoScriptService', $this->mockTypoScriptService);
        ‪$abstractConfigurationManager->‪setConfiguration(['switchableControllerActions' => ['overriddenSwitchableControllerActions']]);
        ‪$abstractConfigurationManager->expects($this->any())->method('getPluginConfiguration')->will($this->returnValue([]));
        ‪$abstractConfigurationManager->expects($this->never())->method('overrideSwitchableControllerActions');
        ‪$abstractConfigurationManager->‪getConfiguration('SomeExtensionName', 'SomePluginName');
    }
 
    public function ‪switchableControllerActionsAreOverriddenIfSpecifiedPluginIsTheCurrentPlugin(): void
    {
        $configuration = [
            'extensionName' => 'CurrentExtensionName',
            'pluginName' => 'CurrentPluginName',
            'switchableControllerActions' => ['overriddenSwitchableControllerActions']
        ];
        ‪$abstractConfigurationManager = $this->getAccessibleMock(
            AbstractConfigurationManager::class,
            [
                'overrideSwitchableControllerActions',
                'getContextSpecificFrameworkConfiguration',
                'getTypoScriptSetup',
                'getPluginConfiguration',
                'getSwitchableControllerActions',
                'getRecursiveStoragePids'
            ]
        );
        $this->mockTypoScriptService->expects($this->any())->method('convertTypoScriptArrayToPlainArray')->with($configuration)->will($this->returnValue($configuration));
        ‪$abstractConfigurationManager->_set('typoScriptService', $this->mockTypoScriptService);
        ‪$abstractConfigurationManager->‪setConfiguration($configuration);
        ‪$abstractConfigurationManager->expects($this->any())->method('getPluginConfiguration')->will($this->returnValue([]));
        ‪$abstractConfigurationManager->expects($this->once())->method('overrideSwitchableControllerActions');
        ‪$abstractConfigurationManager->‪getConfiguration('CurrentExtensionName', 'CurrentPluginName');
    }
 
    public function ‪switchableControllerActionsAreOverriddenIfPluginNameIsNotSpecified(): void
    {
        $configuration = ['switchableControllerActions' => ['overriddenSwitchableControllerActions']];
        ‪$abstractConfigurationManager = $this->getAccessibleMock(
            AbstractConfigurationManager::class,
            [
                'overrideSwitchableControllerActions',
                'getContextSpecificFrameworkConfiguration',
                'getTypoScriptSetup',
                'getPluginConfiguration',
                'getSwitchableControllerActions',
                'getRecursiveStoragePids'
            ]
        );
        $this->mockTypoScriptService->expects($this->any())->method('convertTypoScriptArrayToPlainArray')->with($configuration)->will($this->returnValue($configuration));
        ‪$abstractConfigurationManager->_set('typoScriptService', $this->mockTypoScriptService);
        ‪$abstractConfigurationManager->‪setConfiguration($configuration);
        ‪$abstractConfigurationManager->expects($this->any())->method('getPluginConfiguration')->will($this->returnValue([]));
        ‪$abstractConfigurationManager->expects($this->once())->method('overrideSwitchableControllerActions');
        ‪$abstractConfigurationManager->‪getConfiguration();
    }
 
    public function ‪orderOfActionsCanBeOverriddenForCurrentPlugin(): void
    {
        $configuration = [
            'extensionName' => 'CurrentExtensionName',
            'pluginName' => 'CurrentPluginName',
            'switchableControllerActions' => [
                'Controller1' => ['action2', 'action1', 'action3']
            ]
        ];
        $this->mockTypoScriptService->expects($this->any())->method('convertTypoScriptArrayToPlainArray')->with($configuration)->will($this->returnValue($configuration));
        $this->abstractConfigurationManager->setConfiguration($configuration);
        $this->abstractConfigurationManager->expects($this->once())->method('getPluginConfiguration')->with(
            'CurrentExtensionName',
            'CurrentPluginName'
        )->will($this->returnValue($this->testPluginConfiguration));
        $this->abstractConfigurationManager->expects($this->once())->method('getSwitchableControllerActions')->with(
            'CurrentExtensionName',
            'CurrentPluginName'
        )->will($this->returnValue($this->testSwitchableControllerActions));
        $this->abstractConfigurationManager->expects($this->once())->method('getContextSpecificFrameworkConfiguration')->will($this->returnCallback(function (
            $a
        ) {
            return $a;
        }));
        $mergedConfiguration = $this->abstractConfigurationManager->getConfiguration();
        $expectedResult = [
            'Controller1' => [
                'actions' => ['action2', 'action1', 'action3']
            ]
        ];
        $actualResult = $mergedConfiguration['controllerConfiguration'];
        $this->assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪newActionsCanBeAddedForCurrentPlugin(): void
    {
        $configuration = [
            'extensionName' => 'CurrentExtensionName',
            'pluginName' => 'CurrentPluginName',
            'switchableControllerActions' => [
                'Controller1' => ['action2', 'action1', 'action3', 'newAction']
            ]
        ];
        $this->mockTypoScriptService->expects($this->any())->method('convertTypoScriptArrayToPlainArray')->with($configuration)->will($this->returnValue($configuration));
        $this->abstractConfigurationManager->setConfiguration($configuration);
        $this->abstractConfigurationManager->expects($this->once())->method('getPluginConfiguration')->with(
            'CurrentExtensionName',
            'CurrentPluginName'
        )->will($this->returnValue($this->testPluginConfiguration));
        $this->abstractConfigurationManager->expects($this->once())->method('getSwitchableControllerActions')->with(
            'CurrentExtensionName',
            'CurrentPluginName'
        )->will($this->returnValue($this->testSwitchableControllerActions));
        $this->abstractConfigurationManager->expects($this->once())->method('getContextSpecificFrameworkConfiguration')->will($this->returnCallback(function (
            $a
        ) {
            return $a;
        }));
        $mergedConfiguration = $this->abstractConfigurationManager->getConfiguration();
        $expectedResult = [
            'Controller1' => [
                'actions' => ['action2', 'action1', 'action3', 'newAction']
            ]
        ];
        $actualResult = $mergedConfiguration['controllerConfiguration'];
        $this->assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪controllersCanNotBeOverridden(): void
    {
        $configuration = [
            'extensionName' => 'CurrentExtensionName',
            'pluginName' => 'CurrentPluginName',
            'switchableControllerActions' => [
                'NewController' => ['action1', 'action2']
            ]
        ];
        $this->mockTypoScriptService->expects($this->any())->method('convertTypoScriptArrayToPlainArray')->with($configuration)->will($this->returnValue($configuration));
        $this->abstractConfigurationManager->setConfiguration($configuration);
        $this->abstractConfigurationManager->expects($this->once())->method('getPluginConfiguration')->with(
            'CurrentExtensionName',
            'CurrentPluginName'
        )->will($this->returnValue($this->testPluginConfiguration));
        $this->abstractConfigurationManager->expects($this->once())->method('getSwitchableControllerActions')->with(
            'CurrentExtensionName',
            'CurrentPluginName'
        )->will($this->returnValue($this->testSwitchableControllerActions));
        $this->abstractConfigurationManager->expects($this->once())->method('getContextSpecificFrameworkConfiguration')->will($this->returnCallback(function (
            $a
        ) {
            return $a;
        }));
        $mergedConfiguration = $this->abstractConfigurationManager->getConfiguration();
        $expectedResult = [];
        $actualResult = $mergedConfiguration['controllerConfiguration'];
        $this->assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪cachingOfActionsCanNotBeChanged(): void
    {
        $configuration = [
            'extensionName' => 'CurrentExtensionName',
            'pluginName' => 'CurrentPluginName',
            'switchableControllerActions' => [
                'Controller1' => ['newAction', 'action1'],
                'Controller2' => ['newAction2', 'action4', 'action5']
            ]
        ];
        $this->mockTypoScriptService->expects($this->any())->method('convertTypoScriptArrayToPlainArray')->with($configuration)->will($this->returnValue($configuration));
        $this->abstractConfigurationManager->setConfiguration($configuration);
        $this->abstractConfigurationManager->expects($this->once())->method('getPluginConfiguration')->with(
            'CurrentExtensionName',
            'CurrentPluginName'
        )->will($this->returnValue($this->testPluginConfiguration));
        $this->abstractConfigurationManager->expects($this->once())->method('getSwitchableControllerActions')->with(
            'CurrentExtensionName',
            'CurrentPluginName'
        )->will($this->returnValue($this->testSwitchableControllerActions));
        $this->abstractConfigurationManager->expects($this->once())->method('getContextSpecificFrameworkConfiguration')->will($this->returnCallback(function (
            $a
        ) {
            return $a;
        }));
        $mergedConfiguration = $this->abstractConfigurationManager->getConfiguration();
        $expectedResult = [
            'Controller1' => [
                'actions' => ['newAction', 'action1']
            ],
            'Controller2' => [
                'actions' => ['newAction2', 'action4', 'action5'],
                'nonCacheableActions' => ['action4']
            ]
        ];
        $actualResult = $mergedConfiguration['controllerConfiguration'];
        $this->assertEquals($expectedResult, $actualResult);
    }
 
    public function ‪getContentObjectReturnsNullIfNoContentObjectHasBeenSet(): void
    {
        $this->assertNull($this->abstractConfigurationManager->getContentObject());
    }
 
    public function ‪getContentObjectTheCurrentContentObject(): void
    {
        $mockContentObject = $this->createMock(ContentObjectRenderer::class);
        $this->abstractConfigurationManager->setContentObject($mockContentObject);
        $this->assertSame($this->abstractConfigurationManager->getContentObject(), $mockContentObject);
    }
}