refactor test framework
[vpp.git] / test / test_vxlan.py
1 #!/usr/bin/env python
2
3 import unittest
4 from logging import *
5 from framework import VppTestCase, VppTestRunner
6 from template_bd import BridgeDomain
7
8 from scapy.layers.l2 import Ether
9 from scapy.layers.inet import IP, UDP
10 from scapy_handlers.vxlan import VXLAN
11
12
13 class TestVxlan(BridgeDomain, VppTestCase):
14     """ VXLAN Test Case """
15
16     def __init__(self, *args):
17         BridgeDomain.__init__(self)
18         VppTestCase.__init__(self, *args)
19
20     def encapsulate(self, pkt):
21         """
22         Encapsulate the original payload frame by adding VXLAN header with its
23         UDP, IP and Ethernet fields
24         """
25         return (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
26                 IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
27                 UDP(sport=self.dport, dport=self.dport, chksum=0) /
28                 VXLAN(vni=self.vni) /
29                 pkt)
30
31     def decapsulate(self, pkt):
32         """
33         Decapsulate the original payload frame by removing VXLAN header
34         """
35         return pkt[VXLAN].payload
36
37     # Method for checking VXLAN encapsulation.
38     #
39     def check_encapsulation(self, pkt):
40         # TODO: add error messages
41         # Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
42         #  by VPP using ARP.
43         self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
44         self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
45         # Verify VXLAN tunnel source IP is VPP_IP and destination IP is MY_IP.
46         self.assertEqual(pkt[IP].src, self.pg0.local_ip4)
47         self.assertEqual(pkt[IP].dst, self.pg0.remote_ip4)
48         # Verify UDP destination port is VXLAN 4789, source UDP port could be
49         #  arbitrary.
50         self.assertEqual(pkt[UDP].dport, type(self).dport)
51         # TODO: checksum check
52         # Verify VNI, based on configuration it must be 1.
53         self.assertEqual(pkt[VXLAN].vni, type(self).vni)
54
55     # Class method to start the VXLAN test case.
56     #  Overrides setUpClass method in VppTestCase class.
57     #  Python try..except statement is used to ensure that the tear down of
58     #  the class will be executed even if exception is raised.
59     #  @param cls The class pointer.
60     @classmethod
61     def setUpClass(cls):
62         super(TestVxlan, cls).setUpClass()
63
64         try:
65             cls.dport = 4789
66             cls.vni = 1
67
68             # Create 2 pg interfaces.
69             cls.create_pg_interfaces(range(2))
70             cls.pg0.admin_up()
71             cls.pg1.admin_up()
72
73             # Configure IPv4 addresses on VPP pg0.
74             cls.pg0.config_ip4()
75
76             # Resolve MAC address for VPP's IP address on pg0.
77             cls.pg0.resolve_arp()
78
79             # Create VXLAN VTEP on VPP pg0, and put vxlan_tunnel0 and pg1
80             #  into BD.
81             r = cls.vapi.vxlan_add_del_tunnel(
82                 src_addr=cls.pg0.local_ip4n,
83                 dst_addr=cls.pg0.remote_ip4n,
84                 vni=cls.vni)
85             cls.vapi.sw_interface_set_l2_bridge(r.sw_if_index, bd_id=1)
86             cls.vapi.sw_interface_set_l2_bridge(cls.pg1.sw_if_index, bd_id=1)
87         except Exception:
88             super(TestVxlan, cls).tearDownClass()
89             raise
90
91     # Method to define VPP actions before tear down of the test case.
92     #  Overrides tearDown method in VppTestCase class.
93     #  @param self The object pointer.
94     def tearDown(self):
95         super(TestVxlan, self).tearDown()
96         if not self.vpp_dead:
97             info(self.vapi.cli("show bridge-domain 1 detail"))
98
99 if __name__ == '__main__':
100     unittest.main(testRunner=VppTestRunner)