MigratedLanguageFileSyncLockTestCase Class Reference

Fixture of the MigratedLanguageFileSyncLock*Test classes: a throwaway client data directory and the helpers to run lock scenarios in child PHP processes. More...

Inheritance diagram for MigratedLanguageFileSyncLockTestCase:

Collaboration diagram for MigratedLanguageFileSyncLockTestCase:

Protected Member Functions
	setUp ()
	tearDown ()
	lockFile ()
	seedLockDirectory ()
	Forces withOverlayLock() to take a real lock without needing a shipped .po: the overlay directory already existing is enough (see withOverlayLock()'s early-return condition). More...
	runPhpWithTimeout (string $code, float $timeout_seconds)
	Runs $code in a child PHP process and kills it after $timeout_seconds, so a regression that deadlocks fails the test instead of hanging the suite. More...

Protected Attributes
const string	MODULE = 'stest'
string	$client_data_dir
LanguageFileDirectory	$directory
LanguageFileDirectoryManager	$manager

Detailed Description

Fixture of the MigratedLanguageFileSyncLock*Test classes: a throwaway client data directory and the helpers to run lock scenarios in child PHP processes.

Definition at line 30 of file MigratedLanguageFileSyncLockTestCase.php.

Member Function Documentation

lockFile()

MigratedLanguageFileSyncLockTestCase::lockFile ( )

protected

Definition at line 65 of file MigratedLanguageFileSyncLockTestCase.php.

                                 : string
    {
        return MigratedPoFixture::overlayLock(MigratedPoFixture::overlayBase($this->client_data_dir, $this->directory, 'de'));
    }

References MigratedPoFixture\overlayBase(), and MigratedPoFixture\overlayLock().

Referenced by seedLockDirectory().

Here is the call graph for this function:

Here is the caller graph for this function:

runPhpWithTimeout()

MigratedLanguageFileSyncLockTestCase::runPhpWithTimeout ( string  $code, float  $timeout_seconds  )

protected

Runs $code in a child PHP process and kills it after $timeout_seconds, so a regression that deadlocks fails the test instead of hanging the suite.

Returns

array{finished: bool, exit_code: ?int, output: string}

Definition at line 85 of file MigratedLanguageFileSyncLockTestCase.php.

                                                                              : array
    {
        $started = ChildPhp::open(['-r', $code]);
        if ($started === null) {
            $this->fail('Could not start the child PHP process.');
        }
        [$process, $pipes] = $started;
        stream_set_blocking($pipes[1], false);
        stream_set_blocking($pipes[2], false);
 
        $deadline = microtime(true) + $timeout_seconds;
        $output = '';
        do {
            $output .= (string) stream_get_contents($pipes[1]);
            $output .= (string) stream_get_contents($pipes[2]);
            $status = proc_get_status($process);
            if (!$status['running']) {
                fclose($pipes[1]);
                fclose($pipes[2]);
                proc_close($process);
 
                return ['finished' => true, 'exit_code' => $status['exitcode'], 'output' => $output];
            }
            usleep(20_000);
        } while (microtime(true) < $deadline);
 
        proc_terminate($process, 9);
        usleep(100_000);
        $output .= (string) stream_get_contents($pipes[1]);
        $output .= (string) stream_get_contents($pipes[2]);
        fclose($pipes[1]);
        fclose($pipes[2]);
        proc_close($process);
 
        return ['finished' => false, 'exit_code' => null, 'output' => $output];
    }

References ChildPhp\open().

Here is the call graph for this function:

seedLockDirectory()

MigratedLanguageFileSyncLockTestCase::seedLockDirectory ( )

protected

Forces withOverlayLock() to take a real lock without needing a shipped .po: the overlay directory already existing is enough (see withOverlayLock()'s early-return condition).

Definition at line 74 of file MigratedLanguageFileSyncLockTestCase.php.

                                          : void
    {
        mkdir(dirname($this->lockFile()), 0775, true);
    }

References lockFile().

Here is the call graph for this function:

setUp()

MigratedLanguageFileSyncLockTestCase::setUp ( )

protected

Definition at line 42 of file MigratedLanguageFileSyncLockTestCase.php.

                              : void
    {
        // never the build of the installation, see MigratedPoFixture::resetRuntime()
        MigratedPoFixture::resetRuntime();
        parent::setUp();
 
        if (!defined('ILIAS_ABSOLUTE_PATH')) {
            define('ILIAS_ABSOLUTE_PATH', realpath(__DIR__ . '/../../../../../'));
        }
 
        $this->client_data_dir = sys_get_temp_dir() . '/ilias_mlfs_lock_test_' . bin2hex(random_bytes(4));
        mkdir($this->client_data_dir, 0775, true);
        $this->directory = MigratedPoFixture::directory(self::MODULE, 'x/');
        $this->manager = new LanguageFileDirectoryManager(new CustomizingLanguageFileDirectory(), $this->directory);
    }

References MigratedPoFixture\directory(), MigratedPoFixture\resetRuntime(), and setUp().

Here is the call graph for this function:

tearDown()

MigratedLanguageFileSyncLockTestCase::tearDown ( )

protected

Definition at line 58 of file MigratedLanguageFileSyncLockTestCase.php.

                                 : void
    {
        MigratedPoFixture::removeDirectory($this->client_data_dir);
 
        parent::tearDown();
    }

References MigratedPoFixture\removeDirectory(), and tearDown().

Here is the call graph for this function:

Field Documentation

$client_data_dir

string MigratedLanguageFileSyncLockTestCase::$client_data_dir

protected

Definition at line 36 of file MigratedLanguageFileSyncLockTestCase.php.

$directory

LanguageFileDirectory MigratedLanguageFileSyncLockTestCase::$directory

protected

Definition at line 38 of file MigratedLanguageFileSyncLockTestCase.php.

$manager

LanguageFileDirectoryManager MigratedLanguageFileSyncLockTestCase::$manager

protected

Definition at line 40 of file MigratedLanguageFileSyncLockTestCase.php.

MODULE

const string MigratedLanguageFileSyncLockTestCase::MODULE = 'stest'

protected

Definition at line 34 of file MigratedLanguageFileSyncLockTestCase.php.

---

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

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