diff --git a/app/Contracts/Repository/DatabaseHostRepositoryInterface.php b/app/Contracts/Repository/DatabaseHostRepositoryInterface.php index 25a6ebf29..3abd9be8c 100644 --- a/app/Contracts/Repository/DatabaseHostRepositoryInterface.php +++ b/app/Contracts/Repository/DatabaseHostRepositoryInterface.php @@ -33,6 +33,16 @@ interface DatabaseHostRepositoryInterface extends RepositoryInterface */ 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. * diff --git a/app/Http/Controllers/Admin/DatabaseController.php b/app/Http/Controllers/Admin/DatabaseController.php index bfea288d9..7964d38c9 100644 --- a/app/Http/Controllers/Admin/DatabaseController.php +++ b/app/Http/Controllers/Admin/DatabaseController.php @@ -90,16 +90,16 @@ class DatabaseController extends Controller /** * Display database host to user. * - * @param \Pterodactyl\Models\DatabaseHost $host + * @param int $host * @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', [ 'locations' => $this->locationRepository->getAllWithNodes(), - 'host' => $host, + 'host' => $this->repository->getWithServers($host), ]); } diff --git a/app/Repositories/Eloquent/DatabaseHostRepository.php b/app/Repositories/Eloquent/DatabaseHostRepository.php index 166fd8815..5aff26740 100644 --- a/app/Repositories/Eloquent/DatabaseHostRepository.php +++ b/app/Repositories/Eloquent/DatabaseHostRepository.php @@ -24,6 +24,7 @@ namespace Pterodactyl\Repositories\Eloquent; +use Webmozart\Assert\Assert; use Pterodactyl\Models\DatabaseHost; use Pterodactyl\Exceptions\DisplayException; use Pterodactyl\Exceptions\Repository\RecordNotFoundException; @@ -47,13 +48,26 @@ class DatabaseHostRepository extends EloquentRepository implements DatabaseHostR 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} */ 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) { throw new RecordNotFoundException(); } diff --git a/tests/Assertions/ControllerAssertionsTrait.php b/tests/Assertions/ControllerAssertionsTrait.php new file mode 100644 index 000000000..5e04512d1 --- /dev/null +++ b/tests/Assertions/ControllerAssertionsTrait.php @@ -0,0 +1,86 @@ +. + * + * 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)); + } +} diff --git a/tests/Unit/Http/Controllers/Admin/DatabaseControllerTest.php b/tests/Unit/Http/Controllers/Admin/DatabaseControllerTest.php new file mode 100644 index 000000000..d930b2fff --- /dev/null +++ b/tests/Unit/Http/Controllers/Admin/DatabaseControllerTest.php @@ -0,0 +1,115 @@ +. + * + * 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); + } +}