small refactor

pelican-dev · Aug 2, 2024 · 409c90a · 409c90a
1 parent ebd63d8
commit 409c90a
Show file tree

Hide file tree

Showing 9 changed files with 15 additions and 10 deletions.
diff --git a/app/Http/Controllers/Api/Client/Servers/ActivityLogController.php b/app/Http/Controllers/Api/Client/Servers/ActivityLogController.php
@@ -33,7 +33,7 @@ public function __invoke(ClientApiRequest $request, Server $server): array
                 // We could do this with a query and a lot of joins, but that gets pretty
                 // painful so for now we'll execute a simpler query.
                 $subusers = $server->subusers()->pluck('user_id')->merge([$server->owner_id]);
-                $rootAdmins = Role::findOrCreate(Role::ROOT_ADMIN)->users()->pluck('id');
+                $rootAdmins = Role::getRootAdmin()->users()->pluck('id');
 
                 $builder->select('activity_logs.*')
                     ->leftJoin('users', function (JoinClause $join) {

diff --git a/app/Models/Role.php b/app/Models/Role.php
@@ -23,4 +23,9 @@ public function isRootAdmin(): bool
     {
         return $this->name === self::ROOT_ADMIN;
     }
+
+    public static function getRootAdmin(): self
+    {
+        return self::findOrCreate(self::ROOT_ADMIN);
+    }
 }
diff --git a/app/Services/Users/UserCreationService.php b/app/Services/Users/UserCreationService.php
@@ -45,7 +45,7 @@ public function handle(array $data): User
         ]));
 
         if (array_key_exists('root_admin', $data) && $data['root_admin']) {
-            $user->syncRoles(Role::findOrCreate(Role::ROOT_ADMIN));
+            $user->syncRoles(Role::getRootAdmin());
         }
 
         if (isset($generateResetToken)) {

diff --git a/database/migrations/2024_08_01_114538_remove_root_admin_column.php b/database/migrations/2024_08_01_114538_remove_root_admin_column.php
@@ -15,7 +15,7 @@ public function up(): void
     {
         $adminUsers = User::whereRootAdmin(1)->get();
         foreach ($adminUsers as $adminUser) {
-            $adminUser->syncRoles(Role::findOrCreate(Role::ROOT_ADMIN));
+            $adminUser->syncRoles(Role::getRootAdmin());
         }
 
         Schema::table('users', function (Blueprint $table) {

diff --git a/tests/Integration/Api/Application/ApplicationApiIntegrationTestCase.php b/tests/Integration/Api/Application/ApplicationApiIntegrationTestCase.php
@@ -69,7 +69,7 @@ protected function createNewDefaultApiKey(User $user, array $permissions = []):
     protected function createApiUser(): User
     {
         $user = User::factory()->create();
-        $user->syncRoles(Role::findOrCreate(Role::ROOT_ADMIN));
+        $user->syncRoles(Role::getRootAdmin());
 
         return $user;
     }

diff --git a/tests/Integration/Api/Client/ClientControllerTest.php b/tests/Integration/Api/Client/ClientControllerTest.php
@@ -48,7 +48,7 @@ public function testServersAreFilteredUsingNameAndUuidInformation(): void
     {
         /** @var \App\Models\User[] $users */
         $users = User::factory()->times(2)->create();
-        $users[0]->syncRoles(Role::findOrCreate(Role::ROOT_ADMIN));
+        $users[0]->syncRoles(Role::getRootAdmin());
 
         /** @var \App\Models\Server[] $servers */
         $servers = [
@@ -226,7 +226,7 @@ public function testOnlyAdminLevelServersAreReturned(): void
     {
         /** @var \App\Models\User[] $users */
         $users = User::factory()->times(4)->create();
-        $users[0]->syncRoles(Role::findOrCreate(Role::ROOT_ADMIN));
+        $users[0]->syncRoles(Role::getRootAdmin());
 
         $servers = [
             $this->createServerModel(['user_id' => $users[0]->id]),
@@ -261,7 +261,7 @@ public function testAllServersAreReturnedToAdmin(): void
     {
         /** @var \App\Models\User[] $users */
         $users = User::factory()->times(4)->create();
-        $users[0]->syncRoles(Role::findOrCreate(Role::ROOT_ADMIN));
+        $users[0]->syncRoles(Role::getRootAdmin());
 
         $servers = [
             $this->createServerModel(['user_id' => $users[0]->id]),

diff --git a/tests/Integration/Api/Remote/SftpAuthenticationControllerTest.php b/tests/Integration/Api/Remote/SftpAuthenticationControllerTest.php
@@ -181,7 +181,7 @@ public function testUserPermissionsAreReturnedCorrectly(): void
             ->assertOk()
             ->assertJsonPath('permissions', [Permission::ACTION_FILE_READ, Permission::ACTION_FILE_SFTP]);
 
-        $user->syncRoles(Role::findOrCreate(Role::ROOT_ADMIN));
+        $user->syncRoles(Role::getRootAdmin());
 
         $this->postJson('/api/remote/sftp/auth', $data)
             ->assertOk()

diff --git a/tests/Unit/Http/Middleware/AdminAuthenticateTest.php b/tests/Unit/Http/Middleware/AdminAuthenticateTest.php
@@ -15,7 +15,7 @@ class AdminAuthenticateTest extends MiddlewareTestCase
     public function testAdminsAreAuthenticated(): void
     {
         $user = User::factory()->create();
-        $user->syncRoles(Role::findOrCreate(Role::ROOT_ADMIN));
+        $user->syncRoles(Role::getRootAdmin());
 
         $this->request->shouldReceive('user')->withNoArgs()->twice()->andReturn($user);
 

diff --git a/tests/Unit/Http/Middleware/Api/Application/AuthenticateUserTest.php b/tests/Unit/Http/Middleware/Api/Application/AuthenticateUserTest.php
@@ -39,7 +39,7 @@ public function testNonAdminUser(): void
     public function testAdminUser(): void
     {
         $user = $this->generateRequestUserModel();
-        $user->syncRoles(Role::findOrCreate(Role::ROOT_ADMIN));
+        $user->syncRoles(Role::getRootAdmin());
 
         $this->getMiddleware()->handle($this->request, $this->getClosureAssertions());
     }