-<?php namespace Tests;
+<?php
-use BookStack\Book;
-use BookStack\Chapter;
-use BookStack\Repos\EntityRepo;
-use BookStack\Role;
-use BookStack\Services\SettingService;
+namespace Tests;
+
+use BookStack\Auth\Permissions\JointPermissionBuilder;
+use BookStack\Auth\Permissions\PermissionsRepo;
+use BookStack\Auth\Permissions\RolePermission;
+use BookStack\Auth\Role;
+use BookStack\Auth\User;
+use BookStack\Entities\Models\Entity;
+use BookStack\Settings\SettingService;
+use BookStack\Uploads\HttpFetcher;
+use GuzzleHttp\Client;
+use GuzzleHttp\Handler\MockHandler;
+use GuzzleHttp\HandlerStack;
+use GuzzleHttp\Middleware;
+use Illuminate\Contracts\Console\Kernel;
use Illuminate\Foundation\Testing\DatabaseTransactions;
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 Psr\Http\Client\ClientInterface;
+use Ssddanbrown\AssertHtml\TestsHtml;
+use Tests\Helpers\EntityProvider;
+use Tests\Helpers\TestServiceProvider;
abstract class TestCase extends BaseTestCase
{
use CreatesApplication;
use DatabaseTransactions;
+ use TestsHtml;
+
+ protected ?User $admin = null;
+ protected ?User $editor = null;
+ protected EntityProvider $entities;
- protected $admin;
- protected $editor;
+ protected function setUp(): void
+ {
+ $this->entities = new EntityProvider();
+ parent::setUp();
+ }
/**
* The base URL to use while testing the application.
- * @var string
*/
- protected $baseUrl = 'http://localhost';
+ protected string $baseUrl = 'http://localhost';
+
+ /**
+ * Creates the application.
+ *
+ * @return \Illuminate\Foundation\Application
+ */
+ public function createApplication()
+ {
+ /** @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()
{
/**
* 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();
}
+
return $this->admin;
}
/**
* Set the current user context to be an editor.
- * @return $this
*/
public function asEditor()
{
return $this->actingAs($this->getEditor());
}
-
/**
* Get a editor user.
- * @return mixed
*/
- public function getEditor() {
- if($this->editor === null) {
+ protected function getEditor(): User
+ {
+ if ($this->editor === null) {
$editorRole = Role::getRole('editor');
$this->editor = $editorRole->users->first();
}
+
return $this->editor;
}
/**
- * Create and return a new book.
- * @param array $input
- * @return Book
+ * Set the current user context to be a viewer.
*/
- public function newBook($input = ['name' => 'test book', 'description' => 'My new test book']) {
- return $this->app[EntityRepo::class]->createFromInput('book', $input, false);
+ public function asViewer()
+ {
+ return $this->actingAs($this->getViewer());
}
/**
- * Create and return a new test chapter
- * @param array $input
- * @param Book $book
- * @return Chapter
+ * Get an instance of a user with 'viewer' permissions.
*/
- public function newChapter($input = ['name' => 'test chapter', 'description' => 'My new test chapter'], Book $book) {
- return $this->app[EntityRepo::class]->createFromInput('chapter', $input, $book);
+ protected function getViewer(array $attributes = []): User
+ {
+ $user = Role::getRole('viewer')->users()->first();
+ if (!empty($attributes)) {
+ $user->forceFill($attributes)->save();
+ }
+
+ return $user;
}
/**
- * Create and return a new test page
- * @param array $input
- * @return Chapter
+ * Get a user that's not a system user such as the guest user.
*/
- public function newPage($input = ['name' => 'test page', 'html' => 'My new test page']) {
- $book = Book::first();
- $entityRepo = $this->app[EntityRepo::class];
- $draftPage = $entityRepo->getDraftPage($book);
- return $entityRepo->publishPageDraft($draftPage, $input);
+ public function getNormalUser(): User
+ {
+ return User::query()->where('system_name', '=', null)->get()->last();
}
/**
* 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->put($key, $value);
}
}
-}
\ No newline at end of file
+
+ /**
+ * Give the given user some permissions.
+ */
+ protected function giveUserPermissions(User $user, array $permissions = []): void
+ {
+ $newRole = $this->createNewRole($permissions);
+ $user->attachRole($newRole);
+ $user->load('roles');
+ $user->clearPermissionCache();
+ }
+
+ /**
+ * Completely remove the given permission name from the given user.
+ */
+ protected function removePermissionFromUser(User $user, string $permissionName)
+ {
+ $permissionBuilder = app()->make(JointPermissionBuilder::class);
+
+ /** @var RolePermission $permission */
+ $permission = RolePermission::query()->where('name', '=', $permissionName)->firstOrFail();
+
+ $roles = $user->roles()->whereHas('permissions', function ($query) use ($permission) {
+ $query->where('id', '=', $permission->id);
+ })->get();
+
+ /** @var Role $role */
+ foreach ($roles as $role) {
+ $role->detachPermission($permission);
+ $permissionBuilder->rebuildForRole($role);
+ }
+
+ $user->clearPermissionCache();
+ }
+
+ /**
+ * Create a new basic role for testing purposes.
+ */
+ protected function createNewRole(array $permissions = []): Role
+ {
+ $permissionRepo = app(PermissionsRepo::class);
+ $roleData = Role::factory()->make()->toArray();
+ $roleData['permissions'] = array_flip($permissions);
+
+ return $permissionRepo->saveNewRole($roleData);
+ }
+
+ /**
+ * Mock the HttpFetcher service and return the given data on fetch.
+ */
+ protected function mockHttpFetch($returnData, int $times = 1)
+ {
+ $mockHttp = Mockery::mock(HttpFetcher::class);
+ $this->app[HttpFetcher::class] = $mockHttp;
+ $mockHttp->shouldReceive('fetch')
+ ->times($times)
+ ->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.
+ * Database config is juggled so the value can be restored when
+ * parallel testing are used, where multiple databases exist.
+ */
+ protected function runWithEnv(string $name, $value, callable $callback)
+ {
+ Env::disablePutenv();
+ $originalVal = $_SERVER[$name] ?? null;
+
+ if (is_null($value)) {
+ unset($_SERVER[$name]);
+ } else {
+ $_SERVER[$name] = $value;
+ }
+
+ $database = config('database.connections.mysql_testing.database');
+ $this->refreshApplication();
+
+ DB::purge();
+ config()->set('database.connections.mysql_testing.database', $database);
+
+ $callback();
+
+ if (is_null($originalVal)) {
+ unset($_SERVER[$name]);
+ } else {
+ $_SERVER[$name] = $originalVal;
+ }
+ }
+
+ /**
+ * Check the keys and properties in the given map to include
+ * exist, albeit not exclusively, within the map to check.
+ */
+ protected function assertArrayMapIncludes(array $mapToInclude, array $mapToCheck, string $message = ''): void
+ {
+ $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 a permission error has occurred.
+ */
+ protected function assertPermissionError($response)
+ {
+ PHPUnit::assertTrue($this->isPermissionError($response->baseResponse ?? $response->response), 'Failed asserting the response contains a permission error.');
+ }
+
+ /**
+ * 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.');
+ }
+
+ /**
+ * Check if the given response is a permission error.
+ */
+ 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 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}");
+ }
+
+ /**
+ * Assert the session contains a specific entry.
+ */
+ protected function assertSessionHas(string $key): self
+ {
+ $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]', $text);
+ }
+
+ /**
+ * Set a test handler as the logging interface for the application.
+ * Allows capture of logs for checking against during tests.
+ */
+ protected function withTestLogger(): TestHandler
+ {
+ $monolog = new Logger('testing');
+ $testHandler = new TestHandler();
+ $monolog->pushHandler($testHandler);
+
+ Log::extend('testing', function () use ($monolog) {
+ return $monolog;
+ });
+ Log::setDefaultDriver('testing');
+
+ return $testHandler;
+ }
+
+ /**
+ * Assert that an activity entry exists of the given key.
+ * Checks the activity belongs to the given entity if provided.
+ */
+ protected function assertActivityExists(string $type, ?Entity $entity = null, string $detail = '')
+ {
+ $detailsToCheck = ['type' => $type];
+
+ if ($entity) {
+ $detailsToCheck['entity_type'] = $entity->getMorphClass();
+ $detailsToCheck['entity_id'] = $entity->id;
+ }
+
+ if ($detail) {
+ $detailsToCheck['detail'] = $detail;
+ }
+
+ $this->assertDatabaseHas('activities', $detailsToCheck);
+ }
+}
projects / bookstack / blobdiff