Infra-Mirrors/BookStack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-07-07 20:02:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added tests to cover API config and listing code

Browse Source
This commit is contained in:
Dan Brown 2019-12-30 20:48:23 +00:00
parent 3cacda6762
commit 55abf7be24
No known key found for this signature in database
GPG Key ID: 46D9F943C24A2EF9
3 changed files with 126 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
tests/Api/ApiConfigTest.php Normal file
View File

@ -0,0 +1,47 @@
<?php
namespace Tests;
use BookStack\Auth\Permissions\RolePermission;
use Carbon\Carbon;
class ApiAuthTest extends TestCase
{
use TestsApi;
protected $endpoint = '/api/books';
public function test_default_item_count_reflected_in_listing_requests()
{
$this->actingAsApiEditor();
config()->set(['api.default_item_count' => 5]);
$resp = $this->get($this->endpoint);
$resp->assertJsonCount(5, 'data');
config()->set(['api.default_item_count' => 1]);
$resp = $this->get($this->endpoint);
$resp->assertJsonCount(1, 'data');
}
public function test_default_item_count_does_not_limit_count_param()
{
$this->actingAsApiEditor();
config()->set(['api.default_item_count' => 1]);
$resp = $this->get($this->endpoint . '?count=5');
$resp->assertJsonCount(5, 'data');
}
public function test_max_item_count_limits_listing_requests()
{
$this->actingAsApiEditor();
config()->set(['api.max_item_count' => 2]);
$resp = $this->get($this->endpoint);
$resp->assertJsonCount(2, 'data');
$resp = $this->get($this->endpoint . '?count=5');
$resp->assertJsonCount(2, 'data');
}
}

61
tests/Api/ApiListingTest.php Normal file
View File

@ -0,0 +1,61 @@
<?php
namespace Tests;
use BookStack\Auth\Permissions\RolePermission;
use BookStack\Entities\Book;
use Carbon\Carbon;
class ApiAuthTest extends TestCase
{
use TestsApi;
protected $endpoint = '/api/books';
public function test_count_parameter_limits_responses()
{
$this->actingAsApiEditor();
$bookCount = min(Book::visible()->count(), 100);
$resp = $this->get($this->endpoint);
$resp->assertJsonCount($bookCount, 'data');
$resp = $this->get($this->endpoint . '?count=1');
$resp->assertJsonCount(1, 'data');
}
public function test_offset_parameter()
{
$this->actingAsApiEditor();
$books = Book::visible()->orderBy('id')->take(3)->get();
$resp = $this->get($this->endpoint . '?count=1');
$resp->assertJsonMissing(['name' => $books[1]->name ]);
$resp = $this->get($this->endpoint . '?count=1&offset=1000');
$resp->assertJsonCount(0, 'data');
}
public function test_sort_parameter()
{
$this->actingAsApiEditor();
$sortChecks = [
'-id' => Book::visible()->orderBy('id', 'desc')->first(),
'+name' => Book::visible()->orderBy('name', 'asc')->first(),
'name' => Book::visible()->orderBy('name', 'asc')->first(),
'-name' => Book::visible()->orderBy('name', 'desc')->first()
];
foreach ($sortChecks as $sortOption => $result) {
$resp = $this->get($this->endpoint . '?count=1&sort=' . $sortOption);
$resp->assertJson(['data' => [
[
'id' => $result->id,
'name' => $result->name,
]
]]);
}
}
}

21
tests/TestsApi.php
View File

@ -8,12 +8,27 @@ trait TestsApi
protected $apiTokenId = 'apitoken';
protected $apiTokenSecret = 'password';
protected function errorResponse(string $messge, int $code)
/**
* Set the API editor role as the current user via the API driver.
*/
protected function actingAsApiEditor()
{
return ["error" => ["code" => $code, "message" => $messge]];
$this->actingAs($this->getEditor(), 'api');
return $this;
}
protected function apiAuthHeader()
/**
* Format the given items into a standardised error format.
*/
protected function errorResponse(string $message, int $code): array
{
return ["error" => ["code" => $code, "message" => $message]];
}
/**
* Get an approved API auth header.
*/
protected function apiAuthHeader(): array
{
return [
"Authorization" => "Token {$this->apiTokenId}:{$this->apiTokenSecret}"