ZIP Imports: Added API examples, finished testing

[bookstack] / tests / TestCase.php

diff --git a/tests/TestCase.php b/tests/TestCase.php
index 567dc93eca876bc7426bfee781e80f35c1526ca5..a8636fb158e2b37abd34c8b8e18b15809f76899b 100644 (file)
--- a/tests/TestCase.php
+++ b/tests/TestCase.php
@@ -1,20 +1,58 @@
 <?php
 
 <?php
 

+namespace Tests;
+
+use BookStack\Entities\Models\Entity;
+use BookStack\Http\HttpClientHistory;
+use BookStack\Http\HttpRequestService;
+use BookStack\Settings\SettingService;
+use BookStack\Users\Models\User;
+use Illuminate\Contracts\Console\Kernel;

 use Illuminate\Foundation\Testing\DatabaseTransactions;
 use Illuminate\Foundation\Testing\DatabaseTransactions;

-use Symfony\Component\DomCrawler\Crawler;
+use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Env;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Log;
+use Illuminate\Testing\Assert as PHPUnit;
+use Monolog\Handler\TestHandler;
+use Monolog\Logger;
+use Ssddanbrown\AssertHtml\TestsHtml;
+use Tests\Helpers\EntityProvider;
+use Tests\Helpers\FileProvider;
+use Tests\Helpers\PermissionsProvider;
+use Tests\Helpers\TestServiceProvider;
+use Tests\Helpers\UserRoleProvider;

 
 

-class TestCase extends Illuminate\Foundation\Testing\TestCase
+abstract class TestCase extends BaseTestCase

 {
 {

-
+    use CreatesApplication;

     use DatabaseTransactions;
     use DatabaseTransactions;

+    use TestsHtml;
+
+    protected EntityProvider $entities;
+    protected UserRoleProvider $users;
+    protected PermissionsProvider $permissions;
+    protected FileProvider $files;
+
+    protected function setUp(): void
+    {
+        $this->entities = new EntityProvider();
+        $this->users = new UserRoleProvider();
+        $this->permissions = new PermissionsProvider($this->users);
+        $this->files = new FileProvider();
+
+        parent::setUp();
+
+        // We can uncomment the below to run tests with failings upon deprecations.
+        // Can't leave on since some deprecations can only be fixed upstream.
+         // $this->withoutDeprecationHandling();
+    }

 
     /**
      * The base URL to use while testing the application.
 
     /**
      * The base URL to use while testing the application.

-     *
-     * @var string

      */
      */

-    protected $baseUrl = 'http://localhost';
-    private $admin;
+    protected string $baseUrl = 'http://localhost';

 
     /**
      * Creates the application.
 
     /**
      * Creates the application.


@@ -23,151 +61,210 @@ class TestCase extends Illuminate\Foundation\Testing\TestCase
      */
     public function createApplication()
     {
      */
     public function createApplication()
     {

-        $app = require __DIR__.'/../bootstrap/app.php';
-
-        $app->make(Illuminate\Contracts\Console\Kernel::class)->bootstrap();
+        /** @var \Illuminate\Foundation\Application  $app */
+        $app = require __DIR__ . '/../bootstrap/app.php';
+        $app->register(TestServiceProvider::class);
+        $app->make(Kernel::class)->bootstrap();

 
         return $app;
     }
 
 
         return $app;
     }
 

+    /**
+     * Set the current user context to be an admin.
+     */

     public function asAdmin()
     {
     public function asAdmin()
     {

-        if($this->admin === null) {
-            $adminRole = \BookStack\Role::getRole('admin');
-            $this->admin = $adminRole->users->first();
-        }
-        return $this->actingAs($this->admin);
+        return $this->actingAs($this->users->admin());
+    }
+
+    /**
+     * Set the current user context to be an editor.
+     */
+    public function asEditor()
+    {
+        return $this->actingAs($this->users->editor());
+    }
+
+    /**
+     * Set the current user context to be a viewer.
+     */
+    public function asViewer()
+    {
+        return $this->actingAs($this->users->viewer());

     }
 
     /**
      * Quickly sets an array of settings.
     }
 
     /**
      * Quickly sets an array of settings.

-     * @param $settingsArray

      */
      */

-    protected function setSettings($settingsArray)
+    protected function setSettings(array $settingsArray): void

     {
     {

-        $settings = app('BookStack\Services\SettingService');
+        $settings = app(SettingService::class);

         foreach ($settingsArray as $key => $value) {
             $settings->put($key, $value);
         }
     }
 
     /**
         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
+     * Mock the http client used in BookStack http calls.

      */
      */

-    protected function createEntityChainBelongingToUser($creatorUser, $updaterUser = false)
+    protected function mockHttpClient(array $responses = []): HttpClientHistory

     {
     {

-        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]);
-        return [
-            'book' => $book,
-            'chapter' => $chapter,
-            'page' => $page
-        ];
+        return $this->app->make(HttpRequestService::class)->mockClient($responses);

     }
 
     /**
     }
 
     /**

-     * Quick way to create a new user
-     * @param array $attributes
-     * @return mixed
+     * Run a set test with the given env variable.
+     * Remembers the original and resets the value after test.
+     * Database config is juggled so the value can be restored when
+     * parallel testing are used, where multiple databases exist.

      */
      */

-    protected function getNewUser($attributes = [])
+    protected function runWithEnv(array $valuesByKey, callable $callback, bool $handleDatabase = true): void

     {
     {

-        $user = factory(\BookStack\User::class)->create($attributes);
-        $role = \BookStack\Role::getRole('editor');
-        $user->attachRole($role);;
-        return $user;
+        Env::disablePutenv();
+        $originals = [];
+        foreach ($valuesByKey as $key => $value) {
+            $originals[$key] = $_SERVER[$key] ?? null;
+
+            if (is_null($value)) {
+                unset($_SERVER[$key]);
+            } else {
+                $_SERVER[$key] = $value;
+            }
+        }
+
+        $database = config('database.connections.mysql_testing.database');
+        $this->refreshApplication();
+
+        if ($handleDatabase) {
+            DB::purge();
+            config()->set('database.connections.mysql_testing.database', $database);
+            DB::beginTransaction();
+        }
+
+        $callback();
+
+        if ($handleDatabase) {
+            DB::rollBack();
+        }
+
+        foreach ($originals as $key => $value) {
+            if (is_null($value)) {
+                unset($_SERVER[$key]);
+            } else {
+                $_SERVER[$key] = $value;
+            }
+        }

     }
 
     /**
     }
 
     /**

-     * Quick way to create a new user without any permissions
-     * @param array $attributes
-     * @return mixed
+     * Check the keys and properties in the given map to include
+     * exist, albeit not exclusively, within the map to check.

      */
      */

-    protected function getNewBlankUser($attributes = [])
+    protected function assertArrayMapIncludes(array $mapToInclude, array $mapToCheck, string $message = ''): void

     {
     {

-        $user = factory(\BookStack\User::class)->create($attributes);
-        return $user;
+        $passed = true;
+
+        foreach ($mapToInclude as $key => $value) {
+            if (!isset($mapToCheck[$key]) || $mapToCheck[$key] !== $mapToInclude[$key]) {
+                $passed = false;
+            }
+        }
+
+        $toIncludeStr = print_r($mapToInclude, true);
+        $toCheckStr = print_r($mapToCheck, true);
+        self::assertThat($passed, self::isTrue(), "Failed asserting that given map:\n\n{$toCheckStr}\n\nincludes:\n\n{$toIncludeStr}");

     }
 
     /**
     }
 
     /**

-     * Assert that a given string is seen inside an element.
-     *
-     * @param  bool|string|null $element
-     * @param  integer          $position
-     * @param  string           $text
-     * @param  bool             $negate
-     * @return $this
+     * Assert a permission error has occurred.

      */
      */

-    protected function seeInNthElement($element, $position, $text, $negate = false)
+    protected function assertPermissionError($response)

     {
     {

-        $method = $negate ? 'assertNotRegExp' : 'assertRegExp';
-
-        $rawPattern = preg_quote($text, '/');
-
-        $escapedPattern = preg_quote(e($text), '/');
+        PHPUnit::assertTrue($this->isPermissionError($response->baseResponse ?? $response->response), 'Failed asserting the response contains a permission error.');
+    }

 
 

-        $content = $this->crawler->filter($element)->eq($position)->html();
+    /**
+     * 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.');
+    }

 
 

-        $pattern = $rawPattern == $escapedPattern
-            ? $rawPattern : "({$rawPattern}|{$escapedPattern})";
+    /**
+     * Check if the given response is a permission error.
+     */
+    private function isPermissionError($response): bool
+    {
+        if ($response->status() === 403 && $response instanceof JsonResponse) {
+            $errMessage = $response->getData(true)['error']['message'] ?? '';
+            return $errMessage === 'You do not have permission to perform the requested action.';
+        }

 
 

-        $this->$method("/$pattern/i", $content);
+        return $response->status() === 302
+            && $response->headers->get('Location') === url('/')
+            && str_starts_with(session()->pull('error', ''), 'You do not have permission to access');
+    }

 
 

-        return $this;
+    /**
+     * 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}");

     }
 
     /**
     }
 
     /**

-     * Assert that the current page matches a given URI.
-     *
-     * @param  string  $uri
-     * @return $this
+     * Assert the session contains a specific entry.

      */
      */

-    protected function seePageUrlIs($uri)
+    protected function assertSessionHas(string $key): self

     {
     {

-        $this->assertEquals(
-            $uri, $this->currentUri, "Did not land on expected page [{$uri}].\n"
-        );
+        $this->assertTrue(session()->has($key), "Session does not contain a [{$key}] entry");

 
         return $this;
     }
 
 
         return $this;
     }
 

+    protected function assertNotificationContains(\Illuminate\Testing\TestResponse $resp, string $text)
+    {
+        return $this->withHtml($resp)->assertElementContains('.notification[role="alert"]', $text);
+    }
+

     /**
     /**

-     * 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
+     * Set a test handler as the logging interface for the application.
+     * Allows capture of logs for checking against during tests.

      */
      */

-    protected function forceVisit($uri, $parameters = [], $cookies = [], $files = [])
+    protected function withTestLogger(): TestHandler

     {
     {

-        $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;
+        $monolog = new Logger('testing');
+        $testHandler = new TestHandler();
+        $monolog->pushHandler($testHandler);
+
+        Log::extend('testing', function () use ($monolog) {
+            return $monolog;
+        });
+        Log::setDefaultDriver('testing');
+
+        return $testHandler;

     }
 
     /**
     }
 
     /**

-     * 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 $type, ?Entity $entity = null, string $detail = '')

     {
     {

-        $elem = $this->crawler->filter($parentElement);
-        $link = $elem->selectLink($linkText);
-        $this->visit($link->link()->getUri());
-        return $this;
+        $detailsToCheck = ['type' => $type];
+
+        if ($entity) {
+            $detailsToCheck['loggable_type'] = $entity->getMorphClass();
+            $detailsToCheck['loggable_id'] = $entity->id;
+        }
+
+        if ($detail) {
+            $detailsToCheck['detail'] = $detail;
+        }
+
+        $this->assertDatabaseHas('activities', $detailsToCheck);

     }
 }
     }
 }