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"
27 self.root_dir = tempfile.mkdtemp()
31 shutil.rmtree(self.root_dir)
35 shutil.rmtree(self.root_dir)
37 def make_experiment_desc(self):
38 testbed_id = self.testbed_id
39 testbed_version = self.testbed_version
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, testbed_version)
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):
60 node1 = pl.create("Node")
61 node1.set_attribute_value("hostname", self.host1)
62 node1.set_attribute_value("label", "node1")
63 node1.set_attribute_value("emulation", True) # require emulation
64 iface1 = pl.create("NodeInterface")
65 iface1.set_attribute_value("label", "node1iface")
66 tap1 = pl.create("TapInterface")
67 tap1.enable_trace("packets") # for error output
68 tap1.set_attribute_value("label", "node1tap")
69 inet = pl.create("Internet")
70 node1.connector("devs").connect(iface1.connector("node"))
71 node1.connector("devs").connect(tap1.connector("node"))
72 iface1.connector("inet").connect(inet.connector("devs"))
74 tap1ip = tap1.add_address()
75 tap1ip.set_attribute_value("Address", "192.168.2.2")
76 tap1ip.set_attribute_value("NetPrefix", 24)
77 tap1ip.set_attribute_value("Broadcast", False)
79 return node1, iface1, tap1, tap1ip, inet
81 def make_ns_in_pl(self, pl, exp, node1, iface1, root):
82 ns3_testbed_id = "ns3"
83 ns3_testbed_version = "3_9_RC3"
85 # Add NS3 support in node1
86 plnepi = pl.create("NepiDependency")
87 plns3 = pl.create("NS3Dependency")
88 plnepi.connector("node").connect(node1.connector("deps"))
89 plns3.connector("node").connect(node1.connector("deps"))
91 # Create NS3 testbed running in node1
92 ns3_provider = FactoriesProvider(ns3_testbed_id, ns3_testbed_version)
93 ns3_desc = exp.add_testbed_description(ns3_provider)
94 ns3_desc.set_attribute_value("rootDirectory", root)
95 ns3_desc.set_attribute_value("SimulatorImplementationType", "ns3::RealtimeSimulatorImpl")
96 ns3_desc.set_attribute_value("ChecksumEnabled", True)
97 ns3_desc.set_attribute_value(DC.DEPLOYMENT_HOST, "{#[%s].addr[0].[Address]#}" % (
98 iface1.get_attribute_value("label"),))
99 ns3_desc.set_attribute_value(DC.DEPLOYMENT_USER,
100 pl.get_attribute_value("slice"))
101 ns3_desc.set_attribute_value(DC.DEPLOYMENT_KEY,
102 pl.get_attribute_value("sliceSSHKey"))
103 ns3_desc.set_attribute_value(DC.DEPLOYMENT_MODE, DC.MODE_DAEMON)
104 ns3_desc.set_attribute_value(DC.DEPLOYMENT_COMMUNICATION, DC.ACCESS_SSH)
105 ns3_desc.set_attribute_value(DC.DEPLOYMENT_ENVIRONMENT_SETUP,
107 node1.get_attribute_value("label"),
108 ATTR_NEPI_TESTBED_ENVIRONMENT_SETUP,))
109 ns3_desc.set_attribute_value(DC.LOG_LEVEL, DC.DEBUG_LEVEL)
114 @test_util.skipUnless(test_util.pl_auth() is not None,
115 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
116 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
117 "Test is expensive, requires NEPI_FULL_TESTS=yes")
118 def test_ns3_in_pl(self):
119 ns3_testbed_id = "ns3"
120 ns3_testbed_version = "3_9_RC3"
122 pl, exp = self.make_experiment_desc()
124 node1 = pl.create("Node")
125 node1.set_attribute_value("hostname", self.host1)
126 node1.set_attribute_value("label", "node1")
127 iface1 = pl.create("NodeInterface")
128 iface1.set_attribute_value("label", "node1iface")
129 inet = pl.create("Internet")
130 node1.connector("devs").connect(iface1.connector("node"))
131 iface1.connector("inet").connect(inet.connector("devs"))
133 # Add NS3 support in node1
134 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-1")
138 controller = ExperimentController(xml, self.root_dir)
140 # just test that it starts...
142 controller.shutdown()
144 @test_util.skipUnless(test_util.pl_auth() is not None,
145 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
146 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
147 "Test is expensive, requires NEPI_FULL_TESTS=yes")
148 def test_ns3_in_pl_crossconnect(self):
149 pl, exp = self.make_experiment_desc()
151 # Create PL node, ifaces, assign addresses
152 node1, iface1, tap1, tap1ip, inet = self.make_pl_tapnode(pl)
154 # Add NS3 support in node1
155 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-2")
157 # Create NS3 node that is responsive to pings, connected
158 # to node1 through the Tap interface
159 ns1 = ns3_desc.create("ns3::Node")
160 ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
161 arp1 = ns3_desc.create("ns3::ArpL3Protocol")
162 icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
163 ns1.connector("protos").connect(ipv41.connector("node"))
164 ns1.connector("protos").connect(arp1.connector("node"))
165 ns1.connector("protos").connect(icmp1.connector("node"))
166 ns1if = ns3_desc.create("ns3::FileDescriptorNetDevice")
167 ns1if.enable_trace("FileDescriptorPcapTrace")
168 ns1if.set_attribute_value("label", "ns1if")
169 ns1.connector("devs").connect(ns1if.connector("node"))
170 tap1.connector("fd->").connect(ns1if.connector("->fd"))
171 ip1 = ns1if.add_address()
172 ip1.set_attribute_value("Address", "192.168.2.3")
173 ip1.set_attribute_value("NetPrefix", 24)
174 ip1.set_attribute_value("Broadcast", False)
176 # Create PlanetLab ping application, pinging the NS3 node
177 ping = pl.create("Application")
178 ping.set_attribute_value("command", "ping -qc10 {#[ns1if].addr[0].[Address]#}")
179 ping.enable_trace("stdout")
180 ping.enable_trace("stderr")
181 ping.connector("node").connect(node1.connector("apps"))
183 comp_result = r"""PING .* \(.*\) \d*\(\d*\) bytes of data.
185 --- .* ping statistics ---
186 10 packets transmitted, 10 received, 0% packet loss, time \d*ms.*
191 controller = ExperimentController(xml, self.root_dir)
194 while not controller.is_finished(ping.guid):
197 ping_result = controller.trace(pl.guid, ping.guid, "stdout")
198 tap_trace = controller.trace(pl.guid, tap1.guid, "packets")
201 controller.shutdown()
203 # asserts at the end, to make sure there's proper cleanup
204 self.assertTrue(re.match(comp_result, ping_result, re.MULTILINE),
205 "Unexpected trace:\n%s\nTap trace:\n%s\n" % (
209 @test_util.skipUnless(test_util.pl_auth() is not None,
210 "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
211 @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
212 "Test is expensive, requires NEPI_FULL_TESTS=yes")
213 def test_ns3_in_pl_snat(self):
214 pl, exp = self.make_experiment_desc()
216 # Create PL node, ifaces, assign addresses
217 node1, iface1, tap1, tap1ip, inet = self.make_pl_tapnode(pl)
219 # Add NS3 support in node1
220 ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-3")
223 tap1.set_attribute_value("snat", True)
225 # Add second PL node (ping target)
226 #node2 = pl.create("Node")
227 #node2.set_attribute_value("hostname", self.host2)
228 #node2.set_attribute_value("label", "node2")
229 #iface2 = pl.create("NodeInterface")
230 #iface2.set_attribute_value("label", "node2iface")
231 #node2.connector("devs").connect(iface2.connector("node"))
232 #iface2.connector("inet").connect(inet.connector("devs"))
234 # Create NS3 node that is responsive to pings, connected
235 # to node1 through the Tap interface
236 ns1 = ns3_desc.create("ns3::Node")
237 ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
238 arp1 = ns3_desc.create("ns3::ArpL3Protocol")
239 icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
240 ns1.connector("protos").connect(ipv41.connector("node"))
241 ns1.connector("protos").connect(arp1.connector("node"))
242 ns1.connector("protos").connect(icmp1.connector("node"))
243 ns1if = ns3_desc.create("ns3::FileDescriptorNetDevice")
244 ns1if.enable_trace("FileDescriptorPcapTrace")
245 ns1if.set_attribute_value("label", "ns1if")
246 ns1.connector("devs").connect(ns1if.connector("node"))
247 tap1.connector("fd->").connect(ns1if.connector("->fd"))
248 ip1 = ns1if.add_address()
249 ip1.set_attribute_value("Address", "192.168.2.3")
250 ip1.set_attribute_value("NetPrefix", 24)
251 ip1.set_attribute_value("Broadcast", False)
253 # Add default route to the PL node
255 r1.set_attribute_value("Destination", "0.0.0.0")
256 r1.set_attribute_value("NetPrefix", 0)
257 r1.set_attribute_value("NextHop", "192.168.2.2")
259 # Create NS3 ping application, pinging the PL node
260 ping = ns3_desc.create("ns3::V4Ping")
261 ping.set_attribute_value("Remote", "209.85.146.147") #"{#[node2iface].addr[0].[Address]#}")
262 ping.set_attribute_value("StartTime", "0s")
263 ping.set_attribute_value("StopTime", "10s")
264 ping.connector("node").connect(ns1.connector("apps"))
268 controller = ExperimentController(xml, self.root_dir)
271 while not controller.is_finished(ping.guid):
274 tap_trace = controller.trace(pl.guid, tap1.guid, "packets")
277 controller.shutdown()
279 # asserts at the end, to make sure there's proper cleanup
282 for seq in xrange(10):
284 [0-9.:]* IP 192.168.2.3 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*
285 .*""" % dict(seq=seq)
288 [0-9.:]* IP 192.168.2.3 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*.*
289 [0-9.:]* IP (\d*\.){3}\d* > 192.168.2.3: ICMP echo reply, id 0, seq %(seq)d, length \d*
290 .*""" % dict(seq=seq)
292 sent += bool(re.match(re_send, tap_trace, re.MULTILINE|re.DOTALL))
293 replied += bool(re.match(re_reply, tap_trace, re.MULTILINE|re.DOTALL))
295 self.assertTrue(sent == replied and sent > 5,
296 "Unexpected trace:\n%s\n" % (
299 if __name__ == '__main__':