Modernize third party services' logos

[bookstack] / tests / SharedTestHelpers.php

diff --git a/tests/SharedTestHelpers.php b/tests/SharedTestHelpers.php
index 02f7caae1cb859b4c14d105eab864a78eb4ec0fc..04952d22345caa18761466b026ce3b701395599c 100644 (file)
--- a/tests/SharedTestHelpers.php
+++ b/tests/SharedTestHelpers.php
@@ -1,5 +1,11 @@
-<?php namespace Tests;
+<?php

 
 

+namespace Tests;
+
+use BookStack\Auth\Permissions\PermissionService;
+use BookStack\Auth\Permissions\PermissionsRepo;
+use BookStack\Auth\Permissions\RolePermission;
+use BookStack\Auth\Role;

 use BookStack\Auth\User;
 use BookStack\Entities\Models\Book;
 use BookStack\Entities\Models\Bookshelf;
 use BookStack\Auth\User;
 use BookStack\Entities\Models\Book;
 use BookStack\Entities\Models\Bookshelf;


@@ -9,30 +15,29 @@ use BookStack\Entities\Models\Page;
 use BookStack\Entities\Repos\BookRepo;
 use BookStack\Entities\Repos\BookshelfRepo;
 use BookStack\Entities\Repos\ChapterRepo;
 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\Entities\Repos\PageRepo;
 use BookStack\Settings\SettingService;
 use BookStack\Uploads\HttpFetcher;

-use Illuminate\Http\Response;
+use GuzzleHttp\Client;
+use GuzzleHttp\Handler\MockHandler;
+use GuzzleHttp\HandlerStack;
+use GuzzleHttp\Middleware;
+use Illuminate\Foundation\Testing\Assert as PHPUnit;
+use Illuminate\Http\JsonResponse;

 use Illuminate\Support\Env;
 use Illuminate\Support\Facades\Log;
 use Mockery;
 use Monolog\Handler\TestHandler;
 use Monolog\Logger;
 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;
+use Psr\Http\Client\ClientInterface;

 
 trait SharedTestHelpers
 {
 
 trait SharedTestHelpers
 {

-

     protected $admin;
     protected $editor;
 
     /**
      * Set the current user context to be an admin.
     protected $admin;
     protected $editor;
 
     /**
      * Set the current user context to be an admin.

-     * @return $this

      */
     public function asAdmin()
     {
      */
     public function asAdmin()
     {


@@ -41,35 +46,35 @@ trait SharedTestHelpers
 
     /**
      * Get the current admin user.
 
     /**
      * 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();
         }
             $adminRole = Role::getSystemRole('admin');
             $this->admin = $adminRole->users->first();
         }

+

         return $this->admin;
     }
 
     /**
      * Set the current user context to be an editor.
         return $this->admin;
     }
 
     /**
      * Set the current user context to be an editor.

-     * @return $this

      */
     public function asEditor()
     {
         return $this->actingAs($this->getEditor());
     }
 
      */
     public function asEditor()
     {
         return $this->actingAs($this->getEditor());
     }
 

-

     /**
      * Get a editor user.
     /**
      * 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();
         }
             $editorRole = Role::getRole('editor');
             $this->editor = $editorRole->users->first();
         }

+

         return $this->editor;
     }
 
         return $this->editor;
     }
 


@@ -82,15 +87,22 @@ trait SharedTestHelpers
         if (!empty($attributes)) {
             $user->forceFill($attributes)->save();
         }
         if (!empty($attributes)) {
             $user->forceFill($attributes)->save();
         }

+

         return $user;
     }
 
         return $user;
     }
 

+    /**
+     * Get a user that's not a system user such as the guest user.
+     */
+    public function getNormalUser(): User
+    {
+        return User::query()->where('system_name', '=', null)->get()->last();
+    }
+

     /**
      * Regenerate the permission for an entity.
     /**
      * 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');
     {
         $entity->rebuildPermissions();
         $entity->load('jointPermissions');


@@ -98,50 +110,44 @@ trait SharedTestHelpers
 
     /**
      * Create and return a new bookshelf.
 
     /**
      * 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.
         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);
     }
 
     /**
         return app(BookRepo::class)->create($input);
     }
 
     /**

-     * Create and return a new test chapter
-     * @param array $input
-     * @param Book $book
-     * @return Chapter
+     * Create and return a new test 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);
     }
 
     /**
         return app(ChapterRepo::class)->create($input, $book);
     }
 
     /**

-     * Create and return a new test page
-     * @param array $input
-     * @return Page
-     * @throws Throwable
+     * Create and return a new test page.

      */
      */

-    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);
         $pageRepo = app(PageRepo::class);
         $draftPage = $pageRepo->getNewDraftPage($book);

+

         return $pageRepo->publishDraft($draftPage, $input);
     }
 
     /**
      * Quickly sets an array of settings.
         return $pageRepo->publishDraft($draftPage, $input);
     }
 
     /**
      * 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) {
     {
         $settings = app(SettingService::class);
         foreach ($settingsArray as $key => $value) {


@@ -151,11 +157,8 @@ trait SharedTestHelpers
 
     /**
      * Manually set some permissions on an entity.
 
     /**
      * 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();
     {
         $entity->restricted = true;
         $entity->permissions()->delete();


@@ -165,7 +168,7 @@ trait SharedTestHelpers
             foreach ($roles as $role) {
                 $permissions[] = [
                     'role_id' => $role->id,
             foreach ($roles as $role) {
                 $permissions[] = [
                     'role_id' => $role->id,

-                    'action' => strtolower($action)
+                    'action'  => strtolower($action),

                 ];
             }
         }
                 ];
             }
         }


@@ -180,7 +183,7 @@ trait SharedTestHelpers
     /**
      * Give the given user some permissions.
      */
     /**
      * Give the given user some permissions.
      */

-    protected function giveUserPermissions(User $user, array $permissions = [])
+    protected function giveUserPermissions(User $user, array $permissions = []): void

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


@@ -188,23 +191,54 @@ trait SharedTestHelpers
         $user->clearPermissionCache();
     }
 
         $user->clearPermissionCache();
     }
 

+    /**
+     * Completely remove the given permission name from the given user.
+     */
+    protected function removePermissionFromUser(User $user, string $permission)
+    {
+        $permission = RolePermission::query()->where('name', '=', $permission)->first();
+        /** @var Role $role */
+        foreach ($user->roles as $role) {
+            $role->detachPermission($permission);
+        }
+        $user->clearPermissionCache();
+    }
+

     /**
      * Create a new basic role for testing purposes.
     /**
      * 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();
         $roleData['permissions'] = array_flip($permissions);
     {
         $permissionRepo = app(PermissionsRepo::class);
         $roleData = factory(Role::class)->make()->toArray();
         $roleData['permissions'] = array_flip($permissions);

+

         return $permissionRepo->saveNewRole($roleData);
     }
 
         return $permissionRepo->saveNewRole($roleData);
     }
 

+    /**
+     * Create a group of entities that belong to a specific user.
+     *
+     * @return array{book: Book, chapter: Chapter, page: Page}
+     */
+    protected function createEntityChainBelongingToUser(User $creatorUser, ?User $updaterUser = null): array
+    {
+        if (empty($updaterUser)) {
+            $updaterUser = $creatorUser;
+        }
+
+        $userAttrs = ['created_by' => $creatorUser->id, 'owned_by' => $creatorUser->id, 'updated_by' => $updaterUser->id];
+        $book = factory(Book::class)->create($userAttrs);
+        $chapter = factory(Chapter::class)->create(array_merge(['book_id' => $book->id], $userAttrs));
+        $page = factory(Page::class)->create(array_merge(['book_id' => $book->id, 'chapter_id' => $chapter->id], $userAttrs));
+        $restrictionService = $this->app[PermissionService::class];
+        $restrictionService->buildJointPermissionsForEntity($book);
+
+        return compact('book', 'chapter', 'page');
+    }
+

     /**
      * Mock the HttpFetcher service and return the given data on fetch.
     /**
      * Mock the HttpFetcher service and return the given data on fetch.

-     * @param $returnData
-     * @param int $times

      */
     protected function mockHttpFetch($returnData, int $times = 1)
     {
      */
     protected function mockHttpFetch($returnData, int $times = 1)
     {


@@ -215,12 +249,27 @@ trait SharedTestHelpers
             ->andReturn($returnData);
     }
 
             ->andReturn($returnData);
     }
 

+    /**
+     * Mock the http client used in BookStack.
+     * Returns a reference to the container which holds all history of http transactions.
+     *
+     * @link https://docs.guzzlephp.org/en/stable/testing.html#history-middleware
+     */
+    protected function &mockHttpClient(array $responses = []): array
+    {
+        $container = [];
+        $history = Middleware::history($container);
+        $mock = new MockHandler($responses);
+        $handlerStack = new HandlerStack($mock);
+        $handlerStack->push($history);
+        $this->app[ClientInterface::class] = new Client(['handler' => $handlerStack]);
+
+        return $container;
+    }
+

     /**
      * Run a set test with the given env variable.
      * Remembers the original and resets the value after test.
     /**
      * 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)
     {
      */
     protected function runWithEnv(string $name, $value, callable $callback)
     {


@@ -246,11 +295,8 @@ trait SharedTestHelpers
     /**
      * Check the keys and properties in the given map to include
      * exist, albeit not exclusively, within the map to check.
     /**
      * 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;
 
     {
         $passed = true;
 


@@ -270,7 +316,7 @@ trait SharedTestHelpers
      */
     protected function assertPermissionError($response)
     {
      */
     protected function assertPermissionError($response)
     {

-        PHPUnit::assertTrue($this->isPermissionError($response->baseResponse ?? $response->response), "Failed asserting the response contains a permission error.");
+        PHPUnit::assertTrue($this->isPermissionError($response->baseResponse ?? $response->response), 'Failed asserting the response contains a permission error.');

     }
 
     /**
     }
 
     /**


@@ -278,7 +324,7 @@ trait SharedTestHelpers
      */
     protected function assertNotPermissionError($response)
     {
      */
     protected function assertNotPermissionError($response)
     {

-        PHPUnit::assertFalse($this->isPermissionError($response->baseResponse ?? $response->response), "Failed asserting the response does not contain a permission error.");
+        PHPUnit::assertFalse($this->isPermissionError($response->baseResponse ?? $response->response), 'Failed asserting the response does not contain a permission error.');

     }
 
     /**
     }
 
     /**


@@ -287,8 +333,26 @@ trait SharedTestHelpers
     private function isPermissionError($response): bool
     {
         return $response->status() === 302
     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;
+            && (
+                (
+                    $response->headers->get('Location') === url('/')
+                    && strpos(session()->pull('error', ''), 'You do not have permission to access') === 0
+                )
+                ||
+                (
+                    $response instanceof JsonResponse &&
+                    $response->json(['error' => 'You do not have permission to perform the requested action.'])
+                )
+            );
+    }
+
+    /**
+     * Assert that the session has a particular error notification message set.
+     */
+    protected function assertSessionError(string $message)
+    {
+        $error = session()->get('error');
+        PHPUnit::assertTrue($error === $message, "Failed asserting the session contains an error. \nFound: {$error}\nExpecting: {$message}");

     }
 
     /**
     }
 
     /**


@@ -301,12 +365,11 @@ trait SharedTestHelpers
         $testHandler = new TestHandler();
         $monolog->pushHandler($testHandler);
 
         $testHandler = new TestHandler();
         $monolog->pushHandler($testHandler);
 

-        Log::extend('testing', function() use ($monolog) {
+        Log::extend('testing', function () use ($monolog) {

             return $monolog;
         });
         Log::setDefaultDriver('testing');
 
         return $testHandler;
     }
             return $monolog;
         });
         Log::setDefaultDriver('testing');
 
         return $testHandler;
     }

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