Implemented copy_file_to_local in pssh_client and created accompanying test.

Author: Kincaid Savoie

pssh/pssh_client.py

@@ -857,4 +857,39 @@ def _copy_file(self, host, local_file, remote_file, recurse=False):
                 agent=self.agent,
                 channel_timeout=self.channel_timeout)
         return self.host_clients[host].copy_file(local_file, remote_file,
-                                                 recurse=recurse)
+
+    def copy_file_to_local(self, remote_file, local_file):
+        """Copy remote file to local file in parallel
+
+        :param remote_file: remote filepath to copy to local host
+        :type remote_file: str
+        :param local_file: local filepath on local host to copy file to
+        :type local_file: str
+
+        .. note ::
+          Local directories in `local_file` that do not exist will be
+          created as long as permissions allow.
+
+        .. note ::
+          Path separation is handled client side so it is possible to copy
+          to/from hosts with differing path separators, like from/to Linux
+          and Windows.
+
+        .. note ::
+          File names will be de-duplicated by appending the hostname to the
+          filepath.
+
+        :rtype: List(:mod:`gevent.Greenlet`) of greenlets for remote copy \
+        commands
+        """
+        return [self.pool.spawn(self._copy_file_to_local, host, remote_file, local_file)
+                for host in self.hosts]
+
+    def _copy_file_to_local(self, host, remote_file, local_file):
+        """Make sftp client, copy file to local"""
+        if not self.host_clients[host]:
+            self.host_clients[host] = SSHClient(host, user=self.user,
+                                                password=self.password,
+                                                port=self.port, pkey=self.pkey,
+                                                forward_ssh_agent=self.forward_ssh_agent)
+        return self.host_clients[host].copy_file_to_local(remote_file, local_file + '_' + host)

tests/test_pssh_client.py

@@ -450,6 +450,31 @@ def test_pssh_client_copy_file_failure(self):
         for path in [local_test_path, remote_test_path]:
             shutil.rmtree(path)
 
+    def test_pssh_copy_file_to_local(self):
+        """Test parallel copy file to local host"""
+        test_file_data = 'test'
+        remote_filename = 'test_file'
+        local_test_dir, local_filename = 'local_test_dir', 'test_file_copy'
+        local_filename = os.path.sep.join([local_test_dir, local_filename])
+        test_file = open(remote_filename, 'w')
+        test_file.writelines([test_file_data + os.linesep])
+        test_file.close()
+        server = start_server({ self.fake_cmd : self.fake_resp },
+                              self.listen_socket)
+        client = ParallelSSHClient([self.host], port=self.listen_port,
+                                   pkey=self.user_key)
+        cmds = client.copy_file_to_local(remote_filename, local_filename)
+        cmds[0].get()
+        local_filename += '_' + self.host
+        self.assertTrue(os.path.isdir(local_test_dir),
+                        msg="SFTP create local directory failed")
+        self.assertTrue(os.path.isfile(local_filename),
+                        msg="SFTP copy failed")
+        for filepath in [remote_filename, local_filename]:
+            os.unlink(filepath)
+        del client
+        server.join()
+
     def test_pssh_pool_size(self):
         """Test setting pool size to non default values"""
         hosts = ['host-%01d' % d for d in xrange(5)]