rpc: Rename get_scsi_devices to scsi_get_devices

Change-Id: I6ebc7323835d192ef89dcb449be90529d63be46e
Signed-off-by: Pawel Kaminski <pawelx.kaminski@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/468904
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>

doc/jsonrpc.md

@@ -240,7 +240,7 @@ Example response:
   "result": [
     "framework_start_init",
     "rpc_get_methods",
-    "get_scsi_devices",
+    "scsi_get_devices",
     "net_get_interfaces",
     "delete_ip_address",
     "net_interface_add_ip_address",

lib/scsi/scsi_rpc.c

@@ -38,7 +38,7 @@
 #include "spdk/util.h"
 
 static void
-spdk_rpc_get_scsi_devices(struct spdk_jsonrpc_request *request,
+spdk_rpc_scsi_get_devices(struct spdk_jsonrpc_request *request,
 			  const struct spdk_json_val *params)
 {
 	struct spdk_json_write_ctx *w;
@@ -47,7 +47,7 @@ spdk_rpc_get_scsi_devices(struct spdk_jsonrpc_request *request,
 
 	if (params != NULL) {
 		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
-						 "get_scsi_devices requires no parameters");
+						 "scsi_get_devices requires no parameters");
 		return;
 	}
 
@@ -73,4 +73,5 @@ spdk_rpc_get_scsi_devices(struct spdk_jsonrpc_request *request,
 
 	spdk_jsonrpc_end_result(request, w);
 }
-SPDK_RPC_REGISTER("get_scsi_devices", spdk_rpc_get_scsi_devices, SPDK_RPC_RUNTIME)
+SPDK_RPC_REGISTER("scsi_get_devices", spdk_rpc_scsi_get_devices, SPDK_RPC_RUNTIME)
+SPDK_RPC_REGISTER_ALIAS_DEPRECATED(scsi_get_devices, get_scsi_devices)

scripts/rpc.py

@@ -1140,11 +1140,12 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse
                               help='Display iSCSI global parameters')
     p.set_defaults(func=iscsi_get_options)
 
-    def get_scsi_devices(args):
+    def scsi_get_devices(args):
-        print_dict(rpc.iscsi.get_scsi_devices(args.client))
+        print_dict(rpc.iscsi.scsi_get_devices(args.client))
 
-    p = subparsers.add_parser('get_scsi_devices', help='Display SCSI devices')
+    p = subparsers.add_parser('scsi_get_devices', aliases=['get_scsi_devices'],
-    p.set_defaults(func=get_scsi_devices)
+                              help='Display SCSI devices')
+    p.set_defaults(func=scsi_get_devices)
 
     # trace
     def trace_enable_tpoint_group(args):

scripts/rpc/iscsi.py

@@ -548,10 +548,11 @@ def iscsi_get_options(client):
     return client.call('iscsi_get_options')
 
 
-def get_scsi_devices(client):
+@deprecated_alias('get_iscsi_devices')
+def scsi_get_devices(client):
     """Display SCSI devices.
 
     Returns:
         List of SCSI device.
     """
-    return client.call('get_scsi_devices')
+    return client.call('scsi_get_devices')

scripts/spdkcli/ui_node_iscsi.py

@@ -63,7 +63,7 @@ class UIISCSIDevices(UINode):
     def refresh(self):
         self._children = set([])
         self.target_nodes = list(self.get_root().iscsi_get_target_nodes())
-        self.scsi_devices = list(self.get_root().get_scsi_devices())
+        self.scsi_devices = list(self.get_root().scsi_get_devices())
         for device in self.scsi_devices:
             for node in self.target_nodes:
                 if hasattr(device, "device_name") and node['name'] \

scripts/spdkcli/ui_root.py

@@ -370,9 +370,9 @@ class UIRoot(UINode):
 
     @verbose
     @is_method_available
-    def get_scsi_devices(self):
+    def scsi_get_devices(self):
         if self.is_init:
-            for device in rpc.iscsi.get_scsi_devices(self.client):
+            for device in rpc.iscsi.scsi_get_devices(self.client):
                 yield ScsiObj(device)
 
     @verbose

test/iscsi_tgt/rpc_config/rpc_config.py

@@ -138,10 +138,10 @@ def verify_iscsi_connection_rpc_methods(rpc_py):
 
 def verify_scsi_devices_rpc_methods(rpc_py):
     rpc = spdk_rpc(rpc_py)
-    output = rpc.get_scsi_devices()
+    output = rpc.scsi_get_devices()
     jsonvalue = json.loads(output)
     verify(not jsonvalue, 1,
-           "get_scsi_devices returned {}, expected empty".format(jsonvalue))
+           "scsi_get_devices returned {}, expected empty".format(jsonvalue))
 
     rpc.bdev_malloc_create(rpc_param['malloc_bdev_size'], rpc_param['malloc_block_size'])
     rpc.iscsi_create_portal_group(portal_tag, "{}:{}".format(rpc_param['target_ip'], str(rpc_param['port'])))
@@ -157,7 +157,7 @@ def verify_scsi_devices_rpc_methods(rpc_py):
     output = rpc.iscsi_get_options()
     jsonvalues = json.loads(output)
     nodebase = jsonvalues['node_base']
-    output = rpc.get_scsi_devices()
+    output = rpc.scsi_get_devices()
     jsonvalues = json.loads(output)
     verify(jsonvalues[0]['device_name'] == nodebase + ":" + rpc_param['target_name'], 1,
            "device name vaule is {}, expected {}".format(jsonvalues[0]['device_name'], rpc_param['target_name']))
@@ -169,10 +169,10 @@ def verify_scsi_devices_rpc_methods(rpc_py):
     rpc.iscsi_delete_initiator_group(initiator_tag)
     rpc.iscsi_delete_portal_group(portal_tag)
     rpc.iscsi_delete_target_node(name)
-    output = rpc.get_scsi_devices()
+    output = rpc.scsi_get_devices()
     jsonvalues = json.loads(output)
     verify(not jsonvalues, 1,
-           "get_scsi_devices returned {}, expected empty".format(jsonvalues))
+           "scsi_get_devices returned {}, expected empty".format(jsonvalues))
 
     print("verify_scsi_devices_rpc_methods passed")