Merge pull request #25 from hvariant/fix-package-name-quote

fix quoting of package name

README.md

@@ -1,15 +1,14 @@
 # Ansible AUR helper
 Ansible module to use some Arch User Repository (AUR) helpers as well as makepkg.
 
-The following helpers are supported and automatically selected in the order they are listed:
+The following helpers are supported and automatically selected, if present, in the order listed below:
+- [yay](https://github.com/Jguer/yay)
 - [aurman](https://github.com/polygamma/aurman)
 - [pacaur](https://github.com/rmarquis/pacaur)
 - [trizen](https://github.com/trizen/trizen)
 - [pikaur](https://github.com/actionless/pikaur)
-- [yaourt](https://github.com/archlinuxfr/yaourt)
-- [yay](https://github.com/Jguer/yay)
 
-makepkg will be used if no helper was found or if it's specified explicitly.
+*makepkg* will be used if no helper was found or if it is explicitly specified:
 - [makepkg](https://wiki.archlinux.org/index.php/makepkg)
 
 ## Options
@@ -17,9 +16,10 @@ makepkg will be used if no helper was found or if it's specified explicitly.
 |---            |---      |---     |---                                                |---|
 |name           |no       |        |                                                   |Name or list of names of the package(s) to install or upgrade.|
 |upgrade        |no       |no      |yes, no                                            |Whether or not to upgrade whole system.|
-|use            |no       |auto    |auto, aurman, pacaur, trizen, pikaur, yaourt, yay, makepkg  |The helper to use, 'auto' uses the first known helper found and makepkg as a fallback.|
+|use            |no       |auto    |auto, yay, aurman, pacaur, trizen, pikaur, makepkg |The helper to use, 'auto' uses the first known helper found and makepkg as a fallback.|
 |skip_installed |no       |no      |yes, no                                            |Skip operations if the package is present.|
 |skip_pgp_check |no       |no      |yes, no                                            |Skip verification of PGP signatures. This is useful when installing packages on a host without GnuPG (properly) configured. Only valid with makepkg.|
+|aur_only       |no       |no      |yes, no                                            |Limit operation to the AUR. Compatible with yay, aurman, pacaur and trizen.|
 
 ### Note
 * Either *name* or *upgrade* is required, both cannot be used together.
@@ -27,22 +27,20 @@ makepkg will be used if no helper was found or if it's specified explicitly.
 * In the *use*=*auto* mode, makepkg is used as a fallback if no known helper is found.
 
 ## Installing
-1. Clone the *ansibe-aur* repository in your playbook custom-module directory:
-```
-mkdir --parents library
-cd library
-git clone git@github.com:kewlfft/ansible-aur.git
-```
+### AUR package
+The [ansible-aur-git](https://aur.archlinux.org/packages/ansible-aur-git) package is available in the AUR.
+Note the module is installed in `/usr/share/ansible/plugins/modules` which is one of the default module library paths.
 
-2. Link the script to `library/aur`:
+### Manual installation
+Just clone the *ansible-aur* repository into your user custom-module directory:
 ```
-ln --symbolic ansible-aur/aur.py aur
+git clone https://github.com/kewlfft/ansible-aur.git ~/.ansible/plugins/modules/aur
 ```
 
 ## Usage
-### Note
-* This module aims to cover the AUR, for package removal or system upgrade with the repositories, it is recommended to use the official *pacman* module,
-* A package is reinstalled only if an update is available, using the *--needed* parameter, except for *yay* which does not support it and systematically reinstalls.
+### Notes
+* This module aims to cover the AUR; for package removal or system upgrade with the repositories, it is recommended to use the official *pacman* module.
+* The *--needed* parameter of the helper is systematically used, it means if a package is up to date, it is not built and reinstalled.
 
 ### Examples
 Use it in a task, as in the following examples:
@@ -70,7 +68,7 @@ Use it in a task, as in the following examples:
 ```
 
 ### Create the "aur_builder" user
-While Ansible expects to SSH as root, AUR helpers do not allow executing operations as root, they all fail with "you cannot perform this operation as root". It is therefore recommended to create a user, that we will call for example *aur_builder*, that has no need for password with pacman in sudoers.
+While Ansible expects to SSH as root, AUR helpers do not allow executing operations as root, they all fail with "you cannot perform this operation as root". It is therefore recommended to create a user, let's call it *aur_builder*, that has no need for password with pacman in sudoers.
 This can be done in Ansible with the following actions:
 ```
 - user:

aur.py

@@ -1,4 +1,6 @@
-#!/usr/bin/env python
+#!/usr/bin/python
+
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 from ansible.module_utils.basic import *
 from ansible.module_utils.urls import open_url
@@ -7,20 +9,83 @@ import tarfile
 import os
 import os.path
 import tempfile
+import urllib.parse
+
+
+DOCUMENTATION = '''
+---
+module: aur
+short_description: Manage packages from the AUR
+description:
+    - Manage packages from the Arch User Repository (AUR)
+author:
+    - Kewl <xrjy@nygb.rh.bet(rot13)>
+options:
+    name:
+        description:
+            - Name or list of names of the package(s) to install or upgrade.
+
+    upgrade:
+        description:
+            - Whether or not to upgrade whole system.
+        type: bool
+        default: no
+
+    use:
+        description:
+            - The helper to use, 'auto' uses the first known helper found and makepkg as a fallback.
+        default: auto
+        choices: [ auto, yay, aurman, pacaur, trizen, pikaur, makepkg ]
+
+    skip_installed:
+        description:
+            - Skip operations if the package is present.
+        type: bool
+        default: no
+
+    skip_pgp_check:
+        description:
+            - Skip verification of PGP signatures.
+              This is useful when installing packages on a host without GnuPG (properly) configured.
+              Only valid with makepkg.
+        type: bool
+        default: no
+
+    aur_only:
+        description:
+            - Limit operation to the AUR. Compatible with yay, aurman, pacaur and trizen.
+notes:
+  - When used with a `loop:` each package will be processed individually,
+    it is much more efficient to pass the list directly to the `name` option.
+'''
+
+RETURN = '''
+msg:
+    description: action that has been taken
+helper:
+    the helper that was actually used
+'''
+
+EXAMPLES = '''
+- name: Install trizen using makepkg, skip if trizen is already installed
+  aur: name=trizen use=makepkg skip_installed=true
+  become: yes
+  become_user: aur_builder
+'''
 
 
 def_lang = ['env', 'LC_ALL=C']
 
 use_cmd = {
-    'aurman': ['aurman', '-S', '--noconfirm', '--noedit', '--needed'],
+    'yay': ['yay', '-S', '--noconfirm', '--needed', '--cleanafter'],
+    'aurman': ['aurman', '-S', '--noconfirm', '--noedit', '--needed', '--skip_news', '--pgp_fetch', '--skip_new_locations'],
     'pacaur': ['pacaur', '-S', '--noconfirm', '--noedit', '--needed'],
     'trizen': ['trizen', '-S', '--noconfirm', '--noedit', '--needed'],
     'pikaur': ['pikaur', '-S', '--noconfirm', '--noedit', '--needed'],
-    'yaourt': ['yaourt', '-S', '--noconfirm', '--needed'],
-    'yay': ['yay', '-S', '--noconfirm'],
     'makepkg': ['makepkg', '--syncdeps', '--install', '--noconfirm', '--needed']
 }
-# optional: aurman, pacaur, trizen have a --aur option, do things only for aur
+
+has_aur_option = ['yay', 'aurman', 'pacaur', 'trizen']
 
 
 def package_installed(module, package):
@@ -44,13 +109,13 @@ def check_packages(module, packages):
 
     if would_be_changed:
         status = True
-        if (len(packages) > 1):
-            message = '%s package(s) would be installed' % str(len(would_be_changed))
+        if len(packages) > 1:
+            message = '{} package(s) would be installed'.format(len(would_be_changed))
         else:
             message = 'package would be installed'
     else:
         status = False
-        if (len(packages) > 1):
+        if len(packages) > 1:
             message = 'all packages are already installed'
         else:
             message = 'package is already installed'
@@ -61,10 +126,11 @@ def install_with_makepkg(module, package):
     """
     Install the specified package with makepkg
     """
-    f = open_url('https://aur.archlinux.org/rpc/?v=5&type=info&arg={}'.format(package))
+    module.get_bin_path('fakeroot', required=True)
+    f = open_url('https://aur.archlinux.org/rpc/?v=5&type=info&arg={}'.format(urllib.parse.quote(package)))
     result = json.loads(f.read().decode('utf8'))
     if result['resultcount'] != 1:
-        return (1, '', 'package not found')
+        return (1, '', 'package {} not found'.format(package))
     result = result['results'][0]
     f = open_url('https://aur.archlinux.org/{}'.format(result['URLPath']))
     current_path = os.getcwd()
@@ -84,13 +150,13 @@ def install_with_makepkg(module, package):
     return (rc, out, err)
 
 
-def upgrade(module, use):
+def upgrade(module, use, aur_only):
     """
     Upgrade the whole system
     """
     assert use in use_cmd
 
-    rc, out, err = module.run_command(def_lang + use_cmd[use] + ['-u'], check_rc=True)
+    rc, out, err = module.run_command(def_lang + use_cmd[use] + ['--aur' if (aur_only and use in has_aur_option) else None] + ['-u'], check_rc=True)
 
     module.exit_json(
         changed=not (out == '' or 'nothing to do' in out or 'No AUR updates found' in out),
@@ -99,7 +165,7 @@ def upgrade(module, use):
     )
 
 
-def install_packages(module, packages, use, skip_installed):
+def install_packages(module, packages, use, skip_installed, aur_only):
     """
     Install the specified packages
     """
@@ -115,14 +181,11 @@ def install_packages(module, packages, use, skip_installed):
         if use == 'makepkg':
             rc, out, err = install_with_makepkg(module, package)
         else:
-            rc, out, err = module.run_command(def_lang + use_cmd[use] + [package], check_rc=True)
+            rc, out, err = module.run_command(def_lang + use_cmd[use] + ['--aur' if (aur_only and use in has_aur_option) else None] + [package], check_rc=True)
 
         changed_iter = changed_iter or not (out == '' or '-- skipping' in out or 'nothing to do' in out)
 
-    if changed_iter:
-        message = 'installed package(s)'
-    else:
-        message = 'package(s) already installed'
+    message = 'installed package(s)' if changed_iter else 'package(s) already installed'
 
     module.exit_json(
         changed=changed_iter,
@@ -144,7 +207,7 @@ def main():
             },
             'use': {
                 'default': 'auto',
-                'choices': ['auto', 'aurman', 'pacaur', 'trizen', 'pikaur', 'yaourt', 'yay', 'makepkg'],
+                'choices': ['auto'] + list(use_cmd.keys()),
             },
             'skip_installed': {
                 'default': False,
@@ -154,6 +217,10 @@ def main():
                 'default': False,
                 'type': 'bool',
             },
+            'aur_only': {
+                'default': False,
+                'type': 'bool',
+            },
         },
         required_one_of=[['name', 'upgrade']],
         supports_check_mode=True
@@ -168,7 +235,7 @@ def main():
         use = 'makepkg'
         # auto: select the first helper for which the bin is found
         for k in use_cmd:
-            if module.get_bin_path(k, False):
+            if module.get_bin_path(k):
                 use = k
                 break
     else:
@@ -178,9 +245,9 @@ def main():
         module.fail_json(msg="Upgrade cannot be used with this option.")
     else:
         if params['upgrade']:
-            upgrade(module, use)
+            upgrade(module, use, params['aur_only'])
         else:
-            install_packages(module, params['name'], use, params['skip_installed'])
+            install_packages(module, params['name'], use, params['skip_installed'], params['aur_only'])
 
 
 if __name__ == '__main__':