Honeycomb API keywords - interface, bridge domain

- add keywords to manipulate data  using Honeycomb REST API to configure
  interfaces and bridge domains
- remove "add_vpp_to_honeycomb_network_topology" method from
  HoneycombSetup.py
- remove "parse_json_response" from HoneycombUtil.py
- add methods to manipulate data from Honeycomb REST API

Change-Id: I5e6f87097fe9bfccffa3d4aae21f63281353cf29
Signed-off-by: Tibor Frank <tifrank@cisco.com>

1 files changed, 329 insertions, 0 deletions

diff --git a/resources/libraries/python/HcAPIKwBridgeDomain.py b/resources/libraries/python/HcAPIKwBridgeDomain.py
new file mode 100644
index 0000000000..2f7c149684
--- /dev/null
+++ b/resources/libraries/python/HcAPIKwBridgeDomain.py
@@ -0,0 +1,329 @@
+# Copyright (c) 2016 Cisco and/or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Keywords to manipulate bridge domain configuration using Honeycomb REST API.
+
+The keywords make possible to put and get configuration data and to get
+operational data.
+"""
+
+
+from resources.libraries.python.HTTPRequest import HTTPCodes
+from resources.libraries.python.HoneycombSetup import HoneycombError
+from resources.libraries.python.HoneycombUtil import HoneycombUtil as HcUtil
+from resources.libraries.python.HoneycombUtil import DataRepresentation
+
+
+class BridgeDomainKeywords(object):
+    """Keywords to manipulate bridge domain configuration.
+
+    Implements keywords which get configuration and operational data about
+    bridge domains and put the bridge domains' parameters using Honeycomb REST
+    API.
+    """
+
+    PARAMS = ("flood", "forward", "learn", "unknown-unicast-flood",
+              "arp-termination")
+
+    def __init__(self):
+        pass
+
+    @staticmethod
+    def _configure_bd(node, bd_name, data,
+                      data_representation=DataRepresentation.JSON):
+        """Send bridge domain configuration data and check the response.
+
+        :param node: Honeycomb node.
+        :param bd_name: The name of bridge domain.
+        :param data: Configuration data to be sent in PUT request.
+        :param data_representation: How the data is represented.
+        :type node: dict
+        :type bd_name: str
+        :type data: dict
+        :type data_representation: DataRepresentation
+        :return: Content of response.
+        :rtype: bytearray
+        :raises HoneycombError: If the status code in response on PUT is not
+        200 = OK.
+        """
+
+        status_code, resp = HcUtil.\
+            put_honeycomb_data(node, "config_bridge_domain", data,
+                               data_representation=data_representation)
+        if status_code != HTTPCodes.OK:
+            raise HoneycombError(
+                "The configuration of bridge domain '{0}' was not successful. "
+                "Status code: {1}.".format(bd_name, status_code))
+        return resp
+
+    @staticmethod
+    def _set_bd_properties(node, bd_name, path, new_value=None):
+        """Set bridge domain properties.
+
+        This method reads bridge domain configuration data, creates, changes or
+        removes the requested data and puts it back to Honeycomb.
+
+        :param node: Honeycomb node.
+        :param bd_name: The name of bridge domain.
+        :param path:  Path to data we want to change, create or remove.
+        :param new_value: The new value to be set. If None, the item will be
+        removed.
+        :type node: dict
+        :type bd_name: str
+        :type path: tuple
+        :type new_value: str, dict or list
+        :return: Content of response.
+        :rtype: bytearray
+        :raises HoneycombError: If it is not possible to get or set the data.
+        """
+
+        status_code, resp = HcUtil.\
+            get_honeycomb_data(node, "config_bridge_domain")
+        if status_code != HTTPCodes.OK:
+            raise HoneycombError(
+                "Not possible to get configuration information about the "
+                "bridge domains. Status code: {0}.".format(status_code))
+
+        if new_value:
+            new_data = HcUtil.set_item_value(resp, path, new_value)
+        else:
+            new_data = HcUtil.remove_item(resp, path)
+        return BridgeDomainKeywords._configure_bd(node, bd_name, new_data)
+
+    @staticmethod
+    def _create_bd_structure(bd_name, **kwargs):
+        """Create the bridge domain data structure as it is expected by
+        Honeycomb REST API.
+
+        :param bd_name: Bridge domain name.
+        :param kwargs: Parameters and their values. The accepted parameters are
+        defined in BridgeDomainKeywords.PARAMS.
+        :type bd_name: str
+        :type kwargs: dict
+        :return: Bridge domain data structure.
+        :rtype: dict
+        """
+
+        bd_structure = {"name": bd_name}
+
+        for param, value in kwargs.items():
+            if param not in BridgeDomainKeywords.PARAMS:
+                raise HoneycombError("The parameter {0} is invalid.".
+                                     format(param))
+            bd_structure[param] = str(value)
+
+        return bd_structure
+
+    @staticmethod
+    def get_all_bds_cfg_data(node):
+        """Get configuration data about all bridge domains from Honeycomb.
+
+        :param node: Honeycomb node.
+        :type node: dict
+        :return: Configuration data about all bridge domains from Honeycomb.
+        :rtype: list
+        :raises HoneycombError: If it is not possible to get configuration data.
+        """
+
+        status_code, resp = HcUtil.\
+            get_honeycomb_data(node, "config_bridge_domain")
+        if status_code != HTTPCodes.OK:
+            raise HoneycombError(
+                "Not possible to get configuration information about the "
+                "bridge domains. Status code: {0}.".format(status_code))
+        try:
+            return resp["bridge-domains"]["bridge-domain"]
+
+        except (KeyError, TypeError):
+            return []
+
+    @staticmethod
+    def get_bd_cfg_data(node, bd_name):
+        """Get configuration data about the given bridge domain from Honeycomb.
+
+        :param node: Honeycomb node.
+        :param bd_name: The name of bridge domain.
+        :type node: dict
+        :type bd_name: str
+        :return: Configuration data about the given bridge domain from
+        Honeycomb.
+        :rtype: dict
+        """
+
+        intfs = BridgeDomainKeywords.get_all_bds_cfg_data(node)
+        for intf in intfs:
+            if intf["name"] == bd_name:
+                return intf
+        return {}
+
+    @staticmethod
+    def get_all_bds_oper_data(node):
+        """Get operational data about all bridge domains from Honeycomb.
+
+        :param node: Honeycomb node.
+        :type node: dict
+        :return: Operational data about all bridge domains from Honeycomb.
+        :rtype: list
+        :raises HoneycombError: If it is not possible to get operational data.
+        """
+
+        status_code, resp = HcUtil.\
+            get_honeycomb_data(node, "oper_bridge_domains")
+        if status_code != HTTPCodes.OK:
+            raise HoneycombError(
+                "Not possible to get operational information about the "
+                "bridge domains. Status code: {0}.".format(status_code))
+        try:
+            return resp["bridge-domains"]["bridge-domain"]
+
+        except (KeyError, TypeError):
+            return []
+
+    @staticmethod
+    def get_bd_oper_data(node, bd_name):
+        """Get operational data about the given bridge domain from Honeycomb.
+
+        :param node: Honeycomb node.
+        :param bd_name: The name of bridge domain.
+        :type node: dict
+        :type bd_name: str
+        :return: Operational data about the given bridge domain from Honeycomb.
+        :rtype: dict
+        """
+
+        intfs = BridgeDomainKeywords.get_all_bds_oper_data(node)
+        for intf in intfs:
+            if intf["name"] == bd_name:
+                return intf
+        return {}
+
+    @staticmethod
+    def add_first_bd(node, bd_name, **kwargs):
+        """Add the first bridge domain.
+
+        If there are any other bridge domains configured, they will be removed.
+
+        :param node: Honeycomb node.
+        :param bd_name: Bridge domain name.
+        :param kwargs: Parameters and their values. The accepted parameters are
+        defined in BridgeDomainKeywords.PARAMS
+        :type node: dict
+        :type bd_name: str
+        :type kwargs: dict
+        :return: Bridge domain data structure.
+        :rtype: dict
+        """
+
+        path = ("bridge-domains", )
+        new_bd = BridgeDomainKeywords._create_bd_structure(bd_name, **kwargs)
+        bridge_domain = {"bridge-domain": [new_bd, ]}
+        return BridgeDomainKeywords._set_bd_properties(node, bd_name, path,
+                                                       bridge_domain)
+
+    @staticmethod
+    def add_bd(node, bd_name, **kwargs):
+        """Add a bridge domain.
+
+        :param node: Honeycomb node.
+        :param bd_name: Bridge domain name.
+        :param kwargs: Parameters and their values. The accepted parameters are
+        defined in BridgeDomainKeywords.PARAMS
+        :type node: dict
+        :type bd_name: str
+        :type kwargs: dict
+        :return: Bridge domain data structure.
+        :rtype: dict
+        """
+
+        path = ("bridge-domains", "bridge-domain")
+        new_bd = BridgeDomainKeywords._create_bd_structure(bd_name, **kwargs)
+        bridge_domain = [new_bd, ]
+        return BridgeDomainKeywords._set_bd_properties(node, bd_name, path,
+                                                       bridge_domain)
+
+    @staticmethod
+    def remove_all_bds(node):
+        """Remove all bridge domains.
+
+        :param node: Honeycomb node.
+        :type node: dict
+        :return: Content of response.
+        :rtype: bytearray
+        :raises HoneycombError: If it is not possible to remove all bridge
+        domains.
+        """
+
+        data = {"bridge-domains": {"bridge-domain": []}}
+        status_code, resp = HcUtil.\
+            put_honeycomb_data(node, "config_bridge_domain", data)
+        if status_code != HTTPCodes.OK:
+            raise HoneycombError("Not possible to remove all bridge domains. "
+                                 "Status code: {0}.".format(status_code))
+        return resp
+
+    @staticmethod
+    def remove_bridge_domain(node, bd_name):
+        """Remove a bridge domain.
+
+        :param node:  Honeycomb node.
+        :param bd_name: The name of bridge domain to be removed.
+        :type node: dict
+        :type bd_name: str
+        :return: Content of response.
+        :rtype: bytearray
+        :raises HoneycombError:If it is not possible to remove the bridge
+        domain.
+        """
+
+        path = ("bridge-domains", ("bridge-domain", "name", bd_name))
+
+        status_code, resp = HcUtil.\
+            get_honeycomb_data(node, "config_bridge_domain")
+        if status_code != HTTPCodes.OK:
+            raise HoneycombError(
+                "Not possible to get configuration information about the "
+                "bridge domains. Status code: {0}.".format(status_code))
+
+        new_data = HcUtil.remove_item(resp, path)
+        status_code, resp = HcUtil.\
+            put_honeycomb_data(node, "config_bridge_domain", new_data)
+        if status_code != HTTPCodes.OK:
+            raise HoneycombError("Not possible to remove bridge domain {0}. "
+                                 "Status code: {1}.".
+                                 format(bd_name, status_code))
+        return resp
+
+    @staticmethod
+    def configure_bridge_domain(node, bd_name, param, value):
+        """Configure a bridge domain.
+
+        :param node: Honeycomb node.
+        :param bd_name: Bridge domain name.
+        :param param: Parameter to set, change or remove. The accepted
+        parameters are defined in BridgeDomainKeywords.PARAMS
+        :param value: The new value to be set, change or remove. If None, the
+        item will be removed.
+        :type node: dict
+        :type bd_name: str
+        :type param: str
+        :type value: str
+        :return: Content of response.
+        :rtype: bytearray
+        """
+
+        if param not in BridgeDomainKeywords.PARAMS:
+            raise HoneycombError("The parameter {0} is invalid.".format(param))
+
+        path = ("bridge-domains", ("bridge-domain", "name", bd_name), param)
+        return BridgeDomainKeywords.\
+            _set_bd_properties(node, bd_name, path, value)