Tests: Updated comment test to account for new editor usage

[bookstack] / tests / HomepageTest.php

diff --git a/tests/HomepageTest.php b/tests/HomepageTest.php
index 900650a70537eaddd6da5b4d68a8d28dc91b1155..977ae5256df0038875287eb0bfd8c47b1235838e 100644 (file)
--- a/tests/HomepageTest.php
+++ b/tests/HomepageTest.php
@@ -2,10 +2,8 @@
 
 namespace Tests;
 
 
 namespace Tests;
 

-use BookStack\Auth\Role;
-use BookStack\Auth\User;
-use BookStack\Entities\Models\Bookshelf;
-use BookStack\Entities\Models\Page;
+use BookStack\Users\Models\Role;
+use BookStack\Users\Models\User;

 
 class HomepageTest extends TestCase
 {
 
 class HomepageTest extends TestCase
 {


@@ -24,7 +22,7 @@ class HomepageTest extends TestCase
         $this->asEditor();
         $name = 'My custom homepage';
         $content = str_repeat('This is the body content of my custom homepage.', 20);
         $this->asEditor();
         $name = 'My custom homepage';
         $content = str_repeat('This is the body content of my custom homepage.', 20);

-        $customPage = $this->newPage(['name' => $name, 'html' => $content]);
+        $customPage = $this->entities->newPage(['name' => $name, 'html' => $content]);

         $this->setSettings(['app-homepage' => $customPage->id]);
         $this->setSettings(['app-homepage-type' => 'page']);
 
         $this->setSettings(['app-homepage' => $customPage->id]);
         $this->setSettings(['app-homepage-type' => 'page']);
 


@@ -41,7 +39,7 @@ class HomepageTest extends TestCase
         $this->asEditor();
         $name = 'My custom homepage';
         $content = str_repeat('This is the body content of my custom homepage.', 20);
         $this->asEditor();
         $name = 'My custom homepage';
         $content = str_repeat('This is the body content of my custom homepage.', 20);

-        $customPage = $this->newPage(['name' => $name, 'html' => $content]);
+        $customPage = $this->entities->newPage(['name' => $name, 'html' => $content]);

         $this->setSettings([
             'app-homepage'      => $customPage->id,
             'app-homepage-type' => 'page',
         $this->setSettings([
             'app-homepage'      => $customPage->id,
             'app-homepage-type' => 'page',


@@ -49,7 +47,7 @@ class HomepageTest extends TestCase
 
         $homeVisit = $this->get('/');
         $homeVisit->assertSee($name);
 
         $homeVisit = $this->get('/');
         $homeVisit->assertSee($name);

-        $homeVisit->assertElementNotExists('#home-default');
+        $this->withHtml($homeVisit)->assertElementNotExists('#home-default');

 
         $pageDeleteReq = $this->delete($customPage->getUrl());
         $pageDeleteReq->assertStatus(302);
 
         $pageDeleteReq = $this->delete($customPage->getUrl());
         $pageDeleteReq->assertStatus(302);


@@ -67,7 +65,7 @@ class HomepageTest extends TestCase
         $this->asEditor();
         $name = 'My custom homepage';
         $content = str_repeat('This is the body content of my custom homepage.', 20);
         $this->asEditor();
         $name = 'My custom homepage';
         $content = str_repeat('This is the body content of my custom homepage.', 20);

-        $customPage = $this->newPage(['name' => $name, 'html' => $content]);
+        $customPage = $this->entities->newPage(['name' => $name, 'html' => $content]);

         $this->setSettings([
             'app-homepage'      => $customPage->id,
             'app-homepage-type' => 'default',
         $this->setSettings([
             'app-homepage'      => $customPage->id,
             'app-homepage-type' => 'default',


@@ -81,8 +79,7 @@ class HomepageTest extends TestCase
 
     public function test_custom_homepage_cannot_be_deleted_from_parent_deletion()
     {
 
     public function test_custom_homepage_cannot_be_deleted_from_parent_deletion()
     {

-        /** @var Page $page */
-        $page = Page::query()->first();
+        $page = $this->entities->page();

         $this->setSettings([
             'app-homepage'      => $page->id,
             'app-homepage-type' => 'page',
         $this->setSettings([
             'app-homepage'      => $page->id,
             'app-homepage-type' => 'page',


@@ -100,14 +97,13 @@ class HomepageTest extends TestCase
     public function test_custom_homepage_renders_includes()
     {
         $this->asEditor();
     public function test_custom_homepage_renders_includes()
     {
         $this->asEditor();

-        /** @var Page $included */
-        $included = Page::query()->first();
+        $included = $this->entities->page();

         $content = str_repeat('This is the body content of my custom homepage.', 20);
         $included->html = $content;
         $included->save();
 
         $name = 'My custom homepage';
         $content = str_repeat('This is the body content of my custom homepage.', 20);
         $included->html = $content;
         $included->save();
 
         $name = 'My custom homepage';

-        $customPage = $this->newPage(['name' => $name, 'html' => '{{@' . $included->id . '}}']);
+        $customPage = $this->entities->newPage(['name' => $name, 'html' => '{{@' . $included->id . '}}']);

         $this->setSettings(['app-homepage' => $customPage->id]);
         $this->setSettings(['app-homepage-type' => 'page']);
 
         $this->setSettings(['app-homepage' => $customPage->id]);
         $this->setSettings(['app-homepage-type' => 'page']);
 


@@ -118,7 +114,7 @@ class HomepageTest extends TestCase
 
     public function test_set_book_homepage()
     {
 
     public function test_set_book_homepage()
     {

-        $editor = $this->getEditor();
+        $editor = $this->users->editor();

         setting()->putUser($editor, 'books_view_type', 'grid');
 
         $this->setSettings(['app-homepage-type' => 'books']);
         setting()->putUser($editor, 'books_view_type', 'grid');
 
         $this->setSettings(['app-homepage-type' => 'books']);


@@ -130,16 +126,13 @@ class HomepageTest extends TestCase
         $homeVisit->assertSee('grid-card-content');
         $homeVisit->assertSee('grid-card-footer');
         $homeVisit->assertSee('featured-image-container');
         $homeVisit->assertSee('grid-card-content');
         $homeVisit->assertSee('grid-card-footer');
         $homeVisit->assertSee('featured-image-container');

-
-        $this->setSettings(['app-homepage-type' => false]);
-        $this->test_default_homepage_visible();

     }
 
     public function test_set_bookshelves_homepage()
     {
     }
 
     public function test_set_bookshelves_homepage()
     {

-        $editor = $this->getEditor();
+        $editor = $this->users->editor();

         setting()->putUser($editor, 'bookshelves_view_type', 'grid');
         setting()->putUser($editor, 'bookshelves_view_type', 'grid');

-        $shelf = Bookshelf::query()->firstOrFail();
+        $shelf = $this->entities->shelf();

 
         $this->setSettings(['app-homepage-type' => 'bookshelves']);
 
 
         $this->setSettings(['app-homepage-type' => 'bookshelves']);
 


@@ -148,39 +141,49 @@ class HomepageTest extends TestCase
         $homeVisit->assertSee('Shelves');
         $homeVisit->assertSee('grid-card-content');
         $homeVisit->assertSee('featured-image-container');
         $homeVisit->assertSee('Shelves');
         $homeVisit->assertSee('grid-card-content');
         $homeVisit->assertSee('featured-image-container');

-        $homeVisit->assertElementContains('.grid-card', $shelf->name);
+        $this->withHtml($homeVisit)->assertElementContains('.grid-card', $shelf->name);
+    }
+
+    public function test_books_and_bookshelves_homepage_has_expected_actions()
+    {
+        $this->asEditor();
+
+        foreach (['bookshelves', 'books'] as $homepageType) {
+            $this->setSettings(['app-homepage-type' => $homepageType]);

 
 

-        $this->setSettings(['app-homepage-type' => false]);
-        $this->test_default_homepage_visible();
+            $html = $this->withHtml($this->get('/'));
+            $html->assertElementContains('.actions button', 'Dark Mode');
+            $html->assertElementContains('.actions a[href$="/tags"]', 'View Tags');
+        }

     }
 
     public function test_shelves_list_homepage_adheres_to_book_visibility_permissions()
     {
     }
 
     public function test_shelves_list_homepage_adheres_to_book_visibility_permissions()
     {

-        $editor = $this->getEditor();
+        $editor = $this->users->editor();

         setting()->putUser($editor, 'bookshelves_view_type', 'list');
         $this->setSettings(['app-homepage-type' => 'bookshelves']);
         $this->asEditor();
 
         setting()->putUser($editor, 'bookshelves_view_type', 'list');
         $this->setSettings(['app-homepage-type' => 'bookshelves']);
         $this->asEditor();
 

-        $shelf = Bookshelf::query()->first();
+        $shelf = $this->entities->shelf();

         $book = $shelf->books()->first();
 
         // Ensure initially visible
         $homeVisit = $this->get('/');
         $book = $shelf->books()->first();
 
         // Ensure initially visible
         $homeVisit = $this->get('/');

-        $homeVisit->assertElementContains('.content-wrap', $shelf->name);
-        $homeVisit->assertElementContains('.content-wrap', $book->name);
+        $this->withHtml($homeVisit)->assertElementContains('.content-wrap', $shelf->name);
+        $this->withHtml($homeVisit)->assertElementContains('.content-wrap', $book->name);

 
         // Ensure book no longer visible without view permission
         $editor->roles()->detach();
 
         // Ensure book no longer visible without view permission
         $editor->roles()->detach();

-        $this->giveUserPermissions($editor, ['bookshelf-view-all']);
+        $this->permissions->grantUserRolePermissions($editor, ['bookshelf-view-all']);

         $homeVisit = $this->get('/');
         $homeVisit = $this->get('/');

-        $homeVisit->assertElementContains('.content-wrap', $shelf->name);
-        $homeVisit->assertElementNotContains('.content-wrap', $book->name);
+        $this->withHtml($homeVisit)->assertElementContains('.content-wrap', $shelf->name);
+        $this->withHtml($homeVisit)->assertElementNotContains('.content-wrap', $book->name);

 
         // Ensure is visible again with entity-level view permission
 
         // Ensure is visible again with entity-level view permission

-        $this->setEntityRestrictions($book, ['view'], [$editor->roles()->first()]);
+        $this->permissions->setEntityPermissions($book, ['view'], [$editor->roles()->first()]);

         $homeVisit = $this->get('/');
         $homeVisit = $this->get('/');

-        $homeVisit->assertElementContains('.content-wrap', $shelf->name);
-        $homeVisit->assertElementContains('.content-wrap', $book->name);
+        $this->withHtml($homeVisit)->assertElementContains('.content-wrap', $shelf->name);
+        $this->withHtml($homeVisit)->assertElementContains('.content-wrap', $book->name);

     }
 
     public function test_new_users_dont_have_any_recently_viewed()
     }
 
     public function test_new_users_dont_have_any_recently_viewed()


@@ -190,6 +193,6 @@ class HomepageTest extends TestCase
         $user->attachRole($viewRole);
 
         $homeVisit = $this->actingAs($user)->get('/');
         $user->attachRole($viewRole);
 
         $homeVisit = $this->actingAs($user)->get('/');

-        $homeVisit->assertElementContains('#recently-viewed', 'You have not viewed any pages');
+        $this->withHtml($homeVisit)->assertElementContains('#recently-viewed', 'You have not viewed any pages');

     }
 }
     }
 }