Merge branch 'develop' into feature/react-admin

tests/Integration/Api/Client/Server/ScheduleTask/CreateServerScheduleTaskTest.php

@@ -89,9 +89,9 @@ class CreateServerScheduleTaskTest extends ClientApiIntegrationTestCase
     }
 
     /**
-     * Test that backups can be tasked out correctly since they do not require a payload.
+     * Test that backups can not be tasked when the backup limit is 0
      */
-    public function testBackupsCanBeTaskedCorrectly()
+    public function testBackupsCanNotBeTaskedIfLimit0()
     {
         [$user, $server] = $this->generateTestAccount();
 
@@ -101,13 +101,17 @@ class CreateServerScheduleTaskTest extends ClientApiIntegrationTestCase
         $this->actingAs($user)->postJson($this->link($schedule, '/tasks'), [
             'action' => 'backup',
             'time_offset' => 0,
-        ])->assertOk();
+        ])
+            ->assertStatus(Response::HTTP_FORBIDDEN)
+            ->assertJsonPath('errors.0.detail', 'A backup task cannot be created when the server\'s backup limit is set to 0.');
 
         $this->actingAs($user)->postJson($this->link($schedule, '/tasks'), [
             'action' => 'backup',
             'payload' => "file.txt\nfile2.log",
             'time_offset' => 0,
-        ])->assertOk();
+        ])
+            ->assertStatus(Response::HTTP_FORBIDDEN)
+            ->assertJsonPath('errors.0.detail', 'A backup task cannot be created when the server\'s backup limit is set to 0.');
     }
 
     /**

tests/Integration/Jobs/Schedule/RunTaskJobTest.php

@@ -0,0 +1,157 @@
+<?php
+
+namespace Pterodactyl\Tests\Integration\Jobs\Schedule;
+
+use Mockery;
+use Exception;
+use Carbon\CarbonImmutable;
+use Pterodactyl\Models\Task;
+use GuzzleHttp\Psr7\Request;
+use InvalidArgumentException;
+use GuzzleHttp\Psr7\Response;
+use Pterodactyl\Models\Server;
+use Pterodactyl\Models\Schedule;
+use Illuminate\Support\Facades\Bus;
+use Pterodactyl\Jobs\Schedule\RunTaskJob;
+use GuzzleHttp\Exception\BadResponseException;
+use Pterodactyl\Tests\Integration\IntegrationTestCase;
+use Pterodactyl\Repositories\Wings\DaemonPowerRepository;
+use Pterodactyl\Exceptions\Http\Connection\DaemonConnectionException;
+
+class RunTaskJobTest extends IntegrationTestCase
+{
+    /**
+     * An inactive job should not be run by the system.
+     */
+    public function testInactiveJobIsNotRun()
+    {
+        $server = $this->createServerModel();
+
+        /** @var \Pterodactyl\Models\Schedule $schedule */
+        $schedule = Schedule::factory()->create([
+            'server_id' => $server->id,
+            'is_processing' => true,
+            'last_run_at' => null,
+            'is_active' => false,
+        ]);
+        /** @var \Pterodactyl\Models\Task $task */
+        $task = Task::factory()->create(['schedule_id' => $schedule->id, 'is_queued' => true]);
+
+        $job = new RunTaskJob($task);
+
+        Bus::dispatchNow($job);
+
+        $task->refresh();
+        $schedule->refresh();
+
+        $this->assertFalse($task->is_queued);
+        $this->assertFalse($schedule->is_processing);
+        $this->assertFalse($schedule->is_active);
+        $this->assertTrue(CarbonImmutable::now()->isSameAs(CarbonImmutable::ISO8601, $schedule->last_run_at));
+    }
+
+    public function testJobWithInvalidActionThrowsException()
+    {
+        $server = $this->createServerModel();
+
+        /** @var \Pterodactyl\Models\Schedule $schedule */
+        $schedule = Schedule::factory()->create(['server_id' => $server->id]);
+        /** @var \Pterodactyl\Models\Task $task */
+        $task = Task::factory()->create(['schedule_id' => $schedule->id, 'action' => 'foobar']);
+
+        $job = new RunTaskJob($task);
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Invalid task action provided: foobar');
+        Bus::dispatchNow($job);
+    }
+
+    /**
+     * @dataProvider isManualRunDataProvider
+     */
+    public function testJobIsExecuted(bool $isManualRun)
+    {
+        $server = $this->createServerModel();
+
+        /** @var \Pterodactyl\Models\Schedule $schedule */
+        $schedule = Schedule::factory()->create([
+            'server_id' => $server->id,
+            'is_active' => !$isManualRun,
+            'is_processing' => true,
+            'last_run_at' => null,
+        ]);
+        /** @var \Pterodactyl\Models\Task $task */
+        $task = Task::factory()->create([
+            'schedule_id' => $schedule->id,
+            'action' => Task::ACTION_POWER,
+            'payload' => 'start',
+            'is_queued' => true,
+            'continue_on_failure' => false,
+        ]);
+
+        $mock = Mockery::mock(DaemonPowerRepository::class);
+        $this->instance(DaemonPowerRepository::class, $mock);
+
+        $mock->expects('setServer')->with(Mockery::on(function ($value) use ($server) {
+            return $value instanceof Server && $value->id === $server->id;
+        }))->andReturnSelf();
+        $mock->expects('send')->with('start')->andReturn(new Response());
+
+        Bus::dispatchNow(new RunTaskJob($task, $isManualRun));
+
+        $task->refresh();
+        $schedule->refresh();
+
+        $this->assertFalse($task->is_queued);
+        $this->assertFalse($schedule->is_processing);
+        $this->assertTrue(CarbonImmutable::now()->isSameAs(CarbonImmutable::ISO8601, $schedule->last_run_at));
+    }
+
+    /**
+     * @dataProvider isManualRunDataProvider
+     */
+    public function testExceptionDuringRunIsHandledCorrectly(bool $continueOnFailure)
+    {
+        $server = $this->createServerModel();
+
+        /** @var \Pterodactyl\Models\Schedule $schedule */
+        $schedule = Schedule::factory()->create(['server_id' => $server->id]);
+        /** @var \Pterodactyl\Models\Task $task */
+        $task = Task::factory()->create([
+            'schedule_id' => $schedule->id,
+            'action' => Task::ACTION_POWER,
+            'payload' => 'start',
+            'continue_on_failure' => $continueOnFailure,
+        ]);
+
+        $mock = Mockery::mock(DaemonPowerRepository::class);
+        $this->instance(DaemonPowerRepository::class, $mock);
+
+        $mock->expects('setServer->send')->andThrow(
+            new DaemonConnectionException(new BadResponseException('Bad request', new Request('GET', '/test'), new Response()))
+        );
+
+        if (!$continueOnFailure) {
+            $this->expectException(DaemonConnectionException::class);
+        }
+
+        Bus::dispatchNow(new RunTaskJob($task));
+
+        if ($continueOnFailure) {
+            $task->refresh();
+            $schedule->refresh();
+
+            $this->assertFalse($task->is_queued);
+            $this->assertFalse($schedule->is_processing);
+            $this->assertTrue(CarbonImmutable::now()->isSameAs(CarbonImmutable::ISO8601, $schedule->last_run_at));
+        }
+    }
+
+    /**
+     * @return array
+     */
+    public function isManualRunDataProvider()
+    {
+        return [[true], [false]];
+    }
+}

tests/Unit/Helpers/EnvironmentWriterTraitTest.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Pterodactyl\Tests\Unit\Helpers;
+
+use Pterodactyl\Tests\TestCase;
+use Pterodactyl\Traits\Commands\EnvironmentWriterTrait;
+
+class EnvironmentWriterTraitTest extends TestCase
+{
+    /**
+     * @dataProvider variableDataProvider
+     */
+    public function testVariableIsEscapedProperly($input, $expected)
+    {
+        $output = (new FooClass())->escapeEnvironmentValue($input);
+
+        $this->assertSame($expected, $output);
+    }
+
+    public function variableDataProvider(): array
+    {
+        return [
+            ['foo', 'foo'],
+            ['abc123', 'abc123'],
+            ['val"ue', '"val\"ue"'],
+            ['my test value', '"my test value"'],
+            ['mysql_p@assword', '"mysql_p@assword"'],
+            ['mysql_p#assword', '"mysql_p#assword"'],
+            ['mysql p@$$word', '"mysql p@$$word"'],
+            ['mysql p%word', '"mysql p%word"'],
+            ['mysql p#word', '"mysql p#word"'],
+            ['abc_@#test', '"abc_@#test"'],
+            ['test 123 $$$', '"test 123 $$$"'],
+            ['#password%', '"#password%"'],
+            ['$pass ', '"$pass "'],
+        ];
+    }
+}
+
+class FooClass
+{
+    use EnvironmentWriterTrait;
+}