X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FLispSetup.py;h=65797645961cdfc8423c755d13c2d69c6009d51c;hp=88fcfacda692772ca6d8af6a482aec2894b21c11;hb=9780b57a9640e9ab40e40ec122ac80e09cd74c79;hpb=deb6fdb6a59f5c02b8cacaa9c0e6043562e53646 diff --git a/resources/libraries/python/LispSetup.py b/resources/libraries/python/LispSetup.py index 88fcfacda6..6579764596 100644 --- a/resources/libraries/python/LispSetup.py +++ b/resources/libraries/python/LispSetup.py @@ -1,4 +1,4 @@ -# Copyright (c) 2016 Cisco and/or its affiliates. +# Copyright (c) 2016-2020 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: @@ -13,15 +13,70 @@ """Library to set up Lisp in topology.""" -from resources.libraries.python.topology import NodeType -from resources.libraries.python.VatExecutor import VatExecutor +from enum import IntEnum +from ipaddress import ip_address -class Lisp(object): - """Class for lisp API.""" +from resources.libraries.python.IPUtil import IPUtil +from resources.libraries.python.PapiExecutor import PapiSocketExecutor + + +class EidType(IntEnum): + """EID types.""" + PREFIX = 0 + MAC = 1 + NSH = 2 + + +class LispEid: + """Class for lisp eid.""" + + @staticmethod + def create_eid(eid, prefix_len): + """Create lisp eid object. + + :param eid: Eid value. + :param prefix_len: Prefix len if the eid is IP address. + :type eid: str + :type prefix_len: int + """ + eid_addr = dict( + prefix=IPUtil.create_prefix_object(ip_address(eid), prefix_len) + ) if prefix_len else dict(mac=str(eid)) + + return dict( + type=getattr( + EidType, u"PREFIX" if prefix_len else u"MAC" + ).value, + address=eid_addr + ) + + +class LispRemoteLocator: + """Class for lisp remote locator.""" + + @staticmethod + def create_rloc(ip_addr, priority=0, weight=0): + """Create lisp remote locator object. + + :param ip_addr: IP/IPv6 address. + :param priority: Priority of the remote locator. + :param weight: Weight of the remote locator. + :type ip_addr: str + :type priority: int + :type weight: int + """ + return [ + dict( + priority=priority, + weight=weight, + ip_address=ip_address(ip_addr) + ) + ] - def __init__(self): - pass + +class LispStatus: + """Class for lisp API.""" @staticmethod def vpp_lisp_enable_disable(node, state): @@ -32,30 +87,31 @@ class Lisp(object): :type node: dict :type state: str """ + args = dict(is_enable=bool(state == u"enable")) + cmd = u"lisp_enable_disable" + err_msg = f"Failed to set LISP status on host {node[u'host']}" - VatExecutor.cmd_from_template(node, - 'lisp/lisp.vat', - state=state) + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) -class LispRemoteMapping(object): +class LispRemoteMapping: """Class for lisp remote mapping API.""" - def __init__(self): - pass - @staticmethod - def vpp_add_lisp_remote_mapping(node, vni, deid, deid_prefix, seid, - seid_prefix, rloc): + def vpp_add_lisp_remote_mapping( + node, vni, deid, deid_prefix, seid, seid_prefix, rloc, + is_mac=False): """Add lisp remote mapping on the VPP node in topology. :param node: VPP node. :param vni: Vni. :param deid: Destination eid address. - :param deid_predix: Destination eid address prefix_len. + :param deid_prefix: Destination eid address prefix_len. :param seid: Source eid address. :param seid_prefix: Source eid address prefix_len. :param rloc: Receiver locator. + :param is_mac: Set to True if the deid/seid is MAC address. :type node: dict :type vni: int :type deid: str @@ -63,26 +119,32 @@ class LispRemoteMapping(object): :type seid: str :type seid_prefix: int :type rloc: str + :type is_mac: bool """ - - VatExecutor.cmd_from_template(node, - 'lisp/add_lisp_remote_mapping.vat', - vni=vni, - deid=deid, - deid_prefix=deid_prefix, - seid=seid, - seid_prefix=seid_prefix, - rloc=rloc) + args = dict( + is_add=True, + is_src_dst=True, + vni=int(vni), + deid=LispEid.create_eid(deid, deid_prefix if not is_mac else None), + seid=LispEid.create_eid(seid, seid_prefix if not is_mac else None), + rloc_num=1, + rlocs=LispRemoteLocator.create_rloc(rloc) + ) + cmd = u"lisp_add_del_remote_mapping" + err_msg = f"Failed to add remote mapping on host {node[u'host']}" + + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) @staticmethod - def vpp_del_lisp_remote_mapping(node, vni, deid, deid_prefix, seid, - seid_prefix, rloc): + def vpp_del_lisp_remote_mapping( + node, vni, deid, deid_prefix, seid, seid_prefix, rloc): """Delete lisp remote mapping on the VPP node in topology. :param node: VPP node. :param vni: Vni. :param deid: Destination eid address. - :param deid_predix: Destination eid address prefix_len. + :param deid_prefix: Destination eid address prefix_len. :param seid: Source eid address. :param seid_prefix: Source eid address prefix_len. :param rloc: Receiver locator. @@ -94,135 +156,182 @@ class LispRemoteMapping(object): :type seid_prefix: int :type rloc: str """ - - VatExecutor.cmd_from_template(node, - 'lisp/del_lisp_remote_mapping.vat', - vni=vni, - deid=deid, - deid_predix=deid_prefix, - seid=seid, - seid_prefix=seid_prefix, - rloc=rloc) - - -class LispGpeIface(object): - """Class for Lisp gpe interface API.""" - - def __init__(self): - pass + # used only with IPs + args = dict( + is_add=False, + is_src_dst=True, + vni=int(vni), + deid=LispEid.create_eid(deid, deid_prefix), + seid=LispEid.create_eid(seid, seid_prefix), + rloc_num=1, + rlocs=LispRemoteLocator.create_rloc(rloc) + ) + cmd = u"lisp_add_del_remote_mapping" + err_msg = f"Failed to delete remote mapping on host {node[u'host']}" + + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) + + +class LispAdjacency: + """Class for lisp adjacency API.""" @staticmethod - def vpp_lisp_gpe_iface(node, state): - """Set lisp gpe interface up or down on the VPP node in topology. + def vpp_add_lisp_adjacency( + node, vni, deid, deid_prefix, seid, seid_prefix, is_mac=False): + """Add lisp adjacency on the VPP node in topology. :param node: VPP node. - :param state: State of the gpe iface, up or down. + :param vni: Vni. + :param deid: Destination eid address. + :param deid_prefix: Destination eid address prefix_len. + :param seid: Source eid address. + :param seid_prefix: Source eid address prefix_len. + :param is_mac: Set to True if the deid/seid is MAC address. :type node: dict - :type state: str + :type vni: int + :type deid: str + :type deid_prefix: int + :type seid: str + :type seid_prefix: int + :type is_mac: bool """ - - VatExecutor.cmd_from_template(node, - 'lisp/lisp_gpe_iface.vat', - state=state) - - -class LispMapResolver(object): - """Class for Lisp map resolver API.""" - - def __init__(self): - pass + args = dict( + is_add=True, + vni=int(vni), + reid=LispEid.create_eid(deid, deid_prefix if not is_mac else None), + leid=LispEid.create_eid(seid, seid_prefix if not is_mac else None) + ) + cmd = u"lisp_add_del_adjacency" + err_msg = f"Failed to add lisp adjacency on host {node[u'host']}" + + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) @staticmethod - def vpp_add_map_resolver(node, map_resolver_ip): - """Set lisp map resolver on the VPP node in topology. + def vpp_del_lisp_adjacency( + node, vni, deid, deid_prefix, seid, seid_prefix): + """Delete lisp adjacency on the VPP node in topology. :param node: VPP node. - :param map_resolver_ip: IP address of the map resolver. + :param vni: Vni. + :param deid: Destination eid address. + :param deid_prefix: Destination eid address prefix_len. + :param seid: Source eid address. + :param seid_prefix: Source eid address prefix_len. :type node: dict - :type map_resolver_ip: str + :type vni: int + :type deid: str + :type deid_prefix: int + :type seid: str + :type seid_prefix: int """ + # used only with IPs + args = dict( + is_add=False, + vni=int(vni), + eid=LispEid.create_eid(deid, deid_prefix), + leid=LispEid.create_eid(seid, seid_prefix) + ) + cmd = u"lisp_add_del_adjacency" + err_msg = f"Failed to delete lisp adjacency on host {node[u'host']}" + + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) + - VatExecutor.cmd_from_template(node, - 'lisp/add_lisp_map_resolver.vat', - address=map_resolver_ip) +class LispGpeStatus: + """Class for LISP GPE status manipulation.""" @staticmethod - def vpp_del_map_resolver(node, map_resolver_ip): - """Unset lisp map resolver on the VPP node in topology. + def vpp_lisp_gpe_enable_disable(node, state): + """Change the state of LISP GPE - enable or disable. :param node: VPP node. - :param map_resolver_ip: IP address of the map resolver. + :param state: Requested state - enable or disable. :type node: dict - :type map_resolver_ip: str + :type state: str """ + args = dict(is_enable=bool(state == u"enable")) + cmd = u"gpe_enable_disable" + err_msg = f"Failed to set LISP GPE status on host {node[u'host']}" - VatExecutor.cmd_from_template(node, - 'lisp/del_lisp_map_resolver.vat', - address=map_resolver_ip) + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) -class LispLocalEid(object): +class LispLocalEid: """Class for Lisp local eid API.""" - def __init__(self): - pass - @staticmethod - def vpp_add_lisp_local_eid(node, locator_set_name, address, prefix_len): - """Set lisp eid addres on the VPP node in topology. + def vpp_add_lisp_local_eid( + node, locator_set_name, vni, eid, prefix_len=None): + """Set lisp eid address on the VPP node in topology. :param node: VPP node. :param locator_set_name: Name of the locator_set. - :param address: Eid IP address. - :param prefix_len: prefix len of the eid IP address. + :param vni: Vni value. + :param eid: Eid value. + :param prefix_len: Prefix len if the eid is IP address. :type node: dict :type locator_set_name: str - :type address: str + :type vni: int + :type eid: str :type prefix_len: int """ - - VatExecutor.cmd_from_template(node, - 'lisp/add_lisp_local_eid.vat', - eid_address=address, - eid_prefix=prefix_len, - locator_name=locator_set_name) + args = dict( + is_add=True, + eid=LispEid.create_eid(eid, prefix_len), + locator_set_name=locator_set_name, + vni=int(vni) + ) + cmd = u"lisp_add_del_local_eid" + err_msg = f"Failed to add local eid on host {node[u'host']}" + + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) @staticmethod - def vpp_del_lisp_local_eid(node, locator_set_name, address, prefix_len): - """Set lisp eid addres on the VPP node in topology. + def vpp_del_lisp_local_eid( + node, locator_set_name, vni, eid, prefix_len=None): + """Set lisp eid address on the VPP node in topology. :param node: VPP node. :param locator_set_name: Name of the locator_set. - :param address: Eid IP address. - :param prefix_len: prefix len of the eid IP address. + :param vni: Vni value. + :param eid: Eid value. + :param prefix_len: Prefix len if the eid is IP address. :type node: dict :type locator_set_name: str - :type address: str + :type vni: int + :type eid: str :type prefix_len: int """ + args = dict( + is_add=False, + eid=LispEid.create_eid(eid, prefix_len), + locator_set_name=locator_set_name, + vni=int(vni) + ) + cmd = u"lisp_add_del_local_eid" + err_msg = f"Failed to delete local eid on host {node[u'host']}" - VatExecutor.cmd_from_template(node, - 'lisp/del_lisp_local_eid.vat', - eid_address=address, - eid_prefix=prefix_len, - locator_name=locator_set_name) + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) -class LispLocator(object): +class LispLocator: """Class for the Lisp Locator API.""" - def __init__(self): - pass - @staticmethod def vpp_add_lisp_locator(node, locator_name, sw_if_index, priority, weight): """Set lisp locator on the VPP node in topology. :param node: VPP node. :param locator_name: Name of the locator_set. - :param sw_if_index: sw_if_index if the interface. - :param priority: priority of the locator. - :param weight: weight of the locator. + :param sw_if_index: Sw_if_index if the interface. + :param priority: Priority of the locator. + :param weight: Weight of the locator. :type node: dict :type locator_name: str :type sw_if_index: int @@ -230,12 +339,18 @@ class LispLocator(object): :type weight: int """ - VatExecutor.cmd_from_template(node, - 'lisp/add_lisp_locator.vat', - lisp_name=locator_name, - sw_if_index=sw_if_index, - priority=priority, - weight=weight) + args = dict( + is_add=True, + locator_set_name=locator_name, + sw_if_index=sw_if_index, + priority=priority, + weight=weight + ) + cmd = u"lisp_add_del_locator" + err_msg = f"Failed to add locator on host {node[u'host']}" + + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) @staticmethod def vpp_del_lisp_locator(node, locator_name, sw_if_index, priority, weight): @@ -243,30 +358,32 @@ class LispLocator(object): :param node: VPP node. :param locator_name: Name of the locator_set. - :param sw_if_index: sw_if_index if the interface. - :param priority: priority of the locator. - :param weight: weight of the locator. + :param sw_if_index: Sw_if_index if the interface. + :param priority: Priority of the locator. + :param weight: Weight of the locator. :type node: dict :type locator_name: str :type sw_if_index: int :type priority: int :type weight: int """ + args = dict( + is_add=False, + locator_set_name=locator_name, + sw_if_index=sw_if_index, + priority=priority, + weight=weight + ) + cmd = u"lisp_add_del_locator" + err_msg = f"Failed to delete locator on host {node[u'host']}" - VatExecutor.cmd_from_template(node, - 'lisp/del_lisp_locator.vat', - lisp_name=locator_name, - sw_if_index=sw_if_index, - priority=priority, - weight=weight) + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) -class LispLocatorSet(object): +class LispLocatorSet: """Class for Lisp Locator Set API.""" - def __init__(self): - pass - @staticmethod def vpp_add_lisp_locator_set(node, name): """Add lisp locator_set on VPP. @@ -276,10 +393,17 @@ class LispLocatorSet(object): :type node: dict :type name: str """ - - VatExecutor.cmd_from_template(node, - 'lisp/add_lisp_locator_set.vat', - lisp_name=name) + args = dict( + is_add=True, + locator_set_name=name, + locator_num=0, + locators=[] + ) + cmd = u"lisp_add_del_locator_set" + err_msg = f"Failed to add locator set on host {node[u'host']}" + + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) @staticmethod def vpp_del_lisp_locator_set(node, name): @@ -290,220 +414,48 @@ class LispLocatorSet(object): :type node: dict :type name: str """ + args = dict( + is_add=False, + locator_set_name=name, + locator_num=0, + locators=[] + ) + cmd = u"lisp_add_del_locator_set" + err_msg = f"Failed to delete locator set on host {node[u'host']}" - VatExecutor.cmd_from_template(node, - 'lisp/del_lisp_locator_set.vat', - lisp_name=name) - - -class LispSetup(object): - """Lisp setup in topology.""" - - def __init__(self): - pass - - @staticmethod - def vpp_set_lisp_locator_set(node, locator_sets): - """Set lisp locator_sets on VPP node in topology. - - There are two ways how set lisp locator_set. - One locator_set can contain multiple locators. - Add new locator_set with same name as it already save in vpp - will reset locator_set and his locator. - To not reset locator_set, use "normal" type of generate data, - where the locator_set is set just once. - To test reset locator_set use "reset" type of generate data, - where the locator_set will be set multiple times. - - :param node: VPP node. - :param locator_sets: Dictionary containing information of locator_set. - :type node: dict - :type locator_sets: dict - """ - - if node['type'] != NodeType.DUT: - raise ValueError('Lisp locator set, node is not DUT') - - lisp_locator_set = LispLocatorSet() - lisp_locator = LispLocator() - for locator_set_type, item in locator_sets.iteritems(): - if locator_set_type == 'normal': - lsm_set = 1 - elif locator_set_type == 'reset': - lsm_set = 0 - else: - raise ValueError('Unknown locator_set_type value: ' - '{}'.format(locator_set_type)) - - locator_set_list = [] - for locator_set in item: - locator_name = locator_set.get('locator-set') - sw_if_index = locator_set.get('locator') - priority = locator_set.get('priority') - weight = locator_set.get('weight') - if lsm_set == 1: - if locator_name not in locator_set_list: - locator_set_list.append(locator_name) - lisp_locator_set.vpp_add_lisp_locator_set(node, - locator_name) - else: - lisp_locator_set.vpp_add_lisp_locator_set(node, - locator_name) - lisp_locator.vpp_add_lisp_locator(node, - locator_name, - sw_if_index, - priority, - weight) - - @staticmethod - def vpp_unset_lisp_locator_set(node, locator_sets): - """Unset lisp locator_sets on VPP node in topology. - - :param node: VPP node. - :param locator_sets: Dictionary containing information of locator_set. - :type node: dict - :type locator_sets: dict - """ - - if node['type'] != NodeType.DUT: - raise ValueError('Lisp locator set, node is not DUT') - - lisp_locator = LispLocator() - lisp_locator_set = LispLocatorSet() - for locator_set_type, item in locator_sets.iteritems(): - if locator_set_type == 'normal': - lsm_set = 1 - elif locator_set_type == 'reset': - lsm_set = 0 - else: - raise ValueError('Unknown locator_set_type value: ' - '{}'.format(locator_set_type)) - - locator_set_list = [] - for locator_set in item: - locator_set_name = locator_set.get('locator-set') - sw_if_index = locator_set.get('locator') - priority = locator_set.get('priority') - weight = locator_set.get('weight') - if lsm_set == 1: - if locator_set_name not in locator_set_list: - locator_set_list.append(locator_set_name) - else: - lisp_locator.vpp_del_lisp_locator(node, - locator_set_name, - sw_if_index, - priority, - weight) - - for locator_set_name in locator_set_list: - lisp_locator_set.vpp_del_lisp_locator_set(node, locator_set_name) - - @staticmethod - def vpp_set_lisp_eid_table(node, eid_table): - """Set lisp eid tables on VPP node in topology. - - :param node: VPP node. - :param eid_table: Dictionary containing information of eid_table. - :type node: dict - :type eid_table: dict - """ - - if node['type'] != NodeType.DUT: - raise ValueError('Lisp locator set, node is not DUT') - - lisp_locator_set = LispLocatorSet() - lisp_eid = LispLocalEid() - for eid in eid_table: - eid_address = eid.get('eid address') - eid_prefix_len = eid.get('eid prefix len') - locator_set_name = eid.get('locator-set') - lisp_locator_set.vpp_add_lisp_locator_set(node, locator_set_name) - lisp_eid.vpp_add_lisp_local_eid(node, - locator_set_name, - eid_address, - eid_prefix_len) - - @staticmethod - def vpp_unset_lisp_eid_table(node, eid_table): - """Unset lisp eid tables on VPP node in topology. - - :param node: VPP node. - :param eid_table: Dictionary containing information of eid_table. - :type node: dict - :type eid_table: dict - """ - - if node['type'] != NodeType.DUT: - raise ValueError('Lisp locator set, node is not DUT') + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg) - locator_set_list = [] - lisp_locator_set = LispLocatorSet() - lisp_eid = LispLocalEid() - for eid in eid_table: - eid_address = eid.get('eid address') - eid_prefix_len = eid.get('eid prefix len') - locator_set_name = eid.get('locator-set') - if locator_set_name not in locator_set_list: - locator_set_list.append(locator_set_name) - lisp_eid.vpp_del_lisp_local_eid(node, - locator_set_name, - eid_address, - eid_prefix_len) - - for locator_set_name in locator_set_list: - lisp_locator_set.vpp_del_lisp_locator_set(node, locator_set_name) +class LispEidTableMap: + """ + Class for EID table map. + """ @staticmethod - def vpp_set_lisp_map_resolver(node, map_resolver): - """Set lisp map resolvers on VPP node in topology. - - :param node: VPP node. - :param map_resolver: Dictionary containing information of map resolver. - :type node: dict - :type map_resolver: dict + def vpp_lisp_eid_table_mapping(node, vni, bd_id=None, vrf=None): """ - - lisp_map_res = LispMapResolver() - for map_ip in map_resolver: - lisp_map_res.vpp_add_map_resolver(node, map_ip.get('map resolver')) - - @staticmethod - def vpp_unset_lisp_map_resolver(node, map_resolver): - """Unset lisp map resolvers on VPP node in topology. + Map LISP VNI to either bridge domain ID, or VRF ID. :param node: VPP node. - :param map_resolver: Dictionary containing information of map resolver. + :param vni: Lisp VNI. + :param bd_id: Bridge domain ID. + :param vrf: VRF id. :type node: dict - :type map_resolver: dict - """ - - lisp_map_res = LispMapResolver() - for map_ip in map_resolver: - lisp_map_res.vpp_del_map_resolver(node, map_ip.get('map resolver')) - - @staticmethod - def vpp_lisp_gpe_interface_status(node, state): - """Set lisp gpe interface status on VPP node in topology. - - :param node: VPP node. - :param state: State of the gpe iface, up or down - :type node: dict - :type state: str - """ - - lgi = LispGpeIface() - lgi.vpp_lisp_gpe_iface(node, state) - - @staticmethod - def vpp_lisp_state(node, state): - """Enable/Disable lisp on VPP node in topology. - - :param node: VPP node. - :param state: State of the lisp, enable or disable - :type node: dict - :type state: str + :type vni: int + :type bd_id: int + :type vrf: int """ - - lgi = Lisp() - lgi.vpp_lisp_enable_disable(node, state) + # adding default mapping vni=0, vrf=0 needs to be skipped + if bd_id is not None or int(vrf if vrf else 0) or int(vni): + args = dict( + is_add=True, + vni=int(vni), + dp_table=int(bd_id) if bd_id is not None else int(vrf), + is_l2=bool(bd_id is not None) + ) + cmd = u"lisp_eid_table_add_del_map" + err_msg = f"Failed to add eid table map on host {node[u'host']}" + + with PapiSocketExecutor(node) as papi_exec: + papi_exec.add(cmd, **args).get_reply(err_msg)