Merge pull request ceph#61649 from Hezko/nvmeof-response-handling

mgr/dashboard: introduce "convert_to_model" and "pick" decorators

Author: Hezko

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

@@ -23,8 +23,8 @@
 }
 
 try:
-    from ..services.nvmeof_client import NVMeoFClient, empty_response, \
-        handle_nvmeof_error, map_collection, map_model
+    from ..services.nvmeof_client import NVMeoFClient, convert_to_model, \
+        empty_response, handle_nvmeof_error, map_collection, pick
 except ImportError as e:
     logger.error("Failed to import NVMeoFClient and related components: %s", e)
 else:
@@ -33,7 +33,7 @@
     class NVMeoFGateway(RESTController):
         @EndpointDoc("Get information about the NVMeoF gateway")
         @NvmeofCLICommand("nvmeof gw info")
-        @map_model(model.GatewayInfo)
+        @convert_to_model(model.GatewayInfo)
         @handle_nvmeof_error
         def list(self, gw_group: Optional[str] = None):
             return NVMeoFClient(gw_group=gw_group).stub.get_gateway_info(
@@ -56,7 +56,7 @@ def group(self):
         @ReadPermission
         @Endpoint('GET', '/version')
         @NvmeofCLICommand("nvmeof gw version")
-        @map_model(model.GatewayVersion)
+        @convert_to_model(model.GatewayVersion)
         @handle_nvmeof_error
         def version(self, gw_group: Optional[str] = None):
             gw_info = NVMeoFClient(gw_group=gw_group).stub.get_gateway_info(
@@ -69,7 +69,7 @@ def version(self, gw_group: Optional[str] = None):
         @ReadPermission
         @Endpoint('GET', '/log_level')
         @NvmeofCLICommand("nvmeof gw get_log_level")
-        @map_model(model.GatewayLogLevelInfo)
+        @convert_to_model(model.GatewayLogLevelInfo)
         @handle_nvmeof_error
         def get_log_level(self, gw_group: Optional[str] = None):
             gw_log_level = NVMeoFClient(gw_group=gw_group).stub.get_gateway_log_level(
@@ -80,7 +80,7 @@ def get_log_level(self, gw_group: Optional[str] = None):
         @ReadPermission
         @Endpoint('PUT', '/log_level')
         @NvmeofCLICommand("nvmeof gw set_log_level")
-        @map_model(model.RequestStatus)
+        @convert_to_model(model.RequestStatus)
         @handle_nvmeof_error
         def set_log_level(self, log_level: str, gw_group: Optional[str] = None):
             log_level = log_level.lower()
@@ -95,7 +95,7 @@ class NVMeoFSpdk(RESTController):
         @ReadPermission
         @Endpoint('GET', '/log_level')
         @NvmeofCLICommand("nvmeof spdk_log_level get")
-        @map_model(model.SpdkNvmfLogFlagsAndLevelInfo)
+        @convert_to_model(model.SpdkNvmfLogFlagsAndLevelInfo)
         @handle_nvmeof_error
         def get_spdk_log_level(self, gw_group: Optional[str] = None):
             spdk_log_level = NVMeoFClient(gw_group=gw_group).stub.get_spdk_nvmf_log_flags_and_level(
@@ -106,7 +106,7 @@ def get_spdk_log_level(self, gw_group: Optional[str] = None):
         @ReadPermission
         @Endpoint('PUT', '/log_level')
         @NvmeofCLICommand("nvmeof spdk_log_level set")
-        @map_model(model.RequestStatus)
+        @convert_to_model(model.RequestStatus)
         @handle_nvmeof_error
         def set_spdk_log_level(self, log_level: Optional[str] = None,
                                print_level: Optional[str] = None, gw_group: Optional[str] = None):
@@ -121,7 +121,7 @@ def set_spdk_log_level(self, log_level: Optional[str] = None,
         @ReadPermission
         @Endpoint('PUT', '/log_level/disable')
         @NvmeofCLICommand("nvmeof spdk_log_level disable")
-        @map_model(model.RequestStatus)
+        @convert_to_model(model.RequestStatus)
         @handle_nvmeof_error
         def disable_spdk_log_level(self, gw_group: Optional[str] = None):
             spdk_log_level = NVMeoFClient(gw_group=gw_group).stub.disable_spdk_nvmf_logs(
@@ -133,8 +133,9 @@ def disable_spdk_log_level(self, gw_group: Optional[str] = None):
     @APIDoc("NVMe-oF Subsystem Management API", "NVMe-oF Subsystem")
     class NVMeoFSubsystem(RESTController):
         @EndpointDoc("List all NVMeoF subsystems")
+        @pick(field="subsystems", first=True)
         @NvmeofCLICommand("nvmeof subsystem list")
-        @map_collection(model.Subsystem, pick="subsystems")
+        @convert_to_model(model.SubsystemList)
         @handle_nvmeof_error
         def list(self, gw_group: Optional[str] = None):
             return NVMeoFClient(gw_group=gw_group).stub.list_subsystems(
@@ -148,8 +149,9 @@ def list(self, gw_group: Optional[str] = None):
                 "gw_group": Param(str, "NVMeoF gateway group", True, None),
             },
         )
+        @pick(field="subsystems", first=True)
         @NvmeofCLICommand("nvmeof subsystem get")
-        @map_model(model.Subsystem, first="subsystems")
+        @convert_to_model(model.SubsystemList)
         @handle_nvmeof_error
         def get(self, nqn: str, gw_group: Optional[str] = None):
             return NVMeoFClient(gw_group=gw_group).stub.list_subsystems(
@@ -165,8 +167,9 @@ def get(self, nqn: str, gw_group: Optional[str] = None):
                 "gw_group": Param(str, "NVMeoF gateway group", True, None),
             },
         )
-        @NvmeofCLICommand("nvmeof subsystem add")
         @empty_response
+        @NvmeofCLICommand("nvmeof subsystem add")
+        @convert_to_model(model.RequestStatus)
         @handle_nvmeof_error
         def create(self, nqn: str, enable_ha: bool, max_namespaces: int = 1024,
                    gw_group: Optional[str] = None):
@@ -184,8 +187,9 @@ def create(self, nqn: str, enable_ha: bool, max_namespaces: int = 1024,
                 "gw_group": Param(str, "NVMeoF gateway group", True, None),
             },
         )
-        @NvmeofCLICommand("nvmeof subsystem del")
         @empty_response
+        @NvmeofCLICommand("nvmeof subsystem del")
+        @convert_to_model(model.RequestStatus)
         @handle_nvmeof_error
         def delete(self, nqn: str, force: Optional[str] = "false", gw_group: Optional[str] = None):
             return NVMeoFClient(gw_group=gw_group).stub.delete_subsystem(
@@ -204,8 +208,9 @@ class NVMeoFListener(RESTController):
                 "gw_group": Param(str, "NVMeoF gateway group", True, None),
             },
         )
+        @pick("listeners")
         @NvmeofCLICommand("nvmeof listener list")
-        @map_collection(model.Listener, pick="listeners")
+        @convert_to_model(model.ListenerList)
         @handle_nvmeof_error
         def list(self, nqn: str, gw_group: Optional[str] = None):
             return NVMeoFClient(gw_group=gw_group).stub.list_listeners(
@@ -223,8 +228,9 @@ def list(self, nqn: str, gw_group: Optional[str] = None):
                 "gw_group": Param(str, "NVMeoF gateway group", True, None),
             },
         )
-        @NvmeofCLICommand("nvmeof listener add")
         @empty_response
+        @NvmeofCLICommand("nvmeof listener add")
+        @convert_to_model(model.RequestStatus)
         @handle_nvmeof_error
         def create(
             self,
@@ -256,8 +262,9 @@ def create(
                 "gw_group": Param(str, "NVMeoF gateway group", True, None),
             },
         )
-        @NvmeofCLICommand("nvmeof listener del")
         @empty_response
+        @NvmeofCLICommand("nvmeof listener del")
+        @convert_to_model(model.RequestStatus)
         @handle_nvmeof_error
         def delete(
             self,
@@ -290,8 +297,9 @@ class NVMeoFNamespace(RESTController):
                 "gw_group": Param(str, "NVMeoF gateway group", True, None),
             },
         )
+        @pick("namespaces")
         @NvmeofCLICommand("nvmeof ns list")
-        @map_collection(model.Namespace, pick="namespaces")
+        @convert_to_model(model.NamespaceList)
         @handle_nvmeof_error
         def list(self, nqn: str, gw_group: Optional[str] = None):
             return NVMeoFClient(gw_group=gw_group).stub.list_namespaces(
@@ -306,8 +314,9 @@ def list(self, nqn: str, gw_group: Optional[str] = None):
                 "gw_group": Param(str, "NVMeoF gateway group", True, None),
             },
         )
+        @pick("namespaces", first=True)
         @NvmeofCLICommand("nvmeof ns get")
-        @map_model(model.Namespace, first="namespaces")
+        @convert_to_model(model.NamespaceList)
         @handle_nvmeof_error
         def get(self, nqn: str, nsid: str, gw_group: Optional[str] = None):
             return NVMeoFClient(gw_group=gw_group).stub.list_namespaces(
@@ -325,7 +334,7 @@ def get(self, nqn: str, nsid: str, gw_group: Optional[str] = None):
             },
         )
         @NvmeofCLICommand("nvmeof ns get_io_stats")
-        @map_model(model.NamespaceIOStats)
+        @convert_to_model(model.NamespaceIOStats)
         @handle_nvmeof_error
         def io_stats(self, nqn: str, nsid: str, gw_group: Optional[str] = None):
             return NVMeoFClient(gw_group=gw_group).stub.namespace_get_io_stats(
@@ -357,7 +366,7 @@ def io_stats(self, nqn: str, nsid: str, gw_group: Optional[str] = None):
             },
         )
         @NvmeofCLICommand("nvmeof ns add")
-        @map_model(model.NamespaceCreation)
+        @convert_to_model(model.NamespaceCreation)
         @handle_nvmeof_error
         def create(
             self,
@@ -404,8 +413,9 @@ def create(
                 "trash_image": Param(bool, "Trash RBD image after removing namespace")
             },
         )
+        @pick("namespaces", first=True)
         @NvmeofCLICommand("nvmeof ns update")
-        @map_model(model.Namespace, first="namespaces")
+        @convert_to_model(model.NamespaceList)
         @handle_nvmeof_error
         def update(
             self,
@@ -486,8 +496,9 @@ def update(
                 "force": Param(str, "Force remove the RBD image")
             },
         )
-        @NvmeofCLICommand("nvmeof ns del")
         @empty_response
+        @NvmeofCLICommand("nvmeof ns del")
+        @convert_to_model(model.RequestStatus)
         @handle_nvmeof_error
         def delete(
             self,
@@ -538,8 +549,9 @@ def list(self, nqn: str, gw_group: Optional[str] = None):
                 "gw_group": Param(str, "NVMeoF gateway group", True, None),
             },
         )
-        @NvmeofCLICommand("nvmeof host add")
         @empty_response
+        @NvmeofCLICommand("nvmeof host add")
+        @convert_to_model(model.RequestStatus)
         @handle_nvmeof_error
         def create(self, nqn: str, host_nqn: str, gw_group: Optional[str] = None):
             return NVMeoFClient(gw_group=gw_group).stub.add_host(
@@ -554,8 +566,9 @@ def create(self, nqn: str, host_nqn: str, gw_group: Optional[str] = None):
                 "gw_group": Param(str, "NVMeoF gateway group", True, None),
             },
         )
-        @NvmeofCLICommand("nvmeof host del")
         @empty_response
+        @NvmeofCLICommand("nvmeof host del")
+        @convert_to_model(model.RequestStatus)
         @handle_nvmeof_error
         def delete(self, nqn: str, host_nqn: str, gw_group: Optional[str] = None):
             return NVMeoFClient(gw_group=gw_group).stub.remove_host(
@@ -572,8 +585,9 @@ class NVMeoFConnection(RESTController):
                 "gw_group": Param(str, "NVMeoF gateway group", True, None),
             },
         )
+        @pick("connections")
         @NvmeofCLICommand("nvmeof connection list")
-        @map_collection(model.Connection, pick="connections")
+        @convert_to_model(model.ConnectionList)
         @handle_nvmeof_error
         def list(self, nqn: str, gw_group: Optional[str] = None):
             return NVMeoFClient(gw_group=gw_group).stub.list_connections(

src/pybind/mgr/dashboard/model/nvmeof.py

@@ -1,4 +1,4 @@
-from typing import NamedTuple, Optional
+from typing import List, NamedTuple, Optional
 
 
 class GatewayInfo(NamedTuple):
@@ -19,14 +19,14 @@ class GatewayVersion(NamedTuple):
 class GatewayLogLevelInfo(NamedTuple):
     status: int
     error_message: str
-    log_level: int
+    log_level: str
 
 
 class SpdkNvmfLogFlagsAndLevelInfo(NamedTuple):
     status: int
     error_message: str
-    log_level: int
-    log_print_level: int
+    log_level: str
+    log_print_level: str
 
 
 class Subsystem(NamedTuple):
@@ -41,6 +41,12 @@ class Subsystem(NamedTuple):
     max_namespaces: int
 
 
+class SubsystemList(NamedTuple):
+    status: int
+    error_message: str
+    subsystems: List[Subsystem]
+
+
 class Connection(NamedTuple):
     traddr: str
     trsvcid: int
@@ -51,7 +57,16 @@ class Connection(NamedTuple):
     controller_id: int
 
 
+class ConnectionList(NamedTuple):
+    status: int
+    error_message: str
+    subsystem_nqn: str
+    connections: List[Connection]
+
+
 class NamespaceCreation(NamedTuple):
+    status: int
+    error_message: str
     nsid: int
 
 
@@ -71,7 +86,16 @@ class Namespace(NamedTuple):
     trash_image: bool
 
 
+class NamespaceList(NamedTuple):
+    status: int
+    error_message: str
+    namespaces: List[Namespace]
+
+
 class NamespaceIOStats(NamedTuple):
+    status: int
+    error_message: str
+    subsystem_nqn: str
     nsid: int
     uuid: str
     bdev_name: str
@@ -95,7 +119,7 @@ class NamespaceIOStats(NamedTuple):
     copy_latency_ticks: int
     max_copy_latency_ticks: int
     min_copy_latency_ticks: int
-    # io_error: List[int]
+    io_error: List[int]
 
 
 class Listener(NamedTuple):
@@ -106,6 +130,12 @@ class Listener(NamedTuple):
     trsvcid: int = 4420
 
 
+class ListenerList(NamedTuple):
+    status: int
+    error_message: str
+    listeners: List[Listener]
+
+
 class Host(NamedTuple):
     nqn: str