BookStack Code Mirror - bookstack/blob - 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_for_new_pages()
  22     {
  23         $this->assertEquals('wysiwyg', setting('app-editor'));
  24         $resp = $this->asAdmin()->get($this->page->book->getUrl('/create-page'));
  25         $this->followRedirects($resp)->assertElementExists('#html-editor');
  26     }
  27
  28     public function test_markdown_setting_shows_markdown_editor_for_new_pages()
  29     {
  30         $this->setSettings(['app-editor' => 'markdown']);
  31
  32         $resp = $this->asAdmin()->get($this->page->book->getUrl('/create-page'));
  33         $this->followRedirects($resp)
  34             ->assertElementNotExists('#html-editor')
  35             ->assertElementExists('#markdown-editor');
  36     }
  37
  38     public function test_markdown_content_given_to_editor()
  39     {
  40         $mdContent = '# hello. This is a test';
  41         $this->page->markdown = $mdContent;
  42         $this->page->editor = 'markdown';
  43         $this->page->save();
  44
  45         $this->asAdmin()->get($this->page->getUrl('/edit'))
  46             ->assertElementContains('[name="markdown"]', $mdContent);
  47     }
  48
  49     public function test_html_content_given_to_editor_if_no_markdown()
  50     {
  51         $this->page->editor = 'markdown';
  52         $this->page->save();
  53
  54         $this->asAdmin()->get($this->page->getUrl() . '/edit')
  55             ->assertElementContains('[name="markdown"]', $this->page->html);
  56     }
  57
  58     public function test_empty_markdown_still_saves_without_error()
  59     {
  60         $this->setSettings(['app-editor' => 'markdown']);
  61         /** @var Book $book */
  62         $book = Book::query()->first();
  63
  64         $this->asEditor()->get($book->getUrl('/create-page'));
  65         $draft = Page::query()->where('book_id', '=', $book->id)
  66             ->where('draft', '=', true)->first();
  67
  68         $details = [
  69             'name'     => 'my page',
  70             'markdown' => '',
  71         ];
  72         $resp = $this->post($book->getUrl("/draft/{$draft->id}"), $details);
  73         $resp->assertRedirect();
  74
  75         $this->assertDatabaseHas('pages', [
  76             'markdown' => $details['markdown'],
  77             'id'       => $draft->id,
  78             'draft'    => false,
  79         ]);
  80     }
  81
  82     public function test_back_link_in_editor_has_correct_url()
  83     {
  84         /** @var Book $book */
  85         $book = Book::query()->whereHas('pages')->whereHas('chapters')->firstOrFail();
  86         $this->asEditor()->get($book->getUrl('/create-page'));
  87         /** @var Chapter $chapter */
  88         $chapter = $book->chapters()->firstOrFail();
  89         /** @var Page $draft */
  90         $draft = $book->pages()->where('draft', '=', true)->firstOrFail();
  91
  92         // Book draft goes back to book
  93         $resp = $this->get($book->getUrl("/draft/{$draft->id}"));
  94         $resp->assertElementContains('a[href="' . $book->getUrl() . '"]', 'Back');
  95
  96         // Chapter draft goes back to chapter
  97         $draft->chapter_id = $chapter->id;
  98         $draft->save();
  99         $resp = $this->get($book->getUrl("/draft/{$draft->id}"));
 100         $resp->assertElementContains('a[href="' . $chapter->getUrl() . '"]', 'Back');
 101
 102         // Saved page goes back to page
 103         $this->post($book->getUrl("/draft/{$draft->id}"), ['name' => 'Updated', 'html' => 'Updated']);
 104         $draft->refresh();
 105         $resp = $this->get($draft->getUrl('/edit'));
 106         $resp->assertElementContains('a[href="' . $draft->getUrl() . '"]', 'Back');
 107     }
 108
 109     public function test_switching_from_html_to_clean_markdown_works()
 110     {
 111         /** @var Page $page */
 112         $page = Page::query()->first();
 113         $page->html = '<h2>A Header</h2><p>Some <strong>bold</strong> content.</p>';
 114         $page->save();
 115
 116         $resp = $this->asAdmin()->get($page->getUrl('/edit?editor=markdown-clean'));
 117         $resp->assertStatus(200);
 118         $resp->assertSee("## A Header\n\nSome **bold** content.");
 119         $resp->assertElementExists('#markdown-editor');
 120     }
 121
 122     public function test_switching_from_html_to_stable_markdown_works()
 123     {
 124         /** @var Page $page */
 125         $page = Page::query()->first();
 126         $page->html = '<h2>A Header</h2><p>Some <strong>bold</strong> content.</p>';
 127         $page->save();
 128
 129         $resp = $this->asAdmin()->get($page->getUrl('/edit?editor=markdown-stable'));
 130         $resp->assertStatus(200);
 131         $resp->assertSee("<h2>A Header</h2><p>Some <strong>bold</strong> content.</p>", true);
 132         $resp->assertElementExists('[component="markdown-editor"]');
 133     }
 134
 135     public function test_switching_from_markdown_to_wysiwyg_works()
 136     {
 137         /** @var Page $page */
 138         $page = Page::query()->first();
 139         $page->html = '';
 140         $page->markdown = "## A Header\n\nSome content with **bold** text!";
 141         $page->save();
 142
 143         $resp = $this->asAdmin()->get($page->getUrl('/edit?editor=wysiwyg'));
 144         $resp->assertStatus(200);
 145         $resp->assertElementExists('[component="wysiwyg-editor"]');
 146         $resp->assertSee("<h2>A Header</h2>\n<p>Some content with <strong>bold</strong> text!</p>", true);
 147     }
 148
 149     public function test_page_editor_changes_with_editor_property()
 150     {
 151         $resp = $this->asAdmin()->get($this->page->getUrl('/edit'));
 152         $resp->assertElementExists('[component="wysiwyg-editor"]');
 153
 154         $this->page->markdown = "## A Header\n\nSome content with **bold** text!";
 155         $this->page->editor = 'markdown';
 156         $this->page->save();
 157
 158         $resp = $this->asAdmin()->get($this->page->getUrl('/edit'));
 159         $resp->assertElementExists('[component="markdown-editor"]');
 160     }
 161
 162     public function test_editor_type_switch_options_show()
 163     {
 164         $resp = $this->asAdmin()->get($this->page->getUrl('/edit'));
 165         $editLink = $this->page->getUrl('/edit') . '?editor=';
 166         $resp->assertElementContains("a[href=\"${editLink}markdown-clean\"]", '(Clean Content)');
 167         $resp->assertElementContains("a[href=\"${editLink}markdown-stable\"]", '(Stable Content)');
 168
 169         $resp = $this->asAdmin()->get($this->page->getUrl('/edit?editor=markdown-stable'));
 170         $editLink = $this->page->getUrl('/edit') . '?editor=';
 171         $resp->assertElementContains("a[href=\"${editLink}wysiwyg\"]", 'Switch to WYSIWYG Editor');
 172     }
 173
 174     public function test_editor_type_switch_options_dont_show_if_without_change_editor_permissions()
 175     {
 176         $resp = $this->asEditor()->get($this->page->getUrl('/edit'));
 177         $editLink = $this->page->getUrl('/edit') . '?editor=';
 178         $resp->assertElementNotExists("a[href*=\"${editLink}\"]");
 179     }
 180
 181     public function test_page_editor_type_switch_does_not_work_without_change_editor_permissions()
 182     {
 183         /** @var Page $page */
 184         $page = Page::query()->first();
 185         $page->html = '<h2>A Header</h2><p>Some <strong>bold</strong> content.</p>';
 186         $page->save();
 187
 188         $resp = $this->asEditor()->get($page->getUrl('/edit?editor=markdown-stable'));
 189         $resp->assertStatus(200);
 190         $resp->assertElementExists('[component="wysiwyg-editor"]');
 191         $resp->assertElementNotExists('[component="markdown-editor"]');
 192     }
 193
 194     public function test_page_save_does_not_change_active_editor_without_change_editor_permissions()
 195     {
 196         /** @var Page $page */
 197         $page = Page::query()->first();
 198         $page->html = '<h2>A Header</h2><p>Some <strong>bold</strong> content.</p>';
 199         $page->editor = 'wysiwyg';
 200         $page->save();
 201
 202         $this->asEditor()->put($page->getUrl(), ['name' => $page->name, 'markdown' => '## Updated content abc']);
 203         $this->assertEquals('wysiwyg', $page->refresh()->editor);
 204     }
 205
 206 }