src/plugins/lisp/test/test_lisp.py

   1 #!/usr/bin/env python3
   2
   3 import abc
   4 import unittest
   5
   6 from scapy.fields import BitField, ByteField, FlagsField, IntField
   7 from scapy.packet import bind_layers, Packet, Raw
   8 from scapy.layers.inet import IP, UDP, Ether
   9 from scapy.layers.inet6 import IPv6
  10
  11 from framework import VppTestCase, VppTestRunner
  12 from lisp import VppLocalMapping, VppLispAdjacency, VppLispLocator, \
  13     VppLispLocatorSet, VppRemoteMapping, LispRemoteLocator
  14 from util import ppp, ForeignAddressFactory
  15
  16 # From py_lispnetworking.lisp.py:  # GNU General Public License v2.0
  17
  18
  19 class LISP_GPE_Header(Packet):
  20     name = "LISP GPE Header"
  21     fields_desc = [
  22         FlagsField("gpe_flags", None, 6, ["N", "L", "E", "V", "I", "P"]),
  23         BitField("reserved", 0, 18),
  24         ByteField("next_proto", 0),
  25         IntField("iid", 0),
  26     ]
  27 bind_layers(UDP, LISP_GPE_Header, dport=4341)
  28 bind_layers(UDP, LISP_GPE_Header, sport=4341)
  29 bind_layers(LISP_GPE_Header, IP, next_proto=1)
  30 bind_layers(LISP_GPE_Header, IPv6, next_proto=2)
  31 bind_layers(LISP_GPE_Header, Ether, next_proto=3)
  32
  33
  34 class Driver(metaclass=abc.ABCMeta):
  35
  36     config_order = ['locator-sets',
  37                     'locators',
  38                     'local-mappings',
  39                     'remote-mappings',
  40                     'adjacencies']
  41
  42     """ Basic class for data driven testing """
  43     def __init__(self, test, test_cases):
  44         self._test_cases = test_cases
  45         self._test = test
  46
  47     @property
  48     def test_cases(self):
  49         return self._test_cases
  50
  51     @property
  52     def test(self):
  53         return self._test
  54
  55     def create_packet(self, src_if, dst_if, deid, payload=''):
  56         """
  57         Create IPv4 packet
  58
  59         param: src_if
  60         param: dst_if
  61         """
  62         packet = (Ether(dst=src_if.local_mac, src=src_if.remote_mac) /
  63                   IP(src=src_if.remote_ip4, dst=deid) /
  64                   Raw(payload))
  65         return packet
  66
  67     @abc.abstractmethod
  68     def run(self):
  69         """ testing procedure """
  70         pass
  71
  72
  73 class SimpleDriver(Driver):
  74     """ Implements simple test procedure """
  75     def __init__(self, test, test_cases):
  76         super(SimpleDriver, self).__init__(test, test_cases)
  77
  78     def verify_capture(self, src_loc, dst_loc, capture):
  79         """
  80         Verify captured packet
  81
  82         :param src_loc: source locator address
  83         :param dst_loc: destination locator address
  84         :param capture: list of captured packets
  85         """
  86         self.test.assertEqual(len(capture), 1, "Unexpected number of "
  87                               "packets! Expected 1 but {} received"
  88                               .format(len(capture)))
  89         packet = capture[0]
  90         try:
  91             ip_hdr = packet[IP]
  92             # assert the values match
  93             self.test.assertEqual(ip_hdr.src, src_loc, "IP source address")
  94             self.test.assertEqual(ip_hdr.dst, dst_loc,
  95                                   "IP destination address")
  96             gpe_hdr = packet[LISP_GPE_Header]
  97             self.test.assertEqual(gpe_hdr.next_proto, 1,
  98                                   "next_proto is not ipv4!")
  99             ih = gpe_hdr[IP]
 100             self.test.assertEqual(ih.src, self.test.pg0.remote_ip4,
 101                                   "unexpected source EID!")
 102             self.test.assertEqual(ih.dst, self.test.deid_ip4,
 103                                   "unexpected dest EID!")
 104         except:
 105             self.test.logger.error(ppp("Unexpected or invalid packet:",
 106                                    packet))
 107             raise
 108
 109     def configure_tc(self, tc):
 110         for config_item in self.config_order:
 111             for vpp_object in tc[config_item]:
 112                 vpp_object.add_vpp_config()
 113
 114     def run(self, dest):
 115         """ Send traffic for each test case and verify that it
 116             is encapsulated """
 117         for tc in enumerate(self.test_cases):
 118             self.test.logger.info('Running {}'.format(tc[1]['name']))
 119             self.configure_tc(tc[1])
 120
 121             packet = self.create_packet(self.test.pg0, self.test.pg1, dest,
 122                                         'data')
 123             self.test.pg0.add_stream(packet)
 124             self.test.pg0.enable_capture()
 125             self.test.pg1.enable_capture()
 126             self.test.pg_start()
 127             capture = self.test.pg1.get_capture(1)
 128             self.verify_capture(self.test.pg1.local_ip4,
 129                                 self.test.pg1.remote_ip4, capture)
 130             self.test.pg0.assert_nothing_captured()
 131
 132
 133 class TestLisp(VppTestCase):
 134     """ Basic LISP test """
 135
 136     @classmethod
 137     def setUpClass(cls):
 138         super(TestLisp, cls).setUpClass()
 139         cls.faf = ForeignAddressFactory()
 140         cls.create_pg_interfaces(range(2))  # create pg0 and pg1
 141         for i in cls.pg_interfaces:
 142             i.admin_up()  # put the interface upsrc_if
 143             i.config_ip4()  # configure IPv4 address on the interface
 144             i.resolve_arp()  # resolve ARP, so that we know VPP MAC
 145
 146     @classmethod
 147     def tearDownClass(cls):
 148         super(TestLisp, cls).tearDownClass()
 149
 150     def setUp(self):
 151         super(TestLisp, self).setUp()
 152         self.vapi.lisp_enable_disable(is_enable=1)
 153
 154     def test_lisp_basic_encap(self):
 155         """Test case for basic encapsulation"""
 156
 157         self.deid_ip4_net = self.faf.net
 158         self.deid_ip4 = self.faf.get_ip4()
 159         self.seid_ip4 = '{!s}/{!s}'.format(self.pg0.local_ip4, 32)
 160         self.rloc_ip4 = self.pg1.remote_ip4
 161
 162         test_cases = [
 163             {
 164                 'name': 'basic ip4 over ip4',
 165                 'locator-sets': [VppLispLocatorSet(self, 'ls-4o4')],
 166                 'locators': [
 167                     VppLispLocator(self, self.pg1.sw_if_index, 'ls-4o4')
 168                 ],
 169                 'local-mappings': [
 170                     VppLocalMapping(self, self.seid_ip4, 'ls-4o4')
 171                 ],
 172                 'remote-mappings': [
 173                     VppRemoteMapping(self, self.deid_ip4_net,
 174                                      [LispRemoteLocator(self.rloc_ip4)])
 175                 ],
 176                 'adjacencies': [
 177                     VppLispAdjacency(self, self.seid_ip4, self.deid_ip4_net)
 178                 ]
 179             }
 180         ]
 181         self.test_driver = SimpleDriver(self, test_cases)
 182         self.test_driver.run(self.deid_ip4)
 183
 184
 185 class TestLispUT(VppTestCase):
 186     """ Lisp UT """
 187
 188     @classmethod
 189     def setUpClass(cls):
 190         super(TestLispUT, cls).setUpClass()
 191
 192     @classmethod
 193     def tearDownClass(cls):
 194         super(TestLispUT, cls).tearDownClass()
 195
 196     def test_fib(self):
 197         """ LISP Unit Tests """
 198         error = self.vapi.cli("test lisp cp")
 199
 200         if error:
 201             self.logger.critical(error)
 202         self.assertNotIn("Failed", error)
 203
 204
 205 if __name__ == '__main__':
 206     unittest.main(testRunner=VppTestRunner)