Added tests to cover API config and listing code

diff --git a/tests/Api/ApiConfigTest.php b/tests/Api/ApiConfigTest.php
new file mode 100644 (file)
index 0000000..99b063c
--- /dev/null
+++ b/tests/Api/ApiConfigTest.php
@@ -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');
+    }
+
+}
\ No newline at end of file

diff --git a/tests/Api/ApiListingTest.php b/tests/Api/ApiListingTest.php
new file mode 100644 (file)
index 0000000..70d1140
--- /dev/null
+++ b/tests/Api/ApiListingTest.php
@@ -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,
+                ]
+            ]]);
+        }
+    }
+
+}
\ No newline at end of file

diff --git a/tests/TestsApi.php b/tests/TestsApi.php
index 4afcbdf220a5a78c6a2dce92b465554dcceef421..0bb10a4cc764c22941a0c0c99b280c7b59587bf6 100644 (file)
--- a/tests/TestsApi.php
+++ b/tests/TestsApi.php
@@ -8,12 +8,27 @@ trait TestsApi
     protected $apiTokenId = 'apitoken';
     protected $apiTokenSecret = 'password';
 
     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}"
     {
         return [
             "Authorization" => "Token {$this->apiTokenId}:{$this->apiTokenSecret}"