namespace Tests\Entity;
-use BookStack\Auth\Role;
use BookStack\Entities\Models\Book;
use BookStack\Entities\Models\Chapter;
use BookStack\Entities\Models\Page;
{
public function test_page_text_export()
{
- $page = Page::query()->first();
+ $page = $this->entities->page();
$this->asEditor();
$resp = $this->get($page->getUrl('/export/plaintext'));
public function test_page_pdf_export()
{
- $page = Page::query()->first();
+ $page = $this->entities->page();
$this->asEditor();
$resp = $this->get($page->getUrl('/export/pdf'));
public function test_page_html_export()
{
- $page = Page::query()->first();
+ $page = $this->entities->page();
$this->asEditor();
$resp = $this->get($page->getUrl('/export/html'));
public function test_book_text_export()
{
- $page = Page::query()->first();
- $book = $page->book;
+ $book = $this->entities->bookHasChaptersAndPages();
+ $directPage = $book->directPages()->first();
+ $chapter = $book->chapters()->first();
+ $chapterPage = $chapter->pages()->first();
+ $this->entities->updatePage($directPage, ['html' => '<p>My awesome page</p>']);
+ $this->entities->updatePage($chapterPage, ['html' => '<p>My little nested page</p>']);
$this->asEditor();
$resp = $this->get($book->getUrl('/export/plaintext'));
$resp->assertStatus(200);
$resp->assertSee($book->name);
- $resp->assertSee($page->name);
+ $resp->assertSee($chapterPage->name);
+ $resp->assertSee($chapter->name);
+ $resp->assertSee($directPage->name);
+ $resp->assertSee('My awesome page');
+ $resp->assertSee('My little nested page');
$resp->assertHeader('Content-Disposition', 'attachment; filename="' . $book->slug . '.txt"');
}
+ public function test_book_text_export_format()
+ {
+ $entities = $this->entities->createChainBelongingToUser($this->users->viewer());
+ $this->entities->updatePage($entities['page'], ['html' => '<p>My great page</p><p>Full of <strong>great</strong> stuff</p>', 'name' => 'My wonderful page!']);
+ $entities['chapter']->name = 'Export chapter';
+ $entities['chapter']->description = "A test chapter to be exported\nIt has loads of info within";
+ $entities['book']->name = 'Export Book';
+ $entities['book']->description = "This is a book with stuff to export";
+ $entities['chapter']->save();
+ $entities['book']->save();
+
+ $resp = $this->asEditor()->get($entities['book']->getUrl('/export/plaintext'));
+
+ $expected = "Export Book\nThis is a book with stuff to export\n\nExport chapter\nA test chapter to be exported\nIt has loads of info within\n\n";
+ $expected .= "My wonderful page!\nMy great page Full of great stuff";
+ $resp->assertSee($expected);
+ }
+
public function test_book_pdf_export()
{
- $page = Page::query()->first();
+ $page = $this->entities->page();
$book = $page->book;
$this->asEditor();
public function test_book_html_export()
{
- $page = Page::query()->first();
+ $page = $this->entities->page();
$book = $page->book;
$this->asEditor();
$resp->assertHeader('Content-Disposition', 'attachment; filename="' . $book->slug . '.html"');
}
- public function test_book_html_export_shows_chapter_descriptions()
+ public function test_book_html_export_shows_html_descriptions()
{
- $chapterDesc = 'My custom test chapter description ' . Str::random(12);
- $chapter = Chapter::query()->first();
- $chapter->description = $chapterDesc;
+ $book = $this->entities->bookHasChaptersAndPages();
+ $chapter = $book->chapters()->first();
+ $book->description_html = '<p>A description with <strong>HTML</strong> within!</p>';
+ $chapter->description_html = '<p>A chapter description with <strong>HTML</strong> within!</p>';
+ $book->save();
$chapter->save();
- $book = $chapter->book;
- $this->asEditor();
-
- $resp = $this->get($book->getUrl('/export/html'));
- $resp->assertSee($chapterDesc);
+ $resp = $this->asEditor()->get($book->getUrl('/export/html'));
+ $resp->assertSee($book->description_html, false);
+ $resp->assertSee($chapter->description_html, false);
}
public function test_chapter_text_export()
{
- $chapter = Chapter::query()->first();
+ $chapter = $this->entities->chapter();
$page = $chapter->pages[0];
+ $this->entities->updatePage($page, ['html' => '<p>This is content within the page!</p>']);
$this->asEditor();
$resp = $this->get($chapter->getUrl('/export/plaintext'));
$resp->assertStatus(200);
$resp->assertSee($chapter->name);
$resp->assertSee($page->name);
+ $resp->assertSee('This is content within the page!');
$resp->assertHeader('Content-Disposition', 'attachment; filename="' . $chapter->slug . '.txt"');
}
+ public function test_chapter_text_export_format()
+ {
+ $entities = $this->entities->createChainBelongingToUser($this->users->viewer());
+ $this->entities->updatePage($entities['page'], ['html' => '<p>My great page</p><p>Full of <strong>great</strong> stuff</p>', 'name' => 'My wonderful page!']);
+ $entities['chapter']->name = 'Export chapter';
+ $entities['chapter']->description = "A test chapter to be exported\nIt has loads of info within";
+ $entities['chapter']->save();
+
+ $resp = $this->asEditor()->get($entities['book']->getUrl('/export/plaintext'));
+
+ $expected = "Export chapter\nA test chapter to be exported\nIt has loads of info within\n\n";
+ $expected .= "My wonderful page!\nMy great page Full of great stuff";
+ $resp->assertSee($expected);
+ }
+
public function test_chapter_pdf_export()
{
- $chapter = Chapter::query()->first();
+ $chapter = $this->entities->chapter();
$this->asEditor();
$resp = $this->get($chapter->getUrl('/export/pdf'));
public function test_chapter_html_export()
{
- $chapter = Chapter::query()->first();
+ $chapter = $this->entities->chapter();
$page = $chapter->pages[0];
$this->asEditor();
$resp->assertHeader('Content-Disposition', 'attachment; filename="' . $chapter->slug . '.html"');
}
+ public function test_chapter_html_export_shows_html_descriptions()
+ {
+ $chapter = $this->entities->chapter();
+ $chapter->description_html = '<p>A description with <strong>HTML</strong> within!</p>';
+ $chapter->save();
+
+ $resp = $this->asEditor()->get($chapter->getUrl('/export/html'));
+ $resp->assertSee($chapter->description_html, false);
+ }
+
public function test_page_html_export_contains_custom_head_if_set()
{
- $page = Page::query()->first();
+ $page = $this->entities->page();
$customHeadContent = '<style>p{color: red;}</style>';
$this->setSettings(['app-custom-head' => $customHeadContent]);
public function test_page_html_export_does_not_break_with_only_comments_in_custom_head()
{
- $page = Page::query()->first();
+ $page = $this->entities->page();
$customHeadContent = '<!-- A comment -->';
$this->setSettings(['app-custom-head' => $customHeadContent]);
public function test_page_html_export_use_absolute_dates()
{
- $page = Page::query()->first();
+ $page = $this->entities->page();
$resp = $this->asEditor()->get($page->getUrl('/export/html'));
- $resp->assertSee($page->created_at->formatLocalized('%e %B %Y %H:%M:%S'));
+ $resp->assertSee($page->created_at->isoFormat('D MMMM Y HH:mm:ss'));
$resp->assertDontSee($page->created_at->diffForHumans());
- $resp->assertSee($page->updated_at->formatLocalized('%e %B %Y %H:%M:%S'));
+ $resp->assertSee($page->updated_at->isoFormat('D MMMM Y HH:mm:ss'));
$resp->assertDontSee($page->updated_at->diffForHumans());
}
public function test_page_export_does_not_include_user_or_revision_links()
{
- $page = Page::query()->first();
+ $page = $this->entities->page();
$resp = $this->asEditor()->get($page->getUrl('/export/html'));
$resp->assertDontSee($page->getUrl('/revisions'));
public function test_page_export_sets_right_data_type_for_svg_embeds()
{
- $page = Page::query()->first();
+ $page = $this->entities->page();
Storage::disk('local')->makeDirectory('uploads/images/gallery');
Storage::disk('local')->put('uploads/images/gallery/svg_test.svg', '<svg></svg>');
$page->html = '<img src="http://localhost/uploads/images/gallery/svg_test.svg">';
public function test_page_image_containment_works_on_multiple_images_within_a_single_line()
{
- $page = Page::query()->first();
+ $page = $this->entities->page();
Storage::disk('local')->makeDirectory('uploads/images/gallery');
Storage::disk('local')->put('uploads/images/gallery/svg_test.svg', '<svg></svg>');
Storage::disk('local')->put('uploads/images/gallery/svg_test2.svg', '<svg></svg>');
public function test_page_export_contained_html_image_fetches_only_run_when_url_points_to_image_upload_folder()
{
- $page = Page::query()->first();
+ $page = $this->entities->page();
$page->html = '<img src="http://localhost/uploads/images/gallery/svg_test.svg"/>'
. '<img src="http://localhost/uploads/svg_test.svg"/>'
. '<img src="/uploads/svg_test.svg"/>';
$contents = file_get_contents(public_path('.htaccess'));
config()->set('filesystems.images', 'local');
- $page = Page::query()->first();
+ $page = $this->entities->page();
$page->html = '<img src="http://localhost/uploads/images/../../.htaccess"/>';
$page->save();
config()->set('filesystems.images', 'local_secure');
file_put_contents($testFilePath, 'I am a cat');
- $page = Page::query()->first();
+ $page = $this->entities->page();
$page->html = '<img src="http://localhost/uploads/images/../../logs/test.txt"/>';
$page->save();
public function test_page_export_with_deleted_creator_and_updater()
{
- $user = $this->getViewer(['name' => 'ExportWizardTheFifth']);
- $page = Page::query()->first();
+ $user = $this->users->viewer(['name' => 'ExportWizardTheFifth']);
+ $page = $this->entities->page();
$page->created_by = $user->id;
$page->updated_by = $user->id;
$page->save();
public function test_page_pdf_export_opens_details_blocks()
{
- $page = Page::query()->first()->forceFill([
+ $page = $this->entities->page()->forceFill([
'html' => '<details><summary>Hello</summary><p>Content!</p></details>',
]);
$page->save();
public function test_page_markdown_export()
{
- $page = Page::query()->first();
+ $page = $this->entities->page();
$resp = $this->asEditor()->get($page->getUrl('/export/markdown'));
$resp->assertStatus(200);
public function test_page_markdown_export_uses_existing_markdown_if_apparent()
{
- $page = Page::query()->first()->forceFill([
+ $page = $this->entities->page()->forceFill([
'markdown' => '# A header',
'html' => '<h1>Dogcat</h1>',
]);
public function test_page_markdown_export_converts_html_where_no_markdown()
{
- $page = Page::query()->first()->forceFill([
+ $page = $this->entities->page()->forceFill([
'markdown' => '',
'html' => '<h1>Dogcat</h1><p>Some <strong>bold</strong> text</p>',
]);
$resp->assertSee("# Dogcat\n\nSome **bold** text");
}
- public function test_page_markdown_export_does_not_convert_callouts()
- {
- $page = Page::query()->first()->forceFill([
- 'markdown' => '',
- 'html' => '<h1>Dogcat</h1><p class="callout info">Some callout text</p><p>Another line</p>',
- ]);
- $page->save();
-
- $resp = $this->asEditor()->get($page->getUrl('/export/markdown'));
- $resp->assertSee("# Dogcat\n\n<p class=\"callout info\">Some callout text</p>\n\nAnother line", false);
- }
-
- public function test_page_markdown_export_handles_bookstacks_wysiwyg_codeblock_format()
- {
- $page = Page::query()->first()->forceFill([
- 'markdown' => '',
- 'html' => '<h1>Dogcat</h1>' . "\r\n" . '<pre id="bkmrk-var-a-%3D-%27cat%27%3B"><code class="language-JavaScript">var a = \'cat\';</code></pre><p>Another line</p>',
- ]);
- $page->save();
-
- $resp = $this->asEditor()->get($page->getUrl('/export/markdown'));
- $resp->assertSee("# Dogcat\n\n```JavaScript\nvar a = 'cat';\n```\n\nAnother line", false);
- }
-
- public function test_page_markdown_export_handles_tasklist_checkboxes()
- {
- $page = Page::query()->first()->forceFill([
- 'markdown' => '',
- 'html' => '<ul><li><input type="checkbox" checked="checked">Item A</li><li><input type="checkbox">Item B</li></ul>',
- ]);
- $page->save();
-
- $resp = $this->asEditor()->get($page->getUrl('/export/markdown'));
- $resp->assertSee("- [x] Item A\n- [ ] Item B", false);
- }
-
public function test_chapter_markdown_export()
{
- $chapter = Chapter::query()->first();
+ $chapter = $this->entities->chapter();
$page = $chapter->pages()->first();
$resp = $this->asEditor()->get($chapter->getUrl('/export/markdown'));
$pageB->save();
$resp = $this->get($book->getUrl('/export/markdown'));
- $resp->assertDontSee("hello tester# The second page in this test");
+ $resp->assertDontSee('hello tester# The second page in this test');
$resp->assertSee("hello tester\n\n# The second page in this test");
}
$chapter = $book->chapters()->first();
$page = $chapter->pages()->first();
$entities = [$book, $chapter, $page];
- $user = $this->getViewer();
+ $user = $this->users->viewer();
$this->actingAs($user);
foreach ($entities as $entity) {
$resp->assertSee('/export/pdf');
}
- /** @var Role $role */
- $this->removePermissionFromUser($user, 'content-export');
+ $this->permissions->removeUserRolePermissions($user, ['content-export']);
foreach ($entities as $entity) {
$resp = $this->get($entity->getUrl());
public function test_wkhtmltopdf_only_used_when_allow_untrusted_is_true()
{
- /** @var Page $page */
- $page = Page::query()->first();
+ $page = $this->entities->page();
config()->set('snappy.pdf.binary', '/abc123');
config()->set('app.allow_untrusted_server_fetching', false);
public function test_html_exports_contain_csp_meta_tag()
{
$entities = [
- Page::query()->first(),
- Book::query()->first(),
- Chapter::query()->first(),
+ $this->entities->page(),
+ $this->entities->book(),
+ $this->entities->chapter(),
];
foreach ($entities as $entity) {
$resp = $this->asEditor()->get($entity->getUrl('/export/html'));
- $resp->assertElementExists('head meta[http-equiv="Content-Security-Policy"][content*="script-src "]');
+ $this->withHtml($resp)->assertElementExists('head meta[http-equiv="Content-Security-Policy"][content*="script-src "]');
}
}
+
+ public function test_html_exports_contain_body_classes_for_export_identification()
+ {
+ $page = $this->entities->page();
+
+ $resp = $this->asEditor()->get($page->getUrl('/export/html'));
+ $this->withHtml($resp)->assertElementExists('body.export.export-format-html.export-engine-none');
+ }
}
projects / bookstack / blobdiff