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     def setUp(self):
  19         self.root_dir = tempfile.mkdtemp()
  20
  21     def tearDown(self):
  22         try:
  23             shutil.rmtree(self.root_dir)
  24         except:
  25             # retry
  26             time.sleep(0.1)
  27             shutil.rmtree(self.root_dir)
  28
  29     def make_experiment_desc(self):
  30         testbed_id = "planetlab"
  31         testbed_version = "01"
  32         slicename = "inria_nepi12"
  33         pl_ssh_key = os.environ.get(
  34             "PL_SSH_KEY",
  35             "%s/.ssh/id_rsa_planetlab" % (os.environ['HOME'],) )
  36         pl_user, pl_pwd = test_util.pl_auth()
  37
  38         exp_desc = ExperimentDescription()
  39         pl_provider = FactoriesProvider(testbed_id, testbed_version)
  40         pl_desc = exp_desc.add_testbed_description(pl_provider)
  41         pl_desc.set_attribute_value("homeDirectory", self.root_dir)
  42         pl_desc.set_attribute_value("slice", slicename)
  43         pl_desc.set_attribute_value("sliceSSHKey", pl_ssh_key)
  44         pl_desc.set_attribute_value("authUser", pl_user)
  45         pl_desc.set_attribute_value("authPass", pl_pwd)
  46
  47         return pl_desc, exp_desc
  48
  49     def make_pl_tapnode(self, pl):
  50         node1 = pl.create("Node")
  51         node1.set_attribute_value("hostname", "onelab11.pl.sophia.inria.fr")
  52         node1.set_attribute_value("label", "node1")
  53         node1.set_attribute_value("emulation", True) # require emulation
  54         iface1 = pl.create("NodeInterface")
  55         iface1.set_attribute_value("label", "node1iface")
  56         tap1 = pl.create("TapInterface")
  57         tap1.enable_trace("packets") # for error output
  58         tap1.set_attribute_value("label", "node1tap")
  59         inet = pl.create("Internet")
  60         node1.connector("devs").connect(iface1.connector("node"))
  61         node1.connector("devs").connect(tap1.connector("node"))
  62         iface1.connector("inet").connect(inet.connector("devs"))
  63
  64         tap1ip = tap1.add_address()
  65         tap1ip.set_attribute_value("Address", "192.168.2.2")
  66         tap1ip.set_attribute_value("NetPrefix", 24)
  67         tap1ip.set_attribute_value("Broadcast", False)
  68
  69         return node1, iface1, tap1, tap1ip, inet
  70
  71     def make_ns_in_pl(self, pl, exp, node1, iface1, root):
  72         ns3_testbed_id = "ns3"
  73         ns3_testbed_version = "3_9_RC3"
  74
  75         # Add NS3 support in node1
  76         plnepi = pl.create("NepiDependency")
  77         plns3 = pl.create("NS3Dependency")
  78         plnepi.connector("node").connect(node1.connector("deps"))
  79         plns3.connector("node").connect(node1.connector("deps"))
  80
  81         # Create NS3 testbed running in node1
  82         ns3_provider = FactoriesProvider(ns3_testbed_id, ns3_testbed_version)
  83         ns3_desc = exp.add_testbed_description(ns3_provider)
  84         ns3_desc.set_attribute_value("rootDirectory", root)
  85         ns3_desc.set_attribute_value("SimulatorImplementationType", "ns3::RealtimeSimulatorImpl")
  86         ns3_desc.set_attribute_value("ChecksumEnabled", True)
  87         ns3_desc.set_attribute_value(DC.DEPLOYMENT_HOST, "{#[%s].addr[0].[Address]#}" % (
  88             iface1.get_attribute_value("label"),))
  89         ns3_desc.set_attribute_value(DC.DEPLOYMENT_USER,
  90             pl.get_attribute_value("slice"))
  91         ns3_desc.set_attribute_value(DC.DEPLOYMENT_KEY,
  92             pl.get_attribute_value("sliceSSHKey"))
  93         ns3_desc.set_attribute_value(DC.DEPLOYMENT_MODE, DC.MODE_DAEMON)
  94         ns3_desc.set_attribute_value(DC.DEPLOYMENT_COMMUNICATION, DC.ACCESS_SSH)
  95         ns3_desc.set_attribute_value(DC.DEPLOYMENT_ENVIRONMENT_SETUP,
  96             "{#[%s].[%s]#}" % (
  97                 node1.get_attribute_value("label"),
  98                 ATTR_NEPI_TESTBED_ENVIRONMENT_SETUP,))
  99         ns3_desc.set_attribute_value(DC.LOG_LEVEL, DC.DEBUG_LEVEL)
 100
 101         return ns3_desc
 102
 103
 104     @test_util.skipUnless(test_util.pl_auth() is not None,
 105         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
 106     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
 107         "Test is expensive, requires NEPI_FULL_TESTS=yes")
 108     def test_ns3_in_pl(self):
 109         ns3_testbed_id = "ns3"
 110         ns3_testbed_version = "3_9_RC3"
 111
 112         pl, exp = self.make_experiment_desc()
 113
 114         node1 = pl.create("Node")
 115         node1.set_attribute_value("hostname", "onelab11.pl.sophia.inria.fr")
 116         node1.set_attribute_value("label", "node1")
 117         iface1 = pl.create("NodeInterface")
 118         iface1.set_attribute_value("label", "node1iface")
 119         inet = pl.create("Internet")
 120         node1.connector("devs").connect(iface1.connector("node"))
 121         iface1.connector("inet").connect(inet.connector("devs"))
 122
 123         # Add NS3 support in node1
 124         ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-1")
 125
 126         xml = exp.to_xml()
 127
 128         controller = ExperimentController(xml, self.root_dir)
 129         controller.start()
 130         # just test that it starts...
 131         controller.stop()
 132         controller.shutdown()
 133
 134     @test_util.skipUnless(test_util.pl_auth() is not None,
 135         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
 136     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
 137         "Test is expensive, requires NEPI_FULL_TESTS=yes")
 138     def test_ns3_in_pl_crossconnect(self):
 139         pl, exp = self.make_experiment_desc()
 140
 141         # Create PL node, ifaces, assign addresses
 142         node1, iface1, tap1, tap1ip, inet = self.make_pl_tapnode(pl)
 143
 144         # Add NS3 support in node1
 145         ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-2")
 146
 147         # Create NS3 node that is responsive to pings, connected
 148         # to node1 through the Tap interface
 149         ns1 = ns3_desc.create("ns3::Node")
 150         ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
 151         arp1  = ns3_desc.create("ns3::ArpL3Protocol")
 152         icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
 153         ns1.connector("protos").connect(ipv41.connector("node"))
 154         ns1.connector("protos").connect(arp1.connector("node"))
 155         ns1.connector("protos").connect(icmp1.connector("node"))
 156         ns1if = ns3_desc.create("ns3::FileDescriptorNetDevice")
 157         ns1if.enable_trace("FileDescriptorPcapTrace")
 158         ns1if.set_attribute_value("label", "ns1if")
 159         ns1.connector("devs").connect(ns1if.connector("node"))
 160         tap1.connector("fd->").connect(ns1if.connector("->fd"))
 161         ip1 = ns1if.add_address()
 162         ip1.set_attribute_value("Address", "192.168.2.3")
 163         ip1.set_attribute_value("NetPrefix", 24)
 164         ip1.set_attribute_value("Broadcast", False)
 165
 166         # Create PlanetLab ping application, pinging the NS3 node
 167         ping = pl.create("Application")
 168         ping.set_attribute_value("command", "ping -qc10 {#[ns1if].addr[0].[Address]#}")
 169         ping.enable_trace("stdout")
 170         ping.enable_trace("stderr")
 171         ping.connector("node").connect(node1.connector("apps"))
 172
 173         comp_result = r"""PING .* \(.*\) \d*\(\d*\) bytes of data.
 174
 175 --- .* ping statistics ---
 176 10 packets transmitted, 10 received, 0% packet loss, time \d*ms.*
 177 """
 178
 179         xml = exp.to_xml()
 180
 181         controller = ExperimentController(xml, self.root_dir)
 182         controller.start()
 183
 184         while not controller.is_finished(ping.guid):
 185             time.sleep(0.5)
 186
 187         ping_result = controller.trace(pl.guid, ping.guid, "stdout")
 188         tap_trace = controller.trace(pl.guid, tap1.guid, "packets")
 189
 190         controller.stop()
 191         controller.shutdown()
 192
 193         # asserts at the end, to make sure there's proper cleanup
 194         self.assertTrue(re.match(comp_result, ping_result, re.MULTILINE),
 195             "Unexpected trace:\n%s\nTap trace:\n%s\n" % (
 196                 ping_result,
 197                 tap_trace) )
 198
 199     @test_util.skipUnless(test_util.pl_auth() is not None,
 200         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
 201     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
 202         "Test is expensive, requires NEPI_FULL_TESTS=yes")
 203     def test_ns3_in_pl_snat(self):
 204         pl, exp = self.make_experiment_desc()
 205
 206         # Create PL node, ifaces, assign addresses
 207         node1, iface1, tap1, tap1ip, inet = self.make_pl_tapnode(pl)
 208
 209         # Add NS3 support in node1
 210         ns3_desc = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns3-3")
 211
 212         # Enable SNAT
 213         tap1.set_attribute_value("snat", True)
 214
 215         # Add second PL node (ping target)
 216         node2 = pl.create("Node")
 217         node2.set_attribute_value("hostname", "onelab10.pl.sophia.inria.fr")
 218         node2.set_attribute_value("label", "node2")
 219         iface2 = pl.create("NodeInterface")
 220         iface2.set_attribute_value("label", "node2iface")
 221         node2.connector("devs").connect(iface2.connector("node"))
 222         iface2.connector("inet").connect(inet.connector("devs"))
 223
 224         # Create NS3 node that is responsive to pings, connected
 225         # to node1 through the Tap interface
 226         ns1 = ns3_desc.create("ns3::Node")
 227         ipv41 = ns3_desc.create("ns3::Ipv4L3Protocol")
 228         arp1  = ns3_desc.create("ns3::ArpL3Protocol")
 229         icmp1 = ns3_desc.create("ns3::Icmpv4L4Protocol")
 230         ns1.connector("protos").connect(ipv41.connector("node"))
 231         ns1.connector("protos").connect(arp1.connector("node"))
 232         ns1.connector("protos").connect(icmp1.connector("node"))
 233         ns1if = ns3_desc.create("ns3::FileDescriptorNetDevice")
 234         ns1if.enable_trace("FileDescriptorPcapTrace")
 235         ns1if.set_attribute_value("label", "ns1if")
 236         ns1.connector("devs").connect(ns1if.connector("node"))
 237         tap1.connector("fd->").connect(ns1if.connector("->fd"))
 238         ip1 = ns1if.add_address()
 239         ip1.set_attribute_value("Address", "192.168.2.3")
 240         ip1.set_attribute_value("NetPrefix", 24)
 241         ip1.set_attribute_value("Broadcast", False)
 242
 243         # Add default route to the PL node
 244         r1 = ns1.add_route()
 245         r1.set_attribute_value("Destination", "0.0.0.0")
 246         r1.set_attribute_value("NetPrefix", 0)
 247         r1.set_attribute_value("NextHop", "192.168.2.2")
 248
 249         # Create NS3 ping application, pinging the PL node
 250         ping = ns3_desc.create("ns3::V4Ping")
 251         ping.set_attribute_value("Remote", "{#[node2iface].addr[0].[Address]#}")
 252         ping.set_attribute_value("StartTime", "0s")
 253         ping.set_attribute_value("StopTime", "10s")
 254         ping.connector("node").connect(ns1.connector("apps"))
 255
 256         xml = exp.to_xml()
 257
 258         controller = ExperimentController(xml, self.root_dir)
 259         controller.start()
 260
 261         while not controller.is_finished(ping.guid):
 262             time.sleep(0.5)
 263
 264         tap_trace = controller.trace(pl.guid, tap1.guid, "packets")
 265
 266         controller.stop()
 267         controller.shutdown()
 268
 269         # asserts at the end, to make sure there's proper cleanup
 270         sent = 0
 271         replied = 0
 272         for seq in xrange(10):
 273             re_send = r""".*
 274 [0-9.:]* IP 192.168.2.3 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*
 275 .*""" % dict(seq=seq)
 276
 277             re_reply = r""".*
 278 [0-9.:]* IP 192.168.2.3 > (\d*\.){3}\d*: ICMP echo request, id 0, seq %(seq)d, length \d*.*
 279 [0-9.:]* IP (\d*\.){3}\d* > 192.168.2.3: ICMP echo reply, id 0, seq %(seq)d, length \d*
 280 .*""" % dict(seq=seq)
 281
 282             sent += bool(re.match(re_send, tap_trace, re.MULTILINE|re.DOTALL))
 283             replied += bool(re.match(re_reply, tap_trace, re.MULTILINE|re.DOTALL))
 284
 285         self.assertTrue(sent == replied and sent > 5,
 286             "Unexpected trace:\n%s\n" % (
 287                 tap_trace,) )
 288
 289 if __name__ == '__main__':
 290     unittest.main()
 291