Fix warnings reported by gen_doc.sh

[csit.git] / resources / libraries / python / honeycomb / Routing.py

diff --git a/resources/libraries/python/honeycomb/Routing.py b/resources/libraries/python/honeycomb/Routing.py
index c39031d..520f53e 100644 (file)
--- a/resources/libraries/python/honeycomb/Routing.py
+++ b/resources/libraries/python/honeycomb/Routing.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Cisco and/or its affiliates.
+# Copyright (c) 2018 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:
@@ -46,7 +46,7 @@ class RoutingKeywords(object):
         :type node: dict
         :type path: str
         :type data: dict
-        :return: Content of response.
+        :returns: Content of response.
         :rtype: bytearray
         :raises HoneycombError: If the status code in response is not
         200 = OK.
@@ -92,7 +92,7 @@ class RoutingKeywords(object):
         if special:
             ip_version = "hc2vpp-ietf-{0}-unicast-routing:{0}".format(
                 ip_version)
-            protocol = "vpp-routing-ra:vpp-protocol-attributes"
+            protocol = "vpp-routing:vpp-protocol-attributes"
         else:
             ip_version = ip_version
             protocol = "vpp-protocol-attributes"
@@ -157,7 +157,7 @@ class RoutingKeywords(object):
         if status_code != HTTPCodes.OK:
             raise HoneycombError(
                 "Not possible to get operational information about the "
-                "classify tables. Status code: {0}.".format(status_code))
+                "routing tables. Status code: {0}.".format(status_code))
 
         data = RoutingKeywords.clean_routing_oper_data(
             resp['routing-protocol'][0]['static-routes']
@@ -273,3 +273,60 @@ class RoutingKeywords(object):
             return {k: str(v) for k, v in dict_of_str.items()}
         except (KeyError, TypeError):
             return {}
+
+    @staticmethod
+    def configure_policer(node, policy_name, policer_data=None):
+        """Configure Policer on the specified node.
+
+        :param node: Honeycomb node.
+        :param policer_data: Dictionary of configurations to apply. \
+        If it is None then the existing configuration is removed.
+        :type node: dict
+        :type policer_data: dict
+        :returns: Content of response.
+        :rtype: bytearray
+        :raises HoneycombError: If policer could not be configured.
+        """
+
+        path = '/' + policy_name
+
+        if not policer_data:
+            status_code, _ = HcUtil.delete_honeycomb_data(
+                node, 'config_policer', path)
+        else:
+            data = {
+                'policer': policer_data
+            }
+
+            status_code, _ = HcUtil.put_honeycomb_data(
+                node, 'config_policer', data, path)
+
+        if status_code not in (HTTPCodes.OK, HTTPCodes.ACCEPTED):
+            raise HoneycombError(
+                'Configuring policer failed. Status code:{0}'\
+                    .format(status_code))
+
+    @staticmethod
+    def get_policer_oper_data(node, policy_name):
+        """Get operational data about Policer on the node.
+
+        :param node: Honeycomb node.
+        :type node: dict
+        :returns: dict of Policer operational data.
+        :rtype: dict
+        :raises HoneycombError: If status code differs from successful.
+        """
+
+        path = '/' + policy_name
+
+        status_code, resp = HcUtil.\
+            get_honeycomb_data(node, "oper_policer", path)
+
+        if status_code != HTTPCodes.OK:
+            raise HoneycombError(
+                "Not possible to get operational information about Policer. "
+                "Status code: {0}.".format(status_code))
+        try:
+            return resp['policer']
+        except (KeyError, TypeError):
+            return {}