Cleanup and code quality changes. Changed SFTP test to use a remote path including a non-existing directory and a check that the directory is created remotely

Author: Dan

pssh.py

@@ -139,8 +139,8 @@ def __init__(self, host,
         self.proxy_command = paramiko.ProxyCommand(host_config['proxycommand']) if 'proxycommand' in \
                              host_config else None
         if self.proxy_command:
-            logger.debug("Proxy configured for destination host %s - ProxyCommand: '%s'" % (
-                self.host, " ".join(self.proxy_command.cmd),))
+            logger.debug("Proxy configured for destination host %s - ProxyCommand: '%s'",
+                         self.host, " ".join(self.proxy_command.cmd),)
         if _agent:
             self.client._agent = _agent
         self._connect()
@@ -153,26 +153,26 @@ def _connect(self, retries=1):
                                 pkey=self.pkey,
                                 sock=self.proxy_command)
         except socket.gaierror, e:
-            logger.error("Could not resolve host '%s'", self.host,)
+            logger.error("Could not resolve host '%s' - retry %s/%s",
+                         self.host, retries, NUM_RETRIES)
             while retries < NUM_RETRIES:
                 gevent.sleep(5)
                 return self._connect(retries=retries+1)
             raise UnknownHostException("%s - %s" % (str(e.args[1]),
                                                     self.host,))
         except socket.error, e:
-            logger.error("Error connecting to host '%s:%s'" % (self.host,
-                                                               self.port,))
+            logger.error("Error connecting to host '%s:%s' - retry %s/%s",
+                         self.host, self.port, retries, NUM_RETRIES)
             while retries < NUM_RETRIES:
                 gevent.sleep(5)
                 return self._connect(retries=retries+1)
-            raise ConnectionErrorException("%s for host '%s:%s'" % (str(e.args[1]),
-                                                                    self.host,
-                                                                    self.port,))
+            raise ConnectionErrorException("%s for host '%s:%s' - retry %s/%s",
+                                           str(e.args[1]), self.host, self.port,
+                                           retries, NUM_RETRIES,)
         except paramiko.AuthenticationException, e:
             raise AuthenticationException(e)
         except paramiko.ProxyCommandFailure, e:
-            logger.error("Error executing ProxyCommand - %s" % (
-                e.message,))
+            logger.error("Error executing ProxyCommand - %s", e.message,)
             raise ProxyCommandException(e.message)
 
     def exec_command(self, command, sudo=False, **kwargs):
@@ -188,7 +188,7 @@ def exec_command(self, command, sudo=False, **kwargs):
         :type sudo: bool
         :param kwargs: (Optional) Keyword arguments to be passed to remote \
         command
-        :type kwargs: dict                
+        :type kwargs: dict
         :rtype: Tuple of `(channel, hostname, stdout, stderr)`. \
         Channel is the remote SSH channel, needed to ensure all of stdout has \
         been got, hostname is remote hostname the copy is to, stdout and \
@@ -215,7 +215,7 @@ def exec_command(self, command, sudo=False, **kwargs):
     def _make_sftp(self):
         """Make SFTP client from open transport"""
         transport = self.client.get_transport()
-        channel = transport.open_session()
+        transport.open_session()
         return paramiko.SFTPClient.from_transport(transport)
 
     def mkdir(self, sftp, directory):
@@ -246,7 +246,6 @@ def copy_file(self, local_file, remote_file):
         """
         sftp = self._make_sftp()
         destination = remote_file.split(os.path.sep)
-        filename = destination[0] if len(destination) == 1 else destination[-1]
         remote_file = os.path.sep.join(destination)
         destination = destination[:-1]
         for directory in destination:

tests/test_ssh_client.py

@@ -49,7 +49,8 @@ def test_ssh_client_sftp(self):
         server, remove files and directory."""
         test_file_data = 'test'
         local_filename = 'test_file'
-        remote_filename = 'test_file_copy'
+        remote_test_dir, remote_filename = 'remote_test_dir', 'test_file_copy'
+        remote_filename = os.path.sep.join([remote_test_dir, remote_filename])
         remote_dir = 'remote_dir'
         test_file = open(local_filename, 'w')
         test_file.writelines([test_file_data + os.linesep])
@@ -59,6 +60,8 @@ def test_ssh_client_sftp(self):
         client = SSHClient('127.0.0.1', port=self.listen_port,
                            pkey=self.user_key)
         client.copy_file(local_filename, remote_filename)
+        self.assertTrue(os.path.isdir(remote_test_dir),
+                        msg="SFTP create remote directory failed")
         self.assertTrue(os.path.isfile(remote_filename),
                         msg="SFTP copy failed")
         copied_file = open(remote_filename, 'r')