Repository: ansible-collections/community.general

Issue:
Add ansible galaxy module
<!--- Verify first that your feature was not already discussed on GitHub -->
<!--- Complete *all* sections as described, this form is processed automatically -->

This is a repetition of https://github.com/ansible/ansible/issues/69572.

##### SUMMARY
<!--- Describe the new feature/improvement briefly below -->
Currently, to install ansible galaxy requirements you need to use the CLI. But isn't Ansible about automation?

We should have an `ansible_galaxy` module which handles installing roles or collections in the specified path.

##### ISSUE TYPE
- Feature Idea

##### COMPONENT NAME
<!--- Write the short name of the module, plugin, task or feature below, use your best guess if unsure -->
modules

##### ADDITIONAL INFORMATION
<!--- Describe how the feature would be used, why it is needed and what it would solve -->

<!--- Paste example playbooks or commands between quotes below -->
```yaml
- name: base playbook
  hosts: localhost
  tasks:
  - name: install collections
    ansible_galaxy:
      type: collections
      requirements_file: "{{ playbook_dir }}/requirements.yml"
      dst: "{{ playbook_dir }}/collections"

  - name: install roles
    ansible_galaxy:
      type: roles
      requirements:
        - tecnativa.docker
      dst: "{{ playbook_dir }}/roles"

- name: do the real thing
  collections:
  - a_collection_that_i_just_installed.in_the_previous_play

  ...
```



Discussion:
Files identified in the description:
None

If these files are inaccurate, please update the `component name` section of the description or use the `!component` bot command.

[click here for bot help](https://github.com/ansible/ansibullbot/blob/master/ISSUE_HELP.md)
<!--- boilerplate: components_banner --->
Hi @Yajo I am starting to work on this. Couple of suggestions there:
- naming it `ansible_galaxy_install` - there are other galaxy actions out there and possibly new modules coming to support those in the future, so I think we'd rather be more explicit here.
- the `requirements` option when installing roles being a file, it is pretty much the same logic of `requirements_file` for installing a collection, so I think it makes sense to have only one option named `requirements_file`.
Nice! I'm just thinking now that this should be better a builtin module, right? O therwise, how would I use it to install community.general?
@Yajo you'll have to argue about that with the core team, not with us :) It might be worth bringing this to the public core meeting (https://github.com/ansible/community/issues/606).
BTW, I am thinking of adding it to `/plugins/modules/packaging/language/`, but open to discuss other placements.
@Yajo please take a look at the PR, see if it fits the bill :-) Also, if you see some testing that could/should be added to it, by all means let us know.

Resolving patch:
diff --git a/plugins/modules/ansible_galaxy_install.py b/plugins/modules/ansible_galaxy_install.py
new file mode 120000
--- /dev/null
+++ b/plugins/modules/ansible_galaxy_install.py
@@ -0,0 +1 @@
+packaging/language/ansible_galaxy_install.py
\ No newline at end of file
diff --git a/plugins/modules/packaging/language/ansible_galaxy_install.py b/plugins/modules/packaging/language/ansible_galaxy_install.py
new file mode 100644
--- /dev/null
+++ b/plugins/modules/packaging/language/ansible_galaxy_install.py
@@ -0,0 +1,318 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# (c) 2021, Alexei Znamensky <russoz@gmail.com>
+#
+# 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
+__metaclass__ = type
+
+DOCUMENTATION = """
+module: ansible_galaxy_install
+author:
+    - "Alexei Znamensky (@russoz)"
+short_description: Install Ansible roles or collections using ansible-galaxy
+version_added: 3.5.0
+description:
+  - This module allows the installation of Ansible collections or roles using C(ansible-galaxy).
+notes:
+  - >
+    B(Ansible 2.9/2.10): The C(ansible-galaxy) command changed significantly between Ansible 2.9 and
+    ansible-base 2.10 (later ansible-core 2.11). See comments in the parameters.
+requirements:
+  - Ansible 2.9, ansible-base 2.10, or ansible-core 2.11 or newer
+options:
+  type:
+    description:
+    - The type of installation performed by C(ansible-galaxy).
+    - If I(type) is C(both), then I(requirements_file) must be passed and it may contain both roles and collections.
+    - "Note however that the opposite is not true: if using a I(requirements_file), then I(type) can be any of the three choices."
+    - "B(Ansible 2.9): The option C(both) will have the same effect as C(role)."
+    type: str
+    choices: [collection, role, both]
+    required: true
+  name:
+    description:
+    - Name of the collection or role being installed.
+    - Versions can be specified with C(ansible-galaxy) usual formats. For example, C(community.docker:1.6.1) or C(ansistrano.deploy,3.8.0).
+    - I(name) and I(requirements_file) are mutually exclusive.
+    type: str
+  requirements_file:
+    description:
+    - Path to a file containing a list of requirements to be installed.
+    - It works for I(type) equals to C(collection) and C(role).
+    - I(name) and I(requirements_file) are mutually exclusive.
+    - "B(Ansible 2.9): It can only be used to install either I(type=role) or I(type=collection), but not both at the same run."
+    type: path
+  dest:
+    description:
+    - The path to the directory containing your collections or roles, according to the value of I(type).
+    - >
+      Please notice that C(ansible-galaxy) will not install collections with I(type=both), when I(requirements_file)
+      contains both roles and collections and I(dest) is specified.
+    type: path
+  force:
+    description:
+    - Force overwriting an existing role or collection.
+    - Using I(force=true) is mandatory when downgrading.
+    - "B(Ansible 2.9 and 2.10): Must be C(true) to upgrade roles and collections."
+    type: bool
+    default: false
+  ack_ansible29:
+    description:
+    - Acknowledge using Ansible 2.9 with its limitations, and prevents the module from generating warnings about them.
+    - This option is completely ignored if using a version Ansible greater than C(2.9.x).
+    type: bool
+    default: false
+"""
+
+EXAMPLES = """
+- name: Install collection community.network
+  community.general.ansible_galaxy_install:
+    type: collection
+    name: community.network
+
+- name: Install role at specific path
+  community.general.ansible_galaxy_install:
+    type: role
+    name: ansistrano.deploy
+    dest: /ansible/roles
+
+- name: Install collections and roles together
+  community.general.ansible_galaxy_install:
+    type: both
+    requirements_file: requirements.yml
+
+- name: Force-install collection community.network at specific version
+  community.general.ansible_galaxy_install:
+    type: collection
+    name: community.network:3.0.2
+    force: true
+
+"""
+
+RETURN = """
+  type:
+    description: The value of the I(type) parameter.
+    type: str
+    returned: always
+  name:
+    description: The value of the I(name) parameter.
+    type: str
+    returned: always
+  dest:
+    description: The value of the I(dest) parameter.
+    type: str
+    returned: always
+  requirements_file:
+    description: The value of the I(requirements_file) parameter.
+    type: str
+    returned: always
+  force:
+    description: The value of the I(force) parameter.
+    type: bool
+    returned: always
+  installed_roles:
+    description:
+    - If I(requirements_file) is specified instead, returns dictionary with all the roles installed per path.
+    - If I(name) is specified, returns that role name and the version installed per path.
+    - "B(Ansible 2.9): Returns empty because C(ansible-galaxy) has no C(list) subcommand."
+    type: dict
+    returned: always when installing roles
+    contains:
+      "<path>":
+        description: Roles and versions for that path.
+        type: dict
+    sample:
+      /home/user42/.ansible/roles:
+        ansistrano.deploy: 3.9.0
+        baztian.xfce: v0.0.3
+      /custom/ansible/roles:
+        ansistrano.deploy: 3.8.0
+  installed_collections:
+    description:
+    - If I(requirements_file) is specified instead, returns dictionary with all the collections installed per path.
+    - If I(name) is specified, returns that collection name and the version installed per path.
+    - "B(Ansible 2.9): Returns empty because C(ansible-galaxy) has no C(list) subcommand."
+    type: dict
+    returned: always when installing collections
+    contains:
+      "<path>":
+        description: Collections and versions for that path
+        type: dict
+    sample:
+      /home/az/.ansible/collections/ansible_collections:
+        community.docker: 1.6.0
+        community.general: 3.0.2
+      /custom/ansible/ansible_collections:
+        community.general: 3.1.0
+  new_collections:
+    description: New collections installed by this module.
+    returned: success
+    type: dict
+    sample:
+      community.general: 3.1.0
+      community.docker: 1.6.1
+  new_roles:
+    description: New roles installed by this module.
+    returned: success
+    type: dict
+    sample:
+      ansistrano.deploy: 3.8.0
+      baztian.xfce: v0.0.3
+"""
+
+import re
+
+from ansible_collections.community.general.plugins.module_utils.module_helper import CmdModuleHelper, ArgFormat
+
+
+class AnsibleGalaxyInstall(CmdModuleHelper):
+    _RE_GALAXY_VERSION = re.compile(r'^ansible-galaxy(?: \[core)? (?P<version>\d+\.\d+\.\d+)(?:\.\w+)?(?:\])?')
+    _RE_LIST_PATH = re.compile(r'^# (?P<path>.*)$')
+    _RE_LIST_COLL = re.compile(r'^(?P<elem>\w+\.\w+)\s+(?P<version>[\d\.]+)\s*$')
+    _RE_LIST_ROLE = re.compile(r'^- (?P<elem>\w+\.\w+),\s+(?P<version>[\d\.]+)\s*$')
+    _RE_INSTALL_OUTPUT = None  # Set after determining ansible version, see __init_module__()
+    ansible_version = None
+    is_ansible29 = None
+
+    output_params = ('type', 'name', 'dest', 'requirements_file', 'force')
+    module = dict(
+        argument_spec=dict(
+            type=dict(type='str', choices=('collection', 'role', 'both'), required=True),
+            name=dict(type='str'),
+            requirements_file=dict(type='path'),
+            dest=dict(type='path'),
+            force=dict(type='bool', default=False),
+            ack_ansible29=dict(type='bool', default=False),
+        ),
+        mutually_exclusive=[('name', 'requirements_file')],
+        required_one_of=[('name', 'requirements_file')],
+        required_if=[('type', 'both', ['requirements_file'])],
+        supports_check_mode=False,
+    )
+
+    command = 'ansible-galaxy'
+    command_args_formats = dict(
+        type=dict(fmt=lambda v: [] if v == 'both' else [v]),
+        galaxy_cmd=dict(),
+        requirements_file=dict(fmt=('-r', '{0}'),),
+        dest=dict(fmt=('-p', '{0}'),),
+        force=dict(fmt="--force", style=ArgFormat.BOOLEAN),
+    )
+    force_lang = "en_US.UTF-8"
+    check_rc = True
+
+    def _get_ansible_galaxy_version(self):
+        ansible_galaxy = self.module.get_bin_path("ansible-galaxy", required=True)
+        dummy, out, dummy = self.module.run_command([ansible_galaxy, "--version"], check_rc=True)
+        line = out.splitlines()[0]
+        match = self._RE_GALAXY_VERSION.match(line)
+        if not match:
+            raise RuntimeError("Unable to determine ansible-galaxy version from: {0}".format(line))
+        version = match.group("version")
+        version = tuple(int(x) for x in version.split('.')[:3])
+        return version
+
+    def __init_module__(self):
+        self.ansible_version = self._get_ansible_galaxy_version()
+        self.is_ansible29 = self.ansible_version < (2, 10)
+        if self.is_ansible29:
+            self._RE_INSTALL_OUTPUT = re.compile(r"^(?:.*Installing '(?P<collection>\w+\.\w+):(?P<cversion>[\d\.]+)'.*"
+                                                 r'|- (?P<role>\w+\.\w+) \((?P<rversion>[\d\.]+)\)'
+                                                 r' was installed successfully)$')
+        else:
+            # Collection install output changed:
+            # ansible-base 2.10:  "coll.name (x.y.z)"
+            # ansible-core 2.11+: "coll.name:x.y.z"
+            self._RE_INSTALL_OUTPUT = re.compile(r'^(?:(?P<collection>\w+\.\w+)(?: \(|:)(?P<cversion>[\d\.]+)\)?'
+                                                 r'|- (?P<role>\w+\.\w+) \((?P<rversion>[\d\.]+)\))'
+                                                 r' was installed successfully$')
+
+    @staticmethod
+    def _process_output_list(*args):
+        if "None of the provided paths were usable" in args[1]:
+            return []
+        return args[1].splitlines()
+
+    def _list_element(self, _type, path_re, elem_re):
+        params = ({'type': _type}, {'galaxy_cmd': 'list'}, 'dest')
+        elems = self.run_command(params=params,
+                                 publish_rc=False, publish_out=False, publish_err=False,
+                                 process_output=self._process_output_list,
+                                 check_rc=False)
+        elems_dict = {}
+        current_path = None
+        for line in elems:
+            if line.startswith("#"):
+                match = path_re.match(line)
+                if not match:
+                    continue
+                if self.vars.dest is not None and match.group('path') != self.vars.dest:
+                    current_path = None
+                    continue
+                current_path = match.group('path') if match else None
+                elems_dict[current_path] = {}
+
+            elif current_path is not None:
+                match = elem_re.match(line)
+                if not match or (self.vars.name is not None and match.group('elem') != self.vars.name):
+                    continue
+                elems_dict[current_path][match.group('elem')] = match.group('version')
+        return elems_dict
+
+    def _list_collections(self):
+        return self._list_element('collection', self._RE_LIST_PATH, self._RE_LIST_COLL)
+
+    def _list_roles(self):
+        return self._list_element('role', self._RE_LIST_PATH, self._RE_LIST_ROLE)
+
+    def _setup29(self):
+        self.vars.set("new_collections", {})
+        self.vars.set("new_roles", {})
+        self.vars.set("ansible29_change", False, change=True, output=False)
+        if not self.vars.ack_ansible29:
+            self.module.warn("Ansible 2.9 or older: unable to retrieve lists of roles and collections already installed")
+            if self.vars.requirements_file is not None and self.vars.type == 'both':
+                self.module.warn("Ansible 2.9 or older: will install only roles from requirement files")
+
+    def _setup210plus(self):
+        self.vars.set("new_collections", {}, change=True)
+        self.vars.set("new_roles", {}, change=True)
+        if self.vars.type != "collection":
+            self.vars.installed_roles = self._list_roles()
+        if self.vars.type != "roles":
+            self.vars.installed_collections = self._list_collections()
+
+    def __run__(self):
+        if self.is_ansible29:
+            if self.vars.type == 'both':
+                raise ValueError("Type 'both' not supported in Ansible 2.9")
+            self._setup29()
+        else:
+            self._setup210plus()
+        params = ('type', {'galaxy_cmd': 'install'}, 'force', 'dest', 'requirements_file', 'name')
+        self.run_command(params=params)
+
+    def process_command_output(self, rc, out, err):
+        for line in out.splitlines():
+            match = self._RE_INSTALL_OUTPUT.match(line)
+            if not match:
+                continue
+            if match.group("collection"):
+                self.vars.new_collections[match.group("collection")] = match.group("cversion")
+                if self.is_ansible29:
+                    self.vars.ansible29_change = True
+            elif match.group("role"):
+                self.vars.new_roles[match.group("role")] = match.group("rversion")
+                if self.is_ansible29:
+                    self.vars.ansible29_change = True
+
+
+def main():
+    galaxy = AnsibleGalaxyInstall()
+    galaxy.run()
+
+
+if __name__ == '__main__':
+    main()


Test patch:
diff --git a/tests/integration/targets/ansible_galaxy_install/aliases b/tests/integration/targets/ansible_galaxy_install/aliases
new file mode 100644
--- /dev/null
+++ b/tests/integration/targets/ansible_galaxy_install/aliases
@@ -0,0 +1,3 @@
+destructive
+shippable/posix/group3
+skip/python2.6
diff --git a/tests/integration/targets/ansible_galaxy_install/files/test.yml b/tests/integration/targets/ansible_galaxy_install/files/test.yml
new file mode 100644
--- /dev/null
+++ b/tests/integration/targets/ansible_galaxy_install/files/test.yml
@@ -0,0 +1,11 @@
+---
+roles:
+  # Install a role from Ansible Galaxy.
+  - name: geerlingguy.java
+    version: 1.9.6
+
+collections:
+  # Install a collection from Ansible Galaxy.
+  - name: geerlingguy.php_roles
+    version: 0.9.3
+    source: https://galaxy.ansible.com
diff --git a/tests/integration/targets/ansible_galaxy_install/tasks/main.yml b/tests/integration/targets/ansible_galaxy_install/tasks/main.yml
new file mode 100644
--- /dev/null
+++ b/tests/integration/targets/ansible_galaxy_install/tasks/main.yml
@@ -0,0 +1,95 @@
+---
+###################################################
+- name: Install collection netbox.netbox
+  community.general.ansible_galaxy_install:
+    type: collection
+    name: netbox.netbox
+  register: install_c0
+
+- name: Assert collection was installed
+  assert:
+    that:
+    - install_c0 is changed
+    - '"netbox.netbox" in install_c0.new_collections'
+
+- name: Install collection netbox.netbox (again)
+  community.general.ansible_galaxy_install:
+    type: collection
+    name: netbox.netbox
+  register: install_c1
+
+- name: Assert collection was not installed
+  assert:
+    that:
+    - install_c1 is not changed
+
+###################################################
+- name: Install role ansistrano.deploy
+  community.general.ansible_galaxy_install:
+    type: role
+    name: ansistrano.deploy
+  register: install_r0
+
+- name: Assert collection was installed
+  assert:
+    that:
+    - install_r0 is changed
+    - '"ansistrano.deploy" in install_r0.new_roles'
+
+- name: Install role ansistrano.deploy (again)
+  community.general.ansible_galaxy_install:
+    type: role
+    name: ansistrano.deploy
+  register: install_r1
+
+- name: Assert role was not installed
+  assert:
+    that:
+    - install_r1 is not changed
+
+###################################################
+- name:
+  set_fact:
+    reqs_file: '{{ output_dir }}/reqs.yaml'
+
+- name: Copy requirements file
+  copy:
+    src: 'files/test.yml'
+    dest: '{{ reqs_file }}'
+
+- name: Install from requirements file
+  community.general.ansible_galaxy_install:
+    type: both
+    requirements_file: "{{ reqs_file }}"
+  register: install_rq0
+  ignore_errors: true
+
+- name: Assert requirements file was installed (Ansible >2.9)
+  assert:
+    that:
+    - install_rq0 is changed
+    - '"geerlingguy.java" in install_rq0.new_roles'
+    - '"geerlingguy.php_roles" in install_rq0.new_collections'
+  when:
+    - (ansible_version.major != 2 or ansible_version.minor != 9)
+
+- name: Assert requirements file was installed (Ansible 2.9)
+  assert:
+    that:
+    - install_rq0 is failed
+    - install_rq0 is not changed
+  when:
+    - ansible_version.major == 2
+    - ansible_version.minor == 9
+
+- name: Install from requirements file (again)
+  community.general.ansible_galaxy_install:
+    type: both
+    requirements_file: "{{ reqs_file }}"
+  register: install_rq1
+  ignore_errors: true
+
+- name: Assert requirements file was not installed
+  assert:
+    that:
+    - install_rq1 is not changed