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"
28 self.root_dir = tempfile.mkdtemp()
32 shutil.rmtree(self.root_dir)
36 shutil.rmtree(self.root_dir)
38 def make_experiment_desc(self):
39 testbed_id = self.testbed_id
40 slicename = self.slicename
41 plchost = self.plchost
42 pl_ssh_key = os.environ.get(
44 "%s/.ssh/id_rsa_planetlab" % (os.environ['HOME'],) )
45 pl_user, pl_pwd = test_util.pl_auth()
47 exp_desc = ExperimentDescription()
48 pl_provider = FactoriesProvider(testbed_id)
49 pl_desc = exp_desc.add_testbed_description(pl_provider)
50 pl_desc.set_attribute_value("homeDirectory", self.root_dir)
51 pl_desc.set_attribute_value("slice", slicename)
52 pl_desc.set_attribute_value("sliceSSHKey", pl_ssh_key)
53 pl_desc.set_attribute_value("authUser", pl_user)
54 pl_desc.set_attribute_value("authPass", pl_pwd)
55 pl_desc.set_attribute_value("plcHost", plchost)
57 return pl_desc, exp_desc
59 def make_pl_tapnode(self, pl, ip = "192.168.2.2", inet = None, label = "node1", hostname = None):
60 if not isinstance(ip, list):
64 node1 = pl.create("Node")
65 node1.set_attribute_value("hostname", hostname or self.host1)
66 node1.set_attribute_value("label", label)
67 iface1 = pl.create("NodeInterface")
68 iface1.set_attribute_value("label", label+"iface")
71 for i,ip in enumerate(ips):
72 _tap1 = pl.create("TapInterface")
73 _tap1.enable_trace("packets") # for error output
74 _tap1.set_attribute_value("label", label+"tap"+(str(i+1) if i else ""))
76 _tap1ip = _tap1.add_address()
77 _tap1ip.set_attribute_value("Address", ip)
78 _tap1ip.set_attribute_value("NetPrefix", 24)
79 _tap1ip.set_attribute_value("Broadcast", False)
81 node1.connector("devs").connect(_tap1.connector("node"))
84 tap1ip.append(_tap1ip)
86 inet = inet or pl.create("Internet")
87 node1.connector("devs").connect(iface1.connector("node"))
88 iface1.connector("inet").connect(inet.connector("devs"))
95 return node1, iface1, tap1, tap1ip, inet
97 def make_ns_in_pl(self, pl, exp, node1, iface1, root):
98 ns3_testbed_id = "ns3"
100 # Add NS3 support in node1
101 plnepi = pl.create("NepiDependency")
102 plns3 = pl.create("NS3Dependency")
103 plnepi.connector("node").connect(node1.connector("deps"))
104 plns3.connector("node").connect(node1.connector("deps"))
106 # Create NS3 testbed running in node1
107 ns3_provider = FactoriesProvider(ns3_testbed_id)
108 ns3_desc = exp.add_testbed_description(ns3_provider)
109 ns3_desc.set_attribute_value("rootDirectory", root)
110 ns3_desc.set_attribute_value("SimulatorImplementationType", "ns3::RealtimeSimulatorImpl")
111 ns3_desc.set_attribute_value("ChecksumEnabled", True)
112 ns3_desc.set_attribute_value(DC.DEPLOYMENT_HOST, "{#[%s].addr[0].[Address]#}" % (
113 iface1.get_attribute_value("label"),))
114 ns3_desc.set_attribute_value(DC.DEPLOYMENT_USER,
115 pl.get_attribute_value("slice"))
116 ns3_desc.set_attribute_value(DC.DEPLOYMENT_KEY,
117 pl.get_attribute_value("sliceSSHKey"))
118 ns3_desc.set_attribute_value(DC.DEPLOYMENT_MODE, DC.MODE_DAEMON)
119 ns3_desc.set_attribute_value(DC.DEPLOYMENT_COMMUNICATION, DC.ACCESS_SSH)
120 ns3_desc.set_attribute_value(DC.DEPLOYMENT_ENVIRONMENT_SETUP,
122 node1.get_attribute_value("label"),
123 ATTR_NEPI_TESTBED_ENVIRONMENT_SETUP,))
124 ns3_desc.set_attribute_value(DC.LOG_LEVEL, DC.DEBUG_LEVEL)
129 @test_util.skipUnless(test_util.pl_auth() is not None,
130 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
131 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
132 "Test is expensive, requires NEPI_FULL_TESTS=yes")
133 def test_ns3_in_pl(self):
134 ns3_testbed_id = "ns3"
136 pl, exp = self.make_experiment_desc()
138 node1 = pl.create("Node")
139 node1.set_attribute_value("hostname", self.host1)
140 node1.set_attribute_value("label", "node1")
141 iface1 = pl.create("NodeInterface")
142 iface1.set_attribute_value("label", "node1iface")
143 inet = pl.create("Internet")
144 node1.connector("devs").connect(iface1.connector("node"))
145 iface1.connector("inet").connect(inet.connector("devs"))
147 # Add NS3 support in node1
148 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-1")
153 controller = ExperimentController(xml, self.root_dir)
155 # just test that it starts...
158 controller.shutdown()
160 @test_util.skipUnless(test_util.pl_auth() is not None,
161 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
162 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
163 "Test is expensive, requires NEPI_FULL_TESTS=yes")
164 def test_ns3_in_pl_crossconnect(self):
165 pl, exp = self.make_experiment_desc()
167 # Create PL node, ifaces, assign addresses
168 node1, iface1, tap1, tap1ip, inet = self.make_pl_tapnode(pl)
170 # Add NS3 support in node1
171 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-2")
173 # Create NS3 node that is responsive to pings, connected
174 # to node1 through the Tap interface
175 ns1 = ns3_desc.create("ns3::Node")
176 ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
177 arp1 = ns3_desc.create("ns3::ArpL3Protocol")
178 icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
179 ns1.connector("protos").connect(ipv41.connector("node"))
180 ns1.connector("protos").connect(arp1.connector("node"))
181 ns1.connector("protos").connect(icmp1.connector("node"))
182 ns1if = ns3_desc.create("ns3::FileDescriptorNetDevice")
183 ns1if.enable_trace("FileDescriptorPcapTrace")
184 ns1if.set_attribute_value("label", "ns1if")
185 ns1.connector("devs").connect(ns1if.connector("node"))
186 tap1.connector("fd->").connect(ns1if.connector("->fd"))
187 ip1 = ns1if.add_address()
188 ip1.set_attribute_value("Address", "192.168.2.3")
189 ip1.set_attribute_value("NetPrefix", 24)
190 ip1.set_attribute_value("Broadcast", False)
192 # Create PlanetLab ping application, pinging the NS3 node
193 ping = pl.create("Application")
194 ping.set_attribute_value("command", "ping -qc10 {#[ns1if].addr[0].[Address]#}")
195 ping.enable_trace("stdout")
196 ping.enable_trace("stderr")
197 ping.connector("node").connect(node1.connector("apps"))
199 comp_result = r"""PING .* \(.*\) \d*\(\d*\) bytes of data.
201 --- .* ping statistics ---
202 10 packets transmitted, 10 received, 0% packet loss, time \d*ms.*
208 controller = ExperimentController(xml, self.root_dir)
211 while not controller.is_finished(ping.guid):
214 ping_result = controller.trace(ping.guid, "stdout")
215 tap_trace = controller.trace(tap1.guid, "packets")
219 controller.shutdown()
221 # asserts at the end, to make sure there's proper cleanup
222 self.assertTrue(re.match(comp_result, ping_result, re.MULTILINE),
223 "Unexpected trace:\n%s\nTap trace:\n%s\n" % (
227 @test_util.skipUnless(test_util.pl_auth() is not None,
228 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
229 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
230 "Test is expensive, requires NEPI_FULL_TESTS=yes")
231 def test_ns3_in_pl_snat(self):
232 pl, exp = self.make_experiment_desc()
234 # Create PL node, ifaces, assign addresses
235 node1, iface1, tap1, tap1ip, inet = self.make_pl_tapnode(pl)
237 # Add NS3 support in node1
238 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-3")
241 tap1.set_attribute_value("snat", True)
243 # Add second PL node (ping target)
244 node2 = pl.create("Node")
245 node2.set_attribute_value("hostname", self.host2)
246 node2.set_attribute_value("label", "node2")
247 iface2 = pl.create("NodeInterface")
248 iface2.set_attribute_value("label", "node2iface")
249 node2.connector("devs").connect(iface2.connector("node"))
250 iface2.connector("inet").connect(inet.connector("devs"))
252 # Create NS3 node that is responsive to pings, connected
253 # to node1 through the Tap interface
254 ns1 = ns3_desc.create("ns3::Node")
255 ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
256 arp1 = ns3_desc.create("ns3::ArpL3Protocol")
257 icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
258 ns1.connector("protos").connect(ipv41.connector("node"))
259 ns1.connector("protos").connect(arp1.connector("node"))
260 ns1.connector("protos").connect(icmp1.connector("node"))
261 ns1if = ns3_desc.create("ns3::FileDescriptorNetDevice")
262 ns1if.enable_trace("FileDescriptorPcapTrace")
263 ns1if.set_attribute_value("label", "ns1if")
264 ns1.connector("devs").connect(ns1if.connector("node"))
265 tap1.connector("fd->").connect(ns1if.connector("->fd"))
266 ip1 = ns1if.add_address()
267 ip1.set_attribute_value("Address", "192.168.2.3")
268 ip1.set_attribute_value("NetPrefix", 24)
269 ip1.set_attribute_value("Broadcast", False)
271 # Add default route to the PL node
273 r1.set_attribute_value("Destination", "0.0.0.0")
274 r1.set_attribute_value("NetPrefix", 0)
275 r1.set_attribute_value("NextHop", "192.168.2.2")
277 # Create NS3 ping application, pinging the PL node
278 ping = ns3_desc.create("ns3::V4Ping")
279 ping.set_attribute_value("Remote", "{#[node2iface].addr[0].[Address]#}")
280 ping.set_attribute_value("StartTime", "0s")
281 ping.set_attribute_value("StopTime", "10s")
282 ping.connector("node").connect(ns1.connector("apps"))
287 controller = ExperimentController(xml, self.root_dir)
290 while not controller.is_finished(ping.guid):
293 tap_trace = controller.trace(tap1.guid, "packets")
297 controller.shutdown()
299 # asserts at the end, to make sure there's proper cleanup
302 for seq in xrange(10):
304 [0-9.:]* IP 192.168.2.3 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*
305 .*""" % dict(seq=seq)
308 [0-9.:]* IP 192.168.2.3 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*.*
309 [0-9.:]* IP (\d*\.){3}\d* > 192.168.2.3: ICMP echo reply, id 0, seq %(seq)d, length \d*
310 .*""" % dict(seq=seq)
312 sent += bool(re.match(re_send, tap_trace, re.MULTILINE|re.DOTALL))
313 replied += bool(re.match(re_reply, tap_trace, re.MULTILINE|re.DOTALL))
315 self.assertTrue(sent == replied and sent > 5,
316 "Unexpected trace:\n%s\n" % (
319 def _test_ns3_in_pl_p2p(self, proto):
320 pl, exp = self.make_experiment_desc()
322 # Create PL node, ifaces, assign addresses
323 node1, iface1, (tap0,tap1), (tap0ip,tap1ip), inet = self.make_pl_tapnode(pl,
324 label="node1", hostname = self.host1,
325 ip=["192.168.2.2","192.168.2.5"])
326 node2, iface2, (tap2,tap3), (tap2ip,tap3ip), inet = self.make_pl_tapnode(pl, inet=inet,
327 label="node2", hostname = self.host2,
328 ip=["192.168.2.6","192.168.2.9"])
329 node3, iface3, tap4, tap4ip, inet = self.make_pl_tapnode(pl, inet=inet,
330 label="node3", hostname = self.host3,
333 # Add NS3 support in node1
334 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-4-%s" % (proto,))
336 # Configure P2P links
337 tap0.set_attribute_value("pointopoint", "192.168.2.1") # cross-p2p is not automatic
338 tap1.connector(proto).connect(tap2.connector(proto))
339 tap3.connector(proto).connect(tap4.connector(proto))
342 r = node1.add_route()
343 r.set_attribute_value("Destination", "192.168.2.8")
344 r.set_attribute_value("NetPrefix", 29)
345 r.set_attribute_value("NextHop", "192.168.2.6")
347 r = node2.add_route()
348 r.set_attribute_value("Destination", "192.168.2.0")
349 r.set_attribute_value("NetPrefix", 29)
350 r.set_attribute_value("NextHop", "192.168.2.5")
352 r = node3.add_route()
353 r.set_attribute_value("Destination", "192.168.2.0")
354 r.set_attribute_value("NetPrefix", 29)
355 r.set_attribute_value("NextHop", "192.168.2.9")
357 # Create NS3 node that is responsive to pings, connected
358 # to node1 through the Tap interface
359 ns1 = ns3_desc.create("ns3::Node")
360 ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
361 arp1 = ns3_desc.create("ns3::ArpL3Protocol")
362 icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
363 ns1.connector("protos").connect(ipv41.connector("node"))
364 ns1.connector("protos").connect(arp1.connector("node"))
365 ns1.connector("protos").connect(icmp1.connector("node"))
366 ns1if = ns3_desc.create("ns3::FileDescriptorNetDevice")
367 ns1if.enable_trace("FileDescriptorPcapTrace")
368 ns1if.set_attribute_value("label", "ns1if")
369 ns1.connector("devs").connect(ns1if.connector("node"))
370 tap0.connector("fd->").connect(ns1if.connector("->fd"))
371 ip1 = ns1if.add_address()
372 ip1.set_attribute_value("Address", "192.168.2.1")
373 ip1.set_attribute_value("NetPrefix", 30)
374 ip1.set_attribute_value("Broadcast", False)
376 # Add default route to the PL node
378 r1.set_attribute_value("Destination", "0.0.0.0")
379 r1.set_attribute_value("NetPrefix", 0)
380 r1.set_attribute_value("NextHop", "192.168.2.2")
382 # Create NS3 ping application, pinging the PL node
383 ping = ns3_desc.create("ns3::V4Ping")
384 ping.set_attribute_value("Remote", "{#[node3tap].addr[0].[Address]#}")
385 ping.set_attribute_value("StartTime", "0s")
386 ping.set_attribute_value("StopTime", "10s")
387 ping.connector("node").connect(ns1.connector("apps"))
392 controller = ExperimentController(xml, self.root_dir)
395 while not controller.is_finished(ping.guid):
399 for i,tap in enumerate([ tap0, tap1, tap2, tap3, tap4 ]):
400 tap_trace.append("\nTrace for tap%d:\n" % i)
401 tap_trace.append(controller.trace(tap.guid, "packets"))
402 tap_trace = "".join(tap_trace)
403 tap0_trace = controller.trace(tap0.guid, "packets")
407 controller.shutdown()
409 # asserts at the end, to make sure there's proper cleanup
412 for seq in xrange(10):
414 [0-9.:]* IP 192.168.2.1 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*
415 .*""" % dict(seq=seq)
418 [0-9.:]* IP 192.168.2.1 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*.*
419 [0-9.:]* IP (\d*\.){3}\d* > 192.168.2.1: ICMP echo reply, id 0, seq %(seq)d, length \d*
420 .*""" % dict(seq=seq)
422 sent += bool(re.match(re_send, tap0_trace, re.MULTILINE|re.DOTALL))
423 replied += bool(re.match(re_reply, tap0_trace, re.MULTILINE|re.DOTALL))
425 self.assertTrue(replied >= sent/2 and sent > 5,
426 "Unexpected trace:\n%s\n" % (
430 @test_util.skipUnless(test_util.pl_auth() is not None,
431 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
432 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
433 "Test is expensive, requires NEPI_FULL_TESTS=yes")
434 def test_ns3_in_pl_p2p_udp(self):
435 self._test_ns3_in_pl_p2p("udp")
437 @test_util.skipUnless(test_util.pl_auth() is not None,
438 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
439 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
440 "Test is expensive, requires NEPI_FULL_TESTS=yes")
441 def test_ns3_in_pl_p2p_tcp(self):
442 self._test_ns3_in_pl_p2p("tcp")
444 if __name__ == '__main__':