X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/898cedf5362a43afcee85cf24c8352240cb54690..refs/pull/2700/head:/tests/SharedTestHelpers.php

diff --git a/tests/SharedTestHelpers.php b/tests/SharedTestHelpers.php
index f7b7d5edf..78c1f3b18 100644
--- a/tests/SharedTestHelpers.php
+++ b/tests/SharedTestHelpers.php
@@ -1,11 +1,11 @@
 <?php namespace Tests;
 
 use BookStack\Auth\User;
-use BookStack\Entities\Book;
-use BookStack\Entities\Bookshelf;
-use BookStack\Entities\Chapter;
-use BookStack\Entities\Entity;
-use BookStack\Entities\Page;
+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;
@@ -16,8 +16,11 @@ use BookStack\Entities\Repos\PageRepo;
 use BookStack\Settings\SettingService;
 use BookStack\Uploads\HttpFetcher;
 use Illuminate\Support\Env;
+use Illuminate\Support\Facades\Log;
 use Mockery;
-use Throwable;
+use Monolog\Handler\TestHandler;
+use Monolog\Logger;
+use Illuminate\Foundation\Testing\Assert as PHPUnit;
 
 trait SharedTestHelpers
 {
@@ -27,7 +30,6 @@ trait SharedTestHelpers
 
     /**
      * Set the current user context to be an admin.
-     * @return $this
      */
     public function asAdmin()
     {
@@ -36,19 +38,19 @@ trait SharedTestHelpers
 
     /**
      * Get the current admin user.
-     * @return mixed
      */
-    public function getAdmin() {
-        if($this->admin === null) {
+    public function getAdmin(): User
+    {
+        if (is_null($this->admin)) {
             $adminRole = Role::getSystemRole('admin');
             $this->admin = $adminRole->users->first();
         }
+
         return $this->admin;
     }
 
     /**
      * Set the current user context to be an editor.
-     * @return $this
      */
     public function asEditor()
     {
@@ -58,10 +60,10 @@ trait SharedTestHelpers
 
     /**
      * Get a editor user.
-     * @return mixed
      */
-    protected function getEditor() {
-        if($this->editor === null) {
+    protected function getEditor(): User
+    {
+        if ($this->editor === null) {
             $editorRole = Role::getRole('editor');
             $this->editor = $editorRole->users->first();
         }
@@ -69,23 +71,21 @@ 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 = Role::getRole('viewer')->users()->first();
-        if (!empty($attributes)) $user->forceFill($attributes)->save();
+        if (!empty($attributes)) {
+            $user->forceFill($attributes)->save();
+        }
         return $user;
     }
 
     /**
      * Regenerate the permission for an entity.
-     * @param Entity $entity
-     * @throws Throwable
      */
-    protected function regenEntityPermissions(Entity $entity)
+    protected function regenEntityPermissions(Entity $entity): void
     {
         $entity->rebuildPermissions();
         $entity->load('jointPermissions');
@@ -93,40 +93,34 @@ trait SharedTestHelpers
 
     /**
      * Create and return a new bookshelf.
-     * @param array $input
-     * @return Bookshelf
      */
-    public function newShelf($input = ['name' => 'test shelf', 'description' => 'My new test shelf']) {
+    public function newShelf(array $input = ['name' => 'test shelf', 'description' => 'My new test shelf']): Bookshelf
+    {
         return app(BookshelfRepo::class)->create($input, []);
     }
 
     /**
      * Create and return a new book.
-     * @param array $input
-     * @return Book
      */
-    public function newBook($input = ['name' => 'test book', 'description' => 'My new test book']) {
+    public function newBook(array $input = ['name' => 'test book', 'description' => 'My new test book']): Book
+    {
         return app(BookRepo::class)->create($input);
     }
 
     /**
      * Create and return a new test chapter
-     * @param array $input
-     * @param Book $book
-     * @return Chapter
      */
-    public function newChapter($input = ['name' => 'test chapter', 'description' => 'My new test chapter'], Book $book) {
+    public function newChapter(array $input = ['name' => 'test chapter', 'description' => 'My new test chapter'], Book $book): Chapter
+    {
         return app(ChapterRepo::class)->create($input, $book);
     }
 
     /**
      * Create and return a new test page
-     * @param array $input
-     * @return Page
-     * @throws Throwable
      */
-    public function newPage($input = ['name' => 'test page', 'html' => 'My new test page']) {
-        $book = Book::first();
+    public function newPage(array $input = ['name' => 'test page', 'html' => 'My new test page']): Page
+    {
+        $book = Book::query()->first();
         $pageRepo = app(PageRepo::class);
         $draftPage = $pageRepo->getNewDraftPage($book);
         return $pageRepo->publishDraft($draftPage, $input);
@@ -134,9 +128,8 @@ trait SharedTestHelpers
 
     /**
      * Quickly sets an array of settings.
-     * @param $settingsArray
      */
-    protected function setSettings($settingsArray)
+    protected function setSettings(array $settingsArray): void
     {
         $settings = app(SettingService::class);
         foreach ($settingsArray as $key => $value) {
@@ -146,11 +139,8 @@ trait SharedTestHelpers
 
     /**
      * Manually set some permissions on an entity.
-     * @param Entity $entity
-     * @param array $actions
-     * @param array $roles
      */
-    protected function setEntityRestrictions(Entity $entity, $actions = [], $roles = [])
+    protected function setEntityRestrictions(Entity $entity, array $actions = [], array $roles = []): void
     {
         $entity->restricted = true;
         $entity->permissions()->delete();
@@ -174,23 +164,19 @@ trait SharedTestHelpers
 
     /**
      * Give the given user some permissions.
-     * @param User $user
-     * @param array $permissions
      */
-    protected function giveUserPermissions(User $user, $permissions = [])
+    protected function giveUserPermissions(User $user, array $permissions = []): void
     {
         $newRole = $this->createNewRole($permissions);
         $user->attachRole($newRole);
         $user->load('roles');
-        $user->permissions(false);
+        $user->clearPermissionCache();
     }
 
     /**
      * Create a new basic role for testing purposes.
-     * @param array $permissions
-     * @return Role
      */
-    protected function createNewRole($permissions = [])
+    protected function createNewRole(array $permissions = []): Role
     {
         $permissionRepo = app(PermissionsRepo::class);
         $roleData = factory(Role::class)->make()->toArray();
@@ -200,8 +186,6 @@ trait SharedTestHelpers
 
     /**
      * Mock the HttpFetcher service and return the given data on fetch.
-     * @param $returnData
-     * @param int $times
      */
     protected function mockHttpFetch($returnData, int $times = 1)
     {
@@ -215,9 +199,6 @@ trait SharedTestHelpers
     /**
      * Run a set test with the given env variable.
      * Remembers the original and resets the value after test.
-     * @param string $name
-     * @param $value
-     * @param callable $callback
      */
     protected function runWithEnv(string $name, $value, callable $callback)
     {
@@ -243,11 +224,8 @@ trait SharedTestHelpers
     /**
      * Check the keys and properties in the given map to include
      * exist, albeit not exclusively, within the map to check.
-     * @param array $mapToInclude
-     * @param array $mapToCheck
-     * @param string $message
      */
-    protected function assertArrayMapIncludes(array $mapToInclude, array $mapToCheck, string $message = '') : void
+    protected function assertArrayMapIncludes(array $mapToInclude, array $mapToCheck, string $message = ''): void
     {
         $passed = true;
 
@@ -267,14 +245,43 @@ trait SharedTestHelpers
      */
     protected function assertPermissionError($response)
     {
-        if ($response instanceof BrowserKitTest) {
-            $response = \Illuminate\Foundation\Testing\TestResponse::fromBaseResponse($response->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');
 
-        $response->assertRedirect('/');
-        $this->assertSessionHas('error');
-        $error = session()->pull('error');
-        $this->assertStringStartsWith('You do not have permission to access', $error);
+        return $testHandler;
     }
 
 }
\ No newline at end of file