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     @test_util.skipUnless(test_util.pl_auth() is not None,
  50         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
  51     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
  52         "Test is expensive, requires NEPI_FULL_TESTS=yes")
  53     def test_ns3_in_pl(self):
  54         ns3_testbed_id = "ns3"
  55         ns3_testbed_version = "3_9_RC3"
  56
  57         pl, exp = self.make_experiment_desc()
  58
  59         node1 = pl.create("Node")
  60         node1.set_attribute_value("hostname", "onelab11.pl.sophia.inria.fr")
  61         node1.set_attribute_value("label", "node1")
  62         iface1 = pl.create("NodeInterface")
  63         iface1.set_attribute_value("label", "node1iface")
  64         inet = pl.create("Internet")
  65         node1.connector("devs").connect(iface1.connector("node"))
  66         iface1.connector("inet").connect(inet.connector("devs"))
  67
  68         plnepi = pl.create("NepiDependency")
  69         plns3 = pl.create("NS3Dependency")
  70         plnepi.connector("node").connect(node1.connector("deps"))
  71         plns3.connector("node").connect(node1.connector("deps"))
  72
  73         ns3_provider = FactoriesProvider(ns3_testbed_id, ns3_testbed_version)
  74         ns3_desc = exp.add_testbed_description(ns3_provider)
  75         ns3_desc.set_attribute_value("rootDirectory", "tb-ns3-1")
  76         ns3_desc.set_attribute_value(DC.DEPLOYMENT_HOST, "{#[node1iface].addr[0].[Address]#}")
  77         ns3_desc.set_attribute_value(DC.DEPLOYMENT_USER,
  78             pl.get_attribute_value("slice"))
  79         ns3_desc.set_attribute_value(DC.DEPLOYMENT_KEY,
  80             pl.get_attribute_value("sliceSSHKey"))
  81         ns3_desc.set_attribute_value(DC.DEPLOYMENT_MODE, DC.MODE_DAEMON)
  82         ns3_desc.set_attribute_value(DC.DEPLOYMENT_COMMUNICATION, DC.ACCESS_SSH)
  83         ns3_desc.set_attribute_value(DC.DEPLOYMENT_ENVIRONMENT_SETUP,
  84             "{#[node1].[%s]#}" % (ATTR_NEPI_TESTBED_ENVIRONMENT_SETUP,))
  85
  86         xml = exp.to_xml()
  87
  88         controller = ExperimentController(xml, self.root_dir)
  89         controller.start()
  90         # just test that it starts...
  91         controller.stop()
  92         controller.shutdown()
  93
  94     @test_util.skipUnless(test_util.pl_auth() is not None,
  95         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
  96     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
  97         "Test is expensive, requires NEPI_FULL_TESTS=yes")
  98     def test_ns3_in_pl_crossconnect(self):
  99         ns3_testbed_id = "ns3"
 100         ns3_testbed_version = "3_9_RC3"
 101
 102         pl, exp = self.make_experiment_desc()
 103
 104         # Create PL node, ifaces, assign addresses
 105         node1 = pl.create("Node")
 106         node1.set_attribute_value("hostname", "onelab11.pl.sophia.inria.fr")
 107         node1.set_attribute_value("label", "node1")
 108         node1.set_attribute_value("emulation", True) # require emulation
 109         iface1 = pl.create("NodeInterface")
 110         iface1.set_attribute_value("label", "node1iface")
 111         tap1 = pl.create("TapInterface")
 112         tap1.enable_trace("packets") # for error output
 113         tap1.set_attribute_value("label", "node1tap")
 114         inet = pl.create("Internet")
 115         node1.connector("devs").connect(iface1.connector("node"))
 116         node1.connector("devs").connect(tap1.connector("node"))
 117         iface1.connector("inet").connect(inet.connector("devs"))
 118
 119         tap1ip = tap1.add_address()
 120         tap1ip.set_attribute_value("Address", "192.168.2.2")
 121         tap1ip.set_attribute_value("NetPrefix", 24)
 122         tap1ip.set_attribute_value("Broadcast", False)
 123
 124         # Add NS3 support in node1
 125         plnepi = pl.create("NepiDependency")
 126         plns3 = pl.create("NS3Dependency")
 127         plnepi.connector("node").connect(node1.connector("deps"))
 128         plns3.connector("node").connect(node1.connector("deps"))
 129
 130         # Create NS3 testbed running in node1
 131         ns3_provider = FactoriesProvider(ns3_testbed_id, ns3_testbed_version)
 132         ns3_desc = exp.add_testbed_description(ns3_provider)
 133         ns3_desc.set_attribute_value("rootDirectory", "tb-ns3-2")
 134         ns3_desc.set_attribute_value("SimulatorImplementationType", "ns3::RealtimeSimulatorImpl")
 135         ns3_desc.set_attribute_value("ChecksumEnabled", True)
 136         ns3_desc.set_attribute_value(DC.DEPLOYMENT_HOST, "{#[node1iface].addr[0].[Address]#}")
 137         ns3_desc.set_attribute_value(DC.DEPLOYMENT_USER,
 138             pl.get_attribute_value("slice"))
 139         ns3_desc.set_attribute_value(DC.DEPLOYMENT_KEY,
 140             pl.get_attribute_value("sliceSSHKey"))
 141         ns3_desc.set_attribute_value(DC.DEPLOYMENT_MODE, DC.MODE_DAEMON)
 142         ns3_desc.set_attribute_value(DC.DEPLOYMENT_COMMUNICATION, DC.ACCESS_SSH)
 143         ns3_desc.set_attribute_value(DC.DEPLOYMENT_ENVIRONMENT_SETUP,
 144             "{#[node1].[%s]#}" % (ATTR_NEPI_TESTBED_ENVIRONMENT_SETUP,))
 145         ns3_desc.set_attribute_value(DC.LOG_LEVEL, DC.DEBUG_LEVEL)
 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 1 packets transmitted, 1 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 if __name__ == '__main__':
 200     unittest.main()
 201