X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/b546098b365b611b34c004e120c543efb9311d2e..refs/pull/5280/head:/tests/Entity/PageEditorTest.php diff --git a/tests/Entity/PageEditorTest.php b/tests/Entity/PageEditorTest.php index c06aa5bf1..21abd4ba1 100644 --- a/tests/Entity/PageEditorTest.php +++ b/tests/Entity/PageEditorTest.php @@ -2,61 +2,77 @@ namespace Tests\Entity; -use BookStack\Entities\Models\Book; use BookStack\Entities\Models\Chapter; use BookStack\Entities\Models\Page; +use BookStack\Entities\Tools\PageEditorType; use Tests\TestCase; class PageEditorTest extends TestCase { - /** @var Page */ - protected $page; + protected Page $page; protected function setUp(): void { parent::setUp(); - $this->page = Page::query()->first(); + $this->page = $this->entities->page(); } - public function test_default_editor_is_wysiwyg() + public function test_default_editor_is_wysiwyg_for_new_pages() { $this->assertEquals('wysiwyg', setting('app-editor')); - $this->asAdmin()->get($this->page->getUrl() . '/edit') - ->assertElementExists('#html-editor'); + $resp = $this->asAdmin()->get($this->page->book->getUrl('/create-page')); + $this->withHtml($this->followRedirects($resp))->assertElementExists('#html-editor'); } - public function test_markdown_setting_shows_markdown_editor() + public function test_editor_set_for_new_pages() { - $this->setSettings(['app-editor' => 'markdown']); - $this->asAdmin()->get($this->page->getUrl() . '/edit') + $book = $this->page->book; + + $this->asEditor()->get($book->getUrl('/create-page')); + $newPage = $book->pages()->orderBy('id', 'desc')->first(); + $this->assertEquals('wysiwyg', $newPage->editor); + + $this->setSettings(['app-editor' => PageEditorType::Markdown->value]); + + $this->asEditor()->get($book->getUrl('/create-page')); + $newPage = $book->pages()->orderBy('id', 'desc')->first(); + $this->assertEquals('markdown', $newPage->editor); + } + + public function test_markdown_setting_shows_markdown_editor_for_new_pages() + { + $this->setSettings(['app-editor' => PageEditorType::Markdown->value]); + + $resp = $this->asAdmin()->get($this->page->book->getUrl('/create-page')); + $this->withHtml($this->followRedirects($resp)) ->assertElementNotExists('#html-editor') ->assertElementExists('#markdown-editor'); } public function test_markdown_content_given_to_editor() { - $this->setSettings(['app-editor' => 'markdown']); - $mdContent = '# hello. This is a test'; $this->page->markdown = $mdContent; + $this->page->editor = PageEditorType::Markdown; $this->page->save(); - $this->asAdmin()->get($this->page->getUrl() . '/edit') - ->assertElementContains('[name="markdown"]', $mdContent); + $resp = $this->asAdmin()->get($this->page->getUrl('/edit')); + $this->withHtml($resp)->assertElementContains('[name="markdown"]', $mdContent); } public function test_html_content_given_to_editor_if_no_markdown() { - $this->setSettings(['app-editor' => 'markdown']); - $this->asAdmin()->get($this->page->getUrl() . '/edit') - ->assertElementContains('[name="markdown"]', $this->page->html); + $this->page->editor = 'markdown'; + $this->page->save(); + + $resp = $this->asAdmin()->get($this->page->getUrl() . '/edit'); + $this->withHtml($resp)->assertElementContains('[name="markdown"]', $this->page->html); } public function test_empty_markdown_still_saves_without_error() { $this->setSettings(['app-editor' => 'markdown']); - /** @var Book $book */ - $book = Book::query()->first(); + $book = $this->entities->book(); $this->asEditor()->get($book->getUrl('/create-page')); $draft = Page::query()->where('book_id', '=', $book->id) @@ -78,8 +94,7 @@ class PageEditorTest extends TestCase public function test_back_link_in_editor_has_correct_url() { - /** @var Book $book */ - $book = Book::query()->whereHas('pages')->whereHas('chapters')->firstOrFail(); + $book = $this->entities->bookHasChaptersAndPages(); $this->asEditor()->get($book->getUrl('/create-page')); /** @var Chapter $chapter */ $chapter = $book->chapters()->firstOrFail(); @@ -88,18 +103,166 @@ class PageEditorTest extends TestCase // Book draft goes back to book $resp = $this->get($book->getUrl("/draft/{$draft->id}")); - $resp->assertElementContains('a[href="' . $book->getUrl() . '"]', 'Back'); + $this->withHtml($resp)->assertElementContains('a[href="' . $book->getUrl() . '"]', 'Back'); // Chapter draft goes back to chapter $draft->chapter_id = $chapter->id; $draft->save(); $resp = $this->get($book->getUrl("/draft/{$draft->id}")); - $resp->assertElementContains('a[href="' . $chapter->getUrl() . '"]', 'Back'); + $this->withHtml($resp)->assertElementContains('a[href="' . $chapter->getUrl() . '"]', 'Back'); // Saved page goes back to page $this->post($book->getUrl("/draft/{$draft->id}"), ['name' => 'Updated', 'html' => 'Updated']); $draft->refresh(); $resp = $this->get($draft->getUrl('/edit')); - $resp->assertElementContains('a[href="' . $draft->getUrl() . '"]', 'Back'); + $this->withHtml($resp)->assertElementContains('a[href="' . $draft->getUrl() . '"]', 'Back'); + } + + public function test_switching_from_html_to_clean_markdown_works() + { + $page = $this->entities->page(); + $page->html = '

A Header

Some bold content.

'; + $page->save(); + + $resp = $this->asAdmin()->get($page->getUrl('/edit?editor=markdown-clean')); + $resp->assertStatus(200); + $resp->assertSee("## A Header\n\nSome **bold** content."); + $this->withHtml($resp)->assertElementExists('#markdown-editor'); + } + + public function test_switching_from_html_to_stable_markdown_works() + { + $page = $this->entities->page(); + $page->html = '

A Header

Some bold content.

'; + $page->save(); + + $resp = $this->asAdmin()->get($page->getUrl('/edit?editor=markdown-stable')); + $resp->assertStatus(200); + $resp->assertSee('

A Header

Some bold content.

', true); + $this->withHtml($resp)->assertElementExists('[component="markdown-editor"]'); + } + + public function test_switching_from_markdown_to_wysiwyg_works() + { + $page = $this->entities->page(); + $page->html = ''; + $page->markdown = "## A Header\n\nSome content with **bold** text!"; + $page->save(); + + $resp = $this->asAdmin()->get($page->getUrl('/edit?editor=wysiwyg')); + $resp->assertStatus(200); + $this->withHtml($resp)->assertElementExists('[component="wysiwyg-editor-tinymce"]'); + $resp->assertSee("

A Header

\n

Some content with bold text!

", true); + } + + public function test_switching_from_markdown_to_wysiwyg2024_works() + { + $page = $this->entities->page(); + $page->html = ''; + $page->markdown = "## A Header\n\nSome content with **bold** text!"; + $page->save(); + + $resp = $this->asAdmin()->get($page->getUrl('/edit?editor=wysiwyg2024')); + $resp->assertStatus(200); + $this->withHtml($resp)->assertElementExists('[component="wysiwyg-editor"]'); + $resp->assertSee("

A Header

\n

Some content with bold text!

", true); + } + + public function test_page_editor_changes_with_editor_property() + { + $resp = $this->asAdmin()->get($this->page->getUrl('/edit')); + $this->withHtml($resp)->assertElementExists('[component="wysiwyg-editor-tinymce"]'); + + $this->page->markdown = "## A Header\n\nSome content with **bold** text!"; + $this->page->editor = 'markdown'; + $this->page->save(); + + $resp = $this->asAdmin()->get($this->page->getUrl('/edit')); + $this->withHtml($resp)->assertElementExists('[component="markdown-editor"]'); + + $this->page->editor = 'wysiwyg2024'; + $this->page->save(); + + $resp = $this->asAdmin()->get($this->page->getUrl('/edit')); + $this->withHtml($resp)->assertElementExists('[component="wysiwyg-editor"]'); + } + + public function test_editor_type_switch_options_show() + { + $resp = $this->asAdmin()->get($this->page->getUrl('/edit')); + $editLink = $this->page->getUrl('/edit') . '?editor='; + $this->withHtml($resp)->assertElementContains("a[href=\"${editLink}markdown-clean\"]", '(Clean Content)'); + $this->withHtml($resp)->assertElementContains("a[href=\"${editLink}markdown-stable\"]", '(Stable Content)'); + $this->withHtml($resp)->assertElementContains("a[href=\"${editLink}wysiwyg2024\"]", '(In Alpha Testing)'); + + $resp = $this->asAdmin()->get($this->page->getUrl('/edit?editor=markdown-stable')); + $editLink = $this->page->getUrl('/edit') . '?editor='; + $this->withHtml($resp)->assertElementContains("a[href=\"${editLink}wysiwyg\"]", 'Switch to WYSIWYG Editor'); + } + + public function test_editor_type_switch_options_dont_show_if_without_change_editor_permissions() + { + $resp = $this->asEditor()->get($this->page->getUrl('/edit')); + $editLink = $this->page->getUrl('/edit') . '?editor='; + $this->withHtml($resp)->assertElementNotExists("a[href*=\"${editLink}\"]"); + } + + public function test_page_editor_type_switch_does_not_work_without_change_editor_permissions() + { + $page = $this->entities->page(); + $page->html = '

A Header

Some bold content.

'; + $page->save(); + + $resp = $this->asEditor()->get($page->getUrl('/edit?editor=markdown-stable')); + $resp->assertStatus(200); + $this->withHtml($resp)->assertElementExists('[component="wysiwyg-editor-tinymce"]'); + $this->withHtml($resp)->assertElementNotExists('[component="markdown-editor"]'); + } + + public function test_page_save_does_not_change_active_editor_without_change_editor_permissions() + { + $page = $this->entities->page(); + $page->html = '

A Header

Some bold content.

'; + $page->editor = 'wysiwyg'; + $page->save(); + + $this->asEditor()->put($page->getUrl(), ['name' => $page->name, 'markdown' => '## Updated content abc']); + $this->assertEquals('wysiwyg', $page->refresh()->editor); + } + + public function test_editor_type_change_to_wysiwyg_infers_type_from_request_or_uses_system_default() + { + $tests = [ + [ + 'setting' => 'wysiwyg', + 'request' => 'wysiwyg2024', + 'expected' => 'wysiwyg2024', + ], + [ + 'setting' => 'wysiwyg2024', + 'request' => 'wysiwyg', + 'expected' => 'wysiwyg', + ], + [ + 'setting' => 'wysiwyg', + 'request' => null, + 'expected' => 'wysiwyg', + ], + [ + 'setting' => 'wysiwyg2024', + 'request' => null, + 'expected' => 'wysiwyg2024', + ] + ]; + + $page = $this->entities->page(); + foreach ($tests as $test) { + $page->editor = 'markdown'; + $page->save(); + + $this->setSettings(['app-editor' => $test['setting']]); + $this->asAdmin()->put($page->getUrl(), ['name' => $page->name, 'html' => '

Hello

', 'editor' => $test['request']]); + $this->assertEquals($test['expected'], $page->refresh()->editor, "Failed asserting global editor {$test['setting']} with request editor {$test['request']} results in {$test['expected']} set for the page"); + } } }