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 testbed_version = "01"
20 slicename = "inria_nepi"
21 plchost = "nepiplc.pl.sophia.inria.fr"
23 host1 = "nepi1.pl.sophia.inria.fr"
24 host2 = "nepi2.pl.sophia.inria.fr"
25 host3 = "nepi3.pl.sophia.inria.fr"
26 host4 = "nepi5.pl.sophia.inria.fr"
29 self.root_dir = tempfile.mkdtemp()
33 shutil.rmtree(self.root_dir)
37 shutil.rmtree(self.root_dir)
39 def make_experiment_desc(self):
40 testbed_id = self.testbed_id
41 testbed_version = self.testbed_version
42 slicename = self.slicename
43 plchost = self.plchost
44 pl_ssh_key = os.environ.get(
46 "%s/.ssh/id_rsa_planetlab" % (os.environ['HOME'],) )
47 pl_user, pl_pwd = test_util.pl_auth()
49 exp_desc = ExperimentDescription()
50 pl_provider = FactoriesProvider(testbed_id, testbed_version)
51 pl_desc = exp_desc.add_testbed_description(pl_provider)
52 pl_desc.set_attribute_value("homeDirectory", self.root_dir)
53 pl_desc.set_attribute_value("slice", slicename)
54 pl_desc.set_attribute_value("sliceSSHKey", pl_ssh_key)
55 pl_desc.set_attribute_value("authUser", pl_user)
56 pl_desc.set_attribute_value("authPass", pl_pwd)
57 pl_desc.set_attribute_value("plcHost", plchost)
59 return pl_desc, exp_desc
61 def make_pl_tapnode(self, pl, ip = "192.168.2.2", inet = None, label = "node1", hostname = None):
62 if not isinstance(ip, list):
66 node1 = pl.create("Node")
67 node1.set_attribute_value("hostname", hostname or self.host1)
68 node1.set_attribute_value("label", label)
69 node1.set_attribute_value("emulation", True) # require emulation
70 iface1 = pl.create("NodeInterface")
71 iface1.set_attribute_value("label", label+"iface")
74 for i,ip in enumerate(ips):
75 _tap1 = pl.create("TapInterface")
76 _tap1.enable_trace("packets") # for error output
77 _tap1.set_attribute_value("label", label+"tap"+(str(i+1) if i else ""))
79 _tap1ip = _tap1.add_address()
80 _tap1ip.set_attribute_value("Address", ip)
81 _tap1ip.set_attribute_value("NetPrefix", 24)
82 _tap1ip.set_attribute_value("Broadcast", False)
84 node1.connector("devs").connect(_tap1.connector("node"))
87 tap1ip.append(_tap1ip)
89 inet = inet or pl.create("Internet")
90 node1.connector("devs").connect(iface1.connector("node"))
91 iface1.connector("inet").connect(inet.connector("devs"))
98 return node1, iface1, tap1, tap1ip, inet
100 def make_ns_in_pl(self, pl, exp, node1, iface1, root):
101 ns3_testbed_id = "ns3"
102 ns3_testbed_version = "3_9"
104 # Add NS3 support in node1
105 plnepi = pl.create("NepiDependency")
106 plns3 = pl.create("NS3Dependency")
107 plnepi.connector("node").connect(node1.connector("deps"))
108 plns3.connector("node").connect(node1.connector("deps"))
110 # Create NS3 testbed running in node1
111 ns3_provider = FactoriesProvider(ns3_testbed_id, ns3_testbed_version)
112 ns3_desc = exp.add_testbed_description(ns3_provider)
113 ns3_desc.set_attribute_value("rootDirectory", root)
114 ns3_desc.set_attribute_value("SimulatorImplementationType", "ns3::RealtimeSimulatorImpl")
115 ns3_desc.set_attribute_value("ChecksumEnabled", True)
116 ns3_desc.set_attribute_value(DC.DEPLOYMENT_HOST, "{#[%s].addr[0].[Address]#}" % (
117 iface1.get_attribute_value("label"),))
118 ns3_desc.set_attribute_value(DC.DEPLOYMENT_USER,
119 pl.get_attribute_value("slice"))
120 ns3_desc.set_attribute_value(DC.DEPLOYMENT_KEY,
121 pl.get_attribute_value("sliceSSHKey"))
122 ns3_desc.set_attribute_value(DC.DEPLOYMENT_MODE, DC.MODE_DAEMON)
123 ns3_desc.set_attribute_value(DC.DEPLOYMENT_COMMUNICATION, DC.ACCESS_SSH)
124 ns3_desc.set_attribute_value(DC.DEPLOYMENT_ENVIRONMENT_SETUP,
126 node1.get_attribute_value("label"),
127 ATTR_NEPI_TESTBED_ENVIRONMENT_SETUP,))
128 ns3_desc.set_attribute_value(DC.LOG_LEVEL, DC.DEBUG_LEVEL)
133 @test_util.skipUnless(test_util.pl_auth() is not None,
134 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
135 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
136 "Test is expensive, requires NEPI_FULL_TESTS=yes")
137 def test_ns3_in_pl(self):
138 ns3_testbed_id = "ns3"
139 ns3_testbed_version = "3_9"
141 pl, exp = self.make_experiment_desc()
143 node1 = pl.create("Node")
144 node1.set_attribute_value("hostname", self.host1)
145 node1.set_attribute_value("label", "node1")
146 iface1 = pl.create("NodeInterface")
147 iface1.set_attribute_value("label", "node1iface")
148 inet = pl.create("Internet")
149 node1.connector("devs").connect(iface1.connector("node"))
150 iface1.connector("inet").connect(inet.connector("devs"))
152 # Add NS3 support in node1
153 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-1")
158 controller = ExperimentController(xml, self.root_dir)
160 # just test that it starts...
163 controller.shutdown()
165 @test_util.skipUnless(test_util.pl_auth() is not None,
166 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
167 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
168 "Test is expensive, requires NEPI_FULL_TESTS=yes")
169 def test_ns3_in_pl_crossconnect(self):
170 pl, exp = self.make_experiment_desc()
172 # Create PL node, ifaces, assign addresses
173 node1, iface1, tap1, tap1ip, inet = self.make_pl_tapnode(pl)
175 # Add NS3 support in node1
176 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-2")
178 # Create NS3 node that is responsive to pings, connected
179 # to node1 through the Tap interface
180 ns1 = ns3_desc.create("ns3::Node")
181 ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
182 arp1 = ns3_desc.create("ns3::ArpL3Protocol")
183 icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
184 ns1.connector("protos").connect(ipv41.connector("node"))
185 ns1.connector("protos").connect(arp1.connector("node"))
186 ns1.connector("protos").connect(icmp1.connector("node"))
187 ns1if = ns3_desc.create("ns3::FileDescriptorNetDevice")
188 ns1if.enable_trace("FileDescriptorPcapTrace")
189 ns1if.set_attribute_value("label", "ns1if")
190 ns1.connector("devs").connect(ns1if.connector("node"))
191 tap1.connector("fd->").connect(ns1if.connector("->fd"))
192 ip1 = ns1if.add_address()
193 ip1.set_attribute_value("Address", "192.168.2.3")
194 ip1.set_attribute_value("NetPrefix", 24)
195 ip1.set_attribute_value("Broadcast", False)
197 # Create PlanetLab ping application, pinging the NS3 node
198 ping = pl.create("Application")
199 ping.set_attribute_value("command", "ping -qc10 {#[ns1if].addr[0].[Address]#}")
200 ping.enable_trace("stdout")
201 ping.enable_trace("stderr")
202 ping.connector("node").connect(node1.connector("apps"))
204 comp_result = r"""PING .* \(.*\) \d*\(\d*\) bytes of data.
206 --- .* ping statistics ---
207 10 packets transmitted, 10 received, 0% packet loss, time \d*ms.*
213 controller = ExperimentController(xml, self.root_dir)
216 while not controller.is_finished(ping.guid):
219 ping_result = controller.trace(ping.guid, "stdout")
220 tap_trace = controller.trace(tap1.guid, "packets")
224 controller.shutdown()
226 # asserts at the end, to make sure there's proper cleanup
227 self.assertTrue(re.match(comp_result, ping_result, re.MULTILINE),
228 "Unexpected trace:\n%s\nTap trace:\n%s\n" % (
232 @test_util.skipUnless(test_util.pl_auth() is not None,
233 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
234 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
235 "Test is expensive, requires NEPI_FULL_TESTS=yes")
236 def test_ns3_in_pl_snat(self):
237 pl, exp = self.make_experiment_desc()
239 # Create PL node, ifaces, assign addresses
240 node1, iface1, tap1, tap1ip, inet = self.make_pl_tapnode(pl)
242 # Add NS3 support in node1
243 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-3")
246 tap1.set_attribute_value("snat", True)
248 # Add second PL node (ping target)
249 node2 = pl.create("Node")
250 node2.set_attribute_value("hostname", self.host2)
251 node2.set_attribute_value("label", "node2")
252 iface2 = pl.create("NodeInterface")
253 iface2.set_attribute_value("label", "node2iface")
254 node2.connector("devs").connect(iface2.connector("node"))
255 iface2.connector("inet").connect(inet.connector("devs"))
257 # Create NS3 node that is responsive to pings, connected
258 # to node1 through the Tap interface
259 ns1 = ns3_desc.create("ns3::Node")
260 ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
261 arp1 = ns3_desc.create("ns3::ArpL3Protocol")
262 icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
263 ns1.connector("protos").connect(ipv41.connector("node"))
264 ns1.connector("protos").connect(arp1.connector("node"))
265 ns1.connector("protos").connect(icmp1.connector("node"))
266 ns1if = ns3_desc.create("ns3::FileDescriptorNetDevice")
267 ns1if.enable_trace("FileDescriptorPcapTrace")
268 ns1if.set_attribute_value("label", "ns1if")
269 ns1.connector("devs").connect(ns1if.connector("node"))
270 tap1.connector("fd->").connect(ns1if.connector("->fd"))
271 ip1 = ns1if.add_address()
272 ip1.set_attribute_value("Address", "192.168.2.3")
273 ip1.set_attribute_value("NetPrefix", 24)
274 ip1.set_attribute_value("Broadcast", False)
276 # Add default route to the PL node
278 r1.set_attribute_value("Destination", "0.0.0.0")
279 r1.set_attribute_value("NetPrefix", 0)
280 r1.set_attribute_value("NextHop", "192.168.2.2")
282 # Create NS3 ping application, pinging the PL node
283 ping = ns3_desc.create("ns3::V4Ping")
284 ping.set_attribute_value("Remote", "{#[node2iface].addr[0].[Address]#}")
285 ping.set_attribute_value("StartTime", "0s")
286 ping.set_attribute_value("StopTime", "10s")
287 ping.connector("node").connect(ns1.connector("apps"))
292 controller = ExperimentController(xml, self.root_dir)
295 while not controller.is_finished(ping.guid):
298 tap_trace = controller.trace(tap1.guid, "packets")
302 controller.shutdown()
304 # asserts at the end, to make sure there's proper cleanup
307 for seq in xrange(10):
309 [0-9.:]* IP 192.168.2.3 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*
310 .*""" % dict(seq=seq)
313 [0-9.:]* IP 192.168.2.3 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*.*
314 [0-9.:]* IP (\d*\.){3}\d* > 192.168.2.3: ICMP echo reply, id 0, seq %(seq)d, length \d*
315 .*""" % dict(seq=seq)
317 sent += bool(re.match(re_send, tap_trace, re.MULTILINE|re.DOTALL))
318 replied += bool(re.match(re_reply, tap_trace, re.MULTILINE|re.DOTALL))
320 self.assertTrue(sent == replied and sent > 5,
321 "Unexpected trace:\n%s\n" % (
324 def _test_ns3_in_pl_p2p(self, proto):
325 pl, exp = self.make_experiment_desc()
327 # Create PL node, ifaces, assign addresses
328 node1, iface1, (tap0,tap1), (tap0ip,tap1ip), inet = self.make_pl_tapnode(pl,
329 label="node1", hostname = self.host1,
330 ip=["192.168.2.2","192.168.2.5"])
331 node2, iface2, (tap2,tap3), (tap2ip,tap3ip), inet = self.make_pl_tapnode(pl, inet=inet,
332 label="node2", hostname = self.host2,
333 ip=["192.168.2.6","192.168.2.9"])
334 node3, iface3, tap4, tap4ip, inet = self.make_pl_tapnode(pl, inet=inet,
335 label="node3", hostname = self.host3,
338 # Add NS3 support in node1
339 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-4-%s" % (proto,))
341 # Configure P2P links
342 tap0.set_attribute_value("pointopoint", "192.168.2.1") # cross-p2p is not automatic
343 tap1.connector(proto).connect(tap2.connector(proto))
344 tap3.connector(proto).connect(tap4.connector(proto))
347 r = node1.add_route()
348 r.set_attribute_value("Destination", "192.168.2.8")
349 r.set_attribute_value("NetPrefix", 29)
350 r.set_attribute_value("NextHop", "192.168.2.6")
352 r = node2.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.5")
357 r = node3.add_route()
358 r.set_attribute_value("Destination", "192.168.2.0")
359 r.set_attribute_value("NetPrefix", 29)
360 r.set_attribute_value("NextHop", "192.168.2.9")
362 # Create NS3 node that is responsive to pings, connected
363 # to node1 through the Tap interface
364 ns1 = ns3_desc.create("ns3::Node")
365 ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
366 arp1 = ns3_desc.create("ns3::ArpL3Protocol")
367 icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
368 ns1.connector("protos").connect(ipv41.connector("node"))
369 ns1.connector("protos").connect(arp1.connector("node"))
370 ns1.connector("protos").connect(icmp1.connector("node"))
371 ns1if = ns3_desc.create("ns3::FileDescriptorNetDevice")
372 ns1if.enable_trace("FileDescriptorPcapTrace")
373 ns1if.set_attribute_value("label", "ns1if")
374 ns1.connector("devs").connect(ns1if.connector("node"))
375 tap0.connector("fd->").connect(ns1if.connector("->fd"))
376 ip1 = ns1if.add_address()
377 ip1.set_attribute_value("Address", "192.168.2.1")
378 ip1.set_attribute_value("NetPrefix", 30)
379 ip1.set_attribute_value("Broadcast", False)
381 # Add default route to the PL node
383 r1.set_attribute_value("Destination", "0.0.0.0")
384 r1.set_attribute_value("NetPrefix", 0)
385 r1.set_attribute_value("NextHop", "192.168.2.2")
387 # Create NS3 ping application, pinging the PL node
388 ping = ns3_desc.create("ns3::V4Ping")
389 ping.set_attribute_value("Remote", "{#[node3tap].addr[0].[Address]#}")
390 ping.set_attribute_value("StartTime", "0s")
391 ping.set_attribute_value("StopTime", "10s")
392 ping.connector("node").connect(ns1.connector("apps"))
397 controller = ExperimentController(xml, self.root_dir)
400 while not controller.is_finished(ping.guid):
404 for i,tap in enumerate([ tap0, tap1, tap2, tap3, tap4 ]):
405 tap_trace.append("\nTrace for tap%d:\n" % i)
406 tap_trace.append(controller.trace(tap.guid, "packets"))
407 tap_trace = "".join(tap_trace)
408 tap0_trace = controller.trace(tap0.guid, "packets")
412 controller.shutdown()
414 # asserts at the end, to make sure there's proper cleanup
417 for seq in xrange(10):
419 [0-9.:]* IP 192.168.2.1 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*
420 .*""" % dict(seq=seq)
423 [0-9.:]* IP 192.168.2.1 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*.*
424 [0-9.:]* IP (\d*\.){3}\d* > 192.168.2.1: ICMP echo reply, id 0, seq %(seq)d, length \d*
425 .*""" % dict(seq=seq)
427 sent += bool(re.match(re_send, tap0_trace, re.MULTILINE|re.DOTALL))
428 replied += bool(re.match(re_reply, tap0_trace, re.MULTILINE|re.DOTALL))
430 self.assertTrue(replied >= sent/2 and sent > 5,
431 "Unexpected trace:\n%s\n" % (
435 @test_util.skipUnless(test_util.pl_auth() is not None,
436 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
437 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
438 "Test is expensive, requires NEPI_FULL_TESTS=yes")
439 def test_ns3_in_pl_p2p_udp(self):
440 self._test_ns3_in_pl_p2p("udp")
442 @test_util.skipUnless(test_util.pl_auth() is not None,
443 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
444 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
445 "Test is expensive, requires NEPI_FULL_TESTS=yes")
446 def test_ns3_in_pl_p2p_tcp(self):
447 self._test_ns3_in_pl_p2p("tcp")
449 if __name__ == '__main__':