Add package absent state

This commit is contained in:
Ammar Lakis
2025-08-15 22:39:38 +02:00
parent fe050018db
commit c348e578cb
2 changed files with 103 additions and 15 deletions

View File

@@ -67,7 +67,7 @@ The following helpers are supported and automatically selected, if present, in t
| Parameter | Choices/**Default** | Comments |
| -------------- | ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
| name | | Name or list of names of the package(s) to install or upgrade. |
| state | **present**, latest | Desired state of the package, 'present' skips operations if the package is already installed. |
| state | **present**, latest, absent | Desired state of the package, 'present' skips operations if the package is already installed. |
| upgrade | yes, **no** | Whether or not to upgrade whole system. |
| update_cache | yes, **no** | Whether or not to refresh the packages cache |
| use | **auto**, yay, paru, pacaur, trizen, pikaur, aurman, makepkg | The tool to use, 'auto' uses the first known helper found and makepkg as a fallback. |
@@ -167,4 +167,14 @@ Use it in a task, as in the following examples:
state: present
become: yes
become_user: aur_builder
```
# Remove AUR packages (state=absent)
- name: Remove package_name_1 and package_name_2 using yay
kewlfft.aur.aur:
use: yay
state: absent
name:
- package_name_1
- package_name_2
become: yes
become_user: aur_builder

View File

@@ -31,7 +31,7 @@ options:
description:
- Desired state of the package.
default: present
choices: [ present, latest ]
choices: [ present, latest, absent ]
upgrade:
description:
@@ -123,6 +123,15 @@ use_cmd_local_pkgbuild = {
'makepkg': ['makepkg', '--syncdeps', '--install', '--noconfirm', '--needed']
}
use_remove_cmd = {
'yay': ['yay', '-R', '--noconfirm'],
'paru': ['paru', '-R', '--noconfirm'],
'pacaur': ['pacaur', '-R', '--noconfirm'],
'trizen': ['trizen', '-R', '--noconfirm'],
'pikaur': ['pikaur', '-R', '--noconfirm'],
'aurman': ['aurman', '-R', '--noconfirm'],
}
has_aur_option = ['yay', 'paru', 'pacaur', 'trizen', 'pikaur', 'aurman']
@@ -156,6 +165,28 @@ def check_packages(module, packages):
module.exit_json(changed=status, msg=message, diff=diff)
def check_packages_absent(module, packages):
"""
Inform the user what would change if the module were run with state=absent
"""
would_be_changed = [package for package in packages if package_installed(module, package)]
diff = {'before': '\n'.join(pkg for pkg in would_be_changed if module._diff), 'after': ''}
if would_be_changed:
status = True
if len(packages) > 1:
message = '{} package(s) would be removed'.format(len(would_be_changed))
else:
message = 'package would be removed'
else:
status = False
if len(packages) > 1:
message = 'all packages are already absent'
else:
message = 'package is already absent'
module.exit_json(changed=status, msg=message, diff=diff)
def build_command_prefix(use, extra_args, skip_pgp_check=False, ignore_arch=False, aur_only=False, local_pkgbuild=None, update_cache=False):
"""
Create the prefix of a command that can be used by the install and upgrade functions.
@@ -283,6 +314,44 @@ def install_packages(module, packages, use, extra_args, state, skip_pgp_check, i
)
def remove_packages(module, packages, use, extra_args):
"""
Remove the specified packages
"""
# Determine the base command. If a helper other than makepkg is selected, use it.
# If use is 'makepkg' (which has no remove capability), fallback to pacman directly.
def base_remove_cmd(selected_use):
if selected_use == 'makepkg':
return def_lang + ['pacman', '-R', '--noconfirm'], 'pacman'
else:
assert selected_use in use_remove_cmd
return def_lang + use_remove_cmd[selected_use], selected_use
changed_iter = False
rc = 0
used_helper = use
for package in packages:
if not package_installed(module, package):
continue
command, helper = base_remove_cmd(use)
used_helper = helper
if extra_args:
command += shlex.split(extra_args)
command.append(package)
rc, out, err = module.run_command(command, check_rc=True)
changed_iter |= (rc == 0)
message = 'removed package(s)' if changed_iter else 'package(s) already absent'
module.exit_json(
changed=changed_iter,
msg=message if not rc else err,
helper=used_helper,
rc=rc,
)
def make_module():
module = AnsibleModule(
argument_spec={
@@ -291,7 +360,7 @@ def make_module():
},
'state': {
'default': 'present',
'choices': ['present', 'latest'],
'choices': ['present', 'latest', 'absent'],
},
'upgrade': {
'type': 'bool',
@@ -375,18 +444,27 @@ def apply_module(module, use):
upgrade(module, use, params['extra_args'], params['aur_only'], params['update_cache'])
else:
if module.check_mode:
check_packages(module, params['name'])
if params['state'] == 'absent':
check_packages_absent(module, params['name'])
else:
check_packages(module, params['name'])
else:
install_packages(module,
params['name'],
use,
params['extra_args'],
params['state'],
params['skip_pgp_check'],
params['ignore_arch'],
params['aur_only'],
params['local_pkgbuild'],
params['update_cache'])
if params['state'] == 'absent':
remove_packages(module,
params['name'],
use,
params['extra_args'])
else:
install_packages(module,
params['name'],
use,
params['extra_args'],
params['state'],
params['skip_pgp_check'],
params['ignore_arch'],
params['aur_only'],
params['local_pkgbuild'],
params['update_cache'])
def main():