6 from framework import VppTestCase, VppTestRunner, running_extended_tests
9 from scapy.packet import Raw
10 from scapy.layers.l2 import Ether
11 from scapy.layers.inet import IP
12 from scapy.contrib.igmpv3 import *
13 from scapy.contrib.igmp import *
27 class TestIgmp(VppTestCase):
28 """ IGMP Test Case """
31 super(TestIgmp, self).setUp()
33 self.create_pg_interfaces(range(2))
38 for pg in self.pg_interfaces:
44 for pg in self.pg_interfaces:
45 self.vapi.igmp_clear_interface(pg.sw_if_index)
48 super(TestIgmp, self).tearDown()
50 def send(self, ti, pkts):
52 self.pg_enable_capture(self.pg_interfaces)
55 @unittest.skipUnless(checkIGMPv3(), "missing scapy igmpv3 implementation")
56 def test_igmp_parse_report(self):
57 """ IGMP parse Membership Report """
60 # VPP acts as a router
62 self.vapi.want_igmp_events(1)
64 # hos sends join IGMP 'join'
65 p_join = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
66 IP(src=self.pg0.remote_ip4, dst='224.0.0.22', tos=0xc0) /
69 IGMPv3gr(rtype=3, maddr="224.1.1.1", srcaddrs=["10.1.1.1"]))
71 self.send(self.pg0, p_join)
73 # search for the corresponding state created in VPP
74 dump = self.vapi.igmp_dump()
75 self.assertEqual(len(dump), 1)
76 self.assertEqual(dump[0].sw_if_index, self.pg0.sw_if_index)
77 self.assertEqual(dump[0].gaddr,
78 socket.inet_pton(socket.AF_INET,
80 self.assertEqual(dump[0].saddr,
81 socket.inet_pton(socket.AF_INET,
84 # VPP sends a notification that a new group has been joined
85 ev = self.vapi.wait_for_event(2, "igmp_event")
87 self.assertEqual(ev.saddr,
88 socket.inet_pton(socket.AF_INET,
90 self.assertEqual(ev.gaddr,
91 socket.inet_pton(socket.AF_INET,
93 self.assertEqual(ev.is_join, 1)
95 # host sends IGMP leave
96 p_leave = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
97 IP(src=self.pg0.remote_ip4, dst='224.0.0.22', tos=0xc0) /
100 IGMPv3gr(rtype=4, maddr="224.1.1.1", srcaddrs=["10.1.1.1"]))
102 self.send(self.pg0, p_leave)
104 # VPP sends a notification that a new group has been left
105 ev = self.vapi.wait_for_event(2, "igmp_event")
107 self.assertEqual(ev.saddr,
108 socket.inet_pton(socket.AF_INET,
110 self.assertEqual(ev.gaddr,
111 socket.inet_pton(socket.AF_INET,
113 self.assertEqual(ev.is_join, 0)
116 dump = self.vapi.igmp_dump()
117 self.assertFalse(dump)
120 self.send(self.pg0, p_join)
121 dump = self.vapi.igmp_dump()
122 self.assertEqual(len(dump), 1)
123 self.assertEqual(dump[0].sw_if_index, self.pg0.sw_if_index)
124 self.assertEqual(dump[0].gaddr,
125 socket.inet_pton(socket.AF_INET,
127 self.assertEqual(dump[0].saddr,
128 socket.inet_pton(socket.AF_INET,
132 p_block = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
133 IP(src=self.pg0.remote_ip4, dst='224.0.0.22', tos=0xc0) /
136 IGMPv3gr(rtype=6, maddr="224.1.1.1", srcaddrs=["10.1.1.1"]))
138 self.send(self.pg0, p_block)
140 dump = self.vapi.igmp_dump()
141 self.assertFalse(dump)
143 def verify_general_query(self, p):
145 self.assertEqual(ip.dst, "224.0.0.1")
146 self.assertEqual(ip.proto, 2)
148 self.assertEqual(igmp.type, 0x11)
149 self.assertEqual(igmp.gaddr, "0.0.0.0")
151 @unittest.skipUnless(checkIGMPv3(), "missing scapy igmpv3 implementation")
152 def test_igmp_send_query(self):
153 """ IGMP send General Query """
156 # VPP acts as a router.
157 # Send a membership report so VPP builds state
159 p_mr = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
160 IP(src=self.pg0.remote_ip4, dst='224.0.0.22') /
163 IGMPv3gr(rtype=3, maddr="224.1.1.1", srcaddrs=["10.1.1.1"]))
165 self.send(self.pg0, p_mr)
166 self.logger.info(self.vapi.cli("sh igmp config"))
169 # wait for VPP to send out the General Query
171 capture = self.pg0.get_capture(1, timeout=61)
173 self.verify_general_query(capture[0])
176 # the state will expire in 10 more seconds
179 self.assertFalse(self.vapi.igmp_dump())
181 @unittest.skipUnless(checkIGMPv3(), "missing scapy igmpv3 implementation")
182 def test_igmp_src_exp(self):
183 """ IGMP per source timer """
186 # VPP Acts as a router
189 # Host join for (10.1.1.1,224.1.1.1)
190 p_mr1 = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
191 IP(src=self.pg0.remote_ip4, dst='224.0.0.22') /
194 IGMPv3gr(rtype=3, maddr="224.1.1.1", srcaddrs=["10.1.1.1"]))
196 self.send(self.pg0, p_mr1)
198 # VPP (router) sends General Query
199 capture = self.pg0.get_capture(1, timeout=61)
201 self.verify_general_query(capture[0])
203 # host join for same G and another S: (10.1.1.2,224.1.1.1)
204 # therefore leaving (10.1.1.1,224.1.1.1)
205 p_mr2 = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
206 IP(src=self.pg0.remote_ip4, dst='224.0.0.22') /
209 IGMPv3gr(rtype=2, maddr="224.1.1.1", srcaddrs=["10.1.1.2"]))
211 self.send(self.pg0, p_mr2)
213 # wait for VPP to send general query
214 capture = self.pg0.get_capture(1, timeout=61)
215 self.verify_general_query(capture[0])
217 # host leaves (10.1.1.2,224.1.1.1)
218 p_l = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
219 IP(src=self.pg0.remote_ip4, dst='224.0.0.22') /
222 IGMPv3gr(rtype=2, maddr="224.1.1.1", srcaddrs=["10.1.1.2"]))
224 self.send(self.pg0, p_l)
227 p_l = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
228 IP(src=self.pg0.remote_ip4, dst='224.0.0.22') /
231 IGMPv3gr(rtype=2, maddr="224.1.1.1", srcaddrs=["10.1.1.1"]))
232 self.send(self.pg0, p_l)
235 # host has left all groups, no state left.
238 self.logger.error(self.vapi.cli("sh igmp config"))
239 self.assertFalse(self.vapi.igmp_dump())
241 @unittest.skipUnless(checkIGMPv3(), "missing scapy igmpv3 implementation")
242 def test_igmp_query_resp(self):
243 """ IGMP General Query response """
246 # VPP acting as a host.
247 # Add a listener in VPP for (10.1.1.1,244.1.1.1)
249 self.config_list.append(
251 self, self.pg0.sw_if_index, IgmpSG(
253 socket.AF_INET, "10.1.1.1"), socket.inet_pton(
254 socket.AF_INET, "224.1.1.1"))))
255 self.config_list[0].add_vpp_config()
257 # verify state exists
258 self.assertTrue(self.vapi.igmp_dump(self.pg0.sw_if_index))
261 # Send a general query (from a router)
263 p = (Ether(dst=self.pg0.local_mac, src=self.pg0.remote_mac) /
264 IP(src=self.pg0.remote_ip4, dst='224.0.0.1', tos=0xc0) /
265 IGMPv3(type=0x11, mrcode=100) /
266 IGMPv3mq(gaddr="0.0.0.0"))
268 self.send(self.pg0, p)
271 # expect VPP to respond with a membership report for the
272 # (10.1.1.1, 224.1.1.1) state
274 capture = self.pg0.get_capture(1, timeout=10)
276 self.assertEqual(capture[0][IGMPv3].type, 0x22)
277 self.assertEqual(capture[0][IGMPv3mr].numgrp, 1)
278 self.assertEqual(capture[0][IGMPv3gr].rtype, 1)
279 self.assertEqual(capture[0][IGMPv3gr].numsrc, 1)
280 self.assertEqual(capture[0][IGMPv3gr].maddr, "224.1.1.1")
281 self.assertEqual(len(capture[0][IGMPv3gr].srcaddrs), 1)
282 self.assertEqual(capture[0][IGMPv3gr].srcaddrs[0], "10.1.1.1")
284 @unittest.skipUnless(checkIGMPv3(), "missing scapy igmpv3 implementation")
285 def test_igmp_listen(self):
286 """ IGMP listen (S,G)s """
290 # Add IGMP group state to multiple interfaces and validate its
293 for pg in self.pg_interfaces:
294 self.sg_list.append(IgmpSG(socket.inet_pton(
295 socket.AF_INET, "10.1.1.%d" % pg._sw_if_index),
296 socket.inet_pton(socket.AF_INET, "224.1.1.1")))
298 for pg in self.pg_interfaces:
299 self.config_list.append(
304 self.config_list[-1].add_vpp_config()
306 for config in self.config_list:
307 dump = self.vapi.igmp_dump(config.sw_if_index)
308 self.assertTrue(dump)
309 self.assertEqual(len(dump), len(config.sg_list))
310 for idx, e in enumerate(dump):
311 self.assertEqual(e.sw_if_index, config.sw_if_index)
312 self.assertEqual(e.saddr, config.sg_list[idx].saddr)
313 self.assertEqual(e.gaddr, config.sg_list[idx].gaddr)
315 for config in self.config_list:
316 config.remove_vpp_config()
318 dump = self.vapi.igmp_dump()
319 self.assertFalse(dump)
322 if __name__ == '__main__':
323 unittest.main(testRunner=VppTestRunner)