misc_pterodactyl-panel/tests/Unit/Http/Controllers/Base/APIControllerTest.php

154 lines
5 KiB
PHP
Raw Normal View History

2017-09-02 05:21:15 +00:00
<?php
namespace Tests\Unit\Http\Controllers\Base;
use Mockery as m;
use Pterodactyl\Models\User;
2018-01-14 18:06:15 +00:00
use Pterodactyl\Models\ApiKey;
2017-09-02 05:21:15 +00:00
use Prologue\Alerts\AlertsMessageBag;
use Pterodactyl\Services\Api\KeyCreationService;
use Tests\Unit\Http\Controllers\ControllerTestCase;
2017-09-02 05:21:15 +00:00
use Pterodactyl\Http\Controllers\Base\APIController;
use Pterodactyl\Http\Requests\Base\ApiKeyFormRequest;
use Pterodactyl\Contracts\Repository\ApiKeyRepositoryInterface;
class APIControllerTest extends ControllerTestCase
2017-09-02 05:21:15 +00:00
{
/**
* @var \Prologue\Alerts\AlertsMessageBag|\Mockery\Mock
2017-09-02 05:21:15 +00:00
*/
protected $alert;
/**
* @var \Pterodactyl\Services\Api\KeyCreationService|\Mockery\Mock
2017-09-02 05:21:15 +00:00
*/
protected $keyService;
/**
* @var \Pterodactyl\Contracts\Repository\ApiKeyRepositoryInterface|\Mockery\Mock
2017-09-02 05:21:15 +00:00
*/
protected $repository;
/**
* Setup tests.
*/
public function setUp()
{
parent::setUp();
$this->alert = m::mock(AlertsMessageBag::class);
$this->keyService = m::mock(KeyCreationService::class);
$this->repository = m::mock(ApiKeyRepositoryInterface::class);
}
/**
* Test the index controller.
*/
public function testIndexController()
{
$model = $this->generateRequestUserModel();
2017-09-02 05:21:15 +00:00
$this->repository->shouldReceive('findWhere')->with([['user_id', '=', $model->id]])->once()->andReturn(collect(['testkeys']));
2017-09-02 05:21:15 +00:00
$response = $this->getController()->index($this->request);
$this->assertIsViewResponse($response);
2017-09-02 05:21:15 +00:00
$this->assertViewNameEquals('base.api.index', $response);
$this->assertViewHasKey('keys', $response);
$this->assertViewKeyEquals('keys', collect(['testkeys']), $response);
2017-09-02 05:21:15 +00:00
}
/**
* Test the create API view controller.
*
* @dataProvider rootAdminDataProvider
*/
public function testCreateController($admin)
{
$this->generateRequestUserModel(['root_admin' => $admin]);
2017-09-02 05:21:15 +00:00
$response = $this->getController()->create($this->request);
$this->assertIsViewResponse($response);
2017-09-02 05:21:15 +00:00
$this->assertViewNameEquals('base.api.new', $response);
$this->assertViewHasKey('permissions.user', $response);
$this->assertViewHasKey('permissions.admin', $response);
if ($admin) {
$this->assertViewKeyNotEquals('permissions.admin', null, $response);
} else {
$this->assertViewKeyEquals('permissions.admin', null, $response);
}
}
/**
* Test the store functionality for a non-admin user.
*
* @dataProvider rootAdminDataProvider
*/
public function testStoreController($admin)
{
$this->setRequestMockClass(ApiKeyFormRequest::class);
$model = $this->generateRequestUserModel(['root_admin' => $admin]);
2018-01-14 18:06:15 +00:00
$keyModel = factory(ApiKey::class)->make();
2017-09-02 05:21:15 +00:00
if ($admin) {
$this->request->shouldReceive('input')->with('admin_permissions', [])->once()->andReturn(['admin.permission']);
}
$this->request->shouldReceive('user')->withNoArgs()->andReturn($model);
$this->request->shouldReceive('input')->with('allowed_ips')->once()->andReturnNull();
$this->request->shouldReceive('input')->with('memo')->once()->andReturnNull();
$this->request->shouldReceive('input')->with('permissions', [])->once()->andReturn(['test.permission']);
$this->keyService->shouldReceive('handle')->with([
'user_id' => $model->id,
'allowed_ips' => null,
'memo' => null,
], ['test.permission'], ($admin) ? ['admin.permission'] : [])->once()->andReturn($keyModel);
2017-09-02 05:21:15 +00:00
$this->alert->shouldReceive('success')->with(trans('base.api.index.keypair_created'))->once()->andReturnSelf();
$this->alert->shouldReceive('flash')->withNoArgs()->once()->andReturnNull();
2017-09-02 05:21:15 +00:00
$response = $this->getController()->store($this->request);
$this->assertIsRedirectResponse($response);
$this->assertRedirectRouteEquals('account.api', $response);
2017-09-02 05:21:15 +00:00
}
/**
* Test the API key revocation controller.
*/
public function testRevokeController()
{
$model = $this->generateRequestUserModel();
2017-09-02 05:21:15 +00:00
$this->repository->shouldReceive('deleteWhere')->with([
['user_id', '=', $model->id],
['token', '=', 'testKey123'],
])->once()->andReturn(1);
2017-09-02 05:21:15 +00:00
$response = $this->getController()->revoke($this->request, 'testKey123');
$this->assertIsResponse($response);
2017-09-02 05:21:15 +00:00
$this->assertEmpty($response->getContent());
$this->assertResponseCodeEquals(204, $response);
2017-09-02 05:21:15 +00:00
}
/**
* Data provider to determine if a user is a root admin.
*
* @return array
*/
public function rootAdminDataProvider()
{
return [[0], [1]];
}
/**
* Return an instance of the controller with mocked dependencies for testing.
*
* @return \Pterodactyl\Http\Controllers\Base\APIController
*/
private function getController(): APIController
{
return new APIController($this->alert, $this->repository, $this->keyService);
}
2017-09-02 05:21:15 +00:00
}