ConfigurationItemRepositoryTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extensionmanager\Tests\Unit\Domain\Repository;

/*
 * 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!
 */

class ConfigurationItemRepositoryTest extends \TYPO3\CMS\Core\Tests\UnitTestCase
{
    protected $configurationItemRepository;

    protected $injectedObjectManagerMock;

    protected function setUp()
    {
        // Mock system under test to make protected methods accessible
        $this->configurationItemRepository = $this->getAccessibleMock(
            \TYPO3\CMS\Extensionmanager\Domain\Repository\ConfigurationItemRepository::class,
            ['dummy']
        );

        $this->injectedObjectManagerMock = $this->getMock(\TYPO3\CMS\Extbase\Object\ObjectManagerInterface::class, [], [], '', false);
        $this->configurationItemRepository->_set(
            'objectManager',
            $this->injectedObjectManagerMock
        );
    }

    public function getConfigurationArrayFromExtensionKeyReturnsSortedHierarchicArray()
    {
        $flatConfigurationItemArray = [
            'item1' => [
                'cat' => 'basic',
                'subcat_name' => 'enable',
                'subcat' => 'a/enable/10z',
                'type' => 'string',
                'label' => 'Item 1: This is the first configuration item',
                'name' =>'item1',
                'value' => 'one',
                'default_value' => 'one',
                'subcat_label' => 'Enable features',
            ],
            'integerValue' => [
                'cat' => 'basic',
                'subcat_name' => 'enable',
                'subcat' => 'a/enable/20z',
                'type' => 'int+',
                'label' => 'Integer Value: Please insert a positive integer value',
                'name' =>'integerValue',
                'value' => '1',
                'default_value' => '1',
                'subcat_label' => 'Enable features',
            ],
            'enableJquery' => [
                'cat' => 'advanced',
                'subcat_name' => 'file',
                'subcat' => 'c/file/10z',
                'type' => 'boolean',
                'label' => 'enableJquery: Insert jQuery plugin',
                'name' =>'enableJquery',
                'value' => '1',
                'default_value' => '1',
                'subcat_label' => 'Files',
            ],
        ];

        $configurationItemRepository = $this->getAccessibleMock(
            \TYPO3\CMS\Extensionmanager\Domain\Repository\ConfigurationItemRepository::class,
            ['mergeWithExistingConfiguration', 'translate']
        );
        $configurationItemRepository->_set(
            'objectManager',
            $this->injectedObjectManagerMock
        );
        $configurationUtilityMock = $this->getMock(\TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility::class, [], [], '', false);
        $configurationUtilityMock
            ->expects($this->once())
            ->method('getDefaultConfigurationFromExtConfTemplateAsValuedArray')
            ->will($this->returnValue($flatConfigurationItemArray));
        $this->injectedObjectManagerMock
            ->expects($this->any())
            ->method('get')
            ->will($this->returnValue($configurationUtilityMock));
        $configurationItemRepository
            ->expects($this->any())
            ->method('mergeWithExistingConfiguration')
            ->will($this->returnValue($flatConfigurationItemArray));

        $expectedArray = [
            'basic' => [
                'enable' => [
                    'item1' => [
                        'cat' => 'basic',
                        'subcat_name' => 'enable',
                        'subcat' => 'a/enable/10z',
                        'type' => 'string',
                        'label' => 'Item 1: This is the first configuration item',
                        'name' =>'item1',
                        'value' => 'one',
                        'default_value' => 'one',
                        'subcat_label' => 'Enable features',
                        'labels' => [
                            0 => 'Item 1',
                            1 => 'This is the first configuration item'
                        ]
                    ],
                    'integerValue' => [
                        'cat' => 'basic',
                        'subcat_name' => 'enable',
                        'subcat' => 'a/enable/20z',
                        'type' => 'int+',
                        'label' => 'Integer Value: Please insert a positive integer value',
                        'name' =>'integerValue',
                        'value' => '1',
                        'default_value' => '1',
                        'subcat_label' => 'Enable features',
                        'labels' => [
                            0 => 'Integer Value',
                            1 => 'Please insert a positive integer value'
                        ]
                    ]
                ]
            ],
            'advanced' => [
                'file' => [
                    'enableJquery' => [
                        'cat' => 'advanced',
                        'subcat_name' => 'file',
                        'subcat' => 'c/file/10z',
                        'type' => 'boolean',
                        'label' => 'enableJquery: Insert jQuery plugin',
                        'name' =>'enableJquery',
                        'value' => '1',
                        'default_value' => '1',
                        'subcat_label' => 'Files',
                        'labels' => [
                            0 => 'enableJquery',
                            1 => 'Insert jQuery plugin'
                        ]
                    ],
                ]
            ]
        ];

        $this->assertSame(
            $expectedArray,
            $configurationItemRepository->_call('getConfigurationArrayFromExtensionKey', $this->getUniqueId('some_extension'))
        );
    }

    public function addMetaInformationUnsetsOriginalConfigurationMetaKey()
    {
        $configuration = [
            '__meta__' => 'metaInformation',
            'test123' => 'test123'
        ];
        $this->configurationItemRepository->_callRef('addMetaInformation', $configuration);
        $this->assertEquals(['test123' => 'test123'], $configuration);
    }

    public function addMetaInformationReturnsMetaInformation()
    {
        $configuration = [
            '__meta__' => 'metaInformation',
            'test123' => 'test123'
        ];
        $meta = $this->configurationItemRepository->_callRef('addMetaInformation', $configuration);
        $this->assertEquals('metaInformation', $meta);
    }

    public function extractInformationForConfigFieldsOfTypeUserAddsGenericAndTypeInformationDataProvider()
    {
        return [
            [
                [
                    'cat' => 'basic',
                    'subcat_name' => 'enable',
                    'subcat' => 'a/enable/z',
                    'type' => 'user[EXT:saltedpasswords/classes/class.tx_saltedpasswords_emconfhelper.php:TYPO3\\CMS\\Saltedpasswords\\Utility\\ExtensionManagerConfigurationUtility->checkConfigurationFrontend]',
                    'label' => 'Frontend configuration check',
                    'name' => 'checkConfigurationFE',
                    'value' => 0,
                    'default_value' => 0,
                    'comparisonGeneric' => 'EXT:saltedpasswords/classes/class.tx_saltedpasswords_emconfhelper.php:TYPO3\\CMS\\Saltedpasswords\\Utility\\ExtensionManagerConfigurationUtility->checkConfigurationFrontend'
                ]
            ],
            [
                [
                    'cat' => 'basic',
                    'subcat_name' => 'enable',
                    'subcat' => 'a/enable/z',
                    'type' => 'user[EXT:saltedpasswords/classes/class.tx_saltedpasswords_emconfhelper.php:TYPO3\\CMS\\Saltedpasswords\\Utility\\ExtensionManagerConfigurationUtility->checkConfigurationBackend]',
                    'label' => 'Backend configuration check',
                    'name' => 'checkConfigurationBE',
                    'value' => 0,
                    'default_value' => 0,
                    'comparisonGeneric' => 'EXT:saltedpasswords/classes/class.tx_saltedpasswords_emconfhelper.php:TYPO3\\CMS\\Saltedpasswords\\Utility\\ExtensionManagerConfigurationUtility->checkConfigurationBackend'
                ]
            ],
            [
                [
                    'cat' => 'basic',
                    'subcat_name' => 'enable',
                    'subcat' => 'a/enable/z',
                    'type' => 'user[EXT:saltedpasswords/classes/class.tx_saltedpasswords_emconfhelper.php:TYPO3\\CMS\\Saltedpasswords\\Utility\\ExtensionManagerConfigurationUtility->buildHashMethodSelectorFE]',
                    'label' => 'Hashing method for the frontend: Defines salted hashing method to use. Choose "Portable PHP password hashing" to stay compatible with other CMS (e.g. Drupal, Wordpress). Choose "MD5 salted hashing" to reuse TYPO3 passwords for OS level authentication (other servers could use TYPO3 passwords). Choose "Blowfish salted hashing" for advanced security to reuse passwords on OS level (Blowfish might not be supported on your system TODO).',
                    'name' => 'FE.saltedPWHashingMethod',
                    'value' => \TYPO3\CMS\Saltedpasswords\Salt\PhpassSalt::class,
                    'default_value' => \TYPO3\CMS\Saltedpasswords\Salt\PhpassSalt::class,
                    'comparisonGeneric' => 'EXT:saltedpasswords/classes/class.tx_saltedpasswords_emconfhelper.php:TYPO3\\CMS\\Saltedpasswords\\Utility\\ExtensionManagerConfigurationUtility->buildHashMethodSelectorFE'
                ]
            ]
        ];
    }

    public function extractInformationForConfigFieldsOfTypeUserAddsGenericAndTypeInformation($configurationOption)
    {
        $configurationOptionModified = $this->configurationItemRepository->_callRef('extractInformationForConfigFieldsOfTypeUser', $configurationOption);
        $this->assertEquals('user', $configurationOptionModified['type']);
        $this->assertEquals($configurationOption['comparisonGeneric'], $configurationOptionModified['generic']);
    }

    public function extractInformationForConfigFieldsOfTypeOptionsAddsGenericTypeAndLabelInformation()
    {
        $option = [
            'cat' => 'basic',
            'subcat_name' => 'enable',
            'subcat' => 'a/enable/100z',
            'type' => 'options[Minimal (Most features disabled. Administrator needs to enable them using TypoScript. For advanced administrators only.),Typical (Most commonly used features are enabled. Select this option if you are unsure which one to use.),Demo (Show-off configuration. Includes pre-configured styles. Not for production environments.)]',
            'label' => 'Default configuration settings',
            'name' => 'defaultConfiguration',
            'value' => 'Typical (Most commonly used features are enabled. Select this option if you are unsure which one to use.)',
            'default_value' => 'Typical (Most commonly used features are enabled. Select this option if you are unsure which one to use.)',
            'genericComparisonValue' => [
                'Minimal (Most features disabled. Administrator needs to enable them using TypoScript. For advanced administrators only.)' => 'Minimal (Most features disabled. Administrator needs to enable them using TypoScript. For advanced administrators only.)',
                'Typical (Most commonly used features are enabled. Select this option if you are unsure which one to use.)' => 'Typical (Most commonly used features are enabled. Select this option if you are unsure which one to use.)',
                'Demo (Show-off configuration. Includes pre-configured styles. Not for production environments.)' => 'Demo (Show-off configuration. Includes pre-configured styles. Not for production environments.)'
            ],
            'typeComparisonValue' => 'options'
        ];
        $optionModified = $this->configurationItemRepository->_callRef('extractInformationForConfigFieldsOfTypeOptions', $option);
        $this->assertArrayHasKey('generic', $optionModified);
        $this->assertArrayHasKey('type', $optionModified);
        $this->assertArrayHasKey('label', $optionModified);
        $this->assertEquals($option['genericComparisonValue'], $optionModified['generic']);
        $this->assertEquals($option['typeComparisonValue'], $optionModified['type']);
    }

    public function extractInformationForConfigFieldsOfTypeOptionsWithLabelsAndValuesAddsGenericTypeAndLabelInformation()
    {
        $option = [
            'cat' => 'basic',
            'subcat_name' => 'enable',
            'subcat' => 'a/enable/100z',
            'type' => 'options[Minimal (Most features disabled. Administrator needs to enable them using TypoScript. For advanced administrators only.)=MINIMAL,Typical (Most commonly used features are enabled. Select this option if you are unsure which one to use.) = TYPICAL,Demo (Show-off configuration. Includes pre-configured styles. Not for production environments.)=DEMO]',
            'label' => 'Default configuration settings',
            'name' => 'defaultConfiguration',
            'value' => 'Typical (Most commonly used features are enabled. Select this option if you are unsure which one to use.)',
            'default_value' => 'Typical (Most commonly used features are enabled. Select this option if you are unsure which one to use.)',
            'genericComparisonValue' => [
                'Minimal (Most features disabled. Administrator needs to enable them using TypoScript. For advanced administrators only.)' => 'MINIMAL',
                'Typical (Most commonly used features are enabled. Select this option if you are unsure which one to use.)' => 'TYPICAL',
                'Demo (Show-off configuration. Includes pre-configured styles. Not for production environments.)' => 'DEMO'
            ],
            'typeComparisonValue' => 'options'
        ];
        $optionModified = $this->configurationItemRepository->_callRef('extractInformationForConfigFieldsOfTypeOptions', $option);
        $this->assertArrayHasKey('generic', $optionModified);
        $this->assertArrayHasKey('type', $optionModified);
        $this->assertArrayHasKey('label', $optionModified);
        $this->assertEquals($option['genericComparisonValue'], $optionModified['generic']);
        $this->assertEquals($option['typeComparisonValue'], $optionModified['type']);
    }

    public function mergeDefaultConfigurationCatchesExceptionOfConfigurationManagerIfNoLocalConfigurationExists()
    {
        $exception = $this->getMock('RuntimeException');
        $configurationManagerMock = $this->getMock(\TYPO3\CMS\Core\Configuration\ConfigurationManager::class);
        $configurationManagerMock
            ->expects($this->once())
            ->method('getConfigurationValueByPath')
            ->will($this->throwException($exception));
        $this->injectedObjectManagerMock
            ->expects($this->any())
            ->method('get')
            ->will($this->returnValue($configurationManagerMock));

        $this->configurationItemRepository->_call(
            'mergeWithExistingConfiguration',
            [],
            $this->getUniqueId('not_existing_extension')
        );
    }

    public function mergeDefaultConfigurationWithNoCurrentValuesReturnsTheDefaultConfiguration()
    {
        $exception = $this->getMock('RuntimeException');
        $configurationManagerMock = $this->getMock(\TYPO3\CMS\Core\Configuration\ConfigurationManager::class);
        $configurationManagerMock
            ->expects($this->once())
            ->method('getConfigurationValueByPath')
            ->will($this->throwException($exception));
        $this->injectedObjectManagerMock
            ->expects($this->any())
            ->method('get')
            ->will($this->returnValue($configurationManagerMock));
        $defaultConfiguration = [
            'foo' => 'bar'
        ];
        $configuration = $this->configurationItemRepository->_call(
            'mergeWithExistingConfiguration',
            $defaultConfiguration,
            $this->getUniqueId('not_existing_extension')
        );
        $this->assertEquals($defaultConfiguration, $configuration);
    }

    public function mergeWithExistingConfigurationOverwritesDefaultKeysWithCurrent()
    {
        $localConfiguration = serialize([
            'FE.' => [
                'enabled' => '1',
                'saltedPWHashingMethod' => \TYPO3\CMS\Saltedpasswords\Salt\SaltInterface_sha1::class
            ],
            'CLI.' => [
                'enabled' => '0'
            ]
        ]);

        $configurationManagerMock = $this->getMock(\TYPO3\CMS\Core\Configuration\ConfigurationManager::class);
        $configurationManagerMock
            ->expects($this->once())
            ->method('getConfigurationValueByPath')
            ->with('EXT/extConf/testextensionkey')
            ->will($this->returnValue($localConfiguration));

        $this->injectedObjectManagerMock
            ->expects($this->any())
            ->method('get')
            ->will($this->returnValue($configurationManagerMock));

        $defaultConfiguration = [
            'FE.enabled' => [
                'value' => '0'
            ],
            'FE.saltedPWHashingMethod' => [
                'value' => \TYPO3\CMS\Saltedpasswords\Salt\Md5Salt::class
            ],
            'BE.enabled' => [
                'value' => '1'
            ],
            'BE.saltedPWHashingMethod' => [
                'value' => \TYPO3\CMS\Saltedpasswords\Salt\Md5Salt::class
            ]
        ];

        $expectedResult = [
            'FE.enabled' => [
                'value' => '1'
            ],
            'FE.saltedPWHashingMethod' => [
                'value' => \TYPO3\CMS\Saltedpasswords\Salt\SaltInterface_sha1::class
            ],
            'BE.enabled' => [
                'value' => '1'
            ],
            'BE.saltedPWHashingMethod' => [
                'value' => \TYPO3\CMS\Saltedpasswords\Salt\Md5Salt::class
            ],
            'CLI.enabled' => [
                'value' => '0'
            ]
        ];

        $actualResult = $this->configurationItemRepository->_call(
            'mergeWithExistingConfiguration',
            $defaultConfiguration,
            'testextensionkey'
        );

        $this->assertEquals($expectedResult, $actualResult);
    }
}