Add unit tests for RunTaskJob.
This commit is contained in:
Dane Everitt
parent
238ce435d6
commit
d5bf8734ef
4 changed files with 219 additions and 99 deletions
216
tests/Unit/Jobs/Schedule/RunTaskJobTest.php
Normal file
216
tests/Unit/Jobs/Schedule/RunTaskJobTest.php
Normal file
|
|
@ -0,0 +1,216 @@
|
|||
<?php
|
||||
/*
|
||||
* Pterodactyl - Panel
|
||||
* Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
|
||||
*
|
||||
* This software is licensed under the terms of the MIT license.
|
||||
* https://opensource.org/licenses/MIT
|
||||
*/
|
||||
|
||||
namespace Tests\Unit\Jobs\Schedule;
|
||||
|
||||
use Mockery as m;
|
||||
use Carbon\Carbon;
|
||||
use Tests\TestCase;
|
||||
use Pterodactyl\Models\Task;
|
||||
use Pterodactyl\Models\Server;
|
||||
use Pterodactyl\Models\Schedule;
|
||||
use Illuminate\Support\Facades\Bus;
|
||||
use Pterodactyl\Jobs\Schedule\RunTaskJob;
|
||||
use Illuminate\Contracts\Config\Repository;
|
||||
use Pterodactyl\Contracts\Repository\TaskRepositoryInterface;
|
||||
use Pterodactyl\Services\DaemonKeys\DaemonKeyProviderService;
|
||||
use Pterodactyl\Contracts\Repository\ScheduleRepositoryInterface;
|
||||
use Pterodactyl\Contracts\Repository\Daemon\PowerRepositoryInterface;
|
||||
use Pterodactyl\Contracts\Repository\Daemon\CommandRepositoryInterface;
|
||||
|
||||
class RunTaskJobTest extends TestCase
|
||||
{
|
||||
/**
|
||||
* @var \Pterodactyl\Contracts\Repository\Daemon\CommandRepositoryInterface|\Mockery\Mock
|
||||
*/
|
||||
protected $commandRepository;
|
||||
|
||||
/**
|
||||
* @var \Illuminate\Contracts\Config\Repository|\Mockery\Mock
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* @var \Pterodactyl\Services\DaemonKeys\DaemonKeyProviderService|\Mockery\Mock
|
||||
*/
|
||||
protected $keyProviderService;
|
||||
|
||||
/**
|
||||
* @var \Pterodactyl\Contracts\Repository\Daemon\PowerRepositoryInterface|\Mockery\Mock
|
||||
*/
|
||||
protected $powerRepository;
|
||||
|
||||
/**
|
||||
* @var \Pterodactyl\Contracts\Repository\ScheduleRepositoryInterface|\Mockery\Mock
|
||||
*/
|
||||
protected $scheduleRepository;
|
||||
|
||||
/**
|
||||
* @var \Pterodactyl\Contracts\Repository\TaskRepositoryInterface|\Mockery\Mock
|
||||
*/
|
||||
protected $taskRepository;
|
||||
|
||||
/**
|
||||
* Setup tests.
|
||||
*/
|
||||
public function setUp()
|
||||
{
|
||||
parent::setUp();
|
||||
Bus::fake();
|
||||
|
||||
$this->commandRepository = m::mock(CommandRepositoryInterface::class);
|
||||
$this->config = m::mock(Repository::class);
|
||||
$this->keyProviderService = m::mock(DaemonKeyProviderService::class);
|
||||
$this->powerRepository = m::mock(PowerRepositoryInterface::class);
|
||||
$this->scheduleRepository = m::mock(ScheduleRepositoryInterface::class);
|
||||
$this->taskRepository = m::mock(TaskRepositoryInterface::class);
|
||||
|
||||
$this->app->instance(Repository::class, $this->config);
|
||||
$this->app->instance(TaskRepositoryInterface::class, $this->taskRepository);
|
||||
$this->app->instance(ScheduleRepositoryInterface::class, $this->scheduleRepository);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test power option passed to job.
|
||||
*/
|
||||
public function testPowerAction()
|
||||
{
|
||||
Carbon::setTestNow();
|
||||
|
||||
$schedule = factory(Schedule::class)->make();
|
||||
$task = factory(Task::class)->make(['action' => 'power', 'sequence_id' => 1]);
|
||||
$server = factory(Server::class)->make();
|
||||
$task->server = $server;
|
||||
|
||||
$this->taskRepository->shouldReceive('getTaskWithServer')->with($task->id)->once()->andReturn($task);
|
||||
$this->keyProviderService->shouldReceive('handle')->with($server->id, $server->owner_id)->once()->andReturn('123456');
|
||||
$this->powerRepository->shouldReceive('setNode')->with($server->node_id)->once()->andReturnSelf()
|
||||
->shouldReceive('setAccessServer')->with($server->uuid)->once()->andReturnSelf()
|
||||
->shouldReceive('setAccessToken')->with('123456')->once()->andReturnSelf()
|
||||
->shouldReceive('sendSignal')->with($task->payload)->once()->andReturnNull();
|
||||
|
||||
$this->taskRepository->shouldReceive('update')->with($task->id, ['is_queued' => false])->once()->andReturnNull();
|
||||
$this->taskRepository->shouldReceive('getNextTask')->with($schedule->id, $task->sequence_id)->once()->andReturnNull();
|
||||
|
||||
$this->scheduleRepository->shouldReceive('withoutFresh->update')->with($schedule->id, [
|
||||
'is_processing' => false,
|
||||
'last_run_at' => Carbon::now()->toDateTimeString(),
|
||||
])->once()->andReturnNull();
|
||||
|
||||
$this->getJobInstance($task->id, $schedule->id);
|
||||
|
||||
Bus::assertNotDispatched(RunTaskJob::class);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test commmand action passed to job.
|
||||
*/
|
||||
public function testCommandAction()
|
||||
{
|
||||
Carbon::setTestNow();
|
||||
|
||||
$schedule = factory(Schedule::class)->make();
|
||||
$task = factory(Task::class)->make(['action' => 'command', 'sequence_id' => 1]);
|
||||
$server = factory(Server::class)->make();
|
||||
$task->server = $server;
|
||||
|
||||
$this->taskRepository->shouldReceive('getTaskWithServer')->with($task->id)->once()->andReturn($task);
|
||||
$this->keyProviderService->shouldReceive('handle')->with($server->id, $server->owner_id)->once()->andReturn('123456');
|
||||
$this->commandRepository->shouldReceive('setNode')->with($server->node_id)->once()->andReturnSelf()
|
||||
->shouldReceive('setAccessServer')->with($server->uuid)->once()->andReturnSelf()
|
||||
->shouldReceive('setAccessToken')->with('123456')->once()->andReturnSelf()
|
||||
->shouldReceive('send')->with($task->payload)->once()->andReturnNull();
|
||||
|
||||
$this->taskRepository->shouldReceive('update')->with($task->id, ['is_queued' => false])->once()->andReturnNull();
|
||||
$this->taskRepository->shouldReceive('getNextTask')->with($schedule->id, $task->sequence_id)->once()->andReturnNull();
|
||||
|
||||
$this->scheduleRepository->shouldReceive('withoutFresh->update')->with($schedule->id, [
|
||||
'is_processing' => false,
|
||||
'last_run_at' => Carbon::now()->toDateTimeString(),
|
||||
])->once()->andReturnNull();
|
||||
|
||||
$this->getJobInstance($task->id, $schedule->id);
|
||||
|
||||
Bus::assertNotDispatched(RunTaskJob::class);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that the next task in the list is queued if the current one is not the last.
|
||||
*/
|
||||
public function testNextTaskQueuedIfExists()
|
||||
{
|
||||
Carbon::setTestNow();
|
||||
|
||||
$schedule = factory(Schedule::class)->make();
|
||||
$task = factory(Task::class)->make(['action' => 'command', 'sequence_id' => 1]);
|
||||
$server = factory(Server::class)->make();
|
||||
$task->server = $server;
|
||||
|
||||
$this->taskRepository->shouldReceive('getTaskWithServer')->with($task->id)->once()->andReturn($task);
|
||||
$this->keyProviderService->shouldReceive('handle')->with($server->id, $server->owner_id)->once()->andReturn('123456');
|
||||
$this->commandRepository->shouldReceive('setNode')->with($server->node_id)->once()->andReturnSelf()
|
||||
->shouldReceive('setAccessServer')->with($server->uuid)->once()->andReturnSelf()
|
||||
->shouldReceive('setAccessToken')->with('123456')->once()->andReturnSelf()
|
||||
->shouldReceive('send')->with($task->payload)->once()->andReturnNull();
|
||||
|
||||
$this->taskRepository->shouldReceive('update')->with($task->id, ['is_queued' => false])->once()->andReturnNull();
|
||||
|
||||
$nextTask = factory(Task::class)->make();
|
||||
$this->taskRepository->shouldReceive('getNextTask')->with($schedule->id, $task->sequence_id)->once()->andReturn($nextTask);
|
||||
$this->taskRepository->shouldReceive('update')->with($nextTask->id, [
|
||||
'is_queued' => true,
|
||||
])->once()->andReturnNull();
|
||||
|
||||
$this->getJobInstance($task->id, $schedule->id);
|
||||
|
||||
Bus::assertDispatched(RunTaskJob::class, function ($job) use ($nextTask, $schedule) {
|
||||
$this->assertEquals($nextTask->id, $job->task, 'Assert correct task ID is passed to job.');
|
||||
$this->assertEquals($schedule->id, $job->schedule, 'Assert correct schedule ID is passed to job.');
|
||||
$this->assertEquals($nextTask->time_offset, $job->delay, 'Assert correct job delay time is set.');
|
||||
|
||||
return true;
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that an exception is thrown if an invalid task action is supplied.
|
||||
*
|
||||
* @expectedException \InvalidArgumentException
|
||||
* @expectedExceptionMessage Cannot run a task that points to a non-existant action.
|
||||
*/
|
||||
public function testInvalidActionPassedToJob()
|
||||
{
|
||||
$task = factory(Task::class)->make(['action' => 'invalid', 'sequence_id' => 1]);
|
||||
$task->server = [];
|
||||
|
||||
$this->taskRepository->shouldReceive('getTaskWithServer')->with($task->id)->once()->andReturn($task);
|
||||
|
||||
$this->getJobInstance($task->id, 1234);
|
||||
}
|
||||
|
||||
/**
|
||||
* Run the job using the mocks provided.
|
||||
*
|
||||
* @param int $task
|
||||
* @param int $schedule
|
||||
*
|
||||
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
||||
* @throws \Pterodactyl\Exceptions\Repository\Daemon\InvalidPowerSignalException
|
||||
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||
*/
|
||||
private function getJobInstance($task, $schedule)
|
||||
{
|
||||
return (new RunTaskJob($task, $schedule))->handle(
|
||||
$this->commandRepository,
|
||||
$this->keyProviderService,
|
||||
$this->powerRepository,
|
||||
$this->taskRepository
|
||||
);
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue