test/testbeds/planetlab/integration_ns3.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 import getpass
   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
   9 import os
  10 import shutil
  11 import tempfile
  12 import test_util
  13 import time
  14 import unittest
  15 import re
  16
  17 class PlanetLabCrossIntegrationTestCase(unittest.TestCase):
  18     testbed_id = "planetlab"
  19     testbed_version = "01"
  20     slicename = "inria_nepi"
  21     plchost = "nepiplc.pl.sophia.inria.fr"
  22
  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"
  27
  28     def setUp(self):
  29         self.root_dir = tempfile.mkdtemp()
  30
  31     def tearDown(self):
  32         try:
  33             shutil.rmtree(self.root_dir)
  34         except:
  35             # retry
  36             time.sleep(0.1)
  37             shutil.rmtree(self.root_dir)
  38
  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(
  45             "PL_SSH_KEY",
  46             "%s/.ssh/id_rsa_planetlab" % (os.environ['HOME'],) )
  47         pl_user, pl_pwd = test_util.pl_auth()
  48
  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)
  58
  59         return pl_desc, exp_desc
  60
  61     def make_pl_tapnode(self, pl, ip = "192.168.2.2", inet = None, label = "node1", hostname = None):
  62         if not isinstance(ip, list):
  63             ips = [ip]
  64         else:
  65             ips = ip
  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")
  72         tap1 = []
  73         tap1ip = []
  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 ""))
  78
  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)
  83
  84             node1.connector("devs").connect(_tap1.connector("node"))
  85
  86             tap1.append(_tap1)
  87             tap1ip.append(_tap1ip)
  88
  89         inet = inet or pl.create("Internet")
  90         node1.connector("devs").connect(iface1.connector("node"))
  91         iface1.connector("inet").connect(inet.connector("devs"))
  92
  93         if len(tap1) == 1:
  94             tap1 = tap1[0]
  95         if len(tap1ip) == 1:
  96             tap1ip = tap1ip[0]
  97
  98         return node1, iface1, tap1, tap1ip, inet
  99
 100     def make_ns_in_pl(self, pl, exp, node1, iface1, root):
 101         ns3_testbed_id = "ns3"
 102         ns3_testbed_version = "3_9_RC3"
 103
 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"))
 109
 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,
 125             "{#[%s].[%s]#}" % (
 126                 node1.get_attribute_value("label"),
 127                 ATTR_NEPI_TESTBED_ENVIRONMENT_SETUP,))
 128         ns3_desc.set_attribute_value(DC.LOG_LEVEL, DC.DEBUG_LEVEL)
 129
 130         return ns3_desc
 131
 132
 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_RC3"
 140
 141         pl, exp = self.make_experiment_desc()
 142
 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"))
 151
 152         # Add NS3 support in node1
 153         ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-1")
 154
 155         xml = exp.to_xml()
 156
 157         controller = ExperimentController(xml, self.root_dir)
 158         controller.start()
 159         # just test that it starts...
 160         controller.stop()
 161         controller.shutdown()
 162
 163     @test_util.skipUnless(test_util.pl_auth() is not None,
 164         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
 165     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
 166         "Test is expensive, requires NEPI_FULL_TESTS=yes")
 167     def test_ns3_in_pl_crossconnect(self):
 168         pl, exp = self.make_experiment_desc()
 169
 170         # Create PL node, ifaces, assign addresses
 171         node1, iface1, tap1, tap1ip, inet = self.make_pl_tapnode(pl)
 172
 173         # Add NS3 support in node1
 174         ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-2")
 175
 176         # Create NS3 node that is responsive to pings, connected
 177         # to node1 through the Tap interface
 178         ns1 = ns3_desc.create("ns3::Node")
 179         ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
 180         arp1  = ns3_desc.create("ns3::ArpL3Protocol")
 181         icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
 182         ns1.connector("protos").connect(ipv41.connector("node"))
 183         ns1.connector("protos").connect(arp1.connector("node"))
 184         ns1.connector("protos").connect(icmp1.connector("node"))
 185         ns1if = ns3_desc.create("ns3::FileDescriptorNetDevice")
 186         ns1if.enable_trace("FileDescriptorPcapTrace")
 187         ns1if.set_attribute_value("label", "ns1if")
 188         ns1.connector("devs").connect(ns1if.connector("node"))
 189         tap1.connector("fd->").connect(ns1if.connector("->fd"))
 190         ip1 = ns1if.add_address()
 191         ip1.set_attribute_value("Address", "192.168.2.3")
 192         ip1.set_attribute_value("NetPrefix", 24)
 193         ip1.set_attribute_value("Broadcast", False)
 194
 195         # Create PlanetLab ping application, pinging the NS3 node
 196         ping = pl.create("Application")
 197         ping.set_attribute_value("command", "ping -qc10 {#[ns1if].addr[0].[Address]#}")
 198         ping.enable_trace("stdout")
 199         ping.enable_trace("stderr")
 200         ping.connector("node").connect(node1.connector("apps"))
 201
 202         comp_result = r"""PING .* \(.*\) \d*\(\d*\) bytes of data.
 203
 204 --- .* ping statistics ---
 205 10 packets transmitted, 10 received, 0% packet loss, time \d*ms.*
 206 """
 207
 208         xml = exp.to_xml()
 209
 210         controller = ExperimentController(xml, self.root_dir)
 211         controller.start()
 212
 213         while not controller.is_finished(ping.guid):
 214             time.sleep(0.5)
 215
 216         ping_result = controller.trace(ping.guid, "stdout")
 217         tap_trace = controller.trace(tap1.guid, "packets")
 218
 219         controller.stop()
 220         controller.shutdown()
 221
 222         # asserts at the end, to make sure there's proper cleanup
 223         self.assertTrue(re.match(comp_result, ping_result, re.MULTILINE),
 224             "Unexpected trace:\n%s\nTap trace:\n%s\n" % (
 225                 ping_result,
 226                 tap_trace) )
 227
 228     @test_util.skipUnless(test_util.pl_auth() is not None,
 229         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
 230     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
 231         "Test is expensive, requires NEPI_FULL_TESTS=yes")
 232     def test_ns3_in_pl_snat(self):
 233         pl, exp = self.make_experiment_desc()
 234
 235         # Create PL node, ifaces, assign addresses
 236         node1, iface1, tap1, tap1ip, inet = self.make_pl_tapnode(pl)
 237
 238         # Add NS3 support in node1
 239         ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-3")
 240
 241         # Enable SNAT
 242         tap1.set_attribute_value("snat", True)
 243
 244         # Add second PL node (ping target)
 245         node2 = pl.create("Node")
 246         node2.set_attribute_value("hostname", self.host2)
 247         node2.set_attribute_value("label", "node2")
 248         iface2 = pl.create("NodeInterface")
 249         iface2.set_attribute_value("label", "node2iface")
 250         node2.connector("devs").connect(iface2.connector("node"))
 251         iface2.connector("inet").connect(inet.connector("devs"))
 252
 253         # Create NS3 node that is responsive to pings, connected
 254         # to node1 through the Tap interface
 255         ns1 = ns3_desc.create("ns3::Node")
 256         ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
 257         arp1  = ns3_desc.create("ns3::ArpL3Protocol")
 258         icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
 259         ns1.connector("protos").connect(ipv41.connector("node"))
 260         ns1.connector("protos").connect(arp1.connector("node"))
 261         ns1.connector("protos").connect(icmp1.connector("node"))
 262         ns1if = ns3_desc.create("ns3::FileDescriptorNetDevice")
 263         ns1if.enable_trace("FileDescriptorPcapTrace")
 264         ns1if.set_attribute_value("label", "ns1if")
 265         ns1.connector("devs").connect(ns1if.connector("node"))
 266         tap1.connector("fd->").connect(ns1if.connector("->fd"))
 267         ip1 = ns1if.add_address()
 268         ip1.set_attribute_value("Address", "192.168.2.3")
 269         ip1.set_attribute_value("NetPrefix", 24)
 270         ip1.set_attribute_value("Broadcast", False)
 271
 272         # Add default route to the PL node
 273         r1 = ns1.add_route()
 274         r1.set_attribute_value("Destination", "0.0.0.0")
 275         r1.set_attribute_value("NetPrefix", 0)
 276         r1.set_attribute_value("NextHop", "192.168.2.2")
 277
 278         # Create NS3 ping application, pinging the PL node
 279         ping = ns3_desc.create("ns3::V4Ping")
 280         ping.set_attribute_value("Remote", "{#[node2iface].addr[0].[Address]#}")
 281         ping.set_attribute_value("StartTime", "0s")
 282         ping.set_attribute_value("StopTime", "10s")
 283         ping.connector("node").connect(ns1.connector("apps"))
 284
 285         xml = exp.to_xml()
 286
 287         controller = ExperimentController(xml, self.root_dir)
 288         controller.start()
 289
 290         while not controller.is_finished(ping.guid):
 291             time.sleep(0.5)
 292
 293         tap_trace = controller.trace(tap1.guid, "packets")
 294
 295         controller.stop()
 296         controller.shutdown()
 297
 298         # asserts at the end, to make sure there's proper cleanup
 299         sent = 0
 300         replied = 0
 301         for seq in xrange(10):
 302             re_send = r""".*
 303 [0-9.:]* IP 192.168.2.3 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*
 304 .*""" % dict(seq=seq)
 305
 306             re_reply = r""".*
 307 [0-9.:]* IP 192.168.2.3 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*.*
 308 [0-9.:]* IP (\d*\.){3}\d* > 192.168.2.3: ICMP echo reply, id 0, seq %(seq)d, length \d*
 309 .*""" % dict(seq=seq)
 310
 311             sent += bool(re.match(re_send, tap_trace, re.MULTILINE|re.DOTALL))
 312             replied += bool(re.match(re_reply, tap_trace, re.MULTILINE|re.DOTALL))
 313
 314         self.assertTrue(sent == replied and sent > 5,
 315             "Unexpected trace:\n%s\n" % (
 316                 tap_trace,) )
 317
 318     def _test_ns3_in_pl_p2p(self, proto):
 319         pl, exp = self.make_experiment_desc()
 320
 321         # Create PL node, ifaces, assign addresses
 322         node1, iface1, (tap0,tap1), (tap0ip,tap1ip), inet = self.make_pl_tapnode(pl,
 323             label="node1", hostname = self.host1,
 324             ip=["192.168.2.2","192.168.2.5"])
 325         node2, iface2, (tap2,tap3), (tap2ip,tap3ip), inet = self.make_pl_tapnode(pl, inet=inet,
 326             label="node2", hostname = self.host2,
 327             ip=["192.168.2.6","192.168.2.9"])
 328         node3, iface3, tap4, tap4ip, inet = self.make_pl_tapnode(pl, inet=inet,
 329             label="node3", hostname = self.host3,
 330             ip="192.168.2.10")
 331
 332         # Add NS3 support in node1
 333         ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-4-%s" % (proto,))
 334
 335         # Configure P2P links
 336         tap0.set_attribute_value("pointopoint", "192.168.2.1") # cross-p2p is not automatic
 337         tap1.connector(proto).connect(tap2.connector(proto))
 338         tap3.connector(proto).connect(tap4.connector(proto))
 339
 340         # Configure routes
 341         r = node1.add_route()
 342         r.set_attribute_value("Destination", "192.168.2.8")
 343         r.set_attribute_value("NetPrefix", 29)
 344         r.set_attribute_value("NextHop", "192.168.2.6")
 345
 346         r = node2.add_route()
 347         r.set_attribute_value("Destination", "192.168.2.0")
 348         r.set_attribute_value("NetPrefix", 29)
 349         r.set_attribute_value("NextHop", "192.168.2.5")
 350
 351         r = node3.add_route()
 352         r.set_attribute_value("Destination", "192.168.2.0")
 353         r.set_attribute_value("NetPrefix", 29)
 354         r.set_attribute_value("NextHop", "192.168.2.9")
 355
 356         # Create NS3 node that is responsive to pings, connected
 357         # to node1 through the Tap interface
 358         ns1 = ns3_desc.create("ns3::Node")
 359         ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
 360         arp1  = ns3_desc.create("ns3::ArpL3Protocol")
 361         icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
 362         ns1.connector("protos").connect(ipv41.connector("node"))
 363         ns1.connector("protos").connect(arp1.connector("node"))
 364         ns1.connector("protos").connect(icmp1.connector("node"))
 365         ns1if = ns3_desc.create("ns3::FileDescriptorNetDevice")
 366         ns1if.enable_trace("FileDescriptorPcapTrace")
 367         ns1if.set_attribute_value("label", "ns1if")
 368         ns1.connector("devs").connect(ns1if.connector("node"))
 369         tap0.connector("fd->").connect(ns1if.connector("->fd"))
 370         ip1 = ns1if.add_address()
 371         ip1.set_attribute_value("Address", "192.168.2.1")
 372         ip1.set_attribute_value("NetPrefix", 30)
 373         ip1.set_attribute_value("Broadcast", False)
 374
 375         # Add default route to the PL node
 376         r1 = ns1.add_route()
 377         r1.set_attribute_value("Destination", "0.0.0.0")
 378         r1.set_attribute_value("NetPrefix", 0)
 379         r1.set_attribute_value("NextHop", "192.168.2.2")
 380
 381         # Create NS3 ping application, pinging the PL node
 382         ping = ns3_desc.create("ns3::V4Ping")
 383         ping.set_attribute_value("Remote", "{#[node3tap].addr[0].[Address]#}")
 384         ping.set_attribute_value("StartTime", "0s")
 385         ping.set_attribute_value("StopTime", "10s")
 386         ping.connector("node").connect(ns1.connector("apps"))
 387
 388         xml = exp.to_xml()
 389
 390         try:
 391             controller = ExperimentController(xml, self.root_dir)
 392             controller.start()
 393
 394             while not controller.is_finished(ping.guid):
 395                 time.sleep(0.5)
 396
 397             tap_trace = []
 398             for i,tap in enumerate([ tap0, tap1, tap2, tap3, tap4 ]):
 399                 tap_trace.append("\nTrace for tap%d:\n" % i)
 400                 tap_trace.append(controller.trace(tap.guid, "packets"))
 401             tap_trace = "".join(tap_trace)
 402             tap0_trace = controller.trace(tap0.guid, "packets")
 403
 404         finally:
 405             controller.stop()
 406             controller.shutdown()
 407
 408         # asserts at the end, to make sure there's proper cleanup
 409         sent = 0
 410         replied = 0
 411         for seq in xrange(10):
 412             re_send = r""".*
 413 [0-9.:]* IP 192.168.2.1 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*
 414 .*""" % dict(seq=seq)
 415
 416             re_reply = r""".*
 417 [0-9.:]* IP 192.168.2.1 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*.*
 418 [0-9.:]* IP (\d*\.){3}\d* > 192.168.2.1: ICMP echo reply, id 0, seq %(seq)d, length \d*
 419 .*""" % dict(seq=seq)
 420
 421             sent += bool(re.match(re_send, tap0_trace, re.MULTILINE|re.DOTALL))
 422             replied += bool(re.match(re_reply, tap0_trace, re.MULTILINE|re.DOTALL))
 423
 424         self.assertTrue(replied >= sent/2 and sent > 5,
 425             "Unexpected trace:\n%s\n" % (
 426                 tap_trace,) )
 427
 428
 429     @test_util.skipUnless(test_util.pl_auth() is not None,
 430         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
 431     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
 432         "Test is expensive, requires NEPI_FULL_TESTS=yes")
 433     def test_ns3_in_pl_p2p_udp(self):
 434         self._test_ns3_in_pl_p2p("udp")
 435
 436     @test_util.skipUnless(test_util.pl_auth() is not None,
 437         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
 438     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
 439         "Test is expensive, requires NEPI_FULL_TESTS=yes")
 440     def test_ns3_in_pl_p2p_tcp(self):
 441         self._test_ns3_in_pl_p2p("tcp")
 442
 443 if __name__ == '__main__':
 444     unittest.main()
 445