vxlan: vxlan/vxlan.api API cleanup
[vpp.git] / test / test_vxlan6.py
1 #!/usr/bin/env python3
2
3 import socket
4 import unittest
5 from framework import VppTestCase, VppTestRunner
6 from template_bd import BridgeDomain
7
8 from scapy.layers.l2 import Ether
9 from scapy.layers.inet6 import IPv6, UDP
10 from scapy.layers.vxlan import VXLAN
11 from scapy.utils import atol
12 from vpp_ip_route import VppIpRoute, VppRoutePath
13 from vpp_vxlan_tunnel import VppVxlanTunnel
14 from vpp_ip import INVALID_INDEX
15
16
17 class TestVxlan6(BridgeDomain, VppTestCase):
18     """ VXLAN over IPv6 Test Case """
19
20     def __init__(self, *args):
21         BridgeDomain.__init__(self)
22         VppTestCase.__init__(self, *args)
23
24     def encapsulate(self, pkt, vni):
25         """
26         Encapsulate the original payload frame by adding VXLAN header with its
27         UDP, IP and Ethernet fields
28         """
29         return (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
30                 IPv6(src=self.pg0.remote_ip6, dst=self.pg0.local_ip6) /
31                 UDP(sport=self.dport, dport=self.dport, chksum=0) /
32                 VXLAN(vni=vni, flags=self.flags) /
33                 pkt)
34
35     @classmethod
36     def ip_range(cls, s, e):
37         """ range of remote ip's """
38         tmp = cls.pg0.remote_ip6.rsplit(':', 1)[0]
39         return ("%s:%x" % (tmp, i) for i in range(s, e))
40
41     def encap_mcast(self, pkt, src_ip, src_mac, vni):
42         """
43         Encapsulate the original payload frame by adding VXLAN header with its
44         UDP, IP and Ethernet fields
45         """
46         return (Ether(src=src_mac, dst=self.mcast_mac) /
47                 IPv6(src=src_ip, dst=self.mcast_ip6) /
48                 UDP(sport=self.dport, dport=self.dport, chksum=0) /
49                 VXLAN(vni=vni, flags=self.flags) /
50                 pkt)
51
52     def decapsulate(self, pkt):
53         """
54         Decapsulate the original payload frame by removing VXLAN header
55         """
56         # check if is set I flag
57         self.assertEqual(pkt[VXLAN].flags, int('0x8', 16))
58         return pkt[VXLAN].payload
59
60     # Method for checking VXLAN encapsulation.
61     #
62     def check_encapsulation(self, pkt, vni, local_only=False, mcast_pkt=False):
63         # TODO: add error messages
64         # Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
65         #  by VPP using ARP.
66         self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
67         if not local_only:
68             if not mcast_pkt:
69                 self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
70             else:
71                 self.assertEqual(pkt[Ether].dst, type(self).mcast_mac)
72         # Verify VXLAN tunnel source IP is VPP_IP and destination IP is MY_IP.
73         self.assertEqual(pkt[IPv6].src, self.pg0.local_ip6)
74         if not local_only:
75             if not mcast_pkt:
76                 self.assertEqual(pkt[IPv6].dst, self.pg0.remote_ip6)
77             else:
78                 self.assertEqual(pkt[IPv6].dst, type(self).mcast_ip6)
79         # Verify UDP destination port is VXLAN 4789, source UDP port could be
80         #  arbitrary.
81         self.assertEqual(pkt[UDP].dport, type(self).dport)
82         # TODO: checksum check
83         # Verify VNI
84         self.assertEqual(pkt[VXLAN].vni, vni)
85
86     @classmethod
87     def create_vxlan_flood_test_bd(cls, vni, n_ucast_tunnels):
88         # Create 10 ucast vxlan tunnels under bd
89         start = 10
90         end = start + n_ucast_tunnels
91         for dest_ip6 in cls.ip_range(start, end):
92             # add host route so dest ip will not be resolved
93             rip = VppIpRoute(cls, dest_ip6, 128,
94                              [VppRoutePath(cls.pg0.remote_ip6, INVALID_INDEX)],
95                              register=False)
96             rip.add_vpp_config()
97             r = VppVxlanTunnel(cls, src=cls.pg0.local_ip6,
98                                dst=dest_ip6, vni=vni)
99             r.add_vpp_config()
100             cls.vapi.sw_interface_set_l2_bridge(r.sw_if_index, bd_id=vni)
101
102     @classmethod
103     def add_mcast_tunnels_load(cls):
104         cls.add_del_mcast_tunnels_load(is_add=1)
105
106     @classmethod
107     def del_mcast_tunnels_load(cls):
108         cls.add_del_mcast_tunnels_load(is_add=0)
109
110     # Class method to start the VXLAN test case.
111     #  Overrides setUpClass method in VppTestCase class.
112     #  Python try..except statement is used to ensure that the tear down of
113     #  the class will be executed even if exception is raised.
114     #  @param cls The class pointer.
115     @classmethod
116     def setUpClass(cls):
117         super(TestVxlan6, cls).setUpClass()
118
119         try:
120             cls.dport = 4789
121             cls.flags = 0x8
122
123             # Create 2 pg interfaces.
124             cls.create_pg_interfaces(range(4))
125             for pg in cls.pg_interfaces:
126                 pg.admin_up()
127
128             # Configure IPv4 addresses on VPP pg0.
129             cls.pg0.config_ip6()
130
131             # Resolve MAC address for VPP's IP address on pg0.
132             cls.pg0.resolve_ndp()
133
134             cls.mcast_ip6 = 'ff0e::1'
135             cls.mcast_ip6n = socket.inet_pton(socket.AF_INET6, cls.mcast_ip6)
136             cls.mcast_mac = "33:33:00:00:00:%02x" % (1)
137
138         except Exception:
139             super(TestVxlan6, cls).tearDownClass()
140             raise
141
142     @classmethod
143     def tearDownClass(cls):
144         super(TestVxlan6, cls).tearDownClass()
145
146     def setUp(self):
147         super(TestVxlan6, self).setUp()
148         # Create VXLAN VTEP on VPP pg0, and put vxlan_tunnel0 and pg1
149         #  into BD.
150         self.single_tunnel_bd = 1
151         r = VppVxlanTunnel(self, src=self.pg0.local_ip6,
152                            dst=self.pg0.remote_ip6, vni=self.single_tunnel_bd)
153         r.add_vpp_config()
154         self.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
155                                              bd_id=self.single_tunnel_bd)
156         self.vapi.sw_interface_set_l2_bridge(
157             rx_sw_if_index=self.pg1.sw_if_index, bd_id=self.single_tunnel_bd)
158
159         # Setup vni 2 to test multicast flooding
160         self.n_ucast_tunnels = 10
161         self.mcast_flood_bd = 2
162         self.create_vxlan_flood_test_bd(self.mcast_flood_bd,
163                                         self.n_ucast_tunnels)
164         r = VppVxlanTunnel(self, src=self.pg0.local_ip6, dst=self.mcast_ip6,
165                            mcast_sw_if_index=1, vni=self.mcast_flood_bd)
166         r.add_vpp_config()
167         self.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
168                                              bd_id=self.mcast_flood_bd)
169         self.vapi.sw_interface_set_l2_bridge(
170             rx_sw_if_index=self.pg2.sw_if_index, bd_id=self.mcast_flood_bd)
171
172         # Setup vni 3 to test unicast flooding
173         self.ucast_flood_bd = 3
174         self.create_vxlan_flood_test_bd(self.ucast_flood_bd,
175                                         self.n_ucast_tunnels)
176         self.vapi.sw_interface_set_l2_bridge(
177             rx_sw_if_index=self.pg3.sw_if_index, bd_id=self.ucast_flood_bd)
178
179     # Method to define VPP actions before tear down of the test case.
180     #  Overrides tearDown method in VppTestCase class.
181     #  @param self The object pointer.
182     def tearDown(self):
183         super(TestVxlan6, self).tearDown()
184
185     def show_commands_at_teardown(self):
186         self.logger.info(self.vapi.cli("show bridge-domain 1 detail"))
187         self.logger.info(self.vapi.cli("show bridge-domain 2 detail"))
188         self.logger.info(self.vapi.cli("show bridge-domain 3 detail"))
189         self.logger.info(self.vapi.cli("show vxlan tunnel"))
190
191
192 if __name__ == '__main__':
193     unittest.main(testRunner=VppTestRunner)