Added support for using '~' for SSH key location.

[snaps.git] / snaps / provisioning / ansible_utils.py

diff --git a/snaps/provisioning/ansible_utils.py b/snaps/provisioning/ansible_utils.py
index 31750ee..b776ba0 100644 (file)
--- a/snaps/provisioning/ansible_utils.py
+++ b/snaps/provisioning/ansible_utils.py
@@ -32,21 +32,28 @@ __author__ = 'spisarski'
 logger = logging.getLogger('ansible_utils')
 
 
-def apply_playbook(playbook_path, hosts_inv, host_user, ssh_priv_key_file_path, variables=None, proxy_setting=None):
+def apply_playbook(playbook_path, hosts_inv, host_user, ssh_priv_key_file_path,
+                   variables=None, proxy_setting=None):
     """
     Executes an Ansible playbook to the given host
     :param playbook_path: the (relative) path to the Ansible playbook
-    :param hosts_inv: a list of hostnames/ip addresses to which to apply the Ansible playbook
-    :param host_user: A user for the host instances (must be a password-less sudo user if playbook has "sudo: yes"
+    :param hosts_inv: a list of hostnames/ip addresses to which to apply the
+                      Ansible playbook
+    :param host_user: A user for the host instances (must be a password-less
+                      sudo user if playbook has "sudo: yes"
     :param ssh_priv_key_file_path: the file location of the ssh key
-    :param variables: a dictionary containing any substitution variables needed by the Jinga 2 templates
+    :param variables: a dictionary containing any substitution variables needed
+                      by the Jinga 2 templates
     :param proxy_setting: instance of os_credentials.ProxySettings class
     :return: the results
     """
     if not os.path.isfile(playbook_path):
         raise Exception('Requested playbook not found - ' + playbook_path)
-    if not os.path.isfile(ssh_priv_key_file_path):
-        raise Exception('Requested private SSH key not found - ' + ssh_priv_key_file_path)
+
+    pk_file_path = os.path.expanduser(ssh_priv_key_file_path)
+    if not os.path.isfile(pk_file_path):
+        raise Exception('Requested private SSH key not found - ' +
+                        pk_file_path)
 
     import ansible.constants
     ansible.constants.HOST_KEY_CHECKING = False
@@ -56,23 +63,30 @@ def apply_playbook(playbook_path, hosts_inv, host_user, ssh_priv_key_file_path,
         variable_manager.extra_vars = variables
 
     loader = DataLoader()
-    inventory = Inventory(loader=loader, variable_manager=variable_manager, host_list=hosts_inv)
+    inventory = Inventory(loader=loader, variable_manager=variable_manager,
+                          host_list=hosts_inv)
     variable_manager.set_inventory(inventory)
 
     ssh_extra_args = None
     if proxy_setting and proxy_setting.ssh_proxy_cmd:
-        ssh_extra_args = '-o ProxyCommand=\'' + proxy_setting.ssh_proxy_cmd + '\''
-
-    options = namedtuple('Options', ['listtags', 'listtasks', 'listhosts', 'syntax', 'connection', 'module_path',
-                                     'forks', 'remote_user', 'private_key_file', 'ssh_common_args', 'ssh_extra_args',
-                                     'become', 'become_method', 'become_user', 'verbosity', 'check'])
-
-    ansible_opts = options(listtags=False, listtasks=False, listhosts=False, syntax=False, connection='ssh',
-                           module_path=None, forks=100, remote_user=host_user, private_key_file=ssh_priv_key_file_path,
-                           ssh_common_args=None, ssh_extra_args=ssh_extra_args, become=None, become_method=None,
-                           become_user=None, verbosity=11111, check=False)
-
-    logger.debug('Setting up Ansible Playbook Executor for playbook - ' + playbook_path)
+        ssh_extra_args = '-o ProxyCommand=\'%s\'' % proxy_setting.ssh_proxy_cmd
+
+    options = namedtuple(
+        'Options', ['listtags', 'listtasks', 'listhosts', 'syntax',
+                    'connection', 'module_path', 'forks', 'remote_user',
+                    'private_key_file', 'ssh_common_args', 'ssh_extra_args',
+                    'become', 'become_method', 'become_user', 'verbosity',
+                    'check'])
+
+    ansible_opts = options(
+        listtags=False, listtasks=False, listhosts=False, syntax=False,
+        connection='ssh', module_path=None, forks=100, remote_user=host_user,
+        private_key_file=pk_file_path, ssh_common_args=None,
+        ssh_extra_args=ssh_extra_args, become=None, become_method=None,
+        become_user=None, verbosity=11111, check=False)
+
+    logger.debug('Setting up Ansible Playbook Executor for playbook - ' +
+                 playbook_path)
     executor = PlaybookExecutor(
         playbooks=[playbook_path],
         inventory=inventory,
@@ -91,7 +105,8 @@ def ssh_client(ip, user, private_key_filepath, proxy_settings=None):
     :param ip: the IP of the host to connect
     :param user: the user with which to connect
     :param private_key_filepath: the path to the private key file
-    :param proxy_settings: instance of os_credentials.ProxySettings class (optional)
+    :param proxy_settings: instance of os_credentials.ProxySettings class
+                           (optional)
     :return: the SSH client if can connect else false
     """
     logger.debug('Retrieving SSH client')
@@ -105,7 +120,9 @@ def ssh_client(ip, user, private_key_filepath, proxy_settings=None):
             proxy_cmd_str = proxy_cmd_str.replace("%p", '22')
             proxy_cmd = paramiko.ProxyCommand(proxy_cmd_str)
 
-        ssh.connect(ip, username=user, key_filename=private_key_filepath, sock=proxy_cmd)
+        pk_abs_path = os.path.expanduser(private_key_filepath)
+        ssh.connect(ip, username=user, key_filename=pk_abs_path,
+                    sock=proxy_cmd)
         return ssh
     except Exception as e:
         logger.warning('Unable to connect via SSH with message - ' + str(e))