Added sftp handle error exception. Updated sftp handle implementation.

Added tests for sftp open dir and file, readdir.

Author: Pan

ssh/exceptions.pyx

@@ -153,3 +153,7 @@ class UnknownChannelType(BaseSSHError):
 
 class ResourceShortage(BaseSSHError):
     """Raised on resource shortage errors"""
+
+
+class SFTPHandleError(BaseSSHError):
+    """Raised on errors SFTP handle errors"""

ssh/sftp.pyx

@@ -21,6 +21,7 @@ from sftp_handles cimport SFTPFile, SFTPDir
 from sftp_attributes cimport SFTPAttributes
 from sftp_statvfs cimport SFTPStatVFS
 from utils cimport handle_ssh_error_codes, to_bytes
+from .exceptions import SFTPHandleError
 
 cimport c_sftp
 from c_ssh cimport ssh_get_error_code, timeval
@@ -97,9 +98,12 @@ cdef class SFTP:
         with nogil:
             c_dir = c_sftp.sftp_opendir(self._sftp, c_path)
         if c_dir is NULL:
-            return handle_ssh_error_codes(
+            # May or may not be an 'ssh error' which only handles
+            # three error types
+            handle_ssh_error_codes(
                 ssh_get_error_code(self.session._session),
                 self.session._session)
+            raise SFTPHandleError
         _dir = SFTPDir.from_ptr(c_dir, self)
         return _dir
 
@@ -111,9 +115,10 @@ cdef class SFTP:
         with nogil:
             c_attrs = c_sftp.sftp_stat(self._sftp, c_path)
         if c_attrs is NULL:
-            return handle_ssh_error_codes(
+            handle_ssh_error_codes(
                 ssh_get_error_code(self.session._session),
                 self.session._session)
+            raise SFTPHandleError
         _attrs = SFTPAttributes.from_ptr(c_attrs, self)
         return _attrs
 
@@ -125,9 +130,10 @@ cdef class SFTP:
         with nogil:
             c_attrs = c_sftp.sftp_lstat(self._sftp, c_path)
         if c_attrs is NULL:
-            return handle_ssh_error_codes(
+            handle_ssh_error_codes(
                 ssh_get_error_code(self.session._session),
                 self.session._session)
+            raise SFTPHandleError
         _attrs = SFTPAttributes.from_ptr(c_attrs, self)
         return _attrs
 
@@ -139,9 +145,10 @@ cdef class SFTP:
         with nogil:
             c_file = c_sftp.sftp_open(self._sftp, c_path, accesstype, mode)
         if c_file is NULL:
-            return handle_ssh_error_codes(
+            handle_ssh_error_codes(
                 ssh_get_error_code(self.session._session),
                 self.session._session)
+            raise SFTPHandleError
         _file = SFTPFile.from_ptr(c_file, self)
         return _file
 

ssh/sftp_handles.pxd

@@ -15,6 +15,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-130
 
 from sftp cimport SFTP
+from sftp_attributes cimport SFTPAttributes
 
 cimport c_sftp
 
@@ -33,3 +34,5 @@ cdef class SFTPDir:
 
     @staticmethod
     cdef SFTPDir from_ptr(c_sftp.sftp_dir _dir, SFTP sftp)
+
+    cpdef SFTPAttributes readdir(self)

ssh/sftp_handles.pyx

@@ -14,6 +14,10 @@
 # License along with this library; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-130
 
+from sftp_attributes cimport SFTPAttributes
+
+from .exceptions import SFTPHandleError
+
 from c_ssh cimport uint32_t, uint64_t
 cimport c_sftp
 
@@ -29,6 +33,21 @@ cdef class SFTPFile:
         _fh._file = _file
         return _fh
 
+    def __enter__(self):
+        return self
+
+    def __exit__(self, *args):
+        self.close()
+
+    def __iter__(self):
+        return self
+
+    def __next__(self):
+        size, data = self.read()
+        while size > 0:
+            return size
+        raise StopIteration
+
     @property
     def sftp_session(self):
         return self.sftp
@@ -86,19 +105,50 @@ cdef class SFTPDir:
 
     @staticmethod
     cdef SFTPDir from_ptr(c_sftp.sftp_dir _dir, SFTP sftp):
-        cdef SFTPDir _fh = SFTPDir(SFTPDir, sftp)
+        cdef SFTPDir _fh = SFTPDir.__new__(SFTPDir, sftp)
         _fh._dir = _dir
         return _fh
 
+    def __enter__(self):
+        return self
+
+    def __exit__(self, *args):
+        self.closedir()
+
+    def __iter__(self):
+        return self
+
+    def __next__(self):
+        cdef SFTPAttributes _attrs
+        _attrs = self.readdir()
+        while _attrs is not None:
+            return _attrs
+        raise StopIteration
+
     @property
     def sftp_session(self):
         return self.sftp
 
     def eof(self):
-        pass
+        cdef bint rc
+        with nogil:
+            rc = c_sftp.sftp_dir_eof(self._dir)
+        return bool(rc)
 
     def closedir(self):
-        pass
-
-    def readdir(self):
-        pass
+        cdef int rc
+        with nogil:
+            rc = c_sftp.sftp_closedir(self._dir)
+        return rc
+
+    cpdef SFTPAttributes readdir(self):
+        cdef SFTPAttributes _attrs
+        cdef c_sftp.sftp_attributes c_attrs
+        with nogil:
+            c_attrs = c_sftp.sftp_readdir(self.sftp._sftp, self._dir)
+        if c_sftp.sftp_dir_eof(self._dir) == 1:
+            return
+        elif c_attrs is NULL:
+            raise SFTPHandleError
+        _attrs = SFTPAttributes.from_ptr(c_attrs, self.sftp)
+        return _attrs

tests/test_sftp.py

@@ -0,0 +1,99 @@
+# This file is part of ssh-python.
+# Copyright (C) 2018 Panos Kittenis
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation, version 2.1.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-130
+
+import unittest
+import os
+import platform
+
+from ssh.sftp import SFTP
+from ssh.sftp_handles import SFTPDir, SFTPFile
+from ssh.sftp_attributes import SFTPAttributes
+from ssh.exceptions import InvalidAPIUse, SFTPHandleError
+
+from .base_test import SSHTestCase
+
+
+class SFTPTest(SSHTestCase):
+
+    def test_sftp_init(self):
+        self._auth()
+        sftp = self.session.sftp_new()
+        self.assertIsInstance(sftp, SFTP)
+        self.assertEqual(sftp.init(), 0)
+
+    def test_sftp_fail(self):
+        self.assertRaises(InvalidAPIUse, self.session.sftp_new)
+        self._auth()
+        sftp = self.session.sftp_new()
+        self.assertRaises(SFTPHandleError, sftp.opendir, '.')
+
+    def test_sftp_dir(self):
+        self._auth()
+        sftp = self.session.sftp_new()
+        sftp.init()
+        _dir = sftp.opendir('.')
+        self.assertIsInstance(_dir, SFTPDir)
+        self.assertFalse(_dir.eof())
+        self.assertEqual(_dir.closedir(), 0)
+        # dir handle from context manager
+        with sftp.opendir('.') as _dir:
+            for attr in _dir:
+                self.assertIsInstance(attr, SFTPAttributes)
+                self.assertIsNotNone(attr.name)
+        self.assertTrue(_dir.eof())
+
+    def test_sftp_readdir(self):
+        self._auth()
+        sftp = self.session.sftp_new()
+        sftp.init()
+        with sftp.opendir('.') as _dir:
+            attrs = _dir.readdir()
+            self.assertIsInstance(attrs, SFTPAttributes)
+            self.assertIsNotNone(attrs.uid)
+            self.assertIsNotNone(attrs.gid)
+            self.assertIsNotNone(attrs.owner)
+            self.assertIsNotNone(attrs.group)
+            self.assertTrue(attrs.size > 0)
+            self.assertEqual(attrs.name, b'.')
+            self.assertTrue(len(attrs.longname) > 1)
+
+    def test_sftp_file(self):
+        self._auth()
+        sftp = self.session.sftp_new()
+        sftp.init()
+        if int(platform.python_version_tuple()[0]) >= 3:
+            test_file_data = b'test' + bytes(os.linesep, 'utf-8')
+        else:
+            test_file_data = b'test' + os.linesep
+        remote_filename = os.sep.join([os.path.dirname(__file__),
+                                       'remote_test_file'])
+        with open(remote_filename, 'wb') as test_fh:
+            test_fh.write(test_file_data)
+        try:
+            remote_fh = sftp.open(remote_filename, os.O_RDONLY, 0)
+            self.assertIsInstance(remote_fh, SFTPFile)
+        finally:
+            os.unlink(remote_filename)
+        # with sftp.open(remote_filename, 0, 0) as remote_fh:
+        #     try:
+        #         self.assertTrue(remote_fh is not None)
+        #         remote_data = b""
+        #         for rc, data in remote_fh:
+        #             remote_data += data
+        #         self.assertEqual(remote_fh.close(), 0)
+        #         self.assertEqual(remote_data, test_file_data)
+        #     finally:
+        #         os.unlink(remote_filename)