Fix #80 - Can't add VLAN to subnet (#81)

* fix testcase for subnet module
* Fix vlan to id resolve mechanism
  As reported in #80 it is currently not possible to resolve a vlan number
  to its id. This relies on a different structure of vlan entities. Vlan
  entities has `vlanId` instead of `id` as usual.
  We decided to use the same approach as for device_type to add `vlanId`
  as `id` to the resolved entity.
* Add changlog entry
* Add vlan domain mapping test
* Fix domain resolution in vlan module
* Cleanup conditions for selecting the correct find_* method
* Add comment for later understanding

Author: cmeissner

changelogs/fragments/cant_add_vlan_to_subnet.yml

@@ -0,0 +1,2 @@
+bugfixes:
+- fix \#80 - Can't add VLAN to subnet through to phpipam implementation differences in different entities

plugins/module_utils/phpipam_helper.py

@@ -158,7 +158,10 @@ def find_device_type(self, device_type):
         return result
 
     def find_vlan(self, vlan):
-        return self.find_by_key(self.controller_uri, vlan)
+        result = self.find_by_key('vlan', vlan, key='number')
+        if result and 'vlanId' in result:
+            result['id'] = result['vlanId']
+        return result
 
     def find_by_key(self, controller, value, key='name'):
         """
@@ -189,7 +192,10 @@ def find_current_entity(self):
             entity = self.find_device_type(self.phpipam_params['name'])
         elif self.controller_name == 'tools/tags':
             entity = self.find_by_key(self.controller_uri, self.phpipam_params['name'], key='type')
-        elif 'tools' in self.controller_uri or self.controller_name in ['vlan', 'l2domain', 'vrf']:
+        elif self.controller_name == 'vlan':
+            entity = self.find_vlan(self.phpipam_params['vlan_id'])
+        # l2domains needs to be singular because it is derived from class name
+        elif 'tools' in self.controller_uri or self.controller_name in ['l2domain', 'vrf']:
             entity = self.find_by_key(self.controller_uri, self.phpipam_params['name'])
         else:
             entity = self.find_entity(self.controller_uri, '/' + self.phpipam_params['name'])
@@ -215,7 +221,10 @@ def _resolve_entity(self, key):
             result = self.find_device_type(self.phpipam_params[key])
         elif controller == 'tools/tags':
             result = self.find_by_key(controller=controller, value=self.phpipam_params[key], key='type')
-        elif 'tools' in controller or controller in ['vlan', 'l2domains', 'vrf']:
+        elif controller == 'vlan':
+            result = self.find_vlan(self.phpipam_params['vlan'])
+        # l2domains needs to be plural because it is derived from either controller parameter in entity_spec or controller_uri (which is pluralized)
+        elif 'tools' in controller or controller in ['l2domains', 'vrf']:
             result = self.find_by_key(controller=controller, value=self.phpipam_params[key])
         else:
             if entity_spec.get('type') == 'entity':

tests/test_playbooks/domain_vlan_mapping.yml

@@ -0,0 +1,48 @@
+- hosts: localhost
+  collections:
+    - codeaffen.phpipam
+  gather_facts: false
+  vars_files:
+    - vars/server.yml
+    - vars/domain.yml
+    - vars/vlan.yml
+  tasks:
+    - name: create domains for mapping test
+      include: 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
+      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
+      vars:
+        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
+      vars:
+        name: delete {{ loop_domain_data['name'] }}
+        override:
+          state: absent
+        domain: "{{ loop_domain_data | combine(override) }}"
+      loop: "{{ vlan_mapping_base_domain_data }}"
+      loop_control:
+        loop_var: loop_domain_data

tests/test_playbooks/tasks/subnet.yml

@@ -11,8 +11,8 @@
     description: "{{ subnet.description | default(omit) }}"
     section: "{{ subnet.section | default(omit) }}"
     linked_subnet: "{{ subnet.linked_subnet | default(omit) }}"
-    vlan_id: "{{ subnet.vlan_id | default(omit) }}"
-    vrf_id: "{{ subnet.vrf_id | default(omit) }}"
+    vlan: "{{ subnet.vlan | default(omit) }}"
+    vrf: "{{ subnet.vrf | default(omit) }}"
     master_subnet.cidr: "{{ subnet.master_subnet.cidr | default(omit) }}"
     nameserver: "{{ subnet.nameserver | default(omit) }}"
     show_as_name: "{{ subnet.show_as_name | default(omit) }}"

tests/test_playbooks/vars/domain.yml

@@ -1,5 +1,13 @@
 ---
 base_domain_data:
-  name: my routing domain
+  name: routing domain
   sections:
     - Customers
+
+vlan_mapping_base_domain_data:
+  - name: routing domain 1
+    sections:
+      - Customers
+  - name: routing domain 2
+    sections:
+      - Customers

tests/test_playbooks/vars/subnet.yml

@@ -2,6 +2,7 @@
 base_subnet_data:
   cidr: 10.0.0.0/24
   section: "Customers"
+  vlan: 2001
 
 subnets:
   - cidr: 192.0.2.0/24

tests/test_playbooks/vars/vlan.yml

@@ -3,3 +3,13 @@ base_vlan_data:
   name: ansible_test
   description: test vlan
   vlan_id: 1337
+
+vlan_mapping_base_vlan_data:
+  - name: vlan 1
+    description: domain vlan mappinng test 1
+    vlan_id: 1001
+    routing_domain: routing domain 1
+  - name: vlan 2
+    description: domain vlan mappinng test 2
+    vlan_id: 1002
+    routing_domain: routing domain 2