Refactor TCP port test with netcat into netutil

Specific error messages are no longer available with this refactoring.

Signed-off-by: Emmanuel Varagnat <[email protected]>

Author: guzu

conftest.py

@@ -25,8 +25,8 @@
     vm_image,
     wait_for,
 )
-from lib.netutil import is_ipv6
 from lib.host import Host
+from lib.netutil import is_ipv6, wait_for_ssh
 from lib.pool import Pool
 from lib.sr import SR
 from lib.vm import VM, vm_cache_key_from_def
@@ -203,9 +203,7 @@ def setup_host(hostname_or_ip, *, config=None):
             assert len(ips) == 1
             host_vm.ip = ips[0]
 
-            wait_for(lambda: commands.local_cmd(['nc', '-zw5', str(host_vm.ip), '22'],
-                                                 check=False, simple_output=False).returncode == 0,
-                     "Wait for ssh up on nested host", retry_delay_secs=5)
+            wait_for_ssh(host_vm.ip, host_desc="nested host")
 
             hostname_or_ip = host_vm.ip
 

lib/commands.py

@@ -5,7 +5,6 @@
 
 import lib.config as config
 from lib.common import HostAddress
-from lib.netutil import wrap_ip
 
 from typing import List, Literal, Union, overload
 
@@ -191,6 +190,9 @@ def ssh_with_result(hostname_or_ip, cmd, suppress_fingerprint_warnings=True,
     assert False, "unexpected type"
 
 def scp(hostname_or_ip, src, dest, check=True, suppress_fingerprint_warnings=True, local_dest=False):
+    # local import to avoid cyclic import; lib.netutils also import lib.commands
+    from lib.netutil import wrap_ip
+
     opts = '-o "BatchMode yes"'
     if suppress_fingerprint_warnings:
         # Suppress warnings and questions related to host key fingerprints

lib/host.py

@@ -32,7 +32,7 @@
     wait_for,
     wait_for_not,
 )
-from lib.netutil import wrap_ip
+from lib.netutil import wait_for_ssh, wrap_ip
 from lib.sr import SR
 from lib.vdi import VDI
 from lib.vm import VM
@@ -551,10 +551,7 @@ def reboot(self, verify=False):
                 raise
         if verify:
             wait_for_not(self.is_enabled, "Wait for host down")
-            wait_for(lambda: commands.local_cmd(['ping', '-c1', self.hostname_or_ip], simple_output=False).returncode == 0,
-                     "Wait for host up", timeout_secs=10 * 60, retry_delay_secs=10)
-            wait_for(lambda: commands.local_cmd(['nc', '-zw5', self.hostname_or_ip, '22'], simple_output=False).returncode == 0,
-                     "Wait for ssh up on host", timeout_secs=10 * 60, retry_delay_secs=5)
+            wait_for_ssh(self.hostname_or_ip)
             wait_for(self.is_enabled, "Wait for XAPI to be ready", timeout_secs=30 * 60)
 
     def management_network(self):

lib/netutil.py

@@ -1,5 +1,20 @@
 import socket
 
+from lib.commands import local_cmd
+from lib.common import wait_for
+
+def wait_for_tcp_port(host, port, port_desc, ping=True, host_desc=None):
+    if host_desc:
+        host_desc = f" ({host_desc})"
+    if ping:
+        wait_for(lambda: local_cmd(['ping', '-c1', host], check=False, simple_output=False).returncode == 0,
+                 "Wait for host up (ICMP ping)", timeout_secs=10 * 60, retry_delay_secs=10)
+    wait_for(lambda: local_cmd(['nc', '-zw5', host, str(port)], check=False, simple_output=False).returncode == 0,
+             f"Wait for {port_desc} up on host{host_desc}", timeout_secs=10 * 60, retry_delay_secs=5)
+
+def wait_for_ssh(host, host_desc=None, ping=True):
+    wait_for_tcp_port(host, 22, "SSH", ping, host_desc)
+
 def is_ipv6(ip):
     try:
         socket.inet_pton(socket.AF_INET6, ip)

tests/install/conftest.py

@@ -11,6 +11,7 @@
 from lib.commands import local_cmd
 from lib.common import callable_marker, url_download, wait_for
 from lib.installer import AnswerFile
+from lib.netutil import wait_for_ssh
 
 from typing import Generator, Sequence, Union
 
@@ -292,10 +293,7 @@ def vm_booted_with_installer(host, create_vms, remastered_iso):
             host_vm.ip = ips[0]
 
             # host may not be up if ARP cache was filled
-            wait_for(lambda: local_cmd(["ping", "-c1", host_vm.ip], check=False),
-                     "Wait for host up", timeout_secs=10 * 60, retry_delay_secs=10)
-            wait_for(lambda: local_cmd(["nc", "-zw5", host_vm.ip, "22"], check=False),
-                     "Wait for ssh up on host", timeout_secs=10 * 60, retry_delay_secs=5)
+            wait_for_ssh(host_vm.ip)
 
             yield host_vm
 

tests/install/test.py

@@ -7,6 +7,7 @@
 from lib import commands, installer, pxe
 from lib.common import safe_split, wait_for
 from lib.installer import AnswerFile
+from lib.netutil import wait_for_ssh
 from lib.pif import PIF
 from lib.pool import Pool
 from lib.vdi import VDI
@@ -187,10 +188,7 @@ def _test_firstboot(self, create_vms, mode, *, machine='DEFAULT', is_restore=Fal
             assert len(ips) == 1
             host_vm.ip = ips[0]
 
-            wait_for(
-                lambda: commands.local_cmd(
-                    ["nc", "-zw5", host_vm.ip, "22"], check=False).returncode == 0,
-                "Wait for ssh back up on Host VM", retry_delay_secs=5, timeout_secs=4 * 60)
+            wait_for_ssh(host_vm.ip, host_desc="host VM")
 
             logging.info("Checking installed version (expecting %r %r)",
                          expected_dist, expected_rel)