enable dce in simulation is now automatic
[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     tcp = ec.register_resource("ns3::TcpL4Protocol")
46     ec.register_connection(node, tcp)
47
48
49     return node
50
51 def add_point2point_device(ec, node, address = None,  prefix = None):
52     dev = ec.register_resource("ns3::PointToPointNetDevice")
53     if address:
54        ec.set(dev, "ip", address)
55     if prefix:
56        ec.set(dev, "prefix", prefix)
57     ec.register_connection(node, dev)
58
59     queue = ec.register_resource("ns3::DropTailQueue")
60     ec.register_connection(dev, queue)
61
62     return dev
63
64 def add_csma_device(ec, node, address = None, prefix = None):
65     dev = ec.register_resource("ns3::CsmaNetDevice")
66     if address:
67         ec.set(dev, "ip", address)
68     if prefix:
69         ec.set(dev, "prefix", prefix)
70     ec.register_connection(node, dev)
71
72     queue = ec.register_resource("ns3::DropTailQueue")
73     ec.register_connection(dev, queue)
74
75     return dev
76
77 def add_wifi_device(ec, node, address = None, prefix = None, 
78         access_point = False):
79     dev = ec.register_resource("ns3::WifiNetDevice")
80     if address:
81         ec.set(dev, "ip", address)
82     if prefix:
83         ec.set(dev, "prefix", prefix)
84     ec.register_connection(node, dev)
85
86     phy = ec.register_resource("ns3::YansWifiPhy")
87     ec.set(phy, "Standard", "WIFI_PHY_STANDARD_80211a")
88     ec.register_connection(dev, phy)
89
90     error = ec.register_resource("ns3::NistErrorRateModel")
91     ec.register_connection(phy, error)
92
93     manager = ec.register_resource("ns3::ArfWifiManager")
94     ec.register_connection(dev, manager)
95
96     if access_point:
97         mac = ec.register_resource("ns3::ApWifiMac")
98     else:
99         mac = ec.register_resource("ns3::StaWifiMac")
100
101     ec.set(mac, "Standard", "WIFI_PHY_STANDARD_80211a")
102     ec.register_connection(dev, mac)
103
104     return dev, phy
105
106 def add_random_mobility(ec, node, x, y, z, speed, bounds_width, 
107         bounds_height):
108     position = "%d:%d:%d" % (x, y, z)
109     bounds = "0|%d|0|%d" % (bounds_width, bounds_height) 
110     speed = "ns3::UniformRandomVariable[Min=%d|Max=%s]" % (speed, speed)
111     pause = "ns3::ConstantRandomVariable[Constant=1.0]"
112     
113     mobility = ec.register_resource("ns3::RandomDirection2dMobilityModel")
114     ec.set(mobility, "Position", position)
115     ec.set(mobility, "Bounds", bounds)
116     ec.set(mobility, "Speed", speed)
117     ec.set(mobility, "Pause",  pause)
118     ec.register_connection(node, mobility)
119     return mobility
120
121 def add_constant_mobility(ec, node, x, y, z):
122     mobility = ec.register_resource("ns3::ConstantPositionMobilityModel") 
123     position = "%d:%d:%d" % (x, y, z)
124     ec.set(mobility, "Position", position)
125     ec.register_connection(node, mobility)
126     return mobility
127
128 def add_wifi_channel(ec):
129     channel = ec.register_resource("ns3::YansWifiChannel")
130     delay = ec.register_resource("ns3::ConstantSpeedPropagationDelayModel")
131     ec.register_connection(channel, delay)
132
133     loss  = ec.register_resource("ns3::LogDistancePropagationLossModel")
134     ec.register_connection(channel, loss)
135
136     return channel
137
138 class LinuxNS3DceApplicationTest(unittest.TestCase):
139     def setUp(self):
140         #self.fedora_host = "nepi2.pl.sophia.inria.fr"
141         #self.fedora_host = "planetlabpc1.upf.edu"
142         #self.fedora_user = "inria_nepi"
143         #self.fedora_identity = "%s/.ssh/id_rsa_planetlab" % (os.environ['HOME'])
144         self.fedora_host = "mimas.inria.fr"
145         self.fedora_user = "aquereil"
146         self.fedora_identity = "%s/.ssh/id_rsa" % (os.environ['HOME'])
147
148     def test_dce_ping(self):
149         ec = ExperimentController(exp_id = "test-dce-ping")
150         
151         node = ec.register_resource("LinuxNode")
152         ec.set(node, "hostname", self.fedora_host)
153         ec.set(node, "username", self.fedora_user)
154         ec.set(node, "identity", self.fedora_identity)
155         #ec.set(node, "cleanProcesses", True)
156         #ec.set(node, "cleanHome", True)
157
158         simu = ec.register_resource("LinuxNS3Simulation")
159         ec.set(simu, "verbose", True)
160         ec.set(simu, "buildMode", "debug")
161         ec.set(simu, "nsLog", "DceApplication")
162         ec.register_connection(simu, node)
163
164         nsnode1 = add_ns3_node(ec, simu)
165         p2p1 = add_point2point_device(ec, nsnode1, "10.0.0.1", "30")
166         ec.set(p2p1, "DataRate", "5Mbps")
167
168         nsnode2 = add_ns3_node(ec, simu)
169         p2p2 = add_point2point_device(ec, nsnode2, "10.0.0.2", "30")
170         ec.set(p2p2, "DataRate", "5Mbps")
171
172         # Create channel
173         chan = ec.register_resource("ns3::PointToPointChannel")
174         ec.set(chan, "Delay", "2ms")
175
176         ec.register_connection(chan, p2p1)
177         ec.register_connection(chan, p2p2)
178
179         ### create applications
180         ping = ec.register_resource("ns3::LinuxDceApplication")
181         ec.set (ping, "sources", "http://www.skbuff.net/iputils/iputils-s20101006.tar.bz2")
182         ec.set (ping, "build", "tar xvjf ${SRC}/iputils-s20101006.tar.bz2 && "
183                 "cd iputils-s20101006/ && "
184                 "sed -i 's/CFLAGS=/CFLAGS+=/g' Makefile && "
185                 "make CFLAGS=-fPIC LDFLAGS=-pie ping && "
186                 "cp ping ${BIN_DCE} && cd - ")
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     def test_dce_ccn(self):
217         ec = ExperimentController(exp_id = "test-dce-ccn")
218         
219         node = ec.register_resource("LinuxNode")
220         ec.set(node, "hostname", self.fedora_host)
221         ec.set(node, "username", self.fedora_user)
222         ec.set(node, "identity", self.fedora_identity)
223         #ec.set(node, "cleanProcesses", True)
224         #ec.set(node, "cleanHome", True)
225
226         simu = ec.register_resource("LinuxNS3Simulation")
227         ec.set(simu, "verbose", True)
228         ec.set(simu, "buildMode", "debug")
229         ec.set(simu, "nsLog", "DceApplication")
230         ec.register_connection(simu, node)
231
232         nsnode1 = add_ns3_node(ec, simu)
233         p2p1 = add_point2point_device(ec, nsnode1, "10.0.0.1", "30")
234         ec.set(p2p1, "DataRate", "5Mbps")
235
236         nsnode2 = add_ns3_node(ec, simu)
237         p2p2 = add_point2point_device(ec, nsnode2, "10.0.0.2", "30")
238         ec.set(p2p2, "DataRate", "5Mbps")
239
240         # Create channel
241         chan = ec.register_resource("ns3::PointToPointChannel")
242         ec.set(chan, "Delay", "2ms")
243
244         ec.register_connection(chan, p2p1)
245         ec.register_connection(chan, p2p2)
246
247         ### create applications
248         ccnd1 = ec.register_resource("ns3::LinuxCCNDceApplication")
249
250         ec.set(ccnd1, "depends", "libpcap0.8-dev openjdk-6-jdk ant1.8 autoconf "
251             "libssl-dev libexpat-dev libpcap-dev libecryptfs0 libxml2-utils auto"
252             "make gawk gcc g++ git-core pkg-config libpcre3-dev openjdk-6-jre-lib")
253         ec.set (ccnd1, "sources", "http://www.ccnx.org/releases/ccnx-0.7.2.tar.gz")
254         ec.set (ccnd1, "build", "tar zxf ${SRC}/ccnx-0.7.2.tar.gz && "
255                 "cd ccnx-0.7.2 && "
256                 " INSTALL_BASE=${BIN_DCE}/.. ./configure && "
257                 " make MORE_LDLIBS=-pie && "
258                 " make install && "
259                 " cp ${BIN_DCE}/../bin/ccn* ${BIN_DCE} && "
260                 " cd -")
261         ec.set (ccnd1, "binary", "ccnd")
262         ec.set (ccnd1, "stackSize", 1<<20)
263         ec.set (ccnd1, "environment", "CCND_CAP=50000; CCND_DEBUG=7")
264         ec.set (ccnd1, "StartTime", "1s")
265         ec.set (ccnd1, "StopTime", "20s")
266         ec.register_connection(ccnd1, nsnode1)
267
268         repofile = os.path.join(
269             os.path.dirname(os.path.realpath(__file__)), "ccn", 
270             "repoFile1")
271
272         ccnr = ec.register_resource("ns3::LinuxCCNDceApplication")
273         ec.set (ccnr, "binary", "ccnr")
274         ec.set (ccnr, "environment", "CCNR_DIRECTORY=/REPO/")
275         ec.set (ccnr, "files", "%s=/REPO/repoFile1" % repofile) 
276         ec.set (ccnr, "stackSize", 1<<20)
277         ec.set (ccnr, "StartTime", "2s")
278         ec.set (ccnr, "StopTime", "120s")
279         ec.register_connection(ccnr, nsnode1)
280
281         ccndc1 = ec.register_resource("ns3::LinuxCCNDceApplication")
282         ec.set (ccndc1, "binary", "ccndc")
283         ec.set (ccndc1, "arguments", "-v;add;ccnx:/;udp;10.0.0.2")
284         ec.set (ccndc1, "stackSize", 1<<20)
285         ec.set (ccndc1, "StartTime", "2s")
286         ec.set (ccndc1, "StopTime", "120s")
287         ec.register_connection(ccndc1, nsnode1)
288
289         ccnd2 = ec.register_resource("ns3::LinuxCCNDceApplication")
290         ec.set (ccnd2, "binary", "ccnd")
291         ec.set (ccnd2, "stackSize", 1<<20)
292         ec.set (ccnd2, "environment", "CCND_CAP=50000; CCND_DEBUG=7")
293         ec.set (ccnd2, "StartTime", "1s")
294         ec.set (ccnd2, "StopTime", "120s")
295         ec.register_connection(ccnd2, nsnode2)
296
297         ccndc2 = ec.register_resource("ns3::LinuxCCNDceApplication")
298         ec.set (ccndc2, "binary", "ccndc")
299         ec.set (ccndc2, "arguments", "-v;add;ccnx:/;udp;10.0.0.1")
300         ec.set (ccndc2, "stackSize", 1<<20)
301         ec.set (ccndc2, "StartTime", "2s")
302         ec.set (ccndc2, "StopTime", "120s")
303         ec.register_connection(ccndc2, nsnode2)
304
305         ccnpeek = ec.register_resource("ns3::LinuxCCNDceApplication")
306         ec.set (ccnpeek, "binary", "ccnpeek")
307         ec.set (ccnpeek, "arguments", "ccnx:/test/bunny.ts")
308         ec.set (ccnpeek, "stdinFile", "")
309         ec.set (ccnpeek, "stackSize", 1<<20)
310         ec.set (ccnpeek, "StartTime", "4s")
311         ec.set (ccnpeek, "StopTime", "120s")
312         ec.register_connection(ccnpeek, nsnode2)
313
314         ccncat = ec.register_resource("ns3::LinuxCCNDceApplication")
315         ec.set (ccncat, "binary", "ccncat")
316         ec.set (ccncat, "arguments", "ccnx:/test/bunny.ts")
317         ec.set (ccncat, "stdinFile", "")
318         ec.set (ccncat, "stackSize", 1<<20)
319         ec.set (ccncat, "StartTime", "4s")
320         ec.set (ccncat, "StopTime", "120s")
321         ec.register_connection(ccncat, nsnode2)
322
323         ec.deploy()
324
325         ec.wait_finished([ccncat])
326
327         expected = "ccncat ccnx:/test/bunny.ts"
328         cmdline = ec.trace(ccncat, "cmdline")
329         self.assertTrue(cmdline.find(expected) > -1, cmdline)
330
331         expected = "Start Time: NS3 Time:          4s ("
332         status = ec.trace(ccncat, "status")
333         self.assertTrue(status.find(expected) > -1, status)
334
335         expected = 2873956
336         stdout = ec.trace(ccncat, "stdout")
337         self.assertTrue(len(stdout) == expected , stdout)
338
339         ec.shutdown()
340
341 if __name__ == '__main__':
342     unittest.main()