recordsansible
/
ara
Code Issues Proposed changes

Merge "callback: improve consistency of stored task results"

This commit is contained in:
Zuul 2020-02-23 17:36:51 +00:00 committed by Gerrit Code Review
parent 3b9d9c8ce1 dce9f3a517
commit d9df520e02
1 changed files with 20 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
ara/plugins/callback/ara_default.py
View File

@ -24,7 +24,9 @@ import os
import six import six
from ansible import __version__ as ansible_version from ansible import __version__ as ansible_version
from ansible.parsing.ajson import AnsibleJSONEncoder
from ansible.plugins.callback import CallbackBase from ansible.plugins.callback import CallbackBase
from ansible.vars.clean import module_response_deepcopy, strip_internal_keys
from ara.clients import utils as client_utils from ara.clients import utils as client_utils
@ -166,7 +168,6 @@ class CallbackModule(CallbackBase):
self.play = None self.play = None
self.playbook = None self.playbook = None
self.stats = None self.stats = None
self.loop_items = []
self.file_cache = {} self.file_cache = {}
self.host_cache = {} self.host_cache = {}
@ -315,7 +316,6 @@ class CallbackModule(CallbackBase):
"/api/v1/tasks/%s" % self.task["id"], status="completed", ended=datetime.datetime.now().isoformat() "/api/v1/tasks/%s" % self.task["id"], status="completed", ended=datetime.datetime.now().isoformat()
) )
self.task = None self.task = None
self.loop_items = []
def _end_play(self): def _end_play(self):
if self.play is not None: if self.play is not None:
@ -384,20 +384,24 @@ class CallbackModule(CallbackBase):
# Retrieve the host so we can associate the result to the host id # Retrieve the host so we can associate the result to the host id
host = self._get_or_create_host(result._host.get_name()) host = self._get_or_create_host(result._host.get_name())
# Use Ansible's CallbackBase._dump_results in order to strip internal results = strip_internal_keys(module_response_deepcopy(result._result))
# keys, respect no_log directive, etc.
if self.loop_items: # Round-trip through JSON to sort keys and convert Ansible types
# NOTE (dmsimard): There is a known issue in which Ansible can send # to standard types
# callback hooks out of order and "exit" the task before all items try:
# have returned, this can cause one of the items to be missing jsonified = json.dumps(results, cls=AnsibleJSONEncoder, ensure_ascii=False, sort_keys=True)
# from the task result in ARA. except TypeError:
# https://github.com/ansible/ansible/issues/24207 # Python 3 can't sort non-homogenous keys.
results = [self._dump_results(result._result)] # https://bugs.python.org/issue25457
for item in self.loop_items: jsonified = json.dumps(results, cls=AnsibleJSONEncoder, ensure_ascii=False, sort_keys=False)
results.append(self._dump_results(item._result)) results = json.loads(jsonified)
results = json.loads(json.dumps(results))
else: # Sanitize facts
results = json.loads(self._dump_results(result._result)) if "ansible_facts" in results:
for fact in self.ignored_facts:
if fact in results["ansible_facts"]:
self.log.debug("Ignoring fact: %s" % fact)
results["ansible_facts"][fact] = "Not saved by ARA as configured by 'ignored_facts'"
self.result = self.client.post( self.result = self.client.post(
"/api/v1/results", "/api/v1/results",
@ -415,13 +419,6 @@ class CallbackModule(CallbackBase):
) )
if self.task["action"] in ["setup", "gather_facts"] and "ansible_facts" in results: if self.task["action"] in ["setup", "gather_facts"] and "ansible_facts" in results:
# Potentially sanitize some Ansible facts to prevent them from
# being saved both in the host facts and in the task results.
for fact in self.ignored_facts:
if fact in results["ansible_facts"]:
self.log.debug("Ignoring fact: %s" % fact)
results["ansible_facts"][fact] = "Not saved by ARA as configured by 'ignored_facts'"
self.client.patch("/api/v1/hosts/%s" % host["id"], facts=results["ansible_facts"]) self.client.patch("/api/v1/hosts/%s" % host["id"], facts=results["ansible_facts"])
def _load_stats(self, stats): def _load_stats(self, stats):