Pass connection info via ansible config file

Pass the name of the remote user and the path to the private key to
ansible via the generated configuration file. This allows to re-use the
same connection info for nested ansible calls.

The other options, which affect how ansible runs the playbooks, should
remain on the command line.

Change-Id: Ic3be4f7e9fb52ac95b20ebbbc2f2d538a1fc80e6

tripleo_common/actions/ansible.py

@@ -30,6 +30,8 @@ from tripleo_common.inventory import TripleoInventory
 
 
 def write_default_ansible_cfg(work_dir,
+                              remote_user,
+                              ssh_private_key,
                               base_ansible_cfg='/etc/ansible/ansible.cfg'):
     ansible_config_path = os.path.join(work_dir, 'ansible.cfg')
     shutil.copy(base_ansible_cfg, ansible_config_path)
@@ -45,6 +47,13 @@ def write_default_ansible_cfg(work_dir,
     config.set('ssh_connection', 'ssh_args',
                '-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no')
 
+    # Set connection info in config file so that subsequent/nested ansible
+    # calls can re-use it
+    if remote_user:
+        config.set('defaults', 'remote_user', remote_user)
+    if ssh_private_key:
+        config.set('defaults', 'private_key_file', ssh_private_key)
+
     with open(ansible_config_path, 'w') as configfile:
         config.write(configfile)
 
@@ -162,9 +171,6 @@ class AnsibleAction(actions.Action):
         if self.limit_hosts:
             command.extend(['--limit', self.limit_hosts])
 
-        if self.remote_user:
-            command.extend(['--user', self.remote_user])
-
         if self.become:
             command.extend(['--become'])
 
@@ -189,9 +195,6 @@ class AnsibleAction(actions.Action):
         if self.inventory:
             command.extend(['--inventory-file', self.inventory])
 
-        if self.ssh_private_key:
-            command.extend(['--private-key', self.ssh_private_key])
-
         if self.extra_env_variables:
             if not isinstance(self.extra_env_variables, dict):
                 msg = "extra_env_variables must be a dict"
@@ -201,7 +204,10 @@ class AnsibleAction(actions.Action):
             command.extend(['--gather-facts', self.gather_facts])
 
         try:
-            ansible_config_path = write_default_ansible_cfg(self.work_dir)
+            ansible_config_path = write_default_ansible_cfg(
+                self.work_dir,
+                self.remote_user,
+                self.ssh_private_key)
             env_variables = {
                 'HOME': self.work_dir,
                 'ANSIBLE_CONFIG': ansible_config_path
@@ -394,9 +400,6 @@ class AnsiblePlaybookAction(base.TripleOAction):
         if self.module_path:
             command.extend(['--module-path', self.module_path])
 
-        if self.remote_user:
-            command.extend(['--user', self.remote_user])
-
         if self.become:
             command.extend(['--become'])
 
@@ -424,9 +427,6 @@ class AnsiblePlaybookAction(base.TripleOAction):
         if self.inventory:
             command.extend(['--inventory-file', self.inventory])
 
-        if self.ssh_private_key:
-            command.extend(['--private-key', self.ssh_private_key])
-
         if self.tags:
             command.extend(['--tags', self.tags])
 
@@ -442,7 +442,10 @@ class AnsiblePlaybookAction(base.TripleOAction):
             command.extend(['--gather-facts', self.gather_facts])
 
         try:
-            ansible_config_path = write_default_ansible_cfg(self.work_dir)
+            ansible_config_path = write_default_ansible_cfg(
+                self.work_dir,
+                self.remote_user,
+                self.ssh_private_key)
             env_variables = {
                 'HOME': self.work_dir,
                 'ANSIBLE_CONFIG': ansible_config_path

tripleo_common/tests/actions/test_ansible.py

@@ -58,12 +58,13 @@ class AnsibleActionTest(base.TestCase):
             'ANSIBLE_CONFIG': ansible_config_path
         }
 
+        mock_write_cfg.assert_called_once_with(action.work_dir,
+                                               self.remote_user, None)
+
         mock_execute.assert_called_once_with(
-            'ansible', self.hosts, '-vvvvv', '--module-name',
-            self.module, '--user', self.remote_user, '--become',
-            '--become-user', self.become_user,
-            env_variables=env, cwd=action.work_dir,
-            log_errors=processutils.LogErrors.ALL
+            'ansible', self.hosts, '-vvvvv', '--module-name', self.module,
+            '--become', '--become-user', self.become_user, env_variables=env,
+            cwd=action.work_dir, log_errors=processutils.LogErrors.ALL
         )
 
 
@@ -98,6 +99,9 @@ class AnsiblePlaybookActionTest(base.TestCase):
 
         action.run(self.ctx)
 
+        mock_write_cfg.assert_called_once_with(action.work_dir,
+                                               self.remote_user, None)
+
         pb = os.path.join(action.work_dir, 'playbook.yaml')
         env = {
             'HOME': action.work_dir,
@@ -105,9 +109,8 @@ class AnsiblePlaybookActionTest(base.TestCase):
         }
 
         mock_execute.assert_called_once_with(
-            'ansible-playbook', '-v', pb, '--user',
-            self.remote_user, '--become', '--become-user', self.become_user,
-            '--extra-vars', json.dumps(self.extra_vars),
+            'ansible-playbook', '-v', pb, '--become', '--become-user',
+            self.become_user, '--extra-vars', json.dumps(self.extra_vars),
             env_variables=env, cwd=action.work_dir,
             log_errors=processutils.LogErrors.ALL)
 
@@ -180,7 +183,7 @@ class CopyConfigFileTest(base.TestCase):
             ansible_cfg_file.flush()
 
             resulting_ansible_config = ansible.write_default_ansible_cfg(
-                work_dir, base_ansible_cfg=ansible_cfg_path)
+                work_dir, None, None, base_ansible_cfg=ansible_cfg_path)
 
             self.assertEqual(resulting_ansible_config,
                              os.path.join(work_dir, 'ansible.cfg'))