test/resources/linux/ns3/ns3dceapplication.py

   1 #!/usr/bin/env python
   2 #
   3 #    NEPI, a framework to manage network experiments
   4 #    Copyright (C) 2013 INRIA
   5 #
   6 #    This program is free software: you can redistribute it and/or modify
   7 #    it under the terms of the GNU General Public License version 2 as
   8 #    published by the Free Software Foundation;
   9 #
  10 #    This program is distributed in the hope that it will be useful,
  11 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 #    GNU General Public License for more details.
  14 #
  15 #    You should have received a copy of the GNU General Public License
  16 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 #
  18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
  19
  20
  21 from nepi.execution.ec import ExperimentController
  22 from nepi.execution.trace import TraceAttr
  23
  24 from test_utils import skipIfNotAlive
  25
  26 import os
  27 import time
  28 import unittest
  29
  30 def add_ns3_node(ec, simu):
  31     node = ec.register_resource("ns3::Node")
  32     ec.register_connection(node, simu)
  33
  34     ipv4 = ec.register_resource("ns3::Ipv4L3Protocol")
  35     ec.register_connection(node, ipv4)
  36
  37     arp = ec.register_resource("ns3::ArpL3Protocol")
  38     ec.register_connection(node, arp)
  39
  40     icmp = ec.register_resource("ns3::Icmpv4L4Protocol")
  41     ec.register_connection(node, icmp)
  42
  43     udp = ec.register_resource("ns3::UdpL4Protocol")
  44     ec.register_connection(node, udp)
  45
  46     tcp = ec.register_resource("ns3::TcpL4Protocol")
  47     ec.register_connection(node, tcp)
  48
  49     return node
  50
  51 def add_point2point_device(ec, node, ip, prefix):
  52     dev = ec.register_resource("ns3::PointToPointNetDevice")
  53     ec.set(dev, "ip", ip)
  54     ec.set(dev, "prefix", prefix)
  55     ec.register_connection(node, dev)
  56
  57     queue = ec.register_resource("ns3::DropTailQueue")
  58     ec.register_connection(dev, queue)
  59
  60     return dev
  61
  62 def add_csma_device(ec, node, ip, prefix):
  63     dev = ec.register_resource("ns3::CsmaNetDevice")
  64     ec.set(dev, "ip", ip)
  65     ec.set(dev, "prefix", prefix)
  66     ec.register_connection(node, dev)
  67
  68     queue = ec.register_resource("ns3::DropTailQueue")
  69     ec.register_connection(dev, queue)
  70
  71     return dev
  72
  73 def add_wifi_device(ec, node, ip, prefix,
  74         access_point = False):
  75     dev = ec.register_resource("ns3::WifiNetDevice")
  76     ec.set(dev, "ip", ip)
  77     ec.set(dev, "prefix", prefix)
  78     ec.register_connection(node, dev)
  79
  80     phy = ec.register_resource("ns3::YansWifiPhy")
  81     ec.set(phy, "Standard", "WIFI_PHY_STANDARD_80211a")
  82     ec.register_connection(dev, phy)
  83
  84     error = ec.register_resource("ns3::NistErrorRateModel")
  85     ec.register_connection(phy, error)
  86
  87     manager = ec.register_resource("ns3::ArfWifiManager")
  88     ec.register_connection(dev, manager)
  89
  90     if access_point:
  91         mac = ec.register_resource("ns3::ApWifiMac")
  92     else:
  93         mac = ec.register_resource("ns3::StaWifiMac")
  94
  95     ec.set(mac, "Standard", "WIFI_PHY_STANDARD_80211a")
  96     ec.register_connection(dev, mac)
  97
  98     return dev, phy
  99
 100 def add_random_mobility(ec, node, x, y, z, speed, bounds_width,
 101         bounds_height):
 102     position = "%d:%d:%d" % (x, y, z)
 103     bounds = "0|%d|0|%d" % (bounds_width, bounds_height)
 104     speed = "ns3::UniformRandomVariable[Min=%d|Max=%s]" % (speed, speed)
 105     pause = "ns3::ConstantRandomVariable[Constant=1.0]"
 106
 107     mobility = ec.register_resource("ns3::RandomDirection2dMobilityModel")
 108     ec.set(mobility, "Position", position)
 109     ec.set(mobility, "Bounds", bounds)
 110     ec.set(mobility, "Speed", speed)
 111     ec.set(mobility, "Pause",  pause)
 112     ec.register_connection(node, mobility)
 113     return mobility
 114
 115 def add_constant_mobility(ec, node, x, y, z):
 116     mobility = ec.register_resource("ns3::ConstantPositionMobilityModel")
 117     position = "%d:%d:%d" % (x, y, z)
 118     ec.set(mobility, "Position", position)
 119     ec.register_connection(node, mobility)
 120     return mobility
 121
 122 def add_wifi_channel(ec):
 123     channel = ec.register_resource("ns3::YansWifiChannel")
 124     delay = ec.register_resource("ns3::ConstantSpeedPropagationDelayModel")
 125     ec.register_connection(channel, delay)
 126
 127     loss  = ec.register_resource("ns3::LogDistancePropagationLossModel")
 128     ec.register_connection(channel, loss)
 129
 130     return channel
 131
 132 class LinuxNS3DceApplicationTest(unittest.TestCase):
 133     def setUp(self):
 134         self.fedora_host = "nepi2.pl.sophia.inria.fr"
 135         self.fedora_user = "inria_nepi"
 136         self.fedora_identity = "%s/.ssh/id_rsa_planetlab" % (os.environ['HOME'])
 137
 138         self.ubuntu_host = "roseval.pl.sophia.inria.fr"
 139         self.ubuntu_user = "inria_nepi"
 140         self.ubuntu_identity = "%s/.ssh/id_rsa" % (os.environ['HOME'])
 141
 142     @skipIfNotAlive
 143     def t_dce_ping(self, host, user = None, identity = None):
 144         ec = ExperimentController(exp_id = "test-dce-ping")
 145
 146         node = ec.register_resource("linux::Node")
 147         if host == "localhost":
 148             ec.set(node, "hostname", host)
 149         else:
 150             ec.set(node, "hostname", host)
 151             ec.set(node, "username", user)
 152             ec.set(node, "identity", identity)
 153
 154         ec.set(node, "cleanProcesses", True)
 155         #ec.set(node, "cleanExperiment", True)
 156
 157         simu = ec.register_resource("linux::ns3::Simulation")
 158         ec.set(simu, "verbose", True)
 159         ec.set(simu, "buildMode", "debug")
 160         ec.set(simu, "nsLog", "DceApplication")
 161         ec.register_connection(simu, node)
 162
 163         nsnode1 = add_ns3_node(ec, simu)
 164         p2p1 = add_point2point_device(ec, nsnode1, "10.0.0.1", "30")
 165         ec.set(p2p1, "DataRate", "5Mbps")
 166
 167         nsnode2 = add_ns3_node(ec, simu)
 168         p2p2 = add_point2point_device(ec, nsnode2, "10.0.0.2", "30")
 169         ec.set(p2p2, "DataRate", "5Mbps")
 170
 171         # Create channel
 172         chan = ec.register_resource("ns3::PointToPointChannel")
 173         ec.set(chan, "Delay", "2ms")
 174
 175         ec.register_connection(chan, p2p1)
 176         ec.register_connection(chan, p2p2)
 177
 178         ### create applications
 179         ping = ec.register_resource("linux::ns3::dce::Application")
 180         ec.set (ping, "sources", "http://www.skbuff.net/iputils/iputils-s20101006.tar.bz2")
 181         ec.set (ping, "build", "tar xvjf ${SRC}/iputils-s20101006.tar.bz2 && "
 182                 "cd iputils-s20101006/ && "
 183                 "sed -i 's/CFLAGS=/CFLAGS+=/g' Makefile && "
 184                 "make CFLAGS=-fPIC LDFLAGS='-pie -rdynamic' ping && "
 185                 "cp ping ${BIN_DCE} && cd - ")
 186         ec.set (ping, "binary", "ping")
 187         ec.set (ping, "stackSize", 1<<20)
 188         ec.set (ping, "arguments", "-c 10;-s 1000;10.0.0.2")
 189         ec.set (ping, "StartTime", "1s")
 190         ec.set (ping, "StopTime", "20s")
 191         ec.register_connection(ping, nsnode1)
 192
 193         ec.deploy()
 194
 195         ec.wait_finished([ping])
 196
 197         expected = "ping -c 10 -s 1000 10.0.0.2"
 198         cmdline = ec.trace(ping, "cmdline")
 199         self.assertTrue(cmdline.find(expected) > -1, cmdline)
 200
 201         expected = "Start Time: NS3 Time:          1s ("
 202         status = ec.trace(ping, "status")
 203         self.assertTrue(status.find(expected) > -1, status)
 204
 205         expected = "10 packets transmitted, 10 received, 0% packet loss, time 9002ms"
 206         stdout = ec.trace(ping, "stdout")
 207         self.assertTrue(stdout.find(expected) > -1, stdout)
 208
 209         stderr = ec.trace(simu, "stderr")
 210         expected = "DceApplication:StartApplication"
 211         self.assertTrue(stderr.find(expected) > -1, stderr)
 212
 213         ec.shutdown()
 214
 215     @skipIfNotAlive
 216     def t_dce_ccn(self, host, user = None, identity = None):
 217         ec = ExperimentController(exp_id = "test-dce-ccn")
 218
 219         node = ec.register_resource("linux::Node")
 220         if host == "localhost":
 221             ec.set(node, "hostname", host)
 222         else:
 223             ec.set(node, "hostname", host)
 224             ec.set(node, "username", user)
 225             ec.set(node, "identity", identity)
 226
 227         #ec.set(node, "cleanProcesses", True)
 228         #ec.set(node, "cleanHome", True)
 229
 230         simu = ec.register_resource("linux::ns3::Simulation")
 231         ec.set(simu, "verbose", True)
 232         ec.set(simu, "buildMode", "debug")
 233         ec.set(simu, "nsLog", "DceApplication")
 234         ec.register_connection(simu, node)
 235
 236         nsnode1 = add_ns3_node(ec, simu)
 237         p2p1 = add_point2point_device(ec, nsnode1, "10.0.0.1", "30")
 238         ec.set(p2p1, "DataRate", "5Mbps")
 239
 240         nsnode2 = add_ns3_node(ec, simu)
 241         p2p2 = add_point2point_device(ec, nsnode2, "10.0.0.2", "30")
 242         ec.set(p2p2, "DataRate", "5Mbps")
 243
 244         # Create channel
 245         chan = ec.register_resource("ns3::PointToPointChannel")
 246         ec.set(chan, "Delay", "2ms")
 247
 248         ec.register_connection(chan, p2p1)
 249         ec.register_connection(chan, p2p2)
 250
 251         ### create applications
 252         ccnd1 = ec.register_resource("linux::ns3::dce::CCNApplication")
 253
 254         if host == self.fedora_host:
 255             depends = ( " autoconf openssl-devel  expat-devel libpcap-devel "
 256                 " ecryptfs-utils-devel libxml2-devel automake gawk "
 257                 " gcc gcc-c++ git pcre-devel make ")
 258         else: # UBUNTU
 259             # NOTE THAT INSTALLATION MIGHT FAIL IF openjdk-6-jdk is not installed
 260             depends = ( "libpcap0.8-dev openjdk-6-jdk ant1.8 autoconf "
 261                     "libssl-dev libexpat-dev libpcap-dev libecryptfs0 libxml2-utils auto"
 262                     "make gawk gcc g++ git-core pkg-config libpcre3-dev openjdk-6-jre-lib")
 263
 264         ec.set (ccnd1, "depends", depends)
 265         ec.set (ccnd1, "sources", "http://www.ccnx.org/releases/ccnx-0.7.2.tar.gz")
 266         ec.set (ccnd1, "build", "tar zxf ${SRC}/ccnx-0.7.2.tar.gz && "
 267                 "cd ccnx-0.7.2 && "
 268                 " INSTALL_BASE=${BIN_DCE}/.. ./configure && "
 269                 " make MORE_LDLIBS='-pie -rdynamic' && "
 270                 " make install && "
 271                 " cp ${BIN_DCE}/../bin/ccn* ${BIN_DCE} && "
 272                 " cd -")
 273         ec.set (ccnd1, "binary", "ccnd")
 274         ec.set (ccnd1, "stackSize", 1<<20)
 275         ec.set (ccnd1, "environment", "CCND_CAP=50000; CCND_DEBUG=7")
 276         ec.set (ccnd1, "StartTime", "1s")
 277         ec.set (ccnd1, "StopTime", "20s")
 278         ec.register_connection(ccnd1, nsnode1)
 279
 280         repofile = os.path.join(
 281             os.path.dirname(os.path.realpath(__file__)), "ccn",
 282             "repoFile1")
 283
 284         ccnr = ec.register_resource("linux::ns3::dce::CCNApplication")
 285         ec.set (ccnr, "binary", "ccnr")
 286         ec.set (ccnr, "environment", "CCNR_DIRECTORY=/REPO/")
 287         ec.set (ccnr, "files", "%s=/REPO/repoFile1" % repofile)
 288         ec.set (ccnr, "stackSize", 1<<20)
 289         ec.set (ccnr, "StartTime", "2s")
 290         ec.set (ccnr, "StopTime", "120s")
 291         ec.register_connection(ccnr, nsnode1)
 292
 293         ccndc1 = ec.register_resource("linux::ns3::dce::CCNApplication")
 294         ec.set (ccndc1, "binary", "ccndc")
 295         ec.set (ccndc1, "arguments", "-v;add;ccnx:/;udp;10.0.0.2")
 296         ec.set (ccndc1, "stackSize", 1<<20)
 297         ec.set (ccndc1, "StartTime", "2s")
 298         ec.set (ccndc1, "StopTime", "120s")
 299         ec.register_connection(ccndc1, nsnode1)
 300
 301         ccnd2 = ec.register_resource("linux::ns3::dce::CCNApplication")
 302         ec.set (ccnd2, "binary", "ccnd")
 303         ec.set (ccnd2, "stackSize", 1<<20)
 304         ec.set (ccnd2, "environment", "CCND_CAP=50000; CCND_DEBUG=7")
 305         ec.set (ccnd2, "StartTime", "1s")
 306         ec.set (ccnd2, "StopTime", "120s")
 307         ec.register_connection(ccnd2, nsnode2)
 308
 309         ccndc2 = ec.register_resource("linux::ns3::dce::CCNApplication")
 310         ec.set (ccndc2, "binary", "ccndc")
 311         ec.set (ccndc2, "arguments", "-v;add;ccnx:/;udp;10.0.0.1")
 312         ec.set (ccndc2, "stackSize", 1<<20)
 313         ec.set (ccndc2, "StartTime", "2s")
 314         ec.set (ccndc2, "StopTime", "120s")
 315         ec.register_connection(ccndc2, nsnode2)
 316
 317         ccnpeek = ec.register_resource("linux::ns3::dce::CCNApplication")
 318         ec.set (ccnpeek, "binary", "ccnpeek")
 319         ec.set (ccnpeek, "arguments", "ccnx:/test/bunny.ts")
 320         ec.set (ccnpeek, "stdinFile", "")
 321         ec.set (ccnpeek, "stackSize", 1<<20)
 322         ec.set (ccnpeek, "StartTime", "4s")
 323         ec.set (ccnpeek, "StopTime", "120s")
 324         ec.register_connection(ccnpeek, nsnode2)
 325
 326         ccncat = ec.register_resource("linux::ns3::dce::CCNApplication")
 327         ec.set (ccncat, "binary", "ccncat")
 328         ec.set (ccncat, "arguments", "ccnx:/test/bunny.ts")
 329         ec.set (ccncat, "stdinFile", "")
 330         ec.set (ccncat, "stackSize", 1<<20)
 331         ec.set (ccncat, "StartTime", "4s")
 332         ec.set (ccncat, "StopTime", "120s")
 333         ec.register_connection(ccncat, nsnode2)
 334
 335         ec.deploy()
 336
 337         ec.wait_finished([ccncat])
 338
 339         expected = "ccncat ccnx:/test/bunny.ts"
 340         cmdline = ec.trace(ccncat, "cmdline")
 341         self.assertTrue(cmdline.find(expected) > -1, cmdline)
 342
 343         expected = "Start Time: NS3 Time:          4s ("
 344         status = ec.trace(ccncat, "status")
 345         self.assertTrue(status.find(expected) > -1, status)
 346
 347         expected = 2873956
 348         stdout = ec.trace(ccncat, "stdout")
 349         self.assertTrue(len(stdout) == expected , stdout)
 350
 351         ec.shutdown()
 352
 353     def test_dce_ping_fedora(self):
 354         self.t_dce_ping(self.fedora_host, self.fedora_user, self.fedora_identity)
 355
 356     def test_dce_ping_ubuntu(self):
 357         self.t_dce_ping(self.ubuntu_host, self.ubuntu_user, self.ubuntu_identity)
 358
 359     def test_dce_ping_local(self):
 360         self.t_dce_ping("localhost")
 361
 362     def test_dce_ccn_fedora(self):
 363         self.t_dce_ccn(self.fedora_host, self.fedora_user, self.fedora_identity)
 364
 365     def test_dce_ccn_ubuntu(self):
 366         self.t_dce_ccn(self.ubuntu_host, self.ubuntu_user, self.ubuntu_identity)
 367
 368     def test_dce_ccn_local(self):
 369         self.t_dce_ccn("localhost")
 370
 371 if __name__ == '__main__':
 372     unittest.main()