archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

ansible-pull fix adhoc output inconsistencies on changed (#84869)

Browse Source 
Two fixes for single bug:
  - ignore callback changes for adhoc
  - allow 'yaml' change matching
---------

Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
pull/84949/head
Brian Coca 8 months ago committed by GitHub
parent fd76cc2821
commit 4bc4030988
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 93 additions and 8 deletions
Show Stats Download Patch File Download Diff File

2
changelogs/fragments/pull_changed_fix.yml
Unescape Escape View File

@ -0,0 +1,2 @@
bugfixes:
- ansible-pull change detection will now work independently of callback or result format settings.

51
lib/ansible/cli/pull.py
Unescape Escape View File

@ -31,6 +31,34 @@ from ansible.utils.display import Display
display = Display()
SAFE_OUTPUT_ENV = {
'ANSIBLE_CALLBACK_RESULT_FORMAT': 'json',
'ANSIBLE_LOAD_CALLBACK_PLUGINS': '0',
}
def safe_output_env(f):
def wrapper(*args, **kwargs):
orig = {}
for k, v in SAFE_OUTPUT_ENV.items():
orig[k] = os.environ.get(k, None)
os.environ[k] = v
result = f(*args, **kwargs)
for key in orig.keys():
if orig[key] is None:
del os.environ[key]
else:
os.environ[key] = orig[key]
return result
return wrapper
class PullCLI(CLI):
""" Used to pull a remote copy of ansible on each managed node,
@ -42,7 +70,7 @@ class PullCLI(CLI):
you should use an external scheduler and/or locking to ensure there are no clashing operations.
The setup playbook can be tuned to change the cron frequency, logging locations, and parameters to ansible-pull.
This is useful both for extreme scale-out as well as periodic remediation.
This is useful both for extreme scale-out and periodic remediation.
Usage of the 'fetch' module to retrieve logs from ansible-pull runs would be an
excellent way to gather and analyze remote logs from ansible-pull.
"""
@ -76,8 +104,9 @@ class PullCLI(CLI):
return inv_opts
def init_parser(self):
""" create an options parser for bin/ansible """
""" Specific args/option parser for pull """
# signature is different from parent as caller should not need to add usage/desc
super(PullCLI, self).init_parser(
usage='%prog -U <repository> [options] [<playbook.yml>]',
desc="pulls playbooks from a VCS repo and executes them on target host")
@ -106,10 +135,12 @@ class PullCLI(CLI):
help='path to the directory to which Ansible will checkout the repository.')
self.parser.add_argument('-U', '--url', dest='url', default=None, help='URL of the playbook repository')
self.parser.add_argument('--full', dest='fullclone', action='store_true', help='Do a full clone, instead of a shallow one.')
# TODO: resolve conflict with check mode, added manually below
self.parser.add_argument('-C', '--checkout', dest='checkout',
help='branch/tag/commit to checkout. Defaults to behavior of repository module.')
self.parser.add_argument('--accept-host-key', default=False, dest='accept_host_key', action='store_true',
help='adds the hostkey for the repo url if not already added')
# Overloaded with adhoc ... but really passthrough to adhoc
self.parser.add_argument('-m', '--module-name', dest='module_name', default=self.DEFAULT_REPO_TYPE,
help='Repository module name, which ansible will use to check out the repo. Choices are %s. Default is %s.'
% (self.REPO_CHOICES, self.DEFAULT_REPO_TYPE))
@ -121,7 +152,7 @@ class PullCLI(CLI):
self.parser.add_argument('--track-subs', dest='tracksubs', default=False, action='store_true',
help='submodules will track the latest changes. This is equivalent to specifying the --remote flag to git submodule update')
# add a subset of the check_opts flag group manually, as the full set's
# shortcodes conflict with above --checkout/-C
# shortcodes conflict with above --checkout/-C, see to-do above
self.parser.add_argument("--check", default=False, dest='check', action='store_true',
help="don't make any changes; instead, try to predict some of the changes that may occur")
self.parser.add_argument("--diff", default=C.DIFF_ALWAYS, dest='diff', action='store_true',
@ -177,7 +208,7 @@ class PullCLI(CLI):
limit_opts = 'localhost,127.0.0.1'
base_opts = '-c local '
if context.CLIARGS['verbosity'] > 0:
base_opts += ' -%s' % ''.join(["v" for x in range(0, context.CLIARGS['verbosity'])])
base_opts += ' -%s' % ''.join(["v" for dummy in range(0, context.CLIARGS['verbosity'])])
# Attempt to use the inventory passed in as an argument
# It might not yet have been downloaded so use localhost as default
@ -250,15 +281,21 @@ class PullCLI(CLI):
# RUN the Checkout command
display.debug("running ansible with VCS module to checkout repo")
display.vvvv('EXEC: %s' % cmd)
rc, b_out, b_err = run_cmd(cmd, live=True)
rc, b_out, b_err = safe_output_env(run_cmd)(cmd, live=True)
if rc != 0:
if context.CLIARGS['force']:
display.warning("Unable to update repository. Continuing with (forced) run of playbook.")
else:
return rc
elif context.CLIARGS['ifchanged'] and b'"changed": true' not in b_out:
display.display("Repository has not changed, quitting.")
elif context.CLIARGS['ifchanged']:
# detect json/yaml/header, any count as 'changed'
for detect in (b'"changed": true', b"changed: True", b"| CHANGED =>"):
if detect in b_out:
break
else:
# no change, we bail
display.display(f"Repository has not changed, quitting: {b_out!r}")
return 0
playbook = self.select_playbook(context.CLIARGS['dest'])

1
test/integration/targets/ansible-pull/aliases
Unescape Escape View File

@ -1,2 +1,3 @@
shippable/posix/group5
context/controller
needs/root

45
test/integration/targets/ansible-pull/runme.sh
Unescape Escape View File

@ -27,6 +27,23 @@ cd "${repo_dir}"
git commit -m "Initial commit."
)
function change_repo {
cd "${repo_dir}"
date > forced_change
git add forced_change
git commit -m "forced changed"
cd -
}
function no_change_tests {
# test for https://github.com/ansible/ansible/issues/13688
if grep MAGICKEYWORD "${temp_log}"; then
cat "${temp_log}"
echo "Ran the playbook, found MAGICKEYWORD in output."
exit 1
fi
}
function pass_tests {
# test for https://github.com/ansible/ansible/issues/13688
if ! grep MAGICKEYWORD "${temp_log}"; then
@ -97,3 +114,31 @@ export ANSIBLE_CACHE_PLUGIN=jsonfile ANSIBLE_CACHE_PLUGIN_CONNECTION=./
ansible-pull -d "${pull_dir}" -U "${repo_dir}" "$@" gather_facts.yml
ansible-pull -d "${pull_dir}" -U "${repo_dir}" --flush-cache "$@" test_empty_facts.yml
unset ANSIBLE_CACHE_PLUGIN ANSIBLE_CACHE_PLUGIN_CONNECTION
#### CHACHCHCHANGES!
echo 'setup for change detection'
ORIG_CONFIG="${ANSIBLE_CONFIG}"
unset ANSIBLE_CONFIG
echo 'test no run on no changes'
ansible-pull -d "${pull_dir}" -U "${repo_dir}" --only-if-changed "$@" | tee "${temp_log}"
no_change_tests
echo 'test run on changes'
change_repo
ansible-pull -d "${pull_dir}" -U "${repo_dir}" --only-if-changed "$@" | tee "${temp_log}"
pass_tests
# test changed with non yaml result format, ensures we ignore callback or format changes for adhoc/change detection
echo 'test no run on no changes, yaml result format'
ANSIBLE_CALLBACK_RESULT_FORMAT='yaml' ansible-pull -d "${pull_dir}" -U "${repo_dir}" --only-if-changed "$@" | tee "${temp_log}"
no_change_tests
echo 'test run on changes, yaml result format'
change_repo
ANSIBLE_CALLBACK_RESULT_FORMAT='yaml' ansible-pull -d "${pull_dir}" -U "${repo_dir}" --only-if-changed "$@" | tee "${temp_log}"
pass_tests
if [ "${ORIG_CONFIG}" != "" ]; then
export ANSIBLE_CONFIG="${ORIG_CONFIG}"
fi

Write Preview
Loading…
Cancel
Save