Fixed use of SCP functions in non-blocking mode. Return lissh2 errors as appropriate exceptions from scp functions. Removed SCPError exception.

Author: Pan

.appveyor.yml

@@ -109,7 +109,6 @@ install:
   - ps: ls ssh2
 
 build_script:
-  # Build the compiled extension
   - "%CMD_IN_ENV% ci\\appveyor\\build_zlib.bat"
   - "%CMD_IN_ENV% ci\\appveyor\\build_ssh2.bat"
   - rm -f ssh2/*.c

Changelog.rst

@@ -14,8 +14,14 @@ Changes
 * Windows wheels switched to OpenSSL back end.
 * Windows wheels include zlib and have compression enabled.
 * Windows wheels no MAC and no encryption options enabled, same as posix wheels.
+* SCP functions now raise appropriate exception for all known libssh2 error codes.
 
-Note - binary wheels only.
+Fixes
+-------
+
+* SCP functions could not be used in non-blocking mode.
+
+Note - libssh2 changes apply to binary wheels only. For building from source `see documentation <http://ssh2-python.readthedocs.io/en/latest/installation.html#installation-from-source>`_.
 
 0.11.0
 ++++++++

setup.py

@@ -24,14 +24,11 @@
 
 ext = 'pyx' if USING_CYTHON else 'c'
 sources = glob('ssh2/*.%s' % (ext,))
-if ON_WINDOWS:
-    # For libssh2 OpenSSL backend on Windows.
-    _libs = ['Ws2_32', 'libssh2', 'user32',
-             'libeay32MD', 'ssleay32MD',
-             'zlibstatic',
-    ]
-else:
-    _libs = ['ssh2']
+_libs = ['ssh2'] if not ON_WINDOWS else [
+    'Ws2_32', 'libssh2', 'user32',
+    'libeay32MD', 'ssleay32MD',
+    'zlibstatic',
+]
 
 # _comp_args = ["-ggdb"]
 _comp_args = ["-O3"] if not ON_WINDOWS else None

ssh2/exceptions.c

@@ -159,11 +159,7 @@ class ChannelEOFSentError(ChannelError):
     """Raised on channel EOF errors"""
 
 
-class SCPError(SSH2Error):
-    """Raised on SCP errors. Base class for all SCP exceptions."""
-
-
-class SCPProtocolError(SCPError):
+class SCPProtocolError(SessionError):
     """Raised on SCP protocol errors"""
 
 

ssh2/exceptions.pyx

@@ -20,7 +20,7 @@ from libc.time cimport time_t
 from agent cimport PyAgent, agent_auth, agent_init, init_connect_agent
 from channel cimport PyChannel
 from exceptions import SessionHandshakeError, SessionStartupError, \
-    AuthenticationError, SessionHostKeyError, SCPError, KnownHostError, \
+    AuthenticationError, SessionHostKeyError, KnownHostError, \
     PublicKeyInitError, ChannelError
 from listener cimport PyListener
 from sftp cimport PySFTP
@@ -510,7 +510,8 @@ cdef class Session:
             channel = c_ssh2.libssh2_scp_recv(
                 self._session, _path, statinfo._stat)
         if channel is NULL:
-            raise SCPError("Error opening remote file %s for reading", path)
+            return handle_error_codes(c_ssh2.libssh2_session_last_errno(
+                self._session))
         return PyChannel(channel, self), statinfo
 
     IF EMBEDDED_LIB:
@@ -532,7 +533,8 @@ cdef class Session:
                 channel = c_ssh2.libssh2_scp_recv2(
                     self._session, _path, fileinfo._stat)
             if channel is NULL:
-                raise SCPError("Error opening remote file %s for reading", path)
+                return handle_error_codes(c_ssh2.libssh2_session_last_errno(
+                    self._session))
             return PyChannel(channel, self), fileinfo
 
     def scp_send(self, path not None, int mode, size_t size):
@@ -553,7 +555,8 @@ cdef class Session:
             channel = c_ssh2.libssh2_scp_send(
                 self._session, _path, mode, size)
         if channel is NULL:
-            raise SCPError("Error opening remote file %s for writing", path)
+            return handle_error_codes(c_ssh2.libssh2_session_last_errno(
+                self._session))
         return PyChannel(channel, self)
 
     def scp_send64(self, path not None, int mode, c_ssh2.libssh2_uint64_t size,
@@ -575,7 +578,8 @@ cdef class Session:
             channel = c_ssh2.libssh2_scp_send64(
                 self._session, _path, mode, size, mtime, atime)
         if channel is NULL:
-            raise SCPError("Error opening remote file %s for writing", path)
+            return handle_error_codes(c_ssh2.libssh2_session_last_errno(
+                self._session))
         return PyChannel(channel, self)
 
     def publickey_init(self):

ssh2/session.c

@@ -33,7 +33,7 @@
     ChannelError, ChannelOutOfOrderError, ChannelFailure, \
     ChannelRequestDenied, ChannelUnknownError, ChannelWindowExceeded, \
     ChannelPacketExceeded, ChannelClosedError, ChannelEOFSentError, \
-    SCPError, SCPProtocolError, ZlibError, SocketTimeout, \
+    SCPProtocolError, ZlibError, SocketTimeout, \
     RequestDeniedError, MethodNotSupported, InvalidRequestError, \
     InvalidPollTypeError, PublicKeyProtocolError, BufferTooSmallError, \
     BadUseError, CompressError, OutOfBoundaryError, SocketRecvError, \

ssh2/session.pyx

@@ -8,7 +8,7 @@
 from ssh2.channel import Channel
 from ssh2.error_codes import LIBSSH2_ERROR_EAGAIN
 from ssh2.exceptions import AuthenticationError, AgentAuthenticationError, \
-    SCPError, RequestDeniedError, InvalidRequestError, SocketSendError
+    SCPProtocolError, RequestDeniedError, InvalidRequestError, SocketSendError
 from ssh2.utils import wait_socket
 
 
@@ -83,7 +83,7 @@ def test_scp_recv2(self):
             raise
         finally:
             os.unlink(remote_filename)
-        self.assertRaises(SCPError, self.session.scp_recv2, remote_filename)
+        self.assertRaises(SCPProtocolError, self.session.scp_recv2, remote_filename)
 
     def test_scp_recv(self):
         self.assertEqual(self._auth(), 0)
@@ -109,7 +109,7 @@ def test_scp_recv(self):
             raise
         finally:
             os.unlink(remote_filename)
-        self.assertRaises(SCPError, self.session.scp_recv, remote_filename)
+        self.assertRaises(SCPProtocolError, self.session.scp_recv, remote_filename)
 
     def test_scp_send(self):
         self.assertEqual(self._auth(), 0)
@@ -140,7 +140,7 @@ def test_scp_send(self):
                 os.unlink(to_copy)
             except OSError:
                 pass
-        self.assertRaises(SCPError, self.session.scp_send,
+        self.assertRaises(SCPProtocolError, self.session.scp_send,
                           '/cannot_write', 1 & 777, 1)
 
     @skipUnless(hasattr(Session, 'scp_send64'),
@@ -175,7 +175,7 @@ def test_scp_send64(self):
                 os.unlink(to_copy)
             except OSError:
                 pass
-        self.assertRaises(SCPError, self.session.scp_send64,
+        self.assertRaises(SCPProtocolError, self.session.scp_send64,
                           '/cannot_write', 0 & 777, 1, 1, 1)
 
     def test_non_blocking(self):