mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-10-01 01:36:00 -04:00
829fecd338
- Updated remaining dependancies - Upped min versions used - Updated GH actions to drop 7.2 and include 8.0 - Updated phpunit & tests to 9.x
208 lines
5.9 KiB
PHP
208 lines
5.9 KiB
PHP
<?php namespace Tests;
|
|
|
|
use BookStack\Auth\User;
|
|
use BookStack\Entities\Models\Book;
|
|
use BookStack\Entities\Models\Chapter;
|
|
use BookStack\Entities\Models\Entity;
|
|
use BookStack\Auth\Permissions\PermissionService;
|
|
use BookStack\Entities\Models\Page;
|
|
use BookStack\Settings\SettingService;
|
|
use DB;
|
|
use Illuminate\Contracts\Console\Kernel;
|
|
use Illuminate\Foundation\Application;
|
|
use Illuminate\Foundation\Testing\DatabaseTransactions;
|
|
use Laravel\BrowserKitTesting\TestCase;
|
|
use Symfony\Component\DomCrawler\Crawler;
|
|
|
|
abstract class BrowserKitTest extends TestCase
|
|
{
|
|
|
|
use DatabaseTransactions;
|
|
use SharedTestHelpers;
|
|
|
|
/**
|
|
* The base URL to use while testing the application.
|
|
* @var string
|
|
*/
|
|
protected $baseUrl = 'http://localhost';
|
|
|
|
public function tearDown() : void
|
|
{
|
|
DB::disconnect();
|
|
parent::tearDown();
|
|
}
|
|
|
|
/**
|
|
* Creates the application.
|
|
*
|
|
* @return Application
|
|
*/
|
|
public function createApplication()
|
|
{
|
|
$app = require __DIR__.'/../bootstrap/app.php';
|
|
|
|
$app->make(Kernel::class)->bootstrap();
|
|
|
|
return $app;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get a user that's not a system user such as the guest user.
|
|
*/
|
|
public function getNormalUser()
|
|
{
|
|
return User::where('system_name', '=', null)->get()->last();
|
|
}
|
|
|
|
/**
|
|
* Quickly sets an array of settings.
|
|
* @param $settingsArray
|
|
*/
|
|
protected function setSettings($settingsArray)
|
|
{
|
|
$settings = app(SettingService::class);
|
|
foreach ($settingsArray as $key => $value) {
|
|
$settings->put($key, $value);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Create a group of entities that belong to a specific user.
|
|
*/
|
|
protected function createEntityChainBelongingToUser(User $creatorUser, ?User $updaterUser = null): array
|
|
{
|
|
if (empty($updaterUser)) {
|
|
$updaterUser = $creatorUser;
|
|
}
|
|
|
|
$userAttrs = ['created_by' => $creatorUser->id, 'owned_by' => $creatorUser->id, 'updated_by' => $updaterUser->id];
|
|
$book = factory(Book::class)->create($userAttrs);
|
|
$chapter = factory(Chapter::class)->create(array_merge(['book_id' => $book->id], $userAttrs));
|
|
$page = factory(Page::class)->create(array_merge(['book_id' => $book->id, 'chapter_id' => $chapter->id], $userAttrs));
|
|
$restrictionService = $this->app[PermissionService::class];
|
|
$restrictionService->buildJointPermissionsForEntity($book);
|
|
|
|
return compact('book', 'chapter', 'page');
|
|
}
|
|
|
|
/**
|
|
* Helper for updating entity permissions.
|
|
* @param Entity $entity
|
|
*/
|
|
protected function updateEntityPermissions(Entity $entity)
|
|
{
|
|
$restrictionService = $this->app[PermissionService::class];
|
|
$restrictionService->buildJointPermissionsForEntity($entity);
|
|
}
|
|
|
|
|
|
/**
|
|
* Quick way to create a new user without any permissions
|
|
* @param array $attributes
|
|
* @return mixed
|
|
*/
|
|
protected function getNewBlankUser($attributes = [])
|
|
{
|
|
$user = factory(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 ? 'assertDoesNotMatchRegularExpression' : 'assertMatchesRegularExpression';
|
|
|
|
$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
|
|
*/
|
|
protected function seePageUrlIs($uri)
|
|
{
|
|
$this->assertEquals(
|
|
$uri, $this->currentUri, "Did not land on expected page [{$uri}].\n"
|
|
);
|
|
|
|
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
|
|
* @return $this
|
|
*/
|
|
protected function forceVisit($uri, $parameters = [], $cookies = [], $files = [])
|
|
{
|
|
$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;
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
protected function pageHasElement($selector)
|
|
{
|
|
$elements = $this->crawler->filter($selector);
|
|
$this->assertTrue(count($elements) > 0, "The page does not contain an element matching " . $selector);
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Check if the page contains the given element.
|
|
* @param string $selector
|
|
*/
|
|
protected function pageNotHasElement($selector)
|
|
{
|
|
$elements = $this->crawler->filter($selector);
|
|
$this->assertFalse(count($elements) > 0, "The page contains " . count($elements) . " elements matching " . $selector);
|
|
return $this;
|
|
}
|
|
}
|