CSIT-65: Add new test for LISP API

Test set and unset this API:
	lisp_add_del_locator_set
	lisp_add_del_locator
	lisp_add_del_local_eid
	lisp_add_del_map_resolver
	lisp_gpe_add_del_iface

Change-Id: I9c701fc421d4106147891a7e75e5d68885b9ba59
Signed-off-by: Andrej Kozemcak <akozemca@cisco.com>

2 files changed, 665 insertions, 0 deletions

diff --git a/resources/libraries/python/LispSetup.py b/resources/libraries/python/LispSetup.py
new file mode 100644
index 0000000000..e0c86aae51
--- /dev/null
+++ b/resources/libraries/python/LispSetup.py
@@ -0,0 +1,408 @@
+# 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.
+
+"""Library to set up Lisp in topology."""
+
+from resources.libraries.python.topology import NodeType
+from resources.libraries.python.VatExecutor import VatExecutor
+
+
+class LispGpeIface(object):
+    """Class for Lisp gpe interface API."""
+
+    def __init__(self):
+        pass
+
+    @staticmethod
+    def vpp_lisp_gpe_iface(node, state):
+        """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
+        :type node: dict
+        :type state: str
+        """
+
+        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
+
+    @staticmethod
+    def vpp_add_map_resolver(node, map_resolver_ip):
+        """Set lisp map resolver on the VPP node in topology.
+
+        :param node: VPP node.
+        :param map_resolver_ip: IP address of the map resolver.
+        :type node: dict
+        :type map_resolver_ip: str
+        """
+
+        VatExecutor.cmd_from_template(node,
+                                      'lisp/add_lisp_map_resolver.vat',
+                                      address=map_resolver_ip)
+
+    @staticmethod
+    def vpp_del_map_resolver(node, map_resolver_ip):
+        """Unset lisp map resolver on the VPP node in topology.
+
+        :param node: VPP node.
+        :param map_resolver_ip: IP address of the map resolver.
+        :type node: dict
+        :type map_resolver_ip: str
+        """
+
+        VatExecutor.cmd_from_template(node,
+                                      'lisp/del_lisp_map_resolver.vat',
+                                      address=map_resolver_ip)
+
+
+class LispLocalEid(object):
+    """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.
+
+        :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.
+        :type node: dict
+        :type locator_set_name: str
+        :type address: 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)
+
+    @staticmethod
+    def vpp_del_lisp_local_eid(node, locator_set_name, address, prefix_len):
+        """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.
+        :type node: dict
+        :type locator_set_name: str
+        :type address: 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)
+
+
+class LispLocator(object):
+    """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.
+        :type node: dict
+        :type locator_name: str
+        :type sw_if_index: int
+        :type priority: int
+        :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)
+
+    @staticmethod
+    def vpp_del_lisp_locator(node, locator_name, sw_if_index, priority, weight):
+        """Unset 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.
+        :type node: dict
+        :type locator_name: str
+        :type sw_if_index: int
+        :type priority: int
+        :type weight: int
+        """
+
+        VatExecutor.cmd_from_template(node,
+                                      'lisp/del_lisp_locator.vat',
+                                      lisp_name=locator_name,
+                                      sw_if_index=sw_if_index,
+                                      priority=priority,
+                                      weight=weight)
+
+
+class LispLocatorSet(object):
+    """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.
+
+        :param node: VPP node.
+        :param name: VPP locator name.
+        :type node: dict
+        :type name: str
+        """
+
+        VatExecutor.cmd_from_template(node,
+                                      'lisp/add_lisp_locator_set.vat',
+                                      lisp_name=name)
+
+    @staticmethod
+    def vpp_del_lisp_locator_set(node, name):
+        """Del lisp locator_set on VPP.
+
+        :param node: VPP node.
+        :param name: VPP locator name.
+        :type node: dict
+        :type name: str
+        """
+
+        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')
+
+        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)
+
+    @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
+        """
+
+        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.
+
+        :param node: VPP node.
+        :param map_resolver: Dictionary containing information of map resolver.
+        :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)
diff --git a/resources/libraries/python/LispUtil.py b/resources/libraries/python/LispUtil.py
new file mode 100644
index 0000000000..17a46cd49c
--- /dev/null
+++ b/resources/libraries/python/LispUtil.py
@@ -0,0 +1,257 @@
+# 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)