RootlineUtilityTest.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\Core\Tests\Functional\Utility;
 
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Core\Context\Context;
use ‪TYPO3\CMS\Core\Context\WorkspaceAspect;
use ‪TYPO3\CMS\Core\Exception\Page\PageNotFoundException;
use ‪TYPO3\CMS\Core\Localization\LanguageServiceFactory;
use ‪TYPO3\CMS\Core\Tests\Functional\SiteHandling\SiteBasedTestTrait;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\RootlineUtility;
use TYPO3\TestingFramework\Core\Functional\Framework\DataHandling\Scenario\DataHandlerFactory;
use TYPO3\TestingFramework\Core\Functional\Framework\DataHandling\Scenario\DataHandlerWriter;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
 
final class ‪RootlineUtilityTest extends FunctionalTestCase
{
    use ‪SiteBasedTestTrait;
 
    protected const ‪LANGUAGE_PRESETS = [
        'EN' => ['id' => 0, 'title' => 'English', 'locale' => 'en_US.UTF8'],
        'FR' => ['id' => 1, 'title' => 'French', 'locale' => 'fr_FR.UTF8'],
        'FR-CA' => ['id' => 2, 'title' => 'Franco-Canadian', 'locale' => 'fr_CA.UTF8'],
        'ES' => ['id' => 3, 'title' => 'Spanish', 'locale' => 'es_ES.UTF8'],
    ];
 
    protected array ‪$coreExtensionsToLoad = ['workspaces'];
 
    protected function ‪setUp(): void
    {
        parent::setUp();
 
        $this->‪writeSiteConfiguration(
            'main',
            $this->‪buildSiteConfiguration(1000, 'https://acme.com/'),
            [
                $this->‪buildDefaultLanguageConfiguration('EN', '/'),
                $this->‪buildLanguageConfiguration('FR', '/fr/', ['EN']),
                $this->‪buildLanguageConfiguration('FR-CA', '/fr-ca/', ['FR', 'EN']),
            ]
        );
        $this->withDatabaseSnapshot(function () {
            $this->importCSVDataSet(__DIR__ . '/../Fixtures/be_users.csv');
            $backendUser = $this->setUpBackendUser(1);
            ‪$GLOBALS['LANG'] = $this->get(LanguageServiceFactory::class)->createFromUserPreferences($backendUser);
            $factory = DataHandlerFactory::fromYamlFile(__DIR__ . '/Fixtures/RootlineScenario.yaml');
            $writer = DataHandlerWriter::withBackendUser($backendUser);
            $writer->invokeFactory($factory);
            static::failIfArrayIsNotEmpty($writer->getErrors());
        });
    }
 
    #[Test]
    public function ‪getForRootPageOnlyReturnsRootPageInformation(): void
    {
        $rootPageUid = 1000;
        $subject = new ‪RootlineUtility($rootPageUid);
 
        $result = $subject->get();
 
        self::assertCount(1, $result);
        self::assertSame($rootPageUid, (int)$result[0]['uid']);
    }
 
    #[Test]
    public function ‪getForRootPageAndWithMissingTableColumnsTcaReturnsEmptyArray(): void
    {
        $rootPageUid = 1000;
        $subject = new ‪RootlineUtility($rootPageUid);
 
        unset(‪$GLOBALS['TCA']['pages']['columns']);
        $result = $subject->get();
 
        self::assertCount(1, $result);
        self::assertSame($rootPageUid, (int)$result[0]['uid']);
    }
 
    #[Test]
    public function ‪getForRootPageAndWithNonArrayTableColumnsTcaReturnsEmptyArray(): void
    {
        $rootPageUid = 1000;
        $subject = new ‪RootlineUtility($rootPageUid);
 
        ‪$GLOBALS['TCA']['pages']['columns'] = 'This is not an array.';
        $result = $subject->get();
 
        self::assertCount(1, $result);
        self::assertSame($rootPageUid, (int)$result[0]['uid']);
    }
 
    #[Test]
    public function ‪resolveLivePagesAndSkipWorkspacedVersions(): void
    {
        $context = GeneralUtility::makeInstance(Context::class);
        $context->setAspect('workspace', new ‪WorkspaceAspect(0));
        $subject = new ‪RootlineUtility(1330, '', $context);
        $result = $subject->get();
 
        $expected = [
            2 => [
                'pid' => 1300,
                'uid' => 1330,
                't3ver_oid' => 0,
                't3ver_wsid' => 0,
                't3ver_state' => 0,
                'title' => 'EN: Board Games',
            ],
            1 => [
                'pid' => 1000,
                'uid' => 1300,
                't3ver_oid' => 0,
                't3ver_wsid' => 0,
                't3ver_state' => 0,
                'title' => 'EN: Products',
            ],
            0 => [
                'pid' => 0,
                'uid' => 1000,
                't3ver_oid' => 0,
                't3ver_wsid' => 0,
                't3ver_state' => 0,
                'title' => 'ACME Global',
            ],
        ];
        self::assertSame($expected, $this->‪filterExpectedValues($result, ['pid', 'uid', 't3ver_oid', 't3ver_wsid', 't3ver_state', 'title']));
    }
 
    #[Test]
    public function ‪resolveWorkspaceOverlaysOfNewPageInWorkspace(): void
    {
        $context = GeneralUtility::makeInstance(Context::class);
        $context->setAspect('workspace', new ‪WorkspaceAspect(1));
        $subject = new ‪RootlineUtility(1400, '', $context);
        $result = $subject->get();
 
        $expected = [
            1 => [
                'pid' => 1000,
                'uid' => 1400,
                't3ver_oid' => 0,
                't3ver_wsid' => 1,
                't3ver_state' => 1,
                'title' => 'EN: A new page in workspace',
            ],
            0 => [
                'pid' => 0,
                'uid' => 1000,
                't3ver_oid' => 1000,
                't3ver_wsid' => 1,
                't3ver_state' => 0,
                'title' => 'ACME Global modified in Workspace 1',
                '_ORIG_uid' => 10000,
            ],
        ];
        self::assertSame($expected, $this->‪filterExpectedValues($result, ['pid', 'uid', 't3ver_oid', 't3ver_wsid', 't3ver_state', 'title', '_ORIG_uid', '_ORIG_pid']));
    }
 
    #[Test]
    public function ‪resolveLiveRootLineForMovedPage(): void
    {
        $context = GeneralUtility::makeInstance(Context::class);
        $context->setAspect('workspace', new ‪WorkspaceAspect(0));
        $subject = new ‪RootlineUtility(1333, '', $context);
        $result = $subject->get();
 
        $expected = [
            3 => [
                'pid' => 1330,
                'uid' => 1333,
                't3ver_oid' => 0,
                't3ver_wsid' => 0,
                't3ver_state' => 0,
                'title' => 'EN: Risk',
            ],
            2 => [
                'pid' => 1300,
                'uid' => 1330,
                't3ver_oid' => 0,
                't3ver_wsid' => 0,
                't3ver_state' => 0,
                'title' => 'EN: Board Games',
            ],
            1 => [
                'pid' => 1000,
                'uid' => 1300,
                't3ver_oid' => 0,
                't3ver_wsid' => 0,
                't3ver_state' => 0,
                'title' => 'EN: Products',
            ],
            0 => [
                'pid' => 0,
                'uid' => 1000,
                't3ver_oid' => 0,
                't3ver_wsid' => 0,
                't3ver_state' => 0,
                'title' => 'ACME Global',
            ],
        ];
        self::assertSame($expected, $this->‪filterExpectedValues($result, ['pid', 'uid', 't3ver_oid', 't3ver_wsid', 't3ver_state', 'title', '_ORIG_uid', '_ORIG_pid']));
    }
 
    #[Test]
    public function ‪resolveWorkspaceOverlaysOfMovedPage(): void
    {
        $context = GeneralUtility::makeInstance(Context::class);
        $context->setAspect('workspace', new ‪WorkspaceAspect(1));
        $subject = new ‪RootlineUtility(1333, '', $context);
        $result = $subject->get();
 
        $expected = [
            3 => [
                'pid' => 1320,
                'uid' => 1333,
                't3ver_oid' => 1333,
                't3ver_wsid' => 1,
                't3ver_state' => 4,
                'title' => 'EN: Risk',
                '_ORIG_pid' => 1330, // Pointing to the LIVE pid! WHY? All others point to the same PID! @todo
                '_ORIG_uid' => 10001,
            ],
            2 => [
                'pid' => 1300,
                'uid' => 1320,
                't3ver_oid' => 0,
                't3ver_wsid' => 0,
                't3ver_state' => 0,
                'title' => 'EN: Card Games',
            ],
            1 => [
                'pid' => 1000,
                'uid' => 1300,
                't3ver_oid' => 0,
                't3ver_wsid' => 0,
                't3ver_state' => 0,
                'title' => 'EN: Products',
            ],
            0 => [
                'pid' => 0,
                'uid' => 1000,
                't3ver_oid' => 1000,
                't3ver_wsid' => 1,
                't3ver_state' => 0,
                'title' => 'ACME Global modified in Workspace 1',
                '_ORIG_uid' => 10000,
            ],
        ];
        self::assertSame($expected, $this->‪filterExpectedValues($result, ['pid', 'uid', 't3ver_oid', 't3ver_wsid', 't3ver_state', 'title', '_ORIG_uid', '_ORIG_pid']));
 
        // Now explicitly requesting the versioned ID, which holds the same result
        $subject = new ‪RootlineUtility(10001, '', $context);
        $result = $subject->get();
        self::assertSame($expected, $this->‪filterExpectedValues($result, ['pid', 'uid', 't3ver_oid', 't3ver_wsid', 't3ver_state', 'title', '_ORIG_uid', '_ORIG_pid']));
    }
 
    #[Test]
    public function ‪rootlineFailsForDeletedParentPageInWorkspace(): void
    {
        $this->expectException(PageNotFoundException::class);
        $this->expectExceptionCode(1343464101);
        $context = GeneralUtility::makeInstance(Context::class);
        $context->setAspect('workspace', new ‪WorkspaceAspect(2));
        $subject = new ‪RootlineUtility(1310, '', $context);
        $subject->get();
    }
 
    protected function ‪filterExpectedValues(array $incomingData, array ‪$fields): array
    {
        $result = [];
        foreach ($incomingData as $pos => $values) {
            array_walk($values, static function (&$val) {
                if (is_numeric($val)) {
                    $val = (int)$val;
                }
            });
            $result[$pos] = array_filter($values, static function ($fieldName) use (‪$fields) {
                return in_array($fieldName, ‪$fields, true);
            }, ARRAY_FILTER_USE_KEY);
        }
        return $result;
    }
}