Fix warnings reported by gen_doc.sh
[csit.git] / resources / libraries / python / honeycomb / DHCP.py
1 # Copyright (c) 2018 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
5 #
6 #     http://www.apache.org/licenses/LICENSE-2.0
7 #
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
13
14 """Keywords to manipulate NAT configuration using Honeycomb REST API."""
15
16 from resources.libraries.python.HTTPRequest import HTTPCodes
17 from resources.libraries.python.honeycomb.HoneycombSetup import HoneycombError
18 from resources.libraries.python.honeycomb.HoneycombUtil \
19     import DataRepresentation
20 from resources.libraries.python.honeycomb.HoneycombUtil \
21     import HoneycombUtil as HcUtil
22
23
24 class DHCPRelayKeywords(object):
25     """Keywords for NAT configuration."""
26
27     def __init__(self):
28         pass
29
30     @staticmethod
31     def _set_dhcp_relay_properties(node, path, data=None):
32         """Set DHCP relay properties and check the return code.
33
34         :param node: Honeycomb node.
35         :param path: Path which is added to the base path to identify the data.
36         :param data: The new data to be set. If None, the item will be removed.
37         :type node: dict
38         :type path: str
39         :type data: dict
40         :returns: Content of response.
41         :rtype: bytearray
42         :raises HoneycombError: If the status code in response is not
43         200 = OK or 201 = ACCEPTED.
44         """
45
46         if data:
47             status_code, resp = HcUtil. \
48                 put_honeycomb_data(node, "config_dhcp_relay", data, path,
49                                    data_representation=DataRepresentation.JSON)
50         else:
51             status_code, resp = HcUtil. \
52                 delete_honeycomb_data(node, "config_dhcp_relay", path)
53
54         if status_code not in (HTTPCodes.OK, HTTPCodes.ACCEPTED):
55             raise HoneycombError(
56                 "The configuration of DHCP relay was not successful. "
57                 "Status code: {0}.".format(status_code))
58         return resp
59
60     @staticmethod
61     def add_dhcp_relay(node, data, ip_version, entry_id):
62         """Add a DHCP relay entry to the list on entries.
63
64         :param node: Honeycomb node.
65         :param data: Configuration for the relay entry.
66         :param ip_version: IP protocol version, ipv4 or ipv6.
67         :param entry_id: Numeric ID.
68         :type node: dict
69         :type data: dict
70         :type ip_version: str
71         :type entry_id: int
72         :returns: Content of response.
73         :rtype: bytearray
74         """
75
76         path = "/relay/dhcp:{0}/{1}".format(ip_version, entry_id)
77
78         return DHCPRelayKeywords._set_dhcp_relay_properties(node, path, data)
79
80     @staticmethod
81     def clear_dhcp_relay_configuration(node):
82         """Remove all DHCP relay configuration from the node.
83
84         :param node: Honeycomb node.
85         :type node: dict
86         :returns: Content of response.
87         :rtype: bytearray
88         """
89         return DHCPRelayKeywords._set_dhcp_relay_properties(node, "")
90
91     @staticmethod
92     def get_dhcp_relay_oper_data(node):
93         """Get operational data about the DHCP relay feature.
94
95         :param node: Honeycomb node.
96         :type node: dict
97         :returns: Content of response.
98         :rtype: bytearray
99         :raises HoneycombError: If the status code in response is not 200 = OK.
100         """
101
102         status_code, resp = HcUtil. \
103             get_honeycomb_data(node, "config_dhcp_relay")
104
105         if status_code != HTTPCodes.OK:
106             raise HoneycombError(
107                 "Could not retrieve DHCP relay configuration. "
108                 "Status code: {0}.".format(status_code))
109         return resp

©2016 FD.io a Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.
Please see our privacy policy and terms of use.