refactor: support Ansible 2.19

The big problem was trying to use `vars` with `import_playbook`.

We do not need to use `import_playbook` when `include_tasks` will
work.  Perhaps the original author of these tests thought that
the play `roles` keyword was the only way to invoke roles, so
that had to be "called" using an `import_playbook`?

Use `include_tasks` instead of `import_playbook`, and move some
of those "tasks" playbooks to be tasks files in tests/tasks.

Use `include_role` instead of `import_role`.

Do not set variables using `set_fact` if they have already been
set at the appropriate scope using `vars`.

"Modernize" the code somewhat.

Improve formatting.

Work around an Ansible bug ansible/ansible#85394

Signed-off-by: Rich Megginson <[email protected]>

Author: richm

tests/playbooks/down_profile+delete_interface.yml

@@ -4,65 +4,52 @@
   hosts: all
   vars:
     interface: LSR-TST-br31
-
   tasks:
-    - name: "Set interface={{ interface }}"
-      set_fact:
-        interface: "{{ interface }}"
     - name: Include the task 'show_interfaces.yml'
       include_tasks: tasks/show_interfaces.yml
+
     - name: Include the task 'assert_device_absent.yml'
       include_tasks: tasks/assert_device_absent.yml
 
-- name: Add test bridge
-  hosts: all
-  vars:
-    network_connections:
-      - name: "{{ interface }}"
-        interface_name: "{{ interface }}"
-        state: up
-        type: bridge
-        ip:
-          dhcp4: false
-          auto6: true
-  roles:
-    - linux-system-roles.network
-
-- name: Import the playbook 'run_tasks.yml'
-  import_playbook: run_tasks.yml
-  vars:
-    task: tasks/assert_device_present.yml
-
-- name: Import the playbook 'run_tasks.yml'
-  import_playbook: run_tasks.yml
-  vars:
-    profile: "{{ interface }}"
-    task: tasks/assert_profile_present.yml
-
-- name: Import the playbook 'down_profile+delete_interface.yml'
-  import_playbook: down_profile+delete_interface.yml
-  vars:
-    profile: "{{ interface }}"
-# FIXME: assert profile/device down
-
-- name: Import the playbook 'remove_profile.yml'
-  import_playbook: remove_profile.yml
-  vars:
-    profile: "{{ interface }}"
-
-- name: Import the playbook 'run_tasks.yml'
-  import_playbook: run_tasks.yml
-  vars:
-    profile: "{{ interface }}"
-    task: tasks/assert_profile_absent.yml
-
-- name: Import the playbook 'run_tasks.yml'
-  import_playbook: run_tasks.yml
-  vars:
-    task: tasks/assert_device_absent.yml
+    - name: Add test bridge
+      include_role:
+        name: linux-system-roles.network
+      vars:
+        network_connections:
+          - name: "{{ interface }}"
+            interface_name: "{{ interface }}"
+            state: up
+            type: bridge
+            ip:
+              dhcp4: false
+              auto6: true
+
+    - name: Assert device present
+      include_tasks: tasks/assert_device_present.yml
+
+    - name: Assert profile present
+      include_tasks: tasks/assert_profile_present.yml
+      vars:
+        profile: "{{ interface }}"
+
+    - name: Include the task 'down_profile+delete_interface.yml'
+      include_tasks: tasks/down_profile+delete_interface.yml
+      vars:
+        profile: "{{ interface }}"
+    # FIXME: assert profile/device down
+
+    - name: Include the task 'remove_profile.yml'
+      include_tasks: tasks/remove_profile.yml
+      vars:
+        profile: "{{ interface }}"
+
+    - name: Assert profile absent
+      include_tasks: tasks/assert_profile_absent.yml
+      vars:
+        profile: "{{ interface }}"
+
+    - name: Assert device absent
+      include_tasks: tasks/assert_device_absent.yml
 
-- name: Verify that cleanup restored state to default
-  hosts: all
-  tasks:
     - name: Verify network state restored to default
       include_tasks: tasks/check_network_dns.yml

tests/playbooks/remove_profile.yml

@@ -1,28 +1,25 @@
 # SPDX-License-Identifier: BSD-3-Clause
 ---
 - name: Test configuring bridges
-  hosts: all
-  tasks:
-    - name: Define vars
-      set_fact:
-        interface: "LSR-TST-br31"
-        cloned_mac: "12:23:34:45:56:70"
-
-- name: Add test bridge
   hosts: all
   vars:
-    network_connections:
-      - name: "{{ interface }}"
-        interface_name: "{{ interface }}"
-        state: up
-        type: bridge
-        ip:
-          dhcp4: false
-          auto6: true
-        cloned_mac: "{{ cloned_mac }}"
-  roles:
-    - linux-system-roles.network
+    interface: "LSR-TST-br31"
+    cloned_mac: "12:23:34:45:56:70"
   tasks:
+    - name: Add test bridge
+      include_role:
+        name: linux-system-roles.network
+      vars:
+        network_connections:
+          - name: "{{ interface }}"
+            interface_name: "{{ interface }}"
+            state: up
+            type: bridge
+            ip:
+              dhcp4: false
+              auto6: true
+            cloned_mac: "{{ cloned_mac }}"
+
     - name: Verify ifcfg MACADDR entry
       command: >-
         grep ^MACADDR= /etc/sysconfig/network-scripts/ifcfg-{{ interface }}
@@ -51,18 +48,15 @@
             cloned_mac_address_nm.stdout.find(cloned_mac) != -1
         msg: "cloned-mac-address is configured incorrectly"
 
-- name: Import the playbook 'down_profile+delete_interface.yml'
-  import_playbook: down_profile+delete_interface.yml
-  vars:
-    profile: "{{ interface }}"
+    - name: Include the tasks 'down_profile+delete_interface.yml'
+      include_tasks: tasks/down_profile+delete_interface.yml
+      vars:
+        profile: "{{ interface }}"
 
-- name: Import the playbook 'remove_profile.yml'
-  import_playbook: remove_profile.yml
-  vars:
-    profile: "{{ interface }}"
+    - name: Include the task 'remove_profile.yml'
+      include_tasks: tasks/remove_profile.yml
+      vars:
+        profile: "{{ interface }}"
 
-- name: Verify that cleanup restored state to default
-  hosts: all
-  tasks:
     - name: Verify network state restored to default
       include_tasks: tasks/check_network_dns.yml

tests/playbooks/tests_bridge.yml

@@ -5,24 +5,20 @@
   vars:
     type: veth
     interface: ethtest0
-
-
   tasks:
-    - name: "Set type={{ type }} and interface={{ interface }}"  # noqa name
-      set_fact:
-        type: "{{ type }}"
-        interface: "{{ interface }}"
     - name: Include the task 'show_interfaces.yml'
       include_tasks: tasks/show_interfaces.yml
+
     - name: Include the task 'manage_test_interface.yml'
       include_tasks: tasks/manage_test_interface.yml
       vars:
         state: present
+
     - name: Include the task 'assert_device_present.yml'
       include_tasks: tasks/assert_device_present.yml
 
-    - name: Import network role
-      import_role:
+    - name: Include network role
+      include_role:
         name: linux-system-roles.network
       vars:
         network_connections:
@@ -120,24 +116,24 @@
           - "'9999' in ipv6_dns.stdout"
         msg: "DNS priority is configured incorrectly"
 
-- name: Import the playbook 'down_profile+delete_interface.yml'
-  import_playbook: down_profile+delete_interface.yml
-  vars:
-    profile: "{{ interface }}"
-# FIXME: assert profile/device down
-- name: Import the playbook 'remove_profile.yml'
-  import_playbook: remove_profile.yml
-  vars:
-    profile: "{{ interface }}"
-- name: Assert profile and device are absent
-  hosts: all
-  tasks:
+    - name: Include the tasks 'down_profile+delete_interface.yml'
+      include_tasks: tasks/down_profile+delete_interface.yml
+      vars:
+        profile: "{{ interface }}"
+
+    # FIXME: assert profile/device down
+    - name: Include the task 'remove_profile.yml'
+      include_tasks: tasks/remove_profile.yml
+      vars:
+        profile: "{{ interface }}"
+
     - name: Include the task 'assert_profile_absent.yml'
       include_tasks: tasks/assert_profile_absent.yml
       vars:
         profile: "{{ interface }}"
+
     - name: Include the task 'assert_device_absent.yml'
       include_tasks: tasks/assert_device_absent.yml
+
     - name: Verify network state restored to default
       include_tasks: tasks/check_network_dns.yml
-...

tests/playbooks/tests_bridge_cloned_mac.yml

@@ -1,81 +1,69 @@
 # SPDX-License-Identifier: BSD-3-Clause
 ---
-- name: Play for showing the network provider
+- name: Test configuring ethernet devices
   hosts: all
+  vars:
+    type: veth
+    interface: lsr27
   tasks:
     - name: Show inside ethernet tests
       debug:
         msg: Inside ethernet tests
+
     - name: Show network_provider
       debug:
         var: network_provider
 
-- name: Test configuring ethernet devices
-  hosts: all
-  vars:
-    type: veth
-    interface: lsr27
-
-  tasks:
-    - name: "Set type={{ type }} and interface={{ interface }}"  # noqa name
-      set_fact:
-        type: "{{ type }}"
-        interface: "{{ interface }}"
     - name: Include the task 'show_interfaces.yml'
       include_tasks: tasks/show_interfaces.yml
+
     - name: Include the task 'manage_test_interface.yml'
       include_tasks: tasks/manage_test_interface.yml
       vars:
         state: present
+
     - name: Include the task 'assert_device_present.yml'
       include_tasks: tasks/assert_device_present.yml
 
-- name: Test static interface up
-  hosts: all
-  vars:
-    network_connections:
-      - name: "{{ interface }}"
-        interface_name: "{{ interface }}"
-        state: up
-        type: ethernet
-        autoconnect: true
-        ip:
-          address: 192.0.2.1/24
-  roles:
-    - linux-system-roles.network
-  tasks:
+    - name: Test static interface up
+      include_role:
+        name: linux-system-roles.network
+      vars:
+        network_connections:
+          - name: "{{ interface }}"
+            interface_name: "{{ interface }}"
+            state: up
+            type: ethernet
+            autoconnect: true
+            ip:
+              address: 192.0.2.1/24
+
     - name: Include the task 'assert_output_in_stderr_without_warnings.yml'
       include_tasks: tasks/assert_output_in_stderr_without_warnings.yml
 
-- name: Play for cleaning up the test device and the connection profile
-  hosts: all
-  tasks:
     - name: Show network_provider
       debug:
         var: network_provider
 
-# FIXME: assert profile present
-# FIXME: assert profile/device up + IP address
-- name: Import the playbook 'down_profile+delete_interface.yml'
-  import_playbook: down_profile+delete_interface.yml
-  vars:
-    profile: "{{ interface }}"
-# FIXME: assert profile/device down
-- name: Import the playbook 'remove_profile.yml'
-  import_playbook: remove_profile.yml
-  vars:
-    profile: "{{ interface }}"
-- name: Assert device and profile are absent
-  hosts: all
-  tasks:
+    # FIXME: assert profile present
+    # FIXME: assert profile/device up + IP address
+    - name: Include the tasks 'down_profile+delete_interface.yml'
+      include_tasks: tasks/down_profile+delete_interface.yml
+      vars:
+        profile: "{{ interface }}"
+
+    # FIXME: assert profile/device down
+    - name: Include the task 'remove_profile.yml'
+      include_tasks: tasks/remove_profile.yml
+      vars:
+        profile: "{{ interface }}"
+
     - name: Include the task 'assert_profile_absent.yml'
       include_tasks: tasks/assert_profile_absent.yml
       vars:
         profile: "{{ interface }}"
     - name: Include the task 'assert_device_absent.yml'
       include_tasks: tasks/assert_device_absent.yml
-- name: Verify that cleanup restored state to default
-  hosts: all
-  tasks:
+
     - name: Verify network state restored to default
       include_tasks: tasks/check_network_dns.yml