Add vyos_linkagg module (#26418)

* Add vyos_linkagg module

* Add vyos_linkagg integration tests

* Fix pep8 issue

* Address several review comments

lib/ansible/modules/network/vyos/vyos_linkagg.py

@@ -0,0 +1,244 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# (c) 2017, Ansible by Red Hat, inc
+#
+# This file is part of Ansible by Red Hat
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+                    'status': ['preview'],
+                    'supported_by': 'core'}
+
+
+DOCUMENTATION = """
+---
+module: vyos_linkagg
+version_added: "2.4"
+author: "Ricardo Carrillo Cruz (@rcarrillocruz)"
+short_description: Manage link aggregation groups on VyOS network devices
+description:
+  - This module provides declarative management of link aggregation groups
+    on VyOS network devices.
+options:
+  name:
+    description:
+      - Name of the link aggregation group.
+    required: true
+  mode:
+    description:
+      - Mode of the link aggregation group.
+    choices: ['802.3ad', 'active-backup', 'broadcast',
+              'round-robin', 'transmit-load-balance',
+              'adaptive-load-balance', 'xor-hash', 'on']
+  members:
+    description:
+      - List of members of the link aggregation group.
+  collection:
+    description: List of link aggregation definitions.
+  purge:
+    description:
+      - Purge link aggregation groups not defined in the collections parameter.
+    default: no
+  state:
+    description:
+      - State of the link aggregation group.
+    default: present
+    choices: ['present', 'absent', 'up', 'down']
+"""
+
+EXAMPLES = """
+- name: configure link aggregation group
+  vyos_linkagg:
+    name: bond0
+    members:
+      - eth0
+      - eth1
+
+- name: remove configuration
+  vyos_linkagg:
+    name: bond0
+    state: absent
+
+"""
+
+RETURN = """
+commands:
+  description: The list of configuration mode commands to send to the device
+  returned: always, except for the platforms that use Netconf transport to manage the device.
+  type: list
+  sample:
+    - set interfaces bonding bond0
+    - set interfaces ethernet eth0 bond-group 'bond0'
+    - set interfaces ethernet eth1 bond-group 'bond0'
+"""
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.vyos import load_config, run_commands
+from ansible.module_utils.vyos import vyos_argument_spec, check_args
+
+
+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']
+        members = w.get('members') or []
+        mode = w['mode']
+
+        if mode == 'on':
+            mode = '802.3ad'
+
+        state = w['state']
+
+        obj_in_have = search_obj_in_list(name, have)
+
+        if state == 'absent':
+            if obj_in_have:
+                for m in obj_in_have['members']:
+                    commands.append('delete interfaces ethernet ' + m + ' bond-group')
+
+                commands.append('delete interfaces bonding ' + name)
+        else:
+            if not obj_in_have:
+                commands.append('set interfaces bonding ' + name + ' mode ' + mode)
+
+                for m in members:
+                    commands.append('set interfaces ethernet ' + m + ' bond-group ' + name)
+
+                if state == 'down':
+                    commands.append('set interfaces bonding ' + name + ' disable')
+            else:
+                if mode != obj_in_have['mode']:
+                    commands.append('set interfaces bonding ' + name + ' mode ' + mode)
+
+                missing_members = list(set(members) - set(obj_in_have['members']))
+                for m in missing_members:
+                    commands.append('set interfaces ethernet ' + m + ' bond-group ' + name)
+
+                if state == 'down' and obj_in_have['state'] == 'up':
+                    commands.append('set interfaces bonding ' + name + ' disable')
+                elif state == 'up' and obj_in_have['state'] == 'down':
+                    commands.append('delete interfaces bonding ' + name + ' disable')
+
+    return commands
+
+
+def map_config_to_obj(module):
+    obj = []
+    output = run_commands(module, ['show interfaces bonding slaves'])
+    lines = output[0].splitlines()
+
+    if len(lines) > 1:
+        for line in lines[1:]:
+            splitted_line = line.split()
+
+            name = splitted_line[0]
+            mode = splitted_line[1]
+            state = splitted_line[2]
+
+            if len(splitted_line) > 4:
+                members = splitted_line[4:]
+            else:
+                members = []
+
+            obj.append({'name': name,
+                        'mode': mode,
+                        'members': members,
+                        'state': state})
+
+    return obj
+
+
+def map_params_to_obj(module):
+    obj = []
+
+    if 'collection' in module.params and module.params['collection']:
+        for c in module.params['collection']:
+            d = c.copy()
+
+            if 'state' not in d:
+                d['state'] = module.params['state']
+            if 'mode' not in d:
+                d['mode'] = module.params['mode']
+
+            obj.append(d)
+    else:
+        obj.append({
+            'name': module.params['name'],
+            'mode': module.params['mode'],
+            'members': module.params['members'],
+            'state': module.params['state']
+        })
+
+    return obj
+
+
+def main():
+    """ main entry point for module execution
+    """
+    argument_spec = dict(
+        name=dict(),
+        mode=dict(choices=['802.3ad', 'active-backup', 'broadcast',
+                           'round-robin', 'transmit-load-balance',
+                           'adaptive-load-balance', 'xor-hash', 'on'],
+                  default='802.3ad'),
+        members=dict(type='list'),
+        collection=dict(type='list'),
+        purge=dict(default=False, type='bool'),
+        state=dict(default='present',
+                   choices=['present', 'absent', 'up', 'down'])
+    )
+
+    argument_spec.update(vyos_argument_spec)
+
+    required_one_of = [['name', 'collection']]
+    mutually_exclusive = [['name', 'collection']]
+    module = AnsibleModule(argument_spec=argument_spec,
+                           required_one_of=required_one_of,
+                           supports_check_mode=True)
+
+    warnings = list()
+    check_args(module, warnings)
+
+    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
+        load_config(module, commands, commit=commit)
+        result['changed'] = True
+
+    module.exit_json(**result)
+
+if __name__ == '__main__':
+    main()

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

@@ -0,0 +1,3 @@
+---
+testcase: "*"
+test_items: []

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

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

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

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

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

@@ -0,0 +1,185 @@
+---
+- name: Remove linkagg
+  vyos_linkagg:
+    name: bond0
+    state: absent
+
+- name: Create linkagg
+  vyos_linkagg:
+    name: bond0
+    members:
+      - eth1
+      - eth2
+    state: present
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+      - '"set interfaces bonding bond0 mode 802.3ad" in result.commands'
+      - '"set interfaces ethernet eth1 bond-group bond0" in result.commands'
+      - '"set interfaces ethernet eth2 bond-group bond0" in result.commands'
+
+- name: Create linkagg again (idempotent)
+  vyos_linkagg:
+    name: bond0
+    members:
+      - eth1
+      - eth2
+    state: present
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == false'
+
+- name: Add linkagg member
+  vyos_linkagg:
+    name: bond0
+    members:
+      - eth3
+    state: present
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+      - '"set interfaces ethernet eth3 bond-group bond0" in result.commands'
+
+- name: Add linkagg member again (idempotent)
+  vyos_linkagg:
+    name: bond0
+    members:
+      - eth3
+    state: present
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == false'
+
+- name: Disable linkagg
+  vyos_linkagg:
+    name: bond0
+    state: down
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+      - '"set interfaces bonding bond0 disable" in result.commands'
+
+- name: Disable linkagg again (idempotent)
+  vyos_linkagg:
+    name: bond0
+    state: down
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == false'
+
+- name: Enable linkagg
+  vyos_linkagg:
+    name: bond0
+    state: up
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+      - '"delete interfaces bonding bond0 disable" in result.commands[0]'
+
+- name: Enable linkagg again (idempotent)
+  vyos_linkagg:
+    name: bond0
+    state: up
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == false'
+
+- name: Remove linkagg
+  vyos_linkagg:
+    name: bond0
+    state: absent
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+      - '"delete interfaces ethernet eth1 bond-group" in result.commands'
+      - '"delete interfaces ethernet eth2 bond-group" in result.commands'
+      - '"delete interfaces ethernet eth3 bond-group" in result.commands'
+      - '"delete interfaces bonding bond0" in result.commands'
+
+- name: Remove linkagg again (idempotent)
+  vyos_linkagg:
+    name: bond0
+    state: absent
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == false'
+
+- name: Create collection of linkagg definitions
+  vyos_linkagg:
+    collection:
+        - { name: bond0, members: [eth1, eth2] }
+        - { name: bond1, members: [eth3, eth4] }
+    state: present
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+      - '"set interfaces bonding bond0 mode 802.3ad" in result.commands'
+      - '"set interfaces ethernet eth1 bond-group bond0" in result.commands'
+      - '"set interfaces ethernet eth2 bond-group bond0" in result.commands'
+      - '"set interfaces bonding bond1 mode 802.3ad" in result.commands'
+      - '"set interfaces ethernet eth3 bond-group bond1" in result.commands'
+      - '"set interfaces ethernet eth4 bond-group bond1" in result.commands'
+
+- name: Create collection of linkagg definitions again (idempotent)
+  vyos_linkagg:
+    collection:
+        - { name: bond0, members: [eth1, eth2] }
+        - { name: bond1, members: [eth3, eth4] }
+    state: present
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == false'
+
+- name: Remove collection of linkagg definitions
+  vyos_linkagg:
+    collection:
+      - { name: bond0 }
+      - { name: bond1 }
+    state: absent
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+      - '"delete interfaces ethernet eth1 bond-group" in result.commands'
+      - '"delete interfaces ethernet eth2 bond-group" in result.commands'
+      - '"delete interfaces bonding bond0" in result.commands'
+      - '"delete interfaces ethernet eth1 bond-group" in result.commands'
+      - '"delete interfaces ethernet eth2 bond-group" in result.commands'
+      - '"delete interfaces bonding bond1" in result.commands'
+
+- name: Remove collection of linkagg definitions again (idempotent)
+  vyos_linkagg:
+    collection:
+      - { name: bond0 }
+      - { name: bond1 }
+    state: absent
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == false'

test/integration/vyos.yaml

@@ -42,9 +42,16 @@
       rescue:
         - set_fact: test_failed=true
 
+#    - block:
+#      - include_role:
+#          name: vyos_linkagg
+#        when: "limit_to in ['*', 'vyos_linkagg']"
+#      rescue:
+#        - set_fact: test_failed=true
+
 
 ###########
     - name: Has any previous test failed?
       fail:
         msg: "One or more tests failed, check log for details"
-      when: test_failed
+      when: test_failed