class.ilTestProcessLockerFile.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use ILIAS\Test\Logging\TestLogger;
 
class ilTestProcessLockerFile extends ilTestProcessLocker
{
    public const PROCESS_NAME_TEST_START_LOCK_CHECK = 'testStartLockCheck';
    public const PROCESS_NAME_RANDOM_PASS_BUILD = 'randomPassBuild';
    public const PROCESS_NAME_TEST_FINISH = 'testFinish';
 
    protected $lockFileHandles = [];
 
    public function __construct(
        private readonly ilTestProcessLockFileStorage $lockFileStorage,
        private readonly ilLogger|TestLogger $logger
    ) {
    }
 
    protected function onBeforeExecutingTestStartOperation()
    {
        parent::onBeforeExecutingTestStartOperation();
        $this->requestLock(self::PROCESS_NAME_TEST_START_LOCK_CHECK);
    }
 
    protected function onAfterExecutingTestStartOperation()
    {
        $this->releaseLock(self::PROCESS_NAME_TEST_START_LOCK_CHECK);
        parent::onAfterExecutingTestStartOperation();
    }
 
    protected function onBeforeExecutingRandomPassBuildOperation($withTaxonomyTables = false)
    {
        parent::onBeforeExecutingRandomPassBuildOperation($withTaxonomyTables);
        $this->requestLock(self::PROCESS_NAME_RANDOM_PASS_BUILD);
    }
 
    protected function onAfterExecutingRandomPassBuildOperation($withTaxonomyTables = false)
    {
        $this->releaseLock(self::PROCESS_NAME_RANDOM_PASS_BUILD);
        parent::onAfterExecutingRandomPassBuildOperation($withTaxonomyTables);
    }
 
    protected function onBeforeExecutingTestFinishOperation()
    {
        parent::onBeforeExecutingTestStartOperation();
        $this->requestLock(self::PROCESS_NAME_TEST_FINISH);
    }
 
    protected function onAfterExecutingTestFinishOperation()
    {
        $this->releaseLock(self::PROCESS_NAME_TEST_FINISH);
        parent::onAfterExecutingTestStartOperation();
    }
 
    protected function onBeforeExecutingNamedOperation(string $operationDescriptor): void
    {
        $this->requestLock($operationDescriptor);
        parent::onBeforeExecutingNamedOperation($operationDescriptor);
    }
 
    protected function onAfterExecutingNamedOperation(string $operationDescriptor): void
    {
        $this->releaseLock($operationDescriptor);
        parent::onAfterExecutingNamedOperation($operationDescriptor);
    }
 
    private function requestLock($processName)
    {
        $lockFilePath = $this->getLockFilePath($processName);
        $this->lockFileHandles[$processName] = fopen($lockFilePath, 'w');
        if (!flock($this->lockFileHandles[$processName], LOCK_EX)) {
            $this->logger->error("Flock failed for {$lockFilePath}.");
        }
    }
 
    private function getLockFilePath($processName): string
    {
        $path = $this->lockFileStorage->getAbsolutePath();
        return $path . '/' . $processName . '.lock';
    }
 
    private function releaseLock($processName)
    {
        flock($this->lockFileHandles[$processName], LOCK_UN);
        fclose($this->lockFileHandles[$processName]);
    }
}