]> BookStack Code Mirror - bookstack/blob - tests/Entity/PageEditorTest.php
Aded tests for core editor switching functionality
[bookstack] / tests / Entity / PageEditorTest.php
1 <?php
2
3 namespace Tests\Entity;
4
5 use BookStack\Entities\Models\Book;
6 use BookStack\Entities\Models\Chapter;
7 use BookStack\Entities\Models\Page;
8 use Tests\TestCase;
9
10 class PageEditorTest extends TestCase
11 {
12     /** @var Page */
13     protected $page;
14
15     protected function setUp(): void
16     {
17         parent::setUp();
18         $this->page = Page::query()->first();
19     }
20
21     public function test_default_editor_is_wysiwyg()
22     {
23         $this->assertEquals('wysiwyg', setting('app-editor'));
24         $this->asAdmin()->get($this->page->getUrl() . '/edit')
25             ->assertElementExists('#html-editor');
26     }
27
28     public function test_markdown_setting_shows_markdown_editor()
29     {
30         $this->setSettings(['app-editor' => 'markdown']);
31         $this->asAdmin()->get($this->page->getUrl() . '/edit')
32             ->assertElementNotExists('#html-editor')
33             ->assertElementExists('#markdown-editor');
34     }
35
36     public function test_markdown_content_given_to_editor()
37     {
38         $this->setSettings(['app-editor' => 'markdown']);
39
40         $mdContent = '# hello. This is a test';
41         $this->page->markdown = $mdContent;
42         $this->page->save();
43
44         $this->asAdmin()->get($this->page->getUrl() . '/edit')
45             ->assertElementContains('[name="markdown"]', $mdContent);
46     }
47
48     public function test_html_content_given_to_editor_if_no_markdown()
49     {
50         $this->setSettings(['app-editor' => 'markdown']);
51         $this->asAdmin()->get($this->page->getUrl() . '/edit')
52             ->assertElementContains('[name="markdown"]', $this->page->html);
53     }
54
55     public function test_empty_markdown_still_saves_without_error()
56     {
57         $this->setSettings(['app-editor' => 'markdown']);
58         /** @var Book $book */
59         $book = Book::query()->first();
60
61         $this->asEditor()->get($book->getUrl('/create-page'));
62         $draft = Page::query()->where('book_id', '=', $book->id)
63             ->where('draft', '=', true)->first();
64
65         $details = [
66             'name'     => 'my page',
67             'markdown' => '',
68         ];
69         $resp = $this->post($book->getUrl("/draft/{$draft->id}"), $details);
70         $resp->assertRedirect();
71
72         $this->assertDatabaseHas('pages', [
73             'markdown' => $details['markdown'],
74             'id'       => $draft->id,
75             'draft'    => false,
76         ]);
77     }
78
79     public function test_back_link_in_editor_has_correct_url()
80     {
81         /** @var Book $book */
82         $book = Book::query()->whereHas('pages')->whereHas('chapters')->firstOrFail();
83         $this->asEditor()->get($book->getUrl('/create-page'));
84         /** @var Chapter $chapter */
85         $chapter = $book->chapters()->firstOrFail();
86         /** @var Page $draft */
87         $draft = $book->pages()->where('draft', '=', true)->firstOrFail();
88
89         // Book draft goes back to book
90         $resp = $this->get($book->getUrl("/draft/{$draft->id}"));
91         $resp->assertElementContains('a[href="' . $book->getUrl() . '"]', 'Back');
92
93         // Chapter draft goes back to chapter
94         $draft->chapter_id = $chapter->id;
95         $draft->save();
96         $resp = $this->get($book->getUrl("/draft/{$draft->id}"));
97         $resp->assertElementContains('a[href="' . $chapter->getUrl() . '"]', 'Back');
98
99         // Saved page goes back to page
100         $this->post($book->getUrl("/draft/{$draft->id}"), ['name' => 'Updated', 'html' => 'Updated']);
101         $draft->refresh();
102         $resp = $this->get($draft->getUrl('/edit'));
103         $resp->assertElementContains('a[href="' . $draft->getUrl() . '"]', 'Back');
104     }
105
106     public function test_switching_from_html_to_clean_markdown_works()
107     {
108         /** @var Page $page */
109         $page = Page::query()->first();
110         $page->html = '<h2>A Header</h2><p>Some <strong>bold</strong> content.</p>';
111         $page->save();
112
113         $resp = $this->asAdmin()->get($page->getUrl('/edit?editor=markdown-clean'));
114         $resp->assertStatus(200);
115         $resp->assertSee("## A Header\n\nSome **bold** content.");
116         $resp->assertElementExists('#markdown-editor');
117     }
118
119     public function test_switching_from_html_to_stable_markdown_works()
120     {
121         /** @var Page $page */
122         $page = Page::query()->first();
123         $page->html = '<h2>A Header</h2><p>Some <strong>bold</strong> content.</p>';
124         $page->save();
125
126         $resp = $this->asAdmin()->get($page->getUrl('/edit?editor=markdown-stable'));
127         $resp->assertStatus(200);
128         $resp->assertSee("<h2>A Header</h2><p>Some <strong>bold</strong> content.</p>", true);
129         $resp->assertElementExists('[component="markdown-editor"]');
130     }
131
132     public function test_switching_from_markdown_to_wysiwyg_works()
133     {
134         /** @var Page $page */
135         $page = Page::query()->first();
136         $page->html = '';
137         $page->markdown = "## A Header\n\nSome content with **bold** text!";
138         $page->save();
139
140         $resp = $this->asAdmin()->get($page->getUrl('/edit?editor=wysiwyg'));
141         $resp->assertStatus(200);
142         $resp->assertElementExists('[component="wysiwyg-editor"]');
143         $resp->assertSee("<h2>A Header</h2>\n<p>Some content with <strong>bold</strong> text!</p>", true);
144     }
145
146     public function test_page_editor_depends_on_content_type()
147     {
148         /** @var Page $page */
149         $page = Page::query()->first();
150
151         $resp = $this->asAdmin()->get($page->getUrl('/edit'));
152         $resp->assertElementExists('[component="wysiwyg-editor"]');
153
154         $page->html = '';
155         $page->markdown = "## A Header\n\nSome content with **bold** text!";
156         $page->save();
157
158         $resp = $this->asAdmin()->get($page->getUrl('/edit'));
159         $resp->assertElementExists('[component="markdown-editor"]');
160     }
161
162     public function test_editor_type_switch_options_show()
163     {
164         /** @var Page $page */
165         $page = Page::query()->first();
166
167         $resp = $this->asAdmin()->get($page->getUrl('/edit'));
168         $editLink = $page->getUrl('/edit') . '?editor=';
169         $resp->assertElementContains("a[href=\"${editLink}markdown-clean\"]", '(Clean Content)');
170         $resp->assertElementContains("a[href=\"${editLink}markdown-stable\"]", '(Stable Content)');
171
172         $resp = $this->asAdmin()->get($page->getUrl('/edit?editor=markdown-stable'));
173         $editLink = $page->getUrl('/edit') . '?editor=';
174         $resp->assertElementContains("a[href=\"${editLink}wysiwyg\"]", 'Switch to WYSIWYG Editor');
175     }
176
177     public function test_editor_type_switch_options_dont_show_if_without_change_editor_permissions()
178     {
179         /** @var Page $page */
180         $page = Page::query()->first();
181
182         $resp = $this->asEditor()->get($page->getUrl('/edit'));
183         $editLink = $page->getUrl('/edit') . '?editor=';
184         $resp->assertElementNotExists("a[href*=\"${editLink}\"]");
185     }
186
187 }