PageResolverTest.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\Frontend\Tests\Unit\Middleware;
 
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;
use ‪TYPO3\CMS\Core\Http\JsonResponse;
use ‪TYPO3\CMS\Core\Http\NullResponse;
use ‪TYPO3\CMS\Core\Http\ServerRequest;
use ‪TYPO3\CMS\Core\Routing\PageArguments;
use ‪TYPO3\CMS\Core\Routing\PageRouter;
use ‪TYPO3\CMS\Core\Routing\SiteRouteResult;
use ‪TYPO3\CMS\Core\Site\Entity\Site;
use ‪TYPO3\CMS\Core\Site\Entity\SiteInterface;
use ‪TYPO3\CMS\Core\Site\Entity\SiteLanguage;
use ‪TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
use ‪TYPO3\CMS\Frontend\Middleware\PageResolver;
use TYPO3\TestingFramework\Core\AccessibleObjectInterface;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪PageResolverTest extends UnitTestCase
{
    protected ‪$resetSingletonInstances = true;
 
    protected ‪$controller;
 
    protected ‪$responseOutputHandler;
 
    protected ‪$subject;
 
    protected function ‪setUp(): void
    {
        self::markTestSkipped('Has to be adjusted');
 
        parent::setUp();
        $this->controller = $this->getAccessibleMock(TypoScriptFrontendController::class, ['getSiteScript', 'determineId', 'isBackendUserLoggedIn'], [], '', false);
 
        // A request handler which expects a site with some more details are found.
        $this->responseOutputHandler = new class() implements RequestHandlerInterface {
            public function handle(ServerRequestInterface $request): ResponseInterface
            {
                $site = $request->getAttribute('site');
                $language = $request->getAttribute('language');
                $routeResult = $request->getAttribute('routing', false);
                if ($routeResult) {
                    return new ‪JsonResponse(
                        [
                            'site' => $site->getIdentifier(),
                            'language-id' => $language->getLanguageId(),
                            'pageId' => $routeResult->getPageId(),
                        ]
                    );
                }
                return new ‪NullResponse();
            }
        };
    }
 
    public function ‪properSiteConfigurationLoadsPageRouter()
    {
        $incomingUrl = 'https://king.com/lotus-flower/en/mr-magpie/bloom';
        $pageRecord = ['uid' => 13, 'l10n_parent' => 0, 'slug' => '/mr-magpie/bloom'];
        $site = $this->getMockBuilder(Site::class)->setConstructorArgs([
            'lotus-flower', 13, [
                'base' => '/lotus-flower/',
                'languages' => [
                    0 => [
                        'languageId' => 0,
                        'locale' => 'en_US.UTF-8',
                        'base' => '/en/'
                    ],
                ]
            ]
        ])->setMethods(['getRouter'])->getMock();
        $language = $site->getDefaultLanguage();
 
        $request = new ‪ServerRequest($incomingUrl, 'GET');
        $request = $request->withAttribute('site', $site);
        $request = $request->withAttribute('language', $language);
        $request = $request->withAttribute('routing', new ‪SiteRouteResult($request->getUri(), $site, $language, 'mr-magpie/bloom'));
        $expectedRouteResult = new ‪PageArguments(13, '0', []);
 
        $pageRouterMock = $this->getMockBuilder(PageRouter::class)->disableOriginalConstructor()->setMethods(['matchRequest'])->getMock();
        $pageRouterMock->expects(self::once())->method('matchRequest')->willReturn($expectedRouteResult);
        $site->expects(self::any())->method('getRouter')->willReturn($pageRouterMock);
 
        ‪$subject = new ‪PageResolver($this->controller);
        $response = ‪$subject->‪process($request, $this->responseOutputHandler);
        $result = $response->getBody()->getContents();
        $result = json_decode($result, true);
        self::assertEquals('lotus-flower', $result['site']);
        self::assertEquals(13, $result['pageId']);
    }
 
    public function ‪properSiteConfigurationLoadsPageRouterWithRedirect()
    {
        $incomingUrl = 'https://king.com/lotus-flower/en/mr-magpie/bloom/';
        $pageRecord = ['uid' => 13, 'l10n_parent' => 0, 'slug' => '/mr-magpie/bloom'];
        $site = $this->getMockBuilder(Site::class)->setConstructorArgs([
            'lotus-flower', 13, [
                'base' => '/lotus-flower/',
                'languages' => [
                    0 => [
                        'languageId' => 0,
                        'locale' => 'en_US.UTF-8',
                        'base' => '/en/'
                    ],
                ]
            ]
        ])->setMethods(['getRouter'])->getMock();
        $language = $site->getDefaultLanguage();
 
        $request = new ‪ServerRequest($incomingUrl, 'GET');
        $request = $request->withAttribute('site', $site);
        $request = $request->withAttribute('language', $language);
        $request = $request->withAttribute('routing', new ‪SiteRouteResult($request->getUri(), $site, $language, 'mr-magpie/bloom/'));
 
        $expectedRouteResult = new ‪PageArguments(13, '0', []);
        $pageRouterMock = $this->getMockBuilder(PageRouter::class)->disableOriginalConstructor()->setMethods(['matchRequest'])->getMock();
        $pageRouterMock->expects(self::once())->method('matchRequest')->willReturn($expectedRouteResult);
        $site->expects(self::any())->method('getRouter')->willReturn($pageRouterMock);
 
        ‪$subject = new ‪PageResolver($this->controller);
        $response = ‪$subject->‪process($request, $this->responseOutputHandler);
        self::assertEquals(307, $response->getStatusCode());
        self::assertEquals('https://king.com/lotus-flower/en/mr-magpie/bloom', $response->getHeader('Location')[0]);
    }
 
    public function ‪properSiteConfigurationLoadsPageRouterWithRedirectWithoutTrailingSlash()
    {
        $incomingUrl = 'https://king.com/lotus-flower/en/mr-magpie/bloom';
        $pageRecord = ['uid' => 13, 'l10n_parent' => 0, 'slug' => '/mr-magpie/bloom/'];
        $site = $this->getMockBuilder(Site::class)->setConstructorArgs([
            'lotus-flower', 13, [
                'base' => '/lotus-flower/',
                'languages' => [
                    0 => [
                        'languageId' => 0,
                        'locale' => 'en_US.UTF-8',
                        'base' => '/en/'
                    ],
                ]
            ]
        ])->setMethods(['getRouter'])->getMock();
        $language = $site->getDefaultLanguage();
 
        $request = new ServerRequest($incomingUrl, 'GET');
        $request = $request->withAttribute('site', $site);
        $request = $request->withAttribute('language', $language);
        $request = $request->withAttribute('routing', new SiteRouteResult($request->getUri(), $site, $language, 'mr-magpie/bloom/'));
 
        $expectedRouteResult = new PageArguments(13, '0', []);
        $pageRouterMock = $this->getMockBuilder(PageRouter::class)->disableOriginalConstructor()->setMethods(['matchRequest'])->getMock();
        $pageRouterMock->expects(self::once())->method('matchRequest')->willReturn($expectedRouteResult);
        $site->expects(self::any())->method('getRouter')->willReturn($pageRouterMock);
 
        ‪$subject = new PageResolver($this->controller);
        $response = ‪$subject->‪process($request, $this->responseOutputHandler);
        self::assertEquals(307, $response->getStatusCode());
        self::assertEquals('https://king.com/lotus-flower/en/mr-magpie/bloom/', $response->getHeader('Location')[0]);
    }
}