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/cleanup.yml

@@ -1,8 +1,8 @@
 ---
 - name: Reset settings and provider to os default
-  include_role:
-    name: linux-system-roles.timesync
+  include_tasks: tasks/run_role_with_clear_facts.yml
   vars:
+    __sr_public: true
     timesync_ntp_provider: "{{ timesync_ntp_provider_os_default }}"
     timesync_ptp_domains: []
     timesync_ntp_servers: []

tests/tasks/run_role_with_clear_facts.yml

@@ -0,0 +1,37 @@
+---
+# Task file: clear_facts, run linux-system-roles.timesync.
+# 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.timesync
+        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.timesync
+    tasks_from: "{{ __sr_tasks_from | default('main') }}"
+    public: "{{ __sr_public | default(false) }}"
+  when: __sr_failed_when | d(true)

tests/tasks/setup.yml

@@ -28,6 +28,12 @@
     __required_facts: "{{ __timesync_required_facts + ['default_ipv4'] }}"
     __required_facts_subsets: "{{ ['!all', '!min'] + __required_facts }}"
 
+# This var is used in several tests and must be a fact not a var due
+# to the clear_facts task.
+- name: Set var for default_ipv4 interface fact
+  set_fact:
+    __timesync_default_ipv4_interface: "{{ ansible_facts['default_ipv4']['interface'] }}"
+
 - name: Debug
   debug:
     msg: facts {{ ansible_facts | to_nice_json }}

tests/tests_chrony.yml

@@ -22,9 +22,9 @@
 
   tasks:
     - name: Run the role
-      include_role:
-        name: linux-system-roles.timesync
-        public: true
+      include_tasks: tasks/run_role_with_clear_facts.yml
+      vars:
+        __sr_public: true
       when: not __bootc_validation | d(false)
 
     - name: Run the role only to get vars needed for validation

tests/tests_default.yml

@@ -1,6 +1,6 @@
 ---
 - name: Ensure that the role runs with default parameters
   hosts: all
-  gather_facts: false
-  roles:
-    - linux-system-roles.timesync
+  tasks:
+    - name: Run linux-system-roles.timesync
+      include_tasks: tasks/run_role_with_clear_facts.yml

tests/tests_default_vars.yml

@@ -3,9 +3,9 @@
   hosts: all
   tasks:
     - name: Include the timesync role
-      include_role:
-        name: linux-system-roles.timesync
-        public: true
+      include_tasks: tasks/run_role_with_clear_facts.yml
+      vars:
+        __sr_public: true
 
     - name: Check that public vars are defined
       assert:

tests/tests_ntp.yml

@@ -24,9 +24,9 @@
     timesync_ntp_hwts_interfaces: ["*"]
   tasks:
     - name: Run the role
-      include_role:
-        name: linux-system-roles.timesync
-        public: true
+      include_tasks: tasks/run_role_with_clear_facts.yml
+      vars:
+        __sr_public: true
 
     - name: Run test
       tags: tests::verify

tests/tests_ntp_provider1.yml

@@ -4,8 +4,6 @@
   vars:
     timesync_ntp_servers:
       - hostname: 172.16.123.1
-  roles:
-    - linux-system-roles.timesync
 
   pre_tasks:
     - name: Common test setup tasks
@@ -25,6 +23,10 @@
             - chrony
             - ntp
 
+  tasks:
+    - name: Run linux-system-roles.timesync
+      include_tasks: tasks/run_role_with_clear_facts.yml
+
   post_tasks:
     - name: Verify provider is working
       tags: tests::verify

tests/tests_ntp_provider2.yml

@@ -4,8 +4,6 @@
   vars:
     timesync_ntp_servers:
       - hostname: 172.16.123.1
-  roles:
-    - linux-system-roles.timesync
 
   pre_tasks:
     - name: Common test setup tasks
@@ -39,6 +37,10 @@
             state: "{{ 'started' if __timesync_is_booted else omit }}"
             enabled: true
 
+  tasks:
+    - name: Run linux-system-roles.timesync
+      include_tasks: tasks/run_role_with_clear_facts.yml
+
   post_tasks:
     - name: Verify chronyd running
       tags: tests::verify

tests/tests_ntp_provider3.yml

@@ -4,8 +4,6 @@
   vars:
     timesync_ntp_servers:
       - hostname: 172.16.123.1
-  roles:
-    - linux-system-roles.timesync
 
   pre_tasks:
     - name: Common test setup tasks
@@ -39,6 +37,10 @@
             state: "{{ 'started' if __timesync_is_booted else omit }}"
             enabled: true
 
+  tasks:
+    - name: Run linux-system-roles.timesync
+      include_tasks: tasks/run_role_with_clear_facts.yml
+
   post_tasks:
     - name: Verify ntpd is running
       tags: tests::verify