Push subuser creation service
This commit is contained in:
Dane Everitt
parent
2a5570877c
commit
74ea1aa0aa
23 changed files with 1077 additions and 229 deletions
183
tests/Unit/Services/Helpers/SoftwareVersionServiceTest.php
Normal file
183
tests/Unit/Services/Helpers/SoftwareVersionServiceTest.php
Normal file
|
|
@ -0,0 +1,183 @@
|
|||
<?php
|
||||
/**
|
||||
* Pterodactyl - Panel
|
||||
* Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
* SOFTWARE.
|
||||
*/
|
||||
|
||||
namespace Tests\Unit\Services\Helpers;
|
||||
|
||||
use Closure;
|
||||
use GuzzleHttp\Client;
|
||||
use Mockery as m;
|
||||
use Pterodactyl\Services\Helpers\SoftwareVersionService;
|
||||
use Tests\TestCase;
|
||||
use Illuminate\Contracts\Cache\Repository as CacheRepository;
|
||||
use Illuminate\Contracts\Config\Repository as ConfigRepository;
|
||||
|
||||
class SoftwareVersionServiceTest extends TestCase
|
||||
{
|
||||
/**
|
||||
* @var \Illuminate\Contracts\Cache\Repository
|
||||
*/
|
||||
protected $cache;
|
||||
|
||||
/**
|
||||
* @var \GuzzleHttp\Client
|
||||
*/
|
||||
protected $client;
|
||||
|
||||
/**
|
||||
* @var \Illuminate\Contracts\Config\Repository
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* @var object
|
||||
*/
|
||||
protected static $response = [
|
||||
'panel' => '0.2.0',
|
||||
'daemon' => '0.1.0',
|
||||
'discord' => 'https://pterodactyl.io/discord',
|
||||
];
|
||||
|
||||
/**
|
||||
* @var \Pterodactyl\Services\Helpers\SoftwareVersionService
|
||||
*/
|
||||
protected $service;
|
||||
|
||||
/**
|
||||
* Setup tests
|
||||
*/
|
||||
public function setUp()
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
self::$response = (object) self::$response;
|
||||
|
||||
$this->cache = m::mock(CacheRepository::class);
|
||||
$this->client = m::mock(Client::class);
|
||||
$this->config = m::mock(ConfigRepository::class);
|
||||
|
||||
$this->config->shouldReceive('get')->with('pterodactyl.cdn.cache_time')->once()->andReturn(60);
|
||||
|
||||
$this->cache->shouldReceive('remember')->with(SoftwareVersionService::VERSION_CACHE_KEY, 60, Closure::class)->once()->andReturnNull();
|
||||
|
||||
$this->service = m::mock(SoftwareVersionService::class, [$this->cache, $this->client, $this->config])->makePartial();
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that the panel version is returned.
|
||||
*/
|
||||
public function testPanelVersionIsReturned()
|
||||
{
|
||||
$this->cache->shouldReceive('get')->with(SoftwareVersionService::VERSION_CACHE_KEY)->once()->andReturn(self::$response);
|
||||
$this->assertEquals(self::$response->panel, $this->service->getPanel());
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that the panel version is returned as error.
|
||||
*/
|
||||
public function testPanelVersionIsReturnedAsErrorIfNoKeyIsFound()
|
||||
{
|
||||
$this->cache->shouldReceive('get')->with(SoftwareVersionService::VERSION_CACHE_KEY)->once()->andReturn((object) []);
|
||||
$this->assertEquals('error', $this->service->getPanel());
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that the daemon version is returned.
|
||||
*/
|
||||
public function testDaemonVersionIsReturned()
|
||||
{
|
||||
$this->cache->shouldReceive('get')->with(SoftwareVersionService::VERSION_CACHE_KEY)->once()->andReturn(self::$response);
|
||||
$this->assertEquals(self::$response->daemon, $this->service->getDaemon());
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that the daemon version is returned as an error.
|
||||
*/
|
||||
public function testDaemonVersionIsReturnedAsErrorIfNoKeyIsFound()
|
||||
{
|
||||
$this->cache->shouldReceive('get')->with(SoftwareVersionService::VERSION_CACHE_KEY)->once()->andReturn((object) []);
|
||||
$this->assertEquals('error', $this->service->getDaemon());
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that the discord URL is returned.
|
||||
*/
|
||||
public function testDiscordUrlIsReturned()
|
||||
{
|
||||
$this->cache->shouldReceive('get')->with(SoftwareVersionService::VERSION_CACHE_KEY)->once()->andReturn(self::$response);
|
||||
$this->assertEquals(self::$response->discord, $this->service->getDiscord());
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that the correct boolean value is returned by the helper for each version passed.
|
||||
*
|
||||
* @dataProvider panelVersionProvider
|
||||
*/
|
||||
public function testCorrectBooleanValueIsReturnedWhenCheckingPanelVersion($version, $response)
|
||||
{
|
||||
$this->config->shouldReceive('get')->with('app.version')->andReturn($version);
|
||||
$this->service->shouldReceive('getPanel')->withNoArgs()->andReturn(self::$response->panel);
|
||||
|
||||
$this->assertEquals($response, $this->service->isLatestPanel());
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that the correct boolean value is returned.
|
||||
*
|
||||
* @dataProvider daemonVersionProvider
|
||||
*/
|
||||
public function testCorrectBooleanValueIsReturnedWhenCheckingDaemonVersion($version, $response)
|
||||
{
|
||||
$this->service->shouldReceive('getDaemon')->withNoArgs()->andReturn(self::$response->daemon);
|
||||
|
||||
$this->assertEquals($response, $this->service->isLatestDaemon($version));
|
||||
}
|
||||
|
||||
/**
|
||||
* Provide data for testing boolean response on panel version.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function panelVersionProvider()
|
||||
{
|
||||
return [
|
||||
[self::$response['panel'], true],
|
||||
['0.0.1', false],
|
||||
['canary', true],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Provide data for testing booklean response for daemon version.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function daemonVersionProvider()
|
||||
{
|
||||
return [
|
||||
[self::$response['daemon'], true],
|
||||
['0.0.1', false],
|
||||
['0.0.0-canary', true],
|
||||
];
|
||||
}
|
||||
}
|
||||
260
tests/Unit/Services/Subusers/SubuserCreationServiceTest.php
Normal file
260
tests/Unit/Services/Subusers/SubuserCreationServiceTest.php
Normal file
|
|
@ -0,0 +1,260 @@
|
|||
<?php
|
||||
/**
|
||||
* Pterodactyl - Panel
|
||||
* Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
* SOFTWARE.
|
||||
*/
|
||||
|
||||
namespace Tests\Unit\Services\Subusers;
|
||||
|
||||
use Illuminate\Database\ConnectionInterface;
|
||||
use Illuminate\Log\Writer;
|
||||
use Mockery as m;
|
||||
use phpmock\phpunit\PHPMock;
|
||||
use Pterodactyl\Contracts\Repository\ServerRepositoryInterface;
|
||||
use Pterodactyl\Contracts\Repository\PermissionRepositoryInterface;
|
||||
use Pterodactyl\Contracts\Repository\SubuserRepositoryInterface;
|
||||
use Pterodactyl\Contracts\Repository\UserRepositoryInterface;
|
||||
use Pterodactyl\Exceptions\DisplayException;
|
||||
use Pterodactyl\Exceptions\Service\Subuser\ServerSubuserExistsException;
|
||||
use Pterodactyl\Exceptions\Service\Subuser\UserIsServerOwnerException;
|
||||
use Pterodactyl\Models\Server;
|
||||
use Pterodactyl\Models\Subuser;
|
||||
use Pterodactyl\Models\User;
|
||||
use Pterodactyl\Services\Subusers\SubuserCreationService;
|
||||
use Pterodactyl\Services\Users\CreationService;
|
||||
use Tests\TestCase;
|
||||
use Pterodactyl\Contracts\Repository\Daemon\ServerRepositoryInterface as DaemonServerRepositoryInterface;
|
||||
|
||||
class SubuserCreationServiceTest extends TestCase
|
||||
{
|
||||
use PHPMock;
|
||||
|
||||
/**
|
||||
* @var \Illuminate\Database\ConnectionInterface
|
||||
*/
|
||||
protected $connection;
|
||||
|
||||
/**
|
||||
* @var \Pterodactyl\Contracts\Repository\Daemon\ServerRepositoryInterface
|
||||
*/
|
||||
protected $daemonRepository;
|
||||
|
||||
/**
|
||||
* @var \Pterodactyl\Models\Permission
|
||||
*/
|
||||
protected $permission;
|
||||
|
||||
/**
|
||||
* @var \Pterodactyl\Contracts\Repository\PermissionRepositoryInterface
|
||||
*/
|
||||
protected $permissionRepository;
|
||||
|
||||
/**
|
||||
* @var \Pterodactyl\Contracts\Repository\SubuserRepositoryInterface
|
||||
*/
|
||||
protected $subuserRepository;
|
||||
|
||||
/**
|
||||
* @var \Pterodactyl\Contracts\Repository\ServerRepositoryInterface
|
||||
*/
|
||||
protected $serverRepository;
|
||||
|
||||
/**
|
||||
* @var \Pterodactyl\Services\Subusers\SubuserCreationService
|
||||
*/
|
||||
protected $service;
|
||||
|
||||
/**
|
||||
* @var \Pterodactyl\Services\Users\CreationService
|
||||
*/
|
||||
protected $userCreationService;
|
||||
|
||||
/**
|
||||
* @var \Pterodactyl\Contracts\Repository\UserRepositoryInterface
|
||||
*/
|
||||
protected $userRepository;
|
||||
|
||||
/**
|
||||
* @var \Illuminate\Log\Writer
|
||||
*/
|
||||
protected $writer;
|
||||
|
||||
/**
|
||||
* Setup tests.
|
||||
*/
|
||||
public function setUp()
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
$this->getFunctionMock('\\Pterodactyl\\Services\\Subusers', 'bin2hex')->expects($this->any())->willReturn('bin2hex');
|
||||
|
||||
$this->connection = m::mock(ConnectionInterface::class);
|
||||
$this->daemonRepository = m::mock(DaemonServerRepositoryInterface::class);
|
||||
$this->permission = m::mock('overload:Pterodactyl\Models\Permission');
|
||||
$this->permissionRepository = m::mock(PermissionRepositoryInterface::class);
|
||||
$this->subuserRepository = m::mock(SubuserRepositoryInterface::class);
|
||||
$this->serverRepository = m::mock(ServerRepositoryInterface::class);
|
||||
$this->userCreationService = m::mock(CreationService::class);
|
||||
$this->userRepository = m::mock(UserRepositoryInterface::class);
|
||||
$this->writer = m::mock(Writer::class);
|
||||
|
||||
$this->service = new SubuserCreationService(
|
||||
$this->connection,
|
||||
$this->userCreationService,
|
||||
$this->daemonRepository,
|
||||
$this->permissionRepository,
|
||||
$this->serverRepository,
|
||||
$this->subuserRepository,
|
||||
$this->userRepository,
|
||||
$this->writer
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that a user without an existing account can be added as a subuser.
|
||||
*/
|
||||
public function testAccountIsCreatedForNewUser()
|
||||
{
|
||||
$permissions = ['test-1' => 'test:1', 'test-2' => null];
|
||||
$server = factory(Server::class)->make();
|
||||
$user = factory(User::class)->make();
|
||||
$subuser = factory(Subuser::class)->make(['user_id' => $user->id, 'server_id' => $server->id]);
|
||||
|
||||
$this->userRepository->shouldReceive('findWhere')->with([['email', '=', $user->email]])->once()->andReturnNull();
|
||||
$this->userCreationService->shouldReceive('handle')->with([
|
||||
'email' => $user->email,
|
||||
'username' => substr(strtok($user->email, '@'), 0, 8),
|
||||
'name_first' => 'Server',
|
||||
'name_last' => 'Subuser',
|
||||
'root_admin' => false,
|
||||
])->once()->andReturn($user);
|
||||
|
||||
$this->connection->shouldReceive('beginTransaction')->withNoArgs()->once()->andReturnNull();
|
||||
$this->subuserRepository->shouldReceive('create')->with([
|
||||
'user_id' => $user->id,
|
||||
'server_id' => $server->id,
|
||||
'daemonSecret' => 'bin2hex',
|
||||
])->once()->andReturn($subuser);
|
||||
|
||||
$this->permission->shouldReceive('getPermissions')->with(true)->once()
|
||||
->andReturn($permissions);
|
||||
|
||||
foreach(array_keys($permissions) as $permission) {
|
||||
$this->permissionRepository->shouldReceive('create')
|
||||
->with(['subuser_id' => $subuser->id, 'permission' => $permission])
|
||||
->once()->andReturnNull();
|
||||
}
|
||||
|
||||
$this->daemonRepository->shouldReceive('setNode')->with($server->node_id)->once()->andReturnSelf()
|
||||
->shouldReceive('setAccessServer')->with($server->uuid)->once()->andReturnSelf()
|
||||
->shouldReceive('setSubuserKey')->with($subuser->daemonSecret, ['s:get', 's:console', 'test:1'])->once()->andReturnSelf();
|
||||
$this->connection->shouldReceive('commit')->withNoArgs()->once()->andReturnNull();
|
||||
|
||||
$response = $this->service->handle($server, $user->email, array_keys($permissions));
|
||||
|
||||
$this->assertInstanceOf(Subuser::class, $response);
|
||||
$this->assertSame($subuser, $response);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that an existing user can be added as a subuser.
|
||||
*/
|
||||
public function testExistingUserCanBeAddedAsASubuser()
|
||||
{
|
||||
$permissions = ['test-1' => 'test:1', 'test-2' => null];
|
||||
$server = factory(Server::class)->make();
|
||||
$user = factory(User::class)->make();
|
||||
$subuser = factory(Subuser::class)->make(['user_id' => $user->id, 'server_id' => $server->id]);
|
||||
|
||||
$this->userRepository->shouldReceive('findWhere')->with([['email', '=', $user->email]])->once()->andReturn($user);
|
||||
$this->subuserRepository->shouldReceive('findCountWhere')->with([
|
||||
['user_id', '=', $user->id],
|
||||
['server_id', '=', $server->id],
|
||||
])->once()->andReturn(0);
|
||||
|
||||
$this->connection->shouldReceive('beginTransaction')->withNoArgs()->once()->andReturnNull();
|
||||
$this->subuserRepository->shouldReceive('create')->with([
|
||||
'user_id' => $user->id,
|
||||
'server_id' => $server->id,
|
||||
'daemonSecret' => 'bin2hex',
|
||||
])->once()->andReturn($subuser);
|
||||
|
||||
$this->permission->shouldReceive('getPermissions')->with(true)->once()
|
||||
->andReturn($permissions);
|
||||
|
||||
foreach(array_keys($permissions) as $permission) {
|
||||
$this->permissionRepository->shouldReceive('create')
|
||||
->with(['subuser_id' => $subuser->id, 'permission' => $permission])
|
||||
->once()->andReturnNull();
|
||||
}
|
||||
|
||||
$this->daemonRepository->shouldReceive('setNode')->with($server->node_id)->once()->andReturnSelf()
|
||||
->shouldReceive('setAccessServer')->with($server->uuid)->once()->andReturnSelf()
|
||||
->shouldReceive('setSubuserKey')->with($subuser->daemonSecret, ['s:get', 's:console', 'test:1'])->once()->andReturnSelf();
|
||||
$this->connection->shouldReceive('commit')->withNoArgs()->once()->andReturnNull();
|
||||
|
||||
$response = $this->service->handle($server, $user->email, array_keys($permissions));
|
||||
|
||||
$this->assertInstanceOf(Subuser::class, $response);
|
||||
$this->assertSame($subuser, $response);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that an exception gets thrown if the subuser is actually the server owner
|
||||
*/
|
||||
public function testExceptionIsThrownIfUserIsServerOwner()
|
||||
{
|
||||
$user = factory(User::class)->make();
|
||||
$server = factory(Server::class)->make(['owner_id' => $user->id]);
|
||||
|
||||
$this->userRepository->shouldReceive('findWhere')->with([['email', '=', $user->email]])->once()->andReturn($user);
|
||||
|
||||
try {
|
||||
$this->service->handle($server, $user->email, []);
|
||||
} catch (DisplayException $exception) {
|
||||
$this->assertInstanceOf(UserIsServerOwnerException::class, $exception);
|
||||
$this->assertEquals(trans('admin/exceptions.subusers.user_is_owner'), $exception->getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that an exception is thrown if the user is already added as a subuser.
|
||||
*/
|
||||
public function testExceptionIsThrownIfUserIsAlreadyASubuser()
|
||||
{
|
||||
$user = factory(User::class)->make();
|
||||
$server = factory(Server::class)->make();
|
||||
|
||||
$this->userRepository->shouldReceive('findWhere')->with([['email', '=', $user->email]])->once()->andReturn($user);
|
||||
$this->subuserRepository->shouldReceive('findCountWhere')->with([
|
||||
['user_id', '=', $user->id],
|
||||
['server_id', '=', $server->id],
|
||||
])->once()->andReturn(1);
|
||||
|
||||
try {
|
||||
$this->service->handle($server, $user->email, []);
|
||||
} catch (DisplayException $exception) {
|
||||
$this->assertInstanceOf(ServerSubuserExistsException::class, $exception);
|
||||
$this->assertEquals(trans('admin/exceptions.subusers.subuser_exists'), $exception->getMessage());
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue