AdminPanelInitiatorTest.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
namespace ‪TYPO3\CMS\Adminpanel\Tests\Unit\Middleware;
 
/*
 * 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 Prophecy\Prophecy\ObjectProphecy;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;
use ‪TYPO3\CMS\Adminpanel\Controller\MainController;
use ‪TYPO3\CMS\Adminpanel\Middleware\AdminPanelInitiator;
use ‪TYPO3\CMS\Backend\FrontendBackendUserAuthentication;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪AdminPanelInitiatorTest extends UnitTestCase
{
    protected ‪$resetSingletonInstances = true;
 
    public function ‪processCallsInitialize(): void
    {
        $tsConfig = [
            'admPanel.' => [
                'enable.' => [
                    'all',
                ],
            ],
        ];
        $uc = [
            'AdminPanel' => [
                'display_top' => true
            ]
        ];
        $userAuthentication = $this->prophesize(FrontendBackendUserAuthentication::class);
        $userAuthentication->getTSConfig()->willReturn($tsConfig);
        $userAuthentication->uc = $uc;
        ‪$GLOBALS['BE_USER'] = $userAuthentication->reveal();
 
        $tsfe = $this->prophesize(TypoScriptFrontendController::class);
        ‪$GLOBALS['TSFE'] = $tsfe;
 
        $controller = $this->prophesize(MainController::class);
        GeneralUtility::setSingletonInstance(MainController::class, $controller->reveal());
        $handler = $this->‪prophesizeHandler();
        $request = $this->prophesize(ServerRequestInterface::class);
        $request->withAttribute(Argument::cetera())->willReturn($request);
        // Act
        $adminPanelInitiator = new ‪AdminPanelInitiator();
        $adminPanelInitiator->process(
            $request->reveal(),
            $handler->reveal()
        );
        // Assert
        $controller->initialize(Argument::any())->shouldHaveBeenCalled();
    }
 
    public function ‪processDoesNotCallInitializeIfAdminPanelIsNotEnabledInUC(): void
    {
        $tsConfig = [
            'admPanel.' => [
                'enable.' => [
                    'all',
                ],
            ],
        ];
        $uc = [
            'AdminPanel' => [
                'display_top' => false
            ]
        ];
        $this->‪checkAdminPanelDoesNotCallInitialize($tsConfig, $uc);
    }
 
    public function ‪processDoesNotCallInitializeIfNoAdminPanelModuleIsEnabled(): void
    {
        $tsConfig = [
            'admPanel.' => [],
        ];
        $uc = [
            'AdminPanel' => [
                'display_top' => true
            ]
        ];
        $this->‪checkAdminPanelDoesNotCallInitialize($tsConfig, $uc);
    }
 
    protected function ‪checkAdminPanelDoesNotCallInitialize($tsConfig, $uc): void
    {
        $userAuthentication = $this->prophesize(FrontendBackendUserAuthentication::class);
        $userAuthentication->getTSConfig()->willReturn($tsConfig);
        $userAuthentication->uc = $uc;
        ‪$GLOBALS['BE_USER'] = $userAuthentication->reveal();
 
        $tsfe = $this->prophesize(TypoScriptFrontendController::class);
        ‪$GLOBALS['TSFE'] = $tsfe;
 
        $controller = $this->prophesize(MainController::class);
        GeneralUtility::setSingletonInstance(MainController::class, $controller->reveal());
        $handler = $this->‪prophesizeHandler();
        $request = $this->prophesize(ServerRequestInterface::class);
        // Act
        $adminPanelInitiator = new ‪AdminPanelInitiator();
        $adminPanelInitiator->process(
            $request->reveal(),
            $handler->reveal()
        );
        // Assert
        $controller->initialize(Argument::any())->shouldNotHaveBeenCalled();
    }
 
    protected function ‪prophesizeHandler()
    {
        $handler = $this->prophesize(RequestHandlerInterface::class);
        $handler
            ->handle(Argument::any())
            ->willReturn(
                $this->prophesize(ResponseInterface::class)->reveal()
            );
        return $handler;
    }
}