X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/8d8da31fdd926aab7dc5084e62a96af447a9930a..refs/pull/3918/head:/tests/ThemeTest.php diff --git a/tests/ThemeTest.php b/tests/ThemeTest.php index 551f8350f..efab53379 100644 --- a/tests/ThemeTest.php +++ b/tests/ThemeTest.php @@ -6,6 +6,7 @@ use BookStack\Actions\ActivityType; use BookStack\Actions\DispatchWebhookJob; use BookStack\Actions\Webhook; use BookStack\Auth\User; +use BookStack\Entities\Models\Book; use BookStack\Entities\Models\Page; use BookStack\Entities\Tools\PageContent; use BookStack\Facades\Theme; @@ -17,7 +18,6 @@ use Illuminate\Http\Response; use Illuminate\Support\Facades\Artisan; use Illuminate\Support\Facades\File; use Illuminate\Support\Facades\Http; -use Illuminate\Support\Str; use League\CommonMark\ConfigurableEnvironmentInterface; class ThemeTest extends TestCase @@ -37,7 +37,7 @@ class ThemeTest extends TestCase file_put_contents($translationPath . '/entities.php', $customTranslations); $homeRequest = $this->actingAs($this->getViewer())->get('/'); - $homeRequest->assertElementContains('header nav', 'Sandwiches'); + $this->withHtml($homeRequest)->assertElementContains('header nav', 'Sandwiches'); }); } @@ -64,7 +64,7 @@ class ThemeTest extends TestCase }; Theme::listen(ThemeEvents::COMMONMARK_ENVIRONMENT_CONFIGURE, $callback); - $page = Page::query()->first(); + $page = $this->entities->page(); $content = new PageContent($page); $content->setNewMarkdown('# test'); @@ -197,6 +197,54 @@ class ThemeTest extends TestCase }); } + public function test_event_activity_logged() + { + $book = $this->entities->book(); + $args = []; + $callback = function (...$eventArgs) use (&$args) { + $args = $eventArgs; + }; + + Theme::listen(ThemeEvents::ACTIVITY_LOGGED, $callback); + $this->asEditor()->put($book->getUrl(), ['name' => 'My cool update book!']); + + $this->assertCount(2, $args); + $this->assertEquals(ActivityType::BOOK_UPDATE, $args[0]); + $this->assertTrue($args[1] instanceof Book); + $this->assertEquals($book->id, $args[1]->id); + } + + public function test_event_page_include_parse() + { + /** @var Page $page */ + /** @var Page $otherPage */ + $page = $this->entities->page(); + $otherPage = Page::query()->where('id', '!=', $page->id)->first(); + $otherPage->html = '
This is a really cool section
'; + $page->html = "{{@{$otherPage->id}#bkmrk-cool}}
"; + $page->save(); + $otherPage->save(); + + $args = []; + $callback = function (...$eventArgs) use (&$args) { + $args = $eventArgs; + + return 'Big & content replace surprise!'; + }; + + Theme::listen(ThemeEvents::PAGE_INCLUDE_PARSE, $callback); + $resp = $this->asEditor()->get($page->getUrl()); + $this->withHtml($resp)->assertElementContains('.page-content strong', 'Big & content replace surprise!'); + + $this->assertCount(4, $args); + $this->assertEquals($otherPage->id . '#bkmrk-cool', $args[0]); + $this->assertEquals('This is a really cool section', $args[1]); + $this->assertTrue($args[2] instanceof Page); + $this->assertTrue($args[3] instanceof Page); + $this->assertEquals($page->id, $args[2]->id); + $this->assertEquals($otherPage->id, $args[3]->id); + } + public function test_add_social_driver() { Theme::addSocialDriver('catnet', [ @@ -255,12 +303,12 @@ class ThemeTest extends TestCase $this->assertStringContainsString('Command ran!', $output); } - public function test_body_start_and_end_template_files_can_be_used() + public function test_base_body_start_and_end_template_files_can_be_used() { $bodyStartStr = 'barry-fought-against-the-panther'; $bodyEndStr = 'barry-lost-his-fight-with-grace'; - $this->usingThemeFolder(function(string $folder) use ($bodyStartStr, $bodyEndStr) { + $this->usingThemeFolder(function (string $folder) use ($bodyStartStr, $bodyEndStr) { $viewDir = theme_path('layouts/parts'); mkdir($viewDir, 0777, true); file_put_contents($viewDir . '/base-body-start.blade.php', $bodyStartStr); @@ -272,21 +320,56 @@ class ThemeTest extends TestCase }); } + public function test_export_body_start_and_end_template_files_can_be_used() + { + $bodyStartStr = 'garry-fought-against-the-panther'; + $bodyEndStr = 'garry-lost-his-fight-with-grace'; + $page = $this->entities->page(); + + $this->usingThemeFolder(function (string $folder) use ($bodyStartStr, $bodyEndStr, $page) { + $viewDir = theme_path('layouts/parts'); + mkdir($viewDir, 0777, true); + file_put_contents($viewDir . '/export-body-start.blade.php', $bodyStartStr); + file_put_contents($viewDir . '/export-body-end.blade.php', $bodyEndStr); + + $resp = $this->asEditor()->get($page->getUrl('/export/html')); + $resp->assertSee($bodyStartStr); + $resp->assertSee($bodyEndStr); + }); + } + + public function test_login_and_register_message_template_files_can_be_used() + { + $loginMessage = 'Welcome to this instance, login below you scallywag'; + $registerMessage = 'You want to register? Enter the deets below you numpty'; + + $this->usingThemeFolder(function (string $folder) use ($loginMessage, $registerMessage) { + $viewDir = theme_path('auth/parts'); + mkdir($viewDir, 0777, true); + file_put_contents($viewDir . '/login-message.blade.php', $loginMessage); + file_put_contents($viewDir . '/register-message.blade.php', $registerMessage); + $this->setSettings(['registration-enabled' => 'true']); + + $this->get('/login')->assertSee($loginMessage); + $this->get('/register')->assertSee($registerMessage); + }); + } + protected function usingThemeFolder(callable $callback) { // Create a folder and configure a theme - $themeFolderName = 'testing_theme_' . rtrim(base64_encode(time()), '='); + $themeFolderName = 'testing_theme_' . str_shuffle(rtrim(base64_encode(time()), '=')); config()->set('view.theme', $themeFolderName); $themeFolderPath = theme_path(''); + + // Create theme folder and clean it up on application tear-down File::makeDirectory($themeFolderPath); + $this->beforeApplicationDestroyed(fn() => File::deleteDirectory($themeFolderPath)); // Run provided callback with theme env option set - $this->runWithEnv('APP_THEME', $themeFolderName, function() use ($callback, $themeFolderName) { + $this->runWithEnv('APP_THEME', $themeFolderName, function () use ($callback, $themeFolderName) { call_user_func($callback, $themeFolderName); }); - - // Cleanup the custom theme folder we created - File::deleteDirectory($themeFolderPath); } }