6 from framework import VppTestCase, VppTestRunner
7 from vpp_sub_interface import VppSubInterface, VppDot1QSubint, VppDot1ADSubint
9 from scapy.packet import Raw
10 from scapy.layers.l2 import Ether, Dot1Q
11 from scapy.layers.inet import IP, UDP
15 class TestIPv4(VppTestCase):
16 """ IPv4 Test Case """
20 Perform test setup before test case.
23 - create 3 pg interfaces
24 - untagged pg0 interface
25 - Dot1Q subinterface on pg1
26 - Dot1AD subinterface on pg2
28 - put it into UP state
30 - resolve neighbor address using ARP
31 - configure 200 fib entries
33 :ivar list interfaces: pg interfaces and subinterfaces.
34 :ivar dict flows: IPv4 packet flows in test.
35 :ivar list pg_if_packet_sizes: packet sizes in test.
37 super(TestIPv4, self).setUp()
39 # create 3 pg interfaces
40 self.create_pg_interfaces(range(3))
42 # create 2 subinterfaces for pg1 and pg2
43 self.sub_interfaces = [
44 VppDot1QSubint(self, self.pg1, 100),
45 VppDot1ADSubint(self, self.pg2, 200, 300, 400)]
47 # packet flows mapping pg0 -> pg1.sub, pg2.sub, etc.
49 self.flows[self.pg0] = [self.pg1.sub_if, self.pg2.sub_if]
50 self.flows[self.pg1.sub_if] = [self.pg0, self.pg2.sub_if]
51 self.flows[self.pg2.sub_if] = [self.pg0, self.pg1.sub_if]
54 self.pg_if_packet_sizes = [64, 512, 1518, 9018]
55 self.sub_if_packet_sizes = [64, 512, 1518 + 4, 9018 + 4]
57 self.interfaces = list(self.pg_interfaces)
58 self.interfaces.extend(self.sub_interfaces)
60 # setup all interfaces
61 for i in self.interfaces:
66 # config 2M FIB entries
67 self.config_fib_entries(200)
70 """Run standard test teardown and log ``show ip arp``."""
71 super(TestIPv4, self).tearDown()
73 self.logger.info(self.vapi.cli("show ip arp"))
74 # info(self.vapi.cli("show ip fib")) # many entries
76 def config_fib_entries(self, count):
77 """For each interface add to the FIB table *count* routes to
78 "10.0.0.1/32" destination with interface's local address as next-hop
81 :param int count: Number of FIB entries.
83 - *TODO:* check if the next-hop address shouldn't be remote address
84 instead of local address.
86 n_int = len(self.interfaces)
89 dest_addr = socket.inet_pton(socket.AF_INET, "10.0.0.1")
91 for i in self.interfaces:
92 next_hop_address = i.local_ip4n
93 for j in range(count / n_int):
94 self.vapi.ip_add_del_route(
95 dest_addr, dest_addr_len, next_hop_address)
97 if counter / count * 100 > percent:
98 self.logger.info("Configure %d FIB entries .. %d%% done" %
102 def create_stream(self, src_if, packet_sizes):
103 """Create input packet stream for defined interface.
105 :param VppInterface src_if: Interface to create packet stream for.
106 :param list packet_sizes: Required packet sizes.
109 for i in range(0, 257):
110 dst_if = self.flows[src_if][i % 2]
111 info = self.create_packet_info(src_if, dst_if)
112 payload = self.info_to_payload(info)
113 p = (Ether(dst=src_if.local_mac, src=src_if.remote_mac) /
114 IP(src=src_if.remote_ip4, dst=dst_if.remote_ip4) /
115 UDP(sport=1234, dport=1234) /
118 if isinstance(src_if, VppSubInterface):
119 p = src_if.add_dot1_layer(p)
120 size = packet_sizes[(i // 2) % len(packet_sizes)]
121 self.extend_packet(p, size)
125 def verify_capture(self, dst_if, capture):
126 """Verify captured input packet stream for defined interface.
128 :param VppInterface dst_if: Interface to verify captured packet stream
130 :param list capture: Captured packet stream.
132 self.logger.info("Verifying capture on interface %s" % dst_if.name)
134 for i in self.interfaces:
135 last_info[i.sw_if_index] = None
137 dst_sw_if_index = dst_if.sw_if_index
138 if hasattr(dst_if, 'parent'):
140 for packet in capture:
142 # Check VLAN tags and Ethernet header
143 packet = dst_if.remove_dot1_layer(packet)
144 self.assertTrue(Dot1Q not in packet)
148 payload_info = self.payload_to_info(str(packet[Raw]))
149 packet_index = payload_info.index
150 self.assertEqual(payload_info.dst, dst_sw_if_index)
152 "Got packet on port %s: src=%u (id=%u)" %
153 (dst_if.name, payload_info.src, packet_index))
154 next_info = self.get_next_packet_info_for_interface2(
155 payload_info.src, dst_sw_if_index,
156 last_info[payload_info.src])
157 last_info[payload_info.src] = next_info
158 self.assertTrue(next_info is not None)
159 self.assertEqual(packet_index, next_info.index)
160 saved_packet = next_info.data
161 # Check standard fields
162 self.assertEqual(ip.src, saved_packet[IP].src)
163 self.assertEqual(ip.dst, saved_packet[IP].dst)
164 self.assertEqual(udp.sport, saved_packet[UDP].sport)
165 self.assertEqual(udp.dport, saved_packet[UDP].dport)
167 self.logger.error(ppp("Unexpected or invalid packet:", packet))
169 for i in self.interfaces:
170 remaining_packet = self.get_next_packet_info_for_interface2(
171 i.sw_if_index, dst_sw_if_index, last_info[i.sw_if_index])
172 self.assertTrue(remaining_packet is None,
173 "Interface %s: Packet expected from interface %s "
174 "didn't arrive" % (dst_if.name, i.name))
181 - Create IPv4 stream for pg0 interface
182 - Create IPv4 tagged streams for pg1's and pg2's subinterface.
183 - Send and verify received packets on each interface.
186 pkts = self.create_stream(self.pg0, self.pg_if_packet_sizes)
187 self.pg0.add_stream(pkts)
189 for i in self.sub_interfaces:
190 pkts = self.create_stream(i, self.sub_if_packet_sizes)
191 i.parent.add_stream(pkts)
193 self.pg_enable_capture(self.pg_interfaces)
196 pkts = self.pg0.get_capture()
197 self.verify_capture(self.pg0, pkts)
199 for i in self.sub_interfaces:
200 pkts = i.parent.get_capture()
201 self.verify_capture(i, pkts)
204 class TestIPv4FibCrud(VppTestCase):
205 """ FIB - add/update/delete - ip4 routes
213 ..note:: Python API is too slow to add many routes, needs replacement.
216 def config_fib_many_to_one(self, start_dest_addr, next_hop_addr, count):
219 :param start_dest_addr:
220 :param next_hop_addr:
222 :return list: added ips with 32 prefix
225 dest_addr = int(socket.inet_pton(socket.AF_INET,
226 start_dest_addr).encode('hex'),
229 n_next_hop_addr = socket.inet_pton(socket.AF_INET, next_hop_addr)
230 for _ in range(count):
231 n_dest_addr = '{:08x}'.format(dest_addr).decode('hex')
232 self.vapi.ip_add_del_route(n_dest_addr, dest_addr_len,
234 added_ips.append(socket.inet_ntoa(n_dest_addr))
238 def unconfig_fib_many_to_one(self, start_dest_addr, next_hop_addr, count):
241 dest_addr = int(socket.inet_pton(socket.AF_INET,
242 start_dest_addr).encode('hex'),
245 n_next_hop_addr = socket.inet_pton(socket.AF_INET, next_hop_addr)
246 for _ in range(count):
247 n_dest_addr = '{:08x}'.format(dest_addr).decode('hex')
248 self.vapi.ip_add_del_route(n_dest_addr, dest_addr_len,
249 n_next_hop_addr, is_add=0)
250 removed_ips.append(socket.inet_ntoa(n_dest_addr))
254 def create_stream(self, src_if, dst_if, dst_ips, count):
257 for _ in range(count):
258 dst_addr = random.choice(dst_ips)
259 info = self.create_packet_info(src_if, dst_if)
260 payload = self.info_to_payload(info)
261 p = (Ether(dst=src_if.local_mac, src=src_if.remote_mac) /
262 IP(src=src_if.remote_ip4, dst=dst_addr) /
263 UDP(sport=1234, dport=1234) /
266 self.extend_packet(p, random.choice(self.pg_if_packet_sizes))
271 def _find_ip_match(self, find_in, pkt):
273 if self.payload_to_info(str(p[Raw])) == \
274 self.payload_to_info(str(pkt[Raw])):
275 if p[IP].src != pkt[IP].src:
277 if p[IP].dst != pkt[IP].dst:
279 if p[UDP].sport != pkt[UDP].sport:
281 if p[UDP].dport != pkt[UDP].dport:
287 def _match_route_detail(route_detail, ip, address_length=32, table_id=0):
288 if route_detail.address == socket.inet_pton(socket.AF_INET, ip):
289 if route_detail.table_id != table_id:
291 elif route_detail.address_length != address_length:
298 def verify_capture(self, dst_interface, received_pkts, expected_pkts):
299 self.assertEqual(len(received_pkts), len(expected_pkts))
300 to_verify = list(expected_pkts)
301 for p in received_pkts:
302 self.assertEqual(p.src, dst_interface.local_mac)
303 self.assertEqual(p.dst, dst_interface.remote_mac)
304 x = self._find_ip_match(to_verify, p)
306 self.assertListEqual(to_verify, [])
308 def verify_route_dump(self, fib_dump, ips):
310 def _ip_in_route_dump(ip, fib_dump):
311 return next((route for route in fib_dump
312 if self._match_route_detail(route, ip)),
316 self.assertTrue(_ip_in_route_dump(ip, fib_dump),
317 'IP {} is not in fib dump.'.format(ip))
319 def verify_not_in_route_dump(self, fib_dump, ips):
321 def _ip_in_route_dump(ip, fib_dump):
322 return next((route for route in fib_dump
323 if self._match_route_detail(route, ip)),
327 self.assertFalse(_ip_in_route_dump(ip, fib_dump),
328 'IP {} is in fib dump.'.format(ip))
333 #. Create and initialize 3 pg interfaces.
334 #. initialize class attributes configured_routes and deleted_routes
335 to store information between tests.
337 super(TestIPv4FibCrud, cls).setUpClass()
340 # create 3 pg interfaces
341 cls.create_pg_interfaces(range(3))
343 cls.interfaces = list(cls.pg_interfaces)
345 # setup all interfaces
346 for i in cls.interfaces:
351 cls.configured_routes = []
352 cls.deleted_routes = []
353 cls.pg_if_packet_sizes = [64, 512, 1518, 9018]
356 super(TestIPv4FibCrud, cls).tearDownClass()
360 super(TestIPv4FibCrud, self).setUp()
361 self.reset_packet_infos()
363 def test_1_add_routes(self):
366 - add 100 routes check with traffic script.
368 # config 1M FIB entries
369 self.configured_routes.extend(self.config_fib_many_to_one(
370 "10.0.0.0", self.pg0.remote_ip4, 100))
372 fib_dump = self.vapi.ip_fib_dump()
373 self.verify_route_dump(fib_dump, self.configured_routes)
375 self.stream_1 = self.create_stream(
376 self.pg1, self.pg0, self.configured_routes, 100)
377 self.stream_2 = self.create_stream(
378 self.pg2, self.pg0, self.configured_routes, 100)
379 self.pg1.add_stream(self.stream_1)
380 self.pg2.add_stream(self.stream_2)
382 self.pg_enable_capture(self.pg_interfaces)
385 pkts = self.pg0.get_capture(len(self.stream_1) + len(self.stream_2))
386 self.verify_capture(self.pg0, pkts, self.stream_1 + self.stream_2)
388 def test_2_del_routes(self):
389 """ Delete 100 routes
391 - delete 10 routes check with traffic script.
393 self.deleted_routes.extend(self.unconfig_fib_many_to_one(
394 "10.0.0.10", self.pg0.remote_ip4, 10))
395 for x in self.deleted_routes:
396 self.configured_routes.remove(x)
398 fib_dump = self.vapi.ip_fib_dump()
399 self.verify_route_dump(fib_dump, self.configured_routes)
401 self.stream_1 = self.create_stream(
402 self.pg1, self.pg0, self.configured_routes, 100)
403 self.stream_2 = self.create_stream(
404 self.pg2, self.pg0, self.configured_routes, 100)
405 self.stream_3 = self.create_stream(
406 self.pg1, self.pg0, self.deleted_routes, 100)
407 self.stream_4 = self.create_stream(
408 self.pg2, self.pg0, self.deleted_routes, 100)
409 self.pg1.add_stream(self.stream_1 + self.stream_3)
410 self.pg2.add_stream(self.stream_2 + self.stream_4)
411 self.pg_enable_capture(self.pg_interfaces)
414 pkts = self.pg0.get_capture(len(self.stream_1) + len(self.stream_2))
415 self.verify_capture(self.pg0, pkts, self.stream_1 + self.stream_2)
417 def test_3_add_new_routes(self):
420 - re-add 5 routes check with traffic script.
421 - add 100 routes check with traffic script.
423 tmp = self.config_fib_many_to_one(
424 "10.0.0.10", self.pg0.remote_ip4, 5)
425 self.configured_routes.extend(tmp)
427 self.deleted_routes.remove(x)
429 self.configured_routes.extend(self.config_fib_many_to_one(
430 "10.0.1.0", self.pg0.remote_ip4, 100))
432 fib_dump = self.vapi.ip_fib_dump()
433 self.verify_route_dump(fib_dump, self.configured_routes)
435 self.stream_1 = self.create_stream(
436 self.pg1, self.pg0, self.configured_routes, 300)
437 self.stream_2 = self.create_stream(
438 self.pg2, self.pg0, self.configured_routes, 300)
439 self.stream_3 = self.create_stream(
440 self.pg1, self.pg0, self.deleted_routes, 100)
441 self.stream_4 = self.create_stream(
442 self.pg2, self.pg0, self.deleted_routes, 100)
444 self.pg1.add_stream(self.stream_1 + self.stream_3)
445 self.pg2.add_stream(self.stream_2 + self.stream_4)
446 self.pg_enable_capture(self.pg_interfaces)
449 pkts = self.pg0.get_capture(len(self.stream_1) + len(self.stream_2))
450 self.verify_capture(self.pg0, pkts, self.stream_1 + self.stream_2)
452 def test_4_del_routes(self):
453 """ Delete 1.5k routes
455 - delete 5 routes check with traffic script.
456 - add 100 routes check with traffic script.
458 self.deleted_routes.extend(self.unconfig_fib_many_to_one(
459 "10.0.0.0", self.pg0.remote_ip4, 15))
460 self.deleted_routes.extend(self.unconfig_fib_many_to_one(
461 "10.0.0.20", self.pg0.remote_ip4, 85))
462 self.deleted_routes.extend(self.unconfig_fib_many_to_one(
463 "10.0.1.0", self.pg0.remote_ip4, 100))
464 fib_dump = self.vapi.ip_fib_dump()
465 self.verify_not_in_route_dump(fib_dump, self.deleted_routes)
468 if __name__ == '__main__':
469 unittest.main(testRunner=VppTestRunner)