zenstruck / schedule-bundle

tests/Schedule/Extension/SingleServerExtensionTest.php

<?php

namespace Zenstruck\ScheduleBundle\Tests\Schedule\Extension;

use PHPUnit\Framework\TestCase;

The type PHPUnit\Framework\TestCase was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\Lock\LockFactory;
use Symfony\Component\Lock\Store\FlockStore;
use Zenstruck\ScheduleBundle\Schedule;
use Zenstruck\ScheduleBundle\Schedule\Exception\SkipSchedule;
use Zenstruck\ScheduleBundle\Schedule\Exception\SkipTask;
use Zenstruck\ScheduleBundle\Schedule\Extension\Handler\SingleServerHandler;
use Zenstruck\ScheduleBundle\Schedule\Extension\SingleServerExtension;
use Zenstruck\ScheduleBundle\Schedule\ScheduleRunContext;
use Zenstruck\ScheduleBundle\Schedule\Task\TaskRunContext;
use Zenstruck\ScheduleBundle\Tests\Fixture\MockLogger;
use Zenstruck\ScheduleBundle\Tests\Fixture\MockScheduleBuilder;
use Zenstruck\ScheduleBundle\Tests\Fixture\MockTask;

/**
 * @author Kevin Bond <kevinbond@gmail.com>
 */
final class SingleServerExtensionTest extends TestCase
{
    /**
     * @test
     */
    public function can_lock_schedule()
    {
        $logger = new MockLogger();
        $lockFactory = new LockFactory(new FlockStore());
        $lockFactory->setLogger($logger);

        (new MockScheduleBuilder())
            ->addHandler(new SingleServerHandler($lockFactory))
            ->addExtension(new SingleServerExtension())
            ->run()
        ;

        $this->assertTrue($logger->hasMessageThatContains('Successfully acquired'));
        $this->assertTrue($logger->hasMessageThatContains('Expiration defined'));
    }

    /**
     * @test
     */
    public function can_lock_task()
    {
        $logger = new MockLogger();
        $lockFactory = new LockFactory(new FlockStore());
        $lockFactory->setLogger($logger);

        (new MockScheduleBuilder())
            ->addHandler(new SingleServerHandler($lockFactory))
            ->addTask((new MockTask())->onSingleServer())
            ->run()
        ;

        $this->assertTrue($logger->hasMessageThatContains('Successfully acquired'));
        $this->assertTrue($logger->hasMessageThatContains('Expiration defined'));
    }

    /**
     * @test
     */
    public function provides_helpful_message_if_handler_not_configured()
    {
        $this->expectException(\LogicException::class);
        $this->expectExceptionMessage('To use "onSingleServer" you must configure a lock factory (config path: "zenstruck_schedule.single_server_lock_factory")');

        (new MockScheduleBuilder())
            ->addExtension(new SingleServerExtension())
            ->run()
        ;
    }

    /**
     * @test
     */
    public function skips_schedule_if_locked()
    {
        $schedule1 = new Schedule();
        $schedule1->addCommand('my:command');
        $schedule1->onSingleServer();
        $schedule2 = new Schedule();
        $schedule2->addCommand('my:command');
        $schedule2->onSingleServer();

        $handler = new SingleServerHandler(new LockFactory(new FlockStore()));

        $handler->filterSchedule(new ScheduleRunContext($schedule1), $schedule1->getExtensions()[0]);

        $this->expectException(SkipSchedule::class);
        $this->expectExceptionMessage('Schedule running on another server.');

        $handler->filterSchedule(new ScheduleRunContext($schedule2), $schedule2->getExtensions()[0]);
    }

    /**
     * @test
     */
    public function skips_task_if_locked()
    {
        $schedule1 = new Schedule();
        $task1 = $schedule1->addCommand('my:command')->onSingleServer();
        $schedule2 = new Schedule();
        $task2 = $schedule2->addCommand('my:command')->onSingleServer();

        $handler = new SingleServerHandler(new LockFactory(new FlockStore()));

        $handler->filterTask(new TaskRunContext(new ScheduleRunContext($schedule1), $task1), $task1->getExtensions()[0]);

        $this->expectException(SkipTask::class);
        $this->expectExceptionMessage('Task running on another server.');

        $handler->filterTask(new TaskRunContext(new ScheduleRunContext($schedule2), $task2), $task2->getExtensions()[0]);
    }
}