Updated session and channel to not disconnect session prior to freeing channel and keep track of channel close status. Updated tests.

Author: Pan

ssh/channel.pxd

@@ -21,7 +21,8 @@ cimport c_ssh
 
 cdef class Channel:
     cdef c_ssh.ssh_channel _channel
-    cdef Session session
+    cdef readonly Session session
+    cdef readonly bint closed
 
     @staticmethod
     cdef Channel from_ptr(c_ssh.ssh_channel _chan, Session session)

ssh/channel.pyx

@@ -27,17 +27,15 @@ cdef class Channel:
 
     def __cinit__(self, Session session):
         self.session = session
+        self.closed = False
 
     def __dealloc__(self):
         if self._channel is not NULL:
+            if not self.closed:
+                c_ssh.ssh_channel_close(self._channel)
             c_ssh.ssh_channel_free(self._channel)
             self._channel = NULL
 
-    @property
-    def session(self):
-        """The originating session for this channel."""
-        return self.session
-
     @staticmethod
     cdef Channel from_ptr(c_ssh.ssh_channel _chan, Session session):
         cdef Channel chan = Channel.__new__(Channel, session)
@@ -46,8 +44,12 @@ cdef class Channel:
 
     def close(self):
         cdef int rc
+        if self.closed:
+            return 0
         with nogil:
             rc = c_ssh.ssh_channel_close(self._channel)
+        if rc == 0:
+            self.closed = True
         return handle_ssh_error_codes(rc, self.session._session)
 
     def get_exit_status(self):
@@ -144,7 +146,7 @@ cdef class Channel:
                 self._channel, timeout, is_stderr)
         return handle_ok_error_codes(rc)
 
-    def read(self, c_ssh.uint32_t size=1024, bint is_stderr=False):
+    def read(self, c_ssh.uint32_t size=1024*1024, bint is_stderr=False):
         cdef int rc
         cdef bytes buf = b''
         cdef char* cbuf
@@ -161,7 +163,7 @@ cdef class Channel:
             free(cbuf)
         return handle_ok_error_codes(rc), buf
 
-    def read_nonblocking(self, c_ssh.uint32_t size=1024, bint is_stderr=False):
+    def read_nonblocking(self, c_ssh.uint32_t size=1024*1024, bint is_stderr=False):
         cdef int rc
         cdef bytes buf = b''
         cdef char* cbuf
@@ -180,7 +182,7 @@ cdef class Channel:
         return handle_ok_error_codes(rc), buf
 
     def read_timeout(self, int timeout,
-                     c_ssh.uint32_t size=1024, bint is_stderr=False):
+                     c_ssh.uint32_t size=1024*1024, bint is_stderr=False):
         cdef int rc
         cdef bytes buf = b''
         cdef char* cbuf

ssh/helper.pyx

@@ -1,5 +1,5 @@
 # This file is part of ssh-python.
-# Copyright (C) 2017-2018 Panos Kittenis
+# 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

ssh/session.pyx

@@ -57,6 +57,8 @@ cdef class Session:
 
     def __dealloc__(self):
         if self._session is not NULL:
+            if c_ssh.ssh_is_connected(self._session):
+                c_ssh.ssh_disconnect(self._session)
             c_ssh.ssh_free(self._session)
             self._session = NULL
 
@@ -129,10 +131,12 @@ cdef class Session:
         return handle_ssh_error_codes(rc, self._session)
 
     def disconnect(self):
-        if self._session is NULL:
-            return
-        with nogil:
-            c_ssh.ssh_disconnect(self._session)
+        """No-op. Handled by object de-allocation."""
+        pass
+        # if not c_ssh.ssh_is_connected(self._session):
+        #     return
+        # with nogil:
+        #     c_ssh.ssh_disconnect(self._session)
 
     def connector_new(self):
         cdef c_ssh.ssh_connector _connector

tests/test_channel.py

@@ -26,6 +26,20 @@
 
 class ChannelTest(SSHTestCase):
 
+    def test_close(self):
+        self._auth()
+        chan = self.session.channel_new()
+        self.assertEqual(chan.open_session(), 0)
+        self.assertFalse(chan.closed)
+        chan.request_exec('echo me')
+        chan.read()
+        self.assertFalse(chan.closed)
+        chan.close()
+        self.assertTrue(chan.closed)
+        chan.close()
+        self.session.disconnect()
+        chan.close()
+
     def test_channel_exec(self):
         self._auth()
         chan = self.session.channel_new()

tests/test_session.py

@@ -52,15 +52,12 @@ def test_should_not_segfault(self):
         session.connector_new()
 
     def test_disconnect(self):
-        session = Session()
-        session.options_set(options.HOST, self.host)
-        session.options_set_port(self.port)
-        session.options_set(options.USER, self.user)
-        self.assertEqual(session.connect(), 0)
-        self.assertEqual(
-            session.userauth_publickey(self.pkey), 0)
-        session.disconnect()
-        del session
+        self._auth()
+        chan = self.session.channel_new()
+        chan.open_session()
+        chan.close()
+        self.session.disconnect()
+        del chan
 
     def test_socket_connect(self):
         sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)