Add prev and next button to navigate through different pages

[bookstack] / tests / SharedTestHelpers.php

diff --git a/tests/SharedTestHelpers.php b/tests/SharedTestHelpers.php
index eb3f7b4bbb9e718bd0c59ef8905df801d19fb6cf..02f7caae1cb859b4c14d105eab864a78eb4ec0fc 100644 (file)
--- a/tests/SharedTestHelpers.php
+++ b/tests/SharedTestHelpers.php
@@ -1,16 +1,28 @@
 <?php namespace Tests;
 
 <?php namespace Tests;
 

-use BookStack\Entities\Book;
-use BookStack\Entities\Entity;
-use BookStack\Entities\Page;
-use BookStack\Entities\Repos\EntityRepo;
+use BookStack\Auth\User;
+use BookStack\Entities\Models\Book;
+use BookStack\Entities\Models\Bookshelf;
+use BookStack\Entities\Models\Chapter;
+use BookStack\Entities\Models\Entity;
+use BookStack\Entities\Models\Page;
+use BookStack\Entities\Repos\BookRepo;
+use BookStack\Entities\Repos\BookshelfRepo;
+use BookStack\Entities\Repos\ChapterRepo;

 use BookStack\Auth\Permissions\PermissionsRepo;
 use BookStack\Auth\Role;
 use BookStack\Auth\Permissions\PermissionService;
 use BookStack\Entities\Repos\PageRepo;
 use BookStack\Settings\SettingService;
 use BookStack\Uploads\HttpFetcher;
 use BookStack\Auth\Permissions\PermissionsRepo;
 use BookStack\Auth\Role;
 use BookStack\Auth\Permissions\PermissionService;
 use BookStack\Entities\Repos\PageRepo;
 use BookStack\Settings\SettingService;
 use BookStack\Uploads\HttpFetcher;

+use Illuminate\Http\Response;

 use Illuminate\Support\Env;
 use Illuminate\Support\Env;

+use Illuminate\Support\Facades\Log;
+use Mockery;
+use Monolog\Handler\TestHandler;
+use Monolog\Logger;
+use Throwable;
+use Illuminate\Foundation\Testing\Assert as PHPUnit;

 
 trait SharedTestHelpers
 {
 
 trait SharedTestHelpers
 {


@@ -62,35 +74,35 @@ trait SharedTestHelpers
     }
 
     /**
     }
 
     /**

-     * Get an instance of a user with 'viewer' permissions
-     * @param $attributes
-     * @return mixed
+     * Get an instance of a user with 'viewer' permissions.

      */
      */

-    protected function getViewer($attributes = [])
+    protected function getViewer(array $attributes = []): User

     {
     {

-        $user = \BookStack\Auth\Role::getRole('viewer')->users()->first();
-        if (!empty($attributes)) $user->forceFill($attributes)->save();
+        $user = Role::getRole('viewer')->users()->first();
+        if (!empty($attributes)) {
+            $user->forceFill($attributes)->save();
+        }

         return $user;
     }
 
     /**
      * Regenerate the permission for an entity.
      * @param Entity $entity
         return $user;
     }
 
     /**
      * Regenerate the permission for an entity.
      * @param Entity $entity

-     * @throws \Throwable
+     * @throws Throwable

      */
     protected function regenEntityPermissions(Entity $entity)
     {
      */
     protected function regenEntityPermissions(Entity $entity)
     {

-        app(PermissionService::class)->buildJointPermissionsForEntity($entity);
+        $entity->rebuildPermissions();

         $entity->load('jointPermissions');
     }
 
     /**
      * Create and return a new bookshelf.
      * @param array $input
         $entity->load('jointPermissions');
     }
 
     /**
      * Create and return a new bookshelf.
      * @param array $input

-     * @return \BookStack\Entities\Bookshelf
+     * @return Bookshelf

      */
     public function newShelf($input = ['name' => 'test shelf', 'description' => 'My new test shelf']) {
      */
     public function newShelf($input = ['name' => 'test shelf', 'description' => 'My new test shelf']) {

-        return app(EntityRepo::class)->createFromInput('bookshelf', $input, false);
+        return app(BookshelfRepo::class)->create($input, []);

     }
 
     /**
     }
 
     /**


@@ -99,30 +111,30 @@ trait SharedTestHelpers
      * @return Book
      */
     public function newBook($input = ['name' => 'test book', 'description' => 'My new test book']) {
      * @return Book
      */
     public function newBook($input = ['name' => 'test book', 'description' => 'My new test book']) {

-        return app(EntityRepo::class)->createFromInput('book', $input, false);
+        return app(BookRepo::class)->create($input);

     }
 
     /**
      * Create and return a new test chapter
      * @param array $input
      * @param Book $book
     }
 
     /**
      * Create and return a new test chapter
      * @param array $input
      * @param Book $book

-     * @return \BookStack\Entities\Chapter
+     * @return Chapter

      */
     public function newChapter($input = ['name' => 'test chapter', 'description' => 'My new test chapter'], Book $book) {
      */
     public function newChapter($input = ['name' => 'test chapter', 'description' => 'My new test chapter'], Book $book) {

-        return app(EntityRepo::class)->createFromInput('chapter', $input, $book);
+        return app(ChapterRepo::class)->create($input, $book);

     }
 
     /**
      * Create and return a new test page
      * @param array $input
      * @return Page
     }
 
     /**
      * Create and return a new test page
      * @param array $input
      * @return Page

-     * @throws \Throwable
+     * @throws Throwable

      */
     public function newPage($input = ['name' => 'test page', 'html' => 'My new test page']) {
         $book = Book::first();
         $pageRepo = app(PageRepo::class);
      */
     public function newPage($input = ['name' => 'test page', 'html' => 'My new test page']) {
         $book = Book::first();
         $pageRepo = app(PageRepo::class);

-        $draftPage = $pageRepo->getDraftPage($book);
-        return $pageRepo->publishPageDraft($draftPage, $input);
+        $draftPage = $pageRepo->getNewDraftPage($book);
+        return $pageRepo->publishDraft($draftPage, $input);

     }
 
     /**
     }
 
     /**


@@ -167,15 +179,13 @@ trait SharedTestHelpers
 
     /**
      * Give the given user some permissions.
 
     /**
      * Give the given user some permissions.

-     * @param \BookStack\Auth\User $user
-     * @param array $permissions

      */
      */

-    protected function giveUserPermissions(\BookStack\Auth\User $user, $permissions = [])
+    protected function giveUserPermissions(User $user, array $permissions = [])

     {
         $newRole = $this->createNewRole($permissions);
         $user->attachRole($newRole);
         $user->load('roles');
     {
         $newRole = $this->createNewRole($permissions);
         $user->attachRole($newRole);
         $user->load('roles');

-        $user->permissions(false);
+        $user->clearPermissionCache();

     }
 
     /**
     }
 
     /**


@@ -198,7 +208,7 @@ trait SharedTestHelpers
      */
     protected function mockHttpFetch($returnData, int $times = 1)
     {
      */
     protected function mockHttpFetch($returnData, int $times = 1)
     {

-        $mockHttp = \Mockery::mock(HttpFetcher::class);
+        $mockHttp = Mockery::mock(HttpFetcher::class);

         $this->app[HttpFetcher::class] = $mockHttp;
         $mockHttp->shouldReceive('fetch')
             ->times($times)
         $this->app[HttpFetcher::class] = $mockHttp;
         $mockHttp->shouldReceive('fetch')
             ->times($times)


@@ -215,13 +225,11 @@ trait SharedTestHelpers
     protected function runWithEnv(string $name, $value, callable $callback)
     {
         Env::disablePutenv();
     protected function runWithEnv(string $name, $value, callable $callback)
     {
         Env::disablePutenv();

-        $originalVal = $_ENV[$name] ?? null;
+        $originalVal = $_SERVER[$name] ?? null;

 
         if (is_null($value)) {
 
         if (is_null($value)) {

-            unset($_ENV[$name]);

             unset($_SERVER[$name]);
         } else {
             unset($_SERVER[$name]);
         } else {

-            $_ENV[$name] = $value;

             $_SERVER[$name] = $value;
         }
 
             $_SERVER[$name] = $value;
         }
 


@@ -230,10 +238,8 @@ trait SharedTestHelpers
 
         if (is_null($originalVal)) {
             unset($_SERVER[$name]);
 
         if (is_null($originalVal)) {
             unset($_SERVER[$name]);

-            unset($_ENV[$name]);

         } else {
             $_SERVER[$name] = $originalVal;
         } else {
             $_SERVER[$name] = $originalVal;

-            $_ENV[$name] = $originalVal;

         }
     }
 
         }
     }
 


@@ -259,4 +265,48 @@ trait SharedTestHelpers
         self::assertThat($passed, self::isTrue(), "Failed asserting that given map:\n\n{$toCheckStr}\n\nincludes:\n\n{$toIncludeStr}");
     }
 
         self::assertThat($passed, self::isTrue(), "Failed asserting that given map:\n\n{$toCheckStr}\n\nincludes:\n\n{$toIncludeStr}");
     }
 

+    /**
+     * Assert a permission error has occurred.
+     */
+    protected function assertPermissionError($response)
+    {
+        PHPUnit::assertTrue($this->isPermissionError($response->baseResponse ?? $response->response), "Failed asserting the response contains a permission error.");
+    }
+
+    /**
+     * Assert a permission error has occurred.
+     */
+    protected function assertNotPermissionError($response)
+    {
+        PHPUnit::assertFalse($this->isPermissionError($response->baseResponse ?? $response->response), "Failed asserting the response does not contain a permission error.");
+    }
+
+    /**
+     * Check if the given response is a permission error.
+     */
+    private function isPermissionError($response): bool
+    {
+        return $response->status() === 302
+            && $response->headers->get('Location') === url('/')
+            && strpos(session()->pull('error', ''), 'You do not have permission to access') === 0;
+    }
+
+    /**
+     * Set a test handler as the logging interface for the application.
+     * Allows capture of logs for checking against during tests.
+     */
+    protected function withTestLogger(): TestHandler
+    {
+        $monolog = new Logger('testing');
+        $testHandler = new TestHandler();
+        $monolog->pushHandler($testHandler);
+
+        Log::extend('testing', function() use ($monolog) {
+            return $monolog;
+        });
+        Log::setDefaultDriver('testing');
+
+        return $testHandler;
+    }
+

 }
\ No newline at end of file
 }
\ No newline at end of file