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     def setUp(self):
  28         self.root_dir = tempfile.mkdtemp()
  29
  30     def tearDown(self):
  31         try:
  32             shutil.rmtree(self.root_dir)
  33         except:
  34             # retry
  35             time.sleep(0.1)
  36             shutil.rmtree(self.root_dir)
  37
  38     def make_experiment_desc(self):
  39         testbed_id = self.testbed_id
  40         slicename = self.slicename
  41         plchost = self.plchost
  42         pl_ssh_key = os.environ.get(
  43             "PL_SSH_KEY",
  44             "%s/.ssh/id_rsa_planetlab" % (os.environ['HOME'],) )
  45         pl_user, pl_pwd = test_util.pl_auth()
  46
  47         exp_desc = ExperimentDescription()
  48         pl_provider = FactoriesProvider(testbed_id)
  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)
  56
  57         return pl_desc, exp_desc
  58
  59     def make_pl_tapnode(self, pl, ip = "192.168.2.2", inet = None, label = "node1", hostname = None):
  60         if not isinstance(ip, list):
  61             ips = [ip]
  62         else:
  63             ips = ip
  64         node1 = pl.create("Node")
  65         node1.set_attribute_value("hostname", hostname or self.host1)
  66         node1.set_attribute_value("label", label)
  67         node1.set_attribute_value("emulation", True) # require emulation
  68         iface1 = pl.create("NodeInterface")
  69         iface1.set_attribute_value("label", label+"iface")
  70         tap1 = []
  71         tap1ip = []
  72         for i,ip in enumerate(ips):
  73             _tap1 = pl.create("TapInterface")
  74             _tap1.enable_trace("packets") # for error output
  75             _tap1.set_attribute_value("label", label+"tap"+(str(i+1) if i else ""))
  76
  77             _tap1ip = _tap1.add_address()
  78             _tap1ip.set_attribute_value("Address", ip)
  79             _tap1ip.set_attribute_value("NetPrefix", 24)
  80             _tap1ip.set_attribute_value("Broadcast", False)
  81
  82             node1.connector("devs").connect(_tap1.connector("node"))
  83
  84             tap1.append(_tap1)
  85             tap1ip.append(_tap1ip)
  86
  87         inet = inet or pl.create("Internet")
  88         node1.connector("devs").connect(iface1.connector("node"))
  89         iface1.connector("inet").connect(inet.connector("devs"))
  90
  91         if len(tap1) == 1:
  92             tap1 = tap1[0]
  93         if len(tap1ip) == 1:
  94             tap1ip = tap1ip[0]
  95
  96         return node1, iface1, tap1, tap1ip, inet
  97
  98     def make_ns_in_pl(self, pl, exp, node1, iface1, root):
  99         ns3_testbed_id = "ns3"
 100
 101         # Add NS3 support in node1
 102         plnepi = pl.create("NepiDependency")
 103         plns3 = pl.create("NS3Dependency")
 104         plnepi.connector("node").connect(node1.connector("deps"))
 105         plns3.connector("node").connect(node1.connector("deps"))
 106
 107         # Create NS3 testbed running in node1
 108         ns3_provider = FactoriesProvider(ns3_testbed_id)
 109         ns3_desc = exp.add_testbed_description(ns3_provider)
 110         ns3_desc.set_attribute_value("rootDirectory", root)
 111         ns3_desc.set_attribute_value("SimulatorImplementationType", "ns3::RealtimeSimulatorImpl")
 112         ns3_desc.set_attribute_value("ChecksumEnabled", True)
 113         ns3_desc.set_attribute_value(DC.DEPLOYMENT_HOST, "{#[%s].addr[0].[Address]#}" % (
 114             iface1.get_attribute_value("label"),))
 115         ns3_desc.set_attribute_value(DC.DEPLOYMENT_USER,
 116             pl.get_attribute_value("slice"))
 117         ns3_desc.set_attribute_value(DC.DEPLOYMENT_KEY,
 118             pl.get_attribute_value("sliceSSHKey"))
 119         ns3_desc.set_attribute_value(DC.DEPLOYMENT_MODE, DC.MODE_DAEMON)
 120         ns3_desc.set_attribute_value(DC.DEPLOYMENT_COMMUNICATION, DC.ACCESS_SSH)
 121         ns3_desc.set_attribute_value(DC.DEPLOYMENT_ENVIRONMENT_SETUP,
 122             "{#[%s].[%s]#}" % (
 123                 node1.get_attribute_value("label"),
 124                 ATTR_NEPI_TESTBED_ENVIRONMENT_SETUP,))
 125         ns3_desc.set_attribute_value(DC.LOG_LEVEL, DC.DEBUG_LEVEL)
 126
 127         return ns3_desc
 128
 129
 130     @test_util.skipUnless(test_util.pl_auth() is not None,
 131         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
 132     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
 133         "Test is expensive, requires NEPI_FULL_TESTS=yes")
 134     def test_ns3_in_pl(self):
 135         ns3_testbed_id = "ns3"
 136
 137         pl, exp = self.make_experiment_desc()
 138
 139         node1 = pl.create("Node")
 140         node1.set_attribute_value("hostname", self.host1)
 141         node1.set_attribute_value("label", "node1")
 142         iface1 = pl.create("NodeInterface")
 143         iface1.set_attribute_value("label", "node1iface")
 144         inet = pl.create("Internet")
 145         node1.connector("devs").connect(iface1.connector("node"))
 146         iface1.connector("inet").connect(inet.connector("devs"))
 147
 148         # Add NS3 support in node1
 149         ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-1")
 150
 151         xml = exp.to_xml()
 152
 153         try:
 154             controller = ExperimentController(xml, self.root_dir)
 155             controller.start()
 156             # just test that it starts...
 157         finally:
 158             controller.stop()
 159             controller.shutdown()
 160
 161     @test_util.skipUnless(test_util.pl_auth() is not None,
 162         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
 163     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
 164         "Test is expensive, requires NEPI_FULL_TESTS=yes")
 165     def test_ns3_in_pl_crossconnect(self):
 166         pl, exp = self.make_experiment_desc()
 167
 168         # Create PL node, ifaces, assign addresses
 169         node1, iface1, tap1, tap1ip, inet = self.make_pl_tapnode(pl)
 170
 171         # Add NS3 support in node1
 172         ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-2")
 173
 174         # Create NS3 node that is responsive to pings, connected
 175         # to node1 through the Tap interface
 176         ns1 = ns3_desc.create("ns3::Node")
 177         ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
 178         arp1  = ns3_desc.create("ns3::ArpL3Protocol")
 179         icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
 180         ns1.connector("protos").connect(ipv41.connector("node"))
 181         ns1.connector("protos").connect(arp1.connector("node"))
 182         ns1.connector("protos").connect(icmp1.connector("node"))
 183         ns1if = ns3_desc.create("ns3::FileDescriptorNetDevice")
 184         ns1if.enable_trace("FileDescriptorPcapTrace")
 185         ns1if.set_attribute_value("label", "ns1if")
 186         ns1.connector("devs").connect(ns1if.connector("node"))
 187         tap1.connector("fd->").connect(ns1if.connector("->fd"))
 188         ip1 = ns1if.add_address()
 189         ip1.set_attribute_value("Address", "192.168.2.3")
 190         ip1.set_attribute_value("NetPrefix", 24)
 191         ip1.set_attribute_value("Broadcast", False)
 192
 193         # Create PlanetLab ping application, pinging the NS3 node
 194         ping = pl.create("Application")
 195         ping.set_attribute_value("command", "ping -qc10 {#[ns1if].addr[0].[Address]#}")
 196         ping.enable_trace("stdout")
 197         ping.enable_trace("stderr")
 198         ping.connector("node").connect(node1.connector("apps"))
 199
 200         comp_result = r"""PING .* \(.*\) \d*\(\d*\) bytes of data.
 201
 202 --- .* ping statistics ---
 203 10 packets transmitted, 10 received, 0% packet loss, time \d*ms.*
 204 """
 205
 206         xml = exp.to_xml()
 207
 208         try:
 209             controller = ExperimentController(xml, self.root_dir)
 210             controller.start()
 211
 212             while not controller.is_finished(ping.guid):
 213                 time.sleep(0.5)
 214
 215             ping_result = controller.trace(ping.guid, "stdout")
 216             tap_trace = controller.trace(tap1.guid, "packets")
 217
 218         finally:
 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         try:
 288             controller = ExperimentController(xml, self.root_dir)
 289             controller.start()
 290
 291             while not controller.is_finished(ping.guid):
 292                 time.sleep(0.5)
 293
 294             tap_trace = controller.trace(tap1.guid, "packets")
 295
 296         finally:
 297             controller.stop()
 298             controller.shutdown()
 299
 300         # asserts at the end, to make sure there's proper cleanup
 301         sent = 0
 302         replied = 0
 303         for seq in xrange(10):
 304             re_send = r""".*
 305 [0-9.:]* IP 192.168.2.3 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*
 306 .*""" % dict(seq=seq)
 307
 308             re_reply = r""".*
 309 [0-9.:]* IP 192.168.2.3 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*.*
 310 [0-9.:]* IP (\d*\.){3}\d* > 192.168.2.3: ICMP echo reply, id 0, seq %(seq)d, length \d*
 311 .*""" % dict(seq=seq)
 312
 313             sent += bool(re.match(re_send, tap_trace, re.MULTILINE|re.DOTALL))
 314             replied += bool(re.match(re_reply, tap_trace, re.MULTILINE|re.DOTALL))
 315
 316         self.assertTrue(sent == replied and sent > 5,
 317             "Unexpected trace:\n%s\n" % (
 318                 tap_trace,) )
 319
 320     def _test_ns3_in_pl_p2p(self, proto):
 321         pl, exp = self.make_experiment_desc()
 322
 323         # Create PL node, ifaces, assign addresses
 324         node1, iface1, (tap0,tap1), (tap0ip,tap1ip), inet = self.make_pl_tapnode(pl,
 325             label="node1", hostname = self.host1,
 326             ip=["192.168.2.2","192.168.2.5"])
 327         node2, iface2, (tap2,tap3), (tap2ip,tap3ip), inet = self.make_pl_tapnode(pl, inet=inet,
 328             label="node2", hostname = self.host2,
 329             ip=["192.168.2.6","192.168.2.9"])
 330         node3, iface3, tap4, tap4ip, inet = self.make_pl_tapnode(pl, inet=inet,
 331             label="node3", hostname = self.host3,
 332             ip="192.168.2.10")
 333
 334         # Add NS3 support in node1
 335         ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-4-%s" % (proto,))
 336
 337         # Configure P2P links
 338         tap0.set_attribute_value("pointopoint", "192.168.2.1") # cross-p2p is not automatic
 339         tap1.connector(proto).connect(tap2.connector(proto))
 340         tap3.connector(proto).connect(tap4.connector(proto))
 341
 342         # Configure routes
 343         r = node1.add_route()
 344         r.set_attribute_value("Destination", "192.168.2.8")
 345         r.set_attribute_value("NetPrefix", 29)
 346         r.set_attribute_value("NextHop", "192.168.2.6")
 347
 348         r = node2.add_route()
 349         r.set_attribute_value("Destination", "192.168.2.0")
 350         r.set_attribute_value("NetPrefix", 29)
 351         r.set_attribute_value("NextHop", "192.168.2.5")
 352
 353         r = node3.add_route()
 354         r.set_attribute_value("Destination", "192.168.2.0")
 355         r.set_attribute_value("NetPrefix", 29)
 356         r.set_attribute_value("NextHop", "192.168.2.9")
 357
 358         # Create NS3 node that is responsive to pings, connected
 359         # to node1 through the Tap interface
 360         ns1 = ns3_desc.create("ns3::Node")
 361         ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
 362         arp1  = ns3_desc.create("ns3::ArpL3Protocol")
 363         icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
 364         ns1.connector("protos").connect(ipv41.connector("node"))
 365         ns1.connector("protos").connect(arp1.connector("node"))
 366         ns1.connector("protos").connect(icmp1.connector("node"))
 367         ns1if = ns3_desc.create("ns3::FileDescriptorNetDevice")
 368         ns1if.enable_trace("FileDescriptorPcapTrace")
 369         ns1if.set_attribute_value("label", "ns1if")
 370         ns1.connector("devs").connect(ns1if.connector("node"))
 371         tap0.connector("fd->").connect(ns1if.connector("->fd"))
 372         ip1 = ns1if.add_address()
 373         ip1.set_attribute_value("Address", "192.168.2.1")
 374         ip1.set_attribute_value("NetPrefix", 30)
 375         ip1.set_attribute_value("Broadcast", False)
 376
 377         # Add default route to the PL node
 378         r1 = ns1.add_route()
 379         r1.set_attribute_value("Destination", "0.0.0.0")
 380         r1.set_attribute_value("NetPrefix", 0)
 381         r1.set_attribute_value("NextHop", "192.168.2.2")
 382
 383         # Create NS3 ping application, pinging the PL node
 384         ping = ns3_desc.create("ns3::V4Ping")
 385         ping.set_attribute_value("Remote", "{#[node3tap].addr[0].[Address]#}")
 386         ping.set_attribute_value("StartTime", "0s")
 387         ping.set_attribute_value("StopTime", "10s")
 388         ping.connector("node").connect(ns1.connector("apps"))
 389
 390         xml = exp.to_xml()
 391
 392         try:
 393             controller = ExperimentController(xml, self.root_dir)
 394             controller.start()
 395
 396             while not controller.is_finished(ping.guid):
 397                 time.sleep(0.5)
 398
 399             tap_trace = []
 400             for i,tap in enumerate([ tap0, tap1, tap2, tap3, tap4 ]):
 401                 tap_trace.append("\nTrace for tap%d:\n" % i)
 402                 tap_trace.append(controller.trace(tap.guid, "packets"))
 403             tap_trace = "".join(tap_trace)
 404             tap0_trace = controller.trace(tap0.guid, "packets")
 405
 406         finally:
 407             controller.stop()
 408             controller.shutdown()
 409
 410         # asserts at the end, to make sure there's proper cleanup
 411         sent = 0
 412         replied = 0
 413         for seq in xrange(10):
 414             re_send = r""".*
 415 [0-9.:]* IP 192.168.2.1 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*
 416 .*""" % dict(seq=seq)
 417
 418             re_reply = r""".*
 419 [0-9.:]* IP 192.168.2.1 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*.*
 420 [0-9.:]* IP (\d*\.){3}\d* > 192.168.2.1: ICMP echo reply, id 0, seq %(seq)d, length \d*
 421 .*""" % dict(seq=seq)
 422
 423             sent += bool(re.match(re_send, tap0_trace, re.MULTILINE|re.DOTALL))
 424             replied += bool(re.match(re_reply, tap0_trace, re.MULTILINE|re.DOTALL))
 425
 426         self.assertTrue(replied >= sent/2 and sent > 5,
 427             "Unexpected trace:\n%s\n" % (
 428                 tap_trace,) )
 429
 430
 431     @test_util.skipUnless(test_util.pl_auth() is not None,
 432         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
 433     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
 434         "Test is expensive, requires NEPI_FULL_TESTS=yes")
 435     def test_ns3_in_pl_p2p_udp(self):
 436         self._test_ns3_in_pl_p2p("udp")
 437
 438     @test_util.skipUnless(test_util.pl_auth() is not None,
 439         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
 440     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
 441         "Test is expensive, requires NEPI_FULL_TESTS=yes")
 442     def test_ns3_in_pl_p2p_tcp(self):
 443         self._test_ns3_in_pl_p2p("tcp")
 444
 445 if __name__ == '__main__':
 446     unittest.main()
 447