CronJobManagerTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use PHPUnit\Framework\TestCase;
use ILIAS\Cron\Job\JobRepository;
use ILIAS\Cron\Job\JobResult;
use ILIAS\Cron\CronJob;
use ILIAS\Cron\Job\Manager\JobManagerImpl;

class CronJobManagerTest extends TestCase
{
    private function createClockFactoryMock(): \ILIAS\Data\Clock\ClockFactory
    {
        $clock_factory = $this->createMock(ILIAS\Data\Clock\ClockFactory::class);
        $now = new DateTimeImmutable('@' . time());
        $clock_factory->method('system')->willReturn(
            new readonly class ($now) implements \ILIAS\Data\Clock\ClockInterface {
                public function __construct(private DateTimeImmutable $now)
                {
                }

                public function now(): DateTimeImmutable
                {
                    return $this->now;
                }
            }
        );

        return $clock_factory;
    }

    public function testCronManagerActivatesJobWhenJobWasReset(): void
    {
        $db = $this->createMock(ilDBInterface::class);
        $setting = $this->getMockBuilder(ilSetting::class)->disableOriginalConstructor()->getMock();
        $logger = $this->getMockBuilder(ilLogger::class)->disableOriginalConstructor()->getMock();
        $repository = $this->createMock(JobRepository::class);
        $job = $this->createMock(CronJob::class);
        $user = $this->getMockBuilder(ilObjUser::class)
            ->disableOriginalConstructor()
            ->onlyMethods(['getId'])
            ->getMock();

        $clock_factory = $this->createClockFactoryMock();

        $cronManager = new JobManagerImpl(
            $repository,
            $db,
            $setting,
            $logger,
            $clock_factory
        );

        $repository->expects($this->once())->method('updateJobResult')->with(
            $job,
            $clock_factory->system()->now(),
            $user,
            $this->isInstanceOf(JobResult::class),
            true
        );

        $repository->expects($this->once())->method('resetJob')->with(
            $job
        );

        $repository->expects($this->once())->method('activateJob')->with(
            $job,
            $clock_factory->system()->now(),
            $user,
            true
        );

        $job->expects($this->once())->method('activationWasToggled')->with(
            $db,
            $setting,
            true
        );

        $cronManager->resetJob($job, $user);
    }

    public function testCronManagerNotifiesJobWhenJobGetsActivated(): void
    {
        $db = $this->createMock(ilDBInterface::class);
        $setting = $this->getMockBuilder(ilSetting::class)->disableOriginalConstructor()->getMock();
        $logger = $this->getMockBuilder(ilLogger::class)->disableOriginalConstructor()->getMock();
        $repository = $this->createMock(JobRepository::class);
        $job = $this->createMock(CronJob::class);
        $user = $this->getMockBuilder(ilObjUser::class)
            ->disableOriginalConstructor()
            ->onlyMethods(['getId'])
            ->getMock();

        $clock_factory = $this->createClockFactoryMock();

        $cronManager = new JobManagerImpl(
            $repository,
            $db,
            $setting,
            $logger,
            $clock_factory
        );

        $consecutive = [
            [$job, $clock_factory->system()->now(), $user, true],
            [$job, $clock_factory->system()->now(), $user, false]
        ];
        $repository
            ->expects($this->exactly(2))
            ->method('activateJob')
            ->willReturnCallback(
                function ($job, $date, $user, $flag) use (&$consecutive): void {
                    [$ejob, $edate, $euser, $eflag] = array_shift($consecutive);
                    $this->assertEquals($ejob, $job);
                    $this->assertEquals($edate, $date);
                    $this->assertEquals($euser, $user);
                    $this->assertEquals($eflag, $flag);
                }
            );

        $job->expects($this->exactly(2))->method('activationWasToggled')->with(
            $db,
            $setting,
            true
        );

        $cronManager->activateJob($job, $user, true);
        $cronManager->activateJob($job, $user, false);
    }

    public function testCronManagerNotifiesJobWhenJobGetsDeactivated(): void
    {
        $db = $this->createMock(ilDBInterface::class);
        $setting = $this->getMockBuilder(ilSetting::class)->disableOriginalConstructor()->getMock();
        $logger = $this->getMockBuilder(ilLogger::class)->disableOriginalConstructor()->getMock();
        $repository = $this->createMock(JobRepository::class);
        $job = $this->createMock(CronJob::class);
        $user = $this->getMockBuilder(ilObjUser::class)
            ->disableOriginalConstructor()
            ->onlyMethods(['getId'])
            ->getMock();

        $clock_factory = $this->createClockFactoryMock();

        $cronManager = new JobManagerImpl(
            $repository,
            $db,
            $setting,
            $logger,
            $clock_factory
        );

        $consecutive = [
            [$job, $clock_factory->system()->now(), $user, true],
            [$job, $clock_factory->system()->now(), $user, false]
        ];
        $repository
            ->expects($this->exactly(2))
            ->method('deactivateJob')
            ->willReturnCallback(
                function ($job, $date, $user, $flag) use (&$consecutive): void {
                    [$ejob, $edate, $euser, $eflag] = array_shift($consecutive);
                    $this->assertEquals($ejob, $job);
                    $this->assertEquals($edate, $date);
                    $this->assertEquals($euser, $user);
                    $this->assertEquals($eflag, $flag);
                }
            );

        $job->expects($this->exactly(2))->method('activationWasToggled')->with(
            $db,
            $setting,
            false
        );

        $cronManager->deactivateJob($job, $user, true);
        $cronManager->deactivateJob($job, $user, false);
    }
}