Add new module mlnxos_bgp for managing bgp protocol on Mellanox MLNX-OS devices (#34305)

* Add new module mlnxos_bgp for managing bgp protocol on Mellanox MLNX-OS
devices

Signed-off-by: Samer Deeb <samerd@mellanox.com>

* Add missing required field, and Fix Documentation

Signed-off-by: Samer Deeb <samerd@mellanox.com>

* Fix documentation of neighbors field

Signed-off-by: Samer Deeb <samerd@mellanox.com>

lib/ansible/modules/network/mlnxos/mlnxos_bgp.py

@@ -0,0 +1,197 @@
+#!/usr/bin/python
+#
+# Copyright: Ansible Project
+# 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': 'community'}
+
+DOCUMENTATION = """
+---
+module: mlnxos_bgp
+version_added: "2.5"
+author: "Samer Deeb (@samerd)"
+short_description: Configures BGP on Mellanox MLNX-OS network devices
+description:
+  - This module provides declarative management of BGP router and neighbors
+    on Mellanox MLNX-OS network devices.
+notes:
+  - Tested on MLNX-OS 3.6.4000
+options:
+  as_number:
+    description:
+      - Local AS number.
+    required: true
+  router_id:
+    description:
+      - Router IP address. Required if I(state=present).
+  neighbors:
+    description:
+      - List of neighbors. Required if I(state=present).
+    suboptions:
+      remote_as:
+        description:
+          - Remote AS number.
+        required: true
+      neighbor:
+        description:
+          - Neighbor IP address.
+        required: true
+  state:
+    description:
+      - BGP state.
+    default: present
+    choices: ['present', 'absent']
+"""
+
+EXAMPLES = """
+- name: configure bgp
+  mlnxos_bgp:
+    as_number: 320
+    router_id: 10.3.3.3
+    neighbors:
+      - remote_as: 321
+        neighbor: 10.3.3.4
+    state: present
+"""
+
+RETURN = """
+commands:
+  description: The list of configuration mode commands to send to the device.
+  returned: always
+  type: list
+  sample:
+    - router bgp 172
+    - exit
+    - router bgp 172 router-id 2.3.4.5 force
+    - router bgp 172 neighbor 2.3.4.6 remote-as 173
+"""
+
+import re
+
+from ansible.module_utils.basic import AnsibleModule
+
+from ansible.module_utils.network.mlnxos.mlnxos import get_bgp_summary
+from ansible.module_utils.network.mlnxos.mlnxos import BaseMlnxosModule
+
+
+class MlnxosBgpModule(BaseMlnxosModule):
+    LOCAL_AS_REGEX = \
+        r"BGP router identifier ([0-9\.]+), local AS number (\d+)"
+    NEIGHBOR_REGEX = \
+        r"^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})\s+\d+\s+(\d+)"
+
+    def init_module(self):
+        """ initialize module
+        """
+        neighbor_spec = dict(
+            remote_as=dict(type='int', required=True),
+            neighbor=dict(required=True),
+        )
+        element_spec = dict(
+            as_number=dict(type='int', required=True),
+            router_id=dict(),
+            neighbors=dict(type='list', elements='dict',
+                           options=neighbor_spec),
+            state=dict(choices=['present', 'absent'], default='present'),
+        )
+        argument_spec = dict()
+
+        argument_spec.update(element_spec)
+        self._module = AnsibleModule(
+            argument_spec=argument_spec,
+            supports_check_mode=True)
+
+    def get_required_config(self):
+        module_params = self._module.params
+        bgp_params = {
+            'as_number': module_params['as_number'],
+            'router_id': module_params['router_id'],
+            'state': module_params['state'],
+        }
+        neighbors = module_params['neighbors'] or []
+        req_neighbors = bgp_params['neighbors'] = []
+        for neighbor_data in neighbors:
+            req_neighbors.append(
+                (neighbor_data['neighbor'], neighbor_data['remote_as']))
+        self.validate_param_values(bgp_params)
+        self._required_config = bgp_params
+
+    def _set_bgp_config(self, bgp_config):
+        match = re.search(self.LOCAL_AS_REGEX, bgp_config, re.M)
+        if match:
+            self._current_config['router_id'] = match.group(1)
+            self._current_config['as_number'] = int(match.group(2))
+        matches = re.findall(self.NEIGHBOR_REGEX, bgp_config, re.M) or []
+        neighbors = self._current_config['neighbors'] = []
+        for match in matches:
+            neighbors.append((match[0], int(match[1])))
+
+    def _get_bgp_summary(self):
+        return get_bgp_summary(self._module)
+
+    def load_current_config(self):
+        self._current_config = dict()
+        bgp_config = self._get_bgp_summary()
+        if bgp_config:
+            self._set_bgp_config(bgp_config)
+
+    def generate_commands(self):
+        state = self._required_config['state']
+        if state == 'present':
+            self._generate_bgp_cmds()
+        else:
+            self._generate_no_bgp_cmds()
+
+    def _generate_bgp_cmds(self):
+        as_number = self._required_config['as_number']
+        curr_as_num = self._current_config.get('as_number')
+        bgp_removed = False
+        if curr_as_num != as_number:
+            if curr_as_num:
+                self._commands.append('no router bgp %d' % curr_as_num)
+                bgp_removed = True
+            self._commands.append('router bgp %d' % as_number)
+            self._commands.append('exit')
+        curr_route_id = self._current_config.get('router_id')
+        req_router_id = self._required_config['router_id']
+        if req_router_id and req_router_id != curr_route_id or bgp_removed:
+            self._commands.append('router bgp %d router-id %s force' %
+                                  (as_number, req_router_id))
+
+        req_neighbors = self._required_config['neighbors']
+        curr_neighbors = self._current_config.get('neighbors', [])
+        if not bgp_removed:
+            for neighbor_data in curr_neighbors:
+                if neighbor_data not in req_neighbors:
+                    (neighbor, remote_as) = neighbor_data
+                    self._commands.append(
+                        'router bgp %s no neighbor %s remote-as %s' %
+                        (as_number, neighbor, remote_as))
+
+        for neighbor_data in req_neighbors:
+            if bgp_removed or neighbor_data not in curr_neighbors:
+                (neighbor, remote_as) = neighbor_data
+                self._commands.append(
+                    'router bgp %s neighbor %s remote-as %s' %
+                    (as_number, neighbor, remote_as))
+
+    def _generate_no_bgp_cmds(self):
+        as_number = self._required_config['as_number']
+        curr_as_num = self._current_config.get('as_number')
+        if curr_as_num and curr_as_num == as_number:
+            self._commands.append('no router bgp %d' % as_number)
+
+
+def main():
+    """ main entry point for module execution
+    """
+    MlnxosBgpModule.main()
+
+
+if __name__ == '__main__':
+    main()

test/units/modules/network/mlnxos/fixtures/mlnxos_bgp_show.cfg

@@ -0,0 +1,6 @@
+BGP router identifier 1.2.3.4, local AS number 172
+BGP table version is 1, main routing table version 1
+--------          -         -- ------- -------  ------  --- ---- -------     ------------
+Neighbor          V         AS MsgRcvd MsgSent  TblVer  InQ OutQ Up/Down     State/PfxRcd
+--------          -         -- ------- -------  ------  --- ---- -------     ------------
+10.2.3.4          4        173       0       0       1    0    0 Never       ACTIVE

test/units/modules/network/mlnxos/test_mlnxos_bgp.py

@@ -0,0 +1,70 @@
+#
+# Copyright: Ansible Project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+# Make coding more python3-ish
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+from ansible.compat.tests.mock import patch
+from ansible.modules.network.mlnxos import mlnxos_bgp
+from units.modules.utils import set_module_args
+from .mlnxos_module import TestMlnxosModule, load_fixture
+
+
+class TestMlnxosBgpModule(TestMlnxosModule):
+
+    module = mlnxos_bgp
+
+    def setUp(self):
+        super(TestMlnxosBgpModule, self).setUp()
+        self.mock_get_config = patch.object(
+            mlnxos_bgp.MlnxosBgpModule, "_get_bgp_summary")
+        self.get_config = self.mock_get_config.start()
+
+        self.mock_load_config = patch(
+            'ansible.module_utils.network.mlnxos.mlnxos.load_config')
+        self.load_config = self.mock_load_config.start()
+
+    def tearDown(self):
+        super(TestMlnxosBgpModule, self).tearDown()
+        self.mock_get_config.stop()
+        self.mock_load_config.stop()
+
+    def load_fixtures(self, commands=None, transport='cli'):
+        config_file = 'mlnxos_bgp_show.cfg'
+        self.get_config.return_value = load_fixture(config_file)
+        self.load_config.return_value = None
+
+    def test_bgp_no_change(self):
+        neighbor = dict(remote_as=173, neighbor='10.2.3.4')
+        set_module_args(dict(as_number=172, router_id='1.2.3.4',
+                             neighbors=[neighbor]))
+        self.execute_module(changed=False)
+
+    def test_bgp_remove(self):
+        set_module_args(dict(as_number=172, state='absent'))
+        commands = ['no router bgp 172']
+        self.execute_module(changed=True, commands=commands)
+
+    def test_bgp_change(self):
+        neighbor = dict(remote_as=173, neighbor='10.2.3.4')
+        set_module_args(dict(as_number=174, router_id='1.2.3.4',
+                             neighbors=[neighbor]))
+        commands = ['no router bgp 172', 'router bgp 174', 'exit',
+                    'router bgp 174 router-id 1.2.3.4 force',
+                    'router bgp 174 neighbor 10.2.3.4 remote-as 173']
+        self.execute_module(changed=True, commands=commands)
+
+    def test_bgp_add_neighbor(self):
+        neighbors = [dict(remote_as=173, neighbor='10.2.3.4'),
+                     dict(remote_as=175, neighbor='10.2.3.5')]
+        set_module_args(dict(as_number=172, router_id='1.2.3.4',
+                             neighbors=neighbors))
+        commands = ['router bgp 172 neighbor 10.2.3.5 remote-as 175']
+        self.execute_module(changed=True, commands=commands)
+
+    def test_bgp_del_neighbor(self):
+        set_module_args(dict(as_number=172))
+        commands = ['router bgp 172 no neighbor 10.2.3.4 remote-as 173']
+        self.execute_module(changed=True, commands=commands)