mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-27 04:41:26 -07:00
[PR #5718/682bb4b8 backport][stable-6] opkg: refactor module to use StateModuleHelper and CmdRunner (#5824)
opkg: refactor module to use StateModuleHelper and CmdRunner (#5718)
* opkg: refactor module to use StateModuleHelper and CmdRunner
* add changelog fragment
* Update plugins/modules/opkg.py
Co-authored-by: joergho <48011876+joergho@users.noreply.github.com>
* Update plugins/modules/opkg.py
Co-authored-by: joergho <48011876+joergho@users.noreply.github.com>
* Update plugins/modules/opkg.py
Co-authored-by: joergho <48011876+joergho@users.noreply.github.com>
* Update plugins/modules/opkg.py
Co-authored-by: joergho <48011876+joergho@users.noreply.github.com>
* Update plugins/modules/opkg.py
Co-authored-by: joergho <48011876+joergho@users.noreply.github.com>
* Update plugins/modules/opkg.py
Co-authored-by: joergho <48011876+joergho@users.noreply.github.com>
* Update plugins/modules/opkg.py
Co-authored-by: joergho <48011876+joergho@users.noreply.github.com>
* generate message outcome as before
* aggregated changes from 5688
* fix package query
* add unit tests
* fix sanity error
* Update plugins/modules/opkg.py
Co-authored-by: joergho <48011876+joergho@users.noreply.github.com>
* add test for specifying version
* refactor parameter name
Co-authored-by: joergho <48011876+joergho@users.noreply.github.com>
(cherry picked from commit 682bb4b88a)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot]
GitHub
parent
3fd84d71b8
commit
82a9db9738
3 changed files with 280 additions and 123 deletions
|
|
@ -97,144 +97,106 @@ EXAMPLES = '''
|
|||
force: overwrite
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.six.moves import shlex_quote
|
||||
from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt
|
||||
from ansible_collections.community.general.plugins.module_utils.module_helper import StateModuleHelper
|
||||
|
||||
|
||||
def update_package_db(module, opkg_path):
|
||||
""" Updates packages list. """
|
||||
|
||||
rc, out, err = module.run_command([opkg_path, "update"])
|
||||
|
||||
if rc != 0:
|
||||
module.fail_json(msg="could not update package db")
|
||||
|
||||
|
||||
def query_package(module, opkg_path, name, version=None, state="present"):
|
||||
""" Returns whether a package is installed or not. """
|
||||
|
||||
if state == "present":
|
||||
rc, out, err = module.run_command([opkg_path, "list-installed", name])
|
||||
if rc != 0:
|
||||
return False
|
||||
# variable out is one line if the package is installed:
|
||||
# "NAME - VERSION - DESCRIPTION"
|
||||
if version is not None:
|
||||
if not out.startswith("%s - %s " % (name, version)):
|
||||
return False
|
||||
else:
|
||||
if not out.startswith(name + " "):
|
||||
return False
|
||||
return True
|
||||
else:
|
||||
raise NotImplementedError()
|
||||
|
||||
|
||||
def split_name_and_version(module, package):
|
||||
""" Split the name and the version when using the NAME=VERSION syntax """
|
||||
splitted = package.split('=', 1)
|
||||
if len(splitted) == 1:
|
||||
return splitted[0], None
|
||||
else:
|
||||
return splitted[0], splitted[1]
|
||||
|
||||
|
||||
def remove_packages(module, opkg_path, packages):
|
||||
""" Uninstalls one or more packages if installed. """
|
||||
|
||||
p = module.params
|
||||
force = p["force"]
|
||||
if force:
|
||||
force = "--force-%s" % force
|
||||
|
||||
remove_c = 0
|
||||
# Using a for loop in case of error, we can report the package that failed
|
||||
for package in packages:
|
||||
package, version = split_name_and_version(module, package)
|
||||
|
||||
# Query the package first, to see if we even need to remove
|
||||
if not query_package(module, opkg_path, package):
|
||||
continue
|
||||
|
||||
if force:
|
||||
rc, out, err = module.run_command([opkg_path, "remove", force, package])
|
||||
else:
|
||||
rc, out, err = module.run_command([opkg_path, "remove", package])
|
||||
|
||||
if query_package(module, opkg_path, package):
|
||||
module.fail_json(msg="failed to remove %s: %s" % (package, out))
|
||||
|
||||
remove_c += 1
|
||||
|
||||
if remove_c > 0:
|
||||
|
||||
module.exit_json(changed=True, msg="removed %s package(s)" % remove_c)
|
||||
|
||||
module.exit_json(changed=False, msg="package(s) already absent")
|
||||
|
||||
|
||||
def install_packages(module, opkg_path, packages):
|
||||
""" Installs one or more packages if not already installed. """
|
||||
|
||||
p = module.params
|
||||
force = p["force"]
|
||||
if force:
|
||||
force = "--force-%s" % force
|
||||
|
||||
install_c = 0
|
||||
|
||||
for package in packages:
|
||||
package, version = split_name_and_version(module, package)
|
||||
|
||||
if query_package(module, opkg_path, package, version) and (force != '--force-reinstall'):
|
||||
continue
|
||||
|
||||
if version is not None:
|
||||
version_str = "=%s" % version
|
||||
else:
|
||||
version_str = ""
|
||||
|
||||
if force:
|
||||
rc, out, err = module.run_command([opkg_path, "install", force, package + version_str])
|
||||
else:
|
||||
rc, out, err = module.run_command([opkg_path, "install", package + version_str])
|
||||
|
||||
if not query_package(module, opkg_path, package, version):
|
||||
module.fail_json(msg="failed to install %s%s: %s" % (package, version_str, out))
|
||||
|
||||
install_c += 1
|
||||
|
||||
if install_c > 0:
|
||||
module.exit_json(changed=True, msg="installed %s package(s)" % (install_c))
|
||||
|
||||
module.exit_json(changed=False, msg="package(s) already present")
|
||||
|
||||
|
||||
def main():
|
||||
module = AnsibleModule(
|
||||
class Opkg(StateModuleHelper):
|
||||
module = dict(
|
||||
argument_spec=dict(
|
||||
name=dict(aliases=["pkg"], required=True, type="list", elements="str"),
|
||||
state=dict(default="present", choices=["present", "installed", "absent", "removed"]),
|
||||
force=dict(default="", choices=["", "depends", "maintainer", "reinstall", "overwrite", "downgrade", "space", "postinstall", "remove",
|
||||
"checksum", "removal-of-dependent-packages"]),
|
||||
update_cache=dict(default=False, type='bool'),
|
||||
)
|
||||
),
|
||||
)
|
||||
|
||||
opkg_path = module.get_bin_path('opkg', True, ['/bin'])
|
||||
def __init_module__(self):
|
||||
self.vars.set("install_c", 0, output=False, change=True)
|
||||
self.vars.set("remove_c", 0, output=False, change=True)
|
||||
|
||||
p = module.params
|
||||
state_map = dict(
|
||||
query="list-installed",
|
||||
present="install",
|
||||
installed="install",
|
||||
absent="remove",
|
||||
removed="remove",
|
||||
)
|
||||
|
||||
if p["update_cache"]:
|
||||
update_package_db(module, opkg_path)
|
||||
def _force(value):
|
||||
if value == "":
|
||||
value = None
|
||||
return cmd_runner_fmt.as_optval("--force-")(value, ctx_ignore_none=True)
|
||||
|
||||
pkgs = p["name"]
|
||||
self.runner = CmdRunner(
|
||||
self.module,
|
||||
command="opkg",
|
||||
arg_formats=dict(
|
||||
package=cmd_runner_fmt.as_list(),
|
||||
state=cmd_runner_fmt.as_map(state_map),
|
||||
force=cmd_runner_fmt.as_func(_force),
|
||||
update_cache=cmd_runner_fmt.as_bool("update")
|
||||
),
|
||||
)
|
||||
|
||||
if p["state"] in ["present", "installed"]:
|
||||
install_packages(module, opkg_path, pkgs)
|
||||
@staticmethod
|
||||
def split_name_and_version(package):
|
||||
""" Split the name and the version when using the NAME=VERSION syntax """
|
||||
splitted = package.split('=', 1)
|
||||
if len(splitted) == 1:
|
||||
return splitted[0], None
|
||||
else:
|
||||
return splitted[0], splitted[1]
|
||||
|
||||
elif p["state"] in ["absent", "removed"]:
|
||||
remove_packages(module, opkg_path, pkgs)
|
||||
def _package_in_desired_state(self, name, want_installed, version=None):
|
||||
dummy, out, dummy = self.runner("state package").run(state="query", package=name)
|
||||
|
||||
has_package = out.startswith(name + " - %s" % ("" if not version else (version + " ")))
|
||||
return want_installed == has_package
|
||||
|
||||
def state_present(self):
|
||||
if self.vars.update_cache:
|
||||
dummy, rc, dummy = self.runner("update_cache").run()
|
||||
if rc != 0:
|
||||
self.do_raise("could not update package db")
|
||||
with self.runner("state force package") as ctx:
|
||||
for package in self.vars.name:
|
||||
pkg_name, pkg_version = self.split_name_and_version(package)
|
||||
if not self._package_in_desired_state(pkg_name, want_installed=True, version=pkg_version) or self.vars.force == "reinstall":
|
||||
ctx.run(package=package)
|
||||
if not self._package_in_desired_state(pkg_name, want_installed=True, version=pkg_version):
|
||||
self.do_raise("failed to install %s" % package)
|
||||
self.vars.install_c += 1
|
||||
if self.vars.install_c > 0:
|
||||
self.vars.msg = "installed %s package(s)" % (self.vars.install_c)
|
||||
else:
|
||||
self.vars.msg = "package(s) already present"
|
||||
|
||||
def state_absent(self):
|
||||
if self.vars.update_cache:
|
||||
dummy, rc, dummy = self.runner("update_cache").run()
|
||||
if rc != 0:
|
||||
self.do_raise("could not update package db")
|
||||
with self.runner("state force package") as ctx:
|
||||
for package in self.vars.name:
|
||||
package, dummy = self.split_name_and_version(package)
|
||||
if not self._package_in_desired_state(package, want_installed=False):
|
||||
ctx.run(package=package)
|
||||
if not self._package_in_desired_state(package, want_installed=False):
|
||||
self.do_raise("failed to remove %s" % package)
|
||||
self.vars.remove_c += 1
|
||||
if self.vars.remove_c > 0:
|
||||
self.vars.msg = "removed %s package(s)" % (self.vars.remove_c)
|
||||
else:
|
||||
self.vars.msg = "package(s) already absent"
|
||||
|
||||
state_installed = state_present
|
||||
state_removed = state_absent
|
||||
|
||||
|
||||
def main():
|
||||
Opkg.execute()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue