Added scp send/recv functions to native clients.

Updated changelog.
Renamed tests.

Author: Pan

.appveyor.yml

@@ -112,4 +112,4 @@ artifacts:
   - path: "*.whl"
 
 deploy_script:
-  - IF "%APPVEYOR_REPO_TAG%" == "true"( python ci/appveyor/pypi_upload.py *.whl )
+  - python ci/appveyor/pypi_upload.py *.whl

Changelog.rst

@@ -7,6 +7,12 @@ Change Log
 Changes
 --------
 
+* Added ``scp_send`` and ``scp_recv`` functions to native clients for sending and receiving files via SCP respectively.
+* Refactoring - clients moved to their own sub-package - ``pssh.clients`` - with backwards compatibility for imports from ``pssh.pssh_client`` and ``pssh.pssh2_client``.
+* Show underlying exception from native client library when raising ``parallel-ssh`` exceptions.
+* ``host`` parameter added to all exceptions raised by parallel clients - #116
+* Deprecation warning for client imports.
+* Deprecation warning for default client changing from paramiko to native client as of ``2.0.0``.
 * Upgrade embedded ``libssh2`` in binary wheels to latest version plus enhancements.
 * Adds support for ECDSA host keys for native client.
 * Adds support for SHA-256 host key fingerprints for native client.
@@ -19,7 +25,7 @@ Fixes
 
 * Windows native client could not connect to newer SSH servers - thanks Pavel.
 
-Note - changes apply to binary wheels only. See building from source instructions to make system packages.
+Note - libssh2 changes apply to binary wheels only. For building from source, `see documentation <http://parallel-ssh.readthedocs.io/en/latest/installation.html#building-from-source>`_.
 
 1.5.5
 ++++++

ci/appveyor/pypi_upload.py

@@ -4,6 +4,10 @@
 
 
 def upload_pypi(files):
+    repo_tag = os.environ['APPVEYOR_REPO_TAG']
+    if repo_tag == 'false':
+        sys.stderr.write("Not a tagged release, skipping upload" + os.linesep)
+        return
     _user, _pass = os.environ['PYPI_USER'], os.environ['PYPI_PASS']
     try:
         subprocess.check_call(['twine', 'upload', '-u', _user,
@@ -16,8 +20,4 @@ def upload_pypi(files):
     if not len(sys.argv) > 1:
         sys.stderr.write("Need files to upload argument" + os.linesep)
         sys.exit(1)
-    if os.environ['APPVEYOR_REPO_TAG'] != 'true':
-        sys.stderr.write(
-            "Not a tagged build - skipping PyPi upload" + os.linesep)
-        sys.exit(0)
     upload_pypi(os.path.abspath(sys.argv[1]))

pssh/clients/base_pssh.py

@@ -303,15 +303,13 @@ def copy_remote_file(self, remote_file, local_file, recurse=False,
           host ``myhost``. ``suffix_separator`` has no meaning if
           ``copy_args`` is provided
         :type suffix_separator: str
-        :param copy_args: (Optional) format remote_file and local_file strings
-          with per-host arguments in ``copy_args``.   ``copy_args`` length must
+        :param copy_args: (Optional) Format remote_file and local_file strings
+          with per-host arguments in ``copy_args``. ``copy_args`` length must
           equal length of host list -
           :py:class:`pssh.exceptions.HostArgumentException` is raised otherwise
         :type copy_args: tuple or list
-
         :rtype: list(:py:class:`gevent.Greenlet`) of greenlets for remote copy
           commands
-
         :raises: :py:class:`ValueError` when a directory is supplied to
           local_file and recurse is not set
         :raises: :py:class:`pssh.exceptions.HostArgumentException` on number of
@@ -320,7 +318,7 @@ def copy_remote_file(self, remote_file, local_file, recurse=False,
         :raises: :py:class:`OSError` on OS errors like permission denied
 
         .. note ::
-          Local directories in `local_file` that do not exist will be
+          Local directories in ``local_file`` that do not exist will be
           created as long as permissions allow.
 
         .. note ::
@@ -333,8 +331,7 @@ def copy_remote_file(self, remote_file, local_file, recurse=False,
                 return [self.pool.spawn(
                     self._copy_remote_file, host,
                     remote_file % copy_args[host_i],
-                    local_file % copy_args[host_i], {'recurse': recurse},
-                    **kwargs)
+                    local_file % copy_args[host_i], recurse=recurse, **kwargs)
                     for host_i, host in enumerate(self.hosts)]
             except IndexError:
                 raise HostArgumentException(
@@ -343,8 +340,7 @@ def copy_remote_file(self, remote_file, local_file, recurse=False,
         else:
             return [self.pool.spawn(
                 self._copy_remote_file, host, remote_file,
-                suffix_separator.join([local_file, host]), recurse,
-                **kwargs)
+                suffix_separator.join([local_file, host]), recurse, **kwargs)
                 for host in self.hosts]
 
     def _copy_remote_file(self, host, remote_file, local_file, recurse,
@@ -353,8 +349,7 @@ def _copy_remote_file(self, host, remote_file, local_file, recurse,
         try:
             self._make_ssh_client(host)
             return self.host_clients[host].copy_remote_file(
-                remote_file, local_file, recurse=recurse,
-                **kwargs)
+                remote_file, local_file, recurse=recurse, **kwargs)
         except Exception as ex:
             ex.host = host
             raise ex

pssh/clients/native/parallel.py

@@ -21,7 +21,7 @@
 from ..base_pssh import BaseParallelSSHClient
 from ...constants import DEFAULT_RETRIES, RETRY_DELAY
 from .single import SSHClient
-from ...exceptions import ProxyError, Timeout
+from ...exceptions import ProxyError, Timeout, HostArgumentException
 from ...tunnel import Tunnel
 
 
@@ -446,3 +446,46 @@ def copy_remote_file(self, remote_file, local_file, recurse=False,
             self, remote_file, local_file, recurse=recurse,
             suffix_separator=suffix_separator, copy_args=copy_args,
             encoding=encoding)
+
+    def _scp_send(self, host, local_file, remote_file, recurse=False):
+        self._make_ssh_client(host)
+        return self._handle_greenlet_exc(
+            self.host_clients[host].scp_send, host,
+            local_file, remote_file, recurse=recurse)
+
+    def _scp_recv(self, host, remote_file, local_file, recurse=False):
+        self._make_ssh_client(host)
+        return self._handle_greenlet_exc(
+            self.host_clients[host].scp_recv, host,
+            remote_file, local_file, recurse=recurse)
+
+    def scp_send(self, local_file, remote_file, recurse=False):
+        return [self.pool.spawn(self._scp_send, host, local_file,
+                                remote_file, recurse=recurse)
+                for host in self.hosts]
+
+    def scp_recv(self, remote_file, local_file, recurse=False, copy_args=None):
+        copy_args = [{'local_file': '_'.join([local_file, host]),
+                      'remote_file': remote_file}
+                     for i, host in enumerate(self.hosts)] \
+                         if copy_args is None else copy_args
+        local_file = "%(local_file)s"
+        remote_file = "%(remote_file)s"
+        try:
+            return [self.pool.spawn(
+                self._scp_recv, host,
+                remote_file % copy_args[host_i],
+                local_file % copy_args[host_i], recurse=recurse)
+                    for host_i, host in enumerate(self.hosts)]
+        except IndexError:
+            raise HostArgumentException(
+                "Number of per-host copy arguments provided does not match "
+                "number of hosts")
+
+    def _handle_greenlet_exc(self, func, host, *args, **kwargs):
+        try:
+            self._make_ssh_client(host)
+            return func(*args, **kwargs)
+        except Exception as ex:
+            ex.host = host
+            raise ex