ConfigurationUtilityTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extensionmanager\Tests\Unit\Utility;

/*
 * 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 ConfigurationUtilityTest extends \TYPO3\TestingFramework\Core\Unit\UnitTestCase
{
    public function getCurrentConfigurationReturnsExtensionConfigurationAsValuedConfiguration()
    {
        $configurationUtility = $this->getMockBuilder(\TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility::class)
            ->setMethods(['getDefaultConfigurationFromExtConfTemplateAsValuedArray'])
            ->getMock();
        $configurationUtility
            ->expects($this->once())
            ->method('getDefaultConfigurationFromExtConfTemplateAsValuedArray')
            ->will($this->returnValue([]));
        $extensionKey = $this->getUniqueId('some-extension');

        $currentConfiguration = [
            'key1' => 'value1',
            'key2.' => [
                'subkey1' => 'value2'
            ]
        ];

        $expected = [
            'key1' => [
                'value' => 'value1',
            ],
            'key2.subkey1' => [
                'value' => 'value2',
            ],
        ];

        $GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][$extensionKey] = serialize($currentConfiguration);
        $actual = $configurationUtility->getCurrentConfiguration($extensionKey);
        $this->assertEquals($expected, $actual);
    }

    public function getDefaultConfigurationFromExtConfTemplateAsValuedArrayReturnsExpectedExampleArray()
    {
        $configurationUtility = $this->getAccessibleMock(
            \TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility::class,
            ['getDefaultConfigurationRawString']
        );
        $configurationUtility
            ->expects($this->once())
            ->method('getDefaultConfigurationRawString')
            ->will($this->returnValue('foo'));

        $tsStyleConfig = $this->getMockBuilder(\TYPO3\CMS\Core\TypoScript\ConfigurationForm::class)->getMock();

        $objectManagerMock = $this->getMockBuilder(\TYPO3\CMS\Extbase\Object\ObjectManagerInterface::class)->getMock();
        $configurationUtility->_set('objectManager', $objectManagerMock);
        $objectManagerMock
            ->expects($this->once())
            ->method('get')
            ->with(\TYPO3\CMS\Core\TypoScript\ConfigurationForm::class)
            ->will($this->returnValue($tsStyleConfig));

        $constants = [
            'checkConfigurationFE' => [
                'cat' => 'basic',
                'subcat_name' => 'enable',
                'subcat' => 'a/enable/z',
                'type' => 'user[TYPO3\\CMS\\Saltedpasswords\\Utility\\ExtensionManagerConfigurationUtility->checkConfigurationFrontend]',
                'label' => 'Frontend configuration check',
                'name' => 'checkConfigurationFE',
                'value' => '0',
                'default_value' => '0'
            ],
            'BE.forceSalted' => [
                'cat' => 'advancedbackend',
                'subcat' => 'x/z',
                'type' => 'boolean',
                'label' => 'Force salted passwords: Enforce usage of SaltedPasswords. Old MD5 hashed passwords will stop working.',
                'name' => 'BE.forceSalted',
                'value' => '0',
                'default_value' => '0'
            ]
        ];
        $tsStyleConfig
            ->expects($this->once())
            ->method('ext_initTSstyleConfig')
            ->will($this->returnValue($constants));

        $setupTsConstantEditor = [
            'advancedbackend.' => [
                'description' => '<span style="background:red; padding:1px 2px; color:#fff; font-weight:bold;">1</span> Install tool has hardcoded md5 hashing, enabling this setting will prevent use of a install-tool-created BE user.<br />Currently same is for changin password with user setup module unless you use pending patch!',
                1 => 'BE.forceSalted'
            ]
        ];
        $tsStyleConfig->setup['constants']['TSConstantEditor.'] = $setupTsConstantEditor;

        $expected = [
            'checkConfigurationFE' => [
                'cat' => 'basic',
                'subcat_name' => 'enable',
                'subcat' => 'a/enable/z',
                'type' => 'user[TYPO3\\CMS\\Saltedpasswords\\Utility\\ExtensionManagerConfigurationUtility->checkConfigurationFrontend]',
                'label' => 'Frontend configuration check',
                'name' => 'checkConfigurationFE',
                'value' => '0',
                'default_value' => '0',
                'subcat_label' => 'Enable features',
            ],
            'BE.forceSalted' => [
                'cat' => 'advancedbackend',
                'subcat' => 'x/z',
                'type' => 'boolean',
                'label' => 'Force salted passwords: Enforce usage of SaltedPasswords. Old MD5 hashed passwords will stop working.',
                'name' => 'BE.forceSalted',
                'value' => '0',
                'default_value' => '0',
                'highlight' => 1,
            ],
            '__meta__' => [
                'advancedbackend' => [
                    'highlightText' => '<span style="background:red; padding:1px 2px; color:#fff; font-weight:bold;">1</span> Install tool has hardcoded md5 hashing, enabling this setting will prevent use of a install-tool-created BE user.<br />Currently same is for changin password with user setup module unless you use pending patch!'
                ]
            ]
        ];

        $result = $configurationUtility->getDefaultConfigurationFromExtConfTemplateAsValuedArray($this->getUniqueId('some_extension'));
        $this->assertEquals($expected, $result);
    }

    public function convertValuedToNestedConfigurationDataProvider()
    {
        return [
            'plain array' => [
                [
                    'first' => [
                        'value' => 'value1'
                    ],
                    'second' => [
                        'value' => 'value2'
                    ]
                ],
                [
                    'first' => 'value1',
                    'second' => 'value2'
                ]
            ],
            'nested value with 2 levels' => [
                [
                    'first.firstSub' => [
                        'value' => 'value1'
                    ],
                    'second.secondSub' => [
                        'value' => 'value2'
                    ]
                ],
                [
                    'first.' => [
                        'firstSub' => 'value1'
                    ],
                    'second.' => [
                        'secondSub' => 'value2'
                    ]
                ]
            ],
            'nested value with 3 levels' => [
                [
                    'first.firstSub.firstSubSub' => [
                        'value' => 'value1'
                    ],
                    'second.secondSub.secondSubSub' => [
                        'value' => 'value2'
                    ]
                ],
                [
                    'first.' => [
                        'firstSub.' => [
                            'firstSubSub' => 'value1'
                        ]
                    ],
                    'second.' => [
                        'secondSub.' => [
                            'secondSubSub' => 'value2'
                        ]
                    ]
                ]
            ],
            'mixed nested value with 2 levels' => [
                [
                    'first' => [
                        'value' => 'firstValue'
                    ],
                    'first.firstSub' => [
                        'value' => 'value1'
                    ],
                    'second.secondSub' => [
                        'value' => 'value2'
                    ]
                ],
                [
                    'first' => 'firstValue',
                    'first.' => [
                        'firstSub' => 'value1'
                    ],
                    'second.' => [
                        'secondSub' => 'value2'
                    ]
                ]
            ]
        ];
    }

    public function convertValuedToNestedConfiguration(array $configuration, array $expected)
    {
        $subject = $this->getAccessibleMock(\TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility::class, ['dummy'], [], '', false);
        $this->assertEquals($expected, $subject->convertValuedToNestedConfiguration($configuration));
    }

    public function convertNestedToValuedConfigurationDataProvider()
    {
        return [
            'plain array' => [
                [
                    'first' => 'value1',
                    'second' => 'value2'
                ],
                [
                    'first' => ['value' => 'value1'],
                    'second' => ['value' => 'value2'],
                ]
            ],
            'two levels' => [
                [
                    'first.' => ['firstSub' => 'value1'],
                    'second.' => ['firstSub' => 'value2'],
                ],
                [
                    'first.firstSub' => ['value' => 'value1'],
                    'second.firstSub' => ['value' => 'value2'],
                ]
            ],
            'three levels' => [
                [
                    'first.' => ['firstSub.' => ['firstSubSub' => 'value1']],
                    'second.' => ['firstSub.' => ['firstSubSub' => 'value2']]
                ],
                [
                    'first.firstSub.firstSubSub' => ['value' => 'value1'],
                    'second.firstSub.firstSubSub' => ['value' => 'value2'],
                ]
            ],
            'mixed' => [
                [
                    'first.' => ['firstSub' => 'value1'],
                    'second.' => ['firstSub.' => ['firstSubSub' => 'value2']],
                    'third' => 'value3'
                ],
                [
                    'first.firstSub' => ['value' => 'value1'],
                    'second.firstSub.firstSubSub' => ['value' => 'value2'],
                    'third' => ['value' => 'value3']
                ]
            ]
        ];
    }

    public function convertNestedToValuedConfiguration(array $configuration, array $expected)
    {
        $subject = $this->getAccessibleMock(\TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility::class, ['dummy'], [], '', false);
        $this->assertEquals($expected, $subject->convertNestedToValuedConfiguration($configuration));
    }
}