Update galaxy.yml

Add installed and updated packages to output

.github/workflows/galaxy.yml

@@ -25,10 +25,10 @@ jobs:
           [ "$(cat galaxy.yml | grep version: | awk '{print $2}')" = $(awk -F '/' '{print substr($3, 2)}' <<< ${GITHUB_REF}) ] || exit 1
           echo ::set-output name=version::$(awk -F '/' '{print substr($3, 2)}' <<< ${GITHUB_REF})
 
-      - name: "Set up Python 3.9"
+      - name: "Set up Python"
         uses: actions/setup-python@v2
         with:
-          python-version: "3.9"
+          python-version: "3.11"
 
       - name: Generate cache keys
         id: keys

README.md

@@ -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

galaxy.yml

@@ -8,7 +8,7 @@ namespace: kewlfft
 name: aur
 
 # The version of the collection. Must be compatible with semantic versioning
-version: 0.10.0
+version: 0.12.0
 
 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection
 readme: README.md

plugins/modules/aur.py

@@ -31,7 +31,7 @@ options:
         description:
             - Desired state of the package.
         default: present
-        choices: [ present, latest ]
+        choices: [ present, latest, absent ]
 
     upgrade:
         description:
@@ -97,6 +97,14 @@ msg:
     description: action that has been taken
 helper:
     description: the helper that was actually used
+installed:
+    description: list of packages that were newly installed
+    returned: always
+    type: list
+updated:
+    description: list of packages that were upgraded
+    returned: always
+    type: list
 '''
 
 EXAMPLES = '''
@@ -123,6 +131,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 +173,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.
@@ -256,10 +295,12 @@ def install_packages(module, packages, use, extra_args, state, skip_pgp_check, i
     else:
         assert use in use_cmd
 
-    changed_iter = False
+    installed_pkgs = []
+    updated_pkgs = []
 
     for package in packages:
-        if state == 'present' and package_installed(module, package):
+        was_installed = package_installed(module, package)
+        if state == 'present' and was_installed:
             rc = 0
             continue
         if use == 'makepkg':
@@ -271,7 +312,14 @@ def install_packages(module, packages, use, extra_args, state, skip_pgp_check, i
             command.append(package)
             rc, out, err = module.run_command(command, check_rc=True)
 
-        changed_iter |= not (out == '' or 'up-to-date -- skipping' in out or 'nothing to do' in out.lower())
+        changed_pkg = not (out == '' or 'up-to-date -- skipping' in out or 'nothing to do' in out.lower())
+        if changed_pkg:
+            if was_installed:
+                updated_pkgs.append(package)
+            else:
+                installed_pkgs.append(package)
+
+    changed_iter = bool(installed_pkgs or updated_pkgs)
 
     message = 'installed package(s)' if changed_iter else 'package(s) already installed'
 
@@ -280,6 +328,46 @@ def install_packages(module, packages, use, extra_args, state, skip_pgp_check, i
         msg=message if not rc else err,
         helper=use,
         rc=rc,
+        installed=installed_pkgs,
+        updated=updated_pkgs,
+    )
+
+
+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,
     )
 
 
@@ -291,7 +379,7 @@ def make_module():
             },
             'state': {
                 'default': 'present',
-                'choices': ['present', 'latest'],
+                'choices': ['present', 'latest', 'absent'],
             },
             'upgrade': {
                 'type': 'bool',
@@ -375,18 +463,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,
+            if params['state'] == 'absent':
-                             params['name'],
+                remove_packages(module,
-                             use,
+                                params['name'],
-                             params['extra_args'],
+                                use,
-                             params['state'],
+                                params['extra_args'])
-                             params['skip_pgp_check'],
+            else:
-                             params['ignore_arch'],
+                install_packages(module,
-                             params['aur_only'],
+                                 params['name'],
-                             params['local_pkgbuild'],
+                                 use,
-                             params['update_cache'])
+                                 params['extra_args'],
+                                 params['state'],
+                                 params['skip_pgp_check'],
+                                 params['ignore_arch'],
+                                 params['aur_only'],
+                                 params['local_pkgbuild'],
+                                 params['update_cache'])
 
 
 def main():