ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-04-25 13:12:46 +00:00
Code Activity

Reformat everything.

Browse source
This commit is contained in:
Felix Fontein 2025-11-01 12:08:41 +01:00
parent 3f2213791a
commit 340ff8586d
1008 changed files with 61301 additions and 58309 deletions
Download patch file Download diff file Expand all files Collapse all files

217
plugins/modules/zypper_repository.py
View file

@ -132,6 +132,7 @@ import traceback
XML_IMP_ERR = None
try:
from xml.dom.minidom import parseString as parseXML
HAS_XML = True
except ImportError:
XML_IMP_ERR = traceback.format_exc()
@ -145,12 +146,12 @@ from io import StringIO, open
from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
REPO_OPTS = ['alias', 'name', 'priority', 'enabled', 'autorefresh', 'gpgcheck']
REPO_OPTS = ["alias", "name", "priority", "enabled", "autorefresh", "gpgcheck"]
def _get_cmd(module, *args):
"""Combines the non-interactive zypper command with arguments/subcommands"""
cmd = [module.get_bin_path('zypper', required=True), '--quiet', '--non-interactive']
cmd = [module.get_bin_path("zypper", required=True), "--quiet", "--non-interactive"]
cmd.extend(args)
return cmd
@ -158,7 +159,7 @@ def _get_cmd(module, *args):
def _parse_repos(module):
"""parses the output of zypper --xmlout repos and return a parse repo dictionary"""
cmd = _get_cmd(module, '--xmlout', 'repos')
cmd = _get_cmd(module, "--xmlout", "repos")
if not HAS_XML:
module.fail_json(msg=missing_required_lib("python-xml"), exception=XML_IMP_ERR)
@ -166,15 +167,15 @@ def _parse_repos(module):
if rc == 0:
repos = []
dom = parseXML(stdout)
repo_list = dom.getElementsByTagName('repo')
repo_list = dom.getElementsByTagName("repo")
for repo in repo_list:
opts = {}
for o in REPO_OPTS:
opts[o] = repo.getAttribute(o)
try:
opts['url'] = repo.getElementsByTagName('url')[0].firstChild.data
opts["url"] = repo.getElementsByTagName("url")[0].firstChild.data
except IndexError:
opts['url'] = repo.getAttribute('metalink')
opts["url"] = repo.getAttribute("metalink")
# A repo can be uniquely identified by an alias + url
repos.append(opts)
return repos
@ -196,16 +197,16 @@ def _repo_changes(module, realrepo, repocmp):
valold = str(repocmp[k] or "")
valnew = v or ""
if k == "url":
if '$releasever' in valold or '$releasever' in valnew:
cmd = ['rpm', '-q', '--qf', '%{version}', '-f', '/etc/os-release']
if "$releasever" in valold or "$releasever" in valnew:
cmd = ["rpm", "-q", "--qf", "%{version}", "-f", "/etc/os-release"]
rc, stdout, stderr = module.run_command(cmd, check_rc=True)
valnew = valnew.replace('$releasever', stdout)
valold = valold.replace('$releasever', stdout)
if '$basearch' in valold or '$basearch' in valnew:
cmd = ['rpm', '-q', '--qf', '%{arch}', '-f', '/etc/os-release']
valnew = valnew.replace("$releasever", stdout)
valold = valold.replace("$releasever", stdout)
if "$basearch" in valold or "$basearch" in valnew:
cmd = ["rpm", "-q", "--qf", "%{arch}", "-f", "/etc/os-release"]
rc, stdout, stderr = module.run_command(cmd, check_rc=True)
valnew = valnew.replace('$basearch', stdout)
valold = valold.replace('$basearch', stdout)
valnew = valnew.replace("$basearch", stdout)
valold = valold.replace("$basearch", stdout)
valold, valnew = valold.rstrip("/"), valnew.rstrip("/")
if valold != valnew:
return True
@ -215,16 +216,16 @@ def _repo_changes(module, realrepo, repocmp):
def repo_exists(module, repodata, overwrite_multiple):
"""Check whether the repository already exists.
returns (exists, mod, old_repos)
exists: whether a matching (name, URL) repo exists
mod: whether there are changes compared to the existing repo
old_repos: list of matching repos
returns (exists, mod, old_repos)
exists: whether a matching (name, URL) repo exists
mod: whether there are changes compared to the existing repo
old_repos: list of matching repos
"""
existing_repos = _parse_repos(module)
# look for repos that have matching alias or url to the one searched
repos = []
for kw in ['alias', 'url']:
for kw in ["alias", "url"]:
name = repodata[kw]
for oldr in existing_repos:
if repodata[kw] == oldr[kw] and oldr not in repos:
@ -243,50 +244,50 @@ def repo_exists(module, repodata, overwrite_multiple):
return (True, True, repos)
else:
errmsg = f'More than one repo matched "{name}": "{repos}".'
errmsg += ' Use overwrite_multiple to allow more than one repo to be overwritten'
errmsg += " Use overwrite_multiple to allow more than one repo to be overwritten"
module.fail_json(msg=errmsg)
def addmodify_repo(module, repodata, old_repos, zypper_version):
"Adds the repo, removes old repos before, that would conflict."
repo = repodata['url']
cmd = _get_cmd(module, 'addrepo', '--check')
if repodata['name']:
cmd.extend(['--name', repodata['name']])
repo = repodata["url"]
cmd = _get_cmd(module, "addrepo", "--check")
if repodata["name"]:
cmd.extend(["--name", repodata["name"]])
# priority on addrepo available since 1.12.25
# https://github.com/openSUSE/zypper/blob/b9b3cb6db76c47dc4c47e26f6a4d2d4a0d12b06d/package/zypper.changes#L327-L336
if repodata['priority']:
if zypper_version >= LooseVersion('1.12.25'):
cmd.extend(['--priority', str(repodata['priority'])])
if repodata["priority"]:
if zypper_version >= LooseVersion("1.12.25"):
cmd.extend(["--priority", str(repodata["priority"])])
else:
module.warn("Setting priority only available for zypper >= 1.12.25. Ignoring priority argument.")
if repodata['enabled'] == '0':
cmd.append('--disable')
if repodata["enabled"] == "0":
cmd.append("--disable")
# gpgcheck available since 1.6.2
# https://github.com/openSUSE/zypper/blob/b9b3cb6db76c47dc4c47e26f6a4d2d4a0d12b06d/package/zypper.changes#L2446-L2449
# the default changed in the past, so don't assume a default here and show warning for old zypper versions
if zypper_version >= LooseVersion('1.6.2'):
if repodata['gpgcheck'] == '1':
cmd.append('--gpgcheck')
if zypper_version >= LooseVersion("1.6.2"):
if repodata["gpgcheck"] == "1":
cmd.append("--gpgcheck")
else:
cmd.append('--no-gpgcheck')
cmd.append("--no-gpgcheck")
else:
module.warn("Enabling/disabling gpgcheck only available for zypper >= 1.6.2. Using zypper default value.")
if repodata['autorefresh'] == '1':
cmd.append('--refresh')
if repodata["autorefresh"] == "1":
cmd.append("--refresh")
cmd.append(repo)
if not repo.endswith('.repo'):
cmd.append(repodata['alias'])
if not repo.endswith(".repo"):
cmd.append(repodata["alias"])
if old_repos is not None:
for oldrepo in old_repos:
remove_repo(module, oldrepo['url'])
remove_repo(module, oldrepo["url"])
rc, stdout, stderr = module.run_command(cmd, check_rc=False)
return rc, stdout, stderr
@ -294,27 +295,27 @@ def addmodify_repo(module, repodata, old_repos, zypper_version):
def remove_repo(module, repo):
"Removes the repo."
cmd = _get_cmd(module, 'removerepo', repo)
cmd = _get_cmd(module, "removerepo", repo)
rc, stdout, stderr = module.run_command(cmd, check_rc=True)
return rc, stdout, stderr
def get_zypper_version(module):
rc, stdout, stderr = module.run_command([module.get_bin_path('zypper', required=True), '--version'])
if rc != 0 or not stdout.startswith('zypper '):
return LooseVersion('1.0')
rc, stdout, stderr = module.run_command([module.get_bin_path("zypper", required=True), "--version"])
if rc != 0 or not stdout.startswith("zypper "):
return LooseVersion("1.0")
return LooseVersion(stdout.split()[1])
def runrefreshrepo(module, auto_import_keys=False, shortname=None):
"Forces zypper to refresh repo metadata."
if auto_import_keys:
cmd = _get_cmd(module, '--gpg-auto-import-keys', 'refresh', '--force')
cmd = _get_cmd(module, "--gpg-auto-import-keys", "refresh", "--force")
else:
cmd = _get_cmd(module, 'refresh', '--force')
cmd = _get_cmd(module, "refresh", "--force")
if shortname is not None:
cmd.extend(['-r', shortname])
cmd.extend(["-r", shortname])
rc, stdout, stderr = module.run_command(cmd, check_rc=True)
return rc, stdout, stderr
@ -325,91 +326,91 @@ def main():
argument_spec=dict(
name=dict(),
repo=dict(),
state=dict(choices=['present', 'absent'], default='present'),
runrefresh=dict(default=False, type='bool'),
state=dict(choices=["present", "absent"], default="present"),
runrefresh=dict(default=False, type="bool"),
description=dict(),
disable_gpg_check=dict(default=False, type='bool'),
autorefresh=dict(default=True, type='bool', aliases=['refresh']),
priority=dict(type='int'),
enabled=dict(default=True, type='bool'),
overwrite_multiple=dict(default=False, type='bool'),
auto_import_keys=dict(default=False, type='bool'),
disable_gpg_check=dict(default=False, type="bool"),
autorefresh=dict(default=True, type="bool", aliases=["refresh"]),
priority=dict(type="int"),
enabled=dict(default=True, type="bool"),
overwrite_multiple=dict(default=False, type="bool"),
auto_import_keys=dict(default=False, type="bool"),
),
supports_check_mode=False,
required_one_of=[['state', 'runrefresh']],
required_one_of=[["state", "runrefresh"]],
)
repo = module.params['repo']
alias = module.params['name']
state = module.params['state']
overwrite_multiple = module.params['overwrite_multiple']
auto_import_keys = module.params['auto_import_keys']
runrefresh = module.params['runrefresh']
repo = module.params["repo"]
alias = module.params["name"]
state = module.params["state"]
overwrite_multiple = module.params["overwrite_multiple"]
auto_import_keys = module.params["auto_import_keys"]
runrefresh = module.params["runrefresh"]
zypper_version = get_zypper_version(module)
repodata = {
'url': repo,
'alias': alias,
'name': module.params['description'],
'priority': module.params['priority'],
"url": repo,
"alias": alias,
"name": module.params["description"],
"priority": module.params["priority"],
}
# rewrite bools in the language that zypper lr -x provides for easier comparison
if module.params['enabled']:
repodata['enabled'] = '1'
if module.params["enabled"]:
repodata["enabled"] = "1"
else:
repodata['enabled'] = '0'
if module.params['disable_gpg_check']:
repodata['gpgcheck'] = '0'
repodata["enabled"] = "0"
if module.params["disable_gpg_check"]:
repodata["gpgcheck"] = "0"
else:
repodata['gpgcheck'] = '1'
if module.params['autorefresh']:
repodata['autorefresh'] = '1'
repodata["gpgcheck"] = "1"
if module.params["autorefresh"]:
repodata["autorefresh"] = "1"
else:
repodata['autorefresh'] = '0'
repodata["autorefresh"] = "0"
def exit_unchanged():
module.exit_json(changed=False, repodata=repodata, state=state)
# Check run-time module parameters
if repo == '*' or alias == '*':
if repo == "*" or alias == "*":
if runrefresh:
runrefreshrepo(module, auto_import_keys)
module.exit_json(changed=False, runrefresh=True)
else:
module.fail_json(msg='repo=* can only be used with the runrefresh option.')
module.fail_json(msg="repo=* can only be used with the runrefresh option.")
if state == 'present' and not repo:
module.fail_json(msg='Module option state=present requires repo')
if state == 'absent' and not repo and not alias:
module.fail_json(msg='Alias or repo parameter required when state=absent')
if state == "present" and not repo:
module.fail_json(msg="Module option state=present requires repo")
if state == "absent" and not repo and not alias:
module.fail_json(msg="Alias or repo parameter required when state=absent")
if repo and repo.endswith('.repo'):
if repo and repo.endswith(".repo"):
if alias:
module.fail_json(msg='Incompatible option: \'name\'. Do not use name when adding .repo files')
module.fail_json(msg="Incompatible option: 'name'. Do not use name when adding .repo files")
else:
if not alias and state == "present":
module.fail_json(msg='Name required when adding non-repo files.')
module.fail_json(msg="Name required when adding non-repo files.")
# Download / Open and parse .repo file to ensure idempotency
if repo and repo.endswith('.repo'):
if repo.startswith(('http://', 'https://')):
if repo and repo.endswith(".repo"):
if repo.startswith(("http://", "https://")):
response, info = fetch_url(module=module, url=repo, force=True)
if not response or info['status'] != 200:
module.fail_json(msg='Error downloading .repo file from provided URL')
repofile_text = to_text(response.read(), errors='surrogate_or_strict')
if not response or info["status"] != 200:
module.fail_json(msg="Error downloading .repo file from provided URL")
repofile_text = to_text(response.read(), errors="surrogate_or_strict")
else:
try:
with open(repo, encoding='utf-8') as file:
with open(repo, encoding="utf-8") as file:
repofile_text = file.read()
except IOError:
module.fail_json(msg='Error opening .repo file from provided path')
module.fail_json(msg="Error opening .repo file from provided path")
repofile = configparser.ConfigParser()
try:
repofile.read_file(StringIO(repofile_text))
except configparser.Error:
module.fail_json(msg='Invalid format, .repo file could not be parsed')
module.fail_json(msg="Invalid format, .repo file could not be parsed")
# No support for .repo file with zero or more than one repository
if len(repofile.sections()) != 1:
@ -419,27 +420,27 @@ def main():
section = repofile.sections()[0]
repofile_items = dict(repofile.items(section))
# Only proceed if at least baseurl is available
if 'baseurl' not in repofile_items:
module.fail_json(msg='No baseurl found in .repo file')
if "baseurl" not in repofile_items:
module.fail_json(msg="No baseurl found in .repo file")
# Set alias (name) and url based on values from .repo file
alias = section
repodata['alias'] = section
repodata['url'] = repofile_items['baseurl']
repodata["alias"] = section
repodata["url"] = repofile_items["baseurl"]
# If gpgkey is part of the .repo file, auto import key
if 'gpgkey' in repofile_items:
if "gpgkey" in repofile_items:
auto_import_keys = True
# Map additional values, if available
if 'name' in repofile_items:
repodata['name'] = repofile_items['name']
if 'enabled' in repofile_items:
repodata['enabled'] = repofile_items['enabled']
if 'autorefresh' in repofile_items:
repodata['autorefresh'] = repofile_items['autorefresh']
if 'gpgcheck' in repofile_items:
repodata['gpgcheck'] = repofile_items['gpgcheck']
if "name" in repofile_items:
repodata["name"] = repofile_items["name"]
if "enabled" in repofile_items:
repodata["enabled"] = repofile_items["enabled"]
if "autorefresh" in repofile_items:
repodata["autorefresh"] = repofile_items["autorefresh"]
if "gpgcheck" in repofile_items:
repodata["gpgcheck"] = repofile_items["gpgcheck"]
exists, mod, old_repos = repo_exists(module, repodata, overwrite_multiple)
@ -448,7 +449,7 @@ def main():
else:
shortname = repo
if state == 'present':
if state == "present":
if exists and not mod:
if runrefresh:
runrefreshrepo(module, auto_import_keys, shortname)
@ -456,7 +457,7 @@ def main():
rc, stdout, stderr = addmodify_repo(module, repodata, old_repos, zypper_version)
if rc == 0 and (runrefresh or auto_import_keys):
runrefreshrepo(module, auto_import_keys, shortname)
elif state == 'absent':
elif state == "absent":
if not exists:
exit_unchanged()
rc, stdout, stderr = remove_repo(module, shortname)
@ -464,8 +465,10 @@ def main():
if rc == 0:
module.exit_json(changed=True, repodata=repodata, state=state)
else:
module.fail_json(msg=f"Zypper failed with rc {rc}", rc=rc, stdout=stdout, stderr=stderr, repodata=repodata, state=state)
module.fail_json(
msg=f"Zypper failed with rc {rc}", rc=rc, stdout=stdout, stderr=stderr, repodata=repodata, state=state
)
if __name__ == '__main__':
if __name__ == "__main__":
main()