X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/919660678bec2b94eaa84ac60d0313f5ef07dfb7..refs/pull/2393/head:/tests/SharedTestHelpers.php diff --git a/tests/SharedTestHelpers.php b/tests/SharedTestHelpers.php index 80fab874c..ffcc6f40c 100644 --- a/tests/SharedTestHelpers.php +++ b/tests/SharedTestHelpers.php @@ -1,15 +1,28 @@ users()->first(); - if (!empty($attributes)) $user->forceFill($attributes)->save(); + $user = Role::getRole('viewer')->users()->first(); + if (!empty($attributes)) { + $user->forceFill($attributes)->save(); + } return $user; } /** * Regenerate the permission for an entity. * @param Entity $entity + * @throws Throwable */ protected function regenEntityPermissions(Entity $entity) { - $this->app[PermissionService::class]->buildJointPermissionsForEntity($entity); + $entity->rebuildPermissions(); $entity->load('jointPermissions'); } /** * Create and return a new bookshelf. * @param array $input - * @return \BookStack\Entities\Bookshelf + * @return Bookshelf */ public function newShelf($input = ['name' => 'test shelf', 'description' => 'My new test shelf']) { - return $this->app[EntityRepo::class]->createFromInput('bookshelf', $input, false); + return app(BookshelfRepo::class)->create($input, []); } /** @@ -97,29 +111,30 @@ trait SharedTestHelpers * @return Book */ public function newBook($input = ['name' => 'test book', 'description' => 'My new test book']) { - return $this->app[EntityRepo::class]->createFromInput('book', $input, false); + return app(BookRepo::class)->create($input); } /** * Create and return a new test chapter * @param array $input * @param Book $book - * @return \BookStack\Entities\Chapter + * @return Chapter */ public function newChapter($input = ['name' => 'test chapter', 'description' => 'My new test chapter'], Book $book) { - return $this->app[EntityRepo::class]->createFromInput('chapter', $input, $book); + return app(ChapterRepo::class)->create($input, $book); } /** * Create and return a new test page * @param array $input * @return Page + * @throws Throwable */ 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); + $pageRepo = app(PageRepo::class); + $draftPage = $pageRepo->getNewDraftPage($book); + return $pageRepo->publishDraft($draftPage, $input); } /** @@ -164,10 +179,10 @@ trait SharedTestHelpers /** * Give the given user some permissions. - * @param \BookStack\Auth\User $user + * @param User $user * @param array $permissions */ - protected function giveUserPermissions(\BookStack\Auth\User $user, $permissions = []) + protected function giveUserPermissions(User $user, $permissions = []) { $newRole = $this->createNewRole($permissions); $user->attachRole($newRole); @@ -188,4 +203,112 @@ trait SharedTestHelpers return $permissionRepo->saveNewRole($roleData); } + /** + * Mock the HttpFetcher service and return the given data on fetch. + * @param $returnData + * @param int $times + */ + protected function mockHttpFetch($returnData, int $times = 1) + { + $mockHttp = Mockery::mock(HttpFetcher::class); + $this->app[HttpFetcher::class] = $mockHttp; + $mockHttp->shouldReceive('fetch') + ->times($times) + ->andReturn($returnData); + } + + /** + * Run a set test with the given env variable. + * Remembers the original and resets the value after test. + * @param string $name + * @param $value + * @param callable $callback + */ + 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; + } + + $this->refreshApplication(); + $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. + * @param array $mapToInclude + * @param array $mapToCheck + * @param string $message + */ + 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; + } + + /** + * 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; + } + } \ No newline at end of file