Added OIDC group sync functionality

[bookstack] / tests / Api / BooksApiTest.php

diff --git a/tests/Api/BooksApiTest.php b/tests/Api/BooksApiTest.php
index a40e4c93b6c43aab535dee805b78a7c91b6517a3..f426cff7358fba2e54a4bbfa63dd82b18f20f7d8 100644 (file)
--- a/tests/Api/BooksApiTest.php
+++ b/tests/Api/BooksApiTest.php
@@ -1,12 +1,19 @@
-<?php namespace Tests;
+<?php

 
 

-use BookStack\Entities\Book;
+namespace Tests\Api;
+
+use BookStack\Entities\Models\Book;
+use Carbon\Carbon;
+use Illuminate\Support\Facades\DB;
+use Tests\TestCase;
+use Tests\Uploads\UsesImages;

 
 class BooksApiTest extends TestCase
 {
     use TestsApi;
 
 class BooksApiTest extends TestCase
 {
     use TestsApi;

+    use UsesImages;

 
 

-    protected $baseEndpoint = '/api/books';
+    protected string $baseEndpoint = '/api/books';

 
     public function test_index_endpoint_returns_expected_book()
     {
 
     public function test_index_endpoint_returns_expected_book()
     {


@@ -16,10 +23,10 @@ class BooksApiTest extends TestCase
         $resp = $this->getJson($this->baseEndpoint . '?count=1&sort=+id');
         $resp->assertJson(['data' => [
             [
         $resp = $this->getJson($this->baseEndpoint . '?count=1&sort=+id');
         $resp->assertJson(['data' => [
             [

-                'id' => $firstBook->id,
+                'id'   => $firstBook->id,

                 'name' => $firstBook->name,
                 'slug' => $firstBook->slug,
                 'name' => $firstBook->name,
                 'slug' => $firstBook->slug,

-            ]
+            ],

         ]]);
     }
 
         ]]);
     }
 


@@ -27,7 +34,7 @@ class BooksApiTest extends TestCase
     {
         $this->actingAsApiEditor();
         $details = [
     {
         $this->actingAsApiEditor();
         $details = [

-            'name' => 'My API book',
+            'name'        => 'My API book',

             'description' => 'A book created via the API',
         ];
 
             'description' => 'A book created via the API',
         ];
 


@@ -48,12 +55,12 @@ class BooksApiTest extends TestCase
         $resp = $this->postJson($this->baseEndpoint, $details);
         $resp->assertStatus(422);
         $resp->assertJson([
         $resp = $this->postJson($this->baseEndpoint, $details);
         $resp->assertStatus(422);
         $resp->assertJson([

-            "error" => [
-                "message" => "The given data was invalid.",
-                "validation" => [
-                    "name" => ["The name field is required."]
+            'error' => [
+                'message'    => 'The given data was invalid.',
+                'validation' => [
+                    'name' => ['The name field is required.'],

                 ],
                 ],

-                "code" => 422,
+                'code' => 422,

             ],
         ]);
     }
             ],
         ]);
     }


@@ -67,14 +74,17 @@ class BooksApiTest extends TestCase
 
         $resp->assertStatus(200);
         $resp->assertJson([
 
         $resp->assertStatus(200);
         $resp->assertJson([

-            'id' => $book->id,
-            'slug' => $book->slug,
+            'id'         => $book->id,
+            'slug'       => $book->slug,

             'created_by' => [
                 'name' => $book->createdBy->name,
             ],
             'updated_by' => [
                 'name' => $book->createdBy->name,
             'created_by' => [
                 'name' => $book->createdBy->name,
             ],
             'updated_by' => [
                 'name' => $book->createdBy->name,

-            ]
+            ],
+            'owned_by' => [
+                'name' => $book->ownedBy->name,
+            ],

         ]);
     }
 
         ]);
     }
 


@@ -83,7 +93,7 @@ class BooksApiTest extends TestCase
         $this->actingAsApiEditor();
         $book = Book::visible()->first();
         $details = [
         $this->actingAsApiEditor();
         $book = Book::visible()->first();
         $details = [

-            'name' => 'My updated API book',
+            'name'        => 'My updated API book',

             'description' => 'A book created via the API',
         ];
 
             'description' => 'A book created via the API',
         ];
 


@@ -95,6 +105,57 @@ class BooksApiTest extends TestCase
         $this->assertActivityExists('book_update', $book);
     }
 
         $this->assertActivityExists('book_update', $book);
     }
 

+    public function test_update_increments_updated_date_if_only_tags_are_sent()
+    {
+        $this->actingAsApiEditor();
+        $book = Book::visible()->first();
+        DB::table('books')->where('id', '=', $book->id)->update(['updated_at' => Carbon::now()->subWeek()]);
+
+        $details = [
+            'tags' => [['name' => 'Category', 'value' => 'Testing']],
+        ];
+
+        $this->putJson($this->baseEndpoint . "/{$book->id}", $details);
+        $book->refresh();
+        $this->assertGreaterThan(Carbon::now()->subDay()->unix(), $book->updated_at->unix());
+    }
+
+    public function test_update_cover_image_control()
+    {
+        $this->actingAsApiEditor();
+        /** @var Book $book */
+        $book = Book::visible()->first();
+        $this->assertNull($book->cover);
+        $file = $this->getTestImage('image.png');
+
+        // Ensure cover image can be set via API
+        $resp = $this->call('PUT', $this->baseEndpoint . "/{$book->id}", [
+            'name'  => 'My updated API book with image',
+        ], [], ['image' => $file]);
+        $book->refresh();
+
+        $resp->assertStatus(200);
+        $this->assertNotNull($book->cover);
+
+        // Ensure further updates without image do not clear cover image
+        $resp = $this->put($this->baseEndpoint . "/{$book->id}", [
+            'name' => 'My updated book again',
+        ]);
+        $book->refresh();
+
+        $resp->assertStatus(200);
+        $this->assertNotNull($book->cover);
+
+        // Ensure update with null image property clears image
+        $resp = $this->put($this->baseEndpoint . "/{$book->id}", [
+            'image' => null,
+        ]);
+        $book->refresh();
+
+        $resp->assertStatus(200);
+        $this->assertNull($book->cover);
+    }
+

     public function test_delete_endpoint()
     {
         $this->actingAsApiEditor();
     public function test_delete_endpoint()
     {
         $this->actingAsApiEditor();


@@ -104,4 +165,62 @@ class BooksApiTest extends TestCase
         $resp->assertStatus(204);
         $this->assertActivityExists('book_delete');
     }
         $resp->assertStatus(204);
         $this->assertActivityExists('book_delete');
     }

-}
\ No newline at end of file
+
+    public function test_export_html_endpoint()
+    {
+        $this->actingAsApiEditor();
+        $book = Book::visible()->first();
+
+        $resp = $this->get($this->baseEndpoint . "/{$book->id}/export/html");
+        $resp->assertStatus(200);
+        $resp->assertSee($book->name);
+        $resp->assertHeader('Content-Disposition', 'attachment; filename="' . $book->slug . '.html"');
+    }
+
+    public function test_export_plain_text_endpoint()
+    {
+        $this->actingAsApiEditor();
+        $book = Book::visible()->first();
+
+        $resp = $this->get($this->baseEndpoint . "/{$book->id}/export/plaintext");
+        $resp->assertStatus(200);
+        $resp->assertSee($book->name);
+        $resp->assertHeader('Content-Disposition', 'attachment; filename="' . $book->slug . '.txt"');
+    }
+
+    public function test_export_pdf_endpoint()
+    {
+        $this->actingAsApiEditor();
+        $book = Book::visible()->first();
+
+        $resp = $this->get($this->baseEndpoint . "/{$book->id}/export/pdf");
+        $resp->assertStatus(200);
+        $resp->assertHeader('Content-Disposition', 'attachment; filename="' . $book->slug . '.pdf"');
+    }
+
+    public function test_export_markdown_endpoint()
+    {
+        $this->actingAsApiEditor();
+        $book = Book::visible()->has('pages')->has('chapters')->first();
+
+        $resp = $this->get($this->baseEndpoint . "/{$book->id}/export/markdown");
+        $resp->assertStatus(200);
+        $resp->assertHeader('Content-Disposition', 'attachment; filename="' . $book->slug . '.md"');
+        $resp->assertSee('# ' . $book->name);
+        $resp->assertSee('# ' . $book->pages()->first()->name);
+        $resp->assertSee('# ' . $book->chapters()->first()->name);
+    }
+
+    public function test_cant_export_when_not_have_permission()
+    {
+        $types = ['html', 'plaintext', 'pdf', 'markdown'];
+        $this->actingAsApiEditor();
+        $this->removePermissionFromUser($this->getEditor(), 'content-export');
+
+        $book = Book::visible()->first();
+        foreach ($types as $type) {
+            $resp = $this->get($this->baseEndpoint . "/{$book->id}/export/{$type}");
+            $this->assertPermissionError($resp);
+        }
+    }
+}