-<?php
+<?php namespace Tests;
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';
- // Local user instances
- private $admin;
- private $editor;
-
- /**
- * 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;
- }
-
- /**
- * Set the current user context to be an admin.
- * @return $this
- */
- public function asAdmin()
- {
- return $this->actingAs($this->getAdmin());
- }
-
- /**
- * 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
- */
- public function asEditor()
- {
- if($this->editor === null) {
- $this->editor = $this->getEditor();
- }
- return $this->actingAs($this->editor);
- }
-
- /**
- * 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\PermissionService::class];
- $restrictionService->buildJointPermissionsForEntity($book);
- return [
- 'book' => $book,
- 'chapter' => $chapter,
- 'page' => $page
- ];
- }
-
- /**
- * Quick way to create a new user
- * @param array $attributes
- * @return mixed
- */
- protected function getEditor($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
- * @return $this
- */
- protected function seeInNthElement($element, $position, $text, $negate = false)
- {
- $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);
-
- return $this;
- }
-
/**
- * Assert that the current page matches a given URI.
- *
- * @param string $uri
- * @return $this
+ * Assert a permission error has occurred.
+ * @param TestResponse $response
+ * @return TestCase
*/
- protected function seePageUrlIs($uri)
+ protected function assertPermissionError(TestResponse $response)
{
- $this->assertEquals(
- $uri, $this->currentUri, "Did not land on expected page [{$uri}].\n"
- );
-
+ $response->assertRedirect('/');
+ $this->assertSessionHas('error');
+ session()->remove('error');
return $this;
}
/**
- * Do a forced visit that does not error out on exception.
- * @param string $uri
- * @param array $parameters
- * @param array $cookies
- * @param array $files
+ * Assert the session contains a specific entry.
+ * @param string $key
* @return $this
*/
- protected function forceVisit($uri, $parameters = [], $cookies = [], $files = [])
+ protected function assertSessionHas(string $key)
{
- $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);
+ $this->assertTrue(session()->has($key), "Session does not contain a [{$key}] entry");
return $this;
}
/**
- * Click the text within the selected element.
- * @param $parentElement
- * @param $linkText
- * @return $this
- */
- protected function clickInElement($parentElement, $linkText)
- {
- $elem = $this->crawler->filter($parentElement);
- $link = $elem->selectLink($linkText);
- $this->visit($link->link()->getUri());
- return $this;
- }
-
- /**
- * Check if the page contains the given element.
- * @param string $selector
- * @return bool
+ * Override of the get method so we can get visibility of custom TestResponse methods.
+ * @param string $uri
+ * @param array $headers
+ * @return TestResponse
*/
- protected function pageHasElement($selector)
+ public function get($uri, array $headers = [])
{
- $elements = $this->crawler->filter($selector);
- $this->assertTrue(count($elements) > 0, "The page does not contain an element matching " . $selector);
- return $this;
+ return parent::get($uri, $headers);
}
/**
- * Check if the page contains the given element.
- * @param string $selector
- * @return bool
+ * Create the test response instance from the given response.
+ *
+ * @param \Illuminate\Http\Response $response
+ * @return TestResponse
*/
- protected function pageNotHasElement($selector)
+ protected function createTestResponse($response)
{
- $elements = $this->crawler->filter($selector);
- $this->assertFalse(count($elements) > 0, "The page contains " . count($elements) . " elements matching " . $selector);
- return $this;
+ return TestResponse::fromBaseResponse($response);
}
-}
+}
\ No newline at end of file
projects / bookstack / blobdiff