ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

pkgng: call module.run_command with list

Browse source 
Instead of calling `run_command` with a formatted
string, call it with a list to maintain safer argument
separation.

Also, introduce a wrapper for `run_command`, `run_pkgng`,
which manages the process environment and some common
command line switches, based upon the module parameters.

Introduced in this commit, also pass annotation values
to `pkg annotate` via stdin, which is safer with long
values than putting them in argv.
This commit is contained in:
Ross Williams 2021-10-12 21:15:25 +00:00
parent 4c5239e82f
commit ec03bc1a2a
1 changed files with 82 additions and 90 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

172
plugins/modules/packaging/os/pkgng.py
View file

@ -143,9 +143,9 @@ import re
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
def query_package(module, pkgng_path, name, dir_arg): def query_package(module, run_pkgng, name):
rc, out, err = module.run_command("%s %s info -g -e %s" % (pkgng_path, dir_arg, name)) rc, out, err = run_pkgng('info', '-g', '-e', name)
if rc == 0: if rc == 0:
return True return True
@ -153,15 +153,12 @@ def query_package(module, pkgng_path, name, dir_arg):
return False return False
def query_update(module, pkgng_path, name, dir_arg, old_pkgng, pkgsite): def query_update(module, run_pkgng, name):
# Check to see if a package upgrade is available. # Check to see if a package upgrade is available.
# rc = 0, no updates available or package not installed # rc = 0, no updates available or package not installed
# rc = 1, updates available # rc = 1, updates available
if old_pkgng: rc, out, err = run_pkgng('upgrade', '-g', '-n', name)
rc, out, err = module.run_command("%s %s upgrade -g -n %s" % (pkgsite, pkgng_path, name))
else:
rc, out, err = module.run_command("%s %s upgrade %s -g -n %s" % (pkgng_path, dir_arg, pkgsite, name))
if rc == 1: if rc == 1:
return True return True
@ -171,7 +168,7 @@ def query_update(module, pkgng_path, name, dir_arg, old_pkgng, pkgsite):
def pkgng_older_than(module, pkgng_path, compare_version): def pkgng_older_than(module, pkgng_path, compare_version):
rc, out, err = module.run_command("%s -v" % pkgng_path) rc, out, err = module.run_command([pkgng_path, '-v'])
version = [int(x) for x in re.split(r'[\._]', out)] version = [int(x) for x in re.split(r'[\._]', out)]
i = 0 i = 0
@ -186,14 +183,13 @@ def pkgng_older_than(module, pkgng_path, compare_version):
return not new_pkgng return not new_pkgng
def upgrade_packages(module, pkgng_path, dir_arg): def upgrade_packages(module, run_pkgng):
# Run a 'pkg upgrade', updating all packages. # Run a 'pkg upgrade', updating all packages.
upgraded_c = 0 upgraded_c = 0
cmd = "%s %s upgrade -y" % (pkgng_path, dir_arg) pkgng_args = ['upgrade']
if module.check_mode: pkgng_args.append('-n' if module.check_mode else '-y')
cmd += " -n" rc, out, err = run_pkgng(*pkgng_args)
rc, out, err = module.run_command(cmd)
matches = re.findall('^Number of packages to be (?:upgraded|reinstalled): ([0-9]+)', out, re.MULTILINE) matches = re.findall('^Number of packages to be (?:upgraded|reinstalled): ([0-9]+)', out, re.MULTILINE)
for match in matches: for match in matches:
@ -204,22 +200,22 @@ def upgrade_packages(module, pkgng_path, dir_arg):
return (False, "no packages need upgrades", out, err) return (False, "no packages need upgrades", out, err)
def remove_packages(module, pkgng_path, packages, dir_arg): def remove_packages(module, run_pkgng, packages):
remove_c = 0 remove_c = 0
stdout = "" stdout = ""
stderr = "" stderr = ""
# Using a for loop in case of error, we can report the package that failed # Using a for loop in case of error, we can report the package that failed
for package in packages: for package in packages:
# Query the package first, to see if we even need to remove # Query the package first, to see if we even need to remove
if not query_package(module, pkgng_path, package, dir_arg): if not query_package(module, run_pkgng, package):
continue continue
if not module.check_mode: if not module.check_mode:
rc, out, err = module.run_command("%s %s delete -y %s" % (pkgng_path, dir_arg, package)) rc, out, err = run_pkgng('delete', '-y', package)
stdout += out stdout += out
stderr += err stderr += err
if not module.check_mode and query_package(module, pkgng_path, package, dir_arg): if not module.check_mode and query_package(module, run_pkgng, package):
module.fail_json(msg="failed to remove %s: %s" % (package, out), stdout=stdout, stderr=stderr) module.fail_json(msg="failed to remove %s: %s" % (package, out), stdout=stdout, stderr=stderr)
remove_c += 1 remove_c += 1
@ -230,48 +226,27 @@ def remove_packages(module, pkgng_path, packages, dir_arg):
return (False, "package(s) already absent", stdout, stderr) return (False, "package(s) already absent", stdout, stderr)
def install_packages(module, pkgng_path, packages, cached, pkgsite, dir_arg, state, ignoreosver): def install_packages(module, run_pkgng, packages, cached, state):
action_queue = defaultdict(list) action_queue = defaultdict(list)
action_count = defaultdict(int) action_count = defaultdict(int)
stdout = "" stdout = ""
stderr = "" stderr = ""
# as of pkg-1.1.4, PACKAGESITE is deprecated in favor of repository definitions
# in /usr/local/etc/pkg/repos
old_pkgng = pkgng_older_than(module, pkgng_path, [1, 1, 4])
if pkgsite != "":
if old_pkgng:
pkgsite = "PACKAGESITE=%s" % (pkgsite)
else:
pkgsite = "-r %s" % (pkgsite)
# This environment variable skips mid-install prompts,
# setting them to their default values.
batch_var = 'env BATCH=yes'
if ignoreosver:
# Ignore FreeBSD OS version check,
# useful on -STABLE and -CURRENT branches.
batch_var = batch_var + ' IGNORE_OSVERSION=yes'
if not module.check_mode and not cached: if not module.check_mode and not cached:
if old_pkgng: rc, out, err = run_pkgng('update')
rc, out, err = module.run_command("%s %s update" % (pkgsite, pkgng_path))
else:
rc, out, err = module.run_command("%s %s %s update" % (batch_var, pkgng_path, dir_arg))
stdout += out stdout += out
stderr += err stderr += err
if rc != 0: if rc != 0:
module.fail_json(msg="Could not update catalogue [%d]: %s %s" % (rc, out, err), stdout=stdout, stderr=stderr) module.fail_json(msg="Could not update catalogue [%d]: %s %s" % (rc, out, err), stdout=stdout, stderr=stderr)
for package in packages: for package in packages:
already_installed = query_package(module, pkgng_path, package, dir_arg) already_installed = query_package(module, run_pkgng, package)
if already_installed and state == "present": if already_installed and state == "present":
continue continue
if ( if (
already_installed and state == "latest" already_installed and state == "latest"
and not query_update(module, pkgng_path, package, dir_arg, old_pkgng, pkgsite) and not query_update(module, run_pkgng, package)
): ):
continue continue
@ -289,11 +264,8 @@ def install_packages(module, pkgng_path, packages, cached, pkgsite, dir_arg, sta
action_count[action] += len(package_list) action_count[action] += len(package_list)
continue continue
packages = ' '.join(package_list) pkgng_args = [action, '-g', '-U', '-y'] + package_list
if old_pkgng: rc, out, err = run_pkgng(*pkgng_args)
rc, out, err = module.run_command("%s %s %s %s -g -U -y %s" % (batch_var, pkgsite, pkgng_path, action, packages))
else:
rc, out, err = module.run_command("%s %s %s %s %s -g -U -y %s" % (batch_var, pkgng_path, dir_arg, action, pkgsite, packages))
stdout += out stdout += out
stderr += err stderr += err
@ -301,9 +273,9 @@ def install_packages(module, pkgng_path, packages, cached, pkgsite, dir_arg, sta
for package in package_list: for package in package_list:
verified = False verified = False
if action == 'install': if action == 'install':
verified = query_package(module, pkgng_path, package, dir_arg) verified = query_package(module, run_pkgng, package)
elif action == 'upgrade': elif action == 'upgrade':
verified = not query_update(module, pkgng_path, package, dir_arg, old_pkgng, pkgsite) verified = not query_update(module, run_pkgng, package)
if verified: if verified:
action_count[action] += 1 action_count[action] += 1
@ -321,21 +293,20 @@ def install_packages(module, pkgng_path, packages, cached, pkgsite, dir_arg, sta
return (False, "package(s) already %s" % (state), stdout, stderr) return (False, "package(s) already %s" % (state), stdout, stderr)
def annotation_query(module, pkgng_path, package, tag, dir_arg): def annotation_query(module, run_pkgng, package, tag):
rc, out, err = module.run_command("%s %s info -g -A %s" % (pkgng_path, dir_arg, package)) rc, out, err = run_pkgng('info', '-g', '-A', package)
match = re.search(r'^\s*(?P<tag>%s)\s*:\s*(?P<value>\w+)' % tag, out, flags=re.MULTILINE) match = re.search(r'^\s*(?P<tag>%s)\s*:\s*(?P<value>\w+)' % tag, out, flags=re.MULTILINE)
if match: if match:
return match.group('value') return match.group('value')
return False return False
def annotation_add(module, pkgng_path, package, tag, value, dir_arg): def annotation_add(module, run_pkgng, package, tag, value):
_value = annotation_query(module, pkgng_path, package, tag, dir_arg) _value = annotation_query(module, run_pkgng, package, tag)
if not _value: if not _value:
# Annotation does not exist, add it. # Annotation does not exist, add it.
if not module.check_mode: if not module.check_mode:
rc, out, err = module.run_command('%s %s annotate -y -A %s %s "%s"' rc, out, err = run_pkgng('annotate', '-y', '-A', package, tag, data=value, binary_data=True)
% (pkgng_path, dir_arg, package, tag, value))
if rc != 0: if rc != 0:
module.fail_json(msg="could not annotate %s: %s" module.fail_json(msg="could not annotate %s: %s"
% (package, out), stderr=err) % (package, out), stderr=err)
@ -351,12 +322,11 @@ def annotation_add(module, pkgng_path, package, tag, value, dir_arg):
return False return False
def annotation_delete(module, pkgng_path, package, tag, value, dir_arg): def annotation_delete(module, run_pkgng, package, tag, value):
_value = annotation_query(module, pkgng_path, package, tag, dir_arg) _value = annotation_query(module, run_pkgng, package, tag)
if _value: if _value:
if not module.check_mode: if not module.check_mode:
rc, out, err = module.run_command('%s %s annotate -y -D %s %s' rc, out, err = run_pkgng('annotate', '-y', '-D', package, tag)
% (pkgng_path, dir_arg, package, tag))
if rc != 0: if rc != 0:
module.fail_json(msg="could not delete annotation to %s: %s" module.fail_json(msg="could not delete annotation to %s: %s"
% (package, out), stderr=err) % (package, out), stderr=err)
@ -364,8 +334,8 @@ def annotation_delete(module, pkgng_path, package, tag, value, dir_arg):
return False return False
def annotation_modify(module, pkgng_path, package, tag, value, dir_arg): def annotation_modify(module, run_pkgng, package, tag, value):
_value = annotation_query(module, pkgng_path, package, tag, dir_arg) _value = annotation_query(module, run_pkgng, package, tag)
if not _value: if not _value:
# No such tag # No such tag
module.fail_json(msg="could not change annotation to %s: tag %s does not exist" module.fail_json(msg="could not change annotation to %s: tag %s does not exist"
@ -375,8 +345,7 @@ def annotation_modify(module, pkgng_path, package, tag, value, dir_arg):
return False return False
else: else:
if not module.check_mode: if not module.check_mode:
rc, out, err = module.run_command('%s %s annotate -y -M %s %s "%s"' rc, out, err = run_pkgng('annotate', '-y', '-M', package, tag, data=value, binary_data=True)
% (pkgng_path, dir_arg, package, tag, value))
# pkg sometimes exits with rc == 1, even though the modification succeeded # pkg sometimes exits with rc == 1, even though the modification succeeded
# Check the output for a success message # Check the output for a success message
@ -389,7 +358,7 @@ def annotation_modify(module, pkgng_path, package, tag, value, dir_arg):
return True return True
def annotate_packages(module, pkgng_path, packages, annotations, dir_arg): def annotate_packages(module, run_pkgng, packages, annotations):
annotate_c = 0 annotate_c = 0
if len(annotations) == 1: if len(annotations) == 1:
# Split on commas with optional trailing whitespace, # Split on commas with optional trailing whitespace,
@ -418,7 +387,7 @@ def annotate_packages(module, pkgng_path, packages, annotations, dir_arg):
) )
annotation = annotation.groupdict() annotation = annotation.groupdict()
if operation[annotation['operation']](module, pkgng_path, package, annotation['tag'], annotation['value'], dir_arg): if operation[annotation['operation']](module, run_pkgng, package, annotation['tag'], annotation['value']):
annotate_c += 1 annotate_c += 1
if annotate_c > 0: if annotate_c > 0:
@ -426,10 +395,10 @@ def annotate_packages(module, pkgng_path, packages, annotations, dir_arg):
return (False, "changed no annotations") return (False, "changed no annotations")
def autoremove_packages(module, pkgng_path, dir_arg): def autoremove_packages(module, run_pkgng):
stdout = "" stdout = ""
stderr = "" stderr = ""
rc, out, err = module.run_command("%s %s autoremove -n" % (pkgng_path, dir_arg)) rc, out, err = run_pkgng('autoremove', '-n')
autoremove_c = 0 autoremove_c = 0
@ -441,7 +410,7 @@ def autoremove_packages(module, pkgng_path, dir_arg):
return (False, "no package(s) to autoremove", stdout, stderr) return (False, "no package(s) to autoremove", stdout, stderr)
if not module.check_mode: if not module.check_mode:
rc, out, err = module.run_command("%s %s autoremove -y" % (pkgng_path, dir_arg)) rc, out, err = run_pkgng('autoremove', '-y')
stdout += out stdout += out
stderr += err stderr += err
@ -456,10 +425,10 @@ def main():
cached=dict(default=False, type='bool'), cached=dict(default=False, type='bool'),
ignore_osver=dict(default=False, required=False, type='bool'), ignore_osver=dict(default=False, required=False, type='bool'),
annotation=dict(required=False, type='list', elements='str'), annotation=dict(required=False, type='list', elements='str'),
pkgsite=dict(default="", required=False), pkgsite=dict(required=False),
rootdir=dict(default="", required=False, type='path'), rootdir=dict(required=False, type='path'),
chroot=dict(default="", required=False, type='path'), chroot=dict(required=False, type='path'),
jail=dict(default="", required=False, type='str'), jail=dict(required=False, type='str'),
autoremove=dict(default=False, type='bool')), autoremove=dict(default=False, type='bool')),
supports_check_mode=True, supports_check_mode=True,
mutually_exclusive=[["rootdir", "chroot", "jail"]]) mutually_exclusive=[["rootdir", "chroot", "jail"]])
@ -474,29 +443,53 @@ def main():
msgs = [] msgs = []
stdout = "" stdout = ""
stderr = "" stderr = ""
dir_arg = "" dir_arg = None
if p["rootdir"] != "": if p["rootdir"] is not None:
old_pkgng = pkgng_older_than(module, pkgng_path, [1, 5, 0]) rootdir_not_supported = pkgng_older_than(module, pkgng_path, [1, 5, 0])
if old_pkgng: if rootdir_not_supported:
module.fail_json(msg="To use option 'rootdir' pkg version must be 1.5 or greater") module.fail_json(msg="To use option 'rootdir' pkg version must be 1.5 or greater")
else: else:
dir_arg = "--rootdir %s" % (p["rootdir"]) dir_arg = "--rootdir=%s" % (p["rootdir"])
if p["ignore_osver"]: if p["ignore_osver"]:
old_pkgng = pkgng_older_than(module, pkgng_path, [1, 11, 0]) ignore_osver_not_supported = pkgng_older_than(module, pkgng_path, [1, 11, 0])
if old_pkgng: if ignore_osver_not_supported:
module.fail_json(msg="To use option 'ignore_osver' pkg version must be 1.11 or greater") module.fail_json(msg="To use option 'ignore_osver' pkg version must be 1.11 or greater")
if p["chroot"] != "": if p["chroot"] is not None:
dir_arg = '--chroot %s' % (p["chroot"]) dir_arg = '--chroot=%s' % (p["chroot"])
if p["jail"] != "": if p["jail"] is not None:
dir_arg = '--jail %s' % (p["jail"]) dir_arg = '--jail=%s' % (p["jail"])
# as of pkg-1.1.4, PACKAGESITE is deprecated in favor of repository definitions
# in /usr/local/etc/pkg/repos
repo_flag_not_supported = pkgng_older_than(module, pkgng_path, [1, 1, 4])
def run_pkgng(action, *args, pkgsite=None, **kwargs):
cmd = [pkgng_path, dir_arg, action]
pkgng_env = {'BATCH': 'yes'}
if p["ignore_osver"]:
pkgng_env['IGNORE_OSVERSION'] = 'yes'
if pkgsite is not None and action in ('update', 'install', 'upgrade',):
if repo_flag_not_supported:
pkgng_env['PACKAGESITE'] = pkgsite
else:
cmd.append('--repository=%s' % (pkgsite,))
# If environ_update is specified to be "passed through"
# to module.run_command, then merge its values into pkgng_env
pkgng_env.update(kwargs.pop('environ_update', dict()))
return module.run_command(cmd + list(args), environ_update=pkgng_env, **kwargs)
if pkgs == ['*'] and p["state"] == 'latest': if pkgs == ['*'] and p["state"] == 'latest':
# Operate on all installed packages. Only state: latest makes sense here. # Operate on all installed packages. Only state: latest makes sense here.
_changed, _msg, _stdout, _stderr = upgrade_packages(module, pkgng_path, dir_arg) _changed, _msg, _stdout, _stderr = upgrade_packages(module, run_pkgng)
changed = changed or _changed changed = changed or _changed
stdout += _stdout stdout += _stdout
stderr += _stderr stderr += _stderr
@ -511,30 +504,29 @@ def main():
pkgs = re.split(r'[,\s]', pkgs[0]) pkgs = re.split(r'[,\s]', pkgs[0])
named_packages = [pkg for pkg in pkgs if pkg != '*'] named_packages = [pkg for pkg in pkgs if pkg != '*']
if p["state"] in ("present", "latest") and named_packages: if p["state"] in ("present", "latest") and named_packages:
_changed, _msg, _out, _err = install_packages(module, pkgng_path, named_packages, _changed, _msg, _out, _err = install_packages(module, run_pkgng, named_packages,
p["cached"], p["pkgsite"], dir_arg, p["cached"], p["state"])
p["state"], p["ignore_osver"])
stdout += _out stdout += _out
stderr += _err stderr += _err
changed = changed or _changed changed = changed or _changed
msgs.append(_msg) msgs.append(_msg)
elif p["state"] == "absent" and named_packages: elif p["state"] == "absent" and named_packages:
_changed, _msg, _out, _err = remove_packages(module, pkgng_path, named_packages, dir_arg) _changed, _msg, _out, _err = remove_packages(module, run_pkgng, named_packages)
stdout += _out stdout += _out
stderr += _err stderr += _err
changed = changed or _changed changed = changed or _changed
msgs.append(_msg) msgs.append(_msg)
if p["autoremove"]: if p["autoremove"]:
_changed, _msg, _stdout, _stderr = autoremove_packages(module, pkgng_path, dir_arg) _changed, _msg, _stdout, _stderr = autoremove_packages(module, run_pkgng)
changed = changed or _changed changed = changed or _changed
stdout += _stdout stdout += _stdout
stderr += _stderr stderr += _stderr
msgs.append(_msg) msgs.append(_msg)
if p["annotation"] is not None: if p["annotation"] is not None:
_changed, _msg = annotate_packages(module, pkgng_path, pkgs, p["annotation"], dir_arg) _changed, _msg = annotate_packages(module, run_pkgng, pkgs, p["annotation"])
changed = changed or _changed changed = changed or _changed
msgs.append(_msg) msgs.append(_msg)