BookStack Code Mirror - bookstack/blob - tests/ThemeTest.php

   1 <?php namespace Tests;
   2
   3 use BookStack\Entities\Models\Page;
   4 use BookStack\Entities\Tools\PageContent;
   5 use BookStack\Facades\Theme;
   6 use BookStack\Theming\ThemeEvents;
   7 use File;
   8 use Illuminate\Http\Request;
   9 use Illuminate\Http\Response;
  10 use League\CommonMark\ConfigurableEnvironmentInterface;
  11
  12 class ThemeTest extends TestCase
  13 {
  14     protected $themeFolderName;
  15     protected $themeFolderPath;
  16
  17     public function test_translation_text_can_be_overridden_via_theme()
  18     {
  19         $this->usingThemeFolder(function () {
  20             $translationPath = theme_path('/lang/en');
  21             File::makeDirectory($translationPath, 0777, true);
  22
  23             $customTranslations = '<?php
  24             return [\'books\' => \'Sandwiches\'];
  25         ';
  26             file_put_contents($translationPath . '/entities.php', $customTranslations);
  27
  28             $homeRequest = $this->actingAs($this->getViewer())->get('/');
  29             $homeRequest->assertElementContains('header nav', 'Sandwiches');
  30         });
  31     }
  32
  33     public function test_theme_functions_file_used_and_app_boot_event_runs()
  34     {
  35         $this->usingThemeFolder(function ($themeFolder) {
  36             $functionsFile = theme_path('functions.php');
  37             app()->alias('cat', 'dog');
  38             file_put_contents($functionsFile, "<?php\nTheme::listen(\BookStack\Theming\ThemeEvents::APP_BOOT, function(\$app) { \$app->alias('cat', 'dog');});");
  39             $this->runWithEnv('APP_THEME', $themeFolder, function () {
  40                 $this->assertEquals('cat', $this->app->getAlias('dog'));
  41             });
  42         });
  43     }
  44
  45     public function test_event_commonmark_environment_configure()
  46     {
  47         $callbackCalled = false;
  48         $callback = function ($environment) use (&$callbackCalled) {
  49             $this->assertInstanceOf(ConfigurableEnvironmentInterface::class, $environment);
  50             $callbackCalled = true;
  51             return $environment;
  52         };
  53         Theme::listen(ThemeEvents::COMMONMARK_ENVIRONMENT_CONFIGURE, $callback);
  54
  55         $page = Page::query()->first();
  56         $content = new PageContent($page);
  57         $content->setNewMarkdown('# test');
  58
  59         $this->assertTrue($callbackCalled);
  60     }
  61
  62     public function test_event_web_middleware_before()
  63     {
  64         $callbackCalled = false;
  65         $requestParam = null;
  66         $callback = function ($request) use (&$callbackCalled, &$requestParam) {
  67             $requestParam = $request;
  68             $callbackCalled = true;
  69         };
  70
  71         Theme::listen(ThemeEvents::WEB_MIDDLEWARE_BEFORE, $callback);
  72         $this->get('/login', ['Donkey' => 'cat']);
  73
  74         $this->assertTrue($callbackCalled);
  75         $this->assertInstanceOf(Request::class, $requestParam);
  76         $this->assertEquals('cat', $requestParam->header('donkey'));
  77     }
  78
  79     public function test_event_web_middleware_before_return_val_used_as_response()
  80     {
  81         $callback = function (Request $request) {
  82             return response('cat', 412);
  83         };
  84
  85         Theme::listen(ThemeEvents::WEB_MIDDLEWARE_BEFORE, $callback);
  86         $resp = $this->get('/login', ['Donkey' => 'cat']);
  87         $resp->assertSee('cat');
  88         $resp->assertStatus(412);
  89     }
  90
  91     public function test_event_web_middleware_after()
  92     {
  93         $callbackCalled = false;
  94         $requestParam = null;
  95         $responseParam = null;
  96         $callback = function ($request, Response $response) use (&$callbackCalled, &$requestParam, &$responseParam) {
  97             $requestParam = $request;
  98             $responseParam = $response;
  99             $callbackCalled = true;
 100             $response->header('donkey', 'cat123');
 101         };
 102
 103         Theme::listen(ThemeEvents::WEB_MIDDLEWARE_AFTER, $callback);
 104
 105         $resp = $this->get('/login', ['Donkey' => 'cat']);
 106         $this->assertTrue($callbackCalled);
 107         $this->assertInstanceOf(Request::class, $requestParam);
 108         $this->assertInstanceOf(Response::class, $responseParam);
 109         $resp->assertHeader('donkey', 'cat123');
 110     }
 111
 112     public function test_event_web_middleware_after_return_val_used_as_response()
 113     {
 114         $callback = function () {
 115             return response('cat456', 443);
 116         };
 117
 118         Theme::listen(ThemeEvents::WEB_MIDDLEWARE_AFTER, $callback);
 119
 120         $resp = $this->get('/login', ['Donkey' => 'cat']);
 121         $resp->assertSee('cat456');
 122         $resp->assertStatus(443);
 123     }
 124
 125     public function test_add_social_driver()
 126     {
 127         Theme::addSocialDriver('catnet', [
 128             'client_id' => 'abc123',
 129             'client_secret' => 'def456'
 130         ], 'SocialiteProviders\Discord\DiscordExtendSocialite@handleTesting');
 131
 132         $this->assertEquals('catnet', config('services.catnet.name'));
 133         $this->assertEquals('abc123', config('services.catnet.client_id'));
 134         $this->assertEquals(url('/login/service/catnet/callback'), config('services.catnet.redirect'));
 135
 136         $loginResp = $this->get('/login');
 137         $loginResp->assertSee('login/service/catnet');
 138     }
 139
 140     public function test_add_social_driver_uses_name_in_config_if_given()
 141     {
 142         Theme::addSocialDriver('catnet', [
 143             'client_id' => 'abc123',
 144             'client_secret' => 'def456',
 145             'name' => 'Super Cat Name',
 146         ], 'SocialiteProviders\Discord\DiscordExtendSocialite@handleTesting');
 147
 148         $this->assertEquals('Super Cat Name', config('services.catnet.name'));
 149         $loginResp = $this->get('/login');
 150         $loginResp->assertSee('Super Cat Name');
 151     }
 152
 153     protected function usingThemeFolder(callable $callback)
 154     {
 155         // Create a folder and configure a theme
 156         $themeFolderName = 'testing_theme_' . rtrim(base64_encode(time()), "=");
 157         config()->set('view.theme', $themeFolderName);
 158         $themeFolderPath = theme_path('');
 159         File::makeDirectory($themeFolderPath);
 160
 161         call_user_func($callback, $themeFolderName);
 162
 163         // Cleanup the custom theme folder we created
 164         File::deleteDirectory($themeFolderPath);
 165     }
 166
 167 }