rpc: Rename get_target_nodes to iscsi_get_target_nodes

Change-Id: I0ca8a1cfbcced53932e292abf3a088dd7f5e8928
Signed-off-by: Pawel Kaminski <pawelx.kaminski@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/467332
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Broadcom SPDK FC-NVMe CI <spdk-ci.pdl@broadcom.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>

doc/iscsi.md

@@ -106,7 +106,7 @@ In addition to the configuration file, the iSCSI target may also be configured v
  - construct_target_node -- Add a iSCSI target node.
  - delete_target_node -- Delete a iSCSI target node.
  - target_node_add_lun -- Add an LUN to an existing iSCSI target node.
- - get_target_nodes -- Show information about all available iSCSI target nodes.
+ - iscsi_get_target_nodes -- Show information about all available iSCSI target nodes.
 
 ~~~
 /path/to/spdk/scripts/rpc.py construct_target_node Target3 Target3_alias MyBdev:0 1:2 64 -d

doc/jsonrpc.md

@@ -264,7 +264,7 @@ Example response:
     "delete_pg_ig_maps",
     "add_pg_ig_maps",
     "construct_target_node",
-    "get_target_nodes",
+    "iscsi_get_target_nodes",
     "delete_initiator_group",
     "delete_initiators_from_initiator_group",
     "add_initiators_to_initiator_group",
@@ -3090,7 +3090,7 @@ response:
 }
 ~~~
 
-## get_target_nodes method {#rpc_get_target_nodes}
+## iscsi_get_target_nodes method {#rpc_iscsi_get_target_nodes}
 
 Show information about all available iSCSI target nodes.
 
@@ -3123,7 +3123,7 @@ Example request:
 ~~~
 {
   "jsonrpc": "2.0",
-  "method": "get_target_nodes",
+  "method": "iscsi_get_target_nodes",
   "id": 1
 }
 ~~~

lib/iscsi/iscsi_rpc.c

@@ -291,14 +291,14 @@ invalid:
 SPDK_RPC_REGISTER("delete_initiator_group", spdk_rpc_delete_initiator_group, SPDK_RPC_RUNTIME)
 
 static void
-spdk_rpc_get_target_nodes(struct spdk_jsonrpc_request *request,
+spdk_rpc_iscsi_get_target_nodes(struct spdk_jsonrpc_request *request,
-			  const struct spdk_json_val *params)
+				const struct spdk_json_val *params)
 {
 	struct spdk_json_write_ctx *w;
 
 	if (params != NULL) {
 		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
-						 "get_target_nodes requires no parameters");
+						 "iscsi_get_target_nodes requires no parameters");
 		return;
 	}
 
@@ -309,7 +309,8 @@ spdk_rpc_get_target_nodes(struct spdk_jsonrpc_request *request,
 
 	spdk_jsonrpc_end_result(request, w);
 }
-SPDK_RPC_REGISTER("get_target_nodes", spdk_rpc_get_target_nodes, SPDK_RPC_RUNTIME)
+SPDK_RPC_REGISTER("iscsi_get_target_nodes", spdk_rpc_iscsi_get_target_nodes, SPDK_RPC_RUNTIME)
+SPDK_RPC_REGISTER_ALIAS_DEPRECATED(iscsi_get_target_nodes, get_target_nodes)
 
 struct rpc_pg_ig_map {
 	int32_t pg_tag;

scripts/rpc.py

@@ -796,11 +796,12 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse
                               help='Display current initiator group configuration')
     p.set_defaults(func=get_initiator_groups)
 
-    def get_target_nodes(args):
+    def iscsi_get_target_nodes(args):
-        print_dict(rpc.iscsi.get_target_nodes(args.client))
+        print_dict(rpc.iscsi.iscsi_get_target_nodes(args.client))
 
-    p = subparsers.add_parser('get_target_nodes', help='Display target nodes')
+    p = subparsers.add_parser('iscsi_get_target_nodes', aliases=['get_target_nodes'],
-    p.set_defaults(func=get_target_nodes)
+                              help='Display target nodes')
+    p.set_defaults(func=iscsi_get_target_nodes)
 
     def construct_target_node(args):
         luns = []

scripts/rpc/iscsi.py

@@ -1,3 +1,4 @@
+from .helpers import deprecated_alias
 
 
 def set_iscsi_options(
@@ -141,13 +142,14 @@ def get_initiator_groups(client):
     return client.call('get_initiator_groups')
 
 
-def get_target_nodes(client):
+@deprecated_alias('get_target_nodes')
+def iscsi_get_target_nodes(client):
     """Display target nodes.
 
     Returns:
         List of ISCSI target node objects.
     """
-    return client.call('get_target_nodes')
+    return client.call('iscsi_get_target_nodes')
 
 
 def construct_target_node(

scripts/spdkcli/ui_node_iscsi.py

@@ -62,7 +62,7 @@ class UIISCSIDevices(UINode):
 
     def refresh(self):
         self._children = set([])
-        self.target_nodes = list(self.get_root().get_target_nodes())
+        self.target_nodes = list(self.get_root().iscsi_get_target_nodes())
         self.scsi_devices = list(self.get_root().get_scsi_devices())
         for device in self.scsi_devices:
             for node in self.target_nodes:

scripts/spdkcli/ui_root.py

@@ -377,9 +377,9 @@ class UIRoot(UINode):
 
     @verbose
     @is_method_available
-    def get_target_nodes(self):
+    def iscsi_get_target_nodes(self):
         if self.is_init:
-            for tg in rpc.iscsi.get_target_nodes(self.client):
+            for tg in rpc.iscsi.iscsi_get_target_nodes(self.client):
                 yield tg
 
     @verbose

test/iscsi_tgt/rpc_config/rpc_config.py

@@ -110,7 +110,7 @@ def verify_iscsi_connection_rpc_methods(rpc_py):
     rpc.construct_target_node(rpc_param['target_name'], rpc_param['alias_name'], lun_mapping, net_mapping, rpc_param['queue_depth'], '-d')
     check_output('iscsiadm -m discovery -t st -p {}'.format(rpc_param['target_ip']), shell=True)
     check_output('iscsiadm -m node --login', shell=True)
-    name = json.loads(rpc.get_target_nodes())[0]['name']
+    name = json.loads(rpc.iscsi_get_target_nodes())[0]['name']
     output = rpc.get_iscsi_connections()
     jsonvalues = json.loads(output)
     verify(jsonvalues[0]['target_node_name'] == rpc_param['target_name'], 1,
@@ -151,7 +151,7 @@ def verify_scsi_devices_rpc_methods(rpc_py):
     rpc.construct_target_node(rpc_param['target_name'], rpc_param['alias_name'], lun_mapping, net_mapping, rpc_param['queue_depth'], '-d')
     check_output('iscsiadm -m discovery -t st -p {}'.format(rpc_param['target_ip']), shell=True)
     check_output('iscsiadm -m node --login', shell=True)
-    name = json.loads(rpc.get_target_nodes())[0]['name']
+    name = json.loads(rpc.iscsi_get_target_nodes())[0]['name']
     output = rpc.get_iscsi_global_params()
     jsonvalues = json.loads(output)
     nodebase = jsonvalues['node_base']
@@ -325,10 +325,10 @@ def verify_target_nodes_rpc_methods(rpc_py, rpc_param):
     output = rpc.get_iscsi_global_params()
     jsonvalues = json.loads(output)
     nodebase = jsonvalues['node_base']
-    output = rpc.get_target_nodes()
+    output = rpc.iscsi_get_target_nodes()
     jsonvalues = json.loads(output)
     verify(not jsonvalues, 1,
-           "get_target_nodes returned {}, expected empty".format(jsonvalues))
+           "iscsi_get_target_nodes returned {}, expected empty".format(jsonvalues))
 
     rpc.bdev_malloc_create(rpc_param['malloc_bdev_size'], rpc_param['malloc_block_size'])
     rpc.add_portal_group(portal_tag, "{}:{}".format(rpc_param['target_ip'], str(rpc_param['port'])))
@@ -337,10 +337,10 @@ def verify_target_nodes_rpc_methods(rpc_py, rpc_param):
     lun_mapping = "Malloc" + str(rpc_param['lun_total']) + ":0"
     net_mapping = portal_tag + ":" + initiator_tag
     rpc.construct_target_node(rpc_param['target_name'], rpc_param['alias_name'], lun_mapping, net_mapping, rpc_param['queue_depth'], '-d')
-    output = rpc.get_target_nodes()
+    output = rpc.iscsi_get_target_nodes()
     jsonvalues = json.loads(output)
     verify(len(jsonvalues) == 1, 1,
-           "get_target_nodes returned {} nodes, expected 1".format(len(jsonvalues)))
+           "iscsi_get_target_nodes returned {} nodes, expected 1".format(len(jsonvalues)))
     bdev_name = jsonvalues[0]['luns'][0]['bdev_name']
     verify(bdev_name == "Malloc" + str(rpc_param['lun_total']), 1,
            "bdev_name value is {}, expected Malloc{}".format(jsonvalues[0]['luns'][0]['bdev_name'], str(rpc_param['lun_total'])))
@@ -371,7 +371,7 @@ def verify_target_nodes_rpc_methods(rpc_py, rpc_param):
            "data digest value is {}, expected {}".format(jsonvalues[0]['data_digest'], rpc_param['data_digest']))
     lun_id = '1'
     rpc.target_node_add_lun(name, bdev_name, "-i", lun_id)
-    output = rpc.get_target_nodes()
+    output = rpc.iscsi_get_target_nodes()
     jsonvalues = json.loads(output)
     verify(jsonvalues[0]['luns'][1]['bdev_name'] == "Malloc" + str(rpc_param['lun_total']), 1,
            "bdev_name value is {}, expected Malloc{}".format(jsonvalues[0]['luns'][0]['bdev_name'], str(rpc_param['lun_total'])))
@@ -379,17 +379,17 @@ def verify_target_nodes_rpc_methods(rpc_py, rpc_param):
            "lun id value is {}, expected 1".format(jsonvalues[0]['luns'][1]['lun_id']))
 
     rpc.delete_target_node(name)
-    output = rpc.get_target_nodes()
+    output = rpc.iscsi_get_target_nodes()
     jsonvalues = json.loads(output)
     verify(not jsonvalues, 1,
-           "get_target_nodes returned {}, expected empty".format(jsonvalues))
+           "iscsi_get_target_nodes returned {}, expected empty".format(jsonvalues))
 
     rpc.construct_target_node(rpc_param['target_name'], rpc_param['alias_name'], lun_mapping, net_mapping, rpc_param['queue_depth'], '-d')
 
     rpc.delete_portal_group(portal_tag)
     rpc.delete_initiator_group(initiator_tag)
     rpc.delete_target_node(name)
-    output = rpc.get_target_nodes()
+    output = rpc.iscsi_get_target_nodes()
     jsonvalues = json.loads(output)
     if not jsonvalues:
         print("This issue will be fixed later.")