test: ensure role gathers the facts it uses by having test clear_facts before include_role

The role gathers the facts it uses.  For example, if the user uses
`ANSIBLE_GATHERING=explicit`, the role uses the `setup` module with the
facts and subsets it requires.

This change allows us to test this.  Before every role invocation, the test
will use `meta: clear_facts` so that the role starts with no facts.

Create a task file tests/tasks/run_role_with_clear_facts.yml to do the tasks
to clear the facts and run the role.  Note that this means we don't need to
use `gather_facts` for the tests.

Some vars defined using `ansible_facts` have been changed to be defined with
`set_fact` instead.  This is because of the fact that `vars` are lazily
evaluated - the var might be referenced when the facts have been cleared, and
will issue an error like `ansible_facts["distribution"] is undefined`.  This is
typically done for blocks that have a `when` condition that uses `ansible_facts`
and the block has a role invocation using run_role_with_clear_facts.yml
These have been rewritten to define the `when` condition using `set_fact`.  This
is because the `when` condition is evaluated every time a task is invoked in the
block, and if the facts are cleared, this will raise an undefined variable error.

Signed-off-by: Rich Megginson <rmeggins@redhat.com>

Author: richm

tests/tasks/run_role_with_clear_facts.yml

@@ -0,0 +1,37 @@
+---
+# Task file: clear_facts, run linux-system-roles.ssh,.
+# Include this with include_tasks or import_tasks
+# Input:
+# - __sr_tasks_from: tasks_from to run - same as tasks_from in include_role
+# - __sr_public: export private vars from role - same as public in include_role
+# - __sr_failed_when: set to false to ignore role errors - same as failed_when in include_role
+- name: Clear facts
+  meta: clear_facts
+
+# note that you can use failed_when with import_role but not with include_role
+# so this simulates the __sr_failed_when false case
+# Q: Why do we need a separate task to run the role normally?  Why not just
+# run the role in the block and rethrow the error in the rescue block?
+# A: Because you cannot rethrow the error in exactly the same way as the role does.
+# It might be possible to exactly reconstruct ansible_failed_result but it's not worth the effort.
+- name: Run the role with __sr_failed_when false
+  when:
+    - __sr_failed_when is defined
+    - not __sr_failed_when
+  block:
+    - name: Run the role
+      include_role:
+        name: linux-system-roles.ssh
+        tasks_from: "{{ __sr_tasks_from | default('main') }}"
+        public: "{{ __sr_public | default(false) }}"
+  rescue:
+    - name: Ignore the failure when __sr_failed_when is false
+      debug:
+        msg: Ignoring failure when __sr_failed_when is false
+
+- name: Run the role normally
+  include_role:
+    name: linux-system-roles.ssh
+    tasks_from: "{{ __sr_tasks_from | default('main') }}"
+    public: "{{ __sr_public | default(false) }}"
+  when: __sr_failed_when | d(true)

tests/tests_additional_packages.yml

@@ -1,7 +1,6 @@
 ---
 - name: Verify default packages as well as additional are installed
   hosts: all
-  gather_facts: true
   vars:
     additional_package: >-
       {% if ansible_facts['distribution'] in [ 'RedHat', 'CentOS' ] and
@@ -16,8 +15,7 @@
       {% endif %}
   tasks:
     - name: Run role
-      include_role:
-        name: linux-system-roles.ssh
+      include_tasks: tasks/run_role_with_clear_facts.yml
       vars:
         ssh_additional_packages:
           - "{{ additional_package | trim }}"

tests/tests_all_options.yml

@@ -1,7 +1,6 @@
 ---
 - name: Test we can handle all configuration options documented in manual page
   hosts: all
-  gather_facts: true
   vars:
     ssh_c: {}
     pkg_mgr: "{{ (ansible_facts['distribution_version'] | int > 7) |
@@ -102,8 +101,7 @@
         "{{ ssh_options.stdout_lines }}"
 
     - name: Run role
-      include_role:
-        name: linux-system-roles.ssh
+      include_tasks: tasks/run_role_with_clear_facts.yml
       vars:
         __ssh_supports_validate: false
         ssh_config_file: /etc/test_ssh_config

tests/tests_backup.yml

@@ -22,8 +22,7 @@
       with_items: "{{ backup_files.files }}"
 
     - name: Configure ssh without creating backup
-      ansible.builtin.include_role:
-        name: linux-system-roles.ssh
+      include_tasks: tasks/run_role_with_clear_facts.yml
       vars:
         ssh_backup: false
 
@@ -34,8 +33,7 @@
       register: no_backup
 
     - name: Configure ssh again with different configuration and with backup
-      ansible.builtin.include_role:
-        name: linux-system-roles.ssh
+      include_tasks: tasks/run_role_with_clear_facts.yml
       vars:
         ssh_ForwardX11Trusted: 'yes'  # noqa var-naming
       register: second_run

tests/tests_custom_config.yml

@@ -3,8 +3,7 @@
   hosts: all
   tasks:
     - name: Run role
-      include_role:
-        name: linux-system-roles.ssh
+      include_tasks: tasks/run_role_with_clear_facts.yml
       vars:
         ssh:
           Compression: true

tests/tests_custom_drop_in.yml

@@ -1,7 +1,6 @@
 ---
 - name: Test we can write any other configuration file as a drop-in
   hosts: all
-  gather_facts: true
   vars:
     __ssh_test_backup_files:
       - /tmp/ssh_config.d_00-ansible.conf
@@ -21,8 +20,7 @@
       include_tasks: tasks/backup.yml
 
     - name: Run role
-      include_role:
-        name: linux-system-roles.ssh
+      include_tasks: tasks/run_role_with_clear_facts.yml
       vars:
         ssh:
           Compression: true

tests/tests_custom_with_defaults.yml

@@ -3,8 +3,7 @@
   hosts: all
   tasks:
     - name: Run role
-      include_role:
-        name: linux-system-roles.ssh
+      include_tasks: tasks/run_role_with_clear_facts.yml
       vars:
         ssh:
           Compression: true

tests/tests_default.yml

@@ -11,9 +11,11 @@
 
 - name: Ensure that the role runs with default parameters
   hosts: all
-  gather_facts: false
-  roles:
-    - linux-system-roles.ssh
+  tasks:
+    - name: Run role
+      include_tasks: tasks/run_role_with_clear_facts.yml
+      vars:
+        __sr_public: true
 
 - name: Restore configuration files
   hosts: all

tests/tests_global_config.yml

@@ -1,6 +1,5 @@
 ---
 - name: Test we can write global config with default configuration
-  gather_facts: true
   hosts: all
   vars:
     __ssh_test_backup_files:
@@ -12,8 +11,7 @@
       include_tasks: tasks/backup.yml
 
     - name: Run role
-      include_role:
-        name: linux-system-roles.ssh
+      include_tasks: tasks/run_role_with_clear_facts.yml
       vars:
         # noqa var-naming
         ssh:

tests/tests_global_config_mode.yml

@@ -1,7 +1,6 @@
 ---
 - name: Test we can write global config with given permissions
   hosts: all
-  gather_facts: true
   vars:
     __ssh_test_backup_files:
       - /etc/ssh/ssh_config.d/00-ansible.conf
@@ -16,8 +15,7 @@
       include_tasks: tasks/backup.yml
 
     - name: Run role
-      include_role:
-        name: linux-system-roles.ssh
+      include_tasks: tasks/run_role_with_clear_facts.yml
       vars:
         ssh:
           Compression: true