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.snapshot.
+# 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.snapshot
+        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.snapshot
+    tasks_from: "{{ __sr_tasks_from | default('main') }}"
+    public: "{{ __sr_public | default(false) }}"
+  when: __sr_failed_when | d(true)

tests/tests_basic.yml

@@ -39,8 +39,7 @@
           include_tasks: tasks/setup.yml
 
         - name: Run the snapshot role to create snapshot LVs
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_percent_space_required: 15
             snapshot_lvm_all_vgs: true
@@ -52,17 +51,15 @@
             that: snapshot_cmd["changed"]
 
         - name: Verify the snapshot LVs are created
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_all_vgs: true
             snapshot_lvm_snapset_name: snapset1
             snapshot_lvm_verify_only: true
             snapshot_lvm_action: check
 
         - name: Run the snapshot role again to check idempotence
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_percent_space_required: 15
             snapshot_lvm_all_vgs: true
@@ -74,8 +71,7 @@
             that: not snapshot_cmd["changed"]
 
         - name: Verify again to check idempotence
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_all_vgs: true
             snapshot_lvm_snapset_name: snapset1
@@ -87,8 +83,7 @@
             that: not snapshot_cmd["changed"]
 
         - name: Run the snapshot role remove the snapshot LVs
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_snapset_name: snapset1
             snapshot_lvm_action: remove
@@ -98,16 +93,14 @@
             that: snapshot_cmd["changed"]
 
         - name: Use the snapshot_lvm_verify option to make sure remove is done
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_snapset_name: snapset1
             snapshot_lvm_verify_only: true
             snapshot_lvm_action: remove
 
         - name: Remove again to check idempotence
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_snapset_name: snapset1
             snapshot_lvm_action: remove
@@ -117,8 +110,7 @@
             that: not snapshot_cmd["changed"]
 
         - name: Verify remove again to check idempotence
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_snapset_name: snapset1
             snapshot_lvm_verify_only: true

tests/tests_basic_bootable.yml

@@ -39,8 +39,7 @@
           include_tasks: tasks/setup.yml
 
         - name: Run the snapshot role to create snapshot LVs
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_percent_space_required: 15
             snapshot_lvm_all_vgs: true
@@ -53,17 +52,15 @@
             that: snapshot_cmd["changed"]
 
         - name: Verify the snapshot LVs are created
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_all_vgs: true
             snapshot_lvm_snapset_name: snapset1
             snapshot_lvm_verify_only: true
             snapshot_lvm_action: check
 
         - name: Run the snapshot role again to check idempotence
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_percent_space_required: 15
             snapshot_lvm_all_vgs: true
@@ -75,8 +72,7 @@
             that: not snapshot_cmd["changed"]
 
         - name: Verify again to check idempotence
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_all_vgs: true
             snapshot_lvm_snapset_name: snapset1
@@ -88,8 +84,7 @@
             that: not snapshot_cmd["changed"]
 
         - name: Run the snapshot role remove the snapshot LVs
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_snapset_name: snapset1
             snapshot_lvm_action: remove
@@ -99,16 +94,14 @@
             that: snapshot_cmd["changed"]
 
         - name: Use the snapshot_lvm_verify option to make sure remove is done
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_snapset_name: snapset1
             snapshot_lvm_verify_only: true
             snapshot_lvm_action: remove
 
         - name: Remove again to check idempotence
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_snapset_name: snapset1
             snapshot_lvm_action: remove
@@ -118,8 +111,7 @@
             that: not snapshot_cmd["changed"]
 
         - name: Verify remove again to check idempotence
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_snapset_name: snapset1
             snapshot_lvm_verify_only: true

tests/tests_default.yml

@@ -2,13 +2,13 @@
 ---
 - name: Ensure that the role runs with default parameters
   hosts: all
-  gather_facts: false  # test that role works in this case
   vars:
     # only use vgs matching this pattern
     snapshot_lvm_vg_include: "^test_"
     snapshot_lvm_action: check
     snapshot_lvm_percent_space_required: 2
     snapshot_lvm_snapset_name: snapset1
     snapshot_lvm_all_vgs: true
-  roles:
-    - linux-system-roles.snapshot
+  tasks:
+    - name: Run the role
+      include_tasks: tasks/run_role_with_clear_facts.yml

tests/tests_extend_basic.yml

@@ -36,26 +36,23 @@
           include_tasks: tasks/setup.yml
 
         - name: Run the snapshot role to create snapshot LVs
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_percent_space_required: 50
             snapshot_lvm_all_vgs: true
             snapshot_lvm_snapset_name: snapset1
             snapshot_lvm_action: snapshot
 
         - name: Verify the snapshot LVs are created
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_all_vgs: true
             snapshot_lvm_snapset_name: snapset1
             snapshot_lvm_verify_only: true
             snapshot_lvm_action: check
 
         - name: Extend the snapshots size to 60 percent of the source
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_percent_space_required: 60
             snapshot_lvm_all_vgs: true
@@ -67,8 +64,7 @@
             that: snapshot_cmd["changed"]
 
         - name: Use the snapshot_lvm_verify option to make sure extend is done
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_percent_space_required: 60
             snapshot_lvm_all_vgs: true
@@ -85,8 +81,7 @@
             that: not snapshot_cmd["changed"]
 
         - name: Extend again to check idempotence
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_percent_space_required: 60
             snapshot_lvm_all_vgs: true
@@ -98,8 +93,7 @@
             that: not snapshot_cmd["changed"]
 
         - name: Verify extend again to check idempotence
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_percent_space_required: 60
             snapshot_lvm_all_vgs: true

tests/tests_include_vars_from_parent.yml

@@ -1,7 +1,6 @@
 ---
 - name: Test role include variable override
   hosts: all
-  gather_facts: true
   vars:
     # only use vgs matching this pattern
     snapshot_lvm_vg_include: "^test_"

tests/tests_list.yml

@@ -39,26 +39,23 @@
           include_tasks: tasks/setup.yml
 
         - name: Run the snapshot role to create snapshot LVs
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_percent_space_required: 15
             snapshot_lvm_all_vgs: true
             snapshot_lvm_snapset_name: snapset1
             snapshot_lvm_action: snapshot
 
         - name: Verify the snapshot LVs are created
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_all_vgs: true
             snapshot_lvm_snapset_name: snapset1
             snapshot_lvm_verify_only: true
             snapshot_lvm_action: check
 
         - name: List
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_snapset_name: snapset1
             snapshot_lvm_action: list
@@ -68,15 +65,13 @@
             that: not snapshot_cmd["changed"]
 
         - name: Run the snapshot role remove the snapshot LVs
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_snapset_name: snapset1
             snapshot_lvm_action: remove
 
         - name: Use the snapshot_lvm_verify option to make sure remove is done
-          include_role:
-            name: linux-system-roles.snapshot
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             snapshot_lvm_snapset_name: snapset1
             snapshot_lvm_verify_only: true