ZIP Imports: Added API examples, finished testing

[bookstack] / tests / User / UserManagementTest.php

diff --git a/tests/User/UserManagementTest.php b/tests/User/UserManagementTest.php
index e295034ceefb208bc32ebba6280790ef926e69b6..d92f13f0b3ff7624a58ba95298412a19bf6da152 100644 (file)
--- a/tests/User/UserManagementTest.php
+++ b/tests/User/UserManagementTest.php
@@ -2,14 +2,15 @@
 
 namespace Tests\User;
 
 
 namespace Tests\User;
 

-use BookStack\Actions\ActivityType;
-use BookStack\Auth\Access\UserInviteService;
-use BookStack\Auth\Role;
-use BookStack\Auth\User;
+use BookStack\Access\UserInviteException;
+use BookStack\Access\UserInviteService;
+use BookStack\Activity\ActivityType;
+use BookStack\Uploads\Image;
+use BookStack\Users\Models\Role;
+use BookStack\Users\Models\User;

 use Illuminate\Support\Facades\Hash;
 use Illuminate\Support\Str;
 use Mockery\MockInterface;
 use Illuminate\Support\Facades\Hash;
 use Illuminate\Support\Str;
 use Mockery\MockInterface;

-use RuntimeException;

 use Tests\TestCase;
 
 class UserManagementTest extends TestCase
 use Tests\TestCase;
 
 class UserManagementTest extends TestCase


@@ -46,7 +47,7 @@ class UserManagementTest extends TestCase
 
     public function test_user_updating()
     {
 
     public function test_user_updating()
     {

-        $user = $this->getNormalUser();
+        $user = $this->users->viewer();

         $password = $user->password;
 
         $resp = $this->asAdmin()->get('/settings/users/' . $user->id);
         $password = $user->password;
 
         $resp = $this->asAdmin()->get('/settings/users/' . $user->id);


@@ -65,7 +66,7 @@ class UserManagementTest extends TestCase
 
     public function test_user_password_update()
     {
 
     public function test_user_password_update()
     {

-        $user = $this->getNormalUser();
+        $user = $this->users->viewer();

         $userProfilePage = '/settings/users/' . $user->id;
 
         $this->asAdmin()->get($userProfilePage);
         $userProfilePage = '/settings/users/' . $user->id;
 
         $this->asAdmin()->get($userProfilePage);


@@ -84,6 +85,16 @@ class UserManagementTest extends TestCase
         $this->assertTrue(Hash::check('newpassword', $userPassword));
     }
 
         $this->assertTrue(Hash::check('newpassword', $userPassword));
     }
 

+    public function test_user_can_be_updated_with_single_char_name()
+    {
+        $user = $this->users->viewer();
+        $this->asAdmin()->put("/settings/users/{$user->id}", [
+            'name' => 'b'
+        ])->assertRedirect('/settings/users');
+
+        $this->assertEquals('b', $user->refresh()->name);
+    }
+

     public function test_user_cannot_be_deleted_if_last_admin()
     {
         $adminRole = Role::getRole('admin');
     public function test_user_cannot_be_deleted_if_last_admin()
     {
         $adminRole = Role::getRole('admin');


@@ -113,7 +124,7 @@ class UserManagementTest extends TestCase
 
     public function test_delete()
     {
 
     public function test_delete()
     {

-        $editor = $this->getEditor();
+        $editor = $this->users->editor();

         $resp = $this->asAdmin()->delete("settings/users/{$editor->id}");
         $resp->assertRedirect('/settings/users');
         $resp = $this->followRedirects($resp);
         $resp = $this->asAdmin()->delete("settings/users/{$editor->id}");
         $resp->assertRedirect('/settings/users');
         $resp = $this->followRedirects($resp);


@@ -126,7 +137,7 @@ class UserManagementTest extends TestCase
 
     public function test_delete_offers_migrate_option()
     {
 
     public function test_delete_offers_migrate_option()
     {

-        $editor = $this->getEditor();
+        $editor = $this->users->editor();

         $resp = $this->asAdmin()->get("settings/users/{$editor->id}/delete");
         $resp->assertSee('Migrate Ownership');
         $resp->assertSee('new_owner_id');
         $resp = $this->asAdmin()->get("settings/users/{$editor->id}/delete");
         $resp->assertSee('Migrate Ownership');
         $resp->assertSee('new_owner_id');


@@ -134,16 +145,17 @@ class UserManagementTest extends TestCase
 
     public function test_migrate_option_hidden_if_user_cannot_manage_users()
     {
 
     public function test_migrate_option_hidden_if_user_cannot_manage_users()
     {

-        $editor = $this->getEditor();
+        $editor = $this->users->editor();

 
         $resp = $this->asEditor()->get("settings/users/{$editor->id}/delete");
         $resp->assertDontSee('Migrate Ownership');
         $resp->assertDontSee('new_owner_id');
 
 
         $resp = $this->asEditor()->get("settings/users/{$editor->id}/delete");
         $resp->assertDontSee('Migrate Ownership');
         $resp->assertDontSee('new_owner_id');
 

-        $this->giveUserPermissions($editor, ['users-manage']);
+        $this->permissions->grantUserRolePermissions($editor, ['users-manage']);

 
         $resp = $this->asEditor()->get("settings/users/{$editor->id}/delete");
         $resp->assertSee('Migrate Ownership');
 
         $resp = $this->asEditor()->get("settings/users/{$editor->id}/delete");
         $resp->assertSee('Migrate Ownership');

+        $this->withHtml($resp)->assertElementExists('form input[name="new_owner_id"]');

         $resp->assertSee('new_owner_id');
     }
 
         $resp->assertSee('new_owner_id');
     }
 


@@ -160,17 +172,48 @@ class UserManagementTest extends TestCase
         ]);
     }
 
         ]);
     }
 

+    public function test_delete_with_empty_owner_migration_id_works()
+    {
+        $user = $this->users->editor();
+
+        $resp = $this->asAdmin()->delete("settings/users/{$user->id}", ['new_owner_id' => '']);
+        $resp->assertRedirect('/settings/users');
+        $this->assertActivityExists(ActivityType::USER_DELETE);
+        $this->assertSessionHas('success');
+    }
+
+    public function test_delete_removes_user_preferences()
+    {
+        $editor = $this->users->editor();
+        setting()->putUser($editor, 'dark-mode-enabled', 'true');
+
+        $this->assertDatabaseHas('settings', [
+            'setting_key' => 'user:' . $editor->id . ':dark-mode-enabled',
+            'value' => 'true',
+        ]);
+
+        $this->asAdmin()->delete("settings/users/{$editor->id}");
+
+        $this->assertDatabaseMissing('settings', [
+            'setting_key' => 'user:' . $editor->id . ':dark-mode-enabled',
+        ]);
+    }
+

     public function test_guest_profile_shows_limited_form()
     {
     public function test_guest_profile_shows_limited_form()
     {

-        $guest = User::getDefault();
+        $guest = $this->users->guest();
+

         $resp = $this->asAdmin()->get('/settings/users/' . $guest->id);
         $resp->assertSee('Guest');
         $resp = $this->asAdmin()->get('/settings/users/' . $guest->id);
         $resp->assertSee('Guest');

-        $this->withHtml($resp)->assertElementNotExists('#password');
+        $html = $this->withHtml($resp);
+
+        $html->assertElementNotExists('#password');
+        $html->assertElementNotExists('[name="language"]');

     }
 
     public function test_guest_profile_cannot_be_deleted()
     {
     }
 
     public function test_guest_profile_cannot_be_deleted()
     {

-        $guestUser = User::getDefault();
+        $guestUser = $this->users->guest();

         $resp = $this->asAdmin()->get('/settings/users/' . $guestUser->id . '/delete');
         $resp->assertSee('Delete User');
         $resp->assertSee('Guest');
         $resp = $this->asAdmin()->get('/settings/users/' . $guestUser->id . '/delete');
         $resp->assertSee('Delete User');
         $resp->assertSee('Guest');


@@ -186,7 +229,7 @@ class UserManagementTest extends TestCase
     {
         $langs = ['en', 'fr', 'hr'];
         foreach ($langs as $lang) {
     {
         $langs = ['en', 'fr', 'hr'];
         foreach ($langs as $lang) {

-            config()->set('app.locale', $lang);
+            config()->set('app.default_locale', $lang);

             $resp = $this->asAdmin()->get('/settings/users/create');
             $this->withHtml($resp)->assertElementExists('select[name="language"] option[value="' . $lang . '"][selected]');
         }
             $resp = $this->asAdmin()->get('/settings/users/create');
             $this->withHtml($resp)->assertElementExists('select[name="language"] option[value="' . $lang . '"][selected]');
         }


@@ -200,7 +243,7 @@ class UserManagementTest extends TestCase
 
         // Simulate an invitation sending failure
         $this->mock(UserInviteService::class, function (MockInterface $mock) {
 
         // Simulate an invitation sending failure
         $this->mock(UserInviteService::class, function (MockInterface $mock) {

-            $mock->shouldReceive('sendInvitation')->once()->andThrow(RuntimeException::class);
+            $mock->shouldReceive('sendInvitation')->once()->andThrow(UserInviteException::class);

         });
 
         $this->asAdmin()->post('/settings/users/create', [
         });
 
         $this->asAdmin()->post('/settings/users/create', [


@@ -218,25 +261,45 @@ class UserManagementTest extends TestCase
     {
         /** @var User $user */
         $user = User::factory()->make();
     {
         /** @var User $user */
         $user = User::factory()->make();

-        $adminRole = Role::getRole('admin');

 
         $this->mock(UserInviteService::class, function (MockInterface $mock) {
 
         $this->mock(UserInviteService::class, function (MockInterface $mock) {

-            $mock->shouldReceive('sendInvitation')->once()->andThrow(RuntimeException::class);
+            $mock->shouldReceive('sendInvitation')->once()->andThrow(UserInviteException::class);

         });
 
         $this->asAdmin()->post('/settings/users/create', [
             'name'                          => $user->name,
             'email'                         => $user->email,
             'send_invite'                   => 'true',
         });
 
         $this->asAdmin()->post('/settings/users/create', [
             'name'                          => $user->name,
             'email'                         => $user->email,
             'send_invite'                   => 'true',

-            'roles[' . $adminRole->id . ']' => 'true',

         ]);
 
         $this->assertDatabaseMissing('activities', ['type' => 'USER_CREATE']);
     }
 
         ]);
 
         $this->assertDatabaseMissing('activities', ['type' => 'USER_CREATE']);
     }
 

+    public function test_return_to_form_with_warning_if_the_invitation_sending_fails()
+    {
+        $logger = $this->withTestLogger();
+        /** @var User $user */
+        $user = User::factory()->make();
+
+        $this->mock(UserInviteService::class, function (MockInterface $mock) {
+            $mock->shouldReceive('sendInvitation')->once()->andThrow(UserInviteException::class);
+        });
+
+        $resp = $this->asAdmin()->post('/settings/users/create', [
+            'name'                          => $user->name,
+            'email'                         => $user->email,
+            'send_invite'                   => 'true',
+        ]);
+
+        $resp->assertRedirect('/settings/users/create');
+        $this->assertSessionError('Could not create user since invite email failed to send');
+        $this->assertEquals($user->email, session()->getOldInput('email'));
+        $this->assertTrue($logger->hasErrorThatContains('Failed to send user invite with error:'));
+    }
+

     public function test_user_create_update_fails_if_locale_is_invalid()
     {
     public function test_user_create_update_fails_if_locale_is_invalid()
     {

-        $user = $this->getEditor();
+        $user = $this->users->editor();

 
         // Too long
         $resp = $this->asAdmin()->put($user->getEditUrl(), ['language' => 'this_is_too_long']);
 
         // Too long
         $resp = $this->asAdmin()->put($user->getEditUrl(), ['language' => 'this_is_too_long']);


@@ -257,4 +320,33 @@ class UserManagementTest extends TestCase
         $resp->assertSessionHasErrors(['language' => 'The language may not be greater than 15 characters.']);
         $resp->assertSessionHasErrors(['language' => 'The language may only contain letters, numbers, dashes and underscores.']);
     }
         $resp->assertSessionHasErrors(['language' => 'The language may not be greater than 15 characters.']);
         $resp->assertSessionHasErrors(['language' => 'The language may only contain letters, numbers, dashes and underscores.']);
     }

+
+    public function test_user_avatar_update_and_reset()
+    {
+        $user = $this->users->viewer();
+        $avatarFile = $this->files->uploadedImage('avatar-icon.png');
+
+        $this->assertEquals(0, $user->image_id);
+
+        $upload = $this->asAdmin()->call('PUT', "/settings/users/{$user->id}", [
+            'name' => 'Barry Scott',
+        ], [], ['profile_image' => $avatarFile], []);
+        $upload->assertRedirect('/settings/users');
+
+        $user->refresh();
+        $this->assertNotEquals(0, $user->image_id);
+        /** @var Image $image */
+        $image = Image::query()->findOrFail($user->image_id);
+        $this->assertFileExists(public_path($image->path));
+
+        $reset = $this->put("/settings/users/{$user->id}", [
+            'name' => 'Barry Scott',
+            'profile_image_reset' => 'true',
+        ]);
+        $upload->assertRedirect('/settings/users');
+
+        $user->refresh();
+        $this->assertFileDoesNotExist(public_path($image->path));
+        $this->assertEquals(0, $user->image_id);
+    }

 }
 }