CronJobScheduleTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use PHPUnit\Framework\TestCase;
use ILIAS\Cron\Job\Schedule\JobScheduleType;
use ILIAS\Cron\Job\JobResult;
use ILIAS\Cron\CronJob;
use PHPUnit\Framework\Attributes\DataProvider;

class CronJobScheduleTest extends TestCase
{
    private static DateTimeImmutable $now;
    private static DateTimeImmutable $this_quarter_start;

    private static function getJob(
        bool $has_flexible_schedule,
        JobScheduleType $default_schedule_type,
        ?int $default_schedule_value,
        JobScheduleType $schedule_type,
        ?int $schedule_value
    ): CronJob {
        $job_instance = new class (
            $has_flexible_schedule,
            $default_schedule_type,
            $default_schedule_value,
            $schedule_type,
            $schedule_value
        ) extends
            CronJob {
            public function __construct(
                private readonly bool $has_flexible_schedule,
                private readonly JobScheduleType $default_schedule_type,
                private readonly ?int $default_schedule_value,
                JobScheduleType $schedule_type,
                ?int $schedule_value
            ) {
                $this->schedule_type = $schedule_type;
                $this->schedule_value = $schedule_value;
            }

            public function getId(): string
            {
                return 'phpunit';
            }

            public function getTitle(): string
            {
                return 'phpunit';
            }

            public function getDescription(): string
            {
                return 'phpunit';
            }

            public function hasAutoActivation(): bool
            {
                return false;
            }

            public function hasFlexibleSchedule(): bool
            {
                return $this->has_flexible_schedule;
            }

            public function getDefaultScheduleType(): JobScheduleType
            {
                return $this->default_schedule_type;
            }

            public function getDefaultScheduleValue(): ?int
            {
                return $this->default_schedule_value;
            }

            public function run(): JobResult
            {
                return new JobResult();
            }
        };

        $job_instance->setDateTimeProvider(fn(): DateTimeImmutable => self::$now);

        return $job_instance;
    }

    public static function jobProvider(): array
    {
        return [
            'Manual Run is Always Due' => [
                self::getJob(
                    true,
                    JobScheduleType::DAILY,
                    null,
                    JobScheduleType::DAILY,
                    null
                ),
                true,
                null,
                JobScheduleType::DAILY,
                null,
                true
            ],
            'Job Without Any Run is Always Due' => [
                self::getJob(
                    true,
                    JobScheduleType::DAILY,
                    null,
                    JobScheduleType::DAILY,
                    null
                ),
                false,
                null,
                JobScheduleType::DAILY,
                null,
                true
            ],
            'Daily Schedule / Did not run Today' => [
                self::getJob(
                    true,
                    JobScheduleType::DAILY,
                    null,
                    JobScheduleType::DAILY,
                    null
                ),
                false,
                function (): DateTimeImmutable {
                    self::$now = new DateTimeImmutable('@' . time());

                    return self::$now->modify('-1 day');
                },
                JobScheduleType::DAILY,
                null,
                true
            ],
            'Daily Schedule / Did run Today' => [
                self::getJob(
                    true,
                    JobScheduleType::DAILY,
                    null,
                    JobScheduleType::DAILY,
                    null
                ),
                false,
                function (): DateTimeImmutable {
                    self::$now = new DateTimeImmutable('@' . time());

                    return self::$now;
                },
                JobScheduleType::DAILY,
                null,
                false
            ],
            'Weekly Schedule / Did not run this Week' => [
                self::getJob(
                    true,
                    JobScheduleType::WEEKLY,
                    null,
                    JobScheduleType::WEEKLY,
                    null
                ),
                false,
                function (): DateTimeImmutable {
                    self::$now = new DateTimeImmutable('@' . time());

                    return self::$now->modify('-1 week');
                },
                JobScheduleType::WEEKLY,
                null,
                true
            ],
            'Weekly Schedule / Did run this Week' => [
                self::getJob(
                    true,
                    JobScheduleType::WEEKLY,
                    null,
                    JobScheduleType::WEEKLY,
                    null
                ),
                false,
                function (): DateTimeImmutable {
                    self::$now = new DateTimeImmutable('@' . time());

                    return self::$now->modify('monday this week');
                },
                JobScheduleType::WEEKLY,
                null,
                false
            ],
            'Monthly Schedule / Did not run this Month' => [
                self::getJob(
                    true,
                    JobScheduleType::MONTHLY,
                    null,
                    JobScheduleType::MONTHLY,
                    null
                ),
                false,
                function (): DateTimeImmutable {
                    self::$now = new DateTimeImmutable('@' . time());

                    return self::$now->modify('last day of last month');
                },
                JobScheduleType::MONTHLY,
                null,
                true
            ],
            'Monthly Schedule / Did run this Month' => [
                self::getJob(
                    true,
                    JobScheduleType::MONTHLY,
                    null,
                    JobScheduleType::MONTHLY,
                    null
                ),
                false,
                function (): DateTimeImmutable {
                    self::$now = new DateTimeImmutable('@' . time());

                    return self::$now->modify('first day of this month');
                },
                JobScheduleType::MONTHLY,
                null,
                false
            ],
            'Yearly Schedule / Did not run this Year' => [
                self::getJob(
                    true,
                    JobScheduleType::YEARLY,
                    null,
                    JobScheduleType::YEARLY,
                    null
                ),
                false,
                function (): DateTimeImmutable {
                    self::$now = new DateTimeImmutable('@' . time());

                    return self::$now->modify('-1 year');
                },
                JobScheduleType::YEARLY,
                null,
                true
            ],
            'Yearly Schedule / Did run this Year' => [
                self::getJob(
                    true,
                    JobScheduleType::YEARLY,
                    null,
                    JobScheduleType::YEARLY,
                    null
                ),
                false,
                function (): DateTimeImmutable {
                    self::$now = new DateTimeImmutable('@' . time());

                    return self::$now->modify('first day of January this year');
                },
                JobScheduleType::YEARLY,
                null,
                false
            ],
            'Quarterly Schedule / Did not run this Quarter' => [
                self::getJob(
                    true,
                    JobScheduleType::QUARTERLY,
                    null,
                    JobScheduleType::QUARTERLY,
                    null
                ),
                false,
                function (): DateTimeImmutable {
                    self::$now = new DateTimeImmutable('@' . time());

                    $offset = (((int) self::$now->format('n')) - 1) % 3;
                    self::$this_quarter_start = self::$now->modify("first day of -$offset month midnight");

                    return self::$this_quarter_start->modify('-1 seconds');
                },
                JobScheduleType::QUARTERLY,
                null,
                true
            ],
            'Quarterly Schedule / Did run this Quarter' => [
                self::getJob(
                    true,
                    JobScheduleType::QUARTERLY,
                    null,
                    JobScheduleType::QUARTERLY,
                    null
                ),
                false,
                function (): DateTimeImmutable {
                    self::$now = new DateTimeImmutable('@' . time());

                    $offset = (((int) self::$now->format('n')) - 1) % 3;
                    self::$this_quarter_start = self::$now->modify("first day of -$offset month midnight");

                    return self::$this_quarter_start->modify('+30 seconds');
                },
                JobScheduleType::QUARTERLY,
                null,
                false
            ],
            'Minutely Schedule / Did not run this Minute' => [
                self::getJob(
                    true,
                    JobScheduleType::IN_MINUTES,
                    1,
                    JobScheduleType::IN_MINUTES,
                    1
                ),
                false,
                function (): DateTimeImmutable {
                    self::$now = new DateTimeImmutable('@' . time());

                    return self::$now->modify('-1 minute');
                },
                JobScheduleType::IN_MINUTES,
                1,
                true
            ],
            'Minutely Schedule / Did run this Minute' => [
                self::getJob(
                    true,
                    JobScheduleType::IN_MINUTES,
                    1,
                    JobScheduleType::IN_MINUTES,
                    1
                ),
                false,
                function (): DateTimeImmutable {
                    self::$now = new DateTimeImmutable('@' . time());

                    return self::$now->modify('-30 seconds');
                },
                JobScheduleType::IN_MINUTES,
                1,
                false
            ],
            'Hourly Schedule / Did not run this Hour' => [
                self::getJob(
                    true,
                    JobScheduleType::IN_HOURS,
                    7,
                    JobScheduleType::IN_HOURS,
                    7
                ),
                false,
                function (): DateTimeImmutable {
                    self::$now = new DateTimeImmutable('@' . time());

                    return self::$now->modify('-7 hours');
                },
                JobScheduleType::IN_HOURS,
                7,
                true
            ],
            'Hourly Schedule / Did run this Hour' => [
                self::getJob(
                    true,
                    JobScheduleType::IN_HOURS,
                    7,
                    JobScheduleType::IN_HOURS,
                    7
                ),
                false,
                function (): DateTimeImmutable {
                    self::$now = new DateTimeImmutable('@' . time());

                    return self::$now->modify('-7 hours +30 seconds');
                },
                JobScheduleType::IN_HOURS,
                7,
                false
            ],
            'Every 5 Days Schedule / Did not run for 5 Days' => [
                self::getJob(
                    true,
                    JobScheduleType::IN_DAYS,
                    5,
                    JobScheduleType::IN_DAYS,
                    5
                ),
                false,
                function (): DateTimeImmutable {
                    self::$now = new DateTimeImmutable('@' . time());

                    return self::$now->modify('-5 days');
                },
                JobScheduleType::IN_DAYS,
                5,
                true
            ],
            'Every 5 Days Schedule / Did run withing the last 5 Days' => [
                self::getJob(
                    true,
                    JobScheduleType::IN_DAYS,
                    5,
                    JobScheduleType::IN_DAYS,
                    5
                ),
                false,
                function (): DateTimeImmutable {
                    self::$now = new DateTimeImmutable('@' . time());

                    return self::$now->modify('-4 days');
                },
                JobScheduleType::IN_DAYS,
                5,
                false
            ]
        ];
    }

    #[DataProvider('jobProvider')]
    public function testSchedule(
        CronJob $job_instance,
        bool $is_manual_run,
        ?callable $last_run_datetime_callable,
        JobScheduleType $schedule_type,
        ?int $schedule_value,
        bool $should_be_due
    ): void {
        $last_run_datetime = $last_run_datetime_callable ? $last_run_datetime_callable() : null;
        self::assertEquals(
            $should_be_due,
            $job_instance->isDue($last_run_datetime, $schedule_type, $schedule_value, $is_manual_run),
            'Last run: ' . ($last_run_datetime ? $last_run_datetime->format(DATE_ATOM) : 'never')
        );
    }

    public static function weeklyScheduleProvider(): Generator
    {
        yield 'Different Week' => [
            self::getJob(
                true,
                JobScheduleType::WEEKLY,
                null,
                JobScheduleType::WEEKLY,
                null
            ),
            function (): DateTimeImmutable {
                self::$now = new DateTimeImmutable(
                    '@1672570104'
                ); // Sun Jan 01 2023 10:48:24 GMT+0000 (year: 2023 / week: 52)

                return self::$now->modify('-1 week'); // Sun Dec 25 2022 10:48:24 GMT+0000 (year: 2022 / week: 51)
            },
            true
        ];

        yield 'Same Week and Year, but different Month: December (now) and January (Last run)' => [
            self::getJob(
                true,
                JobScheduleType::WEEKLY,
                null,
                JobScheduleType::WEEKLY,
                null
            ),
            function (): DateTimeImmutable {
                self::$now = new DateTimeImmutable(
                    '@1703669703'
                ); // Wed Dec 27 2023 09:35:03 GMT+0000 (year: 2023 / week: 52 / month: 12)

                return new DateTimeImmutable(
                    '@1672570104'
                ); // Sun Jan 01 2023 10:48:24 GMT+0000 (year: 2023 / week: 52 / month: 1)
            },
            true
        ];

        yield 'Same Week and Year and same Month: January' => [
            self::getJob(
                true,
                JobScheduleType::WEEKLY,
                null,
                JobScheduleType::WEEKLY,
                null
            ),
            function (): DateTimeImmutable {
                self::$now = new DateTimeImmutable(
                    '@1704188103'
                ); // Tue Jan 02 2024 09:35:03 GMT+0000 (year: 2024 / week: 1 / month: 1)

                return self::$now->modify(
                    '-1 day'
                ); // Mon Jan 01 2024 09:35:03 GMT+0000 (year: 2024 / week: 1 / month: 1)
            },
            false
        ];

        yield 'Same Week (52nd), but Year Difference > 1' => [
            self::getJob(
                true,
                JobScheduleType::WEEKLY,
                null,
                JobScheduleType::WEEKLY,
                null
            ),
            function (): DateTimeImmutable {
                self::$now = new DateTimeImmutable(
                    '@1672570104'
                ); // Sun Jan 01 2023 10:48:24 GMT+0000 (year: 2023 / week: 52)

                return self::$now->modify('tuesday this week')->modify(
                    '-1 year'
                ); // Mon Dec 27 2021 10:48:24 GMT+0000 (year: 2021 / week: 52)
            },
            true
        ];

        yield 'Same Week (52nd) in different Years, but Turn of the Year' => [
            self::getJob(
                true,
                JobScheduleType::WEEKLY,
                null,
                JobScheduleType::WEEKLY,
                null
            ),
            function (): DateTimeImmutable {
                self::$now = new DateTimeImmutable(
                    '@1672570104'
                ); // Sun Jan 01 2023 10:48:24 GMT+0000 (year: 2023 / week: 52 / month: 1)

                return self::$now->modify(
                    'monday this week'
                ); // Mon Dec 26 2022 10:48:24 GMT+0000 (year: 2022 / week: 52 / month: 12)
            },
            false
        ];

        yield 'Same Week (52nd) in different Years, but not Turn of the Year' => [
            self::getJob(
                true,
                JobScheduleType::WEEKLY,
                null,
                JobScheduleType::WEEKLY,
                null
            ),
            function (): DateTimeImmutable {
                self::$now = new DateTimeImmutable(
                    '@1703669703'
                ); // Wed Dec 27 2023 09:35:03 GMT+0000 (year: 2023 / week: 52 / month: 12)

                return new DateTimeImmutable(
                    '@1672012800'
                ); // Mon Dec 26 2022 00:00:00 GMT+0000 (year: 2022 / week: 52 / month: 12)
            },
            true
        ];
    }

    #[DataProvider('weeklyScheduleProvider')]
    public function testWeeklySchedules(
        CronJob $job_instance,
        callable $last_run_datetime_provider,
        bool $should_be_due
    ): void {
        $last_run_datetime = $last_run_datetime_provider();

        self::assertSame(
            $should_be_due,
            $job_instance->isDue(
                $last_run_datetime,
                $job_instance->getScheduleType(),
                $job_instance->getScheduleValue(),
                false
            ),
            'Last run: ' . $last_run_datetime->format(DATE_ATOM)
        );
    }
}