1
1
mirror of https://github.com/pterodactyl/panel.git synced 2024-10-27 12:22:28 +01:00

Initial implementation of controller unit tests.

This commit is contained in:
Dane Everitt 2017-08-15 23:16:00 -05:00
parent 90bbe57148
commit 1260a8384a
No known key found for this signature in database
GPG Key ID: EEA66103B3D71F53
5 changed files with 231 additions and 6 deletions

View File

@ -33,6 +33,16 @@ interface DatabaseHostRepositoryInterface extends RepositoryInterface
*/ */
public function getWithViewDetails(); public function getWithViewDetails();
/**
* Return a database host with the databases and associated servers that are attached to said databases.
*
* @param int $id
* @return mixed
*
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
*/
public function getWithServers($id);
/** /**
* Delete a database host from the DB if there are no databases using it. * Delete a database host from the DB if there are no databases using it.
* *

View File

@ -90,16 +90,16 @@ class DatabaseController extends Controller
/** /**
* Display database host to user. * Display database host to user.
* *
* @param \Pterodactyl\Models\DatabaseHost $host * @param int $host
* @return \Illuminate\View\View * @return \Illuminate\View\View
*
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
*/ */
public function view(DatabaseHost $host) public function view($host)
{ {
$host->load('databases.server');
return view('admin.databases.view', [ return view('admin.databases.view', [
'locations' => $this->locationRepository->getAllWithNodes(), 'locations' => $this->locationRepository->getAllWithNodes(),
'host' => $host, 'host' => $this->repository->getWithServers($host),
]); ]);
} }

View File

@ -24,6 +24,7 @@
namespace Pterodactyl\Repositories\Eloquent; namespace Pterodactyl\Repositories\Eloquent;
use Webmozart\Assert\Assert;
use Pterodactyl\Models\DatabaseHost; use Pterodactyl\Models\DatabaseHost;
use Pterodactyl\Exceptions\DisplayException; use Pterodactyl\Exceptions\DisplayException;
use Pterodactyl\Exceptions\Repository\RecordNotFoundException; use Pterodactyl\Exceptions\Repository\RecordNotFoundException;
@ -47,13 +48,26 @@ class DatabaseHostRepository extends EloquentRepository implements DatabaseHostR
return $this->getBuilder()->withCount('databases')->with('node')->get(); return $this->getBuilder()->withCount('databases')->with('node')->get();
} }
public function getWithServers($id)
{
Assert::numeric($id, 'First argument passed to getWithServers must be numeric, recieved %s.');
$instance = $this->getBuilder()->with('databases.server')->find($id, $this->getColumns());
if (! $instance) {
throw new RecordNotFoundException();
}
return $instance;
}
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
public function deleteIfNoDatabases($id) public function deleteIfNoDatabases($id)
{ {
$instance = $this->getBuilder()->withCount('databases')->find($id); Assert::numeric($id, 'First argument passed to deleteIfNoDatabases must be numeric, recieved %s.');
$instance = $this->getBuilder()->withCount('databases')->find($id);
if (! $instance) { if (! $instance) {
throw new RecordNotFoundException(); throw new RecordNotFoundException();
} }

View File

@ -0,0 +1,86 @@
<?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\Assertions;
use PHPUnit_Framework_Assert;
trait ControllerAssertionsTrait
{
/**
* Assert that a view name equals the passed name.
*
* @param string $name
* @param \Illuminate\View\View $view
*/
public function assertViewNameEquals($name, $view)
{
PHPUnit_Framework_Assert::assertEquals($name, $view->getName());
}
/**
* Assert that a view name does not equal a provided name.
*
* @param string $name
* @param \Illuminate\View\View $view
*/
public function assertViewNameNotEquals($name, $view)
{
PHPUnit_Framework_Assert::assertNotEquals($name, $view->getName());
}
/**
* Assert that a view has an attribute passed into it.
*
* @param string $attribute
* @param \Illuminate\View\View $view
*/
public function assertViewHasKey($attribute, $view)
{
PHPUnit_Framework_Assert::assertArrayHasKey($attribute, $view->getData());
}
/**
* Assert that a view does not have a specific attribute passed in.
*
* @param string $attribute
* @param \Illuminate\View\View $view
*/
public function assertViewNotHasKey($attribute, $view)
{
PHPUnit_Framework_Assert::assertArrayNotHasKey($attribute, $view->getData());
}
/**
* Assert that a view attribute equals a given parameter.
*
* @param string $attribute
* @param mixed $value
* @param \Illuminate\View\View $view
*/
public function assertViewKeyEquals($attribute, $value, $view)
{
PHPUnit_Framework_Assert::assertEquals($value, array_get($view->getData(), $attribute));
}
}

View File

@ -0,0 +1,115 @@
<?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\Http\Controllers\Admin;
use Mockery as m;
use Prologue\Alerts\AlertsMessageBag;
use Pterodactyl\Contracts\Repository\DatabaseHostRepositoryInterface;
use Pterodactyl\Contracts\Repository\LocationRepositoryInterface;
use Pterodactyl\Http\Controllers\Admin\DatabaseController;
use Pterodactyl\Services\Database\DatabaseHostService;
use Tests\Assertions\ControllerAssertionsTrait;
use Tests\TestCase;
class DatabaseControllerTest extends TestCase
{
use ControllerAssertionsTrait;
/**
* @var \Prologue\Alerts\AlertsMessageBag
*/
protected $alert;
/**
* @var \Pterodactyl\Http\Controllers\Admin\DatabaseController
*/
protected $controller;
/**
* @var \Pterodactyl\Contracts\Repository\LocationRepositoryInterface
*/
protected $locationRepository;
/**
* @var \Pterodactyl\Contracts\Repository\DatabaseHostRepositoryInterface
*/
protected $repository;
/**
* @var \Pterodactyl\Services\Database\DatabaseHostService
*/
protected $service;
/**
* Setup tests.
*/
public function setUp()
{
parent::setUp();
$this->alert = m::mock(AlertsMessageBag::class);
$this->locationRepository = m::mock(LocationRepositoryInterface::class);
$this->repository = m::mock(DatabaseHostRepositoryInterface::class);
$this->service = m::mock(DatabaseHostService::class);
$this->controller = new DatabaseController(
$this->alert,
$this->repository,
$this->service,
$this->locationRepository
);
}
/**
* Test the index controller.
*/
public function testIndexController()
{
$this->locationRepository->shouldReceive('getAllWithNodes')->withNoArgs()->once()->andReturn('getAllWithNodes');
$this->repository->shouldReceive('getWithViewDetails')->withNoArgs()->once()->andReturn('getWithViewDetails');
$view = $this->controller->index();
$this->assertViewNameEquals('admin.databases.index', $view);
$this->assertViewHasKey('locations', $view);
$this->assertViewHasKey('hosts', $view);
$this->assertViewKeyEquals('locations', 'getAllWithNodes', $view);
$this->assertViewKeyEquals('hosts', 'getWithViewDetails', $view);
}
public function testViewController()
{
$this->locationRepository->shouldReceive('getAllWithNodes')->withNoArgs()->once()->andReturn('getAllWithNodes');
$this->repository->shouldReceive('getWithServers')->with(1)->once()->andReturn('getWithServers');
$view = $this->controller->view(1);
$this->assertViewNameEquals('admin.databases.view', $view);
$this->assertViewHasKey('locations', $view);
$this->assertViewHasKey('host', $view);
$this->assertViewKeyEquals('locations', 'getAllWithNodes', $view);
$this->assertViewKeyEquals('host', 'getWithServers', $view);
}
}