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