LanguageInstallationManagerMigratedSourcesAndLocksTest Class Reference

Inheritance diagram for LanguageInstallationManagerMigratedSourcesAndLocksTest:

Collaboration diagram for LanguageInstallationManagerMigratedSourcesAndLocksTest:

Public Member Functions
	testValuesOfAMigratedModuleComeFromThePoEvenWithoutAnyLangLine ()
	The tos lines could be removed from lang/ilias_xx.lang: the database is filled from the shipped .po alone. More...
	testLangLinesOfAMigratedModuleInNonLocalFilesAreIgnored ()
	testAModuleIsOnlyMigratedForLanguagesWithAShippedPo ()
	Only languages that ship a .po are migrated: for another language the .lang lines are used. More...
	testInstallWithoutLocalChangesWritesNoOverlayOnlyTheTakenOverRecord ()
	An installation without local changes writes no overlay file: the shipped state is served as is. More...
	testAModuleWithAnExistingOverlayIsLockedForTheWholeRunNotJustItsOwnSync ()
	A module that already has an overlay when insertLanguage() decides what to lock is locked (MigratedLanguageFileSync::withOverlayLock()) for the whole run, not just its final sync(), so a concurrent writer cannot interleave with the read-modify-write in between. More...
	testLocksAreAcquiredInSortedOrderRegardlessOfTheContributedDirectoryOrder ()
	Deadlock protection: modules with an overlay are locked in one global order (module name, byte-wise), whatever order getDirectories() hands them out in. More...
	testAModuleWithoutAnOverlayThatGetsOneCreatedDuringTheRunIsReportedAndTheOverlaySurvives ()
	A module without an overlay at that point is never locked (no lock file is created). More...

Additional Inherited Members
Protected Member Functions inherited from LanguageInstallationManagerMigratedModulesTestCase
	setUp ()
	tearDown ()
	db ()
	repository ()
	manager (?\Closure $client_data_dir_resolver=null, ?\Closure $language_cache_invalidator=null, bool $with_resolver=true, bool $with_logger=true, ?LoggerInterface $logger=null)
	expectManagerWarning ()
	assertPostConditions ()
	loggedWarnings ()
	shipPo (array $entries, string $lang_key='de')
	shipSecondModule (array $entries)
	A second migrated module "pilot2" next to "pilot". More...
	seedOverlay (array $entries)
	overlayBase ()
	overlayPo ()
	effective ()
	Shipped .po plus overlay delta, as served (MigratedLanguageFileSync::loadModuleTranslations()) - the overlay itself only holds the entries that differ from the shipped .po. More...
	writeLang (string $relative_file, array $lines)
	resolveToken (string $token)
	lngData ()
	applyLngDataDelete (string $query, array $rows)
	Applies one recorded "DELETE FROM lng_data" to $rows, in the two shapes LanguageInstallationManager issues: the bulk delete of unchanged rows of a migrated module ("... local_change IS NULL AND module IN (...)") and the per-module delete of dropped identifiers ("... AND module = ? AND identifier IN (...)"). More...
	droppedIdentifiers (string $module)
	Identifiers of $module dropped via the per-module "DELETE FROM lng_data ... AND identifier IN (...)", as opposed to keys merely absent because they were never touched. More...
	lngModules ()
	errorLog ()
	What error_log() wrote during this test so far - PHPUnit redirects error_log to a capture file per test (call expectErrorLog() in tests that expect logging, so it is not echoed). More...
	shipPluralPo (array $entries, string $header)
	writeLocalOverlay (array $flat_values)
	seedOverlayMarkedAsMerged (array $entries, array $merged)
Protected Attributes inherited from LanguageInstallationManagerMigratedModulesTestCase
const string	NOW = '2026-01-02 03:04:05'
const string	MODULE = 'pilot'
string	$root
LanguageFileDirectory	$directory
array	$further_directories = []
array	$quoted = []
array	$queries = []
array	$collation_rows = null
array	$pending_rows = []
array	$duplicate_rows = []
array	$local_change_rows = []
array	$db_local_changes = []
array	$db_entries = []
array	$available_languages = []
array	$logged_warnings = []
const string	TWO_FORMS = 'nplurals=2; plural=(n != 1);'
const string	THREE_FORMS = 'nplurals=3; plural=(n == 1 ? 0 : n >= 2 && n <= 4 ? 1 : 2);'

Detailed Description

Definition at line 34 of file LanguageInstallationManagerMigratedSourcesAndLocksTest.php.

Member Function Documentation

testAModuleIsOnlyMigratedForLanguagesWithAShippedPo()

LanguageInstallationManagerMigratedSourcesAndLocksTest::testAModuleIsOnlyMigratedForLanguagesWithAShippedPo

(

)

Only languages that ship a .po are migrated: for another language the .lang lines are used.

Definition at line 73 of file LanguageInstallationManagerMigratedSourcesAndLocksTest.php.

                                                                         : void
    {
        $this->shipPo(['greeting' => 'Hallo'], 'de');
        $this->writeLang('components/pilot/lang/ilias_en.lang', ['greeting#:#Hello']);
 
        $this->manager()->insertLanguageForInstallation('en');
 
        $this->assertSame(['greeting' => 'Hello'], $this->lngModules()[self::MODULE]);
        $this->assertDirectoryDoesNotExist($this->root . '/client-data/lang');
    }

References LanguageInstallationManagerMigratedModulesTestCase\lngModules(), LanguageInstallationManagerMigratedModulesTestCase\manager(), LanguageInstallationManagerMigratedModulesTestCase\shipPo(), and LanguageInstallationManagerMigratedModulesTestCase\writeLang().

Here is the call graph for this function:

testAModuleWithAnExistingOverlayIsLockedForTheWholeRunNotJustItsOwnSync()

LanguageInstallationManagerMigratedSourcesAndLocksTest::testAModuleWithAnExistingOverlayIsLockedForTheWholeRunNotJustItsOwnSync

(

)

A module that already has an overlay when insertLanguage() decides what to lock is locked (MigratedLanguageFileSync::withOverlayLock()) for the whole run, not just its final sync(), so a concurrent writer cannot interleave with the read-modify-write in between.

Definition at line 106 of file LanguageInstallationManagerMigratedSourcesAndLocksTest.php.

                                                                                             : void
    {
        $this->shipPo(['greeting' => 'Hallo']);
        $this->seedOverlay(['greeting' => ['value' => 'Servus', 'original' => 'Hallo', 'local_change' => '2020-01-01T00:00:00Z']]);
        $lock_file = MigratedPoFixture::overlayLock($this->overlayBase());
        $held_locks = new ReflectionProperty(MigratedLanguageFileSync::class, 'held_locks');
 
        $observed = null;
        $manager = $this->manager(null, function () use (&$observed, $held_locks, $lock_file): void {
            $observed = array_key_exists($lock_file, $held_locks->getValue());
        });
 
        $manager->insertLanguageForInstallation('de');
 
        $this->assertTrue($observed, 'the module\'s overlay lock must already be held at this point in the run');
        // released again once the whole run is done
        $this->assertSame([], $held_locks->getValue());
    }

References LanguageInstallationManagerMigratedModulesTestCase\manager(), LanguageInstallationManagerMigratedModulesTestCase\overlayBase(), MigratedPoFixture\overlayLock(), LanguageInstallationManagerMigratedModulesTestCase\seedOverlay(), and LanguageInstallationManagerMigratedModulesTestCase\shipPo().

Here is the call graph for this function:

testAModuleWithoutAnOverlayThatGetsOneCreatedDuringTheRunIsReportedAndTheOverlaySurvives()

LanguageInstallationManagerMigratedSourcesAndLocksTest::testAModuleWithoutAnOverlayThatGetsOneCreatedDuringTheRunIsReportedAndTheOverlaySurvives

(

)

A module without an overlay at that point is never locked (no lock file is created).

Definition at line 176 of file LanguageInstallationManagerMigratedSourcesAndLocksTest.php.

                                                                                                              : void
    {
        $this->expectManagerWarning();
        $this->shipPo(['greeting' => 'Hallo']);
        $concurrent_edit = MigratedPoFixture::catalog(self::MODULE, [
            'greeting' => ['value' => 'Von einem parallelen Admin-Edit', 'original' => 'Hallo', 'local_change' => '2020-01-01T00:00:00Z'],
        ]);
 
        $manager = $this->manager(null, function () use ($concurrent_edit): void {
            MigratedPoFixture::writePair($this->overlayBase(), $concurrent_edit);
        });
 
        $unwritten = $manager->insertLanguageForInstallation('de');
 
        $this->assertSame([self::MODULE], $unwritten);
        $this->assertSame(
            'Von einem parallelen Admin-Edit',
            // untouched, so still as the fixture wrote it: with the module as msgctxt
            $this->overlayPo()->find(self::MODULE, 'greeting')->getTranslation(),
            'the concurrently-written overlay must survive untouched'
        );
    }

References MigratedPoFixture\catalog(), LanguageInstallationManagerMigratedModulesTestCase\expectManagerWarning(), LanguageInstallationManagerMigratedModulesTestCase\manager(), LanguageInstallationManagerMigratedModulesTestCase\overlayBase(), LanguageInstallationManagerMigratedModulesTestCase\overlayPo(), LanguageInstallationManagerMigratedModulesTestCase\shipPo(), and MigratedPoFixture\writePair().

Here is the call graph for this function:

testInstallWithoutLocalChangesWritesNoOverlayOnlyTheTakenOverRecord()

LanguageInstallationManagerMigratedSourcesAndLocksTest::testInstallWithoutLocalChangesWritesNoOverlayOnlyTheTakenOverRecord

(

)

An installation without local changes writes no overlay file: the shipped state is served as is.

Definition at line 87 of file LanguageInstallationManagerMigratedSourcesAndLocksTest.php.

                                                                                         : void
    {
        $this->shipPo(['greeting' => ['value' => 'Hello', 'fuzzy' => true]]);
 
        $this->manager()->insertLanguageForInstallation('de');
 
        // only the record that the lng_data local changes were taken over (there were none)
        $this->assertSame(['.locks', 'taken-over.de.json'], array_values(array_diff(scandir($this->root . '/client-data/lang'), ['.', '..'])));
        $this->assertSame(
            ['greeting' => ['value' => 'Hello', 'local_change' => false, 'local_change_date' => null, 'original' => 'Hello']],
            $this->effective()
        );
    }

References LanguageInstallationManagerMigratedModulesTestCase\effective(), LanguageInstallationManagerMigratedModulesTestCase\manager(), and LanguageInstallationManagerMigratedModulesTestCase\shipPo().

Here is the call graph for this function:

testLangLinesOfAMigratedModuleInNonLocalFilesAreIgnored()

LanguageInstallationManagerMigratedSourcesAndLocksTest::testLangLinesOfAMigratedModuleInNonLocalFilesAreIgnored

(

)

Definition at line 58 of file LanguageInstallationManagerMigratedSourcesAndLocksTest.php.

                                                                             : void
    {
        $this->shipPo(['greeting' => 'Hallo']);
        $this->writeLang('lang/ilias_de.lang', ['pilot#:#greeting#:#Alt aus lang/', 'pilot#:#stale#:#Veraltet']);
        $this->writeLang('components/pilot/lang/ilias_de.lang', ['greeting#:#Alt aus Komponente']);
 
        $this->manager()->insertLanguageForInstallation('de');
 
        $this->assertSame(['greeting' => 'Hallo'], $this->lngModules()[self::MODULE]);
        $this->assertArrayNotHasKey('pilot|stale', $this->lngData());
    }

References LanguageInstallationManagerMigratedModulesTestCase\lngData(), LanguageInstallationManagerMigratedModulesTestCase\lngModules(), LanguageInstallationManagerMigratedModulesTestCase\manager(), LanguageInstallationManagerMigratedModulesTestCase\shipPo(), and LanguageInstallationManagerMigratedModulesTestCase\writeLang().

Here is the call graph for this function:

testLocksAreAcquiredInSortedOrderRegardlessOfTheContributedDirectoryOrder()

LanguageInstallationManagerMigratedSourcesAndLocksTest::testLocksAreAcquiredInSortedOrderRegardlessOfTheContributedDirectoryOrder

(

)

Deadlock protection: modules with an overlay are locked in one global order (module name, byte-wise), whatever order getDirectories() hands them out in.

Definition at line 129 of file LanguageInstallationManagerMigratedSourcesAndLocksTest.php.

                                                                                               : void
    {
        $first_module = MigratedPoFixture::directory('zmod', 'components/pilot/lang/');
        $second_module = MigratedPoFixture::directory('amod', 'components/pilot/lang/');
        MigratedPoFixture::writePo(
            $this->root . '/components/pilot/lang/zmod_de.po',
            MigratedPoFixture::catalog('zmod', ['greeting' => 'Hallo'])
        );
        MigratedPoFixture::writePo(
            $this->root . '/components/pilot/lang/amod_de.po',
            MigratedPoFixture::catalog('amod', ['greeting' => 'Hallo'])
        );
        MigratedPoFixture::writePair(
            $this->root . '/client-data/lang/zmod/de/zmod_de',
            MigratedPoFixture::catalog('zmod', ['greeting' => ['value' => 'Servus', 'original' => 'Hallo']])
        );
        MigratedPoFixture::writePair(
            $this->root . '/client-data/lang/amod/de/amod_de',
            MigratedPoFixture::catalog('amod', ['greeting' => ['value' => 'Servus', 'original' => 'Hallo']])
        );
        $held_locks = new ReflectionProperty(MigratedLanguageFileSync::class, 'held_locks');
        $observed_order = null;
 
        $manager = new LanguageInstallationManager(
            $this->db(),
            // "zmod" contributed before "amod", the opposite of sorted order
            new LanguageFileDirectoryManager(new CustomizingLanguageFileDirectory(), $first_module, $second_module),
            $this->root,
            $this->repository(),
            static fn(): \DateTimeImmutable => new \DateTimeImmutable(self::NOW, new \DateTimeZone('UTC')),
            new CallbackTranslationCache(function () use (&$observed_order, $held_locks): void {
                $observed_order = array_map(
                    static fn(string $lock_file): string => basename(dirname($lock_file, 2)) . '/' . basename($lock_file),
                    array_keys($held_locks->getValue())
                );
            }),
            fn(): string => $this->root . '/client-data'
        );
 
        $manager->insertLanguageForInstallation('de');
 
        $this->assertSame(['amod/lock', 'zmod/lock'], $observed_order);
    }

References MigratedPoFixture\catalog(), LanguageInstallationManagerMigratedModulesTestCase\db(), MigratedPoFixture\directory(), ILIAS\Language\Setup\LanguageInstallationManager\insertLanguageForInstallation(), LanguageInstallationManagerMigratedModulesTestCase\repository(), MigratedPoFixture\writePair(), and MigratedPoFixture\writePo().

Here is the call graph for this function:

testValuesOfAMigratedModuleComeFromThePoEvenWithoutAnyLangLine()

LanguageInstallationManagerMigratedSourcesAndLocksTest::testValuesOfAMigratedModuleComeFromThePoEvenWithoutAnyLangLine

(

)

The tos lines could be removed from lang/ilias_xx.lang: the database is filled from the shipped .po alone.

Definition at line 40 of file LanguageInstallationManagerMigratedSourcesAndLocksTest.php.

                                                                                    : void
    {
        $this->shipPo(['greeting' => 'Hallo', 'farewell' => 'Tschüss']);
        $this->writeLang('lang/ilias_de.lang', ['common#:#yes#:#Ja']);
 
        $this->manager()->insertLanguageForInstallation('de');
 
        $this->assertSame(
            [
                'common|yes' => ['value' => 'Ja', 'local_change' => null],
                'pilot|greeting' => ['value' => 'Hallo', 'local_change' => null],
                'pilot|farewell' => ['value' => 'Tschüss', 'local_change' => null],
            ],
            $this->lngData()
        );
        $this->assertSame(['greeting' => 'Hallo', 'farewell' => 'Tschüss'], $this->lngModules()[self::MODULE]);
    }

References LanguageInstallationManagerMigratedModulesTestCase\lngData(), LanguageInstallationManagerMigratedModulesTestCase\lngModules(), LanguageInstallationManagerMigratedModulesTestCase\manager(), LanguageInstallationManagerMigratedModulesTestCase\shipPo(), and LanguageInstallationManagerMigratedModulesTestCase\writeLang().

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• components/ILIAS/Language/tests/Setup/LanguageInstallationManagerMigratedSourcesAndLocksTest.php