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