MigratedLanguageFileSyncTestCase.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;
 
abstract class MigratedLanguageFileSyncTestCase extends TestCase
{
    use RestoresProcessState;
 
    protected const string MODULE = 'stest';
 
    protected string $fixture_directory;
    protected string $client_data_dir;
    protected string $ilias_root;
    protected LanguageFileDirectory $directory;
    protected LanguageFileDirectoryManager $manager;
 
    protected function setUp(): void
    {
        // never the build of the installation, see MigratedPoFixture::resetRuntime()
        MigratedPoFixture::resetRuntime();
        parent::setUp();
 
        $this->ilias_root = (string) realpath(__DIR__ . '/../../../../../');
 
        $this->fixture_directory = __DIR__ . '/tmp-sync-fixtures-' . bin2hex(random_bytes(4));
        mkdir($this->fixture_directory, 0775, true);
        $this->client_data_dir = sys_get_temp_dir() . '/ilias_mlfs_test_' . bin2hex(random_bytes(4));
        mkdir($this->client_data_dir, 0775, true);
 
        $this->directory = MigratedPoFixture::directory(
            self::MODULE,
            'components/ILIAS/Language/tests/ComponentTranslation/' . basename($this->fixture_directory) . '/'
        );
        $this->manager = new LanguageFileDirectoryManager(new CustomizingLanguageFileDirectory(), $this->directory);
    }
 
    protected function tearDown(): void
    {
        MigratedPoFixture::removeDirectory($this->fixture_directory);
        MigratedPoFixture::removeDirectory($this->client_data_dir);
        MigratedPoFixture::resetRuntime();
 
        parent::tearDown();
    }
 
    protected function seedShipped(array $entries, string $lang_key = 'de', string $module = self::MODULE): void
    {
        MigratedPoFixture::writePo($this->shippedPo($lang_key, $module), MigratedPoFixture::catalog($module, $entries));
    }
 
    protected function seedOverlay(array $entries, string $lang_key = 'de'): void
    {
        MigratedPoFixture::writePair($this->overlayBase($lang_key), MigratedPoFixture::catalog(self::MODULE, $entries));
    }
 
    protected function shippedPo(string $lang_key = 'de', string $module = self::MODULE): string
    {
        return $this->fixture_directory . '/' . $module . '_' . $lang_key . '.po';
    }
 
    protected function overlayBase(string $lang_key = 'de'): string
    {
        return MigratedPoFixture::overlayBase($this->client_data_dir, $this->directory, $lang_key);
    }
 
    protected function overlayPo(): TranslationCatalog
    {
        return MigratedPoFixture::readPo($this->overlayBase() . '.po');
    }
 
    protected function sync(array $entries, bool $refresh = false, ?string $client_data_dir = 'default'): void
    {
        MigratedLanguageFileSync::sync(
            $this->manager,
            $this->ilias_root,
            'de',
            self::MODULE,
            $entries,
            $client_data_dir === 'default' ? $this->client_data_dir : $client_data_dir,
            $refresh
        );
    }
 
    protected function overlayIdentifiers(): array
    {
        return array_map(static fn($entry): string => $entry->getId(), $this->overlayPo()->getEntries());
    }
 
    protected function overlayDirectory(): string
    {
        return dirname($this->overlayBase());
    }
 
    protected function findUnwritable(array $lang_keys = ['de'], ?string $client_data_dir = 'default', ?LanguageFileDirectoryManager $manager = null): array
    {
        return MigratedLanguageFileSync::findUnwritableOverlayDirectories(
            $manager ?? $this->manager,
            $this->ilias_root,
            $lang_keys,
            $client_data_dir === 'default' ? $this->client_data_dir : $client_data_dir
        );
    }
 
 
    public static function refreshFlags(): array
    {
        return ['admin edit (refresh = false)' => [false], 'reconciling write (refresh = true)' => [true]];
    }
}