21b046eadcb64df8e9032eda1d85651b96c6a55f
[nepi.git] / 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 import os
26 import time
27 import unittest
28
29 def add_ns3_node(ec, simu):
30     node = ec.register_resource("ns3::Node")
31     ec.register_connection(node, simu)
32
33     ipv4 = ec.register_resource("ns3::Ipv4L3Protocol")
34     ec.register_connection(node, ipv4)
35
36     arp = ec.register_resource("ns3::ArpL3Protocol")
37     ec.register_connection(node, arp)
38     
39     icmp = ec.register_resource("ns3::Icmpv4L4Protocol")
40     ec.register_connection(node, icmp)
41
42     udp = ec.register_resource("ns3::UdpL4Protocol")
43     ec.register_connection(node, udp)
44
45     return node
46
47 def add_point2point_device(ec, node, address = None,  prefix = None):
48     dev = ec.register_resource("ns3::PointToPointNetDevice")
49     if address:
50        ec.set(dev, "ip", address)
51     if prefix:
52        ec.set(dev, "prefix", prefix)
53     ec.register_connection(node, dev)
54
55     queue = ec.register_resource("ns3::DropTailQueue")
56     ec.register_connection(dev, queue)
57
58     return dev
59
60 def add_csma_device(ec, node, address = None, prefix = None):
61     dev = ec.register_resource("ns3::CsmaNetDevice")
62     if address:
63         ec.set(dev, "ip", address)
64     if prefix:
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, address = None, prefix = None, 
74         access_point = False):
75     dev = ec.register_resource("ns3::WifiNetDevice")
76     if address:
77         ec.set(dev, "ip", address)
78     if prefix:
79         ec.set(dev, "prefix", prefix)
80     ec.register_connection(node, dev)
81
82     phy = ec.register_resource("ns3::YansWifiPhy")
83     ec.set(phy, "Standard", "WIFI_PHY_STANDARD_80211a")
84     ec.register_connection(dev, phy)
85
86     error = ec.register_resource("ns3::NistErrorRateModel")
87     ec.register_connection(phy, error)
88
89     manager = ec.register_resource("ns3::ArfWifiManager")
90     ec.register_connection(dev, manager)
91
92     if access_point:
93         mac = ec.register_resource("ns3::ApWifiMac")
94     else:
95         mac = ec.register_resource("ns3::StaWifiMac")
96
97     ec.set(mac, "Standard", "WIFI_PHY_STANDARD_80211a")
98     ec.register_connection(dev, mac)
99
100     return dev, phy
101
102 def add_random_mobility(ec, node, x, y, z, speed, bounds_width, 
103         bounds_height):
104     position = "%d:%d:%d" % (x, y, z)
105     bounds = "0|%d|0|%d" % (bounds_width, bounds_height) 
106     speed = "ns3::UniformRandomVariable[Min=%d|Max=%s]" % (speed, speed)
107     pause = "ns3::ConstantRandomVariable[Constant=1.0]"
108     
109     mobility = ec.register_resource("ns3::RandomDirection2dMobilityModel")
110     ec.set(mobility, "Position", position)
111     ec.set(mobility, "Bounds", bounds)
112     ec.set(mobility, "Speed", speed)
113     ec.set(mobility, "Pause",  pause)
114     ec.register_connection(node, mobility)
115     return mobility
116
117 def add_constant_mobility(ec, node, x, y, z):
118     mobility = ec.register_resource("ns3::ConstantPositionMobilityModel") 
119     position = "%d:%d:%d" % (x, y, z)
120     ec.set(mobility, "Position", position)
121     ec.register_connection(node, mobility)
122     return mobility
123
124 def add_wifi_channel(ec):
125     channel = ec.register_resource("ns3::YansWifiChannel")
126     delay = ec.register_resource("ns3::ConstantSpeedPropagationDelayModel")
127     ec.register_connection(channel, delay)
128
129     loss  = ec.register_resource("ns3::LogDistancePropagationLossModel")
130     ec.register_connection(channel, loss)
131
132     return channel
133
134 class LinuxNS3DceApplicationTest(unittest.TestCase):
135     def setUp(self):
136         #elf.fedora_host = "nepi2.pl.sophia.inria.fr"
137         #self.fedora_host = "planetlabpc1.upf.edu"
138         self.fedora_host = "peeramide.irisa.fr"
139         self.fedora_user = "inria_nepi"
140         #self.fedora_user = "inria_alina"
141         self.fedora_identity = "%s/.ssh/id_rsa_planetlab" % (os.environ['HOME'])
142
143     def test_dce_application(self):
144         ec = ExperimentController(exp_id = "test-linux-ns3-dce")
145         
146         node = ec.register_resource("LinuxNode")
147         ec.set(node, "hostname", self.fedora_host)
148         ec.set(node, "username", self.fedora_user)
149         ec.set(node, "identity", self.fedora_identity)
150         ec.set(node, "cleanProcesses", True)
151         #ec.set(node, "cleanHome", True)
152
153         simu = ec.register_resource("LinuxNS3Simulation")
154         ec.set(simu, "verbose", True)
155         ec.set(simu, "enableDCE", 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         ec.set(nsnode1, "enableDCE", True)
162         p2p1 = add_point2point_device(ec, nsnode1, "10.0.0.1", "30")
163         ec.set(p2p1, "DataRate", "5Mbps")
164
165         nsnode2 = add_ns3_node(ec, simu)
166         ec.set(nsnode2, "enableDCE", True)
167         p2p2 = add_point2point_device(ec, nsnode2, "10.0.0.2", "30")
168         ec.set(p2p2, "DataRate", "5Mbps")
169
170         # Create channel
171         chan = ec.register_resource("ns3::PointToPointChannel")
172         ec.set(chan, "Delay", "2ms")
173
174         ec.register_connection(chan, p2p1)
175         ec.register_connection(chan, p2p2)
176
177         ### create applications
178         ping = ec.register_resource("ns3::LinuxDceApplication")
179         """
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 ping && "
185                 "cp ping ${BIN_DCE} ")
186         """
187         ec.set (ping, "binary", "ping")
188         ec.set (ping, "stackSize", 1<<20)
189         ec.set (ping, "arguments", "-c 10;-s 1000;10.0.0.2")
190         ec.set (ping, "StartTime", "1s")
191         ec.set (ping, "StopTime", "20s")
192         ec.register_connection(ping, nsnode1)
193
194         ec.deploy()
195
196         ec.wait_finished([ping])
197
198         expected = "ping -c 10 -s 1000 10.0.0.2"
199         cmdline = ec.trace(ping, "cmdline")
200         self.assertTrue(cmdline.find(expected) > -1, cmdline)
201         
202         expected = "Start Time: NS3 Time:          1s ("
203         status = ec.trace(ping, "status")
204         self.assertTrue(status.find(expected) > -1, status)
205
206         expected = "10 packets transmitted, 10 received, 0% packet loss, time 9002ms"
207         stdout = ec.trace(ping, "stdout")
208         self.assertTrue(stdout.find(expected) > -1, stdout)
209
210         stderr = ec.trace(simu, "stderr")
211         expected = "DceApplication:StartApplication"
212         self.assertTrue(stderr.find(expected) > -1, stderr)
213
214         ec.shutdown()
215
216
217 if __name__ == '__main__':
218     unittest.main()