rpc: Rename get_portal_groups to iscsi_get_portal_groups

Change-Id: Idd9b6207674e3e3812f53c140e5dc705a25fb2cc
Signed-off-by: Pawel Kaminski <pawelx.kaminski@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/467834
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Broadcom SPDK FC-NVMe CI <spdk-ci.pdl@broadcom.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>

doc/iscsi.md

@@ -84,7 +84,7 @@ In addition to the configuration file, the iSCSI target may also be configured v
  - delete_portal_group -- Delete an existing portal group.
  - add_pg_ig_maps -- Add initiator group to portal group mappings to an existing iSCSI target node.
  - delete_pg_ig_maps -- Delete initiator group to portal group mappings from an existing iSCSI target node.
- - get_portal_groups -- Show information about all available portal groups.
+ - iscsi_get_portal_groups -- Show information about all available portal groups.
 
 ~~~
 /path/to/spdk/scripts/rpc.py add_portal_group 1 10.0.0.1:3260

doc/jsonrpc.md

@@ -259,7 +259,7 @@ Example response:
     "get_iscsi_connections",
     "delete_portal_group",
     "add_portal_group",
-    "get_portal_groups",
+    "iscsi_get_portal_groups",
     "delete_target_node",
     "delete_pg_ig_maps",
     "add_pg_ig_maps",
@@ -3424,7 +3424,7 @@ Example response:
 }
 ~~~
 
-## get_portal_groups method {#rpc_get_portal_groups}
+## iscsi_get_portal_groups method {#rpc_iscsi_get_portal_groups}
 
 Show information about all available portal groups.
 
@@ -3440,7 +3440,7 @@ Example request:
 request:
 {
   "jsonrpc": "2.0",
-  "method": "get_portal_groups",
+  "method": "iscsi_get_portal_groups",
   "id": 1
 }
 ~~~

lib/iscsi/iscsi_rpc.c

@@ -686,14 +686,14 @@ invalid:
 SPDK_RPC_REGISTER("delete_target_node", spdk_rpc_delete_target_node, SPDK_RPC_RUNTIME)
 
 static void
-spdk_rpc_get_portal_groups(struct spdk_jsonrpc_request *request,
+spdk_rpc_iscsi_get_portal_groups(struct spdk_jsonrpc_request *request,
 				 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_portal_groups requires no parameters");
+						 "iscsi_get_portal_groups requires no parameters");
 		return;
 	}
 
@@ -704,7 +704,8 @@ spdk_rpc_get_portal_groups(struct spdk_jsonrpc_request *request,
 
 	spdk_jsonrpc_end_result(request, w);
 }
-SPDK_RPC_REGISTER("get_portal_groups", spdk_rpc_get_portal_groups, SPDK_RPC_RUNTIME)
+SPDK_RPC_REGISTER("iscsi_get_portal_groups", spdk_rpc_iscsi_get_portal_groups, SPDK_RPC_RUNTIME)
+SPDK_RPC_REGISTER_ALIAS_DEPRECATED(iscsi_get_portal_groups, get_portal_groups)
 
 struct rpc_portal {
 	char *host;

scripts/rpc.py

@@ -782,12 +782,13 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse
                               help='Display current authentication group configuration')
     p.set_defaults(func=get_iscsi_auth_groups)
 
-    def get_portal_groups(args):
+    def iscsi_get_portal_groups(args):
-        print_dict(rpc.iscsi.get_portal_groups(args.client))
+        print_dict(rpc.iscsi.iscsi_get_portal_groups(args.client))
 
     p = subparsers.add_parser(
-        'get_portal_groups', help='Display current portal group configuration')
+        'iscsi_get_portal_groups', aliases=['get_portal_groups'],
-    p.set_defaults(func=get_portal_groups)
+        help='Display current portal group configuration')
+    p.set_defaults(func=iscsi_get_portal_groups)
 
     def get_initiator_groups(args):
         print_dict(rpc.iscsi.get_initiator_groups(args.client))

scripts/rpc/iscsi.py

@@ -124,13 +124,14 @@ def get_iscsi_auth_groups(client):
     return client.call('get_iscsi_auth_groups')
 
 
-def get_portal_groups(client):
+@deprecated_alias('get_portal_groups')
+def iscsi_get_portal_groups(client):
     """Display current portal group configuration.
 
     Returns:
         List of current portal group configuration.
     """
-    return client.call('get_portal_groups')
+    return client.call('iscsi_get_portal_groups')
 
 
 def get_initiator_groups(client):

scripts/spdkcli/ui_node_iscsi.py

@@ -335,7 +335,7 @@ class UIPortalGroups(UINode):
 
     def refresh(self):
         self._children = set([])
-        self.pgs = list(self.get_root().get_portal_groups())
+        self.pgs = list(self.get_root().iscsi_get_portal_groups())
         for pg in self.pgs:
             try:
                 UIPortalGroup(pg, self)

scripts/spdkcli/ui_root.py

@@ -392,9 +392,9 @@ class UIRoot(UINode):
 
     @verbose
     @is_method_available
-    def get_portal_groups(self):
+    def iscsi_get_portal_groups(self):
         if self.is_init:
-            for pg in rpc.iscsi.get_portal_groups(self.client):
+            for pg in rpc.iscsi.iscsi_get_portal_groups(self.client):
                 yield ScsiObj(pg)
 
     @verbose

test/iscsi_tgt/rpc_config/rpc_config.py

@@ -188,10 +188,10 @@ def create_malloc_bdevs_rpc_methods(rpc_py, rpc_param):
 
 def verify_portal_groups_rpc_methods(rpc_py, rpc_param):
     rpc = spdk_rpc(rpc_py)
-    output = rpc.get_portal_groups()
+    output = rpc.iscsi_get_portal_groups()
     jsonvalues = json.loads(output)
     verify(not jsonvalues, 1,
-           "get_portal_groups returned {} groups, expected empty".format(jsonvalues))
+           "iscsi_get_portal_groups returned {} groups, expected empty".format(jsonvalues))
 
     lo_ip = (target_ip, other_ip)
     nics = json.loads(rpc.get_interfaces())
@@ -202,10 +202,10 @@ def verify_portal_groups_rpc_methods(rpc_py, rpc_param):
         # The portal group tag must start at 1
         tag = idx + 1
         rpc.add_portal_group(tag, "{}:{}".format(value, rpc_param['port']))
-        output = rpc.get_portal_groups()
+        output = rpc.iscsi_get_portal_groups()
         jsonvalues = json.loads(output)
         verify(len(jsonvalues) == tag, 1,
-               "get_portal_groups returned {} groups, expected {}".format(len(jsonvalues), tag))
+               "iscsi_get_portal_groups returned {} groups, expected {}".format(len(jsonvalues), tag))
 
     tag_list = []
     for idx, value in enumerate(jsonvalues):
@@ -219,7 +219,7 @@ def verify_portal_groups_rpc_methods(rpc_py, rpc_param):
 
     for idx, value in enumerate(tag_list):
         rpc.delete_portal_group(value)
-        output = rpc.get_portal_groups()
+        output = rpc.iscsi_get_portal_groups()
         jsonvalues = json.loads(output)
         verify(len(jsonvalues) == (len(tag_list) - (idx + 1)), 1,
                "get_portal_group returned {} groups, expected {}".format(len(jsonvalues), (len(tag_list) - (idx + 1))))