X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/cdb1c7ef88a0054c46ba9eb040464bdea274b095..refs/pull/2902/head:/tests/BrowserKitTest.php

diff --git a/tests/BrowserKitTest.php b/tests/BrowserKitTest.php
index 86f61a764..23eb10887 100644
--- a/tests/BrowserKitTest.php
+++ b/tests/BrowserKitTest.php
@@ -1,61 +1,61 @@
-<?php namespace Tests;
-
-use BookStack\Entity;
-use BookStack\Role;
-use BookStack\Services\PermissionService;
+<?php
+
+namespace Tests;
+
+use BookStack\Auth\Permissions\PermissionService;
+use BookStack\Auth\User;
+use BookStack\Entities\Models\Book;
+use BookStack\Entities\Models\Chapter;
+use BookStack\Entities\Models\Entity;
+use BookStack\Entities\Models\Page;
+use BookStack\Settings\SettingService;
+use DB;
 use Illuminate\Contracts\Console\Kernel;
+use Illuminate\Foundation\Application;
 use Illuminate\Foundation\Testing\DatabaseTransactions;
 use Laravel\BrowserKitTesting\TestCase;
 use Symfony\Component\DomCrawler\Crawler;
 
 abstract class BrowserKitTest extends TestCase
 {
-
     use DatabaseTransactions;
     use SharedTestHelpers;
 
     /**
      * The base URL to use while testing the application.
+     *
      * @var string
      */
     protected $baseUrl = 'http://localhost';
 
-    public function tearDown()
+    public function tearDown(): void
     {
-        \DB::disconnect();
+        DB::disconnect();
         parent::tearDown();
     }
 
     /**
      * Creates the application.
      *
-     * @return \Illuminate\Foundation\Application
+     * @return Application
      */
     public function createApplication()
     {
-        $app = require __DIR__.'/../bootstrap/app.php';
+        $app = require __DIR__ . '/../bootstrap/app.php';
 
         $app->make(Kernel::class)->bootstrap();
 
         return $app;
     }
 
-
-    /**
-     * Get a user that's not a system user such as the guest user.
-     */
-    public function getNormalUser()
-    {
-        return \BookStack\User::where('system_name', '=', null)->get()->last();
-    }
-
     /**
      * Quickly sets an array of settings.
+     *
      * @param $settingsArray
      */
     protected function setSettings($settingsArray)
     {
-        $settings = app('BookStack\Services\SettingService');
+        $settings = app(SettingService::class);
         foreach ($settingsArray as $key => $value) {
             $settings->put($key, $value);
         }
@@ -63,27 +63,26 @@ abstract class BrowserKitTest extends TestCase
 
     /**
      * Create a group of entities that belong to a specific user.
-     * @param $creatorUser
-     * @param $updaterUser
-     * @return array
      */
-    protected function createEntityChainBelongingToUser($creatorUser, $updaterUser = false)
+    protected function createEntityChainBelongingToUser(User $creatorUser, ?User $updaterUser = null): array
     {
-        if ($updaterUser === false) $updaterUser = $creatorUser;
-        $book = factory(\BookStack\Book::class)->create(['created_by' => $creatorUser->id, 'updated_by' => $updaterUser->id]);
-        $chapter = factory(\BookStack\Chapter::class)->create(['created_by' => $creatorUser->id, 'updated_by' => $updaterUser->id, 'book_id' => $book->id]);
-        $page = factory(\BookStack\Page::class)->create(['created_by' => $creatorUser->id, 'updated_by' => $updaterUser->id, 'book_id' => $book->id, 'chapter_id' => $chapter->id]);
+        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 [
-            'book' => $book,
-            'chapter' => $chapter,
-            'page' => $page
-        ];
+
+        return compact('book', 'chapter', 'page');
     }
 
     /**
      * Helper for updating entity permissions.
+     *
      * @param Entity $entity
      */
     protected function updateEntityPermissions(Entity $entity)
@@ -92,30 +91,33 @@ abstract class BrowserKitTest extends TestCase
         $restrictionService->buildJointPermissionsForEntity($entity);
     }
 
-
     /**
-     * Quick way to create a new user without any permissions
+     * Quick way to create a new user without any permissions.
+     *
      * @param array $attributes
+     *
      * @return mixed
      */
     protected function getNewBlankUser($attributes = [])
     {
-        $user = factory(\BookStack\User::class)->create($attributes);
+        $user = factory(User::class)->create($attributes);
+
         return $user;
     }
 
     /**
      * Assert that a given string is seen inside an element.
      *
-     * @param  bool|string|null $element
-     * @param  integer          $position
-     * @param  string           $text
-     * @param  bool             $negate
+     * @param bool|string|null $element
+     * @param int              $position
+     * @param string           $text
+     * @param bool             $negate
+     *
      * @return $this
      */
     protected function seeInNthElement($element, $position, $text, $negate = false)
     {
-        $method = $negate ? 'assertNotRegExp' : 'assertRegExp';
+        $method = $negate ? 'assertDoesNotMatchRegularExpression' : 'assertMatchesRegularExpression';
 
         $rawPattern = preg_quote($text, '/');
 
@@ -134,13 +136,16 @@ abstract class BrowserKitTest extends TestCase
     /**
      * Assert that the current page matches a given URI.
      *
-     * @param  string  $uri
+     * @param string $uri
+     *
      * @return $this
      */
     protected function seePageUrlIs($uri)
     {
         $this->assertEquals(
-            $uri, $this->currentUri, "Did not land on expected page [{$uri}].\n"
+            $uri,
+            $this->currentUri,
+            "Did not land on expected page [{$uri}].\n"
         );
 
         return $this;
@@ -148,10 +153,12 @@ abstract class BrowserKitTest extends TestCase
 
     /**
      * Do a forced visit that does not error out on exception.
+     *
      * @param string $uri
-     * @param array $parameters
-     * @param array $cookies
-     * @param array $files
+     * @param array  $parameters
+     * @param array  $cookies
+     * @param array  $files
+     *
      * @return $this
      */
     protected function forceVisit($uri, $parameters = [], $cookies = [], $files = [])
@@ -162,13 +169,16 @@ abstract class BrowserKitTest extends TestCase
         $this->clearInputs()->followRedirects();
         $this->currentUri = $this->app->make('request')->fullUrl();
         $this->crawler = new Crawler($this->response->getContent(), $uri);
+
         return $this;
     }
 
     /**
      * Click the text within the selected element.
+     *
      * @param $parentElement
      * @param $linkText
+     *
      * @return $this
      */
     protected function clickInElement($parentElement, $linkText)
@@ -176,28 +186,33 @@ abstract class BrowserKitTest extends TestCase
         $elem = $this->crawler->filter($parentElement);
         $link = $elem->selectLink($linkText);
         $this->visit($link->link()->getUri());
+
         return $this;
     }
 
     /**
      * Check if the page contains the given element.
-     * @param  string  $selector
+     *
+     * @param string $selector
      */
     protected function pageHasElement($selector)
     {
         $elements = $this->crawler->filter($selector);
-        $this->assertTrue(count($elements) > 0, "The page does not contain an element matching " . $selector);
+        $this->assertTrue(count($elements) > 0, 'The page does not contain an element matching ' . $selector);
+
         return $this;
     }
 
     /**
      * Check if the page contains the given element.
-     * @param  string  $selector
+     *
+     * @param string $selector
      */
     protected function pageNotHasElement($selector)
     {
         $elements = $this->crawler->filter($selector);
-        $this->assertFalse(count($elements) > 0, "The page contains " . count($elements) . " elements matching " . $selector);
+        $this->assertFalse(count($elements) > 0, 'The page contains ' . count($elements) . ' elements matching ' . $selector);
+
         return $this;
     }
 }