# 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. """Lisp utilities library.""" from resources.libraries.python.parsers.JsonParser import JsonParser from resources.libraries.python.topology import Topology from resources.libraries.python.VatExecutor import VatExecutor class LispUtil(object): """Implements keywords for Lisp tests.""" def __init__(self): pass @staticmethod def vpp_show_lisp_locator_set(node): """Get lisp locator_set from VPP node. :param node: VPP node. :type node: dict :return: Lisp locator_set data as python list. :rtype: list """ vat = VatExecutor() vat.execute_script_json_out('lisp/show_lisp_locator_set.vat', node) return JsonParser().parse_data(vat.get_script_stdout()) @staticmethod def vpp_show_lisp_local_eid_table(node): """Get lisp local eid table from VPP node. :param node: VPP node. :type node: dict :return: Lisp eid table as python list. :rtype: list """ vat = VatExecutor() vat.execute_script_json_out('lisp/show_lisp_local_eid_table.vat', node) return JsonParser().parse_data(vat.get_script_stdout()) @staticmethod def vpp_show_lisp_map_resolver(node): """Get lisp map resolver from VPP node. :param node: VPP node. :type node: dict :return: Lisp map resolver as python list. :rtype: list """ vat = VatExecutor() vat.execute_script_json_out('lisp/show_lisp_map_resolver.vat', node) return JsonParser().parse_data(vat.get_script_stdout()) @staticmethod def lisp_should_be_equal(lisp_val1, lisp_val2): """Fail if the lisp values are not equal. :param lisp_val1: First lisp value. :param lisp_val2: Second lisp value. :type lisp_val1: list :type lisp_val2: list """ len1 = len(lisp_val1) len2 = len(lisp_val2) if len1 != len2: raise RuntimeError('Values are not same. ' 'Value 1 {} \n' 'Value 2 {}.'.format(lisp_val1, lisp_val2)) for tmp in lisp_val1: if tmp not in lisp_val2: raise RuntimeError('Value {} is not find in vpp:\n' '{}'.format(tmp, lisp_val2)) def lisp_locator_s_should_be_equal(self, locator_set1, locator_set2): """Fail if the lisp values are not equal. :param locator_set1: Generate lisp value. :param locator_set2: Lisp value from VPP. :type locator_set1: dict :type locator_set2: list """ reset_list = [] locator_set_list = [] for locator_set_type, item in locator_set1.iteritems(): if locator_set_type == 'normal': self.lisp_should_be_equal(item, locator_set2) elif locator_set_type == 'reset': for locator_list in reversed(item): name = locator_list.get('locator-set') if name not in locator_set_list: reset_list.insert(0, locator_list) locator_set_list.append(name) self.lisp_should_be_equal(reset_list, locator_set2) else: raise ValueError('Unknown locator_set_type value: ' '{}'.format(locator_set_type)) @staticmethod def generate_lisp_locator_set_data(node, locator_set_number): """Generate a list of lisp locator_set we want set to VPP and then check if is set correct. "normal" type of data set locator_set just once. :param node: VPP node. :param locator_set_number: Generate n locator_set. :type node: dict :type locator_set_number: str :return: dict of lisp locator_set. :rtype: dict """ topo = Topology() locator_set_list = [] i = 0 for num in range(0, int(locator_set_number)): for interface in node['interfaces'].values(): link = interface.get('link') i += 1 if link is None: continue if_name = topo.get_interface_by_link_name(node, link) sw_if_index = topo.get_interface_sw_index(node, if_name) if if_name is not None: l_name = 'ls{0}'.format(num) locator_set = {'locator-set': l_name, 'locator': sw_if_index, 'priority': i, 'weight': i} locator_set_list.append(locator_set) loc_type = {'normal': locator_set_list} return loc_type @staticmethod def generate_lisp_locator_set_reset_data(node, locator_set_number): """Generate a list of lisp locator_set we want set to VPP and then check if is set correct. "reset" type of data set locator_set multiple times, use to test reset locator_set in vpp. :param node: VPP node. :param locator_set_number: Generate n locator_set. :type node: dict :type locator_set_number: str :return: dict of lisp locator_set. :rtype: dict """ topo = Topology() locator_set_list = [] for num in range(0, int(locator_set_number)): for interface in node['interfaces'].values(): link = interface.get('link') if link is None: continue if_name = topo.get_interface_by_link_name(node, link) sw_if_index = topo.get_interface_sw_index(node, if_name) if if_name is not None: l_name = 'ls{0}'.format(num) locator_set = {'locator-set': l_name, 'locator': sw_if_index, 'priority': 1, 'weight': 1} locator_set_list.append(locator_set) loc_type = {'reset': locator_set_list} return loc_type @staticmethod def generate_lisp_local_eid_data(ipv4_num, ipv6_num): """Generate a list of lisp local eid we want set to VPP and then check if is set correct. :param ipv4_num: Generate n ipv4 eid address. :param ipv6_num: Generate n ipv6 eid address. :type ipv4_num: str :type ipv6_num: str :return: list of lisp local eid. :rtype: list """ eid_table = [] for num in range(0, int(ipv4_num)): addrr = '192.168.{}.1'.format(num) eid = {'eid address': addrr, 'eid prefix len': 24, 'locator-set': 'ls1'} eid_table.append(eid) for num in range(0, int(ipv6_num)): addrr = '10:{}::1'.format(num + 1) eid = {'eid address': addrr, 'eid prefix len': 32, 'locator-set': 'ls1'} eid_table.append(eid) return eid_table @staticmethod def generate_lisp_map_resolver_data(ipv4_num, ipv6_num): """Generate a list of lisp map resolvers we want set to VPP and then check if is set correct. :param ipv4_num: Generate n ipv4 map resolver address. :param ipv6_num: Generate n ipv6 map resolver address. :type ipv4_num: str :type ipv6_num: str :return: list of lisp map resolver. :rtype: list """ map_resolver = [] for i in range(0, int(ipv4_num)): addr = '192.169.{}.1'.format(i) resolver = {'map resolver': addr} map_resolver.append(resolver) for i in range(0, int(ipv6_num)): addr = '12:{}::1'.format(i + 1) resolver = {'map resolver': addr} map_resolver.append(resolver) return map_resolver def lisp_is_empty(self, lisp_params): """Check if the input param are empty. :param lisp_params: Should be empty list. :type lisp_params: list """ self.lisp_should_be_equal([], lisp_params)