Merge pull request #1020 from cchurch/ad-hoc-check-mode-fixes

Fix error with ad hoc command events when running in check mode.

awx/main/migrations/0001_initial.py

@@ -43,7 +43,7 @@ class Migration(migrations.Migration):
                 ('created', models.DateTimeField(default=None, editable=False)),
                 ('modified', models.DateTimeField(default=None, editable=False)),
                 ('host_name', models.CharField(default=b'', max_length=1024, editable=False)),
-                ('event', models.CharField(max_length=100, choices=[(b'runner_on_failed', 'Host Failed'), (b'runner_on_ok', 'Host OK'), (b'runner_on_unreachable', 'Host Unreachable')])),
+                ('event', models.CharField(max_length=100, choices=[(b'runner_on_failed', 'Host Failed'), (b'runner_on_ok', 'Host OK'), (b'runner_on_unreachable', 'Host Unreachable'), (b'runner_on_skipped', 'Host Skipped')])),
                 ('event_data', jsonfield.fields.JSONField(default={}, blank=True)),
                 ('failed', models.BooleanField(default=False, editable=False)),
                 ('changed', models.BooleanField(default=False, editable=False)),

awx/main/models/ad_hoc_commands.py

@@ -221,8 +221,9 @@ class AdHocCommandEvent(CreatedModifiedModel):
         ('runner_on_unreachable', _('Host Unreachable'), True),
         # Tower won't see no_hosts (check is done earlier without callback).
         #('runner_on_no_hosts', _('No Hosts Matched'), False),
-        # Tower should probably never see skipped (no conditionals).
-        #('runner_on_skipped', _('Host Skipped'), False),
+        # Tower will see skipped (when running in check mode for a module that
+        # does not support check mode).
+        ('runner_on_skipped', _('Host Skipped'), False),
         # Tower does not support async for ad hoc commands.
         #('runner_on_async_poll', _('Host Polling'), False),
         #('runner_on_async_ok', _('Host Async OK'), False),

awx/main/tests/old/ad_hoc.py

@@ -128,8 +128,8 @@ class RunAdHocCommandTest(BaseAdHocCommandTest):
         self.assertFalse(ad_hoc_command.passwords_needed_to_start)
         self.assertTrue(ad_hoc_command.signal_start())
         ad_hoc_command = AdHocCommand.objects.get(pk=ad_hoc_command.pk)
-        self.check_job_result(ad_hoc_command, 'failed')
-        self.check_ad_hoc_command_events(ad_hoc_command, 'unreachable')
+        self.check_job_result(ad_hoc_command, 'successful')
+        self.check_ad_hoc_command_events(ad_hoc_command, 'skipped')
 
     @mock.patch('awx.main.tasks.BaseTask.run_pexpect', return_value=('canceled', 0))
     def test_cancel_ad_hoc_command(self, ignore):

awx/plugins/callback/job_event_callback.py

@@ -2,10 +2,10 @@
 # This file is a utility Ansible plugin that is not part of the AWX or Ansible
 # packages.  It does not import any code from either package, nor does its
 # license apply to Ansible or AWX.
-# 
+#
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
-# 
+#
 # Redistributions of source code must retain the above copyright notice, this
 # list of conditions and the following disclaimer.
 #
@@ -90,8 +90,12 @@ CENSOR_FIELD_WHITELIST=[
     'skip_reason',
 ]
 
-def censor(obj):
-    if obj.get('_ansible_no_log', False):
+def censor(obj, no_log=False):
+    if not isinstance(obj, dict):
+        if no_log:
+            return "the output has been hidden due to the fact that 'no_log: true' was specified for this result"
+        return obj
+    if obj.get('_ansible_no_log', no_log):
         new_obj = {}
         for k in CENSOR_FIELD_WHITELIST:
             if k in obj:
@@ -104,8 +108,12 @@ def censor(obj):
         new_obj['censored'] = "the output has been hidden due to the fact that 'no_log: true' was specified for this result"
         obj = new_obj
     if 'results' in obj:
-        for i in xrange(len(obj['results'])):
-            obj['results'][i] = censor(obj['results'][i])
+        if isinstance(obj['results'], list):
+            for i in xrange(len(obj['results'])):
+                obj['results'][i] = censor(obj['results'][i], obj.get('_ansible_no_log', no_log))
+        elif obj.get('_ansible_no_log', False):
+            obj['results'] = "the output has been hidden due to the fact that 'no_log: true' was specified for this result"
+
     return obj
 
 class TokenAuth(requests.auth.AuthBase):
@@ -460,7 +468,7 @@ class JobCallbackModule(BaseCallbackModule):
         # this from a normal task
         self._log_event('playbook_on_task_start', task=task,
                         name=task.get_name())
-                        
+
     def playbook_on_vars_prompt(self, varname, private=True, prompt=None,
                                 encrypt=None, confirm=False, salt_size=None,
                                 salt=None, default=None):
@@ -529,6 +537,7 @@ class AdHocCommandCallbackModule(BaseCallbackModule):
     def __init__(self):
         self.ad_hoc_command_id = int(os.getenv('AD_HOC_COMMAND_ID', '0'))
         self.rest_api_path = '/api/v1/ad_hoc_commands/%d/events/' % self.ad_hoc_command_id
+        self.skipped_hosts = set()
         super(AdHocCommandCallbackModule, self).__init__()
 
     def _log_event(self, event, **event_data):
@@ -539,6 +548,18 @@ class AdHocCommandCallbackModule(BaseCallbackModule):
     def runner_on_file_diff(self, host, diff):
         pass # Ignore file diff for ad hoc commands.
 
+    def runner_on_ok(self, host, res):
+        # When running in check mode using a module that does not support check
+        # mode, Ansible v1.9 will call runner_on_skipped followed by
+        # runner_on_ok for the same host; only capture the skipped event and
+        # ignore the ok event.
+        if host not in self.skipped_hosts:
+            super(AdHocCommandCallbackModule, self).runner_on_ok(host, res)
+
+    def runner_on_skipped(self, host, item=None):
+        super(AdHocCommandCallbackModule, self).runner_on_skipped(host, item)
+        self.skipped_hosts.add(host)
+
 
 if os.getenv('JOB_ID', ''):
     CallbackModule = JobCallbackModule