ShortcutControllerTest.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\Backend\Tests\Functional\Controller;
 
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Backend\Backend\Shortcut\ShortcutRepository;
use ‪TYPO3\CMS\Backend\Backend\ToolbarItems\ShortcutToolbarItem;
use ‪TYPO3\CMS\Backend\Controller\ShortcutController;
use ‪TYPO3\CMS\Backend\View\BackendViewFactory;
use ‪TYPO3\CMS\Core\Http\NormalizedParams;
use ‪TYPO3\CMS\Core\Http\ServerRequest;
use ‪TYPO3\CMS\Core\Localization\LanguageServiceFactory;
use TYPO3\CMS\Core\Package\PackageManager;
use ‪TYPO3\CMS\Fluid\Core\Rendering\RenderingContextFactory;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
 
final class ‪ShortcutControllerTest extends FunctionalTestCase
{
    protected ‪ShortcutController ‪$subject;
    protected ‪ServerRequest ‪$request;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
 
        $this->importCSVDataSet(__DIR__ . '/../Fixtures/sys_be_shortcuts.csv');
        $this->importCSVDataSet(__DIR__ . '/../Fixtures/be_users.csv');
        $backendUser = $this->setUpBackendUser(1);
        ‪$GLOBALS['LANG'] = $this->get(LanguageServiceFactory::class)->createFromUserPreferences($backendUser);
 
        $this->subject = new ‪ShortcutController(
            $this->get(ShortcutToolbarItem::class),
            $this->get(ShortcutRepository::class),
            new ‪BackendViewFactory($this->get(RenderingContextFactory::class), $this->get(PackageManager::class))
        );
        $this->request = (new ‪ServerRequest('https://example.com/typo3/'))->withAttribute('normalizedParams', new ‪NormalizedParams([], [], '', ''));
        ‪$GLOBALS['TYPO3_REQUEST'] = ‪$this->request;
    }
 
    #[DataProvider('addShortcutTestDataProvide')]
    #[Test]
    public function ‪addShortcutTest(array $parsedBody, string $expectedResponseBody, int $expectedResponseStatus): void
    {
        ‪$request = $this->request->‪withParsedBody($parsedBody);
        $response = $this->subject->addAction(‪$request);
        self::assertEquals($expectedResponseBody, $response->getBody());
        self::assertEquals($expectedResponseStatus, $response->getStatusCode());
    }
 
    public static function ‪addShortcutTestDataProvide(): \Generator
    {
        yield 'No route defined' => [
            [],
            json_encode(['result' => 'missingRoute'], JSON_THROW_ON_ERROR),
            400,
        ];
        yield 'Existing data as parsed body' => [
            [
                'routeIdentifier' => 'web_layout',
                'arguments' => '{"id":"123"}',
            ],
            json_encode(['result' => 'alreadyExists'], JSON_THROW_ON_ERROR),
            200,
        ];
        yield 'Invalid route identifier' => [
            [
                'routeIdentifier' => 'invalid_route_identifier',
            ],
            json_encode(['result' => 'failed'], JSON_THROW_ON_ERROR),
            500,
        ];
        yield 'New data as parsed body' => [
            [
                'routeIdentifier' => 'web_list',
                'arguments' => '{"id":"123","GET":{"clipBoard":"1"}}',
            ],
            json_encode(['result' => 'success'], JSON_THROW_ON_ERROR),
            201,
        ];
    }
}