namespace Tests\Entity;
-use BookStack\Auth\Role;
use BookStack\Entities\Models\Book;
use BookStack\Entities\Models\Chapter;
use BookStack\Entities\Models\Page;
use BookStack\Entities\Tools\PdfGenerator;
+use BookStack\Exceptions\PdfExportException;
use Illuminate\Support\Facades\Storage;
-use Illuminate\Support\Str;
use Tests\TestCase;
class ExportTest extends TestCase
public function test_book_text_export()
{
- $page = $this->entities->page();
- $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 = $this->entities->page();
$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 = $this->entities->chapter();
- $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 = $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 = $this->entities->chapter();
$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 = $this->entities->page();
public function test_page_export_with_deleted_creator_and_updater()
{
- $user = $this->getViewer(['name' => 'ExportWizardTheFifth']);
+ $user = $this->users->viewer(['name' => 'ExportWizardTheFifth']);
$page = $this->entities->page();
$page->created_by = $user->id;
$page->updated_by = $user->id;
$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());
{
$page = $this->entities->page();
- config()->set('snappy.pdf.binary', '/abc123');
+ config()->set('exports.snappy.pdf_binary', '/abc123');
config()->set('app.allow_untrusted_server_fetching', false);
$resp = $this->asEditor()->get($page->getUrl('/export/pdf'));
$resp->assertStatus(500); // Bad response indicates wkhtml usage
}
+ public function test_pdf_command_option_used_if_set()
+ {
+ $page = $this->entities->page();
+ $command = 'cp {input_html_path} {output_pdf_path}';
+ config()->set('exports.pdf_command', $command);
+
+ $resp = $this->asEditor()->get($page->getUrl('/export/pdf'));
+ $download = $resp->getContent();
+
+ $this->assertStringContainsString(e($page->name), $download);
+ $this->assertStringContainsString('<html lang=', $download);
+ }
+
+ public function test_pdf_command_option_errors_if_output_path_not_written_to()
+ {
+ $page = $this->entities->page();
+ $command = 'echo "hi"';
+ config()->set('exports.pdf_command', $command);
+
+ $this->assertThrows(function () use ($page) {
+ $this->withoutExceptionHandling()->asEditor()->get($page->getUrl('/export/pdf'));
+ }, PdfExportException::class);
+ }
+
+ public function test_pdf_command_option_errors_if_command_returns_error_status()
+ {
+ $page = $this->entities->page();
+ $command = 'exit 1';
+ config()->set('exports.pdf_command', $command);
+
+ $this->assertThrows(function () use ($page) {
+ $this->withoutExceptionHandling()->asEditor()->get($page->getUrl('/export/pdf'));
+ }, PdfExportException::class);
+ }
+
+ public function test_pdf_command_timout_option_limits_export_time()
+ {
+ $page = $this->entities->page();
+ $command = 'php -r \'sleep(4);\'';
+ config()->set('exports.pdf_command', $command);
+ config()->set('exports.pdf_command_timeout', 1);
+
+ $this->assertThrows(function () use ($page) {
+ $start = time();
+ $this->withoutExceptionHandling()->asEditor()->get($page->getUrl('/export/pdf'));
+
+ $this->assertTrue(time() < ($start + 3));
+ }, PdfExportException::class,
+ "PDF Export via command failed due to timeout at 1 second(s)");
+ }
+
public function test_html_exports_contain_csp_meta_tag()
{
$entities = [
projects / bookstack / blobdiff