misc_pterodactyl-panel/tests/Integration/Services/Schedules/ProcessScheduleServiceTest.php

170 lines
6.2 KiB
PHP
Raw Normal View History

2020-10-15 04:17:57 +00:00
<?php
namespace Pterodactyl\Tests\Integration\Services\Schedules;
use Mockery;
use Exception;
use Carbon\CarbonImmutable;
2020-10-15 04:17:57 +00:00
use Pterodactyl\Models\Task;
use InvalidArgumentException;
use Pterodactyl\Models\Schedule;
use Illuminate\Support\Facades\Bus;
use Illuminate\Contracts\Bus\Dispatcher;
use Pterodactyl\Jobs\Schedule\RunTaskJob;
use Pterodactyl\Exceptions\DisplayException;
use Pterodactyl\Tests\Integration\IntegrationTestCase;
use Pterodactyl\Services\Schedules\ProcessScheduleService;
class ProcessScheduleServiceTest extends IntegrationTestCase
{
/**
* Test that a schedule with no tasks registered returns an error.
*/
public function testScheduleWithNoTasksReturnsException()
{
$server = $this->createServerModel();
$schedule = Schedule::factory()->create(['server_id' => $server->id]);
2020-10-15 04:17:57 +00:00
$this->expectException(DisplayException::class);
$this->expectExceptionMessage('Cannot process schedule for task execution: no tasks are registered.');
$this->getService()->handle($schedule);
}
/**
* Test that an error during the schedule update is not persisted to the database.
*/
public function testErrorDuringScheduleDataUpdateDoesNotPersistChanges()
{
$server = $this->createServerModel();
/** @var \Pterodactyl\Models\Schedule $schedule */
$schedule = Schedule::factory()->create([
2020-10-15 04:17:57 +00:00
'server_id' => $server->id,
'cron_minute' => 'hodor', // this will break the getNextRunDate() function.
]);
/** @var \Pterodactyl\Models\Task $task */
$task = Task::factory()->create(['schedule_id' => $schedule->id, 'sequence_id' => 1]);
2020-10-15 04:17:57 +00:00
$this->expectException(InvalidArgumentException::class);
$this->getService()->handle($schedule);
$this->assertDatabaseMissing('schedules', ['id' => $schedule->id, 'is_processing' => true]);
$this->assertDatabaseMissing('tasks', ['id' => $task->id, 'is_queued' => true]);
}
/**
* Test that a job is dispatched as expected using the initial delay.
*
* @param bool $now
* @dataProvider dispatchNowDataProvider
*/
public function testJobCanBeDispatchedWithExpectedInitialDelay($now)
{
Bus::fake();
2020-10-15 04:17:57 +00:00
$server = $this->createServerModel();
/** @var \Pterodactyl\Models\Schedule $schedule */
$schedule = Schedule::factory()->create(['server_id' => $server->id]);
2020-10-15 04:17:57 +00:00
/** @var \Pterodactyl\Models\Task $task */
$task = Task::factory()->create(['schedule_id' => $schedule->id, 'time_offset' => 10, 'sequence_id' => 1]);
2020-10-15 04:17:57 +00:00
$this->getService()->handle($schedule, $now);
Bus::assertDispatched(RunTaskJob::class, function ($job) use ($now, $task) {
$this->assertInstanceOf(RunTaskJob::class, $job);
$this->assertSame($task->id, $job->task->id);
// Jobs using dispatchNow should not have a delay associated with them.
$this->assertSame($now ? null : 10, $job->delay);
return true;
});
2020-10-15 04:17:57 +00:00
$this->assertDatabaseHas('schedules', ['id' => $schedule->id, 'is_processing' => true]);
$this->assertDatabaseHas('tasks', ['id' => $task->id, 'is_queued' => true]);
}
/**
* Test that even if a schedule's task sequence gets messed up the first task based on
* the ascending order of tasks is used.
*
* @see https://github.com/pterodactyl/panel/issues/2534
*/
public function testFirstSequenceTaskIsFound()
{
Bus::fake();
$server = $this->createServerModel();
/** @var \Pterodactyl\Models\Schedule $schedule */
$schedule = Schedule::factory()->create(['server_id' => $server->id]);
/** @var \Pterodactyl\Models\Task $task */
$task2 = Task::factory()->create(['schedule_id' => $schedule->id, 'sequence_id' => 4]);
$task = Task::factory()->create(['schedule_id' => $schedule->id, 'sequence_id' => 2]);
$task3 = Task::factory()->create(['schedule_id' => $schedule->id, 'sequence_id' => 3]);
$this->getService()->handle($schedule);
Bus::assertDispatched(RunTaskJob::class, function (RunTaskJob $job) use ($task) {
return $task->id === $job->task->id;
});
$this->assertDatabaseHas('schedules', ['id' => $schedule->id, 'is_processing' => true]);
$this->assertDatabaseHas('tasks', ['id' => $task->id, 'is_queued' => true]);
$this->assertDatabaseHas('tasks', ['id' => $task2->id, 'is_queued' => false]);
$this->assertDatabaseHas('tasks', ['id' => $task3->id, 'is_queued' => false]);
}
/**
* Tests that a task's processing state is reset correctly if using "dispatchNow" and there is
* an exception encountered while running it.
*
* @see https://github.com/pterodactyl/panel/issues/2550
*/
public function testTaskDispatchedNowIsResetProperlyIfErrorIsEncountered()
{
$this->swap(Dispatcher::class, $dispatcher = Mockery::mock(Dispatcher::class));
$server = $this->createServerModel();
/** @var \Pterodactyl\Models\Schedule $schedule */
$schedule = Schedule::factory()->create(['server_id' => $server->id, 'last_run_at' => null]);
/** @var \Pterodactyl\Models\Task $task */
$task = Task::factory()->create(['schedule_id' => $schedule->id, 'sequence_id' => 1]);
$dispatcher->expects('dispatchNow')->andThrows(new Exception('Test thrown exception'));
$this->expectException(Exception::class);
$this->expectExceptionMessage('Test thrown exception');
$this->getService()->handle($schedule, true);
$this->assertDatabaseHas('schedules', [
'id' => $schedule->id,
'is_processing' => false,
'last_run_at' => CarbonImmutable::now()->toAtomString(),
]);
$this->assertDatabaseHas('tasks', ['id' => $task->id, 'is_queued' => false]);
}
2020-10-15 04:17:57 +00:00
/**
* @return array
*/
public function dispatchNowDataProvider(): array
{
return [[true], [false]];
}
/**
* @return \Pterodactyl\Services\Schedules\ProcessScheduleService
*/
private function getService()
{
return $this->app->make(ProcessScheduleService::class);
}
}