Add server details modification endpoint to API.
This commit is contained in:
Dane Everitt
parent
3e327b8b0e
commit
17f6f3eeb6
7 changed files with 160 additions and 267 deletions
|
|
@ -1,71 +1,37 @@
|
|||
<?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\Services\Servers;
|
||||
|
||||
use Exception;
|
||||
use Mockery as m;
|
||||
use Tests\TestCase;
|
||||
use Illuminate\Log\Writer;
|
||||
use GuzzleHttp\Psr7\Response;
|
||||
use Pterodactyl\Models\Server;
|
||||
use GuzzleHttp\Exception\RequestException;
|
||||
use Illuminate\Database\ConnectionInterface;
|
||||
use Pterodactyl\Exceptions\DisplayException;
|
||||
use Pterodactyl\Exceptions\PterodactylException;
|
||||
use Pterodactyl\Repositories\Eloquent\ServerRepository;
|
||||
use Pterodactyl\Services\Servers\DetailsModificationService;
|
||||
use Pterodactyl\Services\DaemonKeys\DaemonKeyCreationService;
|
||||
use Pterodactyl\Services\DaemonKeys\DaemonKeyDeletionService;
|
||||
use Pterodactyl\Repositories\Daemon\ServerRepository as DaemonServerRepository;
|
||||
|
||||
class DetailsModificationServiceTest extends TestCase
|
||||
{
|
||||
/**
|
||||
* @var \Illuminate\Database\ConnectionInterface|\Mockery\Mock
|
||||
*/
|
||||
protected $connection;
|
||||
|
||||
/**
|
||||
* @var \Pterodactyl\Repositories\Daemon\ServerRepository|\Mockery\Mock
|
||||
*/
|
||||
protected $daemonServerRepository;
|
||||
|
||||
/**
|
||||
* @var \GuzzleHttp\Exception\RequestException|\Mockery\Mock
|
||||
*/
|
||||
protected $exception;
|
||||
private $connection;
|
||||
|
||||
/**
|
||||
* @var \Pterodactyl\Services\DaemonKeys\DaemonKeyCreationService|\Mockery\Mock
|
||||
*/
|
||||
protected $keyCreationService;
|
||||
private $keyCreationService;
|
||||
|
||||
/**
|
||||
* @var \Pterodactyl\Services\DaemonKeys\DaemonKeyDeletionService|\Mockery\Mock
|
||||
*/
|
||||
protected $keyDeletionService;
|
||||
private $keyDeletionService;
|
||||
|
||||
/**
|
||||
* @var \Pterodactyl\Repositories\Eloquent\ServerRepository|\Mockery\Mock
|
||||
*/
|
||||
protected $repository;
|
||||
|
||||
/**
|
||||
* @var \Pterodactyl\Services\Servers\DetailsModificationService
|
||||
*/
|
||||
protected $service;
|
||||
|
||||
/**
|
||||
* @var \Illuminate\Log\Writer|\Mockery\Mock
|
||||
*/
|
||||
protected $writer;
|
||||
private $repository;
|
||||
|
||||
/**
|
||||
* Setup tests.
|
||||
|
|
@ -75,72 +41,49 @@ class DetailsModificationServiceTest extends TestCase
|
|||
parent::setUp();
|
||||
|
||||
$this->connection = m::mock(ConnectionInterface::class);
|
||||
$this->exception = m::mock(RequestException::class)->makePartial();
|
||||
$this->daemonServerRepository = m::mock(DaemonServerRepository::class);
|
||||
$this->keyCreationService = m::mock(DaemonKeyCreationService::class);
|
||||
$this->keyDeletionService = m::mock(DaemonKeyDeletionService::class);
|
||||
$this->repository = m::mock(ServerRepository::class);
|
||||
$this->writer = m::mock(Writer::class);
|
||||
|
||||
$this->service = new DetailsModificationService(
|
||||
$this->connection,
|
||||
$this->keyCreationService,
|
||||
$this->keyDeletionService,
|
||||
$this->daemonServerRepository,
|
||||
$this->repository,
|
||||
$this->writer
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test basic updating of core variables when a model is provided.
|
||||
*/
|
||||
public function testEditShouldSkipDatabaseSearchIfModelIsPassed()
|
||||
public function testDetailsAreEdited()
|
||||
{
|
||||
$server = factory(Server::class)->make([
|
||||
'owner_id' => 1,
|
||||
]);
|
||||
$server = factory(Server::class)->make(['owner_id' => 1]);
|
||||
|
||||
$data = ['owner_id' => 1, 'name' => 'New Name', 'description' => 'New Description'];
|
||||
|
||||
$this->connection->shouldReceive('beginTransaction')->withNoArgs()->once()->andReturnNull();
|
||||
$this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf()
|
||||
->shouldReceive('update')->with($server->id, [
|
||||
$this->connection->shouldReceive('beginTransaction')->once()->withNoArgs()->andReturnNull();
|
||||
$this->repository->shouldReceive('setFreshModel')->once()->with(false)->andReturnSelf();
|
||||
$this->repository->shouldReceive('update')->once()->with($server->id, [
|
||||
'owner_id' => $data['owner_id'],
|
||||
'name' => $data['name'],
|
||||
'description' => $data['description'],
|
||||
], true, true)->once()->andReturnNull();
|
||||
], true, true)->andReturn(true);
|
||||
|
||||
$this->connection->shouldReceive('commit')->withNoArgs()->once()->andReturnNull();
|
||||
$this->connection->shouldReceive('commit')->once()->withNoArgs()->andReturnNull();
|
||||
|
||||
$this->service->edit($server, $data);
|
||||
$this->assertTrue(true);
|
||||
$response = $this->getService()->handle($server, $data);
|
||||
$this->assertTrue($response);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that repository attempts to find model in database if no model is passed.
|
||||
* Test that a model is returned if requested.
|
||||
*/
|
||||
public function testEditShouldGetModelFromRepositoryIfNotPassed()
|
||||
public function testModelIsReturned()
|
||||
{
|
||||
$server = factory(Server::class)->make([
|
||||
'owner_id' => 1,
|
||||
]);
|
||||
$server = factory(Server::class)->make(['owner_id' => 1]);
|
||||
|
||||
$data = ['owner_id' => 1, 'name' => 'New Name', 'description' => 'New Description'];
|
||||
$this->connection->shouldReceive('beginTransaction')->once()->withNoArgs()->andReturnNull();
|
||||
$this->repository->shouldReceive('setFreshModel')->once()->with(true)->andReturnSelf();
|
||||
$this->repository->shouldReceive('update')->once()->andReturn($server);
|
||||
|
||||
$this->repository->shouldReceive('find')->with($server->id)->once()->andReturn($server);
|
||||
$this->connection->shouldReceive('beginTransaction')->withNoArgs()->once()->andReturnNull();
|
||||
$this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf()
|
||||
->shouldReceive('update')->with($server->id, [
|
||||
'owner_id' => $data['owner_id'],
|
||||
'name' => $data['name'],
|
||||
'description' => $data['description'],
|
||||
], true, true)->once()->andReturnNull();
|
||||
$this->connection->shouldReceive('commit')->once()->withNoArgs()->andReturnNull();
|
||||
|
||||
$this->connection->shouldReceive('commit')->withNoArgs()->once()->andReturnNull();
|
||||
|
||||
$this->service->edit($server->id, $data);
|
||||
$this->assertTrue(true);
|
||||
$response = $this->getService()->returnUpdatedModel()->handle($server, ['owner_id' => 1]);
|
||||
$this->assertInstanceOf(Server::class, $response);
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -150,128 +93,38 @@ class DetailsModificationServiceTest extends TestCase
|
|||
{
|
||||
$server = factory(Server::class)->make([
|
||||
'owner_id' => 1,
|
||||
'node_id' => 1,
|
||||
]);
|
||||
|
||||
$data = ['owner_id' => 2, 'name' => 'New Name', 'description' => 'New Description'];
|
||||
|
||||
$this->connection->shouldReceive('beginTransaction')->withNoArgs()->once()->andReturnNull();
|
||||
$this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf()
|
||||
->shouldReceive('update')->with($server->id, [
|
||||
$this->connection->shouldReceive('beginTransaction')->once()->withNoArgs()->andReturnNull();
|
||||
$this->repository->shouldReceive('setFreshModel')->once()->with(false)->andReturnSelf();
|
||||
$this->repository->shouldReceive('update')->once()->with($server->id, [
|
||||
'owner_id' => $data['owner_id'],
|
||||
'name' => $data['name'],
|
||||
'description' => $data['description'],
|
||||
], true, true)->once()->andReturnNull();
|
||||
], true, true)->andReturn(true);
|
||||
|
||||
$this->keyDeletionService->shouldReceive('handle')->with($server, $server->owner_id)->once()->andReturnNull();
|
||||
$this->keyCreationService->shouldReceive('handle')->with($server->id, $data['owner_id']);
|
||||
$this->connection->shouldReceive('commit')->withNoArgs()->once()->andReturnNull();
|
||||
$this->keyDeletionService->shouldReceive('handle')->once()->with($server, $server->owner_id)->andReturnNull();
|
||||
$this->keyCreationService->shouldReceive('handle')->once()->with($server->id, $data['owner_id'])->andReturnNull();
|
||||
$this->connection->shouldReceive('commit')->once()->withNoArgs()->andReturnNull();
|
||||
|
||||
$this->service->edit($server, $data);
|
||||
$this->assertTrue(true);
|
||||
$response = $this->getService()->handle($server, $data);
|
||||
$this->assertTrue($response);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that the docker image for a server can be updated if a model is provided.
|
||||
*/
|
||||
public function testDockerImageCanBeUpdatedWhenAServerModelIsProvided()
|
||||
{
|
||||
$server = factory(Server::class)->make(['node_id' => 1]);
|
||||
|
||||
$this->connection->shouldReceive('beginTransaction')->withNoArgs()->once()->andReturnNull();
|
||||
$this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf()
|
||||
->shouldReceive('update')->with($server->id, [
|
||||
'image' => 'new/image',
|
||||
])->once()->andReturnNull();
|
||||
|
||||
$this->daemonServerRepository->shouldReceive('setServer')->with($server)->once()->andReturnSelf()
|
||||
->shouldReceive('update')->with([
|
||||
'build' => [
|
||||
'image' => 'new/image',
|
||||
],
|
||||
])->once()->andReturn(new Response);
|
||||
|
||||
$this->connection->shouldReceive('commit')->withNoArgs()->once()->andReturnNull();
|
||||
|
||||
$this->service->setDockerImage($server, 'new/image');
|
||||
$this->assertTrue(true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that the docker image for a server can be updated if a model is provided.
|
||||
*/
|
||||
public function testDockerImageCanBeUpdatedWhenNoModelIsProvided()
|
||||
{
|
||||
$server = factory(Server::class)->make(['node_id' => 1]);
|
||||
|
||||
$this->repository->shouldReceive('find')->with($server->id)->once()->andReturn($server);
|
||||
$this->connection->shouldReceive('beginTransaction')->withNoArgs()->once()->andReturnNull();
|
||||
$this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf()
|
||||
->shouldReceive('update')->with($server->id, [
|
||||
'image' => 'new/image',
|
||||
])->once()->andReturnNull();
|
||||
|
||||
$this->daemonServerRepository->shouldReceive('setServer')->with($server)->once()->andReturnSelf()
|
||||
->shouldReceive('update')->with([
|
||||
'build' => [
|
||||
'image' => 'new/image',
|
||||
],
|
||||
])->once()->andReturn(new Response);
|
||||
|
||||
$this->connection->shouldReceive('commit')->withNoArgs()->once()->andReturnNull();
|
||||
|
||||
$this->service->setDockerImage($server->id, 'new/image');
|
||||
$this->assertTrue(true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that an exception thrown by Guzzle is rendered as a displayable exception.
|
||||
*/
|
||||
public function testExceptionThrownByGuzzleWhenSettingDockerImageShouldBeRenderedAsADisplayableException()
|
||||
{
|
||||
$server = factory(Server::class)->make(['node_id' => 1]);
|
||||
|
||||
$this->connection->shouldReceive('beginTransaction')->withNoArgs()->once()->andReturnNull();
|
||||
$this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf()
|
||||
->shouldReceive('update')->with($server->id, [
|
||||
'image' => 'new/image',
|
||||
])->once()->andReturnNull();
|
||||
|
||||
$this->daemonServerRepository->shouldReceive('setServer')->andThrow($this->exception);
|
||||
$this->connection->shouldReceive('rollBack')->withNoArgs()->once()->andReturnNull();
|
||||
$this->exception->shouldReceive('getResponse')->withNoArgs()->once()->andReturnSelf()
|
||||
->shouldReceive('getStatusCode')->withNoArgs()->once()->andReturn(400);
|
||||
|
||||
$this->writer->shouldReceive('warning')->with($this->exception)->once()->andReturnNull();
|
||||
|
||||
try {
|
||||
$this->service->setDockerImage($server, 'new/image');
|
||||
} catch (PterodactylException $exception) {
|
||||
$this->assertInstanceOf(DisplayException::class, $exception);
|
||||
$this->assertEquals(
|
||||
trans('admin/server.exceptions.daemon_exception', ['code' => 400]),
|
||||
$exception->getMessage()
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that an exception not thrown by Guzzle is not transformed to a displayable exception.
|
||||
* Return an instance of the service with mocked dependencies for testing.
|
||||
*
|
||||
* @expectedException \Exception
|
||||
* @return \Pterodactyl\Services\Servers\DetailsModificationService
|
||||
*/
|
||||
public function testExceptionNotThrownByGuzzleWhenSettingDockerImageShouldNotBeRenderedAsADisplayableException()
|
||||
private function getService(): DetailsModificationService
|
||||
{
|
||||
$server = factory(Server::class)->make(['node_id' => 1]);
|
||||
|
||||
$this->database->shouldReceive('beginTransaction')->withNoArgs()->once()->andReturnNull();
|
||||
$this->repository->shouldReceive('withoutFreshModel')->withNoArgs()->once()->andReturnSelf()
|
||||
->shouldReceive('update')->with($server->id, [
|
||||
'image' => 'new/image',
|
||||
])->once()->andReturnNull();
|
||||
|
||||
$this->daemonServerRepository->shouldReceive('setNode')->andThrow(new Exception());
|
||||
|
||||
$this->service->setDockerImage($server, 'new/image');
|
||||
return new DetailsModificationService(
|
||||
$this->connection,
|
||||
$this->keyCreationService,
|
||||
$this->keyDeletionService,
|
||||
$this->repository
|
||||
);
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue