Add eos_l2_interface module and integration tests (#35162)

* Add eos_l2_interface module and integration tests

* Address PR review comments

* Fix pylint issues

lib/ansible/modules/network/eos/eos_l2_interface.py

@@ -0,0 +1,302 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# (c) 2017, Ansible by Red Hat, inc
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'network'}
+
+DOCUMENTATION = """
+---
+module: eos_l2_interface
+version_added: "2.5"
+author: "Ricardo Carrillo Cruz (@rcarrillocruz)"
+short_description: Manage L2 interfaces on Arista EOS network devices.
+description:
+  - This module provides declarative management of L2 interfaces
+    on Arist EOS network devices.
+notes:
+  - Tested against EOS 4.15
+options:
+  name:
+    description:
+      - Name of the interface
+    required: true
+    aliases: ['interface']
+  mode:
+    description:
+      - Mode in which interface needs to be configured.
+    choices: ['access','trunk']
+  access_vlan:
+    description:
+      - Configure given VLAN in access port.
+        If C(mode=access), used as the access VLAN ID.
+  native_vlan:
+    description:
+      - Native VLAN to be configured in trunk port.
+        If C(mode=trunk), used as the trunk native VLAN ID.
+  trunk_allowed_vlans:
+    description:
+      - List of allowed VLANs in a given trunk port.
+        If C(mode=trunk), these are the ONLY VLANs that will be
+        configured on the trunk, i.e. C(2-10,15).
+    aliases: ['trunk_vlans']
+  aggregate:
+    description:
+      - List of Layer-2 interface definitions.
+  state:
+    description:
+      - Manage the state of the Layer-2 Interface configuration.
+    default:  present
+    choices: ['present','absent', 'unconfigured']
+extends_documentation_fragment: eos
+"""
+
+EXAMPLES = """
+- name: Ensure Ethernet1 does not have any switchport
+  eos_l2_interface:
+    name: Ethernet1
+    state: absent
+
+- name: Ensure Ethernet1 is configured for access vlan 20
+  eos_l2_interface:
+    name: Ethernet1
+    mode: access
+    access_vlan: 20
+
+- name: Ensure Ethernet1 is a trunk port and ensure 2-50 are being tagged (doesn't mean others aren't also being tagged)
+  eos_l2_interface:
+    name: Ethernet1
+    mode: trunk
+    native_vlan: 10
+    trunk_allowed_vlans: 2-50
+
+- name: Set switchports on aggregate
+  eos_l2_interface:
+    aggregate:
+      - { name: ethernet1, mode: access, access_vlan: 20}
+      - { name: ethernet2, mode: trunk, native_vlan: 10}
+"""
+
+RETURN = """
+commands:
+  description: The list of configuration mode commands to send to the device
+  returned: always.
+  type: list
+  sample:
+    - interface ethernet1
+    - switchport access vlan 20
+"""
+import re
+from copy import deepcopy
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.network.common.config import NetworkConfig
+from ansible.module_utils.network.common.utils import remove_default_spec
+from ansible.module_utils.network.eos.eos import get_config, load_config, run_commands
+from ansible.module_utils.network.eos.eos import eos_argument_spec
+
+
+def parse_config_argument(configobj, name, arg=None):
+    cfg = configobj['interface %s' % name]
+    cfg = '\n'.join(cfg.children)
+    match = re.search(r'%s (.+)$' % arg, cfg, re.M)
+    if match:
+        return match.group(1).strip()
+
+
+def search_obj_in_list(name, lst):
+    for o in lst:
+        if o['name'] == name:
+            return o
+
+    return None
+
+
+def map_obj_to_commands(updates, module):
+    commands = list()
+    want, have = updates
+
+    for w in want:
+        name = w['name']
+        state = w['state']
+        mode = w['mode']
+        access_vlan = w['access_vlan']
+        native_vlan = w['native_vlan']
+        trunk_allowed_vlans = w['trunk_allowed_vlans']
+
+        interface = 'interface ' + name
+        commands.append(interface)
+
+        obj_in_have = search_obj_in_list(name, have)
+        if not obj_in_have:
+            module.fail_json(msg='invalid interface {0}'.format(name))
+
+        if state == 'absent':
+            if obj_in_have['state'] == 'present':
+                commands.append('no switchport')
+        else:
+            if obj_in_have['state'] == 'absent':
+                commands.append('switchport')
+                commands.append('switchport mode {0}'.format(mode))
+
+                if access_vlan:
+                    commands.append('switchport access vlan {0}'.format(access_vlan))
+
+                if native_vlan:
+                    commands.append('switchport trunk native vlan {0}'.format(native_vlan))
+
+                if trunk_allowed_vlans:
+                    commands.append('switchport trunk allowed vlan {0}'.format(trunk_allowed_vlans))
+            else:
+                if mode != obj_in_have['mode']:
+                    if obj_in_have['mode'] == 'access':
+                        commands.append('no switchport access vlan {0}'.format(obj_in_have['access_vlan']))
+                        if native_vlan:
+                            commands.append('switchport trunk native vlan {0}'.format(native_vlan))
+                        if trunk_allowed_vlans:
+                            commands.append('switchport trunk allowed vlan {0}'.format(trunk_allowed_vlans))
+                    else:
+                        if obj_in_have['native_vlan']:
+                            commands.append('not switchport trunk native vlan {0}'.format(obj_in_have['native_vlan']))
+                        if obj_in_have['trunk_allowed_vlans']:
+                            commands.append('not switchport trunk allowed vlan {0}'.format(obj_in_have['trunk_allowed_vlans']))
+                        commands.append('switchport access vlan {0}'.format(access_vlan))
+                else:
+                    if mode == 'access':
+                        if access_vlan != obj_in_have['access_vlan']:
+                            commands.append('switchport access vlan {0}'.format(access_vlan))
+                    else:
+                        if native_vlan != obj_in_have['native_vlan'] and native_vlan:
+                            commands.append('switchport trunk native vlan {0}'.format(native_vlan))
+                        if trunk_allowed_vlans != obj_in_have['trunk_allowed_vlans'] and trunk_allowed_vlans:
+                            commands.append('switchport trunk allowed vlan {0}'.format(trunk_allowed_vlans))
+
+        if commands[-1] == interface:
+            commands.pop(-1)
+
+    return commands
+
+
+def map_config_to_obj(module):
+    config = get_config(module, flags=['| section interface'])
+    configobj = NetworkConfig(indent=3, contents=config)
+
+    match = re.findall(r'^interface (\S+)', config, re.M)
+    if not match:
+        return list()
+
+    instances = list()
+
+    for item in set(match):
+        command = 'sh int {0} switchport | include Switchport'
+        switchport_cfg = run_commands(module, command.format(item))[0].split(':')[1].strip()
+        if switchport_cfg == 'Enabled':
+            state = 'present'
+        else:
+            state = 'absent'
+
+        obj = {
+            'name': item.lower(),
+            'state': state,
+        }
+
+        if state == 'present':
+            obj['access_vlan'] = parse_config_argument(configobj, item, 'switchport access vlan')
+            obj['native_vlan'] = parse_config_argument(configobj, item, 'switchport trunk native vlan')
+            obj['trunk_allowed_vlans'] = parse_config_argument(configobj, item, 'switchport trunk allowed vlan')
+            if obj['access_vlan']:
+                obj['mode'] = 'access'
+            else:
+                obj['mode'] = 'trunk'
+
+        instances.append(obj)
+
+    return instances
+
+
+def map_params_to_obj(module):
+    obj = []
+
+    aggregate = module.params.get('aggregate')
+    if aggregate:
+        for item in aggregate:
+            for key in item:
+                if item.get(key) is None:
+                    item[key] = module.params[key]
+
+            item['name'] = item['name'].lower()
+            obj.append(item.copy())
+    else:
+        obj.append({
+            'name': module.params['name'].lower(),
+            'mode': module.params['mode'],
+            'access_vlan': module.params['access_vlan'],
+            'native_vlan': module.params['native_vlan'],
+            'trunk_allowed_vlans': module.params['trunk_allowed_vlans'],
+            'state': module.params['state']
+        })
+
+    return obj
+
+
+def main():
+    """ main entry point for module execution
+    """
+    element_spec = dict(
+        name=dict(type='str', aliases=['interface']),
+        mode=dict(choices=['access', 'trunk']),
+        access_vlan=dict(type='str'),
+        native_vlan=dict(type='str'),
+        trunk_allowed_vlans=dict(type='str', aliases=['trunk_vlans']),
+        state=dict(default='present',
+                   choices=['present', 'absent'])
+    )
+
+    aggregate_spec = deepcopy(element_spec)
+    aggregate_spec['name'] = dict(required=True)
+
+    # remove default in aggregate spec, to handle common arguments
+    remove_default_spec(aggregate_spec)
+
+    argument_spec = dict(
+        aggregate=dict(type='list', elements='dict', options=aggregate_spec),
+    )
+
+    argument_spec.update(element_spec)
+    argument_spec.update(eos_argument_spec)
+
+    module = AnsibleModule(argument_spec=argument_spec,
+                           mutually_exclusive=[['access_vlan', 'native_vlan'],
+                                               ['access_vlan', 'trunk_allowed_vlans']],
+                           supports_check_mode=True)
+
+    warnings = list()
+    result = {'changed': False}
+    if warnings:
+        result['warnings'] = warnings
+
+    want = map_params_to_obj(module)
+    have = map_config_to_obj(module)
+    commands = map_obj_to_commands((want, have), module)
+    result['commands'] = commands
+
+    if commands:
+        commit = not module.check_mode
+        response = load_config(module, commands, commit=commit)
+        if response.get('diff') and module._diff:
+            result['diff'] = {'prepared': response.get('diff')}
+        result['session_name'] = response.get('session')
+        result['changed'] = True
+
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()

test/integration/targets/eos_l2_interface/defaults/main.yaml

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

test/integration/targets/eos_l2_interface/meta/main.yaml

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

test/integration/targets/eos_l2_interface/tasks/cli.yaml

@@ -0,0 +1,22 @@
+---
+- 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 }} ansible_connection=network_cli"
+  with_items: "{{ test_items }}"
+  loop_control:
+    loop_var: test_case_to_run
+
+- name: run test case (connection=local)
+  include: "{{ test_case_to_run }} ansible_connection=local ansible_become=no"
+  with_first_found: "{{ test_items }}"
+  loop_control:
+    loop_var: test_case_to_run

test/integration/targets/eos_l2_interface/tasks/eapi.yaml

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

test/integration/targets/eos_l2_interface/tasks/main.yaml

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

test/integration/targets/eos_l2_interface/tests/cli/basic.yaml

@@ -0,0 +1,137 @@
+---
+- debug: msg="START eos_l2_interface cli/basic.yaml on connection={{ ansible_connection }}"
+
+- name: Delete test interface switchports
+  eos_l2_interface:
+    name: Ethernet1
+    state: absent
+
+- name: Set switchport mode to access on vlan 4000
+  eos_l2_interface:
+    name: Ethernet1
+    state: present
+    mode: access
+    access_vlan: 4000
+    authorize: yes
+    provider: "{{ cli }}"
+  become: yes
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+
+- name: Set switchport mode to access on vlan 4000 again (idempotent)
+  eos_l2_interface:
+    name: Ethernet1
+    state: present
+    mode: access
+    access_vlan: 4000
+    authorize: yes
+    provider: "{{ cli }}"
+  become: yes
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == false'
+
+- name: Change access vlan to 4001
+  eos_l2_interface:
+    name: Ethernet1
+    state: present
+    mode: access
+    access_vlan: 4001
+    authorize: yes
+    provider: "{{ cli }}"
+  become: yes
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+
+- name: Change access vlan to 4001 again (idempotent)
+  eos_l2_interface:
+    name: Ethernet1
+    state: present
+    mode: access
+    access_vlan: 4001
+    authorize: yes
+    provider: "{{ cli }}"
+  become: yes
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == false'
+
+- name: Change switchport mode to trunk and set native vlan to 4001
+  eos_l2_interface:
+    name: Ethernet1
+    state: present
+    mode: trunk
+    native_vlan: 4001
+    authorize: yes
+    provider: "{{ cli }}"
+  become: yes
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+
+- name: Change switchport mode to trunk and set native vlan to 4001 again (idempotent)
+  eos_l2_interface:
+    name: Ethernet1
+    state: present
+    mode: trunk
+    native_vlan: 4001
+    authorize: yes
+    provider: "{{ cli }}"
+  become: yes
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == false'
+
+- name: Set trunk allowed vlans to 20 and 4000
+  eos_l2_interface:
+    name: Ethernet1
+    state: present
+    mode: trunk
+    trunk_allowed_vlans: 20,4000
+    authorize: yes
+    provider: "{{ cli }}"
+  become: yes
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+
+- name: Set trunk allowed vlans to 20 and 4000 again (idempotent)
+  eos_l2_interface:
+    name: Ethernet1
+    state: present
+    mode: trunk
+    trunk_allowed_vlans: 20,4000
+    authorize: yes
+    provider: "{{ cli }}"
+  become: yes
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == false'
+
+- name: Tear down switchports
+  eos_l2_interface:
+    name: Ethernet1
+    state: absent
+    authorize: yes
+    provider: "{{ cli }}"
+  become: yes
+
+- debug: msg="END eos_l3_interface cli/basic.yaml on connection={{ ansible_connection }}"