From 4d62a7cc1f9b05d5efc699d3457a00f7676da4f5 Mon Sep 17 00:00:00 2001 From: Pawel Kaminski Date: Wed, 18 Sep 2019 05:07:01 -0400 Subject: [PATCH] rpc: Rename get_interfaces to net_get_interfaces Change-Id: I137901db9ec2d8f2a85b8e22fc7005081fafb032 Signed-off-by: Pawel Kaminski Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/468678 Reviewed-by: Ben Walker Reviewed-by: Jim Harris Reviewed-by: Paul Luse Tested-by: SPDK CI Jenkins --- doc/jsonrpc.md | 2 +- lib/net/net_rpc.c | 9 +++++---- scripts/rpc.py | 8 ++++---- scripts/rpc/net.py | 5 +++-- test/iscsi_tgt/rpc_config/rpc_config.py | 18 +++++++++--------- 5 files changed, 22 insertions(+), 20 deletions(-) diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index f2b1d7aef..4b05e052d 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -241,7 +241,7 @@ Example response: "start_subsystem_init", "get_rpc_methods", "get_scsi_devices", - "get_interfaces", + "net_get_interfaces", "delete_ip_address", "net_interface_add_ip_address", "nbd_get_disks", diff --git a/lib/net/net_rpc.c b/lib/net/net_rpc.c index d0ae2b581..6937fe4c7 100644 --- a/lib/net/net_rpc.c +++ b/lib/net/net_rpc.c @@ -144,8 +144,8 @@ SPDK_RPC_REGISTER("net_interface_delete_ip_address", spdk_rpc_net_interface_dele SPDK_RPC_REGISTER_ALIAS_DEPRECATED(net_interface_delete_ip_address, delete_ip_address) static void -spdk_rpc_get_interfaces(struct spdk_jsonrpc_request *request, - const struct spdk_json_val *params) +spdk_rpc_net_get_interfaces(struct spdk_jsonrpc_request *request, + const struct spdk_json_val *params) { struct spdk_json_write_ctx *w; TAILQ_HEAD(, spdk_interface) *interface_head = spdk_interface_get_list(); @@ -156,7 +156,7 @@ spdk_rpc_get_interfaces(struct spdk_jsonrpc_request *request, if (params != NULL) { spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, - "get_interfaces requires no parameters"); + "net_get_interfaces requires no parameters"); return; } @@ -184,6 +184,7 @@ spdk_rpc_get_interfaces(struct spdk_jsonrpc_request *request, spdk_jsonrpc_end_result(request, w); } -SPDK_RPC_REGISTER("get_interfaces", spdk_rpc_get_interfaces, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER("net_get_interfaces", spdk_rpc_net_get_interfaces, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER_ALIAS_DEPRECATED(net_get_interfaces, get_interfaces) SPDK_LOG_REGISTER_COMPONENT("net", SPDK_LOG_NET) diff --git a/scripts/rpc.py b/scripts/rpc.py index 1dfd30764..918991674 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -1526,12 +1526,12 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse p.add_argument('ip_addr', help='ip address will be deleted.') p.set_defaults(func=net_interface_delete_ip_address) - def get_interfaces(args): - print_dict(rpc.net.get_interfaces(args.client)) + def net_get_interfaces(args): + print_dict(rpc.net.net_get_interfaces(args.client)) p = subparsers.add_parser( - 'get_interfaces', help='Display current interface list') - p.set_defaults(func=get_interfaces) + 'net_get_interfaces', aliases=['get_interfaces'], help='Display current interface list') + p.set_defaults(func=net_get_interfaces) # NVMe-oF def set_nvmf_target_max_subsystems(args): diff --git a/scripts/rpc/net.py b/scripts/rpc/net.py index 58117ca93..7c479bba8 100644 --- a/scripts/rpc/net.py +++ b/scripts/rpc/net.py @@ -25,10 +25,11 @@ def net_interface_delete_ip_address(client, ifc_index, ip_addr): return client.call('net_interface_delete_ip_address', params) -def get_interfaces(client): +@deprecated_alias('get_interfaces') +def net_get_interfaces(client): """Display current interface list Returns: List of current interface """ - return client.call('get_interfaces') + return client.call('net_get_interfaces') diff --git a/test/iscsi_tgt/rpc_config/rpc_config.py b/test/iscsi_tgt/rpc_config/rpc_config.py index 5f64237d0..2187479e7 100755 --- a/test/iscsi_tgt/rpc_config/rpc_config.py +++ b/test/iscsi_tgt/rpc_config/rpc_config.py @@ -194,7 +194,7 @@ def verify_portal_groups_rpc_methods(rpc_py, rpc_param): "iscsi_get_portal_groups returned {} groups, expected empty".format(jsonvalues)) lo_ip = (target_ip, other_ip) - nics = json.loads(rpc.get_interfaces()) + nics = json.loads(rpc.net_get_interfaces()) for x in nics: if x["ifc_index"] == 'lo': rpc.net_interface_add_ip_address(x["ifc_index"], lo_ip[1]) @@ -401,20 +401,20 @@ def verify_target_nodes_rpc_methods(rpc_py, rpc_param): print("verify_target_nodes_rpc_methods passed.") -def verify_get_interfaces(rpc_py): +def verify_net_get_interfaces(rpc_py): rpc = spdk_rpc(rpc_py) - nics = json.loads(rpc.get_interfaces()) + nics = json.loads(rpc.net_get_interfaces()) nics_names = set(x["name"] for x in nics) - # parse ip link show to verify the get_interfaces result + # parse ip link show to verify the net_get_interfaces result ip_show = ns_cmd + " ip link show" ifcfg_nics = set(re.findall(r'\S+:\s(\S+?)(?:@\S+){0,1}:\s<.*', check_output(ip_show.split()).decode())) - verify(nics_names == ifcfg_nics, 1, "get_interfaces returned {}".format(nics)) - print("verify_get_interfaces passed.") + verify(nics_names == ifcfg_nics, 1, "net_get_interfaces returned {}".format(nics)) + print("verify_net_get_interfaces passed.") def help_get_interface_ip_list(rpc_py, nic_name): rpc = spdk_rpc(rpc_py) - nics = json.loads(rpc.get_interfaces()) + nics = json.loads(rpc.net_get_interfaces()) nic = list([x for x in nics if x["name"] == nic_name]) verify(len(nic) != 0, 1, "Nic name: {} is not found in {}".format(nic_name, [x["name"] for x in nics])) @@ -423,7 +423,7 @@ def help_get_interface_ip_list(rpc_py, nic_name): def verify_net_interface_add_delete_ip_address(rpc_py): rpc = spdk_rpc(rpc_py) - nics = json.loads(rpc.get_interfaces()) + nics = json.loads(rpc.net_get_interfaces()) # add ip on up to first 2 nics for x in nics[:2]: faked_ip = "123.123.{}.{}".format(random.randint(1, 254), random.randint(1, 254)) @@ -485,7 +485,7 @@ if __name__ == "__main__": try: verify_log_flag_rpc_methods(rpc_py, rpc_param) - verify_get_interfaces(rpc_py) + verify_net_get_interfaces(rpc_py) # Add/delete IP will not be supported in VPP. # It has separate vppctl utility for that. if test_type == 'posix':