<?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 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 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.
- *
- * @var string
*/
- protected $baseUrl = 'http://localhost';
-
- // Local user instances
- private $admin;
- private $editor;
+ protected string $baseUrl = 'http://localhost';
/**
* Creates the application.
*/
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;
}
/**
* Set the current user context to be an admin.
- * @return $this
*/
public function asAdmin()
{
- return $this->actingAs($this->getAdmin());
+ return $this->actingAs($this->users->admin());
}
/**
- * Get the current admin user.
- * @return mixed
- */
- public function getAdmin() {
- if($this->admin === null) {
- $adminRole = \BookStack\Role::getRole('admin');
- $this->admin = $adminRole->users->first();
- }
- return $this->admin;
- }
-
- /**
- * Set the current editor context to be an editor.
- * @return $this
+ * Set the current user context to be an editor.
*/
public function asEditor()
{
- if ($this->editor === null) {
- $this->editor = $this->getEditor();
- }
- return $this->actingAs($this->editor);
+ return $this->actingAs($this->users->editor());
}
/**
- * Get a user that's not a system user such as the guest user.
+ * Set the current user context to be a viewer.
*/
- public function getNormalUser()
+ public function asViewer()
{
- return \BookStack\User::where('system_name', '=', null)->get()->last();
+ return $this->actingAs($this->users->viewer());
}
/**
* 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);
}
}
/**
- * 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]);
- $restrictionService = $this->app[\BookStack\Services\PermissionService::class];
- $restrictionService->buildJointPermissionsForEntity($book);
- 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 getEditor($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), '/');
-
- $content = $this->crawler->filter($element)->eq($position)->html();
-
- $pattern = $rawPattern == $escapedPattern
- ? $rawPattern : "({$rawPattern}|{$escapedPattern})";
-
- $this->$method("/$pattern/i", $content);
+ PHPUnit::assertTrue($this->isPermissionError($response->baseResponse ?? $response->response), 'Failed asserting the response contains a permission error.');
+ }
- return $this;
+ /**
+ * 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.');
}
/**
- * Assert that the current page matches a given URI.
- *
- * @param string $uri
- * @return $this
+ * Check if the given response is a permission error.
*/
- protected function seePageUrlIs($uri)
+ private function isPermissionError($response): bool
{
- $this->assertEquals(
- $uri, $this->currentUri, "Did not land on expected page [{$uri}].\n"
- );
+ 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.';
+ }
- return $this;
+ return $response->status() === 302
+ && $response->headers->get('Location') === url('/')
+ && str_starts_with(session()->pull('error', ''), 'You do not have permission to access');
}
/**
- * 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
+ * Assert that the session has a particular error notification message set.
*/
- protected function forceVisit($uri, $parameters = [], $cookies = [], $files = [])
+ protected function assertSessionError(string $message)
{
- $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;
+ $error = session()->get('error');
+ PHPUnit::assertTrue($error === $message, "Failed asserting the session contains an error. \nFound: {$error}\nExpecting: {$message}");
}
/**
- * Click the text within the selected element.
- * @param $parentElement
- * @param $linkText
- * @return $this
+ * Assert the session contains a specific entry.
*/
- protected function clickInElement($parentElement, $linkText)
+ protected function assertSessionHas(string $key): self
{
- $elem = $this->crawler->filter($parentElement);
- $link = $elem->selectLink($linkText);
- $this->visit($link->link()->getUri());
+ $this->assertTrue(session()->has($key), "Session does not contain a [{$key}] entry");
+
return $this;
}
+ protected function assertNotificationContains(\Illuminate\Testing\TestResponse $resp, string $text)
+ {
+ return $this->withHtml($resp)->assertElementContains('.notification[role="alert"]', $text);
+ }
+
/**
- * Check if the page contains the given element.
- * @param string $selector
- * @return bool
+ * Set a test handler as the logging interface for the application.
+ * Allows capture of logs for checking against during tests.
*/
- protected function pageHasElement($selector)
+ protected function withTestLogger(): TestHandler
{
- $elements = $this->crawler->filter($selector);
- $this->assertTrue(count($elements) > 0, "The page does not contain an element matching " . $selector);
- 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;
}
/**
- * Check if the page contains the given element.
- * @param string $selector
- * @return bool
+ * Assert that an activity entry exists of the given key.
+ * Checks the activity belongs to the given entity if provided.
*/
- protected function pageNotHasElement($selector)
+ protected function assertActivityExists(string $type, ?Entity $entity = null, string $detail = '')
{
- $elements = $this->crawler->filter($selector);
- $this->assertFalse(count($elements) > 0, "The page contains " . count($elements) . " elements matching " . $selector);
- 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);
}
}
projects / bookstack / blobdiff