9.5/adminpanel_2_tests_2_unit_2_service_2_configuration_service_test_8php_source.html

<?php

declare(strict_types = 1);


namespace ‪TYPO3\CMS\Adminpanel\Tests\Unit\Service;


use Prophecy\Argument;

use Psr\Http\Message\ServerRequestInterface;

use ‪TYPO3\CMS\Adminpanel\Service\ConfigurationService;

use ‪TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture;

use ‪TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\SubModuleFixture;

use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;

use TYPO3\TestingFramework\Core\Unit\UnitTestCase;


class ‪ConfigurationServiceTest extends UnitTestCase

{

    protected ‪$beUserProphecy;


    public function ‪setUp()

    {

        parent::setUp();

        $this->beUserProphecy = $this->prophesize(BackendUserAuthentication::class);

        ‪$GLOBALS['BE_USER'] = $this->beUserProphecy->reveal();

    }


    public function ‪getMainConfigurationReturnsTsConfigFromUser(): void

    {

        $userTsAdmPanelConfig = [

            'enable.' => [

                'all' => '1',

            ],

        ];

        $this->‪setUpUserTsConfigForAdmPanel($userTsAdmPanelConfig);


        $configurationService = new ‪ConfigurationService();

        $result = $configurationService->getMainConfiguration();


        self::assertSame($userTsAdmPanelConfig, $result);

    }


    public function ‪getConfigurationOptionReturnsEmptyStringIfNoConfigurationFound(): void

    {

        $configurationService = new ConfigurationService();

        $result = $configurationService->getConfigurationOption('foo', 'bar');

        self::assertSame('', $result);

    }


    public function ‪getConfigurationOptionReturnsOverrideOptionIfSet(): void

    {

        $this->‪setUpUserTsConfigForAdmPanel(

            [

                'override.' => [

                    'preview.' => [

                        'showHiddenPages' => '1',

                    ],

                ],

            ]

        );


        $configurationService = new ConfigurationService();

        $result = $configurationService->getConfigurationOption('preview', 'showHiddenPages');


        self::assertSame('1', $result);

    }


    public function ‪getConfigurationOptionCastsResultToString(): void

    {

        $this->‪setUpUserTsConfigForAdmPanel(

            [

                'override.' => [

                    'preview.' => [

                        'showHiddenPages' => 1,

                    ],

                ],

            ]

        );


        $configurationService = new ConfigurationService();

        $result = $configurationService->getConfigurationOption('preview', 'showHiddenPages');


        self::assertSame('1', $result);

    }


    public function ‪getConfigurationOptionEmptyArgumentDataProvider(): array

    {

        return [

            'empty identifier' => [

                '',

                'foo',

            ],

            'empty option' => [

                'foo',

                '',

            ],

            'both empty' => [

                '',

                '',

            ],

        ];

    }


    public function ‪getConfigurationOptionThrowsExceptionOnEmptyArgument($identifier, $option): void

    {

        $this->expectException(\InvalidArgumentException::class);

        $this->expectExceptionCode(1532861423);


        $configurationService = new ‪ConfigurationService();

        $configurationService->getConfigurationOption($identifier, $option);

    }


    public function ‪getConfigurationOptionReturnsSettingFromUcIfNoOverrideGiven(): void

    {

        $this->‪setUpUserTsConfigForAdmPanel([]);

        $this->beUserProphecy->uc = [

            'AdminPanel' => [

                'preview_showHiddenPages' => '1',

            ],

        ];


        $configurationService = new ConfigurationService();

        $result = $configurationService->getConfigurationOption('preview', 'showHiddenPages');


        self::assertSame('1', $result);

    }


    public function ‪saveConfigurationTriggersOnSubmitOnEnabledModules(): void

    {

        $subModuleFixture = $this->prophesize(SubModuleFixture::class);

        $mainModuleFixture = $this->prophesize(MainModuleFixture::class);

        $mainModuleFixture->isEnabled()->willReturn(true);

        $mainModuleFixture->onSubmit(Argument::cetera())->shouldBeCalled()->hasReturnVoid();

        $mainModuleFixture->getSubModules()->willReturn(

            [$subModuleFixture->reveal()]

        );

        $modules = [

            $mainModuleFixture->reveal(),

        ];


        $requestProphecy = $this->prophesize(ServerRequestInterface::class);


        $configurationService = new ConfigurationService();

        $configurationService->saveConfiguration($modules, $requestProphecy->reveal());


        $mainModuleFixture->onSubmit([], $requestProphecy->reveal())->shouldHaveBeenCalled();

        $subModuleFixture->onSubmit([], $requestProphecy->reveal())->shouldHaveBeenCalled();

    }


    public function ‪saveConfigurationSavesMergedExistingAndNewConfiguration(): void

    {

        // existing configuration from UC

        $this->beUserProphecy->uc = [

            'AdminPanel' => [

                'foo' => 'bar',

            ],

        ];


        // new configuration to save

        $requestProphecy = $this->prophesize(ServerRequestInterface::class);

        $requestProphecy->getParsedBody()->willReturn(

            [

                'TSFE_ADMIN_PANEL' => [

                    'baz' => 'bam',

                ],

            ]

        );


        $configurationService = new ConfigurationService();

        $configurationService->saveConfiguration([], $requestProphecy->reveal());


        $expected = [

            'AdminPanel' => [

                'foo' => 'bar',

                'baz' => 'bam',

            ],

        ];

        self::assertSame($expected, $this->beUserProphecy->uc);

        $this->beUserProphecy->writeUC()->shouldHaveBeenCalled();

    }


    private function ‪setUpUserTsConfigForAdmPanel($userTsAdmPanelConfig): void

    {

        $this->beUserProphecy->getTSConfig()->willReturn(

            ['admPanel.' => $userTsAdmPanelConfig]

        );

    }

}