Moved pssh_local.py example script to examples dir. Removed unused embedded server code. Minor test code update for race condition avoidance. Added unit tests for pssh.utils package. Updated pssh_local example script

Author: Dan

embedded_server/embedded_server.py

@@ -41,7 +41,6 @@
 from .stub_sftp import StubSFTPServer
 from .tunnel import Tunneler
 import gevent.subprocess
-# import gipc
 
 logger = logging.getLogger("embedded_server")
 paramiko_logger = logging.getLogger('paramiko.transport')
@@ -208,14 +207,6 @@ def start_server(sock, fail_auth=False, ssh_exception=False,
     return gevent.spawn(listen, sock, fail_auth=fail_auth,
                         timeout=timeout, ssh_exception=ssh_exception)
 
-# def start_server_process(listen_ip, fail_auth=False, ssh_exception=False,
-#                          timeout=None):
-#     p = gipc.start_process(target=_make_sock_start_server, args=(listen_ip,),
-#                            kwargs={'fail_auth': fail_auth,
-#                                    'timeout': timeout,
-#                                    'ssh_exception': ssh_exception,})
-#     return p
-
 if __name__ == "__main__":
     logging.basicConfig()
     logger.setLevel(logging.DEBUG)

pssh_local.py renamed to examples/pssh_local.py

@@ -20,37 +20,40 @@
 and ParallelSSHClient.
 """
 
-from pssh import SSHClient, ParallelSSHClient
+from pssh import SSHClient, ParallelSSHClient, utils
 import logging
+from pprint import pprint
 
-logger = logging.getLogger('pssh')
-
-def _setup_logger(_logger):
-    """Setup default logger"""
-    _handler = logging.StreamHandler()
-    log_format = logging.Formatter(
-        '%(name)s - %(asctime)s - %(levelname)s - %(message)s')
-    _handler.setFormatter(log_format)
-    _logger.addHandler(_handler)
-    _logger.setLevel(logging.DEBUG)
+utils.enable_host_logger()
+utils.enable_logger(utils.logger)
 
 def test():
     """Perform ls and copy file with SSHClient on localhost"""
     client = SSHClient('localhost')
     channel, host, stdout, stderr = client.exec_command('ls -ltrh')
     for line in stdout:
-        print line.strip()
+        pprint(line.strip())
     client.copy_file('../test', 'test_dir/test')
 
 def test_parallel():
-    """Perform ls and copy file with ParallelSSHClient on localhost"""
+    """Perform ls and copy file with ParallelSSHClient on localhost.
+    
+    Two identical hosts cause the same command to be executed
+    twice on the same host in two parallel connections.
+    In printed output there will be two identical lines per printed per
+    line of `ls -ltrh` output as output is printed by host_logger as it
+    becomes available and commands are executed in parallel
+    
+    Host output key is de-duplicated so that output for the two
+    commands run on the same host(s) is not lost
+    """
     client = ParallelSSHClient(['localhost', 'localhost'])
     output = client.run_command('ls -ltrh')
-    print output
-    # cmds = client.copy_file('../test', 'test_dir/test')
-    # client.pool.join()
+    client.join(output)
+    pprint(output)
+    cmds = client.copy_file('../test', 'test_dir/test')
+    client.pool.join()
 
 if __name__ == "__main__":
-    _setup_logger(logger)
-    # test()
+    test()
     test_parallel()

tests/test_pssh_client.py

@@ -583,7 +583,7 @@ def test_ssh_exception(self):
                                    user='fakey', password='fakey',
                                    pkey=paramiko.RSAKey.generate(1024))
         output = client.run_command(self.fake_cmd, stop_on_errors=False)
-        gevent.sleep(.2)
+        gevent.sleep(1)
         client.pool.join()
         self.assertTrue('exception' in output[host],
                         msg="Got no exception for host %s - expected connection error" % (

tests/test_utils.py

@@ -0,0 +1,15 @@
+from pssh import utils
+import unittest
+
+
+class ParallelSSHUtilsTest(unittest.TestCase):
+
+    def test_enabling_host_logger(self):
+        utils.enable_host_logger()
+        # And again to test only one handler is attached
+        utils.enable_host_logger()
+        self.assertTrue(len(utils.host_logger.handlers)==1)
+
+    def test_enabling_pssh_logger(self):
+        utils.enable_logger(utils.logger)
+        self.assertTrue(len(utils.logger.handlers)==1)