RedirectFinisherTest.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\Form\Tests\Unit\Domain\Finishers;
 
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Core\Http\PropagateResponseException;
use ‪TYPO3\CMS\Core\Http\Response;
use ‪TYPO3\CMS\Core\Http\ServerRequest;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters;
use ‪TYPO3\CMS\Extbase\Mvc\Request;
use ‪TYPO3\CMS\Form\Domain\Finishers\FinisherContext;
use ‪TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher;
use ‪TYPO3\CMS\Form\Domain\Runtime\FormRuntime;
use ‪TYPO3\CMS\Form\Service\TranslationService;
use ‪TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
use ‪TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪RedirectFinisherTest extends UnitTestCase
{
    protected bool ‪$resetSingletonInstances = true;
 
    #[DataProvider('pageUidOptionForFinisherAcceptsVariousPageRepresentationsDataProvider')]
    #[Test]
    public function ‪pageUidOptionForFinisherAcceptsVariousPageRepresentations($pageUid, int $expectedPage): void
    {
        $uriPrefix = 'https://site.test/?id=';
        $contentObjectRendererMock = $this->createMock(ContentObjectRenderer::class);
        $contentObjectRendererMock->method('createUrl')->willReturnCallback(static function (array $conf) use ($uriPrefix): string {
            return $uriPrefix . $conf['parameter'];
        });
        $frontendControllerMock = $this->createMock(TypoScriptFrontendController::class);
        $frontendController = $frontendControllerMock;
        $frontendController->cObj = $contentObjectRendererMock;
        ‪$GLOBALS['TSFE'] = $frontendController;
 
        $redirectFinisherMock = $this->getAccessibleMock(RedirectFinisher::class, null, [], '', false);
        $redirectFinisherMock->_set('options', [
            'pageUid' => $pageUid,
        ]);
 
        $formRuntimeMock = $this->createMock(FormRuntime::class);
        $serverRequest = (new ‪ServerRequest())->withAttribute('extbase', new ‪ExtbaseRequestParameters());
        $request = new ‪Request($serverRequest);
        $formRuntimeMock->method('getRequest')->willReturn($request);
        $formRuntimeMock->method('getResponse')->willReturn(new ‪Response());
 
        $finisherContextMock = $this->createMock(FinisherContext::class);
        $finisherContextMock->method('getFormRuntime')->willReturn($formRuntimeMock);
        $finisherContextMock->expects(self::once())->method('cancel');
 
        $translationServiceMock = $this->createMock(TranslationService::class);
        $translationServiceMock->method('translateFinisherOption')->with(self::anything())->willReturnArgument(3);
        GeneralUtility::setSingletonInstance(TranslationService::class, $translationServiceMock);
 
        try {
            $redirectFinisherMock->execute($finisherContextMock);
            self::fail('RedirectFinisher did not throw expected exception.');
        }  catch (‪PropagateResponseException $e) {
            $response = $e->‪getResponse();
            self::assertSame($uriPrefix . $expectedPage, $response->getHeader('Location')[0]);
        }
    }
 
    public static function ‪pageUidOptionForFinisherAcceptsVariousPageRepresentationsDataProvider(): array
    {
        return [
            'null' => [
                null,
                1,
            ],
            'no page' => [
                '',
                1,
            ],
            'page as integer' => [
                3,
                3,
            ],
            'page as string' => [
                '3',
                3,
            ],
            'page with table prefix' => [
                'pages_3',
                3,
            ],
        ];
    }
}