Improve the API for connection plugins and update local and ssh to use it

v2/ansible/executor/task_executor.py

@@ -374,8 +374,6 @@ class TaskExecutor:
         if not connection:
             raise AnsibleError("the connection plugin '%s' was not found" % conn_type)
 
-        connection.connect()
-
         return connection
 
     def _get_action_handler(self, connection):

v2/ansible/plugins/action/__init__.py

@@ -168,7 +168,7 @@ class ActionBase:
         if result['rc'] != 0:
             if result['rc'] == 5:
                 output = 'Authentication failure.'
-            elif result['rc'] == 255 and self._connection.get_transport() in ['ssh']:
+            elif result['rc'] == 255 and self._connection.transport in ('ssh',):
                 # FIXME: more utils.VERBOSITY
                 #if utils.VERBOSITY > 3:
                 #    output = 'SSH encountered an unknown error. The output was:\n%s' % (result['stdout']+result['stderr'])

v2/ansible/plugins/connections/__init__.py

 # (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
+# (c) 2015 Toshio Kuratomi <tkuratomi@ansible.com>
 #
 # This file is part of Ansible
 #
@@ -19,6 +20,10 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
+from abc import ABCMeta, abstractmethod, abstractproperty
+
+from six import add_metaclass
+
 from ansible import constants as C
 from ansible.errors import AnsibleError
 
@@ -29,7 +34,7 @@ from ansible.utils.display import Display
 
 __all__ = ['ConnectionBase']
 
-
+@add_metaclass(ABCMeta)
 class ConnectionBase:
     '''
     A base class for connections to contain common code.
@@ -39,9 +44,15 @@ class ConnectionBase:
     become_methods = C.BECOME_METHODS
 
     def __init__(self, connection_info, *args, **kwargs):
-        self._connection_info = connection_info
-        self._display = Display(verbosity=connection_info.verbosity)
+        # All these hasattrs allow subclasses to override these parameters
+        if not hasattr(self, '_connection_info'):
+            self._connection_info = connection_info
+        if not hasattr(self, '_display'):
+            self._display = Display(verbosity=connection_info.verbosity)
+        if not hasattr(self, '_connected'):
+            self._connected = False
 
+        self._connect()
 
     def _become_method_supported(self, become_method):
         ''' Checks if the current class supports this privilege escalation method '''
@@ -50,3 +61,33 @@ class ConnectionBase:
             return True
 
         raise AnsibleError("Internal Error: this connection module does not support running commands via %s" % become_method)
+
+    @abstractproperty
+    def transport(self):
+        """String used to identify this Connection class from other classes"""
+        pass
+
+    @abstractmethod
+    def _connect(self):
+        """Connect to the host we've been initialized with"""
+        pass
+
+    @abstractmethod
+    def exec_command(self, cmd, tmp_path, executable=None, in_data=None):
+        """Run a command on the remote host"""
+        pass
+
+    @abstractmethod
+    def put_file(self, in_path, out_path):
+        """Transfer a file from local to remote"""
+        pass
+
+    @abstractmethod
+    def fetch_file(self, in_path, out_path):
+        """Fetch a file from remote to local"""
+        pass
+
+    @abstractmethod
+    def close(self):
+        """Terminate the connection"""
+        pass

v2/ansible/plugins/connections/local.py

 # (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
+# (c) 2015 Toshio Kuratomi <tkuratomi@ansible.com>
 #
 # This file is part of Ansible
 #
@@ -19,13 +20,12 @@ __metaclass__ = type
 
 import traceback
 import os
-import pipes
 import shutil
 import subprocess
-import select
-import fcntl
+#import select
+#import fcntl
 
-from ansible.errors import AnsibleError
+from ansible.errors import AnsibleError, AnsibleFileNotFound
 from ansible.plugins.connections import ConnectionBase
 
 from ansible.utils.debug import debug
@@ -33,15 +33,17 @@ from ansible.utils.debug import debug
 class Connection(ConnectionBase):
     ''' Local based connections '''
 
-    def get_transport(self):
+    @property
+    def transport(self):
         ''' used to identify this connection object '''
         return 'local'
 
-    def connect(self, port=None):
+    def _connect(self, port=None):
         ''' connect to the local host; nothing to do here '''
 
-        self._display.vvv("ESTABLISH LOCAL CONNECTION FOR USER: %s" % self._connection_info.remote_user, host=self._connection_info.remote_addr)
-
+        if not self._connected:
+            self._display.vvv("ESTABLISH LOCAL CONNECTION FOR USER: {0}".format(self._connection_info.remote_user, host=self._connection_info.remote_addr))
+            self._connected = True
         return self
 
     def exec_command(self, cmd, tmp_path, executable='/bin/sh', in_data=None):
@@ -57,7 +59,7 @@ class Connection(ConnectionBase):
 
         executable = executable.split()[0] if executable else None
 
-        self._display.vvv("%s EXEC %s" % (self._connection_info.remote_addr, cmd))
+        self._display.vvv("{0} EXEC {1}".format(self._connection_info.remote_addr, cmd))
         # FIXME: cwd= needs to be set to the basedir of the playbook
         debug("opening command with Popen()")
         p = subprocess.Popen(
@@ -106,26 +108,25 @@ class Connection(ConnectionBase):
     def put_file(self, in_path, out_path):
         ''' transfer a file from local to local '''
 
-        #vvv("PUT %s TO %s" % (in_path, out_path), host=self.host)
-        self._display.vvv("%s PUT %s TO %s" % (self._connection_info.remote_addr, in_path, out_path))
+        #vvv("PUT {0} TO {1}".format(in_path, out_path), host=self.host)
+        self._display.vvv("{0} PUT {1} TO {2}".format(self._connection_info.remote_addr, in_path, out_path))
         if not os.path.exists(in_path):
-            #raise AnsibleFileNotFound("file or module does not exist: %s" % in_path)
-            raise AnsibleError("file or module does not exist: %s" % in_path)
+            raise AnsibleFileNotFound("file or module does not exist: {0}".format(in_path))
         try:
             shutil.copyfile(in_path, out_path)
         except shutil.Error:
             traceback.print_exc()
-            raise AnsibleError("failed to copy: %s and %s are the same" % (in_path, out_path))
+            raise AnsibleError("failed to copy: {0} and {1} are the same".format(in_path, out_path))
         except IOError:
             traceback.print_exc()
-            raise AnsibleError("failed to transfer file to %s" % out_path)
+            raise AnsibleError("failed to transfer file to {0}".format(out_path))
 
     def fetch_file(self, in_path, out_path):
-        #vvv("FETCH %s TO %s" % (in_path, out_path), host=self.host)
-        self._display.vvv("%s FETCH %s TO %s" % (self._connection_info.remote_addr, in_path, out_path))
         ''' fetch a file from local to local -- for copatibility '''
+        #vvv("FETCH {0} TO {1}".format(in_path, out_path), host=self.host)
+        self._display.vvv("{0} FETCH {1} TO {2}".format(self._connection_info.remote_addr, in_path, out_path))
         self.put_file(in_path, out_path)
 
     def close(self):
         ''' terminate the connection; nothing to do here '''
-        pass
+        self._connected = False