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/library

@@ -7,8 +7,7 @@
 - name: Run the role and check for errors
   block:
     - name: Run the role
-      include_role:
-        name: linux-system-roles.ha_cluster
+      include_tasks: tasks/run_role_with_clear_facts.yml
 
     - name: Fail
       fail:

tests/tasks/assert_node_options_check.yml

@@ -5,13 +5,19 @@
     file: vars/rh_distros_vars.yml
   when: __ha_cluster_is_rh_distro is not defined
 
+- name: Set variable for crypto-policies PQC block
+  set_fact:
+    __need_crypto_policies_pqc: >-
+      {{ __ha_cluster_is_rh_distro | bool and (
+        (ansible_facts['distribution'] == 'RedHat' and
+         ansible_facts['distribution_version'] is version('9.7', '>=') and
+         ansible_facts['distribution_version'] is version('10', '<'))
+        or (ansible_facts['distribution'] != 'RedHat' and
+            ansible_facts['distribution_major_version'] is version('9', '=='))
+      ) }}
+
 - name: Check if the managed node needs crypto-policies to be able to use PQC
-  when:
-    - __ha_cluster_is_rh_distro | bool
-    - (ansible_facts["distribution"] == "RedHat" and ansible_facts["distribution_version"] is version("9.7", ">=")
-       and ansible_facts["distribution_version"] is version("10", "<"))
-      or (ansible_facts["distribution"] != "RedHat" and
-          ansible_facts['distribution_major_version'] is version("9", "=="))
+  when: __need_crypto_policies_pqc | bool
   block:
     # calling role with null will just return the current policy
     - name: Get current crypto policy

tests/tasks/fixture_psks.yml

@@ -0,0 +1,39 @@
+---
+# Task file: save facts, clear_facts, run linux-system-roles.ha_cluster, then restore facts.
+# Include this with include_tasks or import_tasks; ensure tests/library is in module search path.
+# 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
+# Output:
+# - ansible_facts: merged saved ansible_facts with ansible_facts modified by the role, if any
+- 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.ha_cluster
+        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.ha_cluster
+    tasks_from: "{{ __sr_tasks_from | default('main') }}"
+    public: "{{ __sr_public | default(false) }}"
+  when: __sr_failed_when | d(true)

tests/tasks/run_role_with_clear_facts.yml

@@ -27,10 +27,9 @@
       run_once: true  # noqa: run_once[task]
 
     - name: Run HA Cluster role
-      include_role:
-        name: linux-system-roles.ha_cluster
-        # variables for the role are supposed to be defined in a playbook which
-        # includes this task file
+      include_tasks: tasks/run_role_with_clear_facts.yml
+      # variables for the role are supposed to be defined in a playbook which
+      # includes this task file
 
     # The role removed qnetd configuration
     - name: Restore qnetd

tests/template_qdevice.yml

@@ -23,9 +23,9 @@
         - /etc/modules-load.d/softdog.conf
 
     - name: Run HA Cluster role
-      include_role:
-        name: linux-system-roles.ha_cluster
-        public: true
+      include_tasks: tasks/run_role_with_clear_facts.yml
+      vars:
+        __sr_public: true
 
     - name: Slurp generated SBD watchdog blocklist file
       slurp:

tests/template_sbd_all_options.yml

@@ -17,9 +17,9 @@
           when: not __bootc_validation | d(false)
           block:
             - name: Run HA Cluster role
-              include_role:
-                name: linux-system-roles.ha_cluster
-                public: true
+              include_tasks: tasks/run_role_with_clear_facts.yml
+              vars:
+                __sr_public: true
               when: not __bootc_validation | d(false)
 
             - name: Create QEMU deployment during bootc end-to-end test

tests/tests_bootc_e2e_cluster.yml

@@ -22,9 +22,9 @@
           when: not __bootc_validation | d(false)
           block:
             - name: Run HA Cluster role
-              include_role:
-                name: linux-system-roles.ha_cluster
-                public: true
+              include_tasks: tasks/run_role_with_clear_facts.yml
+              vars:
+                __sr_public: true
               when: not __bootc_validation | d(false)
 
             - name: Create QEMU deployment during bootc end-to-end test

tests/tests_bootc_e2e_qnetd.yml

@@ -19,10 +19,9 @@
             tasks_from: test_setup.yml
 
         - name: Run HA Cluster role
-          include_role:
-            name: linux-system-roles.ha_cluster
-            public: true
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
+            __sr_public: true
             ha_cluster_cluster_name: test-cluster
             ha_cluster_manage_firewall: true
             ha_cluster_manage_selinux: true

tests/tests_cib_acls.yml

@@ -19,10 +19,9 @@
             tasks_from: test_setup.yml
 
         - name: Run HA Cluster role
-          include_role:
-            name: linux-system-roles.ha_cluster
-            public: true
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
+            __sr_public: true
             ha_cluster_cluster_name: test-cluster
             ha_cluster_manage_firewall: true
             ha_cluster_manage_selinux: true