5 use BookStack\Actions\ActivityType;
6 use BookStack\Auth\Access\UserInviteService;
7 use BookStack\Auth\Role;
8 use BookStack\Auth\User;
9 use BookStack\Entities\Models\Page;
10 use Illuminate\Support\Facades\Hash;
11 use Illuminate\Support\Str;
12 use Mockery\MockInterface;
16 class UserManagementTest extends TestCase
18 public function test_user_creation()
20 /** @var User $user */
21 $user = User::factory()->make();
22 $adminRole = Role::getRole('admin');
24 $resp = $this->asAdmin()->get('/settings/users');
25 $this->withHtml($resp)->assertElementContains('a[href="' . url('/settings/users/create') . '"]', 'Add New User');
27 $resp = $this->get('/settings/users/create');
28 $this->withHtml($resp)->assertElementContains('form[action="' . url('/settings/users/create') . '"]', 'Save');
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',
37 $resp->assertRedirect('/settings/users');
39 $resp = $this->get('/settings/users');
40 $resp->assertSee($user->name);
42 $this->assertDatabaseHas('users', $user->only('name', 'email'));
45 $this->assertStringStartsWith(Str::slug($user->name), $user->slug);
48 public function test_user_updating()
50 $user = $this->getNormalUser();
51 $password = $user->password;
53 $resp = $this->asAdmin()->get('/settings/users/' . $user->id);
54 $resp->assertSee($user->email);
56 $this->put($user->getEditUrl(), [
57 'name' => 'Barry Scott',
58 ])->assertRedirect('/settings/users');
60 $this->assertDatabaseHas('users', ['id' => $user->id, 'name' => 'Barry Scott', 'password' => $password]);
61 $this->assertDatabaseMissing('users', ['name' => $user->name]);
64 $this->assertStringStartsWith(Str::slug($user->name), $user->slug);
67 public function test_user_password_update()
69 $user = $this->getNormalUser();
70 $userProfilePage = '/settings/users/' . $user->id;
72 $this->asAdmin()->get($userProfilePage);
73 $this->put($userProfilePage, [
74 'password' => 'newpassword',
75 ])->assertRedirect($userProfilePage);
77 $this->get($userProfilePage)->assertSee('Password confirmation required');
79 $this->put($userProfilePage, [
80 'password' => 'newpassword',
81 'password-confirm' => 'newpassword',
82 ])->assertRedirect('/settings/users');
84 $userPassword = User::query()->find($user->id)->password;
85 $this->assertTrue(Hash::check('newpassword', $userPassword));
88 public function test_user_cannot_be_deleted_if_last_admin()
90 $adminRole = Role::getRole('admin');
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) {
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();
106 $resp = $this->asAdmin()->delete('/settings/users/' . $user->id);
107 $resp->assertRedirect('/settings/users/' . $user->id);
109 $resp = $this->get('/settings/users/' . $user->id);
110 $resp->assertSee('You cannot delete the only admin');
112 $this->assertDatabaseHas('users', ['id' => $user->id]);
115 public function test_delete()
117 $editor = $this->getEditor();
118 $resp = $this->asAdmin()->delete("settings/users/{$editor->id}");
119 $resp->assertRedirect('/settings/users');
120 $resp = $this->followRedirects($resp);
122 $resp->assertSee('User successfully removed');
123 $this->assertActivityExists(ActivityType::USER_DELETE);
125 $this->assertDatabaseMissing('users', ['id' => $editor->id]);
128 public function test_delete_offers_migrate_option()
130 $editor = $this->getEditor();
131 $resp = $this->asAdmin()->get("settings/users/{$editor->id}/delete");
132 $resp->assertSee('Migrate Ownership');
133 $resp->assertSee('new_owner_id');
136 public function test_migrate_option_hidden_if_user_cannot_manage_users()
138 $editor = $this->getEditor();
140 $resp = $this->asEditor()->get("settings/users/{$editor->id}/delete");
141 $resp->assertDontSee('Migrate Ownership');
142 $resp->assertDontSee('new_owner_id');
144 $this->giveUserPermissions($editor, ['users-manage']);
146 $resp = $this->asEditor()->get("settings/users/{$editor->id}/delete");
147 $resp->assertSee('Migrate Ownership');
148 $resp->assertSee('new_owner_id');
151 public function test_delete_with_new_owner_id_changes_ownership()
153 $page = Page::query()->first();
154 $owner = $page->ownedBy;
155 $newOwner = User::query()->where('id', '!=', $owner->id)->first();
157 $this->asAdmin()->delete("settings/users/{$owner->id}", ['new_owner_id' => $newOwner->id]);
158 $this->assertDatabaseHas('pages', [
160 'owned_by' => $newOwner->id,
164 public function test_guest_profile_shows_limited_form()
166 $guest = User::getDefault();
167 $resp = $this->asAdmin()->get('/settings/users/' . $guest->id);
168 $resp->assertSee('Guest');
169 $this->withHtml($resp)->assertElementNotExists('#password');
172 public function test_guest_profile_cannot_be_deleted()
174 $guestUser = User::getDefault();
175 $resp = $this->asAdmin()->get('/settings/users/' . $guestUser->id . '/delete');
176 $resp->assertSee('Delete User');
177 $resp->assertSee('Guest');
178 $this->withHtml($resp)->assertElementContains('form[action$="/settings/users/' . $guestUser->id . '"] button', 'Confirm');
180 $resp = $this->delete('/settings/users/' . $guestUser->id);
181 $resp->assertRedirect('/settings/users/' . $guestUser->id);
182 $resp = $this->followRedirects($resp);
183 $resp->assertSee('cannot delete the guest user');
186 public function test_user_create_language_reflects_default_system_locale()
188 $langs = ['en', 'fr', 'hr'];
189 foreach ($langs as $lang) {
190 config()->set('app.locale', $lang);
191 $resp = $this->asAdmin()->get('/settings/users/create');
192 $this->withHtml($resp)->assertElementExists('select[name="language"] option[value="' . $lang . '"][selected]');
196 public function test_user_creation_is_not_performed_if_the_invitation_sending_fails()
198 /** @var User $user */
199 $user = User::factory()->make();
200 $adminRole = Role::getRole('admin');
202 // Simulate an invitation sending failure
203 $this->mock(UserInviteService::class, function (MockInterface $mock) {
204 $mock->shouldReceive('sendInvitation')->once()->andThrow(RuntimeException::class);
207 $this->asAdmin()->post('/settings/users/create', [
208 'name' => $user->name,
209 'email' => $user->email,
210 'send_invite' => 'true',
211 'roles[' . $adminRole->id . ']' => 'true',
214 // Since the invitation failed, the user should not exist in the database
215 $this->assertDatabaseMissing('users', $user->only('name', 'email'));
218 public function test_user_create_activity_is_not_persisted_if_the_invitation_sending_fails()
220 /** @var User $user */
221 $user = User::factory()->make();
222 $adminRole = Role::getRole('admin');
224 $this->mock(UserInviteService::class, function (MockInterface $mock) {
225 $mock->shouldReceive('sendInvitation')->once()->andThrow(RuntimeException::class);
228 $this->asAdmin()->post('/settings/users/create', [
229 'name' => $user->name,
230 'email' => $user->email,
231 'send_invite' => 'true',
232 'roles[' . $adminRole->id . ']' => 'true',
235 $this->assertDatabaseMissing('activities', ['type' => 'USER_CREATE']);
238 public function test_user_create_update_fails_if_locale_is_invalid()
240 $user = $this->getEditor();
243 $resp = $this->asAdmin()->put($user->getEditUrl(), ['language' => 'this_is_too_long']);
244 $resp->assertSessionHasErrors(['language' => 'The language may not be greater than 15 characters.']);
247 // Invalid characters
248 $resp = $this->put($user->getEditUrl(), ['language' => 'en<GB']);
249 $resp->assertSessionHasErrors(['language' => 'The language may only contain letters, numbers, dashes and underscores.']);
253 $resp = $this->post('/settings/users/create', [
254 'language' => 'en<GB_and_this_is_longer',
258 $resp->assertSessionHasErrors(['language' => 'The language may not be greater than 15 characters.']);
259 $resp->assertSessionHasErrors(['language' => 'The language may only contain letters, numbers, dashes and underscores.']);