ios l3 interface update

Signed-off-by: Sumit Jaiswal <[email protected]>

Author: justjais

library/ios_l3_interface.py

@@ -93,14 +93,6 @@
               description:
               - Configures the IPv6 address for Interface.
               type: str
-            autoconfig:
-              description:
-              - Obtain address using autoconfiguration.
-              type: bool
-            dhcp:
-              description:
-              - Obtain a ipv6 address using dhcp.
-              type: bool
     state:
       choices:
       - merged
@@ -138,7 +130,7 @@
 #  encapsulation dot1Q 20
 
 - name: Merge provided configuration with device configuration
-  ios_interfaces:
+  ios_l3_interfaces:
     config:
       - name: GigabitEthernet0/1
         ipv4: 
@@ -201,7 +193,7 @@
 #  ip address 192.168.0.2 255.255.255.0
 
 - name: Replaces device configuration of listed interfaces with provided configuration
-  ios_interfaces:
+  ios_l3_interfaces:
     config:
       - name: GigabitEthernet0/2
         ipv4:
@@ -263,14 +255,14 @@
 #  ip address 192.168.0.2 255.255.255.0
 
 - name: Override device configuration of all interfaces with provided configuration
-  ios_interfaces:
+  ios_l3_interfaces:
     config:
       - name: GigabitEthernet0/2
         ipv4:
         - address: 192.168.0.1/24
       - name: GigabitEthernet0/3.100
         ipv6:
-        - autoconfig: True
+        - address: autoconfig
     operation: overridden
 
 # After state:
@@ -319,7 +311,7 @@
 #  ip address 192.168.0.2 255.255.255.0
 
 - name: Delete attributes of given interfaces (Note: This won't delete the interface itself)
-  ios_interfaces:
+  ios_l3_interfaces:
     config:
       - name: GigabitEthernet0/2
       - name: GigabitEthernet0/3

module_utils/ios/config/l3_interfaces/l3_interfaces.py

@@ -17,7 +17,7 @@
 from ansible.module_utils.ios.argspec.l3_interfaces.l3_interfaces import L3_InterfacesArgs
 from ansible.module_utils.ios.config.base import ConfigBase
 from ansible.module_utils.ios.facts.facts import Facts
-
+import q
 
 class L3_Interfaces(ConfigBase, L3_InterfacesArgs):
     """
@@ -132,6 +132,8 @@ def _state_replaced(**kwargs):
             commands.extend(L3_Interfaces.clear_interface(**kwargs))
             kwargs = {'want': interface, 'have': each, 'commands': commands, 'module': module}
             commands.extend(L3_Interfaces.set_interface(**kwargs))
+        # Remove the duplicate interface call
+        commands = L3_Interfaces._remove_duplicate_interface(commands)
 
         return commands
 
@@ -162,6 +164,8 @@ def _state_overridden(**kwargs):
             commands.extend(L3_Interfaces.clear_interface(**kwargs))
             kwargs = {'want': interface, 'have': each, 'commands': commands, 'module': module}
             commands.extend(L3_Interfaces.set_interface(**kwargs))
+        # Remove the duplicate interface call
+        commands = L3_Interfaces._remove_duplicate_interface(commands)
 
         return commands
 
@@ -246,16 +250,38 @@ def validate_ipv6(value, module):
                 if not 0 <= int(address[1]) <= 128:
                     module.fail_json(msg='invalid value for mask: {}, mask should be in range 0-128'.format(address[1]))
 
+    @staticmethod
+    def validate_n_expand_ipv4(module, want):
+        # Check if input IPV4 is valid IP and expand IPV4 with its subnet mask
+        ip_addr_want = want.get('address')
+        L3_Interfaces.validate_ipv4(ip_addr_want, module)
+        ip = ip_addr_want.split('/')
+        if len(ip) == 2:
+            ip_addr_want = '{0} {1}'.format(ip[0], to_netmask(ip[1]))
+
+        return ip_addr_want
+
+    @staticmethod
+    def _remove_duplicate_interface(commands):
+        # Remove duplicate interface from commands
+        set_cmd = []
+        for each in commands:
+            if 'interface' in each:
+                interface = each
+                if interface not in set_cmd:
+                    set_cmd.append(each)
+            else:
+                set_cmd.append(each)
+
+        return set_cmd
+
     @staticmethod
     def set_interface(**kwargs):
         # Set the interface config based on the want and have config
         commands = []
         want = kwargs['want']
         have = kwargs['have']
         module = kwargs['module']
-        clear_cmds = []
-        if kwargs.get('commands'):
-            clear_cmds = kwargs['commands']
         interface = 'interface ' + want['name']
 
         # To handle Sub-Interface if encapsulation is not already configured
@@ -264,67 +290,59 @@ def set_interface(**kwargs):
                 module.fail_json(msg='IP routing on a LAN Sub-Interface is only allowed if Encapsulation'
                                      ' is configured over respective Sub-Interface'.format(want['name']))
         # To handle L3 IPV4 configuration
-        ipv4 = want.get('ipv4')
-        if ipv4:
-            for each_ip in ipv4:
-                if each_ip.get('address') == 'dhcp':
-                    if each_ip.get('dhcp_client') and (each_ip.get('dhcp_client') != have.get('dhcp_client')
-                                                       or 'no ip address' in clear_cmds):
-                        if each_ip.get('dhcp_hostname') and each_ip.get('dhcp_hostname') == have.get('dhcp_hostname'):
-                            cmd = 'ip address dhcp client-id GigabitEthernet0/{} hostname {}'.\
-                                format(each_ip.get('dhcp_client'), each_ip.get('dhcp_hostname'))
-                            L3_Interfaces._add_command_to_interface(interface, cmd, commands)
-                        else:
-                            cmd = 'ip address dhcp client-id GigabitEthernet0/{}'.format(each_ip.get('dhcp_client'))
-                            L3_Interfaces._add_command_to_interface(interface, cmd, commands)
-                    if each_ip.get('dhcp_hostname') and (each_ip.get('dhcp_hostname') != have.get('dhcp_hostname')
-                                                      or 'no ip address' in clear_cmds):
-                        cmd = 'ip address dhcp hostname {}'.format(each_ip.get('dhcp_hostname'))
-                        L3_Interfaces._add_command_to_interface(interface, cmd, commands)
-                else:
-                    ip_addr = each_ip.get('address')
-                    L3_Interfaces.validate_ipv4(ip_addr, module)
-                    ip = ip_addr.split('/')
-                    if len(ip) == 2:
-                        ip_addr = '{0} {1}'.format(ip[0], to_netmask(ip[1]))
-                    if each_ip.get('secondary'):
-                        if ip_addr != have.get('secondary_ipv4') or 'no ip address' in clear_cmds:
-                            cmd = 'ip address {} secondary'.format(ip_addr)
-                            L3_Interfaces._add_command_to_interface(interface, cmd, commands)
-                    elif have.get('ipv4') != ip_addr or 'no ip address' in clear_cmds:
-                        cmd = 'ip address {}'.format(ip_addr)
-                        L3_Interfaces._add_command_to_interface(interface, cmd, commands)
+        if want.get("ipv4"):
+            for each in want.get("ipv4"):
+                if each.get('address') != 'dhcp':
+                    ip_addr_want = L3_Interfaces.validate_n_expand_ipv4(module, each)
+                    each['address'] = ip_addr_want
+
+        want_ipv4 = set(tuple({k:v for k,v in iteritems(address) if v is not None}.items()) for address in want.get("ipv4") or [])
+        have_ipv4 = set(tuple(address.items()) for address in have.get("ipv4") or [])
+        diff = want_ipv4 - have_ipv4
+        for address in diff:
+            address = dict(address)
+            if address.get('address') != 'dhcp':
+                cmd = "ip address {}".format(address["address"])
+                if address.get("secondary"):
+                    cmd += " secondary"
+            elif address.get('address') == 'dhcp':
+                if address.get('dhcp_client') and address.get('dhcp_hostname'):
+                    cmd = "ip address dhcp client-id GigabitEthernet 0/{} hostname {}".format\
+                        (address.get('dhcp_client'),address.get('dhcp_hostname'))
+                elif address.get('dhcp_client') and not address.get('dhcp_hostname'):
+                    cmd = "ip address dhcp client-id GigabitEthernet 0/{}".format(address.get('dhcp_client'))
+                elif not address.get('dhcp_client') and address.get('dhcp_hostname'):
+                    cmd = "ip address dhcp hostname {}".format(address.get('dhcp_client'))
+
+            L3_Interfaces._add_command_to_interface(interface, cmd, commands)
 
         # To handle L3 IPV6 configuration
-        ipv6 = want.get('ipv6')
-        if ipv6:
-            for each_ip in ipv6:
-                if each_ip.get('dhcp') and (have('dhcp') or 'no ipv6 address' in clear_cmds):
-                    cmd = 'ipv6 address dhcp'
-                    L3_Interfaces._add_command_to_interface(interface, cmd, commands)
-                elif each_ip.get('autoconfig') and (have('autoconfig') or 'no ipv6 address' in clear_cmds):
-                    cmd = 'ipv6 address autoconfig'
-                    L3_Interfaces._add_command_to_interface(interface, cmd, commands)
-                else:
-                    ipv6_addr = each_ip.get('address')
-                    L3_Interfaces.validate_ipv6(ipv6_addr, module)
-                    if have.get('ipv6') != ipv6_addr.upper() or 'no ipv6 address' in clear_cmds:
-                        cmd = 'ipv6 address {}'.format(ipv6_addr)
-                        L3_Interfaces._add_command_to_interface(interface, cmd, commands)
+        want_ipv6 = set(tuple({k:v for k,v in iteritems(address) if v is not None}.items()) for address in want.get("ipv6") or [])
+        have_ipv6 = set(tuple(address.items()) for address in have.get("ipv6") or [])
+        diff = want_ipv6 - have_ipv6
+        for address in diff:
+            address = dict(address)
+            L3_Interfaces.validate_ipv6(address.get('address'), module)
+            cmd = "ipv6 address {}".format(address.get('address'))
+            L3_Interfaces._add_command_to_interface(interface, cmd, commands)
 
         return commands
 
     @staticmethod
     def clear_interface(**kwargs):
         # Delete the interface config based on the want and have config
+        count = 0
         commands = []
         want = kwargs['want']
         have = kwargs['have']
         interface = 'interface ' + want['name']
 
-        if have.get('secondary') and not want.get('secondary'):
-            cmd = 'ip address {} secondary'.format(have.get('secondary_ipv4'))
-            L3_Interfaces._remove_command_from_interface(interface, cmd, commands)
+        if have.get('ipv4') and want.get('ipv4'):
+            for each in have.get('ipv4'):
+                if each.get('secondary') and not (want.get('ipv4')[count].get('secondary')):
+                    cmd = 'ipv4 address {} secondary'.format(each.get('address'))
+                    L3_Interfaces._remove_command_from_interface(interface, cmd, commands)
+                count += 1
         if have.get('ipv4') and not want.get('ipv4'):
             L3_Interfaces._remove_command_from_interface(interface, 'ip address', commands)
         if have.get('ipv6') and not want.get('ipv6'):

module_utils/ios/facts/l3_interfaces/l3_interfaces.py

@@ -54,6 +54,7 @@ def render_config(self, spec, conf):
         :rtype: dictionary
         :returns: The generated config
         """
+        import q
         config = deepcopy(spec)
         match = re.search(r'^(\S+)', conf)
         intf = match.group(1)
@@ -63,32 +64,40 @@ def render_config(self, spec, conf):
         # populate the facts from the configuration
         config['name'] = normalize_interface(intf)
 
-        # Get the configured IPV4 details
-        ipv4 = re.findall(r"ip address (\S+.*)", conf)
-        for each in ipv4:
-            if 'secondary' in each:
-                config['secondary'] = True
-                config['secondary_ipv4'] = each.split(' secondary')[0]
+        ipv4 = []
+        ipv4_all = re.findall(r"ip address (\S+.*)", conf)
+        for each in ipv4_all:
+            each_ipv4 = dict()
+            if 'secondary' not in each and 'dhcp' not in each:
+                each_ipv4['address'] = each
+            elif 'secondary' in each:
+                each_ipv4['secondary'] = True
+                each_ipv4['address'] = each.split(' secondary')[0]
             elif 'dhcp' in each:
-                config["ipv4"] = 'dhcp'
+                each_ipv4['address'] = 'dhcp'
                 if 'hostname' in each and 'client-id' in each:
-                    config['dhcp_client'] = each.split(' hostname ')[0].split('/')[-1]
-                    config["dhcp_hostname"] = each.split(' hostname ')[-1]
-                if 'hostname' in each and not config["dhcp_hostname"]:
-                    config["dhcp_hostname"] = each.split(' hostname ')[-1]
-                if 'client-id' in each and not config['dhcp_client']:
-                    config['dhcp_client'] = each.split('/')[-1]
-            else:
-                config["ipv4"] = each
+                    each_ipv4["dhcp_hostname"] = each.split(' hostname ')[-1]
+                    each_ipv4['dhcp_client'] = each.split(' hostname ')[0].split('/')[-1]
+                if 'client-id' in each and not each_ipv4['dhcp_client']:
+                    each_ipv4['dhcp_client'] = each.split('/')[-1]
+                if 'hostname' in each and not each_ipv4["dhcp_hostname"]:
+                    each_ipv4["dhcp_hostname"] = each.split(' hostname ')[-1]
+
+            ipv4.append(each_ipv4)
+        config['ipv4'] = ipv4
 
         # Get the configured IPV6 details
-        ipv6 = re.findall(r"ipv6 address (\S+)", conf)
-        for each in ipv6:
-            config["ipv6"] = each
-            if 'autoconfig' in config["ipv6"]:
-                config['autoconfig'] = True
-            elif 'dhcp' in config['ipv6']:
-                config['dhcp'] = True
+        ipv6 = []
+        ipv6_all = re.findall(r"ipv6 address (\S+)", conf)
+        for each in ipv6_all:
+            each_ipv6 = dict()
+            if 'autoconfig' in each:
+                each_ipv6['autoconfig'] = True
+            if 'dhcp' in each:
+                each_ipv6['dhcp'] = True
+            each_ipv6['address'] = each.lower()
+            ipv6.append(each_ipv6)
+        config['ipv6'] = ipv6
 
         encapsulation = re.search(r"encapsulation (\S+)", conf)
         if encapsulation:

tests/integration/targets/ios_l3_interface/default/main.yaml

@@ -0,0 +1,2 @@
+---
+testcase: "*"

tests/integration/targets/ios_l3_interface/meta/main.yaml

@@ -0,0 +1,2 @@
+dependencies:
+  - prepare_ios_tests

tests/integration/targets/ios_l3_interface/tasks/cli.yaml

@@ -0,0 +1,16 @@
+---
+- name: collect all cli test cases
+  find:
+    paths: "{{ role_path }}/tests/cli"
+    patterns: "{{ testcase }}.yaml"
+  register: test_cases
+  delegate_to: localhost
+
+- name: set test_items
+  set_fact: test_items="{{ test_cases.files | map(attribute='path') | list }}"
+
+- name: run test cases (connection=network_cli)
+  include: "{{ test_case_to_run }}"
+  with_items: "{{ test_items }}"
+  loop_control:
+    loop_var: test_case_to_run

tests/integration/targets/ios_l3_interface/tasks/main.yaml

@@ -0,0 +1,2 @@
+---
+- { include: cli.yaml, tags: ['cli'] }

tests/integration/targets/ios_l3_interface/tests/cli/deleted.yaml

@@ -0,0 +1,29 @@
+---
+- debug:
+      msg: "START ios_l3_interfaces Deleted integration tests on connection={{ ansible_connection }}"
+
+- include_tasks: reset_config.yaml
+
+- name: Delete attributes of given interfaces (Note: This won't delete the interface itself)
+  ios_l3_interfaces:
+    config:
+      - name: GigabitEthernet0/1
+      - name: GigabitEthernet0/2
+      - name: GigabitEthernet0/3
+      - name: GigabitEthernet0/3.100
+    state: deleted
+
+- ios_facts:
+    gather_subset: net_configuration_interfaces
+
+- set_fact:
+    expected_output:
+      - name: GigabitEthernet0/1
+      - name: GigabitEthernet0/2
+      - name: GigabitEthernet0/3
+      - name: GigabitEthernet0/3.100
+- assert:
+    that:
+      - "ansible_facts.net_configuration.l3_interfaces == expected_output"
+
+- include_tasks: reset_config.yaml