MigratedLanguageFileSyncUnwritableTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use ILIAS\Language\ComponentTranslation\CustomizingLanguageFileDirectory;
use ILIAS\Language\ComponentTranslation\Catalog\TranslationCatalog;
use ILIAS\Language\ComponentTranslation\LanguageFileDirectory;
use ILIAS\Language\ComponentTranslation\LanguageFileDirectoryManager;
use ILIAS\Language\ComponentTranslation\LocalChangeComments;
use ILIAS\Language\ComponentTranslation\MainLanguageFileDirectory;
use ILIAS\Language\ComponentTranslation\MigratedLanguageFileSync;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
 
class MigratedLanguageFileSyncUnwritableTest extends MigratedLanguageFileSyncTestCase
{
    public function testAFileInPlaceOfTheOverlayDirectoryIsReported(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
        mkdir(dirname($this->overlayDirectory()), 0775, true);
        file_put_contents($this->overlayDirectory(), 'not a directory');
 
        $this->assertSame([$this->overlayDirectory()], $this->findUnwritable());
    }
 
    public function testAFileInPlaceOfAParentOfTheOverlayDirectoryIsReported(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
        file_put_contents($this->client_data_dir . '/lang', 'not a directory');
 
        $this->assertSame([$this->overlayDirectory()], $this->findUnwritable());
    }
 
    #[DataProvider('danglingSymlinkPositions')]
    public function testADanglingSymlinkInTheOverlayPathIsReported(\Closure $link_path): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
        $link = $link_path($this);
        if (!is_dir(dirname($link))) {
            mkdir(dirname($link), 0775, true);
        }
        symlink($this->client_data_dir . '/does-not-exist', $link);
 
        $this->assertSame([$this->overlayDirectory()], $this->findUnwritable());
    }
 
    public static function danglingSymlinkPositions(): array
    {
        return [
            'the overlay directory' => [static fn(self $test): string => $test->overlayDirectory()],
            'a parent ("lang")' => [static fn(self $test): string => $test->client_data_dir . '/lang'],
        ];
    }
 
    public function testASymlinkToAWritableDirectoryIsNotReported(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
        mkdir($this->client_data_dir . '/elsewhere');
        symlink($this->client_data_dir . '/elsewhere', $this->client_data_dir . '/lang');
 
        $this->assertSame([], $this->findUnwritable());
    }
 
    public function testAMissingButCreatableOverlayDirectoryIsNotReported(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
 
        $this->assertDirectoryDoesNotExist($this->client_data_dir . '/lang');
        $this->assertSame([], $this->findUnwritable());
        $this->assertDirectoryDoesNotExist($this->client_data_dir . '/lang', 'the check itself creates nothing');
    }
 
    public function testAMissingClientDataDirWithACreatableParentIsNotReported(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
 
        $this->assertSame([], $this->findUnwritable(['de'], $this->client_data_dir . '/not-yet-created'));
    }
 
    public function testAnExistingWritableOverlayDirectoryIsNotReported(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
        mkdir($this->overlayDirectory(), 0775, true);
 
        $this->assertSame([], $this->findUnwritable());
    }
 
    public function testWithoutClientDataDirNothingIsReported(): void
    {
        $this->seedShipped(['greeting' => 'Hallo']);
        file_put_contents($this->client_data_dir . '/lang', 'not a directory');
 
        $this->assertSame([], $this->findUnwritable(['de'], null));
    }
 
    public function testAModuleThatIsNotMigratedForTheLanguageIsIgnored(): void
    {
        $this->seedShipped(['greeting' => 'Hello'], 'en');
        file_put_contents($this->client_data_dir . '/lang', 'not a directory');
 
        $this->assertSame([], $this->findUnwritable(['de']));
        $this->assertSame([$this->client_data_dir . '/lang/' . self::MODULE . '/en'], $this->findUnwritable(['de', 'en']));
    }
 
    public function testEachUnwritableOverlayDirectoryIsReportedOnceAcrossLanguagesAndModules(): void
    {
        $second = MigratedPoFixture::directory('stwo', 'components/ILIAS/Language/tests/ComponentTranslation/' . basename($this->fixture_directory) . '/sub/');
        $manager = new LanguageFileDirectoryManager(new CustomizingLanguageFileDirectory(), $this->directory, $second);
        $this->seedShipped(['greeting' => 'Hallo'], 'de');
        $this->seedShipped(['greeting' => 'Hello'], 'en');
        MigratedPoFixture::writePo(
            $this->fixture_directory . '/sub/stwo_de.po',
            MigratedPoFixture::catalog('stwo', ['x' => 'y'])
        );
        file_put_contents($this->client_data_dir . '/lang', 'not a directory');
 
        $this->assertSame(
            [
                $this->client_data_dir . '/lang/' . self::MODULE . '/de',
                $this->client_data_dir . '/lang/stwo/de',
                $this->client_data_dir . '/lang/' . self::MODULE . '/en',
            ],
            $this->findUnwritable(['de', 'en', 'de'], 'default', $manager)
        );
    }
}