2020-03-09 10:11:07 +01:00
|
|
|
#!/usr/bin/python
|
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
|
|
|
|
# Copyright: (c) 2012, Afterburn <https://github.com/afterburn>
|
|
|
|
# Copyright: (c) 2013, Aaron Bull Schaefer <aaron@elasticdog.com>
|
|
|
|
# Copyright: (c) 2015, Indrajit Raychaudhuri <irc+code@indrajit.com>
|
2022-02-09 12:35:26 +01:00
|
|
|
# Copyright: (c) 2022, Jean Raby <jean@raby.sh>
|
2020-03-09 10:11:07 +01:00
|
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
|
|
|
|
from __future__ import absolute_import, division, print_function
|
2022-02-09 12:35:26 +01:00
|
|
|
|
2020-03-09 10:11:07 +01:00
|
|
|
__metaclass__ = type
|
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
DOCUMENTATION = """
|
2020-03-09 10:11:07 +01:00
|
|
|
---
|
|
|
|
module: pacman
|
|
|
|
short_description: Manage packages with I(pacman)
|
|
|
|
description:
|
|
|
|
- Manage packages with the I(pacman) package manager, which is used by Arch Linux and its variants.
|
|
|
|
author:
|
|
|
|
- Indrajit Raychaudhuri (@indrajitr)
|
|
|
|
- Aaron Bull Schaefer (@elasticdog) <aaron@elasticdog.com>
|
|
|
|
- Maxime de Roucy (@tchernomax)
|
2022-02-09 12:35:26 +01:00
|
|
|
- Jean Raby (@jraby)
|
2020-03-09 10:11:07 +01:00
|
|
|
options:
|
|
|
|
name:
|
|
|
|
description:
|
|
|
|
- Name or list of names of the package(s) or file(s) to install, upgrade, or remove.
|
|
|
|
Can't be used in combination with C(upgrade).
|
|
|
|
aliases: [ package, pkg ]
|
|
|
|
type: list
|
|
|
|
elements: str
|
|
|
|
|
|
|
|
state:
|
|
|
|
description:
|
2021-06-27 18:47:11 +02:00
|
|
|
- Whether to install (C(present) or C(installed), C(latest)), or remove (C(absent) or C(removed)) a package.
|
|
|
|
- C(present) and C(installed) will simply ensure that a desired package is installed.
|
|
|
|
- C(latest) will update the specified package if it is not of the latest available version.
|
|
|
|
- C(absent) and C(removed) will remove the specified package.
|
2020-03-09 10:11:07 +01:00
|
|
|
default: present
|
2021-06-27 18:47:11 +02:00
|
|
|
choices: [ absent, installed, latest, present, removed ]
|
2020-06-26 15:17:11 +02:00
|
|
|
type: str
|
2020-03-09 10:11:07 +01:00
|
|
|
|
|
|
|
force:
|
|
|
|
description:
|
2022-03-08 07:39:31 +01:00
|
|
|
- When removing packages, forcefully remove them, without any checks.
|
|
|
|
Same as C(extra_args="--nodeps --nodeps").
|
|
|
|
When combined with I(update_cache), force a refresh of all package databases.
|
|
|
|
Same as C(update_cache_extra_args="--refresh --refresh").
|
|
|
|
default: no
|
|
|
|
type: bool
|
|
|
|
|
|
|
|
remove_nosave:
|
|
|
|
description:
|
|
|
|
- When removing packages, do not save modified configuration files as C(.pacsave) files.
|
|
|
|
(passes C(--nosave) to pacman)
|
|
|
|
version_added: 4.6.0
|
2020-03-09 10:11:07 +01:00
|
|
|
default: no
|
|
|
|
type: bool
|
|
|
|
|
2021-05-18 12:59:11 +02:00
|
|
|
executable:
|
|
|
|
description:
|
2022-03-04 19:39:20 +01:00
|
|
|
- Path of the binary to use. This can either be C(pacman) or a pacman compatible AUR helper.
|
|
|
|
- Pacman compatibility is unfortunately ill defined, in particular, this modules makes
|
|
|
|
extensive use of the C(--print-format) directive which is known not to be implemented by
|
|
|
|
some AUR helpers (notably, C(yay)).
|
2021-05-18 12:59:11 +02:00
|
|
|
- Beware that AUR helpers might behave unexpectedly and are therefore not recommended.
|
|
|
|
default: pacman
|
|
|
|
type: str
|
|
|
|
version_added: 3.1.0
|
|
|
|
|
2020-03-09 10:11:07 +01:00
|
|
|
extra_args:
|
|
|
|
description:
|
|
|
|
- Additional option to pass to pacman when enforcing C(state).
|
|
|
|
default:
|
2020-06-26 15:17:11 +02:00
|
|
|
type: str
|
2020-03-09 10:11:07 +01:00
|
|
|
|
|
|
|
update_cache:
|
|
|
|
description:
|
|
|
|
- Whether or not to refresh the master package lists.
|
|
|
|
- This can be run as part of a package installation or as a separate step.
|
2021-03-05 08:17:36 +01:00
|
|
|
- Alias C(update-cache) has been deprecated and will be removed in community.general 5.0.0.
|
2022-02-09 12:35:26 +01:00
|
|
|
- If not specified, it defaults to C(false).
|
2022-03-11 07:15:41 +01:00
|
|
|
- Please note that this option will only have an influence on the module's C(changed) state
|
|
|
|
if I(name) and I(upgrade) are not specified. This will change in community.general 5.0.0.
|
2022-03-15 12:19:10 +01:00
|
|
|
See the examples for how to make the module behave as it will in 5.0.0 right now, or how
|
|
|
|
to keep the current behavior with 5.0.0 and later.
|
2020-03-09 10:11:07 +01:00
|
|
|
type: bool
|
|
|
|
aliases: [ update-cache ]
|
|
|
|
|
|
|
|
update_cache_extra_args:
|
|
|
|
description:
|
|
|
|
- Additional option to pass to pacman when enforcing C(update_cache).
|
|
|
|
default:
|
2020-06-26 15:17:11 +02:00
|
|
|
type: str
|
2020-03-09 10:11:07 +01:00
|
|
|
|
|
|
|
upgrade:
|
|
|
|
description:
|
|
|
|
- Whether or not to upgrade the whole system.
|
|
|
|
Can't be used in combination with C(name).
|
2022-02-09 12:35:26 +01:00
|
|
|
- If not specified, it defaults to C(false).
|
2020-03-09 10:11:07 +01:00
|
|
|
type: bool
|
|
|
|
|
|
|
|
upgrade_extra_args:
|
|
|
|
description:
|
|
|
|
- Additional option to pass to pacman when enforcing C(upgrade).
|
|
|
|
default:
|
2020-06-26 15:17:11 +02:00
|
|
|
type: str
|
2020-03-09 10:11:07 +01:00
|
|
|
|
|
|
|
notes:
|
2021-05-18 12:59:11 +02:00
|
|
|
- When used with a C(loop:) each package will be processed individually,
|
|
|
|
it is much more efficient to pass the list directly to the I(name) option.
|
|
|
|
- To use an AUR helper (I(executable) option), a few extra setup steps might be required beforehand.
|
|
|
|
For example, a dedicated build user with permissions to install packages could be necessary.
|
2022-02-09 12:35:26 +01:00
|
|
|
"""
|
2020-03-09 10:11:07 +01:00
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
RETURN = """
|
2020-03-09 10:11:07 +01:00
|
|
|
packages:
|
2022-03-11 07:15:41 +01:00
|
|
|
description:
|
|
|
|
- A list of packages that have been changed.
|
|
|
|
- Before community.general 4.5.0 this was only returned when I(upgrade=true).
|
|
|
|
In community.general 4.5.0, it was sometimes omitted when the package list is empty,
|
|
|
|
but since community.general 4.6.0 it is always returned when I(name) is specified or
|
|
|
|
I(upgrade=true).
|
|
|
|
returned: success and I(name) is specified or I(upgrade=true)
|
2020-03-09 10:11:07 +01:00
|
|
|
type: list
|
2022-03-11 07:15:41 +01:00
|
|
|
elements: str
|
2020-03-09 10:11:07 +01:00
|
|
|
sample: [ package, other-package ]
|
2021-11-22 20:01:50 +01:00
|
|
|
|
2022-03-15 06:04:58 +01:00
|
|
|
cache_updated:
|
|
|
|
description:
|
|
|
|
- The changed status of C(pacman -Sy).
|
|
|
|
- Useful when I(name) or I(upgrade=true) are specified next to I(update_cache=true).
|
|
|
|
returned: success, when I(update_cache=true)
|
|
|
|
type: bool
|
|
|
|
sample: false
|
|
|
|
version_added: 4.6.0
|
|
|
|
|
2021-11-22 20:01:50 +01:00
|
|
|
stdout:
|
2022-03-11 07:15:41 +01:00
|
|
|
description:
|
|
|
|
- Output from pacman.
|
2021-11-22 20:01:50 +01:00
|
|
|
returned: success, when needed
|
|
|
|
type: str
|
|
|
|
sample: ":: Synchronizing package databases... core is up to date :: Starting full system upgrade..."
|
|
|
|
version_added: 4.1.0
|
|
|
|
|
|
|
|
stderr:
|
2022-03-11 07:15:41 +01:00
|
|
|
description:
|
|
|
|
- Error output from pacman.
|
2021-11-22 20:01:50 +01:00
|
|
|
returned: success, when needed
|
|
|
|
type: str
|
|
|
|
sample: "warning: libtool: local (2.4.6+44+gb9b44533-14) is newer than core (2.4.6+42+gb88cebd5-15)\nwarning ..."
|
|
|
|
version_added: 4.1.0
|
2022-02-09 12:35:26 +01:00
|
|
|
"""
|
2020-03-09 10:11:07 +01:00
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
EXAMPLES = """
|
2020-03-09 10:11:07 +01:00
|
|
|
- name: Install package foo from repo
|
2020-07-13 21:50:31 +02:00
|
|
|
community.general.pacman:
|
2020-03-09 10:11:07 +01:00
|
|
|
name: foo
|
|
|
|
state: present
|
|
|
|
|
|
|
|
- name: Install package bar from file
|
2020-07-13 21:50:31 +02:00
|
|
|
community.general.pacman:
|
2020-03-09 10:11:07 +01:00
|
|
|
name: ~/bar-1.0-1-any.pkg.tar.xz
|
|
|
|
state: present
|
|
|
|
|
|
|
|
- name: Install package foo from repo and bar from file
|
2020-07-13 21:50:31 +02:00
|
|
|
community.general.pacman:
|
2020-03-09 10:11:07 +01:00
|
|
|
name:
|
|
|
|
- foo
|
|
|
|
- ~/bar-1.0-1-any.pkg.tar.xz
|
|
|
|
state: present
|
|
|
|
|
2021-05-18 12:59:11 +02:00
|
|
|
- name: Install package from AUR using a Pacman compatible AUR helper
|
|
|
|
community.general.pacman:
|
|
|
|
name: foo
|
|
|
|
state: present
|
|
|
|
executable: yay
|
|
|
|
extra_args: --builddir /var/cache/yay
|
|
|
|
|
2020-03-09 10:11:07 +01:00
|
|
|
- name: Upgrade package foo
|
2022-03-11 07:15:41 +01:00
|
|
|
# The 'changed' state of this call will only indicate whether foo was
|
|
|
|
# installed/upgraded, but not on whether the cache was updated. This
|
|
|
|
# will change in community.general 5.0.0!
|
2020-07-13 21:50:31 +02:00
|
|
|
community.general.pacman:
|
2020-03-09 10:11:07 +01:00
|
|
|
name: foo
|
|
|
|
state: latest
|
|
|
|
update_cache: yes
|
|
|
|
|
|
|
|
- name: Remove packages foo and bar
|
2020-07-13 21:50:31 +02:00
|
|
|
community.general.pacman:
|
2020-03-09 10:11:07 +01:00
|
|
|
name:
|
|
|
|
- foo
|
|
|
|
- bar
|
|
|
|
state: absent
|
|
|
|
|
|
|
|
- name: Recursively remove package baz
|
2020-07-13 21:50:31 +02:00
|
|
|
community.general.pacman:
|
2020-03-09 10:11:07 +01:00
|
|
|
name: baz
|
|
|
|
state: absent
|
|
|
|
extra_args: --recursive
|
|
|
|
|
|
|
|
- name: Run the equivalent of "pacman -Sy" as a separate step
|
2020-07-13 21:50:31 +02:00
|
|
|
community.general.pacman:
|
2020-03-09 10:11:07 +01:00
|
|
|
update_cache: yes
|
|
|
|
|
|
|
|
- name: Run the equivalent of "pacman -Su" as a separate step
|
2020-07-13 21:50:31 +02:00
|
|
|
community.general.pacman:
|
2020-03-09 10:11:07 +01:00
|
|
|
upgrade: yes
|
|
|
|
|
|
|
|
- name: Run the equivalent of "pacman -Syu" as a separate step
|
2022-03-11 07:15:41 +01:00
|
|
|
# The 'changed' state of this call will only indicate whether
|
|
|
|
# something was upgraded, but not on whether the cache was
|
|
|
|
# updated. This will change in community.general 5.0.0!
|
2022-03-15 12:19:10 +01:00
|
|
|
#
|
|
|
|
# To keep the old behavior, add the following to the task:
|
|
|
|
#
|
|
|
|
# register: result
|
|
|
|
# changed_when: result.packages | length > 0
|
|
|
|
#
|
|
|
|
# To already switch to the new behavior now, add:
|
|
|
|
#
|
|
|
|
# register: result
|
|
|
|
# changed_when: result is changed or result.cache_updated
|
|
|
|
#
|
|
|
|
# Note that both constructs only work with community.general 4.6.0+.
|
|
|
|
# For compatibility with older versions of community.general, you
|
|
|
|
# have to use
|
|
|
|
#
|
|
|
|
# changed_when: result.packages | default([]) | length > 0
|
|
|
|
#
|
|
|
|
# respectively
|
|
|
|
#
|
|
|
|
# changed_when: result is changed or (result.cache_updated | default(false))
|
2020-07-13 21:50:31 +02:00
|
|
|
community.general.pacman:
|
2020-03-09 10:11:07 +01:00
|
|
|
update_cache: yes
|
|
|
|
upgrade: yes
|
|
|
|
|
|
|
|
- name: Run the equivalent of "pacman -Rdd", force remove package baz
|
2020-07-13 21:50:31 +02:00
|
|
|
community.general.pacman:
|
2020-03-09 10:11:07 +01:00
|
|
|
name: baz
|
|
|
|
state: absent
|
|
|
|
force: yes
|
2022-02-09 12:35:26 +01:00
|
|
|
"""
|
2020-03-09 10:11:07 +01:00
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
import shlex
|
2020-03-09 10:11:07 +01:00
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
2022-02-09 12:35:26 +01:00
|
|
|
from collections import defaultdict, namedtuple
|
2020-03-09 10:11:07 +01:00
|
|
|
|
|
|
|
|
2022-03-01 06:34:27 +01:00
|
|
|
class Package(object):
|
|
|
|
def __init__(self, name, source, source_is_URL=False):
|
|
|
|
self.name = name
|
|
|
|
self.source = source
|
|
|
|
self.source_is_URL = source_is_URL
|
|
|
|
|
|
|
|
def __eq__(self, o):
|
|
|
|
return self.name == o.name and self.source == o.source and self.source_is_URL == o.source_is_URL
|
|
|
|
|
|
|
|
def __lt__(self, o):
|
|
|
|
return self.name < o.name
|
|
|
|
|
|
|
|
def __repr__(self):
|
|
|
|
return 'Package("%s", "%s", %s)' % (self.name, self.source, self.source_is_URL)
|
|
|
|
|
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
VersionTuple = namedtuple("VersionTuple", ["current", "latest"])
|
2020-03-09 10:11:07 +01:00
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
|
|
|
|
class Pacman(object):
|
|
|
|
def __init__(self, module):
|
|
|
|
self.m = module
|
|
|
|
|
|
|
|
self.m.run_command_environ_update = dict(LC_ALL="C")
|
|
|
|
p = self.m.params
|
|
|
|
|
|
|
|
self._msgs = []
|
|
|
|
self._stdouts = []
|
|
|
|
self._stderrs = []
|
|
|
|
self.changed = False
|
|
|
|
self.exit_params = {}
|
|
|
|
|
|
|
|
self.pacman_path = self.m.get_bin_path(p["executable"], True)
|
|
|
|
|
2022-03-15 06:04:58 +01:00
|
|
|
self._cached_database = None
|
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
# Normalize for old configs
|
|
|
|
if p["state"] == "installed":
|
|
|
|
self.target_state = "present"
|
|
|
|
elif p["state"] == "removed":
|
|
|
|
self.target_state = "absent"
|
2020-03-09 10:11:07 +01:00
|
|
|
else:
|
2022-02-09 12:35:26 +01:00
|
|
|
self.target_state = p["state"]
|
|
|
|
|
|
|
|
def add_exit_infos(self, msg=None, stdout=None, stderr=None):
|
|
|
|
if msg:
|
|
|
|
self._msgs.append(msg)
|
|
|
|
if stdout:
|
|
|
|
self._stdouts.append(stdout)
|
|
|
|
if stderr:
|
|
|
|
self._stderrs.append(stderr)
|
|
|
|
|
|
|
|
def _set_mandatory_exit_params(self):
|
|
|
|
msg = "\n".join(self._msgs)
|
|
|
|
stdouts = "\n".join(self._stdouts)
|
|
|
|
stderrs = "\n".join(self._stderrs)
|
|
|
|
if stdouts:
|
|
|
|
self.exit_params["stdout"] = stdouts
|
|
|
|
if stderrs:
|
|
|
|
self.exit_params["stderr"] = stderrs
|
|
|
|
self.exit_params["msg"] = msg # mandatory, but might be empty
|
|
|
|
|
|
|
|
def fail(self, msg=None, stdout=None, stderr=None, **kwargs):
|
|
|
|
self.add_exit_infos(msg, stdout, stderr)
|
|
|
|
self._set_mandatory_exit_params()
|
|
|
|
if kwargs:
|
|
|
|
self.exit_params.update(**kwargs)
|
|
|
|
self.m.fail_json(**self.exit_params)
|
|
|
|
|
|
|
|
def success(self):
|
|
|
|
self._set_mandatory_exit_params()
|
|
|
|
self.m.exit_json(changed=self.changed, **self.exit_params)
|
|
|
|
|
|
|
|
def run(self):
|
|
|
|
if self.m.params["update_cache"]:
|
|
|
|
self.update_package_db()
|
|
|
|
|
|
|
|
if not (self.m.params["name"] or self.m.params["upgrade"]):
|
|
|
|
self.success()
|
|
|
|
|
2022-03-06 22:57:22 +01:00
|
|
|
# Avoid shadowing lack of changes in the following stages
|
2022-03-11 07:15:41 +01:00
|
|
|
# so that `update_cache: true` doesn't always return changed
|
|
|
|
# TODO: remove this in community.general 5.0.0
|
2022-03-06 22:57:22 +01:00
|
|
|
self.changed = False
|
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
self.inventory = self._build_inventory()
|
|
|
|
if self.m.params["upgrade"]:
|
|
|
|
self.upgrade()
|
|
|
|
self.success()
|
|
|
|
|
|
|
|
if self.m.params["name"]:
|
|
|
|
pkgs = self.package_list()
|
|
|
|
|
|
|
|
if self.target_state == "absent":
|
|
|
|
self.remove_packages(pkgs)
|
|
|
|
self.success()
|
|
|
|
else:
|
|
|
|
self.install_packages(pkgs)
|
|
|
|
self.success()
|
|
|
|
|
|
|
|
# This shouldn't happen...
|
|
|
|
self.fail("This is a bug")
|
|
|
|
|
|
|
|
def install_packages(self, pkgs):
|
|
|
|
pkgs_to_install = []
|
2022-03-01 06:34:27 +01:00
|
|
|
pkgs_to_install_from_url = []
|
2022-02-09 12:35:26 +01:00
|
|
|
for p in pkgs:
|
2022-03-01 06:34:27 +01:00
|
|
|
if p.source_is_URL:
|
|
|
|
# URL packages bypass the latest / upgradable_pkgs test
|
|
|
|
# They go through the dry-run to let pacman decide if they will be installed
|
|
|
|
pkgs_to_install_from_url.append(p)
|
|
|
|
continue
|
2022-02-09 12:35:26 +01:00
|
|
|
if (
|
|
|
|
p.name not in self.inventory["installed_pkgs"]
|
|
|
|
or self.target_state == "latest"
|
|
|
|
and p.name in self.inventory["upgradable_pkgs"]
|
|
|
|
):
|
|
|
|
pkgs_to_install.append(p)
|
|
|
|
|
2022-03-01 06:34:27 +01:00
|
|
|
if len(pkgs_to_install) == 0 and len(pkgs_to_install_from_url) == 0:
|
2022-03-11 07:15:41 +01:00
|
|
|
self.exit_params["packages"] = []
|
2022-02-09 12:35:26 +01:00
|
|
|
self.add_exit_infos("package(s) already installed")
|
|
|
|
return
|
|
|
|
|
|
|
|
cmd_base = [
|
|
|
|
self.pacman_path,
|
|
|
|
"--noconfirm",
|
|
|
|
"--noprogressbar",
|
|
|
|
"--needed",
|
|
|
|
]
|
|
|
|
if self.m.params["extra_args"]:
|
|
|
|
cmd_base.extend(self.m.params["extra_args"])
|
|
|
|
|
2022-03-01 06:34:27 +01:00
|
|
|
def _build_install_diff(pacman_verb, pkglist):
|
|
|
|
# Dry run to build the installation diff
|
|
|
|
|
|
|
|
cmd = cmd_base + [pacman_verb, "--print-format", "%n %v"] + [p.source for p in pkglist]
|
|
|
|
rc, stdout, stderr = self.m.run_command(cmd, check_rc=False)
|
|
|
|
if rc != 0:
|
|
|
|
self.fail("Failed to list package(s) to install", cmd=cmd, stdout=stdout, stderr=stderr)
|
|
|
|
|
|
|
|
name_ver = [l.strip() for l in stdout.splitlines()]
|
|
|
|
before = []
|
|
|
|
after = []
|
|
|
|
to_be_installed = []
|
|
|
|
for p in name_ver:
|
|
|
|
# With Pacman v6.0.1 - libalpm v13.0.1, --upgrade outputs "loading packages..." on stdout. strip that.
|
|
|
|
# When installing from URLs, pacman can also output a 'nothing to do' message. strip that too.
|
2022-03-08 07:39:31 +01:00
|
|
|
if "loading packages" in p or "there is nothing to do" in p:
|
2022-03-01 06:34:27 +01:00
|
|
|
continue
|
|
|
|
name, version = p.split()
|
|
|
|
if name in self.inventory["installed_pkgs"]:
|
|
|
|
before.append("%s-%s" % (name, self.inventory["installed_pkgs"][name]))
|
|
|
|
after.append("%s-%s" % (name, version))
|
|
|
|
to_be_installed.append(name)
|
|
|
|
|
|
|
|
return (to_be_installed, before, after)
|
2022-02-09 12:35:26 +01:00
|
|
|
|
|
|
|
before = []
|
|
|
|
after = []
|
|
|
|
installed_pkgs = []
|
2022-03-01 06:34:27 +01:00
|
|
|
|
|
|
|
if pkgs_to_install:
|
|
|
|
p, b, a = _build_install_diff("--sync", pkgs_to_install)
|
|
|
|
installed_pkgs.extend(p)
|
|
|
|
before.extend(b)
|
|
|
|
after.extend(a)
|
|
|
|
if pkgs_to_install_from_url:
|
|
|
|
p, b, a = _build_install_diff("--upgrade", pkgs_to_install_from_url)
|
|
|
|
installed_pkgs.extend(p)
|
|
|
|
before.extend(b)
|
|
|
|
after.extend(a)
|
|
|
|
|
|
|
|
if len(installed_pkgs) == 0:
|
|
|
|
# This can happen with URL packages if pacman decides there's nothing to do
|
2022-03-11 07:15:41 +01:00
|
|
|
self.exit_params["packages"] = []
|
2022-03-01 06:34:27 +01:00
|
|
|
self.add_exit_infos("package(s) already installed")
|
|
|
|
return
|
|
|
|
|
|
|
|
self.changed = True
|
2022-02-09 12:35:26 +01:00
|
|
|
|
|
|
|
self.exit_params["diff"] = {
|
2022-03-01 06:34:27 +01:00
|
|
|
"before": "\n".join(sorted(before)) + "\n" if before else "",
|
|
|
|
"after": "\n".join(sorted(after)) + "\n" if after else "",
|
2022-02-09 12:35:26 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
if self.m.check_mode:
|
|
|
|
self.add_exit_infos("Would have installed %d packages" % len(installed_pkgs))
|
2022-03-01 06:34:27 +01:00
|
|
|
self.exit_params["packages"] = sorted(installed_pkgs)
|
2022-02-09 12:35:26 +01:00
|
|
|
return
|
|
|
|
|
|
|
|
# actually do it
|
2022-03-01 06:34:27 +01:00
|
|
|
def _install_packages_for_real(pacman_verb, pkglist):
|
|
|
|
cmd = cmd_base + [pacman_verb] + [p.source for p in pkglist]
|
|
|
|
rc, stdout, stderr = self.m.run_command(cmd, check_rc=False)
|
|
|
|
if rc != 0:
|
|
|
|
self.fail("Failed to install package(s)", cmd=cmd, stdout=stdout, stderr=stderr)
|
|
|
|
self.add_exit_infos(stdout=stdout, stderr=stderr)
|
2022-03-15 06:04:58 +01:00
|
|
|
self._invalidate_database()
|
2022-02-09 12:35:26 +01:00
|
|
|
|
2022-03-01 06:34:27 +01:00
|
|
|
if pkgs_to_install:
|
|
|
|
_install_packages_for_real("--sync", pkgs_to_install)
|
|
|
|
if pkgs_to_install_from_url:
|
|
|
|
_install_packages_for_real("--upgrade", pkgs_to_install_from_url)
|
2022-02-09 12:35:26 +01:00
|
|
|
|
|
|
|
self.exit_params["packages"] = installed_pkgs
|
2022-03-01 06:34:27 +01:00
|
|
|
self.add_exit_infos("Installed %d package(s)" % len(installed_pkgs))
|
2020-03-09 10:11:07 +01:00
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
def remove_packages(self, pkgs):
|
|
|
|
# filter out pkgs that are already absent
|
|
|
|
pkg_names_to_remove = [p.name for p in pkgs if p.name in self.inventory["installed_pkgs"]]
|
|
|
|
|
|
|
|
if len(pkg_names_to_remove) == 0:
|
2022-03-11 07:15:41 +01:00
|
|
|
self.exit_params["packages"] = []
|
2022-02-09 12:35:26 +01:00
|
|
|
self.add_exit_infos("package(s) already absent")
|
|
|
|
return
|
|
|
|
|
|
|
|
# There's something to do, set this in advance
|
|
|
|
self.changed = True
|
|
|
|
|
|
|
|
cmd_base = [self.pacman_path, "--remove", "--noconfirm", "--noprogressbar"]
|
2022-03-08 07:39:31 +01:00
|
|
|
cmd_base += self.m.params["extra_args"]
|
|
|
|
cmd_base += ["--nodeps", "--nodeps"] if self.m.params["force"] else []
|
|
|
|
# nosave_args conflicts with --print-format. Added later.
|
|
|
|
# https://github.com/ansible-collections/community.general/issues/4315
|
2022-02-09 12:35:26 +01:00
|
|
|
|
|
|
|
# This is a bit of a TOCTOU but it is better than parsing the output of
|
|
|
|
# pacman -R, which is different depending on the user config (VerbosePkgLists)
|
|
|
|
# Start by gathering what would be removed
|
|
|
|
cmd = cmd_base + ["--print-format", "%n-%v"] + pkg_names_to_remove
|
|
|
|
|
|
|
|
rc, stdout, stderr = self.m.run_command(cmd, check_rc=False)
|
2020-03-09 10:11:07 +01:00
|
|
|
if rc != 0:
|
2022-03-01 06:34:27 +01:00
|
|
|
self.fail("failed to list package(s) to remove", cmd=cmd, stdout=stdout, stderr=stderr)
|
2020-03-09 10:11:07 +01:00
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
removed_pkgs = stdout.split()
|
|
|
|
self.exit_params["packages"] = removed_pkgs
|
|
|
|
self.exit_params["diff"] = {
|
|
|
|
"before": "\n".join(removed_pkgs) + "\n", # trailing \n to avoid diff complaints
|
|
|
|
"after": "",
|
|
|
|
}
|
2020-03-09 10:11:07 +01:00
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
if self.m.check_mode:
|
|
|
|
self.exit_params["packages"] = removed_pkgs
|
|
|
|
self.add_exit_infos("Would have removed %d packages" % len(removed_pkgs))
|
|
|
|
return
|
2020-03-09 10:11:07 +01:00
|
|
|
|
2022-03-08 07:39:31 +01:00
|
|
|
nosave_args = ["--nosave"] if self.m.params["remove_nosave"] else []
|
|
|
|
cmd = cmd_base + nosave_args + pkg_names_to_remove
|
2020-03-09 10:11:07 +01:00
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
rc, stdout, stderr = self.m.run_command(cmd, check_rc=False)
|
2020-03-09 10:11:07 +01:00
|
|
|
if rc != 0:
|
2022-03-01 06:34:27 +01:00
|
|
|
self.fail("failed to remove package(s)", cmd=cmd, stdout=stdout, stderr=stderr)
|
2022-03-15 06:04:58 +01:00
|
|
|
self._invalidate_database()
|
2022-02-09 12:35:26 +01:00
|
|
|
self.exit_params["packages"] = removed_pkgs
|
|
|
|
self.add_exit_infos("Removed %d package(s)" % len(removed_pkgs), stdout=stdout, stderr=stderr)
|
|
|
|
|
|
|
|
def upgrade(self):
|
|
|
|
"""Runs pacman --sync --sysupgrade if there are upgradable packages"""
|
|
|
|
|
|
|
|
if len(self.inventory["upgradable_pkgs"]) == 0:
|
|
|
|
self.add_exit_infos("Nothing to upgrade")
|
|
|
|
return
|
|
|
|
|
|
|
|
self.changed = True # there are upgrades, so there will be changes
|
|
|
|
|
|
|
|
# Build diff based on inventory first.
|
|
|
|
diff = {"before": "", "after": ""}
|
|
|
|
for pkg, versions in self.inventory["upgradable_pkgs"].items():
|
|
|
|
diff["before"] += "%s-%s\n" % (pkg, versions.current)
|
|
|
|
diff["after"] += "%s-%s\n" % (pkg, versions.latest)
|
|
|
|
self.exit_params["diff"] = diff
|
|
|
|
self.exit_params["packages"] = self.inventory["upgradable_pkgs"].keys()
|
|
|
|
|
|
|
|
if self.m.check_mode:
|
|
|
|
self.add_exit_infos(
|
|
|
|
"%d packages would have been upgraded" % (len(self.inventory["upgradable_pkgs"]))
|
|
|
|
)
|
|
|
|
else:
|
|
|
|
cmd = [
|
|
|
|
self.pacman_path,
|
|
|
|
"--sync",
|
2022-02-23 18:01:06 +01:00
|
|
|
"--sysupgrade",
|
2022-02-09 12:35:26 +01:00
|
|
|
"--quiet",
|
|
|
|
"--noconfirm",
|
|
|
|
]
|
|
|
|
if self.m.params["upgrade_extra_args"]:
|
|
|
|
cmd += self.m.params["upgrade_extra_args"]
|
|
|
|
rc, stdout, stderr = self.m.run_command(cmd, check_rc=False)
|
2022-03-15 06:04:58 +01:00
|
|
|
self._invalidate_database()
|
2022-02-09 12:35:26 +01:00
|
|
|
if rc == 0:
|
|
|
|
self.add_exit_infos("System upgraded", stdout=stdout, stderr=stderr)
|
2020-03-09 10:11:07 +01:00
|
|
|
else:
|
2022-03-01 06:34:27 +01:00
|
|
|
self.fail("Could not upgrade", cmd=cmd, stdout=stdout, stderr=stderr)
|
2020-03-09 10:11:07 +01:00
|
|
|
|
2022-03-15 06:04:58 +01:00
|
|
|
def _list_database(self):
|
|
|
|
"""runs pacman --sync --list with some caching"""
|
|
|
|
if self._cached_database is None:
|
|
|
|
dummy, packages, dummy = self.m.run_command([self.pacman_path, '--sync', '--list'], check_rc=True)
|
|
|
|
self._cached_database = packages.splitlines()
|
|
|
|
return self._cached_database
|
|
|
|
|
|
|
|
def _invalidate_database(self):
|
|
|
|
"""invalidates the pacman --sync --list cache"""
|
|
|
|
self._cached_database = None
|
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
def update_package_db(self):
|
|
|
|
"""runs pacman --sync --refresh"""
|
|
|
|
if self.m.check_mode:
|
|
|
|
self.add_exit_infos("Would have updated the package db")
|
|
|
|
self.changed = True
|
2022-03-15 06:04:58 +01:00
|
|
|
self.exit_params["cache_updated"] = True
|
2022-02-09 12:35:26 +01:00
|
|
|
return
|
2020-03-09 10:11:07 +01:00
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
cmd = [
|
|
|
|
self.pacman_path,
|
|
|
|
"--sync",
|
|
|
|
"--refresh",
|
|
|
|
]
|
|
|
|
if self.m.params["update_cache_extra_args"]:
|
|
|
|
cmd += self.m.params["update_cache_extra_args"]
|
|
|
|
if self.m.params["force"]:
|
|
|
|
cmd += ["--refresh"]
|
2022-03-15 06:04:58 +01:00
|
|
|
else:
|
|
|
|
# Dump package database to get contents before update
|
|
|
|
pre_state = sorted(self._list_database())
|
2020-03-09 10:11:07 +01:00
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
rc, stdout, stderr = self.m.run_command(cmd, check_rc=False)
|
2022-03-15 06:04:58 +01:00
|
|
|
self._invalidate_database()
|
2022-02-09 12:35:26 +01:00
|
|
|
|
2022-03-15 06:04:58 +01:00
|
|
|
if self.m.params["force"]:
|
|
|
|
# Always changed when force=true
|
|
|
|
self.exit_params["cache_updated"] = True
|
|
|
|
else:
|
|
|
|
# Dump package database to get contents after update
|
|
|
|
post_state = sorted(self._list_database())
|
|
|
|
# If contents changed, set changed=true
|
|
|
|
self.exit_params["cache_updated"] = pre_state != post_state
|
|
|
|
if self.exit_params["cache_updated"]:
|
|
|
|
self.changed = True
|
2022-02-09 12:35:26 +01:00
|
|
|
|
|
|
|
if rc == 0:
|
|
|
|
self.add_exit_infos("Updated package db", stdout=stdout, stderr=stderr)
|
|
|
|
else:
|
2022-03-01 06:34:27 +01:00
|
|
|
self.fail("could not update package db", cmd=cmd, stdout=stdout, stderr=stderr)
|
2022-02-09 12:35:26 +01:00
|
|
|
|
|
|
|
def package_list(self):
|
|
|
|
"""Takes the input package list and resolves packages groups to their package list using the inventory,
|
|
|
|
extracts package names from packages given as files or URLs using calls to pacman
|
|
|
|
|
|
|
|
Returns the expanded/resolved list as a list of Package
|
|
|
|
"""
|
|
|
|
pkg_list = []
|
|
|
|
for pkg in self.m.params["name"]:
|
|
|
|
if not pkg:
|
|
|
|
continue
|
|
|
|
|
2022-03-01 06:34:27 +01:00
|
|
|
is_URL = False
|
2022-02-09 12:35:26 +01:00
|
|
|
if pkg in self.inventory["available_groups"]:
|
|
|
|
# Expand group members
|
|
|
|
for group_member in self.inventory["available_groups"][pkg]:
|
|
|
|
pkg_list.append(Package(name=group_member, source=group_member))
|
|
|
|
elif pkg in self.inventory["available_pkgs"]:
|
|
|
|
# just a regular pkg
|
|
|
|
pkg_list.append(Package(name=pkg, source=pkg))
|
|
|
|
else:
|
|
|
|
# Last resort, call out to pacman to extract the info,
|
|
|
|
# pkg is possibly in the <repo>/<pkgname> format, or a filename or a URL
|
|
|
|
|
|
|
|
# Start with <repo>/<pkgname> case
|
|
|
|
cmd = [self.pacman_path, "--sync", "--print-format", "%n", pkg]
|
|
|
|
rc, stdout, stderr = self.m.run_command(cmd, check_rc=False)
|
|
|
|
if rc != 0:
|
|
|
|
# fallback to filename / URL
|
|
|
|
cmd = [self.pacman_path, "--upgrade", "--print-format", "%n", pkg]
|
|
|
|
rc, stdout, stderr = self.m.run_command(cmd, check_rc=False)
|
|
|
|
if rc != 0:
|
|
|
|
if self.target_state == "absent":
|
|
|
|
continue # Don't bark for unavailable packages when trying to remove them
|
|
|
|
else:
|
|
|
|
self.fail(
|
|
|
|
msg="Failed to list package %s" % (pkg),
|
|
|
|
cmd=cmd,
|
|
|
|
stdout=stdout,
|
|
|
|
stderr=stderr,
|
|
|
|
rc=rc,
|
|
|
|
)
|
2022-03-01 06:34:27 +01:00
|
|
|
# With Pacman v6.0.1 - libalpm v13.0.1, --upgrade outputs "loading packages..." on stdout. strip that
|
|
|
|
stdout = stdout.replace("loading packages...\n", "")
|
|
|
|
is_URL = True
|
2022-02-09 12:35:26 +01:00
|
|
|
pkg_name = stdout.strip()
|
2022-03-01 06:34:27 +01:00
|
|
|
pkg_list.append(Package(name=pkg_name, source=pkg, source_is_URL=is_URL))
|
2022-02-09 12:35:26 +01:00
|
|
|
|
|
|
|
return pkg_list
|
|
|
|
|
|
|
|
def _build_inventory(self):
|
|
|
|
"""Build a cache datastructure used for all pkg lookups
|
|
|
|
Returns a dict:
|
|
|
|
{
|
|
|
|
"installed_pkgs": {pkgname: version},
|
|
|
|
"installed_groups": {groupname: set(pkgnames)},
|
|
|
|
"available_pkgs": {pkgname: version},
|
|
|
|
"available_groups": {groupname: set(pkgnames)},
|
|
|
|
"upgradable_pkgs": {pkgname: (current_version,latest_version)},
|
|
|
|
}
|
|
|
|
|
|
|
|
Fails the module if a package requested for install cannot be found
|
|
|
|
"""
|
|
|
|
|
|
|
|
installed_pkgs = {}
|
|
|
|
dummy, stdout, dummy = self.m.run_command([self.pacman_path, "--query"], check_rc=True)
|
|
|
|
# Format of a line: "pacman 6.0.1-2"
|
|
|
|
for l in stdout.splitlines():
|
|
|
|
l = l.strip()
|
|
|
|
if not l:
|
|
|
|
continue
|
|
|
|
pkg, ver = l.split()
|
|
|
|
installed_pkgs[pkg] = ver
|
|
|
|
|
|
|
|
installed_groups = defaultdict(set)
|
|
|
|
dummy, stdout, dummy = self.m.run_command(
|
2022-03-04 19:39:20 +01:00
|
|
|
[self.pacman_path, "--query", "--groups"], check_rc=True
|
2022-02-09 12:35:26 +01:00
|
|
|
)
|
|
|
|
# Format of lines:
|
|
|
|
# base-devel file
|
|
|
|
# base-devel findutils
|
|
|
|
# ...
|
|
|
|
for l in stdout.splitlines():
|
|
|
|
l = l.strip()
|
|
|
|
if not l:
|
|
|
|
continue
|
|
|
|
group, pkgname = l.split()
|
|
|
|
installed_groups[group].add(pkgname)
|
|
|
|
|
|
|
|
available_pkgs = {}
|
2022-03-15 06:04:58 +01:00
|
|
|
database = self._list_database()
|
2022-02-09 12:35:26 +01:00
|
|
|
# Format of a line: "core pacman 6.0.1-2"
|
2022-03-15 06:04:58 +01:00
|
|
|
for l in database:
|
2022-02-09 12:35:26 +01:00
|
|
|
l = l.strip()
|
|
|
|
if not l:
|
|
|
|
continue
|
|
|
|
repo, pkg, ver = l.split()[:3]
|
|
|
|
available_pkgs[pkg] = ver
|
|
|
|
|
|
|
|
available_groups = defaultdict(set)
|
|
|
|
dummy, stdout, dummy = self.m.run_command(
|
2022-03-04 19:39:20 +01:00
|
|
|
[self.pacman_path, "--sync", "--groups", "--groups"], check_rc=True
|
2022-02-09 12:35:26 +01:00
|
|
|
)
|
|
|
|
# Format of lines:
|
|
|
|
# vim-plugins vim-airline
|
|
|
|
# vim-plugins vim-airline-themes
|
|
|
|
# vim-plugins vim-ale
|
|
|
|
# ...
|
|
|
|
for l in stdout.splitlines():
|
|
|
|
l = l.strip()
|
|
|
|
if not l:
|
|
|
|
continue
|
|
|
|
group, pkg = l.split()
|
|
|
|
available_groups[group].add(pkg)
|
|
|
|
|
|
|
|
upgradable_pkgs = {}
|
|
|
|
rc, stdout, stderr = self.m.run_command(
|
|
|
|
[self.pacman_path, "--query", "--upgrades"], check_rc=False
|
|
|
|
)
|
|
|
|
|
|
|
|
# non-zero exit with nothing in stdout -> nothing to upgrade, all good
|
|
|
|
# stderr can have warnings, so not checked here
|
|
|
|
if rc == 1 and stdout == "":
|
|
|
|
pass # nothing to upgrade
|
|
|
|
elif rc == 0:
|
|
|
|
# Format of lines:
|
|
|
|
# strace 5.14-1 -> 5.15-1
|
|
|
|
# systemd 249.7-1 -> 249.7-2 [ignored]
|
|
|
|
for l in stdout.splitlines():
|
|
|
|
l = l.strip()
|
|
|
|
if not l:
|
|
|
|
continue
|
|
|
|
if "[ignored]" in l:
|
|
|
|
continue
|
|
|
|
s = l.split()
|
|
|
|
if len(s) != 4:
|
|
|
|
self.fail(msg="Invalid line: %s" % l)
|
|
|
|
|
|
|
|
pkg = s[0]
|
|
|
|
current = s[1]
|
|
|
|
latest = s[3]
|
|
|
|
upgradable_pkgs[pkg] = VersionTuple(current=current, latest=latest)
|
|
|
|
else:
|
|
|
|
# stuff in stdout but rc!=0, abort
|
|
|
|
self.fail(
|
|
|
|
"Couldn't get list of packages available for upgrade",
|
|
|
|
stdout=stdout,
|
|
|
|
stderr=stderr,
|
|
|
|
rc=rc,
|
|
|
|
)
|
|
|
|
|
|
|
|
return dict(
|
|
|
|
installed_pkgs=installed_pkgs,
|
|
|
|
installed_groups=installed_groups,
|
|
|
|
available_pkgs=available_pkgs,
|
|
|
|
available_groups=available_groups,
|
|
|
|
upgradable_pkgs=upgradable_pkgs,
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
def setup_module():
|
2020-03-09 10:11:07 +01:00
|
|
|
module = AnsibleModule(
|
|
|
|
argument_spec=dict(
|
2022-02-09 12:35:26 +01:00
|
|
|
name=dict(type="list", elements="str", aliases=["pkg", "package"]),
|
|
|
|
state=dict(
|
|
|
|
type="str",
|
|
|
|
default="present",
|
|
|
|
choices=["present", "installed", "latest", "absent", "removed"],
|
|
|
|
),
|
|
|
|
force=dict(type="bool", default=False),
|
2022-03-08 07:39:31 +01:00
|
|
|
remove_nosave=dict(type="bool", default=False),
|
2022-02-09 12:35:26 +01:00
|
|
|
executable=dict(type="str", default="pacman"),
|
|
|
|
extra_args=dict(type="str", default=""),
|
|
|
|
upgrade=dict(type="bool"),
|
|
|
|
upgrade_extra_args=dict(type="str", default=""),
|
2021-03-05 08:17:36 +01:00
|
|
|
update_cache=dict(
|
2022-02-09 12:35:26 +01:00
|
|
|
type="bool",
|
|
|
|
aliases=["update-cache"],
|
|
|
|
deprecated_aliases=[
|
|
|
|
dict(
|
|
|
|
name="update-cache",
|
|
|
|
version="5.0.0",
|
|
|
|
collection_name="community.general",
|
|
|
|
)
|
|
|
|
],
|
|
|
|
),
|
|
|
|
update_cache_extra_args=dict(type="str", default=""),
|
2020-03-09 10:11:07 +01:00
|
|
|
),
|
2022-02-09 12:35:26 +01:00
|
|
|
required_one_of=[["name", "update_cache", "upgrade"]],
|
|
|
|
mutually_exclusive=[["name", "upgrade"]],
|
2020-03-09 10:11:07 +01:00
|
|
|
supports_check_mode=True,
|
|
|
|
)
|
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
# Split extra_args as the shell would for easier handling later
|
|
|
|
for str_args in ["extra_args", "upgrade_extra_args", "update_cache_extra_args"]:
|
|
|
|
module.params[str_args] = shlex.split(module.params[str_args])
|
2020-03-09 10:11:07 +01:00
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
return module
|
2020-03-09 10:11:07 +01:00
|
|
|
|
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
def main():
|
2020-03-09 10:11:07 +01:00
|
|
|
|
2022-02-09 12:35:26 +01:00
|
|
|
Pacman(setup_module()).run()
|
2020-03-09 10:11:07 +01:00
|
|
|
|
|
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
main()
|