Update test documentation.
[vpp.git] / test / test_ip6.py
1 #!/usr/bin/env python
2
3 import unittest
4 import socket
5
6 from framework import VppTestCase, VppTestRunner
7 from vpp_sub_interface import VppSubInterface, VppDot1QSubint
8
9 from scapy.packet import Raw
10 from scapy.layers.l2 import Ether, Dot1Q
11 from scapy.layers.inet6 import IPv6, UDP
12
13
14 class TestIPv6(VppTestCase):
15     """ IPv6 Test Case """
16
17     @classmethod
18     def setUpClass(cls):
19         super(TestIPv6, cls).setUpClass()
20
21     def setUp(self):
22         """
23         Perform test setup before test case.
24
25         **Config:**
26             - create 3 pg interfaces
27                 - untagged pg0 interface
28                 - Dot1Q subinterface on pg1
29                 - Dot1AD subinterface on pg2
30             - setup interfaces:
31                 - put it into UP state
32                 - set IPv6 addresses
33                 - resolve neighbor address using NDP
34             - configure 200 fib entries
35
36         :ivar list interfaces: pg interfaces and subinterfaces.
37         :ivar dict flows: IPv4 packet flows in test.
38         :ivar list pg_if_packet_sizes: packet sizes in test.
39
40         *TODO:* Create AD sub interface
41         """
42         super(TestIPv6, self).setUp()
43
44         # create 3 pg interfaces
45         self.create_pg_interfaces(range(3))
46
47         # create 2 subinterfaces for p1 and pg2
48         self.sub_interfaces = [
49             VppDot1QSubint(self, self.pg1, 100),
50             VppDot1QSubint(self, self.pg2, 200)
51             # TODO: VppDot1ADSubint(self, self.pg2, 200, 300, 400)
52         ]
53
54         # packet flows mapping pg0 -> pg1.sub, pg2.sub, etc.
55         self.flows = dict()
56         self.flows[self.pg0] = [self.pg1.sub_if, self.pg2.sub_if]
57         self.flows[self.pg1.sub_if] = [self.pg0, self.pg2.sub_if]
58         self.flows[self.pg2.sub_if] = [self.pg0, self.pg1.sub_if]
59
60         # packet sizes
61         self.pg_if_packet_sizes = [64, 512, 1518, 9018]
62         self.sub_if_packet_sizes = [64, 512, 1518 + 4, 9018 + 4]
63
64         self.interfaces = list(self.pg_interfaces)
65         self.interfaces.extend(self.sub_interfaces)
66
67         # setup all interfaces
68         for i in self.interfaces:
69             i.admin_up()
70             i.config_ip6()
71             i.resolve_ndp()
72
73         # config 2M FIB entries
74         self.config_fib_entries(200)
75
76     def tearDown(self):
77         """Run standard test teardown and log ``show ip6 neighbors``."""
78         super(TestIPv6, self).tearDown()
79         if not self.vpp_dead:
80             self.logger.info(self.vapi.cli("show ip6 neighbors"))
81             # info(self.vapi.cli("show ip6 fib"))  # many entries
82
83     def config_fib_entries(self, count):
84         """For each interface add to the FIB table *count* routes to
85         "fd02::1/128" destination with interface's local address as next-hop
86         address.
87
88         :param int count: Number of FIB entries.
89
90         - *TODO:* check if the next-hop address shouldn't be remote address
91           instead of local address.
92         """
93         n_int = len(self.interfaces)
94         percent = 0
95         counter = 0.0
96         dest_addr = socket.inet_pton(socket.AF_INET6, "fd02::1")
97         dest_addr_len = 128
98         for i in self.interfaces:
99             next_hop_address = i.local_ip6n
100             for j in range(count / n_int):
101                 self.vapi.ip_add_del_route(
102                     dest_addr, dest_addr_len, next_hop_address, is_ipv6=1)
103                 counter += 1
104                 if counter / count * 100 > percent:
105                     self.logger.info("Configure %d FIB entries .. %d%% done" %
106                          (count, percent))
107                     percent += 1
108
109     def create_stream(self, src_if, packet_sizes):
110         """Create input packet stream for defined interface.
111
112         :param VppInterface src_if: Interface to create packet stream for.
113         :param list packet_sizes: Required packet sizes.
114         """
115         pkts = []
116         for i in range(0, 257):
117             dst_if = self.flows[src_if][i % 2]
118             info = self.create_packet_info(
119                 src_if.sw_if_index, dst_if.sw_if_index)
120             payload = self.info_to_payload(info)
121             p = (Ether(dst=src_if.local_mac, src=src_if.remote_mac) /
122                  IPv6(src=src_if.remote_ip6, dst=dst_if.remote_ip6) /
123                  UDP(sport=1234, dport=1234) /
124                  Raw(payload))
125             info.data = p.copy()
126             if isinstance(src_if, VppSubInterface):
127                 p = src_if.add_dot1_layer(p)
128             size = packet_sizes[(i // 2) % len(packet_sizes)]
129             self.extend_packet(p, size)
130             pkts.append(p)
131         return pkts
132
133     def verify_capture(self, dst_if, capture):
134         """Verify captured input packet stream for defined interface.
135
136         :param VppInterface dst_if: Interface to verify captured packet stream
137                                     for.
138         :param list capture: Captured packet stream.
139         """
140         self.logger.info("Verifying capture on interface %s" % dst_if.name)
141         last_info = dict()
142         for i in self.interfaces:
143             last_info[i.sw_if_index] = None
144         is_sub_if = False
145         dst_sw_if_index = dst_if.sw_if_index
146         if hasattr(dst_if, 'parent'):
147             is_sub_if = True
148         for packet in capture:
149             if is_sub_if:
150                 # Check VLAN tags and Ethernet header
151                 packet = dst_if.remove_dot1_layer(packet)
152             self.assertTrue(Dot1Q not in packet)
153             try:
154                 ip = packet[IPv6]
155                 udp = packet[UDP]
156                 payload_info = self.payload_to_info(str(packet[Raw]))
157                 packet_index = payload_info.index
158                 self.assertEqual(payload_info.dst, dst_sw_if_index)
159                 self.logger.debug("Got packet on port %s: src=%u (id=%u)" %
160                                   (dst_if.name, payload_info.src, packet_index))
161                 next_info = self.get_next_packet_info_for_interface2(
162                     payload_info.src, dst_sw_if_index,
163                     last_info[payload_info.src])
164                 last_info[payload_info.src] = next_info
165                 self.assertTrue(next_info is not None)
166                 self.assertEqual(packet_index, next_info.index)
167                 saved_packet = next_info.data
168                 # Check standard fields
169                 self.assertEqual(ip.src, saved_packet[IPv6].src)
170                 self.assertEqual(ip.dst, saved_packet[IPv6].dst)
171                 self.assertEqual(udp.sport, saved_packet[UDP].sport)
172                 self.assertEqual(udp.dport, saved_packet[UDP].dport)
173             except:
174                 self.logger.error("Unexpected or invalid packet:")
175                 self.logger.error(packet.show())
176                 raise
177         for i in self.interfaces:
178             remaining_packet = self.get_next_packet_info_for_interface2(
179                 i.sw_if_index, dst_sw_if_index, last_info[i.sw_if_index])
180             self.assertTrue(
181                 remaining_packet is None,
182                 "Interface %s: Packet expected from interface %s didn't arrive" %
183                 (dst_if.name, i.name))
184
185     def test_fib(self):
186         """ IPv6 FIB test
187
188         Test scenario:
189             - Create IPv6 stream for pg0 interface
190             - Create IPv6 tagged streams for pg1's and pg2's subinterface.
191             - Send and verify received packets on each interface.
192         """
193
194         pkts = self.create_stream(self.pg0, self.pg_if_packet_sizes)
195         self.pg0.add_stream(pkts)
196
197         for i in self.sub_interfaces:
198             pkts = self.create_stream(i, self.sub_if_packet_sizes)
199             i.parent.add_stream(pkts)
200
201         self.pg_enable_capture(self.pg_interfaces)
202         self.pg_start()
203
204         pkts = self.pg0.get_capture()
205         self.verify_capture(self.pg0, pkts)
206
207         for i in self.sub_interfaces:
208             pkts = i.parent.get_capture()
209             self.verify_capture(i, pkts)
210
211
212 if __name__ == '__main__':
213     unittest.main(testRunner=VppTestRunner)