community.general/tests/integration/targets/gem/tasks/main.yml

---
####################################################################
# WARNING: These are designed specifically for Ansible tests       #
# and should not be used as examples of how to write Ansible roles #
####################################################################

# test code for the gem module
# Copyright (c) 2014, James Tanner <tanner.jc@gmail.com>
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later

- when:
    - not (ansible_facts.os_family == 'Alpine')  # TODO
  block:

    - include_vars: '{{ item }}'
      with_first_found:
        - files:
            - '{{ ansible_facts.distribution }}-{{ ansible_facts.distribution_major_version }}.yml'
            - '{{ ansible_facts.distribution }}-{{ ansible_facts.distribution_version }}.yml'
            - '{{ ansible_facts.distribution }}.yml'
            - '{{ ansible_facts.os_family }}.yml'
            - 'default.yml'
          paths: '../vars'

    - name: Install dependencies for test
      package:
        name: "{{ item }}"
        state: present
      loop: "{{ test_packages }}"
      when: ansible_facts.distribution != "MacOSX"

    # default user_install: skip on RedHat/Fedora where OS-injected --install-dir conflicts
    - when: ansible_facts.os_family != "RedHat"
      block:
        - name: Install a gem (default user_install)
          gem:
            name: gist
            state: present
          register: install_gem_result

        - name: List gems
          command: gem list
          register: current_gems

        - name: Ensure gem was installed
          assert:
            that:
              - install_gem_result is changed
              - current_gems.stdout is search('gist\s+\([0-9.]+\)')

        - name: Remove a gem
          gem:
            name: gist
            state: absent
          register: remove_gem_results

        - name: List gems
          command: gem list
          register: current_gems

        - name: Verify gem is not installed
          assert:
            that:
              - remove_gem_results is changed
              - current_gems.stdout is not search('gist\s+\([0-9.]+\)')

    # install gem in --no-user-install
    - block:
        - name: Install a gem with --no-user-install
          gem:
            name: gist
            state: present
            user_install: false
          register: install_gem_result

        - name: List gems
          command: gem list
          register: current_gems

        - name: Ensure gem was installed
          assert:
            that:
              - install_gem_result is changed
              - current_gems.stdout is search('gist\s+\([0-9.]+\)')

        - name: Remove a gem
          gem:
            name: gist
            state: absent
            user_install: false
          register: remove_gem_results

        - name: List gems
          command: gem list
          register: current_gems

        - name: Verify gem is not installed
          assert:
            that:
              - remove_gem_results is changed
              - current_gems.stdout is not search('gist\s+\([0-9.]+\)')
      when: ansible_facts.user_uid == 0

    # Check custom gem directory
    - name: Install gem in a custom directory with incorrect options
      gem:
        name: gist
        state: present
        install_dir: "{{ remote_tmp_dir }}/gems"
      ignore_errors: true
      register: install_gem_fail_result

    - debug:
        var: install_gem_fail_result
      tags: debug

    - name: Ensure previous task failed
      assert:
        that:
          - install_gem_fail_result is failed
          - install_gem_fail_result.msg == 'install_dir requires user_install=false'

    - name: Install a gem in a custom directory
      gem:
        name: gist
        state: present
        user_install: false
        install_dir: "{{ remote_tmp_dir }}/gems"
      register: install_gem_result

    - name: Find gems in custom directory
      find:
        paths: "{{ remote_tmp_dir }}/gems/gems"
        file_type: directory
        contains: gist
      register: gem_search

    - name: Ensure gem was installed in custom directory
      assert:
        that:
          - install_gem_result is changed
          - gem_search.files[0].path is search('gist-[0-9.]+')
      ignore_errors: true

    - name: Remove a gem in a custom directory
      gem:
        name: gist
        state: absent
        user_install: false
        install_dir: "{{ remote_tmp_dir }}/gems"
      register: install_gem_result

    - name: Find gems in custom directory
      find:
        paths: "{{ remote_tmp_dir }}/gems/gems"
        file_type: directory
        contains: gist
      register: gem_search

    - name: Ensure gem was removed in custom directory
      assert:
        that:
          - install_gem_result is changed
          - gem_search.files | length == 0

    # Custom directory for executables (--bindir)
    - name: Install gem with custom bindir
      gem:
        name: gist
        state: present
        bindir: "{{ remote_tmp_dir }}/custom_bindir"
        norc: true
        user_install: false
      register: install_gem_result

    - name: Get stats of gem executable
      stat:
        path: "{{ remote_tmp_dir }}/custom_bindir/gist"
      register: gem_bindir_stat

    - name: Ensure gem executable was installed in custom directory
      assert:
        that:
          - install_gem_result is changed
          - gem_bindir_stat.stat.exists and gem_bindir_stat.stat.isreg

    - name: Remove gem with custom bindir
      gem:
        name: gist
        state: absent
        bindir: "{{ remote_tmp_dir }}/custom_bindir"
        norc: true
        user_install: false
      register: install_gem_result

    - name: Get stats of gem executable
      stat:
        path: "{{ remote_tmp_dir }}/custom_bindir/gist"
      register: gem_bindir_stat

    - name: Ensure gem executable was removed from custom directory
      assert:
        that:
          - install_gem_result is changed
          - not gem_bindir_stat.stat.exists

    # override_platform_install_dir: install and remove using explicit user gem dir
    - name: Install a gem with override_platform_install_dir
      gem:
        name: gist
        state: present
        override_platform_install_dir: true
      register: install_gem_result

    - name: List gems
      command: gem list
      register: current_gems

    - name: Ensure gem was installed with override_platform_install_dir
      assert:
        that:
          - install_gem_result is changed
          - current_gems.stdout is search('gist\s+\([0-9.]+\)')

    - name: Install a gem with override_platform_install_dir (idempotency)
      gem:
        name: gist
        state: present
        override_platform_install_dir: true
      register: install_gem_result

    - name: Ensure install is idempotent
      assert:
        that:
          - install_gem_result is not changed

    - name: Remove a gem with override_platform_install_dir
      gem:
        name: gist
        state: absent
        override_platform_install_dir: true
      register: remove_gem_result

    - name: List gems
      command: gem list
      register: current_gems

    - name: Verify gem was removed with override_platform_install_dir
      assert:
        that:
          - remove_gem_result is changed
          - current_gems.stdout is not search('gist\s+\([0-9.]+\)')

    - name: Attempt to uninstall default gem 'json'
      community.general.gem:
        name: json
        state: absent
      when: ansible_facts.distribution == "Ubuntu"
      register: gem_result
      ignore_errors: true

    - name: Assert gem uninstall failed as expected
      when: ansible_facts.distribution == "Ubuntu"
      assert:
        that:
          - gem_result is failed
          - gem_result.msg.startswith("Failed to uninstall gem 'json'")