MigratedLanguageFileSyncFindModulesWithOverlayTest Class Reference

findModulesWithOverlay(): only current or a .po in lang/<module>/<lang>/ counts, nothing else below lang. More...

Inheritance diagram for MigratedLanguageFileSyncFindModulesWithOverlayTest:

Collaboration diagram for MigratedLanguageFileSyncFindModulesWithOverlayTest:

Public Member Functions
	testOnlyCurrentOrAPoMakesAnOverlay (string $file, bool $is_overlay)
	testAModuleIsFoundPerLanguageAndTheResultIsSorted ()
	testLocksAndTheTakenOverRecordAreNoModules ()
	The lock directory and the record sit next to the module directories and are no modules. More...
	testSymbolicLinksAreNotFollowed ()
	testNoClientDataDirectoryAnInvalidLanguageKeyOrNoLangDirectoryFindNothing ()
	testUnreadableDirectoriesCountAsOverlayOrFindNothing ()
	An unreadable module directory counts as overlay, an unreadable overlay root finds nothing. More...

Static Public Member Functions
static	overlayMarkers ()
Static Public Member Functions inherited from MigratedLanguageFileSyncTestCase
static	refreshFlags ()

Private Member Functions
	touch (string $relative)

Additional Inherited Members
Protected Member Functions inherited from MigratedLanguageFileSyncTestCase
	setUp ()
	tearDown ()
	seedShipped (array $entries, string $lang_key='de', string $module=self::MODULE)
	seedOverlay (array $entries, string $lang_key='de')
	shippedPo (string $lang_key='de', string $module=self::MODULE)
	overlayBase (string $lang_key='de')
	overlayPo ()
	sync (array $entries, bool $refresh=false, ?string $client_data_dir='default')
	overlayIdentifiers ()
	overlayDirectory ()
	findUnwritable (array $lang_keys=['de'], ?string $client_data_dir='default', ?LanguageFileDirectoryManager $manager=null)
Protected Attributes inherited from MigratedLanguageFileSyncTestCase
const string	MODULE = 'stest'
string	$fixture_directory
string	$client_data_dir
string	$ilias_root
LanguageFileDirectory	$directory
LanguageFileDirectoryManager	$manager

Detailed Description

findModulesWithOverlay(): only current or a .po in lang/<module>/<lang>/ counts, nothing else below lang.

Definition at line 27 of file MigratedLanguageFileSyncFindModulesWithOverlayTest.php.

Member Function Documentation

overlayMarkers()

static MigratedLanguageFileSyncFindModulesWithOverlayTest::overlayMarkers ( )

static

Returns

array<string, array{0: string, 1: bool}> file below lang/zmod/de/, whether it makes an overlay

Definition at line 41 of file MigratedLanguageFileSyncFindModulesWithOverlayTest.php.

                                           : array
    {
        return [
            'current' => ['current', true],
            'po' => ['zmod_de.po', true],
            'only the lock' => ['zmod_de.lock', false],
            'only the mo' => ['zmod_de.mo', false],
        ];
    }

testAModuleIsFoundPerLanguageAndTheResultIsSorted()

MigratedLanguageFileSyncFindModulesWithOverlayTest::testAModuleIsFoundPerLanguageAndTheResultIsSorted

(

)

Definition at line 59 of file MigratedLanguageFileSyncFindModulesWithOverlayTest.php.

                                                                       : void
    {
        $this->touch('zmod/de/current');
        $this->touch('amod/de/amod_de.po');
        $this->touch('fmod/fr/current');
 
        $this->assertSame(['amod', 'zmod'], MigratedLanguageFileSync::findModulesWithOverlay($this->client_data_dir, 'de'));
        $this->assertSame(['fmod'], MigratedLanguageFileSync::findModulesWithOverlay($this->client_data_dir, 'fr'));
    }

References touch().

Here is the call graph for this function:

testLocksAndTheTakenOverRecordAreNoModules()

MigratedLanguageFileSyncFindModulesWithOverlayTest::testLocksAndTheTakenOverRecordAreNoModules

(

)

The lock directory and the record sit next to the module directories and are no modules.

Definition at line 70 of file MigratedLanguageFileSyncFindModulesWithOverlayTest.php.

                                                                : void
    {
        MigratedLanguageFileSync::markLocalChangesTakenOver($this->client_data_dir, 'de', ['zmod']);
        $this->touch('.locks/de/current');
        $this->touch('.locks/de/x.po');
 
        $this->assertFileExists(MigratedLanguageFilePaths::takenOverFile($this->client_data_dir, 'de'));
        $this->assertSame([], MigratedLanguageFileSync::findModulesWithOverlay($this->client_data_dir, 'de'));
    }

References touch().

Here is the call graph for this function:

testNoClientDataDirectoryAnInvalidLanguageKeyOrNoLangDirectoryFindNothing()

MigratedLanguageFileSyncFindModulesWithOverlayTest::testNoClientDataDirectoryAnInvalidLanguageKeyOrNoLangDirectoryFindNothing

(

)

Definition at line 98 of file MigratedLanguageFileSyncFindModulesWithOverlayTest.php.

                                                                                               : void
    {
        $this->touch('zmod/de/current');
 
        $this->assertSame([], MigratedLanguageFileSync::findModulesWithOverlay(null, 'de'));
        $this->assertSame([], MigratedLanguageFileSync::findModulesWithOverlay($this->client_data_dir, '../de'));
        $this->assertSame([], MigratedLanguageFileSync::findModulesWithOverlay($this->client_data_dir . '/missing', 'de'));
    }

References touch().

Here is the call graph for this function:

testOnlyCurrentOrAPoMakesAnOverlay()

MigratedLanguageFileSyncFindModulesWithOverlayTest::testOnlyCurrentOrAPoMakesAnOverlay	(	string	$file,
		bool	$is_overlay
	)

Definition at line 52 of file MigratedLanguageFileSyncFindModulesWithOverlayTest.php.

                                                                                      : void
    {
        $this->touch('zmod/de/' . $file);
 
        $this->assertSame($is_overlay ? ['zmod'] : [], MigratedLanguageFileSync::findModulesWithOverlay($this->client_data_dir, 'de'));
    }

References touch().

Here is the call graph for this function:

testSymbolicLinksAreNotFollowed()

MigratedLanguageFileSyncFindModulesWithOverlayTest::testSymbolicLinksAreNotFollowed

(

)

Definition at line 80 of file MigratedLanguageFileSyncFindModulesWithOverlayTest.php.

                                                     : void
    {
        $outside = sys_get_temp_dir() . '/ilias_find_overlay_outside_' . bin2hex(random_bytes(4));
        mkdir($outside . '/de', 0775, true);
        file_put_contents($outside . '/de/current', 'x');
        try {
            mkdir($this->client_data_dir . '/lang/linkedmod', 0775, true);
            symlink($outside . '/de', $this->client_data_dir . '/lang/linkedmod/de');
            symlink($outside, $this->client_data_dir . '/lang/linkedmodule');
            mkdir($this->client_data_dir . '/lang/linkedcurrent/de', 0775, true);
            symlink($outside . '/missing', $this->client_data_dir . '/lang/linkedcurrent/de/current');
 
            $this->assertSame(['linkedcurrent'], MigratedLanguageFileSync::findModulesWithOverlay($this->client_data_dir, 'de'));
        } finally {
            MigratedPoFixture::removeDirectory($outside);
        }
    }

References MigratedPoFixture\removeDirectory().

Here is the call graph for this function:

testUnreadableDirectoriesCountAsOverlayOrFindNothing()

MigratedLanguageFileSyncFindModulesWithOverlayTest::testUnreadableDirectoriesCountAsOverlayOrFindNothing

(

)

An unreadable module directory counts as overlay, an unreadable overlay root finds nothing.

Definition at line 108 of file MigratedLanguageFileSyncFindModulesWithOverlayTest.php.

                                                                          : void
    {
        $this->touch('amod/de/current');
        mkdir($this->client_data_dir . '/lang/zmod/de', 0775, true);
        chmod($this->client_data_dir . '/lang/zmod/de', 0000);
        try {
            if (is_readable($this->client_data_dir . '/lang/zmod/de')) {
                $this->markTestSkipped('permissions are not enforced (root)');
            }
            $this->assertSame(['amod', 'zmod'], MigratedLanguageFileSync::findModulesWithOverlay($this->client_data_dir, 'de'));
 
            chmod($this->client_data_dir . '/lang', 0000);
            $this->assertSame([], MigratedLanguageFileSync::findModulesWithOverlay($this->client_data_dir, 'de'));
        } finally {
            chmod($this->client_data_dir . '/lang', 0775);
            chmod($this->client_data_dir . '/lang/zmod/de', 0775);
        }
    }

References touch().

Here is the call graph for this function:

touch()

MigratedLanguageFileSyncFindModulesWithOverlayTest::touch ( string  $relative )

private

Definition at line 29 of file MigratedLanguageFileSyncFindModulesWithOverlayTest.php.

                                            : void
    {
        $file = $this->client_data_dir . '/lang/' . $relative;
        if (!is_dir(dirname($file))) {
            mkdir(dirname($file), 0775, true);
        }
        file_put_contents($file, 'x');
    }

Referenced by testAModuleIsFoundPerLanguageAndTheResultIsSorted(), testLocksAndTheTakenOverRecordAreNoModules(), testNoClientDataDirectoryAnInvalidLanguageKeyOrNoLangDirectoryFindNothing(), testOnlyCurrentOrAPoMakesAnOverlay(), and testUnreadableDirectoriesCountAsOverlayOrFindNothing().

Here is the caller graph for this function:

---

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

• components/ILIAS/Language/tests/ComponentTranslation/MigratedLanguageFileSyncFindModulesWithOverlayTest.php