mirror of
https://github.com/ansible/awx.git
synced 2026-01-22 23:18:03 -03:30
cba55a061a
- Add variables field on Host/Group models and remove separate VariableData model. - Add data migrations for existing variable data. - Update views, serializers and tests to keep roughly the same API interface for variable data. - Add has_active_failures properties on Group/Host models to provide indication of last job status. - Add job_tags field on JobTemplate/Job models to specify tags to ansible-playbook. - Add host_config_key field to JobTemplate model for use by empheral hosts. - Add job_args, job_cwd and job_env fields to Job model to capture more info from running the job. - Add failed flag on JobHostSummary model. - Add play/task fields on JobEvent model to capture new context variables from callback. - Add parent field on JobEvent model to capture hierarchy of job events. - Add hosts field on JobEvent model to capture all hosts associated with the event (especially useful for parent events in the hierarchy). - Removed existing Tag model, replace with django-taggit instead. - Removed existing AuditLog model, replacement TBD.
211 lines
7.7 KiB
Python
211 lines
7.7 KiB
Python
# Copyright (c) 2013 AnsibleWorks, Inc.
|
|
# All Rights Reserved.
|
|
|
|
import cStringIO
|
|
import logging
|
|
import os
|
|
import select
|
|
import subprocess
|
|
import tempfile
|
|
import time
|
|
import traceback
|
|
from celery import Task
|
|
from django.conf import settings
|
|
import pexpect
|
|
from ansibleworks.main.models import *
|
|
|
|
__all__ = ['RunJob']
|
|
|
|
logger = logging.getLogger('ansibleworks.main.tasks')
|
|
|
|
class RunJob(Task):
|
|
'''
|
|
Celery task to run a job using ansible-playbook.
|
|
'''
|
|
|
|
name = 'run_job'
|
|
|
|
def update_job(self, job_pk, **job_updates):
|
|
'''
|
|
Reload Job from database and update the given fields.
|
|
'''
|
|
job = Job.objects.get(pk=job_pk)
|
|
if job_updates:
|
|
update_fields = []
|
|
for field, value in job_updates.items():
|
|
setattr(job, field, value)
|
|
update_fields.append(field)
|
|
if field == 'status':
|
|
update_fields.append('failed')
|
|
job.save(update_fields=update_fields)
|
|
return job
|
|
|
|
def get_path_to(self, *args):
|
|
'''
|
|
Return absolute path relative to this file.
|
|
'''
|
|
return os.path.abspath(os.path.join(os.path.dirname(__file__), *args))
|
|
|
|
def build_ssh_key_path(self, job, **kwargs):
|
|
'''
|
|
Create a temporary file containing the SSH private key.
|
|
'''
|
|
creds = job.credential
|
|
if creds and creds.ssh_key_data:
|
|
# FIXME: File permissions?
|
|
handle, path = tempfile.mkstemp()
|
|
f = os.fdopen(handle, 'w')
|
|
f.write(creds.ssh_key_data)
|
|
f.close()
|
|
return path
|
|
else:
|
|
return ''
|
|
|
|
def build_passwords(self, job, **kwargs):
|
|
'''
|
|
Build a dictionary of passwords for SSH private key, SSH user and sudo.
|
|
'''
|
|
passwords = {}
|
|
creds = job.credential
|
|
if creds:
|
|
for field in ('ssh_key_unlock', 'ssh_password', 'sudo_password'):
|
|
value = kwargs.get(field, getattr(creds, field))
|
|
if value not in ('', 'ASK'):
|
|
passwords[field] = value
|
|
return passwords
|
|
|
|
def build_env(self, job, **kwargs):
|
|
'''
|
|
Build environment dictionary for ansible-playbook.
|
|
'''
|
|
plugin_dir = self.get_path_to('..', 'plugins', 'callback')
|
|
callback_script = self.get_path_to('management', 'commands',
|
|
'acom_callback_event.py')
|
|
env = dict(os.environ.items())
|
|
# question: when running over CLI, generate a random ID or grab next, etc?
|
|
# answer: TBD
|
|
env['ACOM_JOB_ID'] = str(job.pk)
|
|
env['ACOM_INVENTORY_ID'] = str(job.inventory.pk)
|
|
env['ANSIBLE_CALLBACK_PLUGINS'] = plugin_dir
|
|
env['ACOM_CALLBACK_EVENT_SCRIPT'] = callback_script
|
|
if hasattr(settings, 'ANSIBLE_TRANSPORT'):
|
|
env['ANSIBLE_TRANSPORT'] = getattr(settings, 'ANSIBLE_TRANSPORT')
|
|
env['ANSIBLE_NOCOLOR'] = '1' # Prevent output of escape sequences.
|
|
return env
|
|
|
|
def build_args(self, job, **kwargs):
|
|
'''
|
|
Build command line argument list for running ansible-playbook,
|
|
optionally using ssh-agent for public/private key authentication.
|
|
'''
|
|
creds = job.credential
|
|
ssh_username, sudo_username = '', ''
|
|
if creds:
|
|
ssh_username = kwargs.get('ssh_username', creds.ssh_username)
|
|
sudo_username = kwargs.get('sudo_username', creds.sudo_username)
|
|
ssh_username = ssh_username or 'root'
|
|
sudo_username = sudo_username or 'root'
|
|
inventory_script = self.get_path_to('management', 'commands',
|
|
'acom_inventory.py')
|
|
args = ['ansible-playbook', '-i', inventory_script]
|
|
if job.job_type == 'check':
|
|
args.append('--check')
|
|
args.extend(['-u', ssh_username])
|
|
if 'ssh_password' in kwargs.get('passwords', {}):
|
|
args.append('--ask-pass')
|
|
args.extend(['-U', sudo_username])
|
|
if 'sudo_password' in kwargs.get('passwords', {}):
|
|
args.append('--ask-sudo-pass')
|
|
if job.forks: # FIXME: Max limit?
|
|
args.append('--forks=%d' % job.forks)
|
|
if job.limit:
|
|
args.extend(['-l', job.limit])
|
|
if job.verbosity:
|
|
args.append('-%s' % ('v' * min(3, job.verbosity)))
|
|
if job.extra_vars:
|
|
args.extend(['-e', job.extra_vars])
|
|
if job.job_tags:
|
|
args.extend(['-t', job.job_tags])
|
|
args.append(job.playbook) # relative path to project.local_path
|
|
ssh_key_path = kwargs.get('ssh_key_path', '')
|
|
if ssh_key_path:
|
|
cmd = ' '.join([subprocess.list2cmdline(['ssh-add', ssh_key_path]),
|
|
'&&', subprocess.list2cmdline(args)])
|
|
args = ['ssh-agent', 'sh', '-c', cmd]
|
|
return args
|
|
|
|
def run_pexpect(self, job_pk, args, cwd, env, passwords):
|
|
'''
|
|
Run the job using pexpect to capture output and provide passwords when
|
|
requested.
|
|
'''
|
|
status, stdout = 'error', ''
|
|
logfile = cStringIO.StringIO()
|
|
logfile_pos = logfile.tell()
|
|
child = pexpect.spawn(args[0], args[1:], cwd=cwd, env=env)
|
|
child.logfile_read = logfile
|
|
job_canceled = False
|
|
while child.isalive():
|
|
expect_list = [
|
|
r'Enter passphrase for .*:',
|
|
r'Bad passphrase, try again for .*:',
|
|
r'sudo password.*:',
|
|
r'SSH password:',
|
|
pexpect.TIMEOUT,
|
|
pexpect.EOF,
|
|
]
|
|
result_id = child.expect(expect_list, timeout=2)
|
|
if result_id == 0:
|
|
child.sendline(passwords.get('ssh_key_unlock', ''))
|
|
elif result_id == 1:
|
|
child.sendline('')
|
|
elif result_id == 2:
|
|
child.sendline(passwords.get('sudo_password', ''))
|
|
elif result_id == 3:
|
|
child.sendline(passwords.get('ssh_password', ''))
|
|
job_updates = {}
|
|
if logfile_pos != logfile.tell():
|
|
job_updates['result_stdout'] = logfile.getvalue()
|
|
job = self.update_job(job_pk, **job_updates)
|
|
if job.cancel_flag:
|
|
child.close(True)
|
|
job_canceled = True
|
|
if job_canceled:
|
|
status = 'canceled'
|
|
elif child.exitstatus == 0:
|
|
status = 'successful'
|
|
else:
|
|
status = 'failed'
|
|
stdout = logfile.getvalue()
|
|
return status, stdout
|
|
|
|
def run(self, job_pk, **kwargs):
|
|
'''
|
|
Run the job using ansible-playbook and capture its output.
|
|
'''
|
|
job = self.update_job(job_pk, status='running')
|
|
status, stdout, tb = 'error', '', ''
|
|
try:
|
|
kwargs['ssh_key_path'] = self.build_ssh_key_path(job, **kwargs)
|
|
kwargs['passwords'] = self.build_passwords(job, **kwargs)
|
|
args = self.build_args(job, **kwargs)
|
|
cwd = job.project.get_project_path()
|
|
if not cwd:
|
|
raise RuntimeError('project local_path %s cannot be found' %
|
|
project.local_path)
|
|
env = self.build_env(job, **kwargs)
|
|
job = self.update_job(job_pk, job_args=args, job_cwd=cwd,
|
|
job_env=env)
|
|
status, stdout = self.run_pexpect(job_pk, args, cwd, env,
|
|
kwargs['passwords'])
|
|
except Exception:
|
|
tb = traceback.format_exc()
|
|
finally:
|
|
if kwargs.get('ssh_key_path', ''):
|
|
try:
|
|
os.remove(kwargs['ssh_key_path'])
|
|
except IOError:
|
|
pass
|
|
self.update_job(job_pk, status=status, result_stdout=stdout,
|
|
result_traceback=tb)
|