BookStack Code Mirror - bookstack/blob - tests/User/UserManagementTest.php

   1 <?php
   2
   3 namespace Tests\User;
   4
   5 use BookStack\Actions\ActivityType;
   6 use BookStack\Auth\Access\UserInviteService;
   7 use BookStack\Auth\Role;
   8 use BookStack\Auth\User;
   9 use BookStack\Uploads\Image;
  10 use Illuminate\Support\Facades\Hash;
  11 use Illuminate\Support\Str;
  12 use Mockery\MockInterface;
  13 use RuntimeException;
  14 use Tests\TestCase;
  15
  16 class UserManagementTest extends TestCase
  17 {
  18     public function test_user_creation()
  19     {
  20         /** @var User $user */
  21         $user = User::factory()->make();
  22         $adminRole = Role::getRole('admin');
  23
  24         $resp = $this->asAdmin()->get('/settings/users');
  25         $this->withHtml($resp)->assertElementContains('a[href="' . url('/settings/users/create') . '"]', 'Add New User');
  26
  27         $resp = $this->get('/settings/users/create');
  28         $this->withHtml($resp)->assertElementContains('form[action="' . url('/settings/users/create') . '"]', 'Save');
  29
  30         $resp = $this->post('/settings/users/create', [
  31             'name'                          => $user->name,
  32             'email'                         => $user->email,
  33             'password'                      => $user->password,
  34             'password-confirm'              => $user->password,
  35             'roles[' . $adminRole->id . ']' => 'true',
  36         ]);
  37         $resp->assertRedirect('/settings/users');
  38
  39         $resp = $this->get('/settings/users');
  40         $resp->assertSee($user->name);
  41
  42         $this->assertDatabaseHas('users', $user->only('name', 'email'));
  43
  44         $user->refresh();
  45         $this->assertStringStartsWith(Str::slug($user->name), $user->slug);
  46     }
  47
  48     public function test_user_updating()
  49     {
  50         $user = $this->users->viewer();
  51         $password = $user->password;
  52
  53         $resp = $this->asAdmin()->get('/settings/users/' . $user->id);
  54         $resp->assertSee($user->email);
  55
  56         $this->put($user->getEditUrl(), [
  57             'name' => 'Barry Scott',
  58         ])->assertRedirect('/settings/users');
  59
  60         $this->assertDatabaseHas('users', ['id' => $user->id, 'name' => 'Barry Scott', 'password' => $password]);
  61         $this->assertDatabaseMissing('users', ['name' => $user->name]);
  62
  63         $user->refresh();
  64         $this->assertStringStartsWith(Str::slug($user->name), $user->slug);
  65     }
  66
  67     public function test_user_password_update()
  68     {
  69         $user = $this->users->viewer();
  70         $userProfilePage = '/settings/users/' . $user->id;
  71
  72         $this->asAdmin()->get($userProfilePage);
  73         $this->put($userProfilePage, [
  74             'password' => 'newpassword',
  75         ])->assertRedirect($userProfilePage);
  76
  77         $this->get($userProfilePage)->assertSee('Password confirmation required');
  78
  79         $this->put($userProfilePage, [
  80             'password'         => 'newpassword',
  81             'password-confirm' => 'newpassword',
  82         ])->assertRedirect('/settings/users');
  83
  84         $userPassword = User::query()->find($user->id)->password;
  85         $this->assertTrue(Hash::check('newpassword', $userPassword));
  86     }
  87
  88     public function test_user_cannot_be_deleted_if_last_admin()
  89     {
  90         $adminRole = Role::getRole('admin');
  91
  92         // Delete all but one admin user if there are more than one
  93         $adminUsers = $adminRole->users;
  94         if (count($adminUsers) > 1) {
  95             /** @var User $user */
  96             foreach ($adminUsers->splice(1) as $user) {
  97                 $user->delete();
  98             }
  99         }
 100
 101         // Ensure we currently only have 1 admin user
 102         $this->assertEquals(1, $adminRole->users()->count());
 103         /** @var User $user */
 104         $user = $adminRole->users->first();
 105
 106         $resp = $this->asAdmin()->delete('/settings/users/' . $user->id);
 107         $resp->assertRedirect('/settings/users/' . $user->id);
 108
 109         $resp = $this->get('/settings/users/' . $user->id);
 110         $resp->assertSee('You cannot delete the only admin');
 111
 112         $this->assertDatabaseHas('users', ['id' => $user->id]);
 113     }
 114
 115     public function test_delete()
 116     {
 117         $editor = $this->users->editor();
 118         $resp = $this->asAdmin()->delete("settings/users/{$editor->id}");
 119         $resp->assertRedirect('/settings/users');
 120         $resp = $this->followRedirects($resp);
 121
 122         $resp->assertSee('User successfully removed');
 123         $this->assertActivityExists(ActivityType::USER_DELETE);
 124
 125         $this->assertDatabaseMissing('users', ['id' => $editor->id]);
 126     }
 127
 128     public function test_delete_offers_migrate_option()
 129     {
 130         $editor = $this->users->editor();
 131         $resp = $this->asAdmin()->get("settings/users/{$editor->id}/delete");
 132         $resp->assertSee('Migrate Ownership');
 133         $resp->assertSee('new_owner_id');
 134     }
 135
 136     public function test_migrate_option_hidden_if_user_cannot_manage_users()
 137     {
 138         $editor = $this->users->editor();
 139
 140         $resp = $this->asEditor()->get("settings/users/{$editor->id}/delete");
 141         $resp->assertDontSee('Migrate Ownership');
 142         $resp->assertDontSee('new_owner_id');
 143
 144         $this->permissions->grantUserRolePermissions($editor, ['users-manage']);
 145
 146         $resp = $this->asEditor()->get("settings/users/{$editor->id}/delete");
 147         $resp->assertSee('Migrate Ownership');
 148         $resp->assertSee('new_owner_id');
 149     }
 150
 151     public function test_delete_with_new_owner_id_changes_ownership()
 152     {
 153         $page = $this->entities->page();
 154         $owner = $page->ownedBy;
 155         $newOwner = User::query()->where('id', '!=', $owner->id)->first();
 156
 157         $this->asAdmin()->delete("settings/users/{$owner->id}", ['new_owner_id' => $newOwner->id]);
 158         $this->assertDatabaseHas('pages', [
 159             'id'       => $page->id,
 160             'owned_by' => $newOwner->id,
 161         ]);
 162     }
 163
 164     public function test_delete_removes_user_preferences()
 165     {
 166         $editor = $this->users->editor();
 167         setting()->putUser($editor, 'dark-mode-enabled', 'true');
 168
 169         $this->assertDatabaseHas('settings', [
 170             'setting_key' => 'user:' . $editor->id . ':dark-mode-enabled',
 171             'value' => 'true',
 172         ]);
 173
 174         $this->asAdmin()->delete("settings/users/{$editor->id}");
 175
 176         $this->assertDatabaseMissing('settings', [
 177             'setting_key' => 'user:' . $editor->id . ':dark-mode-enabled',
 178         ]);
 179     }
 180
 181     public function test_guest_profile_shows_limited_form()
 182     {
 183         $guest = User::getDefault();
 184         $resp = $this->asAdmin()->get('/settings/users/' . $guest->id);
 185         $resp->assertSee('Guest');
 186         $this->withHtml($resp)->assertElementNotExists('#password');
 187     }
 188
 189     public function test_guest_profile_cannot_be_deleted()
 190     {
 191         $guestUser = User::getDefault();
 192         $resp = $this->asAdmin()->get('/settings/users/' . $guestUser->id . '/delete');
 193         $resp->assertSee('Delete User');
 194         $resp->assertSee('Guest');
 195         $this->withHtml($resp)->assertElementContains('form[action$="/settings/users/' . $guestUser->id . '"] button', 'Confirm');
 196
 197         $resp = $this->delete('/settings/users/' . $guestUser->id);
 198         $resp->assertRedirect('/settings/users/' . $guestUser->id);
 199         $resp = $this->followRedirects($resp);
 200         $resp->assertSee('cannot delete the guest user');
 201     }
 202
 203     public function test_user_create_language_reflects_default_system_locale()
 204     {
 205         $langs = ['en', 'fr', 'hr'];
 206         foreach ($langs as $lang) {
 207             config()->set('app.locale', $lang);
 208             $resp = $this->asAdmin()->get('/settings/users/create');
 209             $this->withHtml($resp)->assertElementExists('select[name="language"] option[value="' . $lang . '"][selected]');
 210         }
 211     }
 212
 213     public function test_user_creation_is_not_performed_if_the_invitation_sending_fails()
 214     {
 215         /** @var User $user */
 216         $user = User::factory()->make();
 217         $adminRole = Role::getRole('admin');
 218
 219         // Simulate an invitation sending failure
 220         $this->mock(UserInviteService::class, function (MockInterface $mock) {
 221             $mock->shouldReceive('sendInvitation')->once()->andThrow(RuntimeException::class);
 222         });
 223
 224         $this->asAdmin()->post('/settings/users/create', [
 225             'name'                          => $user->name,
 226             'email'                         => $user->email,
 227             'send_invite'                   => 'true',
 228             'roles[' . $adminRole->id . ']' => 'true',
 229         ]);
 230
 231         // Since the invitation failed, the user should not exist in the database
 232         $this->assertDatabaseMissing('users', $user->only('name', 'email'));
 233     }
 234
 235     public function test_user_create_activity_is_not_persisted_if_the_invitation_sending_fails()
 236     {
 237         /** @var User $user */
 238         $user = User::factory()->make();
 239         $adminRole = Role::getRole('admin');
 240
 241         $this->mock(UserInviteService::class, function (MockInterface $mock) {
 242             $mock->shouldReceive('sendInvitation')->once()->andThrow(RuntimeException::class);
 243         });
 244
 245         $this->asAdmin()->post('/settings/users/create', [
 246             'name'                          => $user->name,
 247             'email'                         => $user->email,
 248             'send_invite'                   => 'true',
 249             'roles[' . $adminRole->id . ']' => 'true',
 250         ]);
 251
 252         $this->assertDatabaseMissing('activities', ['type' => 'USER_CREATE']);
 253     }
 254
 255     public function test_user_create_update_fails_if_locale_is_invalid()
 256     {
 257         $user = $this->users->editor();
 258
 259         // Too long
 260         $resp = $this->asAdmin()->put($user->getEditUrl(), ['language' => 'this_is_too_long']);
 261         $resp->assertSessionHasErrors(['language' => 'The language may not be greater than 15 characters.']);
 262         session()->flush();
 263
 264         // Invalid characters
 265         $resp = $this->put($user->getEditUrl(), ['language' => 'en<GB']);
 266         $resp->assertSessionHasErrors(['language' => 'The language may only contain letters, numbers, dashes and underscores.']);
 267         session()->flush();
 268
 269         // Both on create
 270         $resp = $this->post('/settings/users/create', [
 271             'language' => 'en<GB_and_this_is_longer',
 272             'name'     => 'My name',
 273             'email'    => '[email protected]',
 274         ]);
 275         $resp->assertSessionHasErrors(['language' => 'The language may not be greater than 15 characters.']);
 276         $resp->assertSessionHasErrors(['language' => 'The language may only contain letters, numbers, dashes and underscores.']);
 277     }
 278
 279     public function test_user_avatar_update_and_reset()
 280     {
 281         $user = $this->users->viewer();
 282         $avatarFile = $this->files->uploadedImage('avatar-icon.png');
 283
 284         $this->assertEquals(0, $user->image_id);
 285
 286         $upload = $this->asAdmin()->call('PUT', "/settings/users/{$user->id}", [
 287             'name' => 'Barry Scott',
 288         ], [], ['profile_image' => $avatarFile], []);
 289         $upload->assertRedirect('/settings/users');
 290
 291         $user->refresh();
 292         $this->assertNotEquals(0, $user->image_id);
 293         /** @var Image $image */
 294         $image = Image::query()->findOrFail($user->image_id);
 295         $this->assertFileExists(public_path($image->path));
 296
 297         $reset = $this->put("/settings/users/{$user->id}", [
 298             'name' => 'Barry Scott',
 299             'profile_image_reset' => 'true',
 300         ]);
 301         $upload->assertRedirect('/settings/users');
 302
 303         $user->refresh();
 304         $this->assertFileDoesNotExist(public_path($image->path));
 305         $this->assertEquals(0, $user->image_id);
 306     }
 307 }