4 from util import ip4_range, ip4_range
6 from framework import VppTestCase, VppTestRunner
7 from template_bd import BridgeDomain
9 from scapy.layers.l2 import Ether
10 from scapy.layers.inet import IP, UDP
11 from scapy.contrib.geneve import GENEVE
12 from scapy.utils import atol
13 from vpp_ip_route import VppIpRoute, VppRoutePath
14 from vpp_ip import INVALID_INDEX
17 class TestGeneve(BridgeDomain, VppTestCase):
18 """ GENEVE Test Case """
20 def __init__(self, *args):
21 BridgeDomain.__init__(self)
22 VppTestCase.__init__(self, *args)
24 def encapsulate(self, pkt, vni):
27 Encapsulate the original payload frame by adding GENEVE header with its
28 UDP, IP and Ethernet fields
30 return (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
31 IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
32 UDP(sport=self.dport, dport=self.dport, chksum=0) /
36 def ip_range(self, start, end):
37 """ range of remote ip's """
38 return ip4_range(self.pg0.remote_ip4, start, end)
40 def encap_mcast(self, pkt, src_ip, src_mac, vni):
42 Encapsulate the original payload frame by adding GENEVE header with its
43 UDP, IP and Ethernet fields
45 return (Ether(src=src_mac, dst=self.mcast_mac) /
46 IP(src=src_ip, dst=self.mcast_ip4) /
47 UDP(sport=self.dport, dport=self.dport, chksum=0) /
51 def decapsulate(self, pkt):
53 Decapsulate the original payload frame by removing GENEVE header
55 # check if is set I flag
56 # self.assertEqual(pkt[GENEVE].flags, int('0x8', 16))
57 return pkt[GENEVE].payload
59 # Method for checking GENEVE encapsulation.
61 def check_encapsulation(self, pkt, vni, local_only=False, mcast_pkt=False):
62 # TODO: add error messages
63 # Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
65 self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
68 self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
70 self.assertEqual(pkt[Ether].dst, type(self).mcast_mac)
71 # Verify GENEVE tunnel source IP is VPP_IP and destination IP is MY_IP.
72 self.assertEqual(pkt[IP].src, self.pg0.local_ip4)
75 self.assertEqual(pkt[IP].dst, self.pg0.remote_ip4)
77 self.assertEqual(pkt[IP].dst, type(self).mcast_ip4)
78 # Verify UDP destination port is GENEVE 4789, source UDP port could be
80 self.assertEqual(pkt[UDP].dport, type(self).dport)
81 # TODO: checksum check
83 self.assertEqual(pkt[GENEVE].vni, vni)
86 def create_geneve_flood_test_bd(cls, vni, n_ucast_tunnels):
87 # Create 10 ucast geneve tunnels under bd
89 ip_range_end = ip_range_start + n_ucast_tunnels
90 next_hop_address = cls.pg0.remote_ip4
91 for dest_ip4 in ip4_range(next_hop_address, ip_range_start,
93 # add host route so dest_ip4 will not be resolved
94 rip = VppIpRoute(cls, dest_ip4, 32,
95 [VppRoutePath(next_hop_address,
99 r = cls.vapi.geneve_add_del_tunnel(
100 local_address=cls.pg0.local_ip4, remote_address=dest_ip4,
102 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
106 def add_del_shared_mcast_dst_load(cls, is_add):
108 add or del tunnels sharing the same mcast dst
109 to test geneve ref_count mechanism
111 n_shared_dst_tunnels = 10
113 vni_end = vni_start + n_shared_dst_tunnels
114 for vni in range(vni_start, vni_end):
115 r = cls.vapi.geneve_add_del_tunnel(
116 local_address=cls.pg0.local_ip4,
117 remote_address=cls.mcast_ip4, mcast_sw_if_index=1,
118 is_add=is_add, vni=vni)
119 if r.sw_if_index == 0xffffffff:
120 raise ValueError("bad sw_if_index: ~0")
123 def add_shared_mcast_dst_load(cls):
124 cls.add_del_shared_mcast_dst_load(is_add=1)
127 def del_shared_mcast_dst_load(cls):
128 cls.add_del_shared_mcast_dst_load(is_add=0)
131 def add_del_mcast_tunnels_load(cls, is_add):
133 add or del tunnels to test geneve stability
135 n_distinct_dst_tunnels = 10
137 ip_range_end = ip_range_start + n_distinct_dst_tunnels
138 for dest_ip4 in ip4_range(cls.mcast_ip4, ip_range_start,
140 vni = int(dest_ip4.split('.')[3])
141 cls.vapi.geneve_add_del_tunnel(local_address=cls.pg0.local_ip4,
142 remote_address=dest_ip4,
143 mcast_sw_if_index=1, is_add=is_add,
147 def add_mcast_tunnels_load(cls):
148 cls.add_del_mcast_tunnels_load(is_add=1)
151 def del_mcast_tunnels_load(cls):
152 cls.add_del_mcast_tunnels_load(is_add=0)
154 # Class method to start the GENEVE test case.
155 # Overrides setUpClass method in VppTestCase class.
156 # Python try..except statement is used to ensure that the tear down of
157 # the class will be executed even if exception is raised.
158 # @param cls The class pointer.
161 super(TestGeneve, cls).setUpClass()
166 # Create 2 pg interfaces.
167 cls.create_pg_interfaces(range(4))
168 for pg in cls.pg_interfaces:
171 # Configure IPv4 addresses on VPP pg0.
174 # Resolve MAC address for VPP's IP address on pg0.
175 cls.pg0.resolve_arp()
177 # Our Multicast address
178 cls.mcast_ip4 = '239.1.1.1'
179 iplong = atol(cls.mcast_ip4)
180 cls.mcast_mac = "01:00:5e:%02x:%02x:%02x" % (
181 (iplong >> 16) & 0x7F, (iplong >> 8) & 0xFF, iplong & 0xFF)
183 # Create GENEVE VTEP on VPP pg0, and put geneve_tunnel0 and pg1
185 cls.single_tunnel_vni = 0xabcde
186 cls.single_tunnel_bd = 1
187 r = cls.vapi.geneve_add_del_tunnel(
188 local_address=cls.pg0.local_ip4,
189 remote_address=cls.pg0.remote_ip4, vni=cls.single_tunnel_vni)
190 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
191 bd_id=cls.single_tunnel_bd)
192 cls.vapi.sw_interface_set_l2_bridge(
193 rx_sw_if_index=cls.pg1.sw_if_index, bd_id=cls.single_tunnel_bd)
195 # Setup vni 2 to test multicast flooding
196 cls.n_ucast_tunnels = 10
197 cls.mcast_flood_bd = 2
198 cls.create_geneve_flood_test_bd(cls.mcast_flood_bd,
200 r = cls.vapi.geneve_add_del_tunnel(
201 local_address=cls.pg0.local_ip4,
202 remote_address=cls.mcast_ip4, mcast_sw_if_index=1,
203 vni=cls.mcast_flood_bd)
204 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
205 bd_id=cls.mcast_flood_bd)
206 cls.vapi.sw_interface_set_l2_bridge(
207 rx_sw_if_index=cls.pg2.sw_if_index, bd_id=cls.mcast_flood_bd)
209 # Add and delete mcast tunnels to check stability
210 cls.add_shared_mcast_dst_load()
211 cls.add_mcast_tunnels_load()
212 cls.del_shared_mcast_dst_load()
213 cls.del_mcast_tunnels_load()
215 # Setup vni 3 to test unicast flooding
216 cls.ucast_flood_bd = 3
217 cls.create_geneve_flood_test_bd(cls.ucast_flood_bd,
219 cls.vapi.sw_interface_set_l2_bridge(
220 rx_sw_if_index=cls.pg3.sw_if_index, bd_id=cls.ucast_flood_bd)
222 super(TestGeneve, cls).tearDownClass()
225 # Method to define VPP actions before tear down of the test case.
226 # Overrides tearDown method in VppTestCase class.
227 # @param self The object pointer.
229 super(TestGeneve, self).tearDown()
231 def show_commands_at_teardown(self):
232 self.logger.info(self.vapi.cli("show bridge-domain 1 detail"))
233 self.logger.info(self.vapi.cli("show bridge-domain 2 detail"))
234 self.logger.info(self.vapi.cli("show bridge-domain 3 detail"))
235 self.logger.info(self.vapi.cli("show geneve tunnel"))
238 if __name__ == '__main__':
239 unittest.main(testRunner=VppTestRunner)