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.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
  60         return pl_desc, exp_desc
  61
  62     def make_pl_tapnode(self, pl, ip = "192.168.2.2", inet = None, label = "node1", hostname = None):
  63         if not isinstance(ip, list):
  64             ips = [ip]
  65         else:
  66             ips = ip
  67         node1 = pl.create("Node")
  68         node1.set_attribute_value("hostname", hostname or self.host1)
  69         node1.set_attribute_value("label", label)
  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
 103         # Add NS3 support in node1
 104         plnepi = pl.create("NepiDependency")
 105         plns3 = pl.create("NS3Dependency")
 106         plnepi.connector("node").connect(node1.connector("deps"))
 107         plns3.connector("node").connect(node1.connector("deps"))
 108
 109         # Create NS3 testbed running in node1
 110         ns3_provider = FactoriesProvider(ns3_testbed_id)
 111         ns3_desc = exp.add_testbed_description(ns3_provider)
 112         ns3_desc.set_attribute_value("rootDirectory", root)
 113         ns3_desc.set_attribute_value("SimulatorImplementationType", "ns3::RealtimeSimulatorImpl")
 114         ns3_desc.set_attribute_value("ChecksumEnabled", True)
 115         ns3_desc.set_attribute_value(DC.DEPLOYMENT_HOST, "{#[%s].addr[0].[Address]#}" % (
 116             iface1.get_attribute_value("label"),))
 117         ns3_desc.set_attribute_value(DC.DEPLOYMENT_USER,
 118             pl.get_attribute_value("slice"))
 119         ns3_desc.set_attribute_value(DC.DEPLOYMENT_KEY,
 120             pl.get_attribute_value("sliceSSHKey"))
 121         ns3_desc.set_attribute_value(DC.DEPLOYMENT_MODE, DC.MODE_DAEMON)
 122         ns3_desc.set_attribute_value(DC.DEPLOYMENT_COMMUNICATION, DC.ACCESS_SSH)
 123         ns3_desc.set_attribute_value(DC.DEPLOYMENT_ENVIRONMENT_SETUP,
 124             "{#[%s].[%s]#}" % (
 125                 node1.get_attribute_value("label"),
 126                 ATTR_NEPI_TESTBED_ENVIRONMENT_SETUP,))
 127         ns3_desc.set_attribute_value(DC.LOG_LEVEL, DC.DEBUG_LEVEL)
 128
 129         return ns3_desc
 130
 131
 132     @test_util.skipUnless(test_util.pl_auth() is not None,
 133         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
 134     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
 135         "Test is expensive, requires NEPI_FULL_TESTS=yes")
 136     def test_ns3_in_pl(self):
 137         ns3_testbed_id = "ns3"
 138
 139         pl, exp = self.make_experiment_desc()
 140
 141         node1 = pl.create("Node")
 142         node1.set_attribute_value("hostname", self.host1)
 143         node1.set_attribute_value("label", "node1")
 144         iface1 = pl.create("NodeInterface")
 145         iface1.set_attribute_value("label", "node1iface")
 146         inet = pl.create("Internet")
 147         node1.connector("devs").connect(iface1.connector("node"))
 148         iface1.connector("inet").connect(inet.connector("devs"))
 149
 150         # Add NS3 support in node1
 151         ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-1")
 152
 153         xml = exp.to_xml()
 154
 155         try:
 156             controller = ExperimentController(xml, self.root_dir)
 157             controller.start()
 158             # just test that it starts...
 159         finally:
 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         try:
 211             controller = ExperimentController(xml, self.root_dir)
 212             controller.start()
 213
 214             while not controller.is_finished(ping.guid):
 215                 time.sleep(0.5)
 216
 217             ping_result = controller.trace(ping.guid, "stdout")
 218             tap_trace = controller.trace(tap1.guid, "packets")
 219
 220         finally:
 221             controller.stop()
 222             controller.shutdown()
 223
 224         # asserts at the end, to make sure there's proper cleanup
 225         self.assertTrue(re.match(comp_result, ping_result, re.MULTILINE),
 226             "Unexpected trace:\n%s\nTap trace:\n%s\n" % (
 227                 ping_result,
 228                 tap_trace) )
 229
 230     @test_util.skipUnless(test_util.pl_auth() is not None,
 231         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
 232     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
 233         "Test is expensive, requires NEPI_FULL_TESTS=yes")
 234     def test_ns3_in_pl_snat(self):
 235         pl, exp = self.make_experiment_desc()
 236
 237         # Create PL node, ifaces, assign addresses
 238         node1, iface1, tap1, tap1ip, inet = self.make_pl_tapnode(pl)
 239
 240         # Add NS3 support in node1
 241         ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-3")
 242
 243         # Enable SNAT
 244         tap1.set_attribute_value("snat", True)
 245
 246         # Add second PL node (ping target)
 247         node2 = pl.create("Node")
 248         node2.set_attribute_value("hostname", self.host2)
 249         node2.set_attribute_value("label", "node2")
 250         iface2 = pl.create("NodeInterface")
 251         iface2.set_attribute_value("label", "node2iface")
 252         node2.connector("devs").connect(iface2.connector("node"))
 253         iface2.connector("inet").connect(inet.connector("devs"))
 254
 255         # Create NS3 node that is responsive to pings, connected
 256         # to node1 through the Tap interface
 257         ns1 = ns3_desc.create("ns3::Node")
 258         ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
 259         arp1  = ns3_desc.create("ns3::ArpL3Protocol")
 260         icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
 261         ns1.connector("protos").connect(ipv41.connector("node"))
 262         ns1.connector("protos").connect(arp1.connector("node"))
 263         ns1.connector("protos").connect(icmp1.connector("node"))
 264         ns1if = ns3_desc.create("ns3::FileDescriptorNetDevice")
 265         ns1if.enable_trace("FileDescriptorPcapTrace")
 266         ns1if.set_attribute_value("label", "ns1if")
 267         ns1.connector("devs").connect(ns1if.connector("node"))
 268         tap1.connector("fd->").connect(ns1if.connector("->fd"))
 269         ip1 = ns1if.add_address()
 270         ip1.set_attribute_value("Address", "192.168.2.3")
 271         ip1.set_attribute_value("NetPrefix", 24)
 272         ip1.set_attribute_value("Broadcast", False)
 273
 274         # Add default route to the PL node
 275         r1 = ns1.add_route()
 276         r1.set_attribute_value("Destination", "0.0.0.0")
 277         r1.set_attribute_value("NetPrefix", 0)
 278         r1.set_attribute_value("NextHop", "192.168.2.2")
 279
 280         # Create NS3 ping application, pinging the PL node
 281         ping = ns3_desc.create("ns3::V4Ping")
 282         ping.set_attribute_value("Remote", "{#[node2iface].addr[0].[Address]#}")
 283         ping.set_attribute_value("StartTime", "0s")
 284         ping.set_attribute_value("StopTime", "10s")
 285         ping.connector("node").connect(ns1.connector("apps"))
 286
 287         xml = exp.to_xml()
 288
 289         try:
 290             controller = ExperimentController(xml, self.root_dir)
 291             controller.start()
 292
 293             while not controller.is_finished(ping.guid):
 294                 time.sleep(0.5)
 295
 296             tap_trace = controller.trace(tap1.guid, "packets")
 297
 298         finally:
 299             controller.stop()
 300             controller.shutdown()
 301
 302         # asserts at the end, to make sure there's proper cleanup
 303         sent = 0
 304         replied = 0
 305         for seq in xrange(10):
 306             re_send = r""".*
 307 [0-9.:]* IP 192.168.2.3 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*
 308 .*""" % dict(seq=seq)
 309
 310             re_reply = r""".*
 311 [0-9.:]* IP 192.168.2.3 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*.*
 312 [0-9.:]* IP (\d*\.){3}\d* > 192.168.2.3: ICMP echo reply, id 0, seq %(seq)d, length \d*
 313 .*""" % dict(seq=seq)
 314
 315             sent += bool(re.match(re_send, tap_trace, re.MULTILINE|re.DOTALL))
 316             replied += bool(re.match(re_reply, tap_trace, re.MULTILINE|re.DOTALL))
 317
 318         self.assertTrue(sent == replied and sent > 5,
 319             "Unexpected trace:\n%s\n" % (
 320                 tap_trace,) )
 321
 322     def _test_ns3_in_pl_p2p(self, proto):
 323         pl, exp = self.make_experiment_desc()
 324
 325         # Create PL node, ifaces, assign addresses
 326         node1, iface1, (tap0,tap1), (tap0ip,tap1ip), inet = self.make_pl_tapnode(pl,
 327             label="node1", hostname = self.host1,
 328             ip=["192.168.2.2","192.168.2.5"])
 329         node2, iface2, (tap2,tap3), (tap2ip,tap3ip), inet = self.make_pl_tapnode(pl, inet=inet,
 330             label="node2", hostname = self.host2,
 331             ip=["192.168.2.6","192.168.2.9"])
 332         node3, iface3, tap4, tap4ip, inet = self.make_pl_tapnode(pl, inet=inet,
 333             label="node3", hostname = self.host3,
 334             ip="192.168.2.10")
 335
 336         # Add NS3 support in node1
 337         ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-4-%s" % (proto,))
 338
 339         # Configure P2P links
 340         tap0.set_attribute_value("pointopoint", "192.168.2.1") # cross-p2p is not automatic
 341         tap1.connector(proto).connect(tap2.connector(proto))
 342         tap3.connector(proto).connect(tap4.connector(proto))
 343
 344         # Configure routes
 345         r = node1.add_route()
 346         r.set_attribute_value("Destination", "192.168.2.8")
 347         r.set_attribute_value("NetPrefix", 29)
 348         r.set_attribute_value("NextHop", "192.168.2.6")
 349
 350         r = node2.add_route()
 351         r.set_attribute_value("Destination", "192.168.2.0")
 352         r.set_attribute_value("NetPrefix", 29)
 353         r.set_attribute_value("NextHop", "192.168.2.5")
 354
 355         r = node3.add_route()
 356         r.set_attribute_value("Destination", "192.168.2.0")
 357         r.set_attribute_value("NetPrefix", 29)
 358         r.set_attribute_value("NextHop", "192.168.2.9")
 359
 360         # Create NS3 node that is responsive to pings, connected
 361         # to node1 through the Tap interface
 362         ns1 = ns3_desc.create("ns3::Node")
 363         ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
 364         arp1  = ns3_desc.create("ns3::ArpL3Protocol")
 365         icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
 366         ns1.connector("protos").connect(ipv41.connector("node"))
 367         ns1.connector("protos").connect(arp1.connector("node"))
 368         ns1.connector("protos").connect(icmp1.connector("node"))
 369         ns1if = ns3_desc.create("ns3::FileDescriptorNetDevice")
 370         ns1if.enable_trace("FileDescriptorPcapTrace")
 371         ns1if.set_attribute_value("label", "ns1if")
 372         ns1.connector("devs").connect(ns1if.connector("node"))
 373         tap0.connector("fd->").connect(ns1if.connector("->fd"))
 374         ip1 = ns1if.add_address()
 375         ip1.set_attribute_value("Address", "192.168.2.1")
 376         ip1.set_attribute_value("NetPrefix", 30)
 377         ip1.set_attribute_value("Broadcast", False)
 378
 379         # Add default route to the PL node
 380         r1 = ns1.add_route()
 381         r1.set_attribute_value("Destination", "0.0.0.0")
 382         r1.set_attribute_value("NetPrefix", 0)
 383         r1.set_attribute_value("NextHop", "192.168.2.2")
 384
 385         # Create NS3 ping application, pinging the PL node
 386         ping = ns3_desc.create("ns3::V4Ping")
 387         ping.set_attribute_value("Remote", "{#[node3tap].addr[0].[Address]#}")
 388         ping.set_attribute_value("StartTime", "0s")
 389         ping.set_attribute_value("StopTime", "10s")
 390         ping.connector("node").connect(ns1.connector("apps"))
 391
 392         xml = exp.to_xml()
 393
 394         try:
 395             controller = ExperimentController(xml, self.root_dir)
 396             controller.start()
 397
 398             while not controller.is_finished(ping.guid):
 399                 time.sleep(0.5)
 400
 401             tap_trace = []
 402             for i,tap in enumerate([ tap0, tap1, tap2, tap3, tap4 ]):
 403                 tap_trace.append("\nTrace for tap%d:\n" % i)
 404                 tap_trace.append(controller.trace(tap.guid, "packets"))
 405             tap_trace = "".join(tap_trace)
 406             tap0_trace = controller.trace(tap0.guid, "packets")
 407
 408         finally:
 409             controller.stop()
 410             controller.shutdown()
 411
 412         # asserts at the end, to make sure there's proper cleanup
 413         sent = 0
 414         replied = 0
 415         for seq in xrange(10):
 416             re_send = r""".*
 417 [0-9.:]* IP 192.168.2.1 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*
 418 .*""" % dict(seq=seq)
 419
 420             re_reply = r""".*
 421 [0-9.:]* IP 192.168.2.1 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*.*
 422 [0-9.:]* IP (\d*\.){3}\d* > 192.168.2.1: ICMP echo reply, id 0, seq %(seq)d, length \d*
 423 .*""" % dict(seq=seq)
 424
 425             sent += bool(re.match(re_send, tap0_trace, re.MULTILINE|re.DOTALL))
 426             replied += bool(re.match(re_reply, tap0_trace, re.MULTILINE|re.DOTALL))
 427
 428         self.assertTrue(replied >= sent/2 and sent > 5,
 429             "Unexpected trace:\n%s\n" % (
 430                 tap_trace,) )
 431
 432
 433     @test_util.skipUnless(test_util.pl_auth() is not None,
 434         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
 435     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
 436         "Test is expensive, requires NEPI_FULL_TESTS=yes")
 437     def test_ns3_in_pl_p2p_udp(self):
 438         self._test_ns3_in_pl_p2p("udp")
 439
 440     @test_util.skipUnless(test_util.pl_auth() is not None,
 441         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
 442     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
 443         "Test is expensive, requires NEPI_FULL_TESTS=yes")
 444     def test_ns3_in_pl_p2p_tcp(self):
 445         self._test_ns3_in_pl_p2p("tcp")
 446
 447 if __name__ == '__main__':
 448     unittest.main()
 449