control/cli: add ip requirement for listener

discovert controller need a specific ip/port.

fixes: #87

Signed-off-by: Yin Congmin <[email protected]>

README.md

@@ -134,7 +134,7 @@ Indicate the location of the keys and certificates in the config file:
 		$ python3 -m control.cli add_host -n nqn.2016-06.io.spdk:cnode1 -t '*'
 		INFO:root:Allowed open host access to nqn.2016-06.io.spdk:cnode1: True
 		
-		$ python3 -m control.cli create_listener -n nqn.2016-06.io.spdk:cnode1 -s 5001
+		$ python3 -m control.cli create_listener -n nqn.2016-06.io.spdk:cnode1 -g gateway_name -a gateway_addr -s 5001
 		INFO:root:Created nqn.2016-06.io.spdk:cnode1 listener: True
 
 3. On the storage client system (ubuntu-21.04):

control/cli.py

@@ -270,10 +270,10 @@ def remove_host(self, args):
 
     @cli.cmd([
         argument("-n", "--subnqn", help="Subsystem NQN", required=True),
-        argument("-g", "--gateway-name", help="Gateway name", default=""),
+        argument("-g", "--gateway-name", help="Gateway name", required=True),
         argument("-t", "--trtype", help="Transport type", default="TCP"),
         argument("-f", "--adrfam", help="Address family", default="ipv4"),
-        argument("-a", "--traddr", help="NVMe host IP", default=""),
+        argument("-a", "--traddr", help="NVMe host IP", required=True),
         argument("-s", "--trsvcid", help="Port number", required=True),
     ])
     def create_listener(self, args):
@@ -295,10 +295,10 @@ def create_listener(self, args):
 
     @cli.cmd([
         argument("-n", "--subnqn", help="Subsystem NQN", required=True),
-        argument("-g", "--gateway-name", help="Gateway name", default=""),
+        argument("-g", "--gateway-name", help="Gateway name", required=True),
         argument("-t", "--trtype", help="Transport type", default="TCP"),
         argument("-f", "--adrfam", help="Address family", default="ipv4"),
-        argument("-a", "--traddr", help="NVMe host IP", default=""),
+        argument("-a", "--traddr", help="NVMe host IP", required=True),
         argument("-s", "--trsvcid", help="Port number", required=True),
     ])
     def delete_listener(self, args):

control/grpc.py

@@ -330,25 +330,12 @@ def create_listener(self, request, context=None):
                          f" {request.trtype} listener for {request.nqn} at"
                          f" {request.traddr}:{request.trsvcid}.")
         try:
-            if (request.gateway_name and not request.traddr) or \
-               (not request.gateway_name and request.traddr):
-                raise Exception(
-                    "both gateway_name and traddr or neither must be specified")
-
-            if not request.gateway_name or \
-               request.gateway_name == self.gateway_name:
-                if not request.traddr:
-                    traddr = self.config.get("gateway", "addr")
-                    if not traddr:
-                        raise Exception("gateway.addr option is not set")
-                else:
-                    traddr = request.traddr
-
+            if request.gateway_name == self.gateway_name:
                 ret = self.spdk_rpc.nvmf.nvmf_subsystem_add_listener(
                     self.spdk_rpc_client,
                     nqn=request.nqn,
                     trtype=request.trtype,
-                    traddr=traddr,
+                    traddr=request.traddr,
                     trsvcid=request.trsvcid,
                     adrfam=request.adrfam,
                 )
@@ -384,25 +371,12 @@ def delete_listener(self, request, context=None):
                          f" {request.trtype} listener for {request.nqn} at"
                          f" {request.traddr}:{request.trsvcid}.")
         try:
-            if (request.gateway_name and not request.traddr) or \
-               (not request.gateway_name and request.traddr):
-                raise Exception(
-                    "both gateway_name and traddr or neither must be specified")
-
-            if not request.gateway_name or \
-               request.gateway_name == self.gateway_name:
-                if not request.traddr:
-                    traddr = self.config.get("gateway", "addr")
-                    if not traddr:
-                        raise Exception("gateway.addr option is not set")
-                else:
-                    traddr = request.traddr
-
+            if request.gateway_name == self.gateway_name:
                 ret = self.spdk_rpc.nvmf.nvmf_subsystem_remove_listener(
                     self.spdk_rpc_client,
                     nqn=request.nqn,
                     trtype=request.trtype,
-                    traddr=traddr,
+                    traddr=request.traddr,
                     trsvcid=request.trsvcid,
                     adrfam=request.adrfam,
                 )

tests/test_cli.py

@@ -12,7 +12,7 @@
 trtype = "TCP"
 gateway_name = socket.gethostname()
 addr = "127.0.0.1"
-listener_list = [["-g", gateway_name, "-a", addr, "-s", "5001"], ["-s", "5002"]]
+listener = ["-g", gateway_name, "-a", addr, "-s", "5001"]
 config = "ceph-nvmeof.conf"
 
 
@@ -40,8 +40,7 @@ def test_add_host(self, caplog, host):
         cli(["-c", config, "add_host", "-n", subsystem, "-t", host])
         assert "Failed to add" not in caplog.text
 
-    @pytest.mark.parametrize("listener", listener_list)
-    def test_create_listener(self, caplog, listener):
+    def test_create_listener(self, caplog):
         cli(["-c", config, "create_listener", "-n", subsystem] + listener)
         assert "Failed to create" not in caplog.text
 
@@ -52,8 +51,7 @@ def test_remove_host(self, caplog, host):
         cli(["-c", config, "remove_host", "-n", subsystem, "-t", host])
         assert "Failed to remove" not in caplog.text
 
-    @pytest.mark.parametrize("listener", listener_list)
-    def test_delete_listener(self, caplog, listener):
+    def test_delete_listener(self, caplog):
         cli(["-c", config, "delete_listener", "-n", subsystem] + listener)
         assert "Failed to delete" not in caplog.text