IntegrityServiceTest.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\Redirects\Tests\Functional\Service;
 
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\MockObject\MockObject;
use ‪TYPO3\CMS\Core\Cache\CacheManager;
use ‪TYPO3\CMS\Core\Cache\Frontend\PhpFrontend;
use ‪TYPO3\CMS\Core\EventDispatcher\NoopEventDispatcher;
use ‪TYPO3\CMS\Core\LinkHandling\LinkService;
use ‪TYPO3\CMS\Core\Log\LogManager;
use ‪TYPO3\CMS\Core\Site\Entity\Site;
use ‪TYPO3\CMS\Core\Site\SiteFinder;
use TYPO3\CMS\Core\TypoScript\FrontendTypoScriptFactory;
use ‪TYPO3\CMS\Frontend\Page\PageInformationFactory;
use ‪TYPO3\CMS\Redirects\Service\IntegrityService;
use ‪TYPO3\CMS\Redirects\Service\RedirectCacheService;
use ‪TYPO3\CMS\Redirects\Service\RedirectService;
use ‪TYPO3\CMS\Redirects\Utility\RedirectConflict;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
 
final class ‪IntegrityServiceTest extends FunctionalTestCase
{
    protected bool ‪$resetSingletonInstances = true;
    protected array ‪$coreExtensionsToLoad = ['redirects'];
    protected ‪IntegrityService ‪$subject;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $siteFinder = $this->‪getSiteFinderMock();
        $typoScriptCache = $this->get(CacheManager::class)->getCache('typoscript');
        $this->subject = new ‪IntegrityService(
            new ‪RedirectService(
                new ‪RedirectCacheService(),
                $this->getMockBuilder(LinkService::class)->disableOriginalConstructor()->getMock(),
                $siteFinder,
                new ‪NoopEventDispatcher(),
                $this->get(PageInformationFactory::class),
                $this->get(FrontendTypoScriptFactory::class),
                $typoScriptCache,
                $this->get(LogManager::class)->getLogger('Testing'),
            ),
            $siteFinder
        );
    }
 
    #[Test]
    public function ‪sourcePathWithMatchingSlugInLocalizedPageIsNotReportedAsConflict(): void
    {
        $this->importCSVDataSet(__DIR__ . '/Fixtures/IntegrityServiceTest_sourcePathWithMatchingSlugInLocalizedPageIsNotReportedAsConflict.csv');
 
        $result = $this->subject->findConflictingRedirects('localized-page');
        $this->‪assertExpectedPathsFromGenerator([], $result);
    }
 
    #[Test]
    public function ‪conflictingRedirectsAreFoundForDefinedSiteOnly(): void
    {
        $this->importCSVDataSet(__DIR__ . '/Fixtures/SimplePages.csv');
        $this->importCSVDataSet(__DIR__ . '/Fixtures/sys_redirect.csv');
 
        $expectedConflicts = [
            [
                'uri' => 'https://example.com/',
                'redirect' => [
                    'integrity_status' => ‪RedirectConflict::SELF_REFERENCE,
                    'source_host' => 'example.com',
                    'source_path' => '/',
                    'uid' => 7,
                ],
            ],
            [
                'uri' => 'https://example.com/about-us/we-are-here',
                'redirect' => [
                    'integrity_status' => ‪RedirectConflict::SELF_REFERENCE,
                    'source_host' => '*',
                    'source_path' => '/about-us/we-are-here',
                    'uid' => 1,
                ],
            ],
            [
                'uri' => 'https://example.com/contact',
                'redirect' => [
                    'integrity_status' => ‪RedirectConflict::SELF_REFERENCE,
                    'source_host' => 'example.com',
                    'source_path' => '/contact',
                    'uid' => 6,
                ],
            ],
            [
                'uri' => 'https://example.com/features',
                'redirect' => [
                    'integrity_status' => ‪RedirectConflict::SELF_REFERENCE,
                    'source_host' => '*',
                    'source_path' => '/features',
                    'uid' => 9,
                ],
            ],
        ];
 
        $this->‪assertExpectedPathsFromGenerator($expectedConflicts, $this->subject->findConflictingRedirects('simple-page'));
    }
 
    #[Test]
    public function ‪conflictingRedirectsAreFoundForLocalizedPages(): void
    {
        $this->importCSVDataSet(__DIR__ . '/Fixtures/LocalizedPages.csv');
        $this->importCSVDataSet(__DIR__ . '/Fixtures/sys_redirect.csv');
 
        $expectedConflicts = [
            [
                'uri' => 'https://another.example.com/about-us/we-are-here',
                'redirect' => [
                    'integrity_status' => ‪RedirectConflict::SELF_REFERENCE,
                    'source_host' => '*',
                    'source_path' => '/about-us/we-are-here',
                    'uid' => 1,
                ],
            ],
            [
                'uri' => 'https://another.example.com/de/merkmale',
                'redirect' => [
                    'integrity_status' => ‪RedirectConflict::SELF_REFERENCE,
                    'source_host' => 'another.example.com',
                    'source_path' => '/de/merkmale',
                    'uid' => 4,
                ],
            ],
            [
                'uri' => 'https://another.example.com/features',
                'redirect' => [
                    'integrity_status' => ‪RedirectConflict::SELF_REFERENCE,
                    'source_host' => 'another.example.com',
                    'source_path' => '/features',
                    'uid' => 8,
                ],
            ],
        ];
        $conflicts = $this->subject->findConflictingRedirects('localized-page');
        $this->‪assertExpectedPathsFromGenerator($expectedConflicts, $conflicts);
    }
 
    #[Test]
    public function ‪conflictingRedirectsAreFoundForAllSites(): void
    {
        $this->importCSVDataSet(__DIR__ . '/Fixtures/SimplePages.csv');
        $this->importCSVDataSet(__DIR__ . '/Fixtures/LocalizedPages.csv');
        $this->importCSVDataSet(__DIR__ . '/Fixtures/sys_redirect.csv');
 
        $expectedConflicts = [
            [
                'uri' => 'https://example.com/',
                'redirect' => [
                    'integrity_status' => ‪RedirectConflict::SELF_REFERENCE,
                    'source_host' => 'example.com',
                    'source_path' => '/',
                    'uid' => 7,
                ],
            ],
            [
                'uri' => 'https://example.com/about-us/we-are-here',
                'redirect' => [
                    'integrity_status' => ‪RedirectConflict::SELF_REFERENCE,
                    'source_host' => '*',
                    'source_path' => '/about-us/we-are-here',
                    'uid' => 1,
                ],
            ],
            [
                'uri' => 'https://another.example.com/about-us/we-are-here',
                'redirect' => [
                    'integrity_status' => ‪RedirectConflict::SELF_REFERENCE,
                    'source_host' => '*',
                    'source_path' => '/about-us/we-are-here',
                    'uid' => 1,
                ],
            ],
            [
                'uri' => 'https://another.example.com/de/merkmale',
                'redirect' => [
                    'integrity_status' => ‪RedirectConflict::SELF_REFERENCE,
                    'source_host' => 'another.example.com',
                    'source_path' => '/de/merkmale',
                    'uid' => 4,
                ],
            ],
            [
                'uri' => 'https://example.com/contact',
                'redirect' => [
                    'integrity_status' => ‪RedirectConflict::SELF_REFERENCE,
                    'source_host' => 'example.com',
                    'source_path' => '/contact',
                    'uid' => 6,
                ],
            ],
            [
                'uri' => 'https://example.com/features',
                'redirect' => [
                    'integrity_status' => ‪RedirectConflict::SELF_REFERENCE,
                    'source_host' => '*',
                    'source_path' => '/features',
                    'uid' => 9,
                ],
            ],
            [
                'uri' => 'https://another.example.com/features',
                'redirect' => [
                    'integrity_status' => ‪RedirectConflict::SELF_REFERENCE,
                    'source_host' => 'another.example.com',
                    'source_path' => '/features',
                    'uid' => 8,
                ],
            ],
        ];
 
        $this->‪assertExpectedPathsFromGenerator($expectedConflicts, $this->subject->findConflictingRedirects());
    }
 
    private function ‪assertExpectedPathsFromGenerator(array $expectedConflicts, \Generator $generator): void
    {
        $matches = 0;
        foreach ($generator as $reportedConflict) {
            self::assertContains($reportedConflict, $expectedConflicts);
            $matches++;
        }
        self::assertSame(count($expectedConflicts), $matches);
    }
 
    private function ‪getSiteFinderMock(): MockObject&‪SiteFinder
    {
        $siteFinderMock = $this->getMockBuilder(SiteFinder::class)->disableOriginalConstructor()->getMock();
 
        $simpleSite = new ‪Site('simple-page', 1, [
            'base' => 'https://example.com',
            'languages' => [
                [
                    'languageId' => 0,
                    'title' => 'United States',
                    'locale' => 'en_US.UTF-8',
                ],
            ],
        ]);
        $localizedSite = new ‪Site('localized-page', 100, [
            'base' => 'https://another.example.com',
            'languages' => [
                [
                    'languageId' => 0,
                    'title' => 'United States',
                    'locale' => 'en_US.UTF-8',
                ],
                [
                    'base' => '/de/',
                    'languageId' => 1,
                    'title' => 'DE',
                    'locale' => 'de_DE.UTF-8',
                ],
                [
                    'base' => '/fr/',
                    'languageId' => 2,
                    'title' => 'FR',
                    'locale' => 'fr_FR.UTF-8',
                ],
            ],
        ]);
 
        $siteFinderMock->method('getSiteByIdentifier')->willReturnMap([
            ['simple-page', $simpleSite],
            ['localized-page', $localizedSite],
        ]);
 
        $siteFinderMock->method('getAllSites')->willReturn([$simpleSite, $localizedSite]);
 
        return $siteFinderMock;
    }
}