Merge pull request ceph#62027 from rhcs-dashboard/admin-ops-api-for-rgw-accounts

nizamial09 · web-flow · commit 1e333f3dd9cc · 2025-03-25T13:21:21.000+05:30
mgr/dashboard: Use admin ops API for rgw accounts
diff --git a/src/pybind/mgr/dashboard/controllers/rgw_iam.py b/src/pybind/mgr/dashboard/controllers/rgw_iam.py
@@ -1,5 +1,6 @@
 from typing import Optional
 
+from ..controllers.rgw import RgwRESTController
 from ..security import Scope
 from ..services.rgw_iam import RgwAccounts
 from ..tools import str_to_bool
@@ -8,7 +9,7 @@
 
 @APIRouter('rgw/accounts', Scope.RGW)
 @APIDoc("RGW User Accounts API", "RgwUserAccounts")
-class RgwUserAccountsController(RESTController):
+class RgwUserAccountsController(RgwRESTController):
     @EndpointDoc("Update RGW account info",
                  parameters={'account_name': (str, 'Account name'),
                              'email': (str, 'Email'),
@@ -17,12 +18,13 @@ class RgwUserAccountsController(RESTController):
                              'max_users': (int, 'Max users'),
                              'max_roles': (int, 'Max roles'),
                              'max_group': (int, 'Max groups'),
-                             'max_access_keys': (int, 'Max access keys')})
+                             'max_access_keys': (int, 'Max access keys'),
+                             'daemon_name': (str, 'Name of the daemon')})
     @allow_empty_body
     def create(self, account_name: str, tenant: Optional[str] = None,
                email: Optional[str] = None, max_buckets: Optional[int] = None,
                max_users: Optional[int] = None, max_roles: Optional[int] = None,
-               max_group: Optional[int] = None,
+               max_group: Optional[int] = None, daemon_name=None,
                max_access_keys: Optional[int] = None):
         """
         Create an account
@@ -31,38 +33,64 @@ def create(self, account_name: str, tenant: Optional[str] = None,
         :return: Returns account resource.
         :rtype: Dict[str, Any]
         """
-        return RgwAccounts.create_account(account_name, tenant, email,
-                                          max_buckets, max_users, max_roles,
-                                          max_group, max_access_keys)
+        params = {'name': account_name}
+        if tenant:
+            params['tenant'] = tenant
+        if email:
+            params['email'] = email
+        if max_buckets:
+            params['max-buckets'] = str(max_buckets)
+        if max_users:
+            params['max-users'] = str(max_users)
+        if max_roles:
+            params['max-roles'] = str(max_roles)
+        if max_group:
+            params['max-group'] = str(max_group)
+        if max_access_keys:
+            params['max-access-keys'] = str(max_access_keys)
 
-    def list(self, detailed: bool = False):
+        result = self.proxy(daemon_name, 'POST', 'account', params)
+        return result
+
+    def list(self, daemon_name=None, detailed: bool = False):
         """
         List all account ids or all detailed account info based on the 'detailed' query parameter.
 
         - If detailed=True, returns detailed account info.
         - If detailed=False, returns only account ids.
         """
         detailed = str_to_bool(detailed)
-        return RgwAccounts.get_accounts(detailed)
+        account_list = RgwAccounts.get_accounts()
+        detailed_account_list = []
+        if detailed:
+            for account in account_list:
+                detailed_account_list.append(self.get_account(account, daemon_name))
+            return detailed_account_list
+        return account_list
 
     @EndpointDoc("Get RGW Account by id",
-                 parameters={'account_id': (str, 'Account id')})
-    def get(self, account_id: str):
+                 parameters={'account_id': (str, 'Account id'),
+                             'daemon_name': (str, 'Name of the daemon')})
+    def get(self, account_id: str, daemon_name=None):
         """
         Get an account by account id
         """
-        return RgwAccounts.get_account(account_id)
+        return self.get_account(account_id, daemon_name)
+
+    def get_account(self, account_id, daemon_name=None) -> dict:
+        return self.proxy(daemon_name, 'GET', 'account', {'id': account_id})
 
     @EndpointDoc("Delete RGW Account",
-                 parameters={'account_id': (str, 'Account id')})
-    def delete(self, account_id):
+                 parameters={'account_id': (str, 'Account id'),
+                             'daemon_name': (str, 'Name of the daemon')})
+    def delete(self, account_id, daemon_name=None):
         """
         Removes an account
 
         :param account_id: account identifier
         :return: None.
         """
-        return RgwAccounts.delete_account(account_id)
+        return self.proxy(daemon_name, 'DELETE', 'account', {'id': account_id}, json_response=False)
 
     @EndpointDoc("Update RGW account info",
                  parameters={'account_id': (str, 'Account id'),
@@ -73,23 +101,41 @@ def delete(self, account_id):
                              'max_users': (int, 'Max users'),
                              'max_roles': (int, 'Max roles'),
                              'max_group': (int, 'Max groups'),
-                             'max_access_keys': (int, 'Max access keys')})
+                             'max_access_keys': (int, 'Max access keys'),
+                             'daemon_name': (str, 'Name of the daemon')})
     @allow_empty_body
     def set(self, account_id: str, account_name: str,
             email: Optional[str] = None, tenant: Optional[str] = None,
             max_buckets: Optional[int] = None, max_users: Optional[int] = None,
             max_roles: Optional[int] = None, max_group: Optional[int] = None,
-            max_access_keys: Optional[int] = None):
+            max_access_keys: Optional[int] = None, daemon_name=None):
         """
         Modifies an account
 
         :param account_id: Account identifier
         :return: Returns modified account resource.
         :rtype: Dict[str, Any]
         """
-        return RgwAccounts.modify_account(account_id, account_name, email, tenant,
-                                          max_buckets, max_users, max_roles,
-                                          max_group, max_access_keys)
+
+        params = {'id': account_id}
+        if account_name:
+            params['name'] = account_name
+        if tenant:
+            params['tenant'] = tenant
+        if email:
+            params['email'] = email
+        if max_buckets:
+            params['max-buckets'] = str(max_buckets)
+        if max_users:
+            params['max-users'] = str(max_users)
+        if max_roles:
+            params['max-roles'] = str(max_roles)
+        if max_group:
+            params['max-group'] = str(max_group)
+        if max_access_keys:
+            params['max-access-keys'] = str(max_access_keys)
+
+        return self.proxy(daemon_name, 'PUT', 'account', params)
 
     @EndpointDoc("Set RGW Account/Bucket quota",
                  parameters={'account_id': (str, 'Account id'),
diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rgw-user-accounts.service.spec.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rgw-user-accounts.service.spec.ts
@@ -3,6 +3,7 @@ import { TestBed } from '@angular/core/testing';
 import { RgwUserAccountsService } from './rgw-user-accounts.service';
 import { HttpClientTestingModule, HttpTestingController } from '@angular/common/http/testing';
 import { Account } from '~/app/ceph/rgw/models/rgw-user-accounts';
+import { RgwHelper } from '~/testing/unit-test-helper';
 
 const mockAccountData: Account[] = [
   {
@@ -68,6 +69,7 @@ describe('RgwUserAccountsService', () => {
     });
     service = TestBed.inject(RgwUserAccountsService);
     httpTesting = TestBed.inject(HttpTestingController);
+    RgwHelper.selectDaemon();
   });
 
   it('should be created', () => {
@@ -76,8 +78,56 @@ describe('RgwUserAccountsService', () => {
 
   it('should fetch detailed list of accounts', () => {
     service.list(true).subscribe();
-    const req = httpTesting.expectOne('api/rgw/accounts?detailed=true');
+    const req = httpTesting.expectOne(
+      `api/rgw/accounts?${RgwHelper.DAEMON_QUERY_PARAM}&detailed=true`
+    );
     expect(req.request.method).toBe('GET');
     req.flush(mockAccountData);
   });
+
+  it('should fetch single account detail', () => {
+    service.get('RGW80617806988089685').subscribe();
+    const req = httpTesting.expectOne(
+      `api/rgw/accounts/get?${RgwHelper.DAEMON_QUERY_PARAM}&account_id=RGW80617806988089685`
+    );
+    expect(req.request.method).toBe('GET');
+    req.flush(mockAccountData[0]);
+  });
+
+  it('should call create method', () => {
+    service.create(mockAccountData[0]).subscribe();
+    const req = httpTesting.expectOne(`api/rgw/accounts?${RgwHelper.DAEMON_QUERY_PARAM}`);
+    expect(req.request.method).toBe('POST');
+    req.flush(mockAccountData[0]);
+  });
+
+  it('should call modify method', () => {
+    service.modify(mockAccountData[0]).subscribe();
+    const req = httpTesting.expectOne(`api/rgw/accounts/set?${RgwHelper.DAEMON_QUERY_PARAM}`);
+    expect(req.request.method).toBe('PUT');
+    req.flush(mockAccountData[0]);
+  });
+
+  it('should call remove method', () => {
+    service.remove('RGW12444466134482748').subscribe();
+    const req = httpTesting.expectOne(
+      `api/rgw/accounts/RGW12444466134482748?${RgwHelper.DAEMON_QUERY_PARAM}`
+    );
+    expect(req.request.method).toBe('DELETE');
+    req.flush(null);
+  });
+
+  it('should call setQuota method', () => {
+    service
+      .setQuota('RGW12444466134482748', {
+        quota_type: 'bucket',
+        max_size: '10MB',
+        max_objects: '1000',
+        enabled: true
+      })
+      .subscribe();
+    const req = httpTesting.expectOne(`api/rgw/accounts/RGW12444466134482748/quota`);
+    expect(req.request.method).toBe('PUT');
+    req.flush(null);
+  });
 });
diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rgw-user-accounts.service.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rgw-user-accounts.service.ts
@@ -1,41 +1,51 @@
 import { HttpClient, HttpParams } from '@angular/common/http';
 import { Injectable } from '@angular/core';
 import { Observable } from 'rxjs';
+import { RgwDaemonService } from './rgw-daemon.service';
+import { Account } from '~/app/ceph/rgw/models/rgw-user-accounts';
 
 @Injectable({
   providedIn: 'root'
 })
 export class RgwUserAccountsService {
   private url = 'api/rgw/accounts';
 
-  constructor(private http: HttpClient) {}
+  constructor(private http: HttpClient, private rgwDaemonService: RgwDaemonService) {}
 
   list(detailed?: boolean): Observable<any> {
-    let params = new HttpParams();
-    if (detailed) {
-      params = params.append('detailed', detailed);
-    }
-    return this.http.get(this.url, { params });
+    return this.rgwDaemonService.request((params: HttpParams) => {
+      if (detailed) {
+        params = params.append('detailed', detailed);
+      }
+      return this.http.get(this.url, { params });
+    });
   }
 
   get(account_id: string): Observable<any> {
-    let params = new HttpParams();
-    if (account_id) {
-      params = params.append('account_id', account_id);
-    }
-    return this.http.get(`${this.url}/get`, { params });
+    return this.rgwDaemonService.request((params: HttpParams) => {
+      if (account_id) {
+        params = params.append('account_id', account_id);
+      }
+      return this.http.get(`${this.url}/get`, { params });
+    });
   }
 
-  create(payload: any): Observable<any> {
-    return this.http.post(this.url, payload);
+  create(payload: Partial<Account>): Observable<any> {
+    return this.rgwDaemonService.request((params: HttpParams) => {
+      return this.http.post(this.url, payload, { params: params });
+    });
   }
 
-  modify(payload: any): Observable<any> {
-    return this.http.put(`${this.url}/set`, payload);
+  modify(payload: Partial<Account>): Observable<any> {
+    return this.rgwDaemonService.request((params: HttpParams) => {
+      return this.http.put(`${this.url}/set`, payload, { params: params });
+    });
   }
 
   remove(accountId: string) {
-    return this.http.delete(`${this.url}/${accountId}`);
+    return this.rgwDaemonService.request((params: HttpParams) => {
+      return this.http.delete(`${this.url}/${accountId}`, { params: params });
+    });
   }
 
   setQuota(
diff --git a/src/pybind/mgr/dashboard/openapi.yaml b/src/pybind/mgr/dashboard/openapi.yaml
@@ -11040,6 +11040,11 @@ paths:
         \ detailed account info.\n        - If detailed=False, returns only account\
         \ ids.\n        "
       parameters:
+      - allowEmptyValue: true
+        in: query
+        name: daemon_name
+        schema:
+          type: string
       - default: false
         in: query
         name: detailed
@@ -11077,6 +11082,9 @@ paths:
                 account_name:
                   description: Account name
                   type: string
+                daemon_name:
+                  description: Name of the daemon
+                  type: string
                 email:
                   description: Email
                   type: string
@@ -11137,6 +11145,12 @@ paths:
         required: true
         schema:
           type: string
+      - allowEmptyValue: true
+        description: Name of the daemon
+        in: query
+        name: daemon_name
+        schema:
+          type: string
       responses:
         '202':
           content:
@@ -11171,6 +11185,12 @@ paths:
         required: true
         schema:
           type: string
+      - allowEmptyValue: true
+        description: Name of the daemon
+        in: query
+        name: daemon_name
+        schema:
+          type: string
       responses:
         '200':
           content:
@@ -11210,6 +11230,9 @@ paths:
                 account_name:
                   description: Account name
                   type: string
+                daemon_name:
+                  description: Name of the daemon
+                  type: string
                 email:
                   description: Email
                   type: string
diff --git a/src/pybind/mgr/dashboard/services/rgw_iam.py b/src/pybind/mgr/dashboard/services/rgw_iam.py
diff --git a/src/pybind/mgr/dashboard/tests/test_rgw_iam.py b/src/pybind/mgr/dashboard/tests/test_rgw_iam.py
