colin
/
bookstack
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Input WYSIWYG: Updated API testing, fixed description set issue 

Fixed issue where an existing description_html field would not be
updated via 'description' input.
This commit is contained in:
Dan Brown 2023-12-22 13:17:23 +00:00
parent 00ae04e0bd
commit 2a7a81e749
No known key found for this signature in database
GPG Key ID: 46D9F943C24A2EF9
4 changed files with 148 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
app/Entities/Repos/BaseRepo.php
View File

@ -116,6 +116,7 @@ class BaseRepo
$entity->description = html_entity_decode(strip_tags($input['description_html'])); $entity->description = html_entity_decode(strip_tags($input['description_html']));
} else if (isset($input['description'])) { } else if (isset($input['description'])) {
$entity->description = $input['description']; $entity->description = $input['description'];
$entity->description_html = '';
$entity->description_html = $entity->descriptionHtml(); $entity->description_html = $entity->descriptionHtml();
} }
} }

56
tests/Api/BooksApiTest.php
View File

@ -33,8 +33,8 @@ class BooksApiTest extends TestCase
$this->actingAsApiEditor(); $this->actingAsApiEditor();
$templatePage = $this->entities->templatePage(); $templatePage = $this->entities->templatePage();
$details = [ $details = [
'name' => 'My API book', 'name' => 'My API book',
'description' => 'A book created via the API', 'description' => 'A book created via the API',
'default_template_id' => $templatePage->id, 'default_template_id' => $templatePage->id,
]; ];
@ -42,10 +42,35 @@ class BooksApiTest extends TestCase
$resp->assertStatus(200); $resp->assertStatus(200);
$newItem = Book::query()->orderByDesc('id')->where('name', '=', $details['name'])->first(); $newItem = Book::query()->orderByDesc('id')->where('name', '=', $details['name'])->first();
$resp->assertJson(array_merge($details, ['id' => $newItem->id, 'slug' => $newItem->slug])); $resp->assertJson(array_merge($details, [
'id' => $newItem->id,
'slug' => $newItem->slug,
'description_html' => '<p>A book created via the API</p>',
]));
$this->assertActivityExists('book_create', $newItem); $this->assertActivityExists('book_create', $newItem);
} }
public function test_create_endpoint_with_html()
{
$this->actingAsApiEditor();
$details = [
'name' => 'My API book',
'description_html' => '<p>A book <em>created</em> <strong>via</strong> the API</p>',
];
$resp = $this->postJson($this->baseEndpoint, $details);
$resp->assertStatus(200);
$newItem = Book::query()->orderByDesc('id')->where('name', '=', $details['name'])->first();
$expectedDetails = array_merge($details, [
'id' => $newItem->id,
'description' => 'A book created via the API',
]);
$resp->assertJson($expectedDetails);
$this->assertDatabaseHas('books', $expectedDetails);
}
public function test_book_name_needed_to_create() public function test_book_name_needed_to_create()
{ {
$this->actingAsApiEditor(); $this->actingAsApiEditor();
@ -61,7 +86,7 @@ class BooksApiTest extends TestCase
'validation' => [ 'validation' => [
'name' => ['The name field is required.'], 'name' => ['The name field is required.'],
], ],
'code' => 422, 'code' => 422,
], ],
]); ]);
} }
@ -128,7 +153,7 @@ class BooksApiTest extends TestCase
$templatePage = $this->entities->templatePage(); $templatePage = $this->entities->templatePage();
$details = [ $details = [
'name' => 'My updated API book', 'name' => 'My updated API book',
'description' => 'A book created via the API', 'description' => 'A book updated via the API',
'default_template_id' => $templatePage->id, 'default_template_id' => $templatePage->id,
]; ];
@ -136,10 +161,29 @@ class BooksApiTest extends TestCase
$book->refresh(); $book->refresh();
$resp->assertStatus(200); $resp->assertStatus(200);
$resp->assertJson(array_merge($details, ['id' => $book->id, 'slug' => $book->slug])); $resp->assertJson(array_merge($details, [
'id' => $book->id,
'slug' => $book->slug,
'description_html' => '<p>A book updated via the API</p>',
]));
$this->assertActivityExists('book_update', $book); $this->assertActivityExists('book_update', $book);
} }
public function test_update_endpoint_with_html()
{
$this->actingAsApiEditor();
$book = $this->entities->book();
$details = [
'name' => 'My updated API book',
'description_html' => '<p>A book <strong>updated</strong> via the API</p>',
];
$resp = $this->putJson($this->baseEndpoint . "/{$book->id}", $details);
$resp->assertStatus(200);
$this->assertDatabaseHas('books', array_merge($details, ['id' => $book->id, 'description' => 'A book updated via the API']));
}
public function test_update_increments_updated_date_if_only_tags_are_sent() public function test_update_increments_updated_date_if_only_tags_are_sent()
{ {
$this->actingAsApiEditor(); $this->actingAsApiEditor();

52
tests/Api/ChaptersApiTest.php
View File

@ -51,7 +51,11 @@ class ChaptersApiTest extends TestCase
$resp = $this->postJson($this->baseEndpoint, $details); $resp = $this->postJson($this->baseEndpoint, $details);
$resp->assertStatus(200); $resp->assertStatus(200);
$newItem = Chapter::query()->orderByDesc('id')->where('name', '=', $details['name'])->first(); $newItem = Chapter::query()->orderByDesc('id')->where('name', '=', $details['name'])->first();
$resp->assertJson(array_merge($details, ['id' => $newItem->id, 'slug' => $newItem->slug])); $resp->assertJson(array_merge($details, [
'id' => $newItem->id,
'slug' => $newItem->slug,
'description_html' => '<p>A chapter created via the API</p>',
]));
$this->assertDatabaseHas('tags', [ $this->assertDatabaseHas('tags', [
'entity_id' => $newItem->id, 'entity_id' => $newItem->id,
'entity_type' => $newItem->getMorphClass(), 'entity_type' => $newItem->getMorphClass(),
@ -62,6 +66,28 @@ class ChaptersApiTest extends TestCase
$this->assertActivityExists('chapter_create', $newItem); $this->assertActivityExists('chapter_create', $newItem);
} }
public function test_create_endpoint_with_html()
{
$this->actingAsApiEditor();
$book = $this->entities->book();
$details = [
'name' => 'My API chapter',
'description_html' => '<p>A chapter <strong>created</strong> via the API</p>',
'book_id' => $book->id,
];
$resp = $this->postJson($this->baseEndpoint, $details);
$resp->assertStatus(200);
$newItem = Chapter::query()->orderByDesc('id')->where('name', '=', $details['name'])->first();
$expectedDetails = array_merge($details, [
'id' => $newItem->id,
'description' => 'A chapter created via the API',
]);
$resp->assertJson($expectedDetails);
$this->assertDatabaseHas('chapters', $expectedDetails);
}
public function test_chapter_name_needed_to_create() public function test_chapter_name_needed_to_create()
{ {
$this->actingAsApiEditor(); $this->actingAsApiEditor();
@ -131,7 +157,7 @@ class ChaptersApiTest extends TestCase
$chapter = $this->entities->chapter(); $chapter = $this->entities->chapter();
$details = [ $details = [
'name' => 'My updated API chapter', 'name' => 'My updated API chapter',
'description' => 'A chapter created via the API', 'description' => 'A chapter updated via the API',
'tags' => [ 'tags' => [
[ [
'name' => 'freshtag', 'name' => 'freshtag',
@ -146,11 +172,31 @@ class ChaptersApiTest extends TestCase
$resp->assertStatus(200); $resp->assertStatus(200);
$resp->assertJson(array_merge($details, [ $resp->assertJson(array_merge($details, [
'id' => $chapter->id, 'slug' => $chapter->slug, 'book_id' => $chapter->book_id, 'id' => $chapter->id,
'slug' => $chapter->slug,
'book_id' => $chapter->book_id,
'description_html' => '<p>A chapter updated via the API</p>',
])); ]));
$this->assertActivityExists('chapter_update', $chapter); $this->assertActivityExists('chapter_update', $chapter);
} }
public function test_update_endpoint_with_html()
{
$this->actingAsApiEditor();
$chapter = $this->entities->chapter();
$details = [
'name' => 'My updated API chapter',
'description_html' => '<p>A chapter <em>updated</em> via the API</p>',
];
$resp = $this->putJson($this->baseEndpoint . "/{$chapter->id}", $details);
$resp->assertStatus(200);
$this->assertDatabaseHas('chapters', array_merge($details, [
'id' => $chapter->id, 'description' => 'A chapter updated via the API'
]));
}
public function test_update_increments_updated_date_if_only_tags_are_sent() public function test_update_increments_updated_date_if_only_tags_are_sent()
{ {
$this->actingAsApiEditor(); $this->actingAsApiEditor();

51
tests/Api/ShelvesApiTest.php
View File

@ -42,7 +42,11 @@ class ShelvesApiTest extends TestCase
$resp = $this->postJson($this->baseEndpoint, array_merge($details, ['books' => [$books[0]->id, $books[1]->id]])); $resp = $this->postJson($this->baseEndpoint, array_merge($details, ['books' => [$books[0]->id, $books[1]->id]]));
$resp->assertStatus(200); $resp->assertStatus(200);
$newItem = Bookshelf::query()->orderByDesc('id')->where('name', '=', $details['name'])->first(); $newItem = Bookshelf::query()->orderByDesc('id')->where('name', '=', $details['name'])->first();
$resp->assertJson(array_merge($details, ['id' => $newItem->id, 'slug' => $newItem->slug])); $resp->assertJson(array_merge($details, [
'id' => $newItem->id,
'slug' => $newItem->slug,
'description_html' => '<p>A shelf created via the API</p>',
]));
$this->assertActivityExists('bookshelf_create', $newItem); $this->assertActivityExists('bookshelf_create', $newItem);
foreach ($books as $index => $book) { foreach ($books as $index => $book) {
$this->assertDatabaseHas('bookshelves_books', [ $this->assertDatabaseHas('bookshelves_books', [
@ -53,6 +57,28 @@ class ShelvesApiTest extends TestCase
} }
} }
public function test_create_endpoint_with_html()
{
$this->actingAsApiEditor();
$details = [
'name' => 'My API shelf',
'description_html' => '<p>A <strong>shelf</strong> created via the API</p>',
];
$resp = $this->postJson($this->baseEndpoint, $details);
$resp->assertStatus(200);
$newItem = Bookshelf::query()->orderByDesc('id')->where('name', '=', $details['name'])->first();
$expectedDetails = array_merge($details, [
'id' => $newItem->id,
'description' => 'A shelf created via the API',
]);
$resp->assertJson($expectedDetails);
$this->assertDatabaseHas('bookshelves', $expectedDetails);
}
public function test_shelf_name_needed_to_create() public function test_shelf_name_needed_to_create()
{ {
$this->actingAsApiEditor(); $this->actingAsApiEditor();
@ -102,17 +128,36 @@ class ShelvesApiTest extends TestCase
$shelf = Bookshelf::visible()->first(); $shelf = Bookshelf::visible()->first();
$details = [ $details = [
'name' => 'My updated API shelf', 'name' => 'My updated API shelf',
'description' => 'A shelf created via the API', 'description' => 'A shelf updated via the API',
]; ];
$resp = $this->putJson($this->baseEndpoint . "/{$shelf->id}", $details); $resp = $this->putJson($this->baseEndpoint . "/{$shelf->id}", $details);
$shelf->refresh(); $shelf->refresh();
$resp->assertStatus(200); $resp->assertStatus(200);
$resp->assertJson(array_merge($details, ['id' => $shelf->id, 'slug' => $shelf->slug])); $resp->assertJson(array_merge($details, [
'id' => $shelf->id,
'slug' => $shelf->slug,
'description_html' => '<p>A shelf updated via the API</p>',
]));
$this->assertActivityExists('bookshelf_update', $shelf); $this->assertActivityExists('bookshelf_update', $shelf);
} }
public function test_update_endpoint_with_html()
{
$this->actingAsApiEditor();
$shelf = Bookshelf::visible()->first();
$details = [
'name' => 'My updated API shelf',
'description_html' => '<p>A shelf <em>updated</em> via the API</p>',
];
$resp = $this->putJson($this->baseEndpoint . "/{$shelf->id}", $details);
$resp->assertStatus(200);
$this->assertDatabaseHas('bookshelves', array_merge($details, ['id' => $shelf->id, 'description' => 'A shelf updated via the API']));
}
public function test_update_increments_updated_date_if_only_tags_are_sent() public function test_update_increments_updated_date_if_only_tags_are_sent()
{ {
$this->actingAsApiEditor(); $this->actingAsApiEditor();