2 # -*- coding: utf-8 -*-
5 from nepi.core.design import ExperimentDescription, FactoriesProvider
6 from nepi.core.execute import ExperimentController
7 from nepi.util import proxy
8 from nepi.util.constants import DeploymentConfiguration as DC, ATTR_NEPI_TESTBED_ENVIRONMENT_SETUP
17 class PlanetLabCrossIntegrationTestCase(unittest.TestCase):
18 testbed_id = "planetlab"
19 slicename = "inria_nepi"
20 plchost = "nepiplc.pl.sophia.inria.fr"
22 host1 = "nepi1.pl.sophia.inria.fr"
23 host2 = "nepi2.pl.sophia.inria.fr"
24 host3 = "nepi3.pl.sophia.inria.fr"
25 host4 = "nepi5.pl.sophia.inria.fr"
27 port_base = 2000 + (os.getpid() % 1000) * 13
30 self.root_dir = tempfile.mkdtemp()
31 self.__class__.port_base = self.port_base + 100
35 shutil.rmtree(self.root_dir)
39 shutil.rmtree(self.root_dir)
41 def make_experiment_desc(self):
42 testbed_id = self.testbed_id
43 slicename = self.slicename
44 plchost = self.plchost
45 pl_ssh_key = os.environ.get(
47 "%s/.ssh/id_rsa_planetlab" % (os.environ['HOME'],) )
48 pl_user, pl_pwd = test_util.pl_auth()
50 exp_desc = ExperimentDescription()
51 pl_provider = FactoriesProvider(testbed_id)
52 pl_desc = exp_desc.add_testbed_description(pl_provider)
53 pl_desc.set_attribute_value("homeDirectory", self.root_dir)
54 pl_desc.set_attribute_value("slice", slicename)
55 pl_desc.set_attribute_value("sliceSSHKey", pl_ssh_key)
56 pl_desc.set_attribute_value("authUser", pl_user)
57 pl_desc.set_attribute_value("authPass", pl_pwd)
58 pl_desc.set_attribute_value("plcHost", plchost)
59 pl_desc.set_attribute_value("tapPortBase", self.port_base)
60 pl_desc.set_attribute_value("p2pDeployment", False) # it's interactive, we don't want it in tests
61 pl_desc.set_attribute_value("dedicatedSlice", True)
63 return pl_desc, exp_desc
65 def make_pl_tapnode(self, pl, ip = "192.168.2.2", inet = None, label = "node1", hostname = None):
66 if not isinstance(ip, list):
70 node1 = pl.create("Node")
71 node1.set_attribute_value("hostname", hostname or self.host1)
72 node1.set_attribute_value("label", label)
73 iface1 = pl.create("NodeInterface")
74 iface1.set_attribute_value("label", label+"iface")
77 for i,ip in enumerate(ips):
78 _tap1 = pl.create("TapInterface")
79 _tap1.enable_trace("packets") # for error output
80 _tap1.set_attribute_value("label", label+"tap"+(str(i+1) if i else ""))
82 _tap1ip = _tap1.add_address()
83 _tap1ip.set_attribute_value("Address", ip)
84 _tap1ip.set_attribute_value("NetPrefix", 24)
85 _tap1ip.set_attribute_value("Broadcast", False)
87 node1.connector("devs").connect(_tap1.connector("node"))
90 tap1ip.append(_tap1ip)
92 inet = inet or pl.create("Internet")
93 node1.connector("devs").connect(iface1.connector("node"))
94 iface1.connector("inet").connect(inet.connector("devs"))
101 return node1, iface1, tap1, tap1ip, inet
103 def make_ns_in_pl(self, pl, exp, node1, iface1, root):
104 ns3_testbed_id = "ns3"
106 # Add NS3 support in node1
107 plnepi = pl.create("NepiDependency")
108 plns3 = pl.create("NS3Dependency")
109 plnepi.connector("node").connect(node1.connector("deps"))
110 plns3.connector("node").connect(node1.connector("deps"))
112 # Create NS3 testbed running in node1
113 ns3_provider = FactoriesProvider(ns3_testbed_id)
114 ns3_desc = exp.add_testbed_description(ns3_provider)
115 ns3_desc.set_attribute_value("rootDirectory", root)
116 ns3_desc.set_attribute_value("SimulatorImplementationType", "ns3::RealtimeSimulatorImpl")
117 ns3_desc.set_attribute_value("ChecksumEnabled", True)
118 ns3_desc.set_attribute_value(DC.DEPLOYMENT_HOST, "{#[%s].addr[0].[Address]#}" % (
119 iface1.get_attribute_value("label"),))
120 ns3_desc.set_attribute_value(DC.DEPLOYMENT_USER,
121 pl.get_attribute_value("slice"))
122 ns3_desc.set_attribute_value(DC.DEPLOYMENT_KEY,
123 pl.get_attribute_value("sliceSSHKey"))
124 ns3_desc.set_attribute_value(DC.DEPLOYMENT_MODE, DC.MODE_DAEMON)
125 ns3_desc.set_attribute_value(DC.DEPLOYMENT_COMMUNICATION, DC.ACCESS_SSH)
126 ns3_desc.set_attribute_value(DC.DEPLOYMENT_ENVIRONMENT_SETUP,
128 node1.get_attribute_value("label"),
129 ATTR_NEPI_TESTBED_ENVIRONMENT_SETUP,))
130 ns3_desc.set_attribute_value(DC.LOG_LEVEL, DC.DEBUG_LEVEL)
135 @test_util.skipUnless(test_util.pl_auth() is not None,
136 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
137 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
138 "Test is expensive, requires NEPI_FULL_TESTS=yes")
139 def test_ns3_in_pl(self):
140 ns3_testbed_id = "ns3"
142 pl, exp = self.make_experiment_desc()
144 node1 = pl.create("Node")
145 node1.set_attribute_value("hostname", self.host1)
146 node1.set_attribute_value("label", "node1")
147 iface1 = pl.create("NodeInterface")
148 iface1.set_attribute_value("label", "node1iface")
149 inet = pl.create("Internet")
150 node1.connector("devs").connect(iface1.connector("node"))
151 iface1.connector("inet").connect(inet.connector("devs"))
153 # Add NS3 support in node1
154 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-1")
159 controller = ExperimentController(xml, self.root_dir)
161 # just test that it starts...
167 traceback.print_exc()
169 controller.shutdown()
172 traceback.print_exc()
174 @test_util.skipUnless(test_util.pl_auth() is not None,
175 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
176 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
177 "Test is expensive, requires NEPI_FULL_TESTS=yes")
178 def test_ns3_in_pl_crossconnect(self):
179 pl, exp = self.make_experiment_desc()
181 # Create PL node, ifaces, assign addresses
182 node1, iface1, tap1, tap1ip, inet = self.make_pl_tapnode(pl)
184 # Add NS3 support in node1
185 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-2")
187 # Create NS3 node that is responsive to pings, connected
188 # to node1 through the Tap interface
189 ns1 = ns3_desc.create("ns3::Node")
190 ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
191 arp1 = ns3_desc.create("ns3::ArpL3Protocol")
192 icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
193 ns1.connector("protos").connect(ipv41.connector("node"))
194 ns1.connector("protos").connect(arp1.connector("node"))
195 ns1.connector("protos").connect(icmp1.connector("node"))
196 ns1if = ns3_desc.create("ns3::FdNetDevice")
197 ns1if.enable_trace("FdPcapTrace")
198 ns1if.set_attribute_value("label", "ns1if")
199 ns1.connector("devs").connect(ns1if.connector("node"))
200 tap1.connector("fd->").connect(ns1if.connector("->fd"))
201 tap1.set_attribute_value("tun_cipher", "PLAIN")
202 ip1 = ns1if.add_address()
203 ip1.set_attribute_value("Address", "192.168.2.3")
204 ip1.set_attribute_value("NetPrefix", 24)
205 ip1.set_attribute_value("Broadcast", False)
207 # Create PlanetLab ping application, pinging the NS3 node
208 ping = pl.create("Application")
209 ping.set_attribute_value("command", "ping -qc10 {#[ns1if].addr[0].[Address]#}")
210 ping.enable_trace("stdout")
211 ping.enable_trace("stderr")
212 ping.connector("node").connect(node1.connector("apps"))
214 comp_result = r"""PING .* \(.*\) \d*\(\d*\) bytes of data.
216 --- .* ping statistics ---
217 10 packets transmitted, 10 received, 0% packet loss, time \d*ms.*
223 controller = ExperimentController(xml, self.root_dir)
226 while not controller.is_finished(ping.guid):
229 ping_result = controller.trace(ping.guid, "stdout")
230 tap_trace = controller.trace(tap1.guid, "packets")
237 traceback.print_exc()
239 controller.shutdown()
242 traceback.print_exc()
244 # asserts at the end, to make sure there's proper cleanup
245 self.assertTrue(re.match(comp_result, ping_result, re.MULTILINE),
246 "Unexpected trace:\n%s\nTap trace:\n%s\n" % (
250 @test_util.skipUnless(test_util.pl_auth() is not None,
251 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
252 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
253 "Test is expensive, requires NEPI_FULL_TESTS=yes")
254 def test_ns3_in_pl_snat(self):
255 pl, exp = self.make_experiment_desc()
257 # Create PL node, ifaces, assign addresses
258 node1, iface1, tap1, tap1ip, inet = self.make_pl_tapnode(pl)
260 # Add NS3 support in node1
261 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-3")
264 tap1.set_attribute_value("snat", True)
266 # Add second PL node (ping target)
267 node2 = pl.create("Node")
268 node2.set_attribute_value("hostname", self.host2)
269 node2.set_attribute_value("label", "node2")
270 iface2 = pl.create("NodeInterface")
271 iface2.set_attribute_value("label", "node2iface")
272 node2.connector("devs").connect(iface2.connector("node"))
273 iface2.connector("inet").connect(inet.connector("devs"))
275 # Create NS3 node that is responsive to pings, connected
276 # to node1 through the Tap interface
277 ns1 = ns3_desc.create("ns3::Node")
278 ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
279 arp1 = ns3_desc.create("ns3::ArpL3Protocol")
280 icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
281 ns1.connector("protos").connect(ipv41.connector("node"))
282 ns1.connector("protos").connect(arp1.connector("node"))
283 ns1.connector("protos").connect(icmp1.connector("node"))
284 ns1if = ns3_desc.create("ns3::FdNetDevice")
285 ns1if.enable_trace("FdPcapTrace")
286 ns1if.set_attribute_value("label", "ns1if")
287 ns1.connector("devs").connect(ns1if.connector("node"))
288 tap1.connector("fd->").connect(ns1if.connector("->fd"))
289 tap1.set_attribute_value("tun_cipher", "PLAIN")
290 ip1 = ns1if.add_address()
291 ip1.set_attribute_value("Address", "192.168.2.3")
292 ip1.set_attribute_value("NetPrefix", 24)
293 ip1.set_attribute_value("Broadcast", False)
295 # Add default route to the PL node
297 r1.set_attribute_value("Destination", "0.0.0.0")
298 r1.set_attribute_value("NetPrefix", 0)
299 r1.set_attribute_value("NextHop", "192.168.2.2")
301 # Create NS3 ping application, pinging the PL node
302 ping = ns3_desc.create("ns3::V4Ping")
303 ping.set_attribute_value("Remote", "{#[node2iface].addr[0].[Address]#}")
304 ping.set_attribute_value("StartTime", "0s")
305 ping.set_attribute_value("StopTime", "10s")
306 ping.connector("node").connect(ns1.connector("apps"))
311 controller = ExperimentController(xml, self.root_dir)
314 while not controller.is_finished(ping.guid):
317 tap_trace = controller.trace(tap1.guid, "packets")
324 traceback.print_exc()
326 controller.shutdown()
329 traceback.print_exc()
331 # asserts at the end, to make sure there's proper cleanup
334 for seq in xrange(10):
336 [0-9.:]* IP 192.168.2.3 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*
337 .*""" % dict(seq=seq)
340 [0-9.:]* IP 192.168.2.3 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*.*
341 [0-9.:]* IP (\d*\.){3}\d* > 192.168.2.3: ICMP echo reply, id 0, seq %(seq)d, length \d*
342 .*""" % dict(seq=seq)
344 sent += bool(re.match(re_send, tap_trace, re.MULTILINE|re.DOTALL))
345 replied += bool(re.match(re_reply, tap_trace, re.MULTILINE|re.DOTALL))
347 self.assertTrue(sent == replied and sent > 5,
348 "Unexpected trace:\n%s\n" % (
351 def _test_ns3_in_pl_p2p(self, proto):
352 pl, exp = self.make_experiment_desc()
354 # Create PL node, ifaces, assign addresses
355 node1, iface1, (tap0,tap1), (tap0ip,tap1ip), inet = self.make_pl_tapnode(pl,
356 label="node1", hostname = self.host1,
357 ip=["192.168.2.2","192.168.2.5"])
358 node2, iface2, (tap2,tap3), (tap2ip,tap3ip), inet = self.make_pl_tapnode(pl, inet=inet,
359 label="node2", hostname = self.host2,
360 ip=["192.168.2.6","192.168.2.9"])
361 node3, iface3, tap4, tap4ip, inet = self.make_pl_tapnode(pl, inet=inet,
362 label="node3", hostname = self.host3,
365 # Add NS3 support in node1
366 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-4-%s" % (proto,))
368 # Configure P2P links
369 tap0.set_attribute_value("pointopoint", "192.168.2.1") # cross-p2p is not automatic
370 tap1.connector(proto).connect(tap2.connector(proto))
371 tap3.connector(proto).connect(tap4.connector(proto))
374 r = node1.add_route()
375 r.set_attribute_value("Destination", "192.168.2.8")
376 r.set_attribute_value("NetPrefix", 29)
377 r.set_attribute_value("NextHop", "192.168.2.6")
379 r = node2.add_route()
380 r.set_attribute_value("Destination", "192.168.2.0")
381 r.set_attribute_value("NetPrefix", 29)
382 r.set_attribute_value("NextHop", "192.168.2.5")
384 r = node3.add_route()
385 r.set_attribute_value("Destination", "192.168.2.0")
386 r.set_attribute_value("NetPrefix", 29)
387 r.set_attribute_value("NextHop", "192.168.2.9")
389 # Create NS3 node that is responsive to pings, connected
390 # to node1 through the Tap interface
391 ns1 = ns3_desc.create("ns3::Node")
392 ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
393 arp1 = ns3_desc.create("ns3::ArpL3Protocol")
394 icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
395 ns1.connector("protos").connect(ipv41.connector("node"))
396 ns1.connector("protos").connect(arp1.connector("node"))
397 ns1.connector("protos").connect(icmp1.connector("node"))
398 ns1if = ns3_desc.create("ns3::FdNetDevice")
399 ns1if.enable_trace("FdPcapTrace")
400 ns1if.set_attribute_value("label", "ns1if")
401 ns1.connector("devs").connect(ns1if.connector("node"))
402 tap0.connector("fd->").connect(ns1if.connector("->fd"))
403 tap0.set_attribute_value("tun_cipher", "PLAIN")
404 ip1 = ns1if.add_address()
405 ip1.set_attribute_value("Address", "192.168.2.1")
406 ip1.set_attribute_value("NetPrefix", 30)
407 ip1.set_attribute_value("Broadcast", False)
409 # Add default route to the PL node
411 r1.set_attribute_value("Destination", "0.0.0.0")
412 r1.set_attribute_value("NetPrefix", 0)
413 r1.set_attribute_value("NextHop", "192.168.2.2")
415 # Create NS3 ping application, pinging the PL node
416 ping = ns3_desc.create("ns3::V4Ping")
417 ping.set_attribute_value("Remote", "{#[node3tap].addr[0].[Address]#}")
418 ping.set_attribute_value("StartTime", "0s")
419 ping.set_attribute_value("StopTime", "10s")
420 ping.connector("node").connect(ns1.connector("apps"))
425 controller = ExperimentController(xml, self.root_dir)
428 while not controller.is_finished(ping.guid):
432 for i,tap in enumerate([ tap0, tap1, tap2, tap3, tap4 ]):
433 tap_trace.append("\nTrace for tap%d:\n" % i)
434 tap_trace.append(controller.trace(tap.guid, "packets"))
435 tap_trace = "".join(tap_trace)
436 tap0_trace = controller.trace(tap0.guid, "packets")
443 traceback.print_exc()
445 controller.shutdown()
448 traceback.print_exc()
450 # asserts at the end, to make sure there's proper cleanup
453 for seq in xrange(10):
455 [0-9.:]* IP 192.168.2.1 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*
456 .*""" % dict(seq=seq)
459 [0-9.:]* IP 192.168.2.1 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*.*
460 [0-9.:]* IP (\d*\.){3}\d* > 192.168.2.1: ICMP echo reply, id 0, seq %(seq)d, length \d*
461 .*""" % dict(seq=seq)
463 sent += bool(re.match(re_send, tap0_trace, re.MULTILINE|re.DOTALL))
464 replied += bool(re.match(re_reply, tap0_trace, re.MULTILINE|re.DOTALL))
466 self.assertTrue(replied >= sent/2 and sent > 5,
467 "Unexpected trace:\n%s\n" % (
471 @test_util.skipUnless(test_util.pl_auth() is not None,
472 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
473 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
474 "Test is expensive, requires NEPI_FULL_TESTS=yes")
475 def test_ns3_in_pl_p2p_udp(self):
476 self._test_ns3_in_pl_p2p("udp")
478 @test_util.skipUnless(test_util.pl_auth() is not None,
479 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
480 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
481 "Test is expensive, requires NEPI_FULL_TESTS=yes")
482 def test_ns3_in_pl_p2p_tcp(self):
483 self._test_ns3_in_pl_p2p("tcp")
485 if __name__ == '__main__':