StateUtilityTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Adminpanel\Tests\Unit\Utility;
 
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Adminpanel\Utility\StateUtility;
use ‪TYPO3\CMS\Backend\FrontendBackendUserAuthentication;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪StateUtilityTest extends UnitTestCase
{
    #[Test]
    public function ‪isEnabledReturnsFalseIfNoBackendUserExists(): void
    {
        ‪$GLOBALS['BE_USER'] = false;
        $isEnabled = ‪StateUtility::isActivatedForUser();
        self::assertFalse($isEnabled);
    }
 
    #[Test]
    public function ‪isEnabledReturnsFalseIfNoBackendUserInFrontendContextIsLoggedIn(): void
    {
        ‪$GLOBALS['BE_USER'] = $this->getMockBuilder(BackendUserAuthentication::class)->disableOriginalConstructor()->getMock();
        $isEnabled = ‪StateUtility::isActivatedForUser();
        self::assertFalse($isEnabled);
    }
 
    public static function ‪tsConfigEnabledDataProvider(): array
    {
        return [
            '1 module enabled' => [
                [
                    'admPanel.' => [
                        'enable.' => [
                            'preview' => 1,
                        ],
                    ],
                ],
            ],
            'all modules enabled' => [
                [
                    'admPanel.' => [
                        'enable.' => [
                            'all' => 1,
                        ],
                    ],
                ],
            ],
        ];
    }
 
    #[DataProvider('tsConfigEnabledDataProvider')]
    #[Test]
    public function ‪isEnabledReturnsTrueIfAtLeastOneModuleIsEnabled(array $tsConfig): void
    {
        $beUserMock = $this->getMockBuilder(FrontendBackendUserAuthentication::class)->disableOriginalConstructor()->getMock();
        $beUserMock->method('getTSConfig')->willReturn($tsConfig);
        ‪$GLOBALS['BE_USER'] = $beUserMock;
        $isEnabled = ‪StateUtility::isActivatedForUser();
        self::assertTrue($isEnabled);
    }
 
    public static function ‪tsConfigDisabledDataProvider(): array
    {
        return [
            'no config set' => [
                [],
            ],
            'all modules disabled' => [
                [
                    'admPanel.' => [
                        'enable.' => [
                            'all' => 0,
                        ],
                    ],
                ],
            ],
            'single module configured, disabled' => [
                [
                    'admPanel.' => [
                        'enable.' => [
                            'preview' => 0,
                        ],
                    ],
                ],
            ],
        ];
    }
 
    #[DataProvider('tsConfigDisabledDataProvider')]
    #[Test]
    public function ‪isEnabledReturnsFalseIfNoModulesEnabled(array $tsConfig): void
    {
        $beUserMock = $this->getMockBuilder(FrontendBackendUserAuthentication::class)->disableOriginalConstructor()->getMock();
        $beUserMock->method('getTSConfig')->willReturn($tsConfig);
        ‪$GLOBALS['BE_USER'] = $beUserMock;
        $isEnabled = ‪StateUtility::isActivatedForUser();
        self::assertFalse($isEnabled);
    }
 
    public static function ‪tsConfigHideDataProvider(): array
    {
        return [
            'no config set' => [
                [],
                false,
            ],
            'defined as not hidden' => [
                [
                    'admPanel.' => [
                        'hide' => '0',
                    ],
                ],
                false,
            ],
            'defined as hidden' => [
                [
                    'admPanel.' => [
                        'hide' => '1',
                    ],
                ],
                true,
            ],
        ];
    }
 
    #[DataProvider('tsConfigHideDataProvider')]
    #[Test]
    public function ‪isHiddenForUserReturnsCorrectValue(array $tsConfig, bool $expected): void
    {
        $beUserMock = $this->getMockBuilder(FrontendBackendUserAuthentication::class)->disableOriginalConstructor()->getMock();
        $beUserMock->method('getTSConfig')->willReturn($tsConfig);
        ‪$GLOBALS['BE_USER'] = $beUserMock;
        $isEnabled = ‪StateUtility::isHiddenForUser();
        self::assertSame($expected, $isEnabled);
    }
 
    #[Test]
    public function ‪isHiddenForUserReturnsFalseIfUserIsNotAvailable(): void
    {
        ‪$GLOBALS['BE_USER'] = null;
        $isEnabled = ‪StateUtility::isHiddenForUser();
        self::assertFalse($isEnabled);
    }
 
    public static function ‪ucDisplayOpenDataProvider(): array
    {
        return [
            'no config set' => [
                [],
                false,
            ],
            'defined as display_top=false' => [
                [
                    'AdminPanel' => [
                        'display_top' => false,
                    ],
                ],
                false,
            ],
            'defined as display_top=true' => [
                [
                    'AdminPanel' => [
                        'display_top' => true,
                    ],
                ],
                true,
            ],
        ];
    }
 
    #[DataProvider('ucDisplayOpenDataProvider')]
    #[Test]
    public function ‪isOpenForUserReturnsCorrectValue(array $uc, bool $expected): void
    {
        $beUser = new ‪FrontendBackendUserAuthentication();
        $beUser->uc = $uc;
        ‪$GLOBALS['BE_USER'] = $beUser;
        $isOpen = ‪StateUtility::isOpen();
        self::assertSame($expected, $isOpen);
    }
 
    #[Test]
    public function ‪isOpenForUserReturnsFalseIfUserIsNotAvailable(): void
    {
        ‪$GLOBALS['BE_USER'] = null;
        $isOpen = ‪StateUtility::isOpen();
        self::assertFalse($isOpen);
    }
}