support ssh timeout (confluentinc#311)

ducktape/cluster/remoteaccount.py

@@ -50,7 +50,8 @@ def wrapper(self, *args, **kwargs):
 
 
 class RemoteAccountSSHConfig(object):
-    def __init__(self, host=None, hostname=None, user=None, port=None, password=None, identityfile=None, **kwargs):
+    def __init__(self, host=None, hostname=None, user=None, port=None, password=None, identityfile=None,
+                 connecttimeout=None, **kwargs):
         """Wrapper for ssh configs used by ducktape to connect to remote machines.
 
         The fields in this class are lowercase versions of a small selection of ssh config properties
@@ -63,6 +64,8 @@ def __init__(self, host=None, hostname=None, user=None, port=None, password=None
         self.port = int(self.port)
         self.password = password
         self.identityfile = identityfile
+        # None is default, and it means default TCP timeout will be used.
+        self.connecttimeout = int(connecttimeout) if connecttimeout is not None else None
 
     @staticmethod
     def from_string(config_str):
@@ -194,7 +197,8 @@ def _set_ssh_client(self):
             username=self.ssh_config.user,
             password=self.ssh_config.password,
             key_filename=self.ssh_config.identityfile,
-            look_for_keys=False)
+            look_for_keys=False,
+            timeout=self.ssh_config.connecttimeout)
 
         if self._ssh_client:
             self._ssh_client.close()

tests/cluster/check_remoteaccount.py

@@ -104,13 +104,15 @@ def check_wait_for_http_timeout(self):
                                           [raise_error_checker, raise_no_error_checker]])
     def check_ssh_checker(self, checkers):
         self.server.start()
-        self.account = RemoteAccount(RemoteAccountSSHConfig.from_string(
+        ssh_config = RemoteAccountSSHConfig.from_string(
             """
         Host dummy_host.com
             Hostname dummy_host.name.com
             Port 22
             User dummy
-        """), ssh_exception_checks=checkers)
+            ConnectTimeout 1
+        """)
+        self.account = RemoteAccount(ssh_config, ssh_exception_checks=checkers)
         with pytest.raises(DummyException):
             self.account.ssh('echo test')
 

tests/cluster/check_vagrant.py

@@ -107,7 +107,8 @@ def check_cluster_file_write(self, monkeypatch):
                     "user": node_account.ssh_config.user,
                     "identityfile": node_account.ssh_config.identityfile,
                     "password": node_account.ssh_config.password,
-                    "port": node_account.ssh_config.port
+                    "port": node_account.ssh_config.port,
+                    "connecttimeout": None
                 }
             }
             for node_account in cluster._available_accounts
@@ -135,7 +136,8 @@ def check_cluster_file_read(self, monkeypatch):
                 "user": "vagrant",
                 "port": 2222,
                 "password": "password",
-                "identityfile": "/path/to/identfile3"
+                "identityfile": "/path/to/identfile3",
+                "connecttimeout": None
             }
         }
         nodes_expected.append(node1_expected)
@@ -148,7 +150,8 @@ def check_cluster_file_read(self, monkeypatch):
                 "user": "vagrant",
                 "port": 2223,
                 "password": None,
-                "identityfile": "/path/to/indentfile2"
+                "identityfile": "/path/to/indentfile2",
+                "connecttimeout": 10
             }
         }
         nodes_expected.append(node2_expected)