Resource module for ios_l2_interfaces (ansible#60344)

* ios_l2_interface checkin

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

lib/ansible/module_utils/network/common/utils.py

@@ -594,6 +594,13 @@ def validate_config(spec, data):
     return validated_data
 
 
+def search_obj_in_list(name, lst, key='name'):
+    for item in lst:
+        if item[key] == name:
+            return item
+    return None
+
+
 class Template:
 
     def __init__(self):

lib/ansible/module_utils/network/ios/argspec/facts/facts.py

@@ -22,7 +22,9 @@ def __init__(self, **kwargs):
         'all',
         '!all',
         'interfaces',
-        '!interfaces'
+        '!interfaces',
+        'l2_interfaces',
+        '!l2_interfaces'
     ]
 
     argument_spec = {

lib/ansible/module_utils/network/ios/argspec/l2_interfaces/l2_interfaces.py

@@ -0,0 +1,53 @@
+#
+# -*- coding: utf-8 -*-
+# Copyright 2019 Red Hat
+# GNU General Public License v3.0+
+# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+#############################################
+#                WARNING                    #
+#############################################
+#
+# This file is auto generated by the resource
+#   module builder playbook.
+#
+# Do not edit this file manually.
+#
+# Changes to this file will be over written
+#   by the resource module builder.
+#
+# Changes should be made in the model used to
+#   generate this file or in the resource module
+#   builder template.
+#
+#############################################
+"""
+The arg spec for the ios_l2_interfaces module
+"""
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+class L2_InterfacesArgs(object):
+
+    def __init__(self, **kwargs):
+        pass
+
+    argument_spec = {'config': {'elements': 'dict',
+                                'options': {'name': {'type': 'str', 'required': True},
+                                            'access': {'type': 'dict',
+                                                       'options': {'vlan': {'type': 'int'}}
+                                                       },
+                                            'trunk': {'type': 'dict',
+                                                      'options': {'allowed_vlans': {'type': 'list'},
+                                                                  'encapsulation': {'type': 'str',
+                                                                                    'choices':
+                                                                                        ['dot1q', 'isl', 'negotiate']},
+                                                                  'native_vlan': {'type': 'int'},
+                                                                  'pruning_vlans': {'type': 'list'}}
+                                                      }},
+                                'type': 'list'},
+                     'state': {'choices': ['merged', 'replaced', 'overridden', 'deleted'],
+                               'default': 'merged',
+                               'type': 'str'}}

lib/ansible/module_utils/network/ios/config/l2_interfaces/l2_interfaces.py

@@ -0,0 +1,312 @@
+# -*- coding: utf-8 -*-
+# Copyright 2019 Red Hat Inc.
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+"""
+The ios_l2_interfaces class
+It is in this file where the current configuration (as dict)
+is compared to the provided configuration (as dict) and the command set
+necessary to bring the current configuration to it's desired end-state is
+created
+"""
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+from ansible.module_utils.network.common.cfg.base import ConfigBase
+from ansible.module_utils.network.common.utils import to_list
+from ansible.module_utils.network.ios.facts.facts import Facts
+from ansible.module_utils.network.ios.utils.utils import dict_to_set
+from ansible.module_utils.network.ios.utils.utils import remove_command_from_config_list, add_command_to_config_list
+from ansible.module_utils.network.ios.utils.utils import filter_dict_having_none_value, remove_duplicate_interface
+
+
+class L2_Interfaces(ConfigBase):
+    """
+    The ios_l2_interfaces class
+    """
+
+    gather_subset = [
+        '!all',
+        '!min',
+    ]
+
+    gather_network_resources = [
+        'l2_interfaces',
+    ]
+
+    access_cmds = {'access_vlan': 'switchport access vlan'}
+    trunk_cmds = {'encapsulation': 'switchport trunk encapsulation', 'pruning_vlans': 'switchport trunk pruning vlan',
+                  'native_vlan': 'switchport trunk native vlan', 'allowed_vlans': 'switchport trunk allowed vlan'}
+
+    def get_interfaces_facts(self):
+        """ Get the 'facts' (the current configuration)
+        :rtype: A dictionary
+        :returns: The current configuration as a dictionary
+        """
+        facts, _warnings = Facts(self._module).get_facts(self.gather_subset, self.gather_network_resources)
+        interfaces_facts = facts['ansible_network_resources'].get('l2_interfaces')
+        if not interfaces_facts:
+            return []
+
+        return interfaces_facts
+
+    def execute_module(self):
+        """ Execute the module
+        :rtype: A dictionary
+        :returns: The result from moduel execution
+        """
+        result = {'changed': False}
+        commands = []
+        warnings = []
+        existing_facts = self.get_interfaces_facts()
+        commands.extend(self.set_config(existing_facts))
+        result['before'] = existing_facts
+        if commands:
+            if not self._module.check_mode:
+                self._connection.edit_config(commands)
+            result['changed'] = True
+        result['commands'] = commands
+
+        interfaces_facts = self.get_interfaces_facts()
+
+        if result['changed']:
+            result['after'] = interfaces_facts
+        result['warnings'] = warnings
+        return result
+
+    def set_config(self, existing_facts):
+        """ Collect the configuration from the args passed to the module,
+            collect the current configuration (as a dict from facts)
+        :rtype: A list
+        :returns: the commands necessary to migrate the current configuration
+                  to the deisred configuration
+        """
+
+        want = self._module.params['config']
+        have = existing_facts
+        resp = self.set_state(want, have)
+
+        return to_list(resp)
+
+    def set_state(self, want, have):
+        """ Select the appropriate function based on the state provided
+        :param want: the desired configuration as a dictionary
+        :param have: the current configuration as a dictionary
+        :rtype: A list
+        :returns: the commands necessary to migrate the current configuration
+                  to the deisred configuration
+        """
+        commands = []
+
+        state = self._module.params['state']
+        if state == 'overridden':
+            commands = self._state_overridden(want, have, self._module)
+        elif state == 'deleted':
+            commands = self._state_deleted(want, have)
+        elif state == 'merged':
+            commands = self._state_merged(want, have, self._module)
+        elif state == 'replaced':
+            commands = self._state_replaced(want, have, self._module)
+
+        return commands
+
+    def _state_replaced(self, want, have, module):
+        """ The command generator when state is replaced
+        :param want: the desired configuration as a dictionary
+        :param have: the current configuration as a dictionary
+        :param interface_type: interface type
+        :rtype: A list
+        :returns: the commands necessary to migrate the current configuration
+                  to the deisred configuration
+        """
+        commands = []
+
+        for interface in want:
+            for each in have:
+                if each['name'] == interface['name']:
+                    break
+            else:
+                continue
+            have_dict = filter_dict_having_none_value(interface, each)
+            commands.extend(self._clear_config(dict(), have_dict))
+            commands.extend(self._set_config(interface, each, module))
+        # Remove the duplicate interface call
+        commands = remove_duplicate_interface(commands)
+
+        return commands
+
+    def _state_overridden(self, want, have, module):
+        """ The command generator when state is overridden
+        :param want: the desired configuration as a dictionary
+        :param obj_in_have: the current configuration as a dictionary
+        :rtype: A list
+        :returns: the commands necessary to migrate the current configuration
+                  to the desired configuration
+        """
+        commands = []
+
+        for each in have:
+            for interface in want:
+                if each['name'] == interface['name']:
+                    break
+            else:
+                # We didn't find a matching desired state, which means we can
+                # pretend we recieved an empty desired state.
+                interface = dict(name=each['name'])
+                kwargs = {'want': interface, 'have': each}
+                commands.extend(self._clear_config(**kwargs))
+                continue
+            have_dict = filter_dict_having_none_value(interface, each)
+            commands.extend(self._clear_config(dict(), have_dict))
+            commands.extend(self._set_config(interface, each, module))
+        # Remove the duplicate interface call
+        commands = remove_duplicate_interface(commands)
+
+        return commands
+
+    def _state_merged(self, want, have, module):
+        """ The command generator when state is merged
+        :param want: the additive configuration as a dictionary
+        :param obj_in_have: the current configuration as a dictionary
+        :rtype: A list
+        :returns: the commands necessary to merge the provided into
+                  the current configuration
+        """
+        commands = []
+
+        for interface in want:
+            for each in have:
+                if each['name'] == interface['name']:
+                    break
+            else:
+                continue
+            commands.extend(self._set_config(interface, each, module))
+
+        return commands
+
+    def _state_deleted(self, want, have):
+        """ The command generator when state is deleted
+        :param want: the objects from which the configuration should be removed
+        :param obj_in_have: the current configuration as a dictionary
+        :param interface_type: interface type
+        :rtype: A list
+        :returns: the commands necessary to remove the current configuration
+                  of the provided objects
+        """
+        commands = []
+
+        if want:
+            for interface in want:
+                for each in have:
+                    if each['name'] == interface['name']:
+                        break
+                else:
+                    continue
+                interface = dict(name=interface['name'])
+                commands.extend(self._clear_config(interface, each))
+        else:
+            for each in have:
+                want = dict()
+                commands.extend(self._clear_config(want, each))
+
+        return commands
+
+    def _check_for_correct_vlan_range(self, vlan, module):
+        # Function to check if the VLAN range passed is Valid
+        for each in vlan:
+            vlan_range = each.split('-')
+            if len(vlan_range) > 1:
+                if vlan_range[0] < vlan_range[1]:
+                    return True
+                else:
+                    module.fail_json(msg='Command rejected: Bad VLAN list - end of range not larger than the'
+                                         ' start of range!')
+            else:
+                return True
+
+    def _set_config(self, want, have, module):
+        # Set the interface config based on the want and have config
+        commands = []
+        interface = 'interface ' + want['name']
+
+        # Get the diff b/w want and have
+        want_dict = dict_to_set(want)
+        have_dict = dict_to_set(have)
+        want_trunk = dict(want_dict).get('trunk')
+        have_trunk = dict(have_dict).get('trunk')
+        if want_trunk and have_trunk:
+            diff = set(tuple(dict(want_dict).get('trunk'))) - set(tuple(dict(have_dict).get('trunk')))
+        else:
+            diff = want_dict - have_dict
+
+        if diff:
+            diff = dict(diff)
+
+            if diff.get('access'):
+                cmd = 'switchport access vlan {0}'.format(diff.get('access')[0][1])
+                add_command_to_config_list(interface, cmd, commands)
+
+            if want_trunk:
+                if diff.get('trunk'):
+                    diff = dict(diff.get('trunk'))
+                if diff.get('encapsulation'):
+                    cmd = self.trunk_cmds['encapsulation'] + ' {0}'.format(diff.get('encapsulation'))
+                    add_command_to_config_list(interface, cmd, commands)
+                if diff.get('native_vlan'):
+                    cmd = self.trunk_cmds['native_vlan'] + ' {0}'.format(diff.get('native_vlan'))
+                    add_command_to_config_list(interface, cmd, commands)
+                allowed_vlans = diff.get('allowed_vlans')
+                pruning_vlans = diff.get('pruning_vlans')
+
+                if allowed_vlans and self._check_for_correct_vlan_range(allowed_vlans, module):
+                    allowed_vlans = ','.join(allowed_vlans)
+                    cmd = self.trunk_cmds['allowed_vlans'] + ' {0}'.format(allowed_vlans)
+                    add_command_to_config_list(interface, cmd, commands)
+                if pruning_vlans and self._check_for_correct_vlan_range(pruning_vlans, module):
+                    pruning_vlans = ','.join(pruning_vlans)
+                    cmd = self.trunk_cmds['pruning_vlans'] + ' {0}'.format(pruning_vlans)
+                    add_command_to_config_list(interface, cmd, commands)
+
+        return commands
+
+    def _clear_config(self, want, have):
+        # Delete the interface config based on the want and have config
+        commands = []
+        if want.get('name'):
+            interface = 'interface ' + want['name']
+        else:
+            interface = 'interface ' + have['name']
+
+        if have.get('access') and want.get('access') is None:
+            remove_command_from_config_list(interface, L2_Interfaces.access_cmds['access_vlan'], commands)
+        elif have.get('access') and want.get('access'):
+            if have.get('access').get('vlan') != want.get('access').get('vlan'):
+                remove_command_from_config_list(interface, L2_Interfaces.access_cmds['access_vlan'], commands)
+
+        if have.get('trunk') and want.get('trunk') is None:
+            # Check when no config is passed
+            if have.get('trunk').get('encapsulation'):
+                remove_command_from_config_list(interface, self.trunk_cmds['encapsulation'], commands)
+            if have.get('trunk').get('native_vlan'):
+                remove_command_from_config_list(interface, self.trunk_cmds['native_vlan'], commands)
+            if have.get('trunk').get('allowed_vlans'):
+                remove_command_from_config_list(interface, self.trunk_cmds['allowed_vlans'], commands)
+            if have.get('trunk').get('pruning_vlans'):
+                remove_command_from_config_list(interface, self.trunk_cmds['pruning_vlans'], commands)
+        elif have.get('trunk') and want.get('trunk'):
+            # Check when config is passed, also used in replaced and override state
+            if have.get('trunk').get('encapsulation')\
+                    and have.get('trunk').get('encapsulation') != want.get('trunk').get('encapsulation'):
+                remove_command_from_config_list(interface, self.trunk_cmds['encapsulation'], commands)
+            if have.get('trunk').get('native_vlan') \
+                    and have.get('trunk').get('native_vlan') != want.get('trunk').get('native_vlan'):
+                remove_command_from_config_list(interface, self.trunk_cmds['native_vlan'], commands)
+            if have.get('trunk').get('allowed_vlans') \
+                    and have.get('trunk').get('allowed_vlans') != want.get('trunk').get('allowed_vlans'):
+                remove_command_from_config_list(interface, self.trunk_cmds['allowed_vlans'], commands)
+            if have.get('trunk').get('pruning_vlans') \
+                    and have.get('trunk').get('pruning_vlans') != want.get('trunk').get('pruning_vlans'):
+                remove_command_from_config_list(interface, self.trunk_cmds['pruning_vlans'], commands)
+
+        return commands