WebServerConfigurationFileServiceTest.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\Install\Tests\Functional\Service;
 
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Install\Service\WebServerConfigurationFileService;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
 
final class ‪WebServerConfigurationFileServiceTest extends FunctionalTestCase
{
    protected bool ‪$initializeDatabase = false;
 
    #[DataProvider('webServerConfigurationIsChangedDataProvider')]
    #[Test]
    public function ‪addWebServerSpecificBackendRoutingRewriteRulesTest(
        string $webServer,
        string $configurationFile,
        bool $shouldBeChanged = false,
        array $addedParts = [],
        array $removedParts = []
    ): void {
        ‪$_SERVER['SERVER_SOFTWARE'] = $webServer;
        $filename = ‪Environment::getPublicPath() . '/' . ($webServer === 'Apache' ? '.htaccess' : 'web.config');
 
        file_put_contents($filename, file_get_contents(__DIR__ . '/../Fixtures/' . $configurationFile));
 
        $changed = (new ‪WebServerConfigurationFileService())->addWebServerSpecificBackendRoutingRewriteRules();
 
        self::assertEquals($shouldBeChanged, $changed);
 
        if ($shouldBeChanged) {
            $newFileContent = file_get_contents($filename);
            // Check if updated file contains parts
            foreach ($addedParts as $part) {
                self::assertStringContainsString($part, $newFileContent);
            }
            // Check if updated file does not contain parts
            foreach ($removedParts as $part) {
                self::assertStringNotContainsString($part, $newFileContent);
            }
        }
 
        unlink($filename);
    }
 
    public static function ‪webServerConfigurationIsChangedDataProvider(): \Generator
    {
        yield '.htaccess already updated -  will not be changed' => [
            'Apache',
            '.htaccess_already_updated',
        ];
        yield 'outdated .htaccess - will be changed' => [
            'Apache',
            '.htaccess_outdated',
            true,
            [
                '# Stop rewrite processing, if we are in any known directory',
                'RewriteRule ^typo3/(.*)$ %{ENV:CWD}index.php [QSA,L]',
            ],
            [
                '# Stop rewrite processing, if we are in any other known directory',
                'RewriteRule ^typo3/(.*)$ %{ENV:CWD}typo3/index.php [QSA,L]',
            ],
        ];
        yield 'web.config already updated - will not be changed' => [
            'Microsoft-IIS',
            'web.config_already_updated',
        ];
        yield 'outdated web.config - will be changed' => [
            'Microsoft-IIS',
            'web.config_outdated',
            true,
            [
                '<action type="Rewrite" url="index.php" appendQueryString="true" />',
            ],
            [
                '<action type="Rewrite" url="typo3/index.php" appendQueryString="true" />',
            ],
        ];
    }
}