Merged py3 branch changes. Bumped gevent requirement to 1.1rc3. Added agent parameter to ParallelSSHClient class and made agent parameter in SSHClient public. Added explicit agent usage in tests to avoid using system agent in tests.

Author: Dan

.travis.yml

@@ -4,10 +4,12 @@ sudo: false
 python:
   - 2.6
   - 2.7
+  - 3.4
+  - 3.5
 install:
   - pip install -r requirements.txt
   - pip install coveralls
-script: nosetests --with-coverage --cover-package=pssh
+script: python setup.py nosetests --with-coverage --cover-package=pssh
 notifications:
   email:
     on_failure: change

embedded_server/embedded_server.py

@@ -44,7 +44,7 @@
 
 host_key = paramiko.RSAKey(filename = os.path.sep.join([os.path.dirname(__file__), 'rsa.key']))
 
-class Server (paramiko.ServerInterface):
+class Server(paramiko.ServerInterface):
     def __init__(self, transport, fail_auth=False,
                  ssh_exception=False):
         self.event = Event()

pssh/pssh_client.py

@@ -50,7 +50,8 @@ class ParallelSSHClient(object):
     def __init__(self, hosts,
                  user=None, password=None, port=None, pkey=None,
                  forward_ssh_agent=True, num_retries=DEFAULT_RETRIES, timeout=120,
-                 pool_size=10, proxy_host=None, proxy_port=22):
+                 pool_size=10, proxy_host=None, proxy_port=22,
+                 agent=None):
         """
         :param hosts: Hosts to connect to
         :type hosts: list(str)
@@ -196,6 +197,7 @@ def __init__(self, hosts,
         self.proxy_host, self.proxy_port = proxy_host, proxy_port
         # To hold host clients
         self.host_clients = dict((host, None) for host in hosts)
+        self.agent = agent
 
     def run_command(self, *args, **kwargs):
         """Run command on all hosts in parallel, honoring self.pool_size,
@@ -325,7 +327,8 @@ def _exec_command(self, host, *args, **kwargs):
                                                 num_retries=self.num_retries,
                                                 timeout=self.timeout,
                                                 proxy_host=self.proxy_host,
-                                                proxy_port=self.proxy_port)
+                                                proxy_port=self.proxy_port,
+                                                agent=self.agent)
         return self.host_clients[host].exec_command(*args, **kwargs)
 
     def get_output(self, cmd, output):

pssh/ssh_client.py

@@ -46,7 +46,7 @@ class SSHClient(object):
     def __init__(self, host,
                  user=None, password=None, port=None,
                  pkey=None, forward_ssh_agent=True,
-                 num_retries=DEFAULT_RETRIES, _agent=None, timeout=10,
+                 num_retries=DEFAULT_RETRIES, agent=None, timeout=10,
                  proxy_host=None, proxy_port=22):
         """Connect to host honouring any user set configuration in ~/.ssh/config \
         or /etc/ssh/ssh_config
@@ -74,11 +74,11 @@ def __init__(self, host,
         equivalent to `ssh -A` from the `ssh` command line utility. \
         Defaults to True if not set.
         :type forward_ssh_agent: bool
-        :param _agent: (Optional) Override SSH agent object with the provided. \
+        :param agent: (Optional) Override SSH agent object with the provided. \
         This allows for overriding of the default paramiko behaviour of \
-        connecting to local SSH agent to lookup keys with our own SSH agent. \
-        Only really useful for testing, hence the internal variable prefix.
-        :type _agent: :mod:`paramiko.agent.Agent`
+        connecting to local SSH agent to lookup keys with our own SSH agent \
+        object.
+        :type agent: :mod:`paramiko.agent.Agent`
         :param proxy_host: (Optional) SSH host to tunnel connection through \
         so that SSH clients connects to self.host via client -> proxy_host -> host
         :type proxy_host: str
@@ -109,8 +109,8 @@ def __init__(self, host,
         self.pkey = pkey
         self.port = port if port else 22
         self.host = resolved_address
-        if _agent:
-            self.client._agent = _agent
+        if agent:
+            self.client._agent = agent
         self.num_retries = num_retries
         self.timeout = timeout
         self.proxy_host, self.proxy_port = proxy_host, proxy_port

requirements.txt

@@ -1,2 +1,2 @@
 paramiko>=1.9
-gevent>=1.0.1
+gevent>=1.1rc3

setup.py

@@ -14,6 +14,11 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 from setuptools import setup, find_packages
+import sys
+
+convert_2_to_3 = {}
+if sys.version_info >= (3,):
+    convert_2_to_3['use_2to3'] = True
 
 setup(name='parallel-ssh',
       version='0.80.6',
@@ -30,8 +35,12 @@
         'Programming Language :: Python :: 2',
         'Programming Language :: Python :: 2.6',
         'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
         'Topic :: Utilities',
         'Operating System :: POSIX :: Linux',
         'Operating System :: POSIX :: BSD',
         ],
+        **convert_2_to_3
       )

tests/test_pssh_client.py

@@ -24,6 +24,7 @@
      AuthenticationException, ConnectionErrorException, SSHException, logger as pssh_logger
 from embedded_server.embedded_server import start_server, make_socket, \
      logger as server_logger, paramiko_logger
+from embedded_server.fake_agent import FakeAgent
 import random
 import logging
 import gevent
@@ -51,36 +52,39 @@ def setUp(self):
         self.listen_socket = make_socket(self.host)
         self.listen_port = self.listen_socket.getsockname()[1]
         self.server = start_server(self.listen_socket)
-
+        self.agent = FakeAgent()
+        self.agent.add_key(USER_KEY)
+        self.client = ParallelSSHClient([self.host], port=self.listen_port,
+                                        pkey=self.user_key,
+                                        agent=self.agent)
+    
     def tearDown(self):
         del self.server
         del self.listen_socket
+        del self.client
 
     def test_pssh_client_exec_command(self):
-        client = ParallelSSHClient([self.host], port=self.listen_port,
-                                   pkey=self.user_key)
-        cmd = client.exec_command(self.fake_cmd)[0]
-        output = client.get_stdout(cmd)
+        cmd = self.client.exec_command(self.fake_cmd)[0]
+        output = self.client.get_stdout(cmd)
         expected = {self.host : {'exit_code' : 0}}
         self.assertEqual(expected, output,
                          msg="Got unexpected command output - %s" % (output,))
         self.assertTrue(output[self.host]['exit_code'] == 0)
 
     def test_pssh_client_no_stdout_non_zero_exit_code(self):
-        client = ParallelSSHClient([self.host], port=self.listen_port,
-                                   pkey=self.user_key)
-        output = client.run_command('exit 1')
+        output = self.client.run_command('exit 1')
         expected_exit_code = 1
         exit_code = output[self.host]['exit_code']
-        client.pool.join()
+        self.client.pool.join()
         self.assertEqual(expected_exit_code, exit_code,
                          msg="Got unexpected exit code - %s, expected %s" %
                          (exit_code,
                           expected_exit_code,))
 
     def test_pssh_client_exec_command_get_buffers(self):
         client = ParallelSSHClient([self.host], port=self.listen_port,
-                                   pkey=self.user_key)
+                                   pkey=self.user_key,
+                                   agent=self.agent)
         cmd = client.exec_command(self.fake_cmd)[0]
         output = client.get_stdout(cmd, return_buffers=True)
         expected_exit_code = 0
@@ -104,7 +108,8 @@ def test_pssh_client_exec_command_get_buffers(self):
 
     def test_pssh_client_run_command_get_output(self):
         client = ParallelSSHClient([self.host], port=self.listen_port,
-                                   pkey=self.user_key)
+                                   pkey=self.user_key,
+                                   agent=self.agent)
         output = client.run_command(self.fake_cmd)
         expected_exit_code = 0
         expected_stdout = [self.fake_resp]
@@ -170,7 +175,8 @@ def test_pssh_client_auth_failure(self):
         listen_port = listen_socket.getsockname()[1]
         server = start_server(listen_socket, fail_auth=True)
         client = ParallelSSHClient([self.host], port=listen_port,
-                                   pkey=self.user_key)
+                                   pkey=self.user_key,
+                                   agent=self.agent)
         cmd = client.exec_command(self.fake_cmd)[0]
         # Handle exception
         try:
@@ -191,7 +197,7 @@ def test_pssh_client_hosts_list_part_failure(self):
         client = ParallelSSHClient(hosts,
                                    port=self.listen_port,
                                    pkey=self.user_key,
-                                   )
+                                   agent=self.agent)
         output = client.run_command(self.fake_cmd,
                                     stop_on_errors=False)
         self.assertTrue(hosts[0] in output,
@@ -258,7 +264,7 @@ def test_pssh_client_timeout(self):
         server.join()
 
     def test_pssh_client_exec_command_password(self):
-        """Test password authentication. Fake server accepts any password
+        """Test password authentication. Embedded server accepts any password
         even empty string"""
         client = ParallelSSHClient([self.host], port=self.listen_port,
                                    password='')
@@ -501,7 +507,8 @@ def test_authentication_exception(self):
         server = start_server(_socket, fail_auth=True)
         hosts = [self.host]
         client = ParallelSSHClient(hosts, port=port,
-                                   pkey=self.user_key)
+                                   pkey=self.user_key,
+                                   agent=self.agent)
         output = client.run_command(self.fake_cmd, stop_on_errors=False)
         client.pool.join()
         self.assertTrue('exception' in output[self.host],

tests/test_ssh_client.py

@@ -203,7 +203,7 @@ def test_ssh_agent_authentication(self):
         agent = FakeAgent()
         agent.add_key(USER_KEY)
         client = SSHClient(self.host, port=self.listen_port,
-                           _agent=agent)
+                           agent=agent)
         channel, host, stdout, stderr = client.exec_command(self.fake_cmd)
         channel.close()
         output = list(stdout)