Merge pull request ceph#61123 from rhcs-dashboard/raise-smb-msg-exception

mgr/dashboard: smb raise exception for unsucessful resource update

Reviewed-by: Afreen Misbah <[email protected]>

Author: Pegonzal

src/pybind/mgr/dashboard/controllers/smb.py

@@ -3,6 +3,7 @@
 
 import json
 import logging
+from functools import wraps
 from typing import List
 
 from smb.enums import Intent
@@ -88,6 +89,26 @@
 }
 
 
+def raise_on_failure(func):
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        result = func(*args, **kwargs)
+
+        if isinstance(result, dict) and result.get('success') is False:
+            msg = 'Operation failed'
+
+            # Extracts the result msg from either of two possible response structures:
+            if 'results' in result:
+                msg = result['results'][0].get('msg', msg)
+            elif 'msg' in result:
+                msg = result['msg']
+            raise DashboardException(msg=msg, component='smb')
+
+        return result
+
+    return wrapper
+
+
 @APIRouter('/smb/cluster', Scope.SMB)
 @APIDoc("SMB Cluster Management API", "SMB")
 class SMBCluster(RESTController):
@@ -115,6 +136,7 @@ def get(self, cluster_id: str) -> Cluster:
         """
         return mgr.remote('smb', 'show', [f'{self._resource}.{cluster_id}'])
 
+    @raise_on_failure
     @CreatePermission
     @EndpointDoc("Create smb cluster",
                  parameters={
@@ -181,8 +203,9 @@ def list(self, cluster_id: str = '') -> List[Share]:
             [f'{self._resource}.{cluster_id}' if cluster_id else self._resource])
         return res['resources'] if 'resources' in res else res
 
+    @raise_on_failure
     @DeletePermission
-    @EndpointDoc("Remove smb shares",
+    @EndpointDoc("Remove an smb share",
                  parameters={
                      'cluster_id': (str, 'Unique identifier for the cluster'),
                      'share_id': (str, 'Unique identifier for the share')

src/pybind/mgr/dashboard/openapi.yaml

@@ -14939,7 +14939,7 @@ paths:
             trace.
       security:
       - jwt: []
-      summary: Remove smb shares
+      summary: Remove an smb share
       tags:
       - SMB
   /api/summary: