Initial commit

plugins/module_utils/network/edgeswitch/edgeswitch.py

@@ -0,0 +1,168 @@
+# This code is part of Ansible, but is an independent component.
+# This particular file snippet, and this file snippet only, is BSD licensed.
+# Modules you write using this snippet, which is embedded dynamically by Ansible
+# still belong to the author of the module, and may assign their own license
+# to the complete work.
+#
+# (c) 2018 Red Hat Inc.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+#    * Redistributions of source code must retain the above copyright
+#      notice, this list of conditions and the following disclaimer.
+#    * Redistributions in binary form must reproduce the above copyright notice,
+#      this list of conditions and the following disclaimer in the documentation
+#      and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+import json
+import re
+
+from copy import deepcopy
+
+from ansible.module_utils._text import to_text
+from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list, ComplexList
+from ansible.module_utils.connection import Connection, ConnectionError
+from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import remove_default_spec
+
+_DEVICE_CONFIGS = {}
+
+
+def build_aggregate_spec(element_spec, required, *extra_spec):
+    aggregate_spec = deepcopy(element_spec)
+    for elt in required:
+        aggregate_spec[elt] = dict(required=True)
+    remove_default_spec(aggregate_spec)
+    argument_spec = dict(
+        aggregate=dict(type='list', elements='dict', options=aggregate_spec)
+    )
+    argument_spec.update(element_spec)
+    for elt in extra_spec:
+        argument_spec.update(elt)
+    return argument_spec
+
+
+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]
+
+            d = item.copy()
+            obj.append(d)
+    else:
+        obj.append(module.params)
+
+    return obj
+
+
+def get_connection(module):
+    if hasattr(module, '_edgeswitch_connection'):
+        return module._edgeswitch_connection
+
+    capabilities = get_capabilities(module)
+    network_api = capabilities.get('network_api')
+    if network_api == 'cliconf':
+        module._edgeswitch_connection = Connection(module._socket_path)
+    else:
+        module.fail_json(msg='Invalid connection type %s' % network_api)
+
+    return module._edgeswitch_connection
+
+
+def get_capabilities(module):
+    if hasattr(module, '_edgeswitch_capabilities'):
+        return module._edgeswitch_capabilities
+    try:
+        capabilities = Connection(module._socket_path).get_capabilities()
+    except ConnectionError as exc:
+        module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
+    module._edgeswitch_capabilities = json.loads(capabilities)
+    return module._edgeswitch_capabilities
+
+
+def get_defaults_flag(module):
+    connection = get_connection(module)
+    try:
+        out = connection.get_defaults_flag()
+    except ConnectionError as exc:
+        module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
+    return to_text(out, errors='surrogate_then_replace').strip()
+
+
+def get_config(module, flags=None):
+    flag_str = ' '.join(to_list(flags))
+
+    try:
+        return _DEVICE_CONFIGS[flag_str]
+    except KeyError:
+        connection = get_connection(module)
+        try:
+            out = connection.get_config(flags=flags)
+        except ConnectionError as exc:
+            module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
+        cfg = to_text(out, errors='surrogate_then_replace').strip()
+        _DEVICE_CONFIGS[flag_str] = cfg
+        return cfg
+
+
+def get_interfaces_config(module):
+    config = get_config(module)
+    lines = config.split('\n')
+    interfaces = {}
+    interface = None
+    for line in lines:
+        if line == 'exit':
+            if interface:
+                interfaces[interface[0]] = interface
+                interface = None
+        elif interface:
+            interface.append(line)
+        else:
+            match = re.match(r'^interface (.*)$', line)
+            if match:
+                interface = list()
+                interface.append(line)
+
+    return interfaces
+
+
+def to_commands(module, commands):
+    spec = {
+        'command': dict(key=True),
+        'prompt': dict(),
+        'answer': dict()
+    }
+    transform = ComplexList(spec, module)
+    return transform(commands)
+
+
+def run_commands(module, commands, check_rc=True):
+    connection = get_connection(module)
+    try:
+        return connection.run_commands(commands=commands, check_rc=check_rc)
+    except ConnectionError as exc:
+        module.fail_json(msg=to_text(exc))
+
+
+def load_config(module, commands):
+    connection = get_connection(module)
+
+    try:
+        resp = connection.edit_config(commands)
+        return resp.get('response')
+    except ConnectionError as exc:
+        module.fail_json(msg=to_text(exc))

plugins/module_utils/network/edgeswitch/edgeswitch_interface.py

@@ -0,0 +1,91 @@
+# This code is part of Ansible, but is an independent component.
+# This particular file snippet, and this file snippet only, is BSD licensed.
+# Modules you write using this snippet, which is embedded dynamically by Ansible
+# still belong to the author of the module, and may assign their own license
+# to the complete work.
+#
+# (c) 2018 Red Hat Inc.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+#    * Redistributions of source code must retain the above copyright
+#      notice, this list of conditions and the following disclaimer.
+#    * Redistributions in binary form must reproduce the above copyright notice,
+#      this list of conditions and the following disclaimer in the documentation
+#      and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+import re
+
+
+class InterfaceConfiguration:
+    def __init__(self):
+        self.commands = []
+        self.merged = False
+
+    def has_same_commands(self, interface):
+        len1 = len(self.commands)
+        len2 = len(interface.commands)
+        return len1 == len2 and len1 == len(frozenset(self.commands).intersection(interface.commands))
+
+
+def merge_interfaces(interfaces):
+    """ to reduce commands generated by an edgeswitch module
+        we take interfaces one by one and we try to merge them with neighbors if everyone has same commands to run
+    """
+    merged = {}
+
+    for i, interface in interfaces.items():
+        if interface.merged:
+            continue
+        interface.merged = True
+
+        match = re.match(r'(\d+)\/(\d+)', i)
+        group = int(match.group(1))
+        start = int(match.group(2))
+        end = start
+
+        while True:
+            try:
+                start = start - 1
+                key = '{0}/{1}'.format(group, start)
+                neighbor = interfaces[key]
+                if not neighbor.merged and interface.has_same_commands(neighbor):
+                    neighbor.merged = True
+                else:
+                    break
+            except KeyError:
+                break
+        start = start + 1
+
+        while True:
+            try:
+                end = end + 1
+                key = '{0}/{1}'.format(group, end)
+                neighbor = interfaces[key]
+                if not neighbor.merged and interface.has_same_commands(neighbor):
+                    neighbor.merged = True
+                else:
+                    break
+            except KeyError:
+                break
+        end = end - 1
+
+        if end == start:
+            key = '{0}/{1}'.format(group, start)
+        else:
+            key = '{0}/{1}-{2}/{3}'.format(group, start, group, end)
+
+        merged[key] = interface
+    return merged