X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/a81a56706e8be77586631f3619ad84df36c8d84e..refs/pull/2023/head:/tests/TestCase.php

diff --git a/tests/TestCase.php b/tests/TestCase.php
index 1b6a69c62..1f1d5ece7 100644
--- a/tests/TestCase.php
+++ b/tests/TestCase.php
@@ -1,199 +1,67 @@
-<?php
+<?php namespace Tests;
 
+use BookStack\Entities\Entity;
 use Illuminate\Foundation\Testing\DatabaseTransactions;
-use Symfony\Component\DomCrawler\Crawler;
+use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
 
-class TestCase extends Illuminate\Foundation\Testing\TestCase
+abstract class TestCase extends BaseTestCase
 {
-
+    use CreatesApplication;
     use DatabaseTransactions;
+    use SharedTestHelpers;
 
     /**
      * The base URL to use while testing the application.
-     *
      * @var string
      */
     protected $baseUrl = 'http://localhost';
-    private $admin;
-
-    /**
-     * Creates the application.
-     *
-     * @return \Illuminate\Foundation\Application
-     */
-    public function createApplication()
-    {
-        $app = require __DIR__.'/../bootstrap/app.php';
-
-        $app->make(Illuminate\Contracts\Console\Kernel::class)->bootstrap();
-
-        return $app;
-    }
-
-    public function asAdmin()
-    {
-        if($this->admin === null) {
-            $adminRole = \BookStack\Role::getRole('admin');
-            $this->admin = $adminRole->users->first();
-        }
-        return $this->actingAs($this->admin);
-    }
-
-    /**
-     * Quickly sets an array of settings.
-     * @param $settingsArray
-     */
-    protected function setSettings($settingsArray)
-    {
-        $settings = app('BookStack\Services\SettingService');
-        foreach ($settingsArray as $key => $value) {
-            $settings->put($key, $value);
-        }
-    }
-
-    /**
-     * Create a group of entities that belong to a specific user.
-     * @param $creatorUser
-     * @param $updaterUser
-     * @return array
-     */
-    protected function createEntityChainBelongingToUser($creatorUser, $updaterUser = false)
-    {
-        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]);
-        $page = factory(BookStack\Page::class)->create(['created_by' => $creatorUser->id, 'updated_by' => $updaterUser->id, 'book_id' => $book->id]);
-        $book->chapters()->saveMany([$chapter]);
-        $chapter->pages()->saveMany([$page]);
-        $restrictionService = $this->app[\BookStack\Services\RestrictionService::class];
-        $restrictionService->buildEntityPermissionsForEntity($book);
-        return [
-            'book' => $book,
-            'chapter' => $chapter,
-            'page' => $page
-        ];
-    }
-
-    /**
-     * Quick way to create a new user
-     * @param array $attributes
-     * @return mixed
-     */
-    protected function getNewUser($attributes = [])
-    {
-        $user = factory(\BookStack\User::class)->create($attributes);
-        $role = \BookStack\Role::getRole('editor');
-        $user->attachRole($role);;
-        return $user;
-    }
-
-    /**
-     * 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);
-        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
+     * Assert the session contains a specific entry.
+     * @param string $key
      * @return $this
      */
-    protected function seeInNthElement($element, $position, $text, $negate = false)
+    protected function assertSessionHas(string $key)
     {
-        $method = $negate ? 'assertNotRegExp' : 'assertRegExp';
-
-        $rawPattern = preg_quote($text, '/');
-
-        $escapedPattern = preg_quote(e($text), '/');
-
-        $content = $this->crawler->filter($element)->eq($position)->html();
-
-        $pattern = $rawPattern == $escapedPattern
-            ? $rawPattern : "({$rawPattern}|{$escapedPattern})";
-
-        $this->$method("/$pattern/i", $content);
-
+        $this->assertTrue(session()->has($key), "Session does not contain a [{$key}] entry");
         return $this;
     }
 
     /**
-     * Assert that the current page matches a given URI.
-     *
+     * Override of the get method so we can get visibility of custom TestResponse methods.
      * @param  string  $uri
-     * @return $this
+     * @param  array  $headers
+     * @return TestResponse
      */
-    protected function seePageUrlIs($uri)
+    public function get($uri, array $headers = [])
     {
-        $this->assertEquals(
-            $uri, $this->currentUri, "Did not land on expected page [{$uri}].\n"
-        );
-
-        return $this;
+        return parent::get($uri, $headers);
     }
 
     /**
-     * Do a forced visit that does not error out on exception.
-     * @param string $uri
-     * @param array $parameters
-     * @param array $cookies
-     * @param array $files
-     * @return $this
+     * Create the test response instance from the given response.
+     *
+     * @param  \Illuminate\Http\Response $response
+     * @return TestResponse
      */
-    protected function forceVisit($uri, $parameters = [], $cookies = [], $files = [])
+    protected function createTestResponse($response)
     {
-        $method = 'GET';
-        $uri = $this->prepareUrlForRequest($uri);
-        $this->call($method, $uri, $parameters, $cookies, $files);
-        $this->clearInputs()->followRedirects();
-        $this->currentUri = $this->app->make('request')->fullUrl();
-        $this->crawler = new Crawler($this->response->getContent(), $uri);
-        return $this;
+        return TestResponse::fromBaseResponse($response);
     }
 
     /**
-     * Click the text within the selected element.
-     * @param $parentElement
-     * @param $linkText
-     * @return $this
+     * Assert that an activity entry exists of the given key.
+     * Checks the activity belongs to the given entity if provided.
      */
-    protected function clickInElement($parentElement, $linkText)
+    protected function assertActivityExists(string $key, Entity $entity = null)
     {
-        $elem = $this->crawler->filter($parentElement);
-        $link = $elem->selectLink($linkText);
-        $this->visit($link->link()->getUri());
-        return $this;
-    }
+        $detailsToCheck = ['key' => $key];
 
-    /**
-     * Check if the page contains the given element.
-     * @param  string  $selector
-     * @return bool
-     */
-    protected function pageHasElement($selector)
-    {
-        $elements = $this->crawler->filter($selector);
-        $this->assertTrue(count($elements) > 0, "The page does not contain an element matching " . $selector);
-        return $this;
-    }
+        if ($entity) {
+            $detailsToCheck['entity_type'] = $entity->getMorphClass();
+            $detailsToCheck['entity_id'] = $entity->id;
+        }
 
-    /**
-     * Check if the page contains the given element.
-     * @param  string  $selector
-     * @return bool
-     */
-    protected function pageNotHasElement($selector)
-    {
-        $elements = $this->crawler->filter($selector);
-        $this->assertFalse(count($elements) > 0, "The page contains " . count($elements) . " elements matching " . $selector);
-        return $this;
+        $this->assertDatabaseHas('activities', $detailsToCheck);
     }
-}
+}
\ No newline at end of file