1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
# Copyright (c) 2018 Bell Canada, Pantheon Technologies 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.
"""This module implements keywords to manipulate FIB tables using
Honeycomb REST API."""
from robot.api import logger
from resources.libraries.python.HTTPRequest import HTTPCodes
from resources.libraries.python.honeycomb.HoneycombSetup import HoneycombError
from resources.libraries.python.honeycomb.HoneycombUtil \
import DataRepresentation
from resources.libraries.python.honeycomb.HoneycombUtil \
import HoneycombUtil as HcUtil
class FibKeywords(object):
"""Implementation of keywords which make it possible to:
- add/remove FIB tables,
- add/remove FIB table entries
- get operational data about FIB tables,
"""
def __init__(self):
pass
@staticmethod
def _set_fib_table_properties(node, path, data=None):
"""Set FIB table properties and check the return code.
:param node: Honeycomb node.
:param path: Path which is added to the base path to identify the data.
:param data: The new data to be set. If None, the item will be removed.
:type node: dict
:type path: str
:type data: dict
:returns: Content of response.
:rtype: bytearray
:raises HoneycombError: If the status code in response is not
200 = OK.
"""
if data:
status_code, resp = HcUtil. \
put_honeycomb_data(node, "config_fib_table", data, path,
data_representation=DataRepresentation.JSON)
else:
status_code, resp = HcUtil. \
delete_honeycomb_data(node, "config_fib_table", path)
if status_code not in (HTTPCodes.OK, HTTPCodes.ACCEPTED):
if data is None and '"error-tag":"data-missing"' in resp:
logger.debug("data does not exist in path.")
else:
raise HoneycombError(
"The configuration of FIB table was not successful. "
"Status code: {0}.".format(status_code))
return resp
@staticmethod
def configure_fib_table(node, ip_version, vrf=1):
"""Configure a FIB table according to the data provided.
:param node: Honeycomb node.
:param ip_version: IP protocol version, ipv4 or ipv6.
:param vrf: vrf-id to attach configuration to.
:type node: dict
:type ip_version: str
:type vrf: int
:returns: Content of response.
:rtype: bytearray
"""
full_data = {
"vpp-fib-table-management:table": [
{
"table-id": vrf,
"address-family": "vpp-fib-table-management:{0}"
.format(ip_version),
"name": "{0}-VRF:{1}".format(ip_version, vrf)
}
]
}
path = "/table/{0}/vpp-fib-table-management:{1}".format(vrf, ip_version)
return FibKeywords._set_fib_table_properties(node, path, full_data)
@staticmethod
def delete_fib_table(node, ip_version, vrf=1):
"""Delete the specified FIB table from configuration data.
:param node: Honeycomb node.
:param ip_version: IP protocol version, ipv4 or ipv6.
:param vrf: vrf-id to attach configuration to.
:type node: dict
:type ip_version: str
:type vrf: int
:returns: Content of response.
:rtype: bytearray
"""
path = "/table/{0}/vpp-fib-table-management:{1}".format(vrf, ip_version)
return FibKeywords._set_fib_table_properties(node, path)
@staticmethod
def get_fib_table_oper(node, ip_version, vrf=1):
"""Retrieve operational data about the specified FIB table.
:param node: Honeycomb node.
:param ip_version: IP protocol version, ipv4 or ipv6.
:param vrf: vrf-id to attach configuration to.
:type node: dict
:type ip_version: str
:type vrf: int
:returns: FIB table operational data.
:rtype: list
:raises HoneycombError: If the operation fails.
"""
path = "/table/{0}/vpp-fib-table-management:{1}".format(vrf, ip_version)
status_code, resp = HcUtil. \
get_honeycomb_data(node, "oper_fib_table", path)
if status_code != HTTPCodes.OK:
raise HoneycombError(
"Not possible to get operational information about the "
"FIB tables. Status code: {0}.".format(status_code))
data = resp['vpp-fib-table-management:table'][0]
return data
|
