AC-632 Fix escaping for ansible-playbook command line when also using ssh-agent.

This commit is contained in:
Chris Church
2013-11-16 16:15:35 -05:00
parent 17899eed3a
commit 40b0608586
2 changed files with 26 additions and 10 deletions

View File

@@ -9,6 +9,7 @@ import distutils.version
import json import json
import logging import logging
import os import os
import pipes
import re import re
import subprocess import subprocess
import stat import stat
@@ -128,6 +129,9 @@ class BaseTask(Task):
env[k] = '*'*len(str(v)) env[k] = '*'*len(str(v))
return env return env
def args2cmdline(self, *args):
return ' '.join([pipes.quote(a) for a in args])
def build_args(self, instance, **kwargs): def build_args(self, instance, **kwargs):
raise NotImplementedError raise NotImplementedError
@@ -378,8 +382,8 @@ class RunJob(BaseTask):
args.append(job.playbook) # relative path to project.local_path args.append(job.playbook) # relative path to project.local_path
ssh_key_path = kwargs.get('private_data_file', '') ssh_key_path = kwargs.get('private_data_file', '')
if ssh_key_path: if ssh_key_path:
cmd = ' '.join([subprocess.list2cmdline(['ssh-add', ssh_key_path]), cmd = ' '.join([self.args2cmdline('ssh-add', ssh_key_path),
'&&', subprocess.list2cmdline(args)]) '&&', self.args2cmdline(*args)])
args = ['ssh-agent', 'sh', '-c', cmd] args = ['ssh-agent', 'sh', '-c', cmd]
return args return args
@@ -612,7 +616,7 @@ class RunProjectUpdate(BaseTask):
ssh_key_path = kwargs.get('private_data_file', '') ssh_key_path = kwargs.get('private_data_file', '')
if ssh_key_path: if ssh_key_path:
subcmds = [('ssh-add', ssh_key_path), args] subcmds = [('ssh-add', ssh_key_path), args]
cmd = ' && '.join([subprocess.list2cmdline(x) for x in subcmds]) cmd = ' && '.join([self.args2cmdline(*x) for x in subcmds])
args = ['ssh-agent', 'sh', '-c', cmd] args = ['ssh-agent', 'sh', '-c', cmd]
return args return args

View File

@@ -160,14 +160,13 @@ class RunJobTest(BaseCeleryTest):
self.test_project_path = None self.test_project_path = None
self.setup_users() self.setup_users()
self.organization = self.make_organizations(self.super_django_user, 1)[0] self.organization = self.make_organizations(self.super_django_user, 1)[0]
self.inventory = Inventory.objects.create(name='test-inventory', self.inventory = self.organization.inventories.create(name='test-inventory',
description='description for test-inventory', description='description for test-inventory')
organization=self.organization) self.host = self.inventory.hosts.create(name='host.example.com')
self.host = self.inventory.hosts.create(name='host.example.com', self.group = self.inventory.groups.create(name='test-group')
inventory=self.inventory) self.group2 = self.inventory.groups.create(name='test-group2')
self.group = self.inventory.groups.create(name='test-group',
inventory=self.inventory)
self.group.hosts.add(self.host) self.group.hosts.add(self.host)
self.group2.hosts.add(self.host)
self.project = None self.project = None
self.credential = None self.credential = None
# Monkeypatch RunJob to capture list of command line arguments. # Monkeypatch RunJob to capture list of command line arguments.
@@ -703,6 +702,19 @@ class RunJobTest(BaseCeleryTest):
self.check_job_result(job, 'failed') self.check_job_result(job, 'failed')
self.assertTrue('-l' in self.run_job_args) self.assertTrue('-l' in self.run_job_args)
def test_limit_option_with_group_pattern_and_ssh_agent(self):
self.create_test_credential(ssh_key_data=TEST_SSH_KEY_DATA)
self.create_test_project(TEST_PLAYBOOK)
job_template = self.create_test_job_template(limit='test-group:&test-group2')
job = self.create_test_job(job_template=job_template)
self.assertEqual(job.status, 'new')
self.assertFalse(job.passwords_needed_to_start)
self.assertTrue(job.start())
self.assertEqual(job.status, 'pending')
job = Job.objects.get(pk=job.pk)
self.check_job_result(job, 'successful')
self.assertTrue('ssh-agent' in self.run_job_args)
def test_ssh_username_and_password(self): def test_ssh_username_and_password(self):
self.create_test_credential(username='sshuser', password='sshpass') self.create_test_credential(username='sshuser', password='sshpass')
self.create_test_project(TEST_PLAYBOOK) self.create_test_project(TEST_PLAYBOOK)