BookStack Code Mirror - bookstack/blobdiff - tests/Api/PagesApiTest.php

index fe1fc8d36cbbb762e6d2fc7d8eed05f4c4e1d5d6..a1f65692f05822482047af88878c9d139746f0af 100644 (file)

--- a/tests/Api/PagesApiTest.php

+++ b/tests/Api/PagesApiTest.php

@@ -2,7 +2,6 @@

namespace Tests\Api;

-use BookStack\Entities\Models\Book;

use BookStack\Entities\Models\Chapter;

use BookStack\Entities\Models\Page;

use Carbon\Carbon;

@@ -64,6 +63,39 @@ class PagesApiTest extends TestCase

$this->assertActivityExists('page_create', $newItem);

}

+ public function test_create_applies_correct_priority()

+ {

+ $this->actingAsApiEditor();

+ $book = $this->entities->book();

+ $details = [

+ 'name' => 'My API page',

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

+ 'html' => '<p>My new page content</p>',

+ 'tags' => [

+ [

+ 'name' => 'tagname',

+ 'value' => 'tagvalue',

+ ],

+ 'priority' => 15,

+ ];

+ $resp = $this->postJson($this->baseEndpoint, $details);

+ unset($details['html']);

+ $resp->assertStatus(200);

+ $newItem = Page::query()->orderByDesc('id')->where('name', '=', $details['name'])->first();

+ $resp->assertJson(array_merge($details, ['id' => $newItem->id, 'slug' => $newItem->slug]));

+ $this->assertDatabaseHas('tags', [

+ 'entity_id' => $newItem->id,

+ 'entity_type' => $newItem->getMorphClass(),

+ 'name' => 'tagname',

+ 'value' => 'tagvalue',

+ ]);

+ $resp->assertSeeText('My new page content');

+ $resp->assertJsonMissing(['book' => []]);

+ $this->assertActivityExists('page_create', $newItem);

+ }

public function test_page_name_needed_to_create()

{

$this->actingAsApiEditor();

@@ -95,11 +127,11 @@ class PagesApiTest extends TestCase

'chapter_id' => ['The chapter id field is required when book id is not present.'],

]));

- $chapter = Chapter::visible()->first();

+ $chapter = $this->entities->chapter();

$resp = $this->postJson($this->baseEndpoint, array_merge($details, ['chapter_id' => $chapter->id]));

$resp->assertStatus(200);

- $book = Book::visible()->first();

+ $book = $this->entities->book();

$resp = $this->postJson($this->baseEndpoint, array_merge($details, ['book_id' => $book->id]));

$resp->assertStatus(200);

}

@@ -107,7 +139,7 @@ class PagesApiTest extends TestCase

public function test_markdown_can_be_provided_for_create()

{

$this->actingAsApiEditor();

- $book = Book::visible()->first();

+ $book = $this->entities->book();

$details = [

'book_id' => $book->id,

'name' => 'My api page',

@@ -126,7 +158,7 @@ class PagesApiTest extends TestCase

public function test_read_endpoint()

{

$this->actingAsApiEditor();

- $page = Page::visible()->first();

+ $page = $this->entities->page();

$resp = $this->getJson($this->baseEndpoint . "/{$page->id}");

$resp->assertStatus(200);

@@ -149,7 +181,7 @@ class PagesApiTest extends TestCase

public function test_read_endpoint_provides_rendered_html()

{

$this->actingAsApiEditor();

- $page = Page::visible()->first();

+ $page = $this->entities->page();

$page->html = "<p>testing</p><script>alert('danger')</script><h1>Hello</h1>";

$page->save();

@@ -160,10 +192,45 @@ class PagesApiTest extends TestCase

$this->assertStringContainsString('testing', $html);

}

+ public function test_read_endpoint_provides_raw_html()

+ {

+ $html = "<p>testing</p><script>alert('danger')</script><h1>Hello</h1>";

+ $this->actingAsApiEditor();

+ $page = $this->entities->page();

+ $page->html = $html;

+ $page->save();

+ $resp = $this->getJson($this->baseEndpoint . "/{$page->id}");

+ $this->assertEquals($html, $resp->json('raw_html'));

+ $this->assertNotEquals($html, $resp->json('html'));

+ }

+ public function test_read_endpoint_returns_not_found()

+ {

+ $this->actingAsApiEditor();

+ // get an id that is not used

+ $id = Page::orderBy('id', 'desc')->first()->id + 1;

+ $this->assertNull(Page::find($id));

+ $resp = $this->getJson($this->baseEndpoint . "/$id");

+ $resp->assertNotFound();

+ $this->assertNull($resp->json('id'));

+ $resp->assertJsonIsObject('error');

+ $resp->assertJsonStructure([

+ 'error' => [

+ 'code',

+ 'message',

+ ],

+ ]);

+ $this->assertSame(404, $resp->json('error')['code']);

+ }

public function test_update_endpoint()

{

$this->actingAsApiEditor();

- $page = Page::visible()->first();

+ $page = $this->entities->page();

$details = [

'name' => 'My updated API page',

'html' => '<p>A page created via the API</p>',

@@ -173,6 +240,7 @@ class PagesApiTest extends TestCase

'value' => 'freshtagval',

+ 'priority' => 15,

];

$resp = $this->putJson($this->baseEndpoint . "/{$page->id}", $details);

@@ -189,7 +257,7 @@ class PagesApiTest extends TestCase

public function test_providing_new_chapter_id_on_update_will_move_page()

{

$this->actingAsApiEditor();

- $page = Page::visible()->first();

+ $page = $this->entities->page();

$chapter = Chapter::visible()->where('book_id', '!=', $page->book_id)->first();

$details = [

'name' => 'My updated API page',

@@ -208,9 +276,9 @@ class PagesApiTest extends TestCase

public function test_providing_move_via_update_requires_page_create_permission_on_new_parent()

{

$this->actingAsApiEditor();

- $page = Page::visible()->first();

+ $page = $this->entities->page();

$chapter = Chapter::visible()->where('book_id', '!=', $page->book_id)->first();

- $this->entities->setPermissions($chapter, ['view'], [$this->getEditor()->roles()->first()]);

+ $this->permissions->setEntityPermissions($chapter, ['view'], [$this->users->editor()->roles()->first()]);

$details = [

'name' => 'My updated API page',

'chapter_id' => $chapter->id,

@@ -224,7 +292,7 @@ class PagesApiTest extends TestCase

public function test_update_endpoint_does_not_wipe_content_if_no_html_or_md_provided()

{

$this->actingAsApiEditor();

- $page = Page::visible()->first();

+ $page = $this->entities->page();

$originalContent = $page->html;

$details = [

'name' => 'My updated API page',

@@ -245,7 +313,7 @@ class PagesApiTest extends TestCase

public function test_update_increments_updated_date_if_only_tags_are_sent()

{

$this->actingAsApiEditor();

- $page = Page::visible()->first();

+ $page = $this->entities->page();

DB::table('pages')->where('id', '=', $page->id)->update(['updated_at' => Carbon::now()->subWeek()]);

$details = [

@@ -262,7 +330,7 @@ class PagesApiTest extends TestCase

public function test_delete_endpoint()

{

$this->actingAsApiEditor();

- $page = Page::visible()->first();

+ $page = $this->entities->page();

$resp = $this->deleteJson($this->baseEndpoint . "/{$page->id}");

$resp->assertStatus(204);

@@ -272,7 +340,7 @@ class PagesApiTest extends TestCase

public function test_export_html_endpoint()

{

$this->actingAsApiEditor();

- $page = Page::visible()->first();

+ $page = $this->entities->page();

$resp = $this->get($this->baseEndpoint . "/{$page->id}/export/html");

$resp->assertStatus(200);

@@ -283,7 +351,7 @@ class PagesApiTest extends TestCase

public function test_export_plain_text_endpoint()

{

$this->actingAsApiEditor();

- $page = Page::visible()->first();

+ $page = $this->entities->page();

$resp = $this->get($this->baseEndpoint . "/{$page->id}/export/plaintext");

$resp->assertStatus(200);

@@ -294,7 +362,7 @@ class PagesApiTest extends TestCase

public function test_export_pdf_endpoint()

{

$this->actingAsApiEditor();

- $page = Page::visible()->first();

+ $page = $this->entities->page();

$resp = $this->get($this->baseEndpoint . "/{$page->id}/export/pdf");

$resp->assertStatus(200);

@@ -304,7 +372,7 @@ class PagesApiTest extends TestCase

public function test_export_markdown_endpoint()

{

$this->actingAsApiEditor();

- $page = Page::visible()->first();

+ $page = $this->entities->page();

$resp = $this->get($this->baseEndpoint . "/{$page->id}/export/markdown");

$resp->assertStatus(200);

@@ -316,9 +384,9 @@ class PagesApiTest extends TestCase

{

$types = ['html', 'plaintext', 'pdf', 'markdown'];

$this->actingAsApiEditor();

- $this->removePermissionFromUser($this->getEditor(), 'content-export');

+ $this->permissions->removeUserRolePermissions($this->users->editor(), ['content-export']);

- $page = Page::visible()->first();

+ $page = $this->entities->page();

foreach ($types as $type) {

$resp = $this->get($this->baseEndpoint . "/{$page->id}/export/{$type}");

$this->assertPermissionError($resp);