134 lines
4.3 KiB
PHP
134 lines
4.3 KiB
PHP
<?php
|
|
|
|
namespace Pterodactyl\Tests\Integration\Api\Client;
|
|
|
|
use ReflectionClass;
|
|
use Pterodactyl\Models\Node;
|
|
use Pterodactyl\Models\Task;
|
|
use Pterodactyl\Models\User;
|
|
use Webmozart\Assert\Assert;
|
|
use Pterodactyl\Models\Backup;
|
|
use Pterodactyl\Models\Server;
|
|
use Pterodactyl\Models\Subuser;
|
|
use Pterodactyl\Models\Database;
|
|
use Pterodactyl\Models\Location;
|
|
use Pterodactyl\Models\Schedule;
|
|
use Illuminate\Support\Collection;
|
|
use Pterodactyl\Models\Allocation;
|
|
use Pterodactyl\Models\DatabaseHost;
|
|
use Pterodactyl\Tests\Integration\TestResponse;
|
|
use Pterodactyl\Tests\Integration\IntegrationTestCase;
|
|
use Pterodactyl\Transformers\Api\Client\BaseClientTransformer;
|
|
|
|
abstract class ClientApiIntegrationTestCase extends IntegrationTestCase
|
|
{
|
|
/**
|
|
* Cleanup after running tests.
|
|
*/
|
|
protected function tearDown(): void
|
|
{
|
|
Database::query()->forceDelete();
|
|
DatabaseHost::query()->forceDelete();
|
|
Backup::query()->forceDelete();
|
|
Server::query()->forceDelete();
|
|
Node::query()->forceDelete();
|
|
Location::query()->forceDelete();
|
|
User::query()->forceDelete();
|
|
|
|
parent::tearDown();
|
|
}
|
|
|
|
/**
|
|
* Override the default createTestResponse from Illuminate so that we can
|
|
* just dump 500-level errors to the screen in the tests without having
|
|
* to keep re-assigning variables.
|
|
*
|
|
* @param \Illuminate\Http\Response $response
|
|
* @return \Illuminate\Testing\TestResponse
|
|
*/
|
|
protected function createTestResponse($response)
|
|
{
|
|
return TestResponse::fromBaseResponse($response);
|
|
}
|
|
|
|
/**
|
|
* Returns a link to the specific resource using the client API.
|
|
*
|
|
* @param mixed $model
|
|
* @param string|null $append
|
|
*
|
|
* @return string
|
|
*/
|
|
protected function link($model, $append = null): string
|
|
{
|
|
Assert::isInstanceOfAny($model, [Server::class, Schedule::class, Task::class, Allocation::class]);
|
|
|
|
$link = '';
|
|
switch (get_class($model)) {
|
|
case Server::class:
|
|
$link = "/api/client/servers/{$model->uuid}";
|
|
break;
|
|
case Schedule::class:
|
|
$link = "/api/client/servers/{$model->server->uuid}/schedules/{$model->id}";
|
|
break;
|
|
case Task::class:
|
|
$link = "/api/client/servers/{$model->schedule->server->uuid}/schedules/{$model->schedule->id}/tasks/{$model->id}";
|
|
break;
|
|
case Allocation::class:
|
|
$link = "/api/client/servers/{$model->server->uuid}/network/allocations/{$model->id}";
|
|
break;
|
|
}
|
|
|
|
return $link . ($append ? '/' . ltrim($append, '/') : '');
|
|
}
|
|
|
|
/**
|
|
* Generates a user and a server for that user. If an array of permissions is passed it
|
|
* is assumed that the user is actually a subuser of the server.
|
|
*
|
|
* @param string[] $permissions
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function generateTestAccount(array $permissions = []): array
|
|
{
|
|
/** @var \Pterodactyl\Models\User $user */
|
|
$user = User::factory()->create();
|
|
|
|
if (empty($permissions)) {
|
|
return [$user, $this->createServerModel(['user_id' => $user->id])];
|
|
}
|
|
|
|
/** @var \Pterodactyl\Models\Server $server */
|
|
$server = $this->createServerModel();
|
|
|
|
Subuser::query()->create([
|
|
'user_id' => $user->id,
|
|
'server_id' => $server->id,
|
|
'permissions' => $permissions,
|
|
]);
|
|
|
|
return [$user, $server];
|
|
}
|
|
|
|
/**
|
|
* Asserts that the data passed through matches the output of the data from the transformer. This
|
|
* will remove the "relationships" key when performing the comparison.
|
|
*
|
|
* @param array $data
|
|
* @param \Pterodactyl\Models\Model|\Illuminate\Database\Eloquent\Model $model
|
|
*/
|
|
protected function assertJsonTransformedWith(array $data, $model)
|
|
{
|
|
$reflect = new ReflectionClass($model);
|
|
$transformer = sprintf('\\Pterodactyl\\Transformers\\Api\\Client\\%sTransformer', $reflect->getShortName());
|
|
|
|
$transformer = new $transformer;
|
|
$this->assertInstanceOf(BaseClientTransformer::class, $transformer);
|
|
|
|
$this->assertSame(
|
|
$transformer->transform($model),
|
|
Collection::make($data)->except(['relationships'])->toArray()
|
|
);
|
|
}
|
|
}
|