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("cleanProc", True)
62 #pl_desc.set_attribute_value("plLogLevel", "DEBUG")
64 return pl_desc, exp_desc
66 def make_pl_tapnode(self, pl, ip = "192.168.2.2", inet = None, label = "node1", hostname = None):
67 if not isinstance(ip, list):
71 node1 = pl.create("Node")
72 node1.set_attribute_value("hostname", hostname or self.host1)
73 node1.set_attribute_value("label", label)
74 iface1 = pl.create("NodeInterface")
75 iface1.set_attribute_value("label", label+"iface")
78 for i,ip in enumerate(ips):
79 _tap1 = pl.create("TapInterface")
80 _tap1.enable_trace("packets") # for error output
81 _tap1.set_attribute_value("label", label+"tap"+(str(i+1) if i else ""))
83 _tap1ip = _tap1.add_address()
84 _tap1ip.set_attribute_value("Address", ip)
85 _tap1ip.set_attribute_value("NetPrefix", 24)
86 _tap1ip.set_attribute_value("Broadcast", False)
88 node1.connector("devs").connect(_tap1.connector("node"))
91 tap1ip.append(_tap1ip)
93 inet = inet or pl.create("Internet")
94 node1.connector("devs").connect(iface1.connector("node"))
95 iface1.connector("inet").connect(inet.connector("devs"))
102 return node1, iface1, tap1, tap1ip, inet
104 def make_ns_in_pl(self, pl, exp, node1, iface1, root):
105 ns3_testbed_id = "ns3"
107 # Add NS3 support in node1
108 plnepi = pl.create("NepiDependency")
109 plns3 = pl.create("NS3Dependency")
110 plnepi.connector("node").connect(node1.connector("deps"))
111 plns3.connector("node").connect(node1.connector("deps"))
113 # Create NS3 testbed running in node1
114 ns3_provider = FactoriesProvider(ns3_testbed_id)
115 ns3_desc = exp.add_testbed_description(ns3_provider)
116 ns3_desc.set_attribute_value("rootDirectory", root)
117 ns3_desc.set_attribute_value("SimulatorImplementationType", "ns3::RealtimeSimulatorImpl")
118 ns3_desc.set_attribute_value("ChecksumEnabled", True)
119 ns3_desc.set_attribute_value(DC.DEPLOYMENT_HOST, "{#[%s].addr[0].[Address]#}" % (
120 iface1.get_attribute_value("label"),))
121 ns3_desc.set_attribute_value(DC.DEPLOYMENT_USER,
122 pl.get_attribute_value("slice"))
123 ns3_desc.set_attribute_value(DC.DEPLOYMENT_KEY,
124 pl.get_attribute_value("sliceSSHKey"))
125 ns3_desc.set_attribute_value(DC.DEPLOYMENT_MODE, DC.MODE_DAEMON)
126 ns3_desc.set_attribute_value(DC.DEPLOYMENT_COMMUNICATION, DC.ACCESS_SSH)
127 ns3_desc.set_attribute_value(DC.DEPLOYMENT_ENVIRONMENT_SETUP,
129 node1.get_attribute_value("label"),
130 ATTR_NEPI_TESTBED_ENVIRONMENT_SETUP,))
131 ns3_desc.set_attribute_value(DC.LOG_LEVEL, DC.DEBUG_LEVEL)
136 @test_util.skipUnless(test_util.pl_auth() is not None,
137 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
138 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
139 "Test is expensive, requires NEPI_FULL_TESTS=yes")
140 def test_ns3_in_pl(self):
141 ns3_testbed_id = "ns3"
143 pl, exp = self.make_experiment_desc()
145 node1 = pl.create("Node")
146 node1.set_attribute_value("hostname", self.host1)
147 node1.set_attribute_value("label", "node1")
148 iface1 = pl.create("NodeInterface")
149 iface1.set_attribute_value("label", "node1iface")
150 inet = pl.create("Internet")
151 node1.connector("devs").connect(iface1.connector("node"))
152 iface1.connector("inet").connect(inet.connector("devs"))
154 # Add NS3 support in node1
155 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-1")
160 controller = ExperimentController(xml, self.root_dir)
162 # just test that it starts...
168 traceback.print_exc()
170 controller.shutdown()
173 traceback.print_exc()
175 @test_util.skipUnless(test_util.pl_auth() is not None,
176 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
177 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
178 "Test is expensive, requires NEPI_FULL_TESTS=yes")
179 def test_ns3_in_pl_crossconnect(self):
180 pl, exp = self.make_experiment_desc()
182 # Create PL node, ifaces, assign addresses
183 node1, iface1, tap1, tap1ip, inet = self.make_pl_tapnode(pl)
185 # Add NS3 support in node1
186 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-2")
188 # Create NS3 node that is responsive to pings, connected
189 # to node1 through the Tap interface
190 ns1 = ns3_desc.create("ns3::Node")
191 ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
192 arp1 = ns3_desc.create("ns3::ArpL3Protocol")
193 icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
194 ns1.connector("protos").connect(ipv41.connector("node"))
195 ns1.connector("protos").connect(arp1.connector("node"))
196 ns1.connector("protos").connect(icmp1.connector("node"))
197 ns1if = ns3_desc.create("ns3::FdNetDevice")
198 ns1if.enable_trace("FdPcapTrace")
199 ns1if.set_attribute_value("label", "ns1if")
200 ns1.connector("devs").connect(ns1if.connector("node"))
201 tap1.connector("fd->").connect(ns1if.connector("->fd"))
202 tap1.set_attribute_value("tun_cipher", "PLAIN")
203 ip1 = ns1if.add_address()
204 ip1.set_attribute_value("Address", "192.168.2.3")
205 ip1.set_attribute_value("NetPrefix", 24)
206 ip1.set_attribute_value("Broadcast", False)
208 # Create PlanetLab ping application, pinging the NS3 node
209 ping = pl.create("Application")
210 ping.set_attribute_value("command", "ping -qc10 {#[ns1if].addr[0].[Address]#}")
211 ping.enable_trace("stdout")
212 ping.enable_trace("stderr")
213 ping.connector("node").connect(node1.connector("apps"))
215 comp_result = r"""PING .* \(.*\) \d*\(\d*\) bytes of data.
217 --- .* ping statistics ---
218 10 packets transmitted, 10 received, 0% packet loss, time \d*ms.*
224 controller = ExperimentController(xml, self.root_dir)
227 while not controller.is_finished(ping.guid):
230 ping_result = controller.trace(ping.guid, "stdout")
231 tap_trace = controller.trace(tap1.guid, "packets")
238 traceback.print_exc()
240 controller.shutdown()
243 traceback.print_exc()
245 # asserts at the end, to make sure there's proper cleanup
246 self.assertTrue(re.match(comp_result, ping_result, re.MULTILINE),
247 "Unexpected trace:\n%s\nTap trace:\n%s\n" % (
251 @test_util.skipUnless(test_util.pl_auth() is not None,
252 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
253 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
254 "Test is expensive, requires NEPI_FULL_TESTS=yes")
255 def test_ns3_in_pl_snat(self):
256 pl, exp = self.make_experiment_desc()
258 # Create PL node, ifaces, assign addresses
259 node1, iface1, tap1, tap1ip, inet = self.make_pl_tapnode(pl)
261 # Add NS3 support in node1
262 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-3")
265 tap1.set_attribute_value("snat", True)
267 # Add second PL node (ping target)
268 node2 = pl.create("Node")
269 node2.set_attribute_value("hostname", self.host2)
270 node2.set_attribute_value("label", "node2")
271 iface2 = pl.create("NodeInterface")
272 iface2.set_attribute_value("label", "node2iface")
273 node2.connector("devs").connect(iface2.connector("node"))
274 iface2.connector("inet").connect(inet.connector("devs"))
276 # Create NS3 node that is responsive to pings, connected
277 # to node1 through the Tap interface
278 ns1 = ns3_desc.create("ns3::Node")
279 ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
280 arp1 = ns3_desc.create("ns3::ArpL3Protocol")
281 icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
282 ns1.connector("protos").connect(ipv41.connector("node"))
283 ns1.connector("protos").connect(arp1.connector("node"))
284 ns1.connector("protos").connect(icmp1.connector("node"))
285 ns1if = ns3_desc.create("ns3::FdNetDevice")
286 ns1if.enable_trace("FdPcapTrace")
287 ns1if.set_attribute_value("label", "ns1if")
288 ns1.connector("devs").connect(ns1if.connector("node"))
289 tap1.connector("fd->").connect(ns1if.connector("->fd"))
290 tap1.set_attribute_value("tun_cipher", "PLAIN")
291 ip1 = ns1if.add_address()
292 ip1.set_attribute_value("Address", "192.168.2.3")
293 ip1.set_attribute_value("NetPrefix", 24)
294 ip1.set_attribute_value("Broadcast", False)
296 # Add default route to the PL node
298 r1.set_attribute_value("Destination", "0.0.0.0")
299 r1.set_attribute_value("NetPrefix", 0)
300 r1.set_attribute_value("NextHop", "192.168.2.2")
302 # Create NS3 ping application, pinging the PL node
303 ping = ns3_desc.create("ns3::V4Ping")
304 ping.set_attribute_value("Remote", "{#[node2iface].addr[0].[Address]#}")
305 ping.set_attribute_value("StartTime", "0s")
306 ping.set_attribute_value("StopTime", "10s")
307 ping.connector("node").connect(ns1.connector("apps"))
312 controller = ExperimentController(xml, self.root_dir)
315 while not controller.is_finished(ping.guid):
318 tap_trace = controller.trace(tap1.guid, "packets")
325 traceback.print_exc()
327 controller.shutdown()
330 traceback.print_exc()
332 # asserts at the end, to make sure there's proper cleanup
335 for seq in xrange(10):
337 [0-9.:]* IP 192.168.2.3 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*
338 .*""" % dict(seq=seq)
341 [0-9.:]* IP 192.168.2.3 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*.*
342 [0-9.:]* IP (\d*\.){3}\d* > 192.168.2.3: ICMP echo reply, id 0, seq %(seq)d, length \d*
343 .*""" % dict(seq=seq)
345 sent += bool(re.match(re_send, tap_trace, re.MULTILINE|re.DOTALL))
346 replied += bool(re.match(re_reply, tap_trace, re.MULTILINE|re.DOTALL))
348 self.assertTrue(sent == replied and sent > 5,
349 "Unexpected trace:\n%s\n" % (
352 def _test_ns3_in_pl_p2p(self, proto):
353 pl, exp = self.make_experiment_desc()
355 # Create PL node, ifaces, assign addresses
356 node1, iface1, (tap0,tap1), (tap0ip,tap1ip), inet = self.make_pl_tapnode(pl,
357 label="node1", hostname = self.host1,
358 ip=["192.168.2.2","192.168.2.5"])
359 node2, iface2, (tap2,tap3), (tap2ip,tap3ip), inet = self.make_pl_tapnode(pl, inet=inet,
360 label="node2", hostname = self.host2,
361 ip=["192.168.2.6","192.168.2.9"])
362 node3, iface3, tap4, tap4ip, inet = self.make_pl_tapnode(pl, inet=inet,
363 label="node3", hostname = self.host3,
366 # Add NS3 support in node1
367 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-4-%s" % (proto,))
369 # Configure P2P links
370 tap0.set_attribute_value("pointopoint", "192.168.2.1") # cross-p2p is not automatic
371 tap1.connector(proto).connect(tap2.connector(proto))
372 tap3.connector(proto).connect(tap4.connector(proto))
375 r = node1.add_route()
376 r.set_attribute_value("Destination", "192.168.2.8")
377 r.set_attribute_value("NetPrefix", 29)
378 r.set_attribute_value("NextHop", "192.168.2.6")
380 r = node2.add_route()
381 r.set_attribute_value("Destination", "192.168.2.0")
382 r.set_attribute_value("NetPrefix", 29)
383 r.set_attribute_value("NextHop", "192.168.2.5")
385 r = node3.add_route()
386 r.set_attribute_value("Destination", "192.168.2.0")
387 r.set_attribute_value("NetPrefix", 29)
388 r.set_attribute_value("NextHop", "192.168.2.9")
390 # Create NS3 node that is responsive to pings, connected
391 # to node1 through the Tap interface
392 ns1 = ns3_desc.create("ns3::Node")
393 ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
394 arp1 = ns3_desc.create("ns3::ArpL3Protocol")
395 icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
396 ns1.connector("protos").connect(ipv41.connector("node"))
397 ns1.connector("protos").connect(arp1.connector("node"))
398 ns1.connector("protos").connect(icmp1.connector("node"))
399 ns1if = ns3_desc.create("ns3::FdNetDevice")
400 ns1if.enable_trace("FdPcapTrace")
401 ns1if.set_attribute_value("label", "ns1if")
402 ns1.connector("devs").connect(ns1if.connector("node"))
403 tap0.connector("fd->").connect(ns1if.connector("->fd"))
404 tap0.set_attribute_value("tun_cipher", "PLAIN")
405 ip1 = ns1if.add_address()
406 ip1.set_attribute_value("Address", "192.168.2.1")
407 ip1.set_attribute_value("NetPrefix", 30)
408 ip1.set_attribute_value("Broadcast", False)
410 # Add default route to the PL node
412 r1.set_attribute_value("Destination", "0.0.0.0")
413 r1.set_attribute_value("NetPrefix", 0)
414 r1.set_attribute_value("NextHop", "192.168.2.2")
416 # Create NS3 ping application, pinging the PL node
417 ping = ns3_desc.create("ns3::V4Ping")
418 ping.set_attribute_value("Remote", "{#[node3tap].addr[0].[Address]#}")
419 ping.set_attribute_value("StartTime", "0s")
420 ping.set_attribute_value("StopTime", "10s")
421 ping.connector("node").connect(ns1.connector("apps"))
426 controller = ExperimentController(xml, self.root_dir)
429 while not controller.is_finished(ping.guid):
433 for i,tap in enumerate([ tap0, tap1, tap2, tap3, tap4 ]):
434 tap_trace.append("\nTrace for tap%d:\n" % i)
435 tap_trace.append(controller.trace(tap.guid, "packets"))
436 tap_trace = "".join(tap_trace)
437 tap0_trace = controller.trace(tap0.guid, "packets")
444 traceback.print_exc()
446 controller.shutdown()
449 traceback.print_exc()
451 # asserts at the end, to make sure there's proper cleanup
454 for seq in xrange(10):
456 [0-9.:]* IP 192.168.2.1 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*
457 .*""" % dict(seq=seq)
460 [0-9.:]* IP 192.168.2.1 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*.*
461 [0-9.:]* IP (\d*\.){3}\d* > 192.168.2.1: ICMP echo reply, id 0, seq %(seq)d, length \d*
462 .*""" % dict(seq=seq)
464 sent += bool(re.match(re_send, tap0_trace, re.MULTILINE|re.DOTALL))
465 replied += bool(re.match(re_reply, tap0_trace, re.MULTILINE|re.DOTALL))
467 self.assertTrue(replied >= sent/2 and sent > 5,
468 "Unexpected trace:\n%s\n" % (
472 @test_util.skipUnless(test_util.pl_auth() is not None,
473 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
474 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
475 "Test is expensive, requires NEPI_FULL_TESTS=yes")
476 def test_ns3_in_pl_p2p_udp(self):
477 self._test_ns3_in_pl_p2p("udp")
479 @test_util.skipUnless(test_util.pl_auth() is not None,
480 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
481 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
482 "Test is expensive, requires NEPI_FULL_TESTS=yes")
483 def test_ns3_in_pl_p2p_tcp(self):
484 self._test_ns3_in_pl_p2p("tcp")
486 if __name__ == '__main__':