ExtensionConfigurationTest.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
namespace ‪TYPO3\CMS\Core\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 Prophecy\Argument;
use TYPO3\CMS\Core\Configuration\ConfigurationManager;
use ‪TYPO3\CMS\Core\Configuration\ExtensionConfiguration;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪ExtensionConfigurationTest extends UnitTestCase
{
    public function ‪getWithEmptyPathReturnsEntireExtensionConfiguration()
    {
        ‪$extConf = [
            'aFeature' => 'iAmEnabled',
            'aFlagCategory' => [
                'someFlag' => 'foo',
            ],
        ];
        ‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['someExtension'] = ‪$extConf;
        $this->assertSame((new ‪ExtensionConfiguration())->get('someExtension'), ‪$extConf);
    }
 
    public function ‪getWithPathReturnsGivenValue()
    {
        ‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['someExtension'] = [
            'aFeature' => 'iAmEnabled',
            'aFlagCategory' => [
                'someFlag' => 'foo',
            ],
        ];
        $this->assertSame((new ‪ExtensionConfiguration())->get('someExtension', 'aFeature'), 'iAmEnabled');
    }
 
    public function ‪getWithPathReturnsGivenPathSegment()
    {
        ‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['someExtension'] = [
            'aFeature' => 'iAmEnabled',
            'aFlagCategory' => [
                'someFlag' => 'foo',
            ],
        ];
        $this->assertSame((new ‪ExtensionConfiguration())->get('someExtension', 'aFlagCategory'), ['someFlag' => 'foo']);
    }
 
    public function ‪setThrowsExceptionWithEmptyExtension()
    {
        $this->expectException(\RuntimeException::class);
        $this->expectExceptionCode(1509715852);
        (new ‪ExtensionConfiguration())->set('');
    }
 
    public function ‪setRemovesFullExtensionConfiguration()
    {
        $configurationManagerProphecy = $this->prophesize(ConfigurationManager::class);
        GeneralUtility::addInstance(ConfigurationManager::class, $configurationManagerProphecy->reveal());
        $configurationManagerProphecy->removeLocalConfigurationKeysByPath(['EXTENSIONS/foo'])->shouldBeCalled();
        (new ‪ExtensionConfiguration())->set('foo');
    }
 
    public function ‪setWritesFullExtensionConfig()
    {
        $configurationManagerProphecy = $this->prophesize(ConfigurationManager::class);
        GeneralUtility::addInstance(ConfigurationManager::class, $configurationManagerProphecy->reveal());
        $configurationManagerProphecy->setLocalConfigurationValueByPath(Argument::cetera())->shouldBeCalled();
        $configurationManagerProphecy->setLocalConfigurationValueByPath('EXTENSIONS/foo', ['bar' => 'baz'])->shouldBeCalled();
        (new ‪ExtensionConfiguration())->set('foo', '', ['bar' => 'baz']);
    }
 
    public function ‪setUpdatesLegacyExtConfToNewValues()
    {
        $configurationManagerProphecy = $this->prophesize(ConfigurationManager::class);
        GeneralUtility::addInstance(ConfigurationManager::class, $configurationManagerProphecy->reveal());
        $configurationManagerProphecy->setLocalConfigurationValueByPath(Argument::cetera())->shouldBeCalled();
        $configurationManagerProphecy->setLocalConfigurationValueByPath('EXT/extConf', ['foo' => serialize(['bar' => 'baz'])])->shouldBeCalled();
        (new ‪ExtensionConfiguration())->set('foo', '', ['bar' => 'baz']);
    }
 
    public function ‪setUpdatesLegacyExtConfWithDottedArrayKeysForNestedConfiguration()
    {
        $configurationManagerProphecy = $this->prophesize(ConfigurationManager::class);
        GeneralUtility::addInstance(ConfigurationManager::class, $configurationManagerProphecy->reveal());
        $nestedInput = [
            'TopLevelKey' => [
                'subLevelKey' => true,
            ]
        ];
        $expectedLegacyExtConf = [
            'TopLevelKey.' => [
                'subLevelKey' => true,
            ]
        ];
        $configurationManagerProphecy->setLocalConfigurationValueByPath(Argument::cetera())->shouldBeCalled();
        $configurationManagerProphecy->setLocalConfigurationValueByPath('EXT/extConf', ['someExtension' => serialize($expectedLegacyExtConf)])->shouldBeCalled();
        (new ‪ExtensionConfiguration())->set('someExtension', '', $nestedInput);
    }
 
    public function ‪setUpdatesLegacyExtConfWithDottedArrayKeysForNestedConfigurationWithMultiNestedArrays()
    {
        $configurationManagerProphecy = $this->prophesize(ConfigurationManager::class);
        GeneralUtility::addInstance(ConfigurationManager::class, $configurationManagerProphecy->reveal());
        $nestedInput = [
            'aCategory' => [
                'aSubCategory' => [
                    'aKey' => 'aValue',
                ],
            ],
        ];
        $expectedLegacyExtConf = [
            'aCategory.' => [
                'aSubCategory.' => [
                    'aKey' => 'aValue',
                ],
            ],
        ];
        $configurationManagerProphecy->setLocalConfigurationValueByPath(Argument::cetera())->shouldBeCalled();
        $configurationManagerProphecy->setLocalConfigurationValueByPath('EXT/extConf', ['someExtension' => serialize($expectedLegacyExtConf)])->shouldBeCalled();
        (new ‪ExtensionConfiguration())->set('someExtension', '', $nestedInput);
    }
}