[dhcp_static] Allow use of display name for netif; Error in case a in…

…terface group name is specified; Fixes #79

plugins/modules/pfsense_dhcp_static.py

@@ -144,7 +144,11 @@
 """
 
 RETURN = """
-
+netif:
+    description: The selected interface
+    returned: success
+    type: str
+    sample: 'lan'
 """
 
 from ipaddress import ip_address, ip_network
@@ -223,10 +227,15 @@ def _validate_params(self):
             self.module.fail_json(msg='A valid MAC address must be specified.')
 
         if params['netif'] is not None:
-            self.pfsense.parse_interface(params['netif'])
+            if self.pfsense.is_interface_group(params['netif']):
+                self.module.fail_json(msg='DHCP cannot be configured for interface groups')
+            else:
+                netif = self.pfsense.parse_interface(params['netif'])
+        else:
+            netif = None
 
         # find staticmaps and determine interface
-        self._find_staticmaps(params['netif'])
+        self._find_staticmaps(netif)
 
         if params['ipaddr'] is not None:
             addr = ip_address(u'{0}'.format(params['ipaddr']))
@@ -297,6 +306,8 @@ def _find_staticmaps(self, netif=None):
             else:
                 self.module.fail_json(msg="No DHCP configuration found for netif='{0}'".format(netif))
 
+        self.result['netif'] = netif
+
     def _find_target(self):
         if self.params['name'] is not None and self.params['macaddr'] is not None:
             result = self.root_elt.findall("staticmap[cid='{0}'][mac='{1}']".format(self.params['name'], self.params['macaddr']))

tests/unit/plugins/modules/fixtures/pfsense_dhcp_static_config.xml

@@ -1741,6 +1741,13 @@
 			<domain>acme.com</domain>
 		</system>
 	</wizardtemp>
+        <ifgroups>
+                <ifgroupentry>
+                        <members>opt1 opt2 opt3</members>
+                        <descr></descr>
+                        <ifname>IFGROUP1</ifname>
+                </ifgroupentry>
+        </ifgroups>
 	<vlans>
 		<vlan>
 			<if>vmx0</if>

tests/unit/plugins/modules/pfsense_module.py

@@ -110,7 +110,7 @@ def get_args_fields(self):
         except AttributeError:
             raise NotImplementedError()
 
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ return target elt from XML """
         raise NotImplementedError()
 
@@ -180,12 +180,12 @@ def do_module_test(self, obj, command=None, changed=True, failed=False, msg=None
             self.assertEqual(result['commands'], [])
         elif delete:
             self.assertTrue(self.load_xml_result())
-            target_elt = self.get_target_elt(obj, absent=True)
+            target_elt = self.get_target_elt(obj, absent=True, module_result=result)
             self.assertIsNone(target_elt)
             self.assertEqual(result['commands'], command)
         else:
             self.assertTrue(self.load_xml_result())
-            target_elt = self.get_target_elt(obj)
+            target_elt = self.get_target_elt(obj, module_result=result)
             self.assertIsNotNone(target_elt)
             self.check_target_elt(obj, target_elt, **kwargs)
             self.assertEqual(result['commands'], command)

tests/unit/plugins/modules/test_pfsense_authserver_ldap.py

@@ -30,7 +30,7 @@ def runTest():
         """ dummy function needed to instantiate this test module from another in python 2.7 """
         pass
 
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ return target elt from XML """
         root_elt = self.assert_find_xml_elt(self.xml_result, 'system')
         result = root_elt.findall("authserver[name='{0}']".format(obj['name']))

tests/unit/plugins/modules/test_pfsense_authserver_radius.py

@@ -30,7 +30,7 @@ def runTest():
         """ dummy function needed to instantiate this test module from another in python 2.7 """
         pass
 
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ return target elt from XML """
         root_elt = self.assert_find_xml_elt(self.xml_result, 'system')
         result = root_elt.findall("authserver[name='{0}']".format(obj['name']))

tests/unit/plugins/modules/test_pfsense_ca.py

@@ -71,7 +71,7 @@ def runTest():
         """ dummy function needed to instantiate this test module from another in python 2.7 """
         pass
 
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ return target elt from XML """
         root_elt = self.xml_result.getroot()
         result = root_elt.findall("ca[descr='{0}']".format(obj['name']))

tests/unit/plugins/modules/test_pfsense_dhcp_static.py

@@ -44,21 +44,24 @@ def check_target_elt(self, obj, target_elt, target_idx=-1):
         # Defaulted options
         self.check_param_equal(obj, target_elt, 'ddnsdomainkeyalgorithm', default='hmac-md5')
 
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ get the generated xml definition """
         dhcpd_elt = self.assert_find_xml_elt(self.xml_result, 'dhcpd')
+        root_elt = None
         for e in dhcpd_elt:
-            if 'netif' not in obj or e.tag == obj['netif']:
+            if 'netif' not in obj or (module_result is not None and e.tag == module_result['netif']):
                 if e.find('enable') is not None:
                     root_elt = e
                     break
 
-        if 'name' in obj and 'macaddr' in obj:
-            result = root_elt.findall("staticmap[cid='{0}'][mac='{1}']".format(obj['name'], obj['macaddr']))
-        elif 'name' in obj:
-            result = root_elt.findall("staticmap[cid='{0}']".format(obj['name']))
-        else:
-            result = root_elt.findall("staticmap[mac='{0}']".format(obj['macaddr']))
+        result = []
+        if root_elt is not None:
+            if 'name' in obj and 'macaddr' in obj:
+                result = root_elt.findall("staticmap[cid='{0}'][mac='{1}']".format(obj['name'], obj['macaddr']))
+            elif 'name' in obj:
+                result = root_elt.findall("staticmap[cid='{0}']".format(obj['name']))
+            else:
+                result = root_elt.findall("staticmap[mac='{0}']".format(obj['macaddr']))
 
         if len(result) == 1:
             return result[0]
@@ -86,6 +89,14 @@ def test_dhcp_static_create_empty(self):
         )
         self.do_module_test(obj, command=command)
 
+    def test_dhcp_static_create_display(self):
+        """ test create with netif display name """
+        obj = dict(name='test_entry', macaddr='ab:ab:ab:ab:ab:ac', ipaddr='10.0.0.101', netif='pub')
+        command = (
+            "create dhcp_static 'test_entry', macaddr='ab:ab:ab:ab:ab:ac', ipaddr='10.0.0.101'"
+        )
+        self.do_module_test(obj, command=command)
+
     def test_dhcp_static_create_wrong_subnet(self):
         """ test create with IP address in the wrong subnet """
         obj = dict(name='test_entry', macaddr='ab:ab:ab:ab:ab:ab', ipaddr='1.2.3.4', netif='opt1')
@@ -96,6 +107,11 @@ def test_dhcp_static_create_no_netif(self):
         obj = dict(name='test_entry', macaddr='ab:ab:ab:ab:ab:ab', ipaddr='1.2.3.4')
         self.do_module_test(obj, failed=True, msg='Multiple DHCP servers enabled and no netif specified')
 
+    def test_dhcp_static_create_ifgroup(self):
+        """ test create with interface group """
+        obj = dict(name='test_entry', macaddr='ab:ab:ab:ab:ab:ab', ipaddr='1.2.3.4', netif='IFGROUP1')
+        self.do_module_test(obj, failed=True, msg='DHCP cannot be configured for interface groups')
+
     def test_dhcp_static_create_invalid_macaddr(self):
         """ test create with invalid macaddr """
         msg = 'A valid MAC address must be specified.'

tests/unit/plugins/modules/test_pfsense_gateway.py

@@ -41,7 +41,7 @@ def check_target_elt(self, obj, target_elt):
         self.check_param_equal(obj, target_elt, 'gateway')
         self.check_param_equal(obj, target_elt, 'ipprotocol', 'inet')
 
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ get the generated xml definition """
         rules_elt = self.assert_find_xml_elt(self.xml_result, 'gateways')
 

tests/unit/plugins/modules/test_pfsense_haproxy_backend.py

@@ -27,7 +27,7 @@ def __init__(self, *args, **kwargs):
     ##############
     # tests utils
     #
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ get the generated backend xml definition """
         pkgs_elt = self.assert_find_xml_elt(self.xml_result, 'installedpackages')
         hap_elt = self.assert_find_xml_elt(pkgs_elt, 'haproxy')

tests/unit/plugins/modules/test_pfsense_haproxy_backend_server.py

@@ -27,7 +27,7 @@ def __init__(self, *args, **kwargs):
     ##############
     # tests utils
     #
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ get the generated backend server xml definition """
         pkgs_elt = self.assert_find_xml_elt(self.xml_result, 'installedpackages')
         hap_elt = self.assert_find_xml_elt(pkgs_elt, 'haproxy')

tests/unit/plugins/modules/test_pfsense_interface.py

@@ -53,7 +53,7 @@ def tearDown(self):
     ##############
     # tests utils
     #
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ get the generated interface xml definition """
         elt_filter = {}
         elt_filter['descr'] = obj['descr']

tests/unit/plugins/modules/test_pfsense_ipsec.py

@@ -34,7 +34,7 @@ def get_config_file(self):
     ##############
     # tests utils
     #
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ get the generated ipsec xml definition """
         elt_filter = {}
         elt_filter['descr'] = obj['descr']

tests/unit/plugins/modules/test_pfsense_ipsec_p2.py

@@ -33,7 +33,7 @@ def get_phase1_elt(self, descr, absent=False):
         elt_filter['descr'] = descr
         return self.assert_has_xml_tag('ipsec', elt_filter, absent=absent)
 
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ get the generated phase2 xml definition """
         phase1_elt = self.get_phase1_elt(obj['p1_descr'])
 

tests/unit/plugins/modules/test_pfsense_ipsec_proposal.py

@@ -34,7 +34,7 @@ def get_config_file(self):
     ##############
     # tests utils
     #
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ get the generated proposal xml definition """
         elt_filter = {}
         elt_filter['descr'] = obj['descr']

tests/unit/plugins/modules/test_pfsense_log_settings.py

@@ -36,7 +36,7 @@ def __init__(self, *args, **kwargs):
     ##############
     # tests utils
     #
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ get the generated xml definition """
         return self.assert_find_xml_elt(self.xml_result, 'syslog')
 

tests/unit/plugins/modules/test_pfsense_nat_outbound.py

@@ -143,7 +143,7 @@ def check_rule_idx(self, params, target_idx):
                 return
         self.fail('rule not found ' + str(idx))
 
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ get the generated xml definition """
         nat_elt = self.assert_find_xml_elt(self.xml_result, 'nat')
         outbount_elt = self.assert_find_xml_elt(nat_elt, 'outbound')

tests/unit/plugins/modules/test_pfsense_nat_port_forward.py

@@ -88,7 +88,7 @@ def check_rule_idx(self, params, target_idx):
                 return
         self.fail('rule not found ' + str(idx))
 
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ get the generated xml definition """
         rules_elt = self.assert_find_xml_elt(self.xml_result, 'nat')
 

tests/unit/plugins/modules/test_pfsense_openvpn_override.py

@@ -30,7 +30,7 @@ def runTest():
         """ dummy function needed to instantiate this test module from another in python 2.7 """
         pass
 
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ return target elt from XML """
         root_elt = self.xml_result.getroot().find('openvpn')
         result = root_elt.findall("openvpn-csc[common_name='{0}']".format(obj['name']))

tests/unit/plugins/modules/test_pfsense_openvpn_server.py

@@ -54,7 +54,7 @@ def runTest():
         """ dummy function needed to instantiate this test module from another in python 2.7 """
         pass
 
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ return target elt from XML """
         root_elt = self.xml_result.getroot().find('openvpn')
         result = root_elt.findall("openvpn-server[description='{0}']".format(obj['name']))

tests/unit/plugins/modules/test_pfsense_route.py

@@ -47,7 +47,7 @@ def check_target_elt(self, obj, target_elt):
         self.check_param_equal(obj, target_elt, 'gateway')
         self.check_param_equal(obj, target_elt, 'network')
 
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ get the generated xml definition """
         root_elt = self.assert_find_xml_elt(self.xml_result, 'staticroutes')
 

tests/unit/plugins/modules/test_pfsense_rule.py

@@ -77,7 +77,7 @@ def check_rule_elt_addr(self, rule, rule_elt, addr):
         if 'not' not in addr_dict:
             self.assert_not_find_xml_elt(addr_elt, 'not')
 
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ return target elt from XML """
         obj['interface'] = self.unalias_interface(obj['interface'])
         if 'floating' in obj and obj['floating'] == 'yes':

tests/unit/plugins/modules/test_pfsense_rule_separator.py

@@ -23,7 +23,7 @@ def __init__(self, *args, **kwargs):
         self.config_file = 'pfsense_rule_separator_config.xml'
         self.pfmodule = PFSenseRuleSeparatorModule
 
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ get separator from XML """
         if obj.get('floating'):
             interface = 'floatingrules'

tests/unit/plugins/modules/test_pfsense_setup.py

@@ -54,7 +54,7 @@ def tearDown(self):
     ##############
     # tests utils
     #
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ get the generated xml definition """
         return self.assert_find_xml_elt(self.xml_result, 'system')
 

tests/unit/plugins/modules/test_pfsense_user.py

@@ -30,7 +30,7 @@ def runTest():
         """ dummy function needed to instantiate this test module from another in python 2.7 """
         pass
 
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ return target elt from XML """
         root_elt = self.assert_find_xml_elt(self.xml_result, 'system')
         result = root_elt.findall("user[name='{0}']".format(obj['name']))

tests/unit/plugins/modules/test_pfsense_vlan.py

@@ -28,7 +28,7 @@ def __init__(self, *args, **kwargs):
     # tests utils
     #
 
-    def get_target_elt(self, obj, absent=False):
+    def get_target_elt(self, obj, absent=False, module_result=None):
         """ get the generated vlan xml definition """
         elt_filter = {}
         elt_filter['if'] = self.unalias_interface(obj['interface'], physical=True)