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

Fix ansible-lint and ansible-test issues related newer versions of
those tools.

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

Author: richm

.sanity-ansible-ignore-2.18.txt

@@ -0,0 +1,3 @@
+plugins/modules/network_connections.py validate-modules:missing-gplv3-license
+plugins/modules/network_state.py validate-modules:missing-gplv3-license
+tests/network/ensure_provider_tests.py shebang!skip

.sanity-ansible-ignore-2.19.txt

@@ -0,0 +1,3 @@
+plugins/modules/network_connections.py validate-modules:missing-gplv3-license
+plugins/modules/network_state.py validate-modules:missing-gplv3-license
+tests/network/ensure_provider_tests.py shebang!skip

examples/down_profile.yml

@@ -176,13 +176,13 @@
         network_state:
           routes:
             config:
-            - destination: ::/0
-              next-hop-interface: eth1
-              next-hop-address: fe80::1
+              - destination: ::/0
+                next-hop-interface: eth1
+                next-hop-address: fe80::1
       ansible.builtin.include_role:
         name: linux-system-roles.network
 
-    - name: Configure the ethernet device eth1 with dhcp4 configured
+    - name: Configure the ethernet device eth1 with dhcp4 configured again
       vars:
         network_state:
           interfaces:

examples/network_state_example.yml

@@ -45,7 +45,7 @@
         hidden: true
       register: files_to_delete
 
-    - name: Remove old data
+    - name: Remove old data from files_to_delete
       file:
         path: "{{ item.path }}"
         state: absent

examples/remove+down_profile.yml

@@ -39,7 +39,7 @@
               # not take precedence over other routes or not ignore other
               # routes
               route_metric4: 65535
-    - name: Include the task 'assert_device_present.yml'
+    - name: Include the task 'assert_device_present.yml' again
       include_tasks: tasks/assert_device_present.yml
     - name: Include the task 'assert_profile_present.yml'
       include_tasks: tasks/assert_profile_present.yml
@@ -67,7 +67,7 @@
     - name: "TEARDOWN: remove profiles."
       debug:
         msg: "##################################################"
-    - name: Import network role
+    - name: Import network role to remove interface
       import_role:
         name: linux-system-roles.network
       vars:
@@ -76,19 +76,19 @@
             persistent_state: absent
             state: down
       ignore_errors: true  # noqa ignore-errors
-    - name: Include the task 'manage_test_interface.yml'
+    - name: Include the task 'manage_test_interface.yml' to remove interface
       include_tasks: tasks/manage_test_interface.yml
       vars:
         state: absent
     - name: >-
         TEST: I can configure an interface with auto_gateway disabled
       debug:
         msg: "##################################################"
-    - name: Include the task 'manage_test_interface.yml'
+    - name: Include the task 'manage_test_interface.yml' to disable auto_gateway
       include_tasks: tasks/manage_test_interface.yml
       vars:
         state: present
-    - name: Import network role
+    - name: Import network role to disable auto_gateway
       import_role:
         name: linux-system-roles.network
       vars:
@@ -105,13 +105,13 @@
                 - "203.0.113.2/24"
               gateway6: "2001:db8::1"
               gateway4: "203.0.113.1"
-    - name: Include the task 'assert_device_present.yml'
+    - name: Include the task 'assert_device_present.yml' - 3
       include_tasks: tasks/assert_device_present.yml
-    - name: Include the task 'assert_profile_present.yml'
+    - name: Include the task 'assert_profile_present.yml' again
       include_tasks: tasks/assert_profile_present.yml
       vars:
         profile: "{{ interface }}"
-    - name: "Show ipv4 routes"
+    - name: "Show ipv4 routes again"
       command: "ip route"
       register: ipv4_routes
       changed_when: false
@@ -120,7 +120,7 @@
         that: __test_str not in ipv4_routes.stdout
       vars:
         __test_str: default via 203.0.113.1 dev {{ interface }}
-    - name: "Get ipv6 routes"
+    - name: "Get ipv6 routes again"
       command: "ip -6 route"
       register: ipv6_route
       changed_when: false
@@ -130,10 +130,10 @@
       vars:
         __test_str: default via 2001:db8::1 dev {{ interface }}
       when: network_provider == "nm"
-    - name: "TEARDOWN: remove profiles."
+    - name: "TEARDOWN: remove profiles. again"
       debug:
         msg: "##################################################"
-    - name: Import network role
+    - name: Import network role to remove interface again
       import_role:
         name: linux-system-roles.network
       vars:
@@ -142,7 +142,7 @@
             persistent_state: absent
             state: down
       ignore_errors: true  # noqa ignore-errors
-    - name: Include the task 'manage_test_interface.yml'
+    - name: Include the task 'manage_test_interface.yml' to remove interface again
       include_tasks: tasks/manage_test_interface.yml
       vars:
         state: absent