Update vpp-agent version
[csit.git] / resources / libraries / python / LispSetup.py
index e0c86aa..5ef8bc0 100644 (file)
@@ -17,6 +17,189 @@ from resources.libraries.python.topology import NodeType
 from resources.libraries.python.VatExecutor import VatExecutor
 
 
+class LispStatus(object):
+    """Class for lisp API."""
+
+    def __init__(self):
+        pass
+
+    @staticmethod
+    def vpp_lisp_enable_disable(node, state):
+        """Enable/Disable lisp in the VPP node in topology.
+
+        :param node: Node of the test topology.
+        :param state: State of the lisp, enable or disable.
+        :type node: dict
+        :type state: str
+        """
+
+        VatExecutor.cmd_from_template(node,
+                                      'lisp/lisp_status.vat',
+                                      state=state)
+
+
+class LispRemoteMapping(object):
+    """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, 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_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
+        :type deid_prefix: int
+        :type seid: str
+        :type seid_prefix: int
+        :type rloc: str
+        :type is_mac: bool
+        """
+        if is_mac:
+            deid_prefix = ''
+            seid_prefix = ''
+        else:
+            deid_prefix = '/{}'.format(deid_prefix)
+            seid_prefix = '/{}'.format(seid_prefix)
+        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)
+
+    @staticmethod
+    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_prefix: Destination eid address prefix_len.
+        :param seid: Source eid address.
+        :param seid_prefix: Source eid address prefix_len.
+        :param rloc: Receiver locator.
+        :type node: dict
+        :type vni: int
+        :type deid: str
+        :type deid_prefix: int
+        :type seid: str
+        :type seid_prefix: int
+        :type rloc: str
+        """
+
+        VatExecutor.cmd_from_template(node,
+                                      'lisp/del_lisp_remote_mapping.vat',
+                                      vni=vni,
+                                      deid=deid,
+                                      deid_prefix=deid_prefix,
+                                      seid=seid,
+                                      seid_prefix=seid_prefix,
+                                      rloc=rloc)
+
+
+class LispAdjacency(object):
+    """Class for lisp adjacency API."""
+
+    def __init__(self):
+        pass
+
+    @staticmethod
+    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 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 vni: int
+        :type deid: str
+        :type deid_prefix: int
+        :type seid: str
+        :type seid_prefix: int
+        :type is_mac: bool
+        """
+        if is_mac:
+            deid_prefix = ''
+            seid_prefix = ''
+        else:
+            deid_prefix = '/{}'.format(deid_prefix)
+            seid_prefix = '/{}'.format(seid_prefix)
+        VatExecutor.cmd_from_template(node,
+                                      'lisp/add_lisp_adjacency.vat',
+                                      vni=vni,
+                                      deid=deid,
+                                      deid_prefix=deid_prefix,
+                                      seid=seid,
+                                      seid_prefix=seid_prefix)
+
+    @staticmethod
+    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 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 vni: int
+        :type deid: str
+        :type deid_prefix: int
+        :type seid: str
+        :type seid_prefix: int
+        """
+
+        VatExecutor.cmd_from_template(node,
+                                      'lisp/del_lisp_adjacency.vat',
+                                      vni=vni,
+                                      deid=deid,
+                                      deid_prefix=deid_prefix,
+                                      seid=seid,
+                                      seid_prefix=seid_prefix)
+
+
+class LispGpeStatus(object):
+    """Clas for LISP GPE status manipulation."""
+
+    def __init__(self):
+        pass
+
+    @staticmethod
+    def vpp_lisp_gpe_enable_disable(node, state):
+        """Change the state of LISP GPE - enable or disable.
+
+        :param node: VPP node.
+        :param state: Requested state - enable or disable.
+        :type node: dict
+        :type state: str
+        """
+
+        VatExecutor.cmd_from_template(node, 'lisp/lisp_gpe_status.vat',
+                                      state=state)
+
+
 class LispGpeIface(object):
     """Class for Lisp gpe interface API."""
 
@@ -28,16 +211,38 @@ class LispGpeIface(object):
         """Set lisp gpe interface up or down on the VPP node in topology.
 
         :param node: VPP node.
-        :param state: State of the gpe iface, up or down
+        :param state: State of the gpe iface, up or down.
         :type node: dict
         :type state: str
         """
 
-        VatExecutor.cmd_from_template(node,
-                                      'lisp/lisp_gpe_iface.vat',
+        VatExecutor.cmd_from_template(node, 'lisp/lisp_gpe_iface.vat',
                                       state=state)
 
 
+class LispGpeForwardEntry(object):
+    """The functionality needed for these methods is not implemented in VPP
+    (VAT). Bug https://jira.fd.io/browse/VPP-334 was open to cover this issue.
+
+    TODO: Implement when VPP-334 is fixed.
+    """
+
+    def __init__(self):
+        pass
+
+    @staticmethod
+    def add_lisp_gpe_forward_entry(node, *args):
+        """Not implemented"""
+        # TODO: Implement when VPP-334 is fixed.
+        pass
+
+    @staticmethod
+    def del_lisp_gpe_forward_entry(node, *args):
+        """Not implemented"""
+        # TODO: Implement when VPP-334 is fixed.
+        pass
+
+
 class LispMapResolver(object):
     """Class for Lisp map resolver API."""
 
@@ -80,44 +285,66 @@ class LispLocalEid(object):
         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)
+        if prefix_len is not None:
+            VatExecutor.cmd_from_template(node,
+                                          'lisp/add_lisp_local_eid.vat',
+                                          vni=vni,
+                                          eid=eid,
+                                          eid_prefix=prefix_len,
+                                          locator_name=locator_set_name)
+        else:
+            VatExecutor.cmd_from_template(node,
+                                          'lisp/add_lisp_local_eid_mac.vat',
+                                          vni=vni,
+                                          eid=eid,
+                                          locator_name=locator_set_name)
 
     @staticmethod
-    def vpp_del_lisp_local_eid(node, locator_set_name, address, prefix_len):
+    def vpp_del_lisp_local_eid(node, locator_set_name, vni, eid,
+                               prefix_len=None):
         """Set lisp eid addres 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/del_lisp_local_eid.vat',
-                                      eid_address=address,
-                                      eid_prefix=prefix_len,
-                                      locator_name=locator_set_name)
+        if prefix_len is not None:
+            VatExecutor.cmd_from_template(node,
+                                          'lisp/del_lisp_local_eid.vat',
+                                          vni=vni,
+                                          eid=eid,
+                                          eid_prefix=prefix_len,
+                                          locator_name=locator_set_name)
+        else:
+            VatExecutor.cmd_from_template(node,
+                                          'lisp/del_lisp_local_eid_mac.vat',
+                                          vni=vni,
+                                          eid=eid,
+                                          locator_name=locator_set_name)
 
 
 class LispLocator(object):
@@ -215,66 +442,43 @@ class LispSetup(object):
         pass
 
     @staticmethod
-    def vpp_set_lisp_locator_set(node, locator_sets):
+    def vpp_set_lisp_locator_set(node, locator_set_list):
         """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.
+        :param locator_set_list: List of locator_set.
         :type node: dict
-        :type locator_sets: dict
+        :type locator_set_list: list
         """
 
         if node['type'] != NodeType.DUT:
-            raise ValueError('Lisp locator set, node is not DUT')
+            raise ValueError('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_set = LispLocatorSet()
+        for locator_set in locator_set_list:
+            locator_set_name = locator_set.get('locator-set')
+            locator_list = locator_set.get('locator')
+            lisp_locator_set.vpp_add_lisp_locator_set(node,
+                                                      locator_set_name)
+            for locator in locator_list:
+                sw_if_index = locator.get('locator-index')
+                priority = locator.get('priority')
+                weight = locator.get('weight')
                 lisp_locator.vpp_add_lisp_locator(node,
-                                                  locator_name,
+                                                  locator_set_name,
                                                   sw_if_index,
                                                   priority,
                                                   weight)
 
     @staticmethod
-    def vpp_unset_lisp_locator_set(node, locator_sets):
+    def vpp_unset_lisp_locator_set(node, locator_set_list):
         """Unset lisp locator_sets on VPP node in topology.
 
         :param node: VPP node.
-        :param locator_sets: Dictionary containing information of locator_set.
+        :param locator_set_list: List of locator_set.
         :type node: dict
-        :type locator_sets: dict
+        :type locator_set_list: list
         """
 
         if node['type'] != NodeType.DUT:
@@ -282,33 +486,21 @@ class LispSetup(object):
 
         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 in locator_set_list:
+            locator_set_name = locator_set.get('locator-set')
+            locator_list = locator_set.get('locator')
+            for locator in locator_list:
+                sw_if_index = locator.get('locator-index')
+                priority = locator.get('priority')
+                weight = locator.get('weight')
+                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)
+            lisp_locator_set.vpp_del_lisp_locator_set(node,
+                                                      locator_set_name)
 
     @staticmethod
     def vpp_set_lisp_eid_table(node, eid_table):
@@ -321,17 +513,19 @@ class LispSetup(object):
         """
 
         if node['type'] != NodeType.DUT:
-            raise ValueError('Lisp locator set, node is not DUT')
+            raise ValueError('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')
+            vni = eid.get('vni')
+            eid_address = eid.get('eid')
+            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,
+                                            vni,
                                             eid_address,
                                             eid_prefix_len)
 
@@ -346,20 +540,22 @@ class LispSetup(object):
         """
 
         if node['type'] != NodeType.DUT:
-            raise ValueError('Lisp locator set, node is not DUT')
+            raise ValueError('Node is not DUT')
 
         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')
+            vni = eid.get('vni')
+            eid_address = eid.get('eid')
+            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,
+                                            vni,
                                             eid_address,
                                             eid_prefix_len)
 
@@ -406,3 +602,32 @@ class LispSetup(object):
 
         lgi = LispGpeIface()
         lgi.vpp_lisp_gpe_iface(node, state)
+
+
+class LispEidTableMap(object):
+    """
+    Class for EID table map.
+    """
+
+    @staticmethod
+    def vpp_lisp_eid_table_mapping(node, vni, bd_id=None, vrf=None):
+        """
+        Map LISP VNI to either bridge domain ID, or VRF ID.
+
+        :param node: VPP node.
+        :param vni: Lisp VNI.
+        :param bd_id: Bridge domain ID.
+        :param vrf: VRF id.
+        :type node: dict
+        :type vni: int
+        :type bd_id: int
+        :type vrf: int
+        """
+        if bd_id:
+            bd_or_vrf = 'bd_index {}'.format(bd_id)
+        else:
+            bd_or_vrf = 'vrf {}'.format(vrf)
+        VatExecutor.cmd_from_template(node,
+                                      'lisp/lisp_eid_table_add_del_map.vat',
+                                      vni=vni,
+                                      bd_or_vrf=bd_or_vrf)