Fix #93 - trouble creating subnet with a vrf (#94)

* Implement find_vrf method
* Fix phpipam_name in vrf module
* Create test case to reproduce the issue
* Add `ansible-lint` to dev requirements
* Add changelog entry

Author: cmeissner

changelogs/fragments/trouble_creating_subnet_with_a_vrf.yml

@@ -0,0 +1,2 @@
+bugfixes:
+  - fix \#93 - trouble creating subnet with a vrf

plugins/module_utils/phpipam_helper.py

@@ -188,6 +188,28 @@ def find_vlan(self, number, domain='default'):
 
         return result
 
+    def find_vrf(self, vrf, section=None):
+        # As vrfs should link to subnets in a clean way the vrf module only allow a single vrf with a given name
+        # We also need to guarantee that a vrf belongs to the same section as the related subnet
+        # This method implements the logic to guarantee all that suff in a clean way.
+        result = self.find_by_key('vrfs', vrf)
+
+        if result:
+            # If we resolve a vrf for a subnet we need to check if the vrf belongs to the same section
+            if section:
+                _section_id = self.find_entity('sections', '/' + section)
+
+                if _section_id is None:
+                    self.fail_json(msg="Found no results while searching for section '{0}' ".format(section))
+
+                if _section_id['id'] not in result['sections']:
+                    self.fail_json(msg="Found no vrf '{0}' that belongs to section '{1}' ".format(vrf, section))
+
+            if 'vrfId' in result:
+                result['id'] = result['vrfId']
+
+        return result
+
     def find_by_key(self, controller, value, key='name', controller_path='/'):
         """
         Some controllers don't provide the ability to search for entities by uri
@@ -219,8 +241,10 @@ def find_current_entity(self):
             entity = self.find_by_key(self.controller_uri, self.phpipam_params['name'], key='type')
         elif self.controller_name == 'vlan':
             entity = self.find_vlan(self.phpipam_params['vlan_id'], self.phpipam_params['routing_domain'])
+        elif self.controller_name == 'vrf':
+            entity = self.find_vrf(self.phpipam_params['name'])
         # 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']:
+        elif 'tools' in self.controller_uri or self.controller_name == 'l2domain':
             entity = self.find_by_key(self.controller_uri, self.phpipam_params['name'])
         else:
             entity = self.find_entity(self.controller_uri, '/' + self.phpipam_params['name'])
@@ -248,8 +272,10 @@ def _resolve_entity(self, key):
             result = self.find_by_key(controller=controller, value=self.phpipam_params[key], key='type')
         elif controller == 'vlan':
             result = self.find_vlan(self.phpipam_params[key], self.phpipam_params['routing_domain'])
+        elif controller == 'vrf':
+            result = self.find_vrf(self.phpipam_params['vrf'], self.phpipam_params['section'])
         # 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']:
+        elif 'tools' in controller or controller == 'l2domains':
             result = self.find_by_key(controller=controller, value=self.phpipam_params[key])
         else:
             if entity_spec.get('type') == 'entity':

plugins/modules/vrf.py

@@ -81,7 +81,7 @@ class PhpipamVrfModule(PhpipamEntityAnsibleModule):
 def main():
     module = PhpipamVrfModule(
         phpipam_spec=dict(
-            id=dict(type='int', invisible=True, phpipam_name='vrfId'),
+            id=dict(type='int', invisible=True, phpipam_name='id'),
             name=dict(type='str', required=True),
             description=dict(type='str'),
             distinguisher=dict(type='str', phpipam_name='rd'),

requirements-dev.txt

@@ -1,6 +1,7 @@
 ansible
 # ansible_runner<2.0; python_version < '3.6' # pyup: ignore , disabled due to a flaw in versions < 2.1.0 , please reenable locally if absolutely needed
 ansible_runner; python_version >= '3.6' # pyup: ignore
+ansible-lint
 colour
 coverage
 geopy

tests/test_playbooks/subnet_vrf_mapping.yml

@@ -0,0 +1,22 @@
+- name: Subnet VRF mapping test
+  hosts: localhost
+  collections:
+    - codeaffen.phpipam
+  gather_facts: false
+  vars_files:
+    - vars/server.yml
+    - vars/vrf.yml
+    - vars/subnet.yml
+  tasks:
+    - name: Create vrf
+      ansible.builtin.include_tasks: tasks/vrf.yml
+      vars:
+        name: create vrf
+        vrf: "{{ base_vrf_data }}"
+    - name: Create vars/subnet.yml
+      ansible.builtin.include_tasks: tasks/subnet.yml
+      vars:
+        name: create subnet with vrf
+        override:
+          vrf: "{{ base_vrf_data.name }}"
+        subnet: "{{ base_subnet_data | combine(override) }}"