Enhance test suite (#95)

* Setup matrix build to test our modules against main versions of
  phpipam
* Update test to meet best practices
* Add changelog entry
* move actions to nodejs 16 versions

Author: cmeissner

.github/workflows/main.yml

@@ -6,12 +6,17 @@ jobs:
   test:
     name: end to end tests
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        phpipam-version: ['1.4x', '1.5x']
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: setup phpipam
-        uses: codeaffen/phpipam-action@v1
+        uses: codeaffen/phpipam-action@v2
+        with:
+          ipam_version: ${{ matrix.phpipam-version }}
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
           python-version: '3.x'
       - name: setup test environment

changelogs/fragments/level_up_tests.yml

@@ -0,0 +1,8 @@
+bugfixes:
+  - Enhance test suite by running test agains main phpipam versions as matrix build
+  - Update test playbooks to meet best practices for ansible 2.10.x
+    - use FQCNs
+    - migrate from `include` to `include_tasks`
+    - Add missing names
+    - Start names with upper case letters
+  - move to nodejs 16 for `checkout` and `setup-python` action

tests/test_playbooks/address.yml

@@ -1,34 +1,35 @@
 ---
-- hosts: localhost
+- name: Address module tests
+  hosts: localhost
   collections:
     - codeaffen.phpipam
   gather_facts: false
   vars_files:
     - vars/server.yml
     - vars/address.yml
   tasks:
-    - name: create address
-      include: tasks/address.yml
+    - name: Create address
+      ansible.builtin.include_tasks: tasks/address.yml
       vars:
         name: create address
         address: "{{ base_address_data }}"
 
-    - name: create address again, no change
-      include: tasks/address.yml
+    - name: Create address again, no change
+      ansible.builtin.include_tasks: tasks/address.yml
       vars:
         name: create address again, no change
         address: "{{ base_address_data }}"
 
-    - name: update address
-      include: tasks/address.yml
+    - name: Update address
+      ansible.builtin.include_tasks: tasks/address.yml
       vars:
         name: update address
         override:
           description: address updated
         address: "{{ base_address_data | combine(override) }}"
 
-    - name: delete address
-      include: tasks/address.yml
+    - name: Delete address
+      ansible.builtin.include_tasks: tasks/address.yml
       vars:
         name: delete address
         override:

tests/test_playbooks/device.yml

@@ -1,35 +1,36 @@
 ---
-- hosts: localhost
+- name: Device module tests
+  hosts: localhost
   collections:
     - codeaffen.phpipam
   gather_facts: false
   vars_files:
     - vars/server.yml
     - vars/device.yml
   tasks:
-    - name: create device
-      include: tasks/device.yml
+    - name: Create device
+      ansible.builtin.include_tasks: tasks/device.yml
       vars:
         name: create device
         device: "{{ base_device_data }}"
 
-    - name: create device again, no change
-      include: tasks/device.yml
+    - name: Create device again, no change
+      ansible.builtin.include_tasks: tasks/device.yml
       vars:
         name: create device again, no change
         device: "{{ base_device_data }}"
 
-    - name: update device
-      include: tasks/device.yml
+    - name: Update device
+      ansible.builtin.include_tasks: tasks/device.yml
       vars:
         name: update device
         override:
           description: device updated
           snmp_community: 'my secret community'
         device: "{{ base_device_data | combine(override) }}"
 
-    - name: delete device
-      include: tasks/device.yml
+    - name: Delete device
+      ansible.builtin.include_tasks: tasks/device.yml
       vars:
         name: delete device
         override:

tests/test_playbooks/device_type.yml

@@ -1,34 +1,35 @@
 ---
-- hosts: localhost
+- name: Device type module tests
+  hosts: localhost
   collections:
     - codeaffen.phpipam
   gather_facts: false
   vars_files:
     - vars/server.yml
     - vars/device_type.yml
   tasks:
-    - name: create device_type
-      include: tasks/device_type.yml
+    - name: Create device_type
+      ansible.builtin.include_tasks: tasks/device_type.yml
       vars:
         name: create device_type
         device_type: "{{ base_device_type_data }}"
 
-    - name: create device_type again, no change
-      include: tasks/device_type.yml
+    - name: Create device_type again, no change
+      ansible.builtin.include_tasks: tasks/device_type.yml
       vars:
         name: create device_type again, no change
         device_type: "{{ base_device_type_data }}"
 
-    - name: update device_type
-      include: tasks/device_type.yml
+    - name: Update device_type
+      ansible.builtin.include_tasks: tasks/device_type.yml
       vars:
         name: update device_type
         override:
           description: device_type updated
         device_type: "{{ base_device_type_data | combine(override) }}"
 
-    - name: delete device_type
-      include: tasks/device_type.yml
+    - name: Delete device_type
+      ansible.builtin.include_tasks: tasks/device_type.yml
       vars:
         name: delete device_type
         override:

tests/test_playbooks/domain.yml

@@ -1,34 +1,35 @@
 ---
-- hosts: localhost
+- name: Domain module tests
+  hosts: localhost
   collections:
     - codeaffen.phpipam
   gather_facts: false
   vars_files:
     - vars/server.yml
     - vars/domain.yml
   tasks:
-    - name: create domain
-      include: tasks/domain.yml
+    - name: Create domain
+      ansible.builtin.include_tasks: tasks/domain.yml
       vars:
         name: create domain
         domain: "{{ base_domain_data }}"
 
-    - name: create domain again, no change
-      include: tasks/domain.yml
+    - name: Create domain again, no change
+      ansible.builtin.include_tasks: tasks/domain.yml
       vars:
         name: create domain again, no change
         domain: "{{ base_domain_data }}"
 
-    - name: update domain
-      include: tasks/domain.yml
+    - name: Update domain
+      ansible.builtin.include_tasks: tasks/domain.yml
       vars:
         name: update domain
         override:
           description: domain updated
         domain: "{{ base_domain_data | combine(override) }}"
 
-    - name: delete domain
-      include: tasks/domain.yml
+    - name: Delete domain
+      ansible.builtin.include_tasks: tasks/domain.yml
       vars:
         name: delete domain
         override:

tests/test_playbooks/domain_vlan_mapping.yml

@@ -1,4 +1,5 @@
-- hosts: localhost
+- name: Domain vlan mapping tests
+  hosts: localhost
   collections:
     - codeaffen.phpipam
   gather_facts: false
@@ -7,37 +8,37 @@
     - vars/domain.yml
     - vars/vlan.yml
   tasks:
-    - name: create domains for mapping test
-      include: tasks/domain.yml
+    - name: Create domains for mapping test
+      ansible.builtin.include_tasks: tasks/domain.yml
       vars:
         name: create {{ loop_domain_data['name'] }}
         domain: "{{ loop_domain_data }}"
       loop: "{{ vlan_mapping_base_domain_data }}"
       loop_control:
         loop_var: loop_domain_data
 
-    - name: create vlans for mapping test
-      include: tasks/vlan.yml
+    - name: Create vlans for mapping test
+      ansible.builtin.include_tasks: tasks/vlan.yml
       vars:
         name: create vlan {{ loop_vlan_data['name'] }}
         vlan: "{{ loop_vlan_data }}"
       loop: "{{ vlan_mapping_base_vlan_data }}"
       loop_control:
         loop_var: loop_vlan_data
 
-    - name: delete vlans
-      include: tasks/vlan.yml
+    - name: Delete vlans
+      ansible.builtin.include_tasks: tasks/vlan.yml
       vars:
-        name: delete vlan {{ vlan['name'] }}
+        name: Delete vlan {{ vlan['name'] }}
         override:
           state: absent
         vlan: "{{ loop_vlan_data | combine(override) }}"
       loop: "{{ vlan_mapping_base_vlan_data }}"
       loop_control:
         loop_var: loop_vlan_data
 
-    - name: delete domains
-      include: tasks/domain.yml
+    - name: Delete domains
+      ansible.builtin.include_tasks: tasks/domain.yml
       vars:
         name: delete {{ loop_domain_data['name'] }}
         override:

tests/test_playbooks/domain_vlan_subnet_mapping.yml

@@ -1,4 +1,4 @@
-- name: Setup domain, vlan and subnet mapping
+- name: Domain, vlan and subnet mapping
   hosts: localhost
   collections:
     - codeaffen.phpipam
@@ -8,7 +8,7 @@
     - vars/domain_vlan_subnet_mapping.yml
   tasks:
     - name: IPAM create sections
-      include_tasks: tasks/section.yml
+      ansible.builtin.include_tasks: tasks/section.yml
       vars:
         name: "create section '{{ section.name }}'"
       loop: "{{ docker_compose_ipam_sections }}"
@@ -17,7 +17,7 @@
       tags: admin_tasks_phpipam
 
     - name: IPAM create L2 domains
-      include_tasks: tasks/domain.yml
+      ansible.builtin.include_tasks: tasks/domain.yml
       vars:
         name: "create l2 domain '{{ domain.name }}'"
       loop: "{{ docker_compose_ipam_l2_domains }}"
@@ -26,7 +26,7 @@
       tags: admin_tasks_phpipam
 
     - name: Create VLANS
-      include_tasks: tasks/vlan.yml
+      ansible.builtin.include_tasks: tasks/vlan.yml
       vars:
         name: "create vlans '{{ vlan.name }}'"
       loop: "{{ docker_compose_ipam_vlans }}"
@@ -35,7 +35,7 @@
       tags: admin_tasks_phpipam
 
     - name: Create IP subnets
-      include_tasks: tasks/subnet.yml
+      ansible.builtin.include_tasks: tasks/subnet.yml
       vars:
         name: "create subnet '{{ subnet.name }}'"
       loop: "{{ docker_compose_ipam_subnets }}"

tests/test_playbooks/example_setup.yml

@@ -1,5 +1,6 @@
 ---
-- hosts: localhost
+- name: Simple example setup
+  hosts: localhost
   collections:
     - codeaffen.phpipam
   gather_facts: false
@@ -8,29 +9,30 @@
     - vars/section.yml
     - vars/subnet.yml
   tasks:
-    - name: setup data
+    - name: Setup data
+      when: cleanup is not defined
       block:
-      - name: create sections
-        include: tasks/section.yml
-        vars:
-          name: "{{ section.name }}"
-        loop: "{{ sections }}"
-        loop_control:
-          loop_var: section
+        - name: Create sections
+          ansible.builtin.include_tasks: tasks/section.yml
+          vars:
+            name: "{{ section.name }}"
+          loop: "{{ sections }}"
+          loop_control:
+            loop_var: section
 
-      - name: create subnets
-        include: tasks/subnet.yml
-        vars:
-          name: "{{ subnet.cidr }}"
-        loop: "{{ subnets }}"
-        loop_control:
-          loop_var: subnet
-      when: cleanup is not defined
+        - name: Create subnets
+          ansible.builtin.include_tasks: tasks/subnet.yml
+          vars:
+            name: "{{ subnet.cidr }}"
+          loop: "{{ subnets }}"
+          loop_control:
+            loop_var: subnet
 
-    - name: cleanup data
+    - name: Cleanup data
+      when: cleanup is defined
       block:
-        - name: remove subnets
-          include: tasks/subnet.yml
+        - name: Remove subnets
+          ansible.builtin.include_tasks: tasks/subnet.yml
           vars:
             name: "{{ subnet_loop.cidr }}"
             override:
@@ -40,8 +42,8 @@
           loop_control:
             loop_var: subnet_loop
 
-        - name: remove sections
-          include: tasks/section.yml
+        - name: Remove sections
+          ansible.builtin.include_tasks: tasks/section.yml
           vars:
             name: "{{ section_loop.name }}"
             override:
@@ -50,4 +52,3 @@
           loop: "{{ sections | reverse | list }}"
           loop_control:
             loop_var: section_loop
-      when: cleanup is defined