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

tests/tasks/run_role_with_clear_facts.yml

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

tests/tests_basic_join.yml

@@ -2,7 +2,6 @@
 ---
 - name: Ensure that the role runs with mandatory parameters populated
   hosts: all,!ad
-  gather_facts: false  # test that role works in this case
   vars:
     # sample realm that will skip joining realm step
     ad_integration_realm: "{{ __ad_integration_sample_realm }}"
@@ -14,8 +13,7 @@
         __ad_integration_sample_realm: MiXeD.cAsE
 
     - name: Test - Run the system role
-      include_role:
-        name: linux-system-roles.ad_integration
+      include_tasks: tasks/run_role_with_clear_facts.yml
 
     - name: Test - Check packages are present
       block:

tests/tests_default.yml

@@ -2,13 +2,11 @@
 ---
 - name: Ensure role behaviour with default parameters
   hosts: all,!ad
-  gather_facts: false  # test that role works in this case
   tasks:
     - name: Verify that the role fails without ad_integration_realm variable
       block:
         - name: Include the role
-          include_role:
-            name: linux-system-roles.ad_integration
+          include_tasks: tasks/run_role_with_clear_facts.yml
 
       rescue:
         - name: Assert that user is notified about missing variables

tests/tests_dyndns.yml

@@ -19,7 +19,6 @@
 
 - name: Ensure that the role configures dynamic dns
   hosts: all,!ad
-  gather_facts: true
   vars:
     # if we don't have a real AD server, just verify the config
     # file is written properly
@@ -38,10 +37,9 @@
           when: __ad_integration_test_sssd_config_only
 
         - name: Test - Run the system role with bogus vars
-          include_role:
-            name: linux-system-roles.ad_integration
-            public: true
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
+            __sr_public: true
             ad_dyndns_iface: TESTING
             ad_dyndns_server: 127.0.0.1
             ad_dyndns_auth: GSS-TSIG
@@ -82,8 +80,7 @@
           when: sssd_log.stdout | length > 0
 
         - name: Test - Re-run the system role to remove vars
-          include_role:
-            name: linux-system-roles.ad_integration
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             ad_dyndns_iface: null
             ad_dyndns_server: null

tests/tests_full_integration.yml

@@ -62,9 +62,9 @@
       block:
 
         - name: Test run the system role
-          include_role:
-            name: linux-system-roles.ad_integration
-            public: true
+          include_tasks: tasks/run_role_with_clear_facts.yml
+          vars:
+            __sr_public: true
           register: role_run
 
         - name: Debug role_run

tests/tests_full_integration_dc.yml

@@ -69,9 +69,9 @@
       block:
 
         - name: Test run the system role
-          include_role:
-            name: linux-system-roles.ad_integration
-            public: true
+          include_tasks: tasks/run_role_with_clear_facts.yml
+          vars:
+            __sr_public: true
           register: role_run
 
         - name: Debug role_run

tests/tests_full_integration_dyndns.yml

@@ -30,7 +30,6 @@
 
 - name: Configure DynDNS on AD
   hosts: ad
-  gather_facts: true
   tasks:
     - name: Get AD address
       set_fact:
@@ -62,7 +61,6 @@
 
 - name: Ensure that the role configures dynamic dns
   hosts: client
-  gather_facts: true
   tasks:
     - name: Run the integration
       when: "'ad' in groups and groups['ad']"
@@ -73,10 +71,9 @@
               Interface {{ _ad_dyndns_iface | default(ansible_facts['default_ipv4']['interface']) }} and server
               : {{ hostvars[groups['ad'][0]].ansible_host }}
         - name: Run the system role with proper config
-          include_role:
-            name: linux-system-roles.ad_integration
-            public: true
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
+            __sr_public: true
             ad_dyndns_server: "{{ hostvars[groups['ad'][0]].ansible_host }}"
             ad_dyndns_iface: "{{ _ad_dyndns_iface | default(ansible_facts['default_ipv4']['interface']) }}"
             ad_dyndns_auth: "none"
@@ -126,7 +123,6 @@
 
 - name: Check hosts on AD
   hosts: ad
-  gather_facts: true
   tasks:
     - name: Get network for zone
       set_fact:

tests/tests_full_integration_force_rejoin.yml

@@ -65,9 +65,9 @@
       block:
 
         - name: Test run the system role
-          include_role:
-            name: linux-system-roles.ad_integration
-            public: true
+          include_tasks: tasks/run_role_with_clear_facts.yml
+          vars:
+            __sr_public: true
           register: role_run
 
         - name: Debug role_run
@@ -98,8 +98,7 @@
           changed_when: false
 
         - name: Test run the system role with force rejoin
-          include_role:
-            name: linux-system-roles.ad_integration
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             ad_integration_force_rejoin: true
           register: role_run_rejoin

tests/tests_include_vars_from_parent.yml

@@ -1,7 +1,6 @@
 ---
 - name: Test role inclusion variable overrides
   hosts: all,!ad
-  gather_facts: true
   tasks:
     - name: Create var file in caller that can override the one in called role
       delegate_to: localhost

tests/tests_manage_packages.yml

@@ -30,8 +30,7 @@
 
         # role will fail if ad_integration_manage_packages is not handled correctly
         - name: Run the role with ad_integration_manage_packages
-          include_role:
-            name: linux-system-roles.ad_integration
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             ad_integration_manage_packages: false
 

tests/tests_migrate_sssd_settings.yml

@@ -2,7 +2,6 @@
 ---
 - name: Ensure that the role migrates sssd domain settings depending on case
   hosts: all,!ad
-  gather_facts: true
   vars:
     ad_integration_realm: MIGRATE.REALM.COM
     __ad_integration_test_sssd_config_only: true
@@ -58,8 +57,7 @@
             __ad_integration_realm_list: "domain-name: {{ ad_integration_realm }}"
 
         - name: Test - Run the system role merging duplicate sssd domain sections
-          include_role:
-            name: linux-system-roles.ad_integration
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             ad_integration_sssd_custom_settings: "{{ __ad_integration_sssd_custom_settings +
               __ad_integration_sssd_custom_settings2 + __ad_integration_sssd_custom_settings3 }}"

tests/tests_preserve_authselect.yml

@@ -2,7 +2,6 @@
 ---
 - name: Ensure that the role ad_integration_preserve_authselect_profile works
   hosts: all,!ad
-  gather_facts: false  # test that role works in this case
   vars:
     # sample realm that will skip joining realm step
     ad_integration_realm: "{{ __ad_integration_sample_realm }}"
@@ -11,8 +10,7 @@
 
   tasks:
     - name: Test - Run the system role
-      include_role:
-        name: linux-system-roles.ad_integration
+      include_tasks: tasks/run_role_with_clear_facts.yml
 
     - name: Test - Check that realmd config is present
       stat:

tests/tests_sssd_custom_settings.yml

@@ -3,7 +3,6 @@
 
 - name: Ensure that the role configures dynamic dns
   hosts: all,!ad
-  gather_facts: true
   vars:
     ad_integration_realm: sssd-custom-sample-realm.com
     __ad_integration_test_sssd_config_only: true
@@ -22,9 +21,9 @@
             __manage_fake_realm: setup
 
         - name: Test - Run the system role with bogus vars
-          include_role:
-            name: linux-system-roles.ad_integration
-            public: true
+          include_tasks: tasks/run_role_with_clear_facts.yml
+          vars:
+            __sr_public: true
 
         - name: Check custom SSSD settings
           community.general.ini_file:
@@ -59,8 +58,7 @@
               map('combine', {'state': 'absent'}) | list }}"
 
         - name: Test - Re-run the system role to remove vars
-          include_role:
-            name: linux-system-roles.ad_integration
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             ad_integration_sssd_custom_settings: "{{ update_list }}"
 

tests/tests_sssd_settings.yml

@@ -3,7 +3,6 @@
 
 - name: Ensure that the role configures dynamic dns
   hosts: all,!ad
-  gather_facts: false  # test that role works in this case
   vars:
     ad_integration_realm: sample-realm.com
     __ad_integration_test_sssd_config_only: true
@@ -15,9 +14,9 @@
 
   tasks:
     - name: Test - Run the system role with bogus vars
-      include_role:
-        name: linux-system-roles.ad_integration
-        public: true
+      include_tasks: tasks/run_role_with_clear_facts.yml
+      vars:
+        __sr_public: true
 
     - name: Check SSSD settings
       community.general.ini_file:
@@ -52,8 +51,7 @@
           map('combine', {'state': 'absent'}) | list }}"
 
     - name: Test - Re-run the system role to remove vars
-      include_role:
-        name: linux-system-roles.ad_integration
+      include_tasks: tasks/run_role_with_clear_facts.yml
       vars:
         ad_integration_sssd_settings: "{{ update_list }}"