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.

Add "architecture" to __hpc_required_facts and make the list in alphabetical order.

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

Author: richm

tests/playbooks/verify_custom_storage.yml

@@ -2,7 +2,6 @@
 ---
 - name: Verify if role configures a custom storage properly
   hosts: localhost
-  gather_facts: false
   vars:
     hpc_install_prefix: /opt
     __hpc_hpcx_info:

tests/tasks/run_role_with_clear_facts.yml

@@ -0,0 +1,38 @@
+---
+# DO NOT EDIT THIS FILE - managed by linux-system-roles/.github
+# Task file: clear_facts, run linux-system-roles.hpc.
+# 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.hpc
+        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.hpc
+    tasks_from: "{{ __sr_tasks_from | default('main') }}"
+    public: "{{ __sr_public | default(false) }}"
+  when: __sr_failed_when | d(true)

tests/tests_azure.yml

@@ -2,7 +2,6 @@
 ---
 - name: Verify if role configures a custom storage properly
   hosts: all
-  gather_facts: true
   vars:
     hpc_manage_firewall: true
     hpc_reboot_ok: true
@@ -13,5 +12,4 @@
       when: ansible_facts['system_vendor'] != "Microsoft Corporation"
 
     - name: Run the role
-      include_role:
-        name: linux-system-roles.hpc
+      include_tasks: tasks/run_role_with_clear_facts.yml

tests/tests_default.yml

@@ -2,7 +2,6 @@
 ---
 - name: Ensure that the role runs with default parameters
   hosts: all
-  gather_facts: false
   # Do not do anything in this test, otherwise fails with not enough storage
   vars:
     hpc_manage_storage: false
@@ -31,8 +30,7 @@
     - name: Run test in a block to clean up in always
       block:
         - name: Run the role
-          include_role:
-            name: linux-system-roles.hpc
+          include_tasks: tasks/run_role_with_clear_facts.yml
       always:
         - name: Cleanup
           include_tasks: tasks/cleanup.yml

tests/tests_include_vars_from_parent.yml

@@ -1,7 +1,6 @@
 ---
 - name: Test role include variable override
   hosts: all
-  gather_facts: true
   tasks:
     - name: Skip unsupported architectures
       include_tasks: tasks/skip_unsupported_archs.yml

tests/tests_skip_toolkit.yml

@@ -2,7 +2,6 @@
 ---
 - name: Verify if role configures a custom storage properly
   hosts: all
-  gather_facts: true
   vars:
     hpc_rootvg_name: rootvg
     hpc_rootlv_name: rootlv
@@ -98,8 +97,7 @@
                     mount_point: "{{ hpc_usrlv_mount }}"
 
         - name: Run the role
-          include_role:
-            name: linux-system-roles.hpc
+          include_tasks: tasks/run_role_with_clear_facts.yml
 
         # Both should be 2G
         # rootlv because it was set to 2G with the storage role

vars/main.yml

@@ -2,12 +2,13 @@
 ---
 # ansible_facts required by the role
 __hpc_required_facts:
+  - architecture
+  # required for ansible_facts["system_vendor"]
+  - devices
   - distribution
   - distribution_major_version
   - distribution_version
   - os_family
-  # required for ansible_facts["system_vendor"]
-  - devices
   # required for ansible_facts["processor_nproc"]
   - processor
 # the subsets of ansible_facts that need to be gathered in case any of the