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

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