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.  However, since
the tests use facts, we save and restore the facts used by the test.

Create a task file tests/tasks/run_role_with_clear_facts.yml to do the tasks
to save, clear, run the role, and restore the facts.  This uses an action plugin
merge_ansible_facts to merge the saved facts with any changes by the role.

Any 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`.

Any blocks with a `when` condition that uses `ansible_facts` has been rewritten.
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/action_plugins/merge_ansible_facts.py

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+#
+# Ansible action plugin merge_ansible_facts.
+# Merges saved facts with current Ansible facts on the controller and returns
+# ansible_facts (saved_ansible_facts with current_ansible_facts overlaid).
+#
+# Copyright: (c) 2026, Red Hat, Inc.
+# Code mostly written by Claude model claude-4.5-opus-high
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+from ansible.plugins.action import ActionBase
+
+
+class ActionModule(ActionBase):
+
+    TRANSFERS_FILES = False
+
+    def run(self, tmp=None, task_vars=None):
+        if task_vars is None:
+            task_vars = {}
+
+        result = super(ActionModule, self).run(tmp, task_vars)
+        result["changed"] = False
+
+        current = self._task.args.get("current_ansible_facts")
+        saved = self._task.args.get("saved_ansible_facts")
+
+        if current is None:
+            result["failed"] = True
+            result["msg"] = "current_ansible_facts is required"
+            return result
+        if saved is None:
+            result["failed"] = True
+            result["msg"] = "saved_ansible_facts is required"
+            return result
+
+        # Template in case args were passed as raw Jinja
+        current = self._templar.template(current)
+        saved = self._templar.template(saved)
+
+        if not isinstance(current, dict):
+            result["failed"] = True
+            result["msg"] = "current_ansible_facts must be a dict"
+            return result
+        if not isinstance(saved, dict):
+            result["failed"] = True
+            result["msg"] = "saved_ansible_facts must be a dict"
+            return result
+
+        # Merge: start with a copy of saved, overlay current (same behavior as module)
+        merged = dict(saved)
+        merged.update(current)
+        result["ansible_facts"] = merged
+
+        return result

tests/ensure_provider_tests.py

@@ -1,18 +1,18 @@
 #!/usr/bin/env python3
 # SPDX-License-Identifier: BSD-3-Clause
 """Check that there is a playbook to run all role tests with both providers"""
+
 # vim: fileencoding=utf8
 
 import difflib
 import glob
 import os
 import sys
 
-
 GET_NM_VERSION = """
     - name: Install NetworkManager and get NetworkManager version
       when:
-        - ansible_facts['distribution_major_version'] != '6'
+        - __network_distro_major_version != '6'
       tags:
         - always
       block:
@@ -30,8 +30,7 @@
               ansible_facts.packages['NetworkManager'][0]['version'] }}"
 """
 
-MINIMUM_NM_VERSION_CHECK = """
-    - networkmanager_version is version({minimum_nm_version}, '>=')
+MINIMUM_NM_VERSION_CHECK = """    - networkmanager_version is version({minimum_nm_version}, '>=')
 """
 
 EXTRA_RUN_CONDITION_PREFIX = "    - "
@@ -51,31 +50,72 @@
         network_provider: nm
       tags:
         - always
+    - name: Include distro variables
+      include_vars: vars/rh_distros_vars.yml
+    - name: Set platform facts
+      set_fact:
+        __network_distro_major_version: "{{{{ ansible_facts['distribution_major_version'] }}}}"
+        __network_is_rhel: "{{{{ ansible_facts['distribution'] == 'RedHat' }}}}"
+        __network_is_fedora: "{{{{ ansible_facts['distribution'] == 'Fedora' }}}}"
+        __network_is_centos: "{{{{ ansible_facts['distribution'] == 'CentOS' }}}}"
+        __network_is_os_family_rhel: "{{{{ ansible_facts['os_family'] == 'RedHat' }}}}"
 {get_nm_version}
 
 # The test requires or should run with NetworkManager, therefore it cannot run
 # on RHEL/CentOS 6
 {comment}- name: Import the playbook '{test_playbook}'
   import_playbook: {test_playbook}
   when:
-    - ansible_facts['distribution_major_version'] != '6'
+    - __network_distro_major_version != '6'
 {minimum_nm_version_check}{extra_run_condition}"""
 
+
+RUN_PLAYBOOK_WITH_INITSCRIPTS = """# SPDX-License-Identifier: BSD-3-Clause
+# This file was generated by ensure_provider_tests.py
+---
+# yamllint disable rule:line-length
+- name: Run playbook '{test_playbook}' with initscripts as provider
+  hosts: all
+  tasks:
+    - name: Include the task 'el_repo_setup.yml'
+      include_tasks: tasks/el_repo_setup.yml
+    - name: Set network provider to 'initscripts'
+      set_fact:
+        network_provider: initscripts
+      tags:
+        - always
+    - name: Include distro variables
+      include_vars: vars/rh_distros_vars.yml
+    - name: Set platform facts
+      set_fact:
+        __network_distro_major_version: "{{{{ ansible_facts['distribution_major_version'] }}}}"
+        __network_is_rhel: "{{{{ ansible_facts['distribution'] == 'RedHat' }}}}"
+        __network_is_fedora: "{{{{ ansible_facts['distribution'] == 'Fedora' }}}}"
+        __network_is_centos: "{{{{ ansible_facts['distribution'] == 'CentOS' }}}}"
+        __network_is_os_family_rhel: "{{{{ ansible_facts['os_family'] == 'RedHat' }}}}"
+- name: Import the playbook '{test_playbook}'
+  import_playbook: {test_playbook}
+  when:
+    - __network_is_rh_distro
+    - __network_distro_major_version | int < 9
+"""
+
+
 MINIMUM_VERSION = "minimum_version"
 EXTRA_RUN_CONDITION = "extra_run_condition"
 NM_ONLY_TESTS = {
     "playbooks/tests_802_1x_updated.yml": {
         EXTRA_RUN_CONDITION: (
-            "(ansible_facts['distribution'] != 'RedHat' and\n"
-            "       ansible_facts['distribution_major_version'] | int > 7) or\n"
-            "      ansible_facts['distribution_major_version'] | int == 8"
+            "(not __network_is_rhel and\n"
+            "       __network_distro_major_version | int > 7) or\n"
+            "      __network_distro_major_version | int == 8"
         ),
     },
     "playbooks/tests_802_1x.yml": {
         EXTRA_RUN_CONDITION: (
-            "(ansible_facts['distribution'] != 'RedHat' and\n"
-            "       ansible_facts['distribution_major_version'] | int > 7) or\n"
-            "      ansible_facts['distribution_major_version'] | int == 8"
+            "(not __network_is_rhel and\n"
+            "       __network_distro_major_version | int > 7) or\n"
+            "      __network_distro_major_version | int == 8"
         ),
     },
     "playbooks/tests_ignore_auto_dns.yml": {},
@@ -92,20 +132,20 @@
     },
     "playbooks/tests_provider.yml": {
         MINIMUM_VERSION: "'1.20.0'",
-        "comment": "# NetworKmanager 1.20.0 added support for forgetting profiles",
+        "comment": "# NetworkManager 1.20.0 added support for forgetting profiles",
         EXTRA_RUN_CONDITION: (
-            "(ansible_facts['distribution'] == 'Fedora'\n"
-            "       and ansible_facts['distribution_major_version'] | int < 41)\n"
-            "      or ansible_facts['distribution'] not in ['RedHat', 'CentOS', 'Fedora']\n"
-            "      or ansible_facts['distribution_major_version'] | int < 9"
+            "(__network_is_fedora and\n"
+            "       __network_distro_major_version | int < 41)\n"
+            "      or not __network_is_os_family_rhel\n"
+            "      or __network_distro_major_version | int < 9"
         ),
     },
     "playbooks/tests_eth_pci_address_match.yml": {
         MINIMUM_VERSION: "'1.26.0'",
         "comment": "# NetworkManager 1.26.0 added support for match.path setting",
     },
     "playbooks/tests_network_state.yml": {
-        EXTRA_RUN_CONDITION: "ansible_facts['distribution_major_version'] | int > 7",
+        EXTRA_RUN_CONDITION: "__network_distro_major_version | int > 7",
     },
     "playbooks/tests_reapply.yml": {},
     "playbooks/tests_route_table.yml": {},
@@ -117,30 +157,30 @@
     "playbooks/tests_routing_rules.yml": {},
     # teaming support dropped in EL10
     "playbooks/tests_team.yml": {
-        EXTRA_RUN_CONDITION: "ansible_facts['distribution'] not in ['RedHat', 'CentOS'] or\n      ansible_facts['distribution_major_version'] | int < 10",
+        EXTRA_RUN_CONDITION: "not __network_is_rh_distro or\n      __network_distro_major_version | int < 10",
     },
     "playbooks/tests_team_plugin_installation.yml": {
-        EXTRA_RUN_CONDITION: "ansible_facts['distribution'] not in ['RedHat', 'CentOS'] or\n      ansible_facts['distribution_major_version'] | int < 10",
+        EXTRA_RUN_CONDITION: "not __network_is_rh_distro or\n      __network_distro_major_version | int < 10",
     },
     # mac80211_hwsim (used for tests_wireless) only seems to be available
     # and working on RHEL/CentOS 7
     "playbooks/tests_wireless.yml": {
-        EXTRA_RUN_CONDITION: "ansible_facts['distribution_major_version'] == '7'",
+        EXTRA_RUN_CONDITION: "__network_distro_major_version == '7'",
     },
     "playbooks/tests_wireless_and_network_restart.yml": {},
     "playbooks/tests_wireless_plugin_installation.yml": {},
     "playbooks/tests_wireless_wpa3_owe.yml": {
         "comment": "# OWE has not been supported by NetworkManager 1.18.8 on \
 RHEL 7(dist-tag). Failed in setting up mock wifi on RHEL 8",
-        EXTRA_RUN_CONDITION: "ansible_facts['distribution_major_version'] > '7' and \
-ansible_facts['distribution'] == 'CentOS' or\n     ansible_facts['distribution_major_version'] > '32' \
-and ansible_facts['distribution'] == 'Fedora'",
+        EXTRA_RUN_CONDITION: "__network_distro_major_version | int > 7 and \
+__network_is_centos or\n     __network_distro_major_version | int > 32 \
+and __network_is_fedora",
     },
     "playbooks/tests_wireless_wpa3_sae.yml": {
         "comment": "# SAE has not been supported by NetworkManager 1.18.8 on \
 RHEL 7. Failed in setting up mock wifi on RHEL 8",
-        EXTRA_RUN_CONDITION: "ansible_facts['distribution_major_version'] != '7' and \
-ansible_facts['distribution'] != 'RedHat'",
+        EXTRA_RUN_CONDITION: "__network_distro_major_version != '7' and \
+not __network_is_rhel",
     },
 }
 # NM_CONDITIONAL_TESTS is used to store the test playbooks which are demanding for NM
@@ -168,27 +208,6 @@
     "playbooks/tests_switch_provider.yml",
 ]
 
-RUN_PLAYBOOK_WITH_INITSCRIPTS = """# SPDX-License-Identifier: BSD-3-Clause
-# This file was generated by ensure_provider_tests.py
----
-# yamllint disable rule:line-length
-- name: Run playbook '{test_playbook}' with initscripts as provider
-  hosts: all
-  tasks:
-    - name: Include the task 'el_repo_setup.yml'
-      include_tasks: tasks/el_repo_setup.yml
-    - name: Set network provider to 'initscripts'
-      set_fact:
-        network_provider: initscripts
-      tags:
-        - always
-
-- name: Import the playbook '{test_playbook}'
-  import_playbook: {test_playbook}
-  when: (ansible_facts['distribution'] in ['CentOS','RedHat'] and\n    \
-ansible_facts['distribution_major_version'] | int < 9)
-"""
-
 
 def create_nm_playbook(test_playbook):
     fileroot = os.path.splitext(os.path.basename(test_playbook))[0]

tests/library/network_connections.py

@@ -0,0 +1 @@
+../../library/network_connections.py

tests/playbooks/manual_test_ethtool_coalesce.yml

@@ -34,8 +34,7 @@
           register: original_ethtool_coalesce
           changed_when: false
         - name: Import network role
-          import_role:
-            name: linux-system-roles.network
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             network_connections:
               - name: "{{ interface }}"
@@ -57,8 +56,7 @@
           debug:
             msg: "##################################################"
         - name: Import network role
-          import_role:
-            name: linux-system-roles.network
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             network_connections:
               - name: "{{ interface }}"
@@ -91,8 +89,7 @@
           debug:
             msg: "##################################################"
         - name: Import network role
-          import_role:
-            name: linux-system-roles.network
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             network_connections:
               - name: "{{ interface }}"
@@ -118,14 +115,13 @@
             - "tests::cleanup"
           block:
             - name: Deactivate the connection and remove the connection profile
-              import_role:
-                name: linux-system-roles.network
+              include_tasks: tasks/run_role_with_clear_facts.yml
               vars:
                 network_connections:
                   - name: "{{ interface }}"
                     persistent_state: absent
                     state: down
-              failed_when: false
+                __sr_failed_when: false
             - name: Include the task 'manage_test_interface.yml'
               include_tasks: tasks/manage_test_interface.yml
               vars:

tests/playbooks/tests_802_1x.yml

@@ -16,8 +16,7 @@
           debug:
             msg: "##################################################"
         - name: Import network role
-          import_role:
-            name: linux-system-roles.network
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             network_connections:
               - name: "{{ interface }}"
@@ -48,8 +47,7 @@
           command: ping -c1 203.0.113.1
           changed_when: false
         - name: Import network role
-          import_role:
-            name: linux-system-roles.network
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             network_connections:
               - name: "{{ interface }}"
@@ -79,8 +77,7 @@
             executable: /bin/bash
           changed_when: false
         - name: Import network role
-          import_role:
-            name: linux-system-roles.network
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             network_connections:
               - name: "{{ interface }}"
@@ -105,8 +102,7 @@
           command: ping -c1 203.0.113.1
           changed_when: false
         - name: Import network role
-          import_role:
-            name: linux-system-roles.network
+          include_tasks: tasks/run_role_with_clear_facts.yml
           vars:
             network_connections:
               - name: "{{ interface }}"
@@ -121,8 +117,7 @@
             - "tests::cleanup"
           block:
             - name: Deactivate the connection and remove the connection profile
-              import_role:
-                name: linux-system-roles.network
+              include_tasks: tasks/run_role_with_clear_facts.yml
               vars:
                 network_connections:
                   - name: "{{ interface }}"
@@ -131,7 +126,7 @@
                   - name: br1
                     persistent_state: absent
                     state: down
-              failed_when: false
+                __sr_failed_when: false
             - name: Include the task 'cleanup_802_1x_server.yml'
               include_tasks: tasks/cleanup_802_1x_server.yml
             - name: Remove test certificates