X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/068a8a068c5d7c7ab98a6ee95baae8d321c3c61f..refs/pull/3918/head:/tests/Helpers/EntityProvider.php

diff --git a/tests/Helpers/EntityProvider.php b/tests/Helpers/EntityProvider.php
index d3888e71f..9e8cf0b73 100644
--- a/tests/Helpers/EntityProvider.php
+++ b/tests/Helpers/EntityProvider.php
@@ -2,6 +2,7 @@
 
 namespace Tests\Helpers;
 
+use BookStack\Auth\Permissions\EntityPermission;
 use BookStack\Auth\Role;
 use BookStack\Auth\User;
 use BookStack\Entities\Models\Book;
@@ -13,7 +14,13 @@ use BookStack\Entities\Repos\BookRepo;
 use BookStack\Entities\Repos\BookshelfRepo;
 use BookStack\Entities\Repos\ChapterRepo;
 use BookStack\Entities\Repos\PageRepo;
+use Illuminate\Database\Eloquent\Builder;
 
+/**
+ * Class to provider and action entity models for common test case
+ * operations. Tracks handled models and only returns fresh models.
+ * Does not dedupe against nested/child/parent models.
+ */
 class EntityProvider
 {
     /**
@@ -29,43 +36,68 @@ class EntityProvider
     /**
      * Get an un-fetched page from the system.
      */
-    public function page(): Page
+    public function page(callable $queryFilter = null): Page
     {
         /** @var Page $page */
-        $page = Page::query()->whereNotIn('id', $this->fetchCache['page'])->first();
+        $page = Page::query()->when($queryFilter, $queryFilter)->whereNotIn('id', $this->fetchCache['page'])->first();
         $this->addToCache($page);
         return $page;
     }
 
+    public function pageWithinChapter(): Page
+    {
+        return $this->page(fn(Builder $query) => $query->whereHas('chapter')->with('chapter'));
+    }
+
+    public function pageNotWithinChapter(): Page
+    {
+        return $this->page(fn(Builder $query) => $query->where('chapter_id', '=', 0));
+    }
+
     /**
      * Get an un-fetched chapter from the system.
      */
-    public function chapter(): Chapter
+    public function chapter(callable $queryFilter = null): Chapter
     {
         /** @var Chapter $chapter */
-        $chapter = Chapter::query()->whereNotIn('id', $this->fetchCache['chapter'])->first();
+        $chapter = Chapter::query()->when($queryFilter, $queryFilter)->whereNotIn('id', $this->fetchCache['chapter'])->first();
         $this->addToCache($chapter);
         return $chapter;
     }
 
+    public function chapterHasPages(): Chapter
+    {
+        return $this->chapter(fn(Builder $query) => $query->whereHas('pages'));
+    }
+
     /**
      * Get an un-fetched book from the system.
      */
-    public function book(): Book
+    public function book(callable $queryFilter = null): Book
     {
         /** @var Book $book */
-        $book = Book::query()->whereNotIn('id', $this->fetchCache['book'])->first();
+        $book = Book::query()->when($queryFilter, $queryFilter)->whereNotIn('id', $this->fetchCache['book'])->first();
         $this->addToCache($book);
         return $book;
     }
 
+    /**
+     * Get a book that has chapters and pages assigned.
+     */
+    public function bookHasChaptersAndPages(): Book
+    {
+        return $this->book(function (Builder $query) {
+            $query->has('chapters')->has('pages')->with(['chapters', 'pages']);
+        });
+    }
+
     /**
      * Get an un-fetched shelf from the system.
      */
-    public function shelf(): Bookshelf
+    public function shelf(callable $queryFilter = null): Bookshelf
     {
         /** @var Bookshelf $shelf */
-        $shelf = Bookshelf::query()->whereNotIn('id', $this->fetchCache['bookshelf'])->first();
+        $shelf = Bookshelf::query()->when($queryFilter, $queryFilter)->whereNotIn('id', $this->fetchCache['bookshelf'])->first();
         $this->addToCache($shelf);
         return $shelf;
     }
@@ -84,6 +116,12 @@ class EntityProvider
         ];
     }
 
+    public function updatePage(Page $page, array $data): Page
+    {
+        $this->addToCache($page);
+        return app()->make(PageRepo::class)->update($page, $data);
+    }
+
     /**
      * Create a book to page chain of entities that belong to a specific user.
      * @return array{book: Book, chapter: Chapter, page: Page}
@@ -141,7 +179,7 @@ class EntityProvider
      */
     public function newPage(array $input = ['name' => 'test page', 'html' => 'My new test page']): Page
     {
-        $book = Book::query()->first();
+        $book = $this->book();
         $pageRepo = app(PageRepo::class);
         $draftPage = $pageRepo->getNewDraftPage($book);
         $this->addToCache($draftPage);
@@ -166,21 +204,22 @@ class EntityProvider
      */
     public function setPermissions(Entity $entity, array $actions = [], array $roles = []): void
     {
-        $entity->restricted = true;
         $entity->permissions()->delete();
 
-        $permissions = [];
-        foreach ($actions as $action) {
-            foreach ($roles as $role) {
-                $permissions[] = [
-                    'role_id' => $role->id,
-                    'action'  => strtolower($action),
-                ];
+        $permissions = [
+            // Set default permissions to not allow actions so that only the provided role permissions are at play.
+            ['role_id' => 0, 'view' => false, 'create' => false, 'update' => false, 'delete' => false],
+        ];
+
+        foreach ($roles as $role) {
+            $permission = ['role_id' => $role->id];
+            foreach (EntityPermission::PERMISSIONS as $possibleAction) {
+                $permission[$possibleAction] = in_array($possibleAction, $actions);
             }
+            $permissions[] = $permission;
         }
 
         $entity->permissions()->createMany($permissions);
-        $entity->save();
         $entity->load('permissions');
         $this->regenPermissions($entity);
     }