1 # Copyright (c) 2016 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:
6 # http://www.apache.org/licenses/LICENSE-2.0
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.
14 """Lisp utilities library."""
16 from resources.libraries.python.parsers.JsonParser import JsonParser
17 from resources.libraries.python.topology import Topology
18 from resources.libraries.python.VatExecutor import VatExecutor
21 class LispUtil(object):
22 """Implements keywords for Lisp tests."""
28 def vpp_show_lisp_state(node):
29 """Get lisp state from VPP node.
31 :param node: VPP node.
33 :return: Lisp gpe state.
38 vat.execute_script_json_out('lisp/show_lisp_status.vat',
40 return JsonParser().parse_data(vat.get_script_stdout())
43 def vpp_show_lisp_locator_set(node):
44 """Get lisp locator_set from VPP node.
46 :param node: VPP node.
48 :return: Lisp locator_set data as python list.
53 vat.execute_script_json_out('lisp/show_lisp_locator_set.vat', node)
54 return JsonParser().parse_data(vat.get_script_stdout())
57 def vpp_show_lisp_eid_table(node):
58 """Get lisp eid table from VPP node.
60 :param node: VPP node.
62 :return: Lisp eid table as python list.
67 vat.execute_script_json_out('lisp/show_lisp_eid_table.vat', node)
68 return JsonParser().parse_data(vat.get_script_stdout())
71 def vpp_show_lisp_map_resolver(node):
72 """Get lisp map resolver from VPP node.
74 :param node: VPP node.
76 :return: Lisp map resolver as python list.
81 vat.execute_script_json_out('lisp/show_lisp_map_resolver.vat', node)
82 return JsonParser().parse_data(vat.get_script_stdout())
85 def lisp_should_be_equal(lisp_val1, lisp_val2):
86 """Fail if the lisp values are not equal.
88 :param lisp_val1: First lisp value.
89 :param lisp_val2: Second lisp value.
97 raise RuntimeError('Values are not same. '
99 'Value 2 {}.'.format(lisp_val1,
102 for tmp in lisp_val1:
103 if tmp not in lisp_val2:
104 raise RuntimeError('Value {} not found in vpp:\n'
105 '{}'.format(tmp, lisp_val2))
107 def lisp_locator_s_should_be_equal(self, locator_set1, locator_set2):
108 """Fail if the lisp values are not equal.
110 :param locator_set1: Generate lisp value.
111 :param locator_set2: Lisp value from VPP.
112 :type locator_set1: list
113 :type locator_set2: list
116 # Remove duplicate value which is not set in vpp node.
117 locator_set_list = []
118 tmp_list = list(locator_set1)
120 locator_set = tmp_list.pop(0)
121 locator_set_name = locator_set.get('locator-set')
122 for tmp_loc_set in tmp_list:
123 tmp_loc_set_name = tmp_loc_set.get('locator-set')
124 if locator_set_name == tmp_loc_set_name:
125 locator_set = tmp_loc_set
126 tmp_list.remove(tmp_loc_set)
127 locator_set_list.append(locator_set)
129 for locator_set in locator_set2:
130 if 'locator-set-index' in locator_set:
131 del locator_set['locator-set-index']
133 self.lisp_should_be_equal(locator_set_list, locator_set2)
136 def generate_unique_lisp_locator_set_data(node, locator_set_number):
137 """Generate a list of lisp locator_set we want set to VPP and
138 then check if it is set correctly. All locator_sets are unique.
140 :param node: VPP node.
141 :param locator_set_number: Generate n locator_set.
143 :type locator_set_number: str
144 :return: list of lisp locator_set.
150 locator_set_list = []
152 for num in range(0, int(locator_set_number)):
154 for interface in node['interfaces'].values():
155 link = interface.get('link')
160 if_name = topo.get_interface_by_link_name(node, link)
161 sw_if_index = topo.get_interface_sw_index(node, if_name)
162 if if_name is not None:
163 locator = {'locator-index': sw_if_index,
166 locator_list.append(locator)
168 l_name = 'ls{0}'.format(num)
169 locator_set = {'locator-set': l_name,
170 'locator': locator_list}
171 locator_set_list.append(locator_set)
173 return locator_set_list
176 def generate_duplicate_lisp_locator_set_data(node, locator_set_number):
177 """Generate a list of lisp locator_set we want set to VPP and
178 then check if it is set correctly. Some locator_sets are duplicated.
180 :param node: VPP node.
181 :param locator_set_number: Generate n locator_set.
183 :type locator_set_number: str
184 :return: list of lisp locator_set.
189 locator_set_list = []
191 for num in range(0, int(locator_set_number)):
193 for interface in node['interfaces'].values():
194 link = interface.get('link')
199 if_name = topo.get_interface_by_link_name(node, link)
200 sw_if_index = topo.get_interface_sw_index(node, if_name)
201 if if_name is not None:
202 l_name = 'ls{0}'.format(num)
203 locator = {'locator-index': sw_if_index,
206 locator_list.append(locator)
207 locator_set = {'locator-set': l_name,
208 'locator': locator_list}
209 locator_set_list.append(locator_set)
211 return locator_set_list
213 def lisp_is_empty(self, lisp_params):
214 """Check if the input param are empty.
216 :param lisp_params: Should be empty list.
217 :type lisp_params: list
220 self.lisp_should_be_equal([], lisp_params)