Fixes ns-3/DCE
[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         self.fedora_host = "nepi2.pl.sophia.inria.fr"
137         #self.fedora_host = "planetlabpc1.upf.edu"
138         self.fedora_user = "inria_nepi"
139         self.fedora_identity = "%s/.ssh/id_rsa_planetlab" % (os.environ['HOME'])
140
141     def test_dce_ping(self):
142         ec = ExperimentController(exp_id = "test-dce-ping")
143         
144         node = ec.register_resource("LinuxNode")
145         ec.set(node, "hostname", self.fedora_host)
146         ec.set(node, "username", self.fedora_user)
147         ec.set(node, "identity", self.fedora_identity)
148         ec.set(node, "cleanProcesses", True)
149         #ec.set(node, "cleanHome", True)
150
151         simu = ec.register_resource("LinuxNS3Simulation")
152         ec.set(simu, "verbose", True)
153         ec.set(simu, "enableDCE", True)
154         ec.set(simu, "buildMode", "debug")
155         ec.set(simu, "nsLog", "DceApplication")
156         ec.register_connection(simu, node)
157
158         nsnode1 = add_ns3_node(ec, simu)
159         ec.set(nsnode1, "enableDCE", True)
160         p2p1 = add_point2point_device(ec, nsnode1, "10.0.0.1", "30")
161         ec.set(p2p1, "DataRate", "5Mbps")
162
163         nsnode2 = add_ns3_node(ec, simu)
164         ec.set(nsnode2, "enableDCE", True)
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 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     def test_dce_ccn(self):
213         ec = ExperimentController(exp_id = "test-dce-ccn")
214         
215         node = ec.register_resource("LinuxNode")
216         ec.set(node, "hostname", self.fedora_host)
217         ec.set(node, "username", self.fedora_user)
218         ec.set(node, "identity", self.fedora_identity)
219         ec.set(node, "cleanProcesses", True)
220         #ec.set(node, "cleanHome", True)
221
222         simu = ec.register_resource("LinuxNS3Simulation")
223         ec.set(simu, "verbose", True)
224         ec.set(simu, "enableDCE", True)
225         ec.set(simu, "buildMode", "debug")
226         ec.set(simu, "nsLog", "DceApplication")
227         ec.register_connection(simu, node)
228
229         nsnode1 = add_ns3_node(ec, simu)
230         ec.set(nsnode1, "enableDCE", True)
231         p2p1 = add_point2point_device(ec, nsnode1, "10.0.0.1", "30")
232         ec.set(p2p1, "DataRate", "5Mbps")
233
234         nsnode2 = add_ns3_node(ec, simu)
235         ec.set(nsnode2, "enableDCE", True)
236         p2p2 = add_point2point_device(ec, nsnode2, "10.0.0.2", "30")
237         ec.set(p2p2, "DataRate", "5Mbps")
238
239         # Create channel
240         chan = ec.register_resource("ns3::PointToPointChannel")
241         ec.set(chan, "Delay", "2ms")
242
243         ec.register_connection(chan, p2p1)
244         ec.register_connection(chan, p2p2)
245
246         ### create applications
247         ccnd1 = ec.register_resource("ns3::LinuxCCNDceApplication")
248         ec.set(ccnd1, "depends", "libpcap0.8-dev openjdk-6-jdk ant1.8 autoconf "
249             "libssl-dev libexpat-dev libpcap-dev libecryptfs0 libxml2-utils auto"
250             "make gawk gcc g++ git-core pkg-config libpcre3-dev openjdk-6-jre-lib")
251         ec.set (ccnd1, "sources", "http://www.ccnx.org/releases/ccnx-0.7.2.tar.gz")
252         ec.set (ccnd1, "build", "tar zxf ${SRC}/ccnx-0.7.2.tar.gz && "
253                 "cd ccnx-0.7.2 && "
254                 " INSTALL_BASE=${BIN_DCE}/.. ./configure && "
255                 " make MORE_LDLIBS=-pie && "
256                 " make install && cd -")
257         ec.set (ccnd1, "binary", "ccndstart")
258         ec.set (ccnd1, "stackSize", 1<<20)
259         ec.set (ccnd1, "StartTime", "1s")
260         ec.set (ccnd1, "StopTime", "20s")
261         ec.register_connection(ccnd1, nsnode1)
262
263         ccnkill1 = ec.register_resource("ns3::LinuxCCNDceApplication")
264         ec.set (ccnkill1, "binary", "ccnsmoketest")
265         ec.set (ccnkill1, "arguments", "kill")
266         ec.set (ccnkill1, "stdinFile", "")
267         ec.set (ccnkill1, "stackSize", 1<<20)
268         ec.set (ccnkill1, "StartTime", "110s")
269         ec.set (ccnkill1, "StopTime", "120s")
270         ec.register_connection(ccnkill1, nsnode1)
271
272         repofile = os.path.join(
273             os.path.dirname(os.path.realpath(__file__)),
274             "repoFile1")
275
276         ccnr = ec.register_resource("ns3::LinuxCCNDceApplication")
277         ec.set (ccnr, "binary", "ccnr")
278         ec.set (ccnr, "environment", "CCNR_DIRECTORY=/REPO/")
279         ec.set (ccnr, "files", "%s=/REPO/repoFile1" % repofile) 
280         ec.set (ccnr, "stackSize", 1<<20)
281         ec.set (ccnr, "StartTime", "2s")
282         ec.set (ccnr, "StopTime", "120s")
283         ec.register_connection(ccnr, nsnode1)
284
285         ccndc1 = ec.register_resource("ns3::LinuxCCNDceApplication")
286         ec.set (ccndc1, "binary", "ccndc")
287         ec.set (ccndc1, "arguments", "-v;add;ccnx:/;udp;10.0.0.2")
288         ec.set (ccndc1, "stackSize", 1<<20)
289         ec.set (ccndc1, "StartTime", "2s")
290         ec.set (ccndc1, "StopTime", "120s")
291         ec.register_connection(ccndc1, nsnode1)
292
293         ccnd2 = ec.register_resource("ns3::LinuxCCNDceApplication")
294         ec.set (ccnd2, "binary", "ccndstart")
295         ec.set (ccnd2, "stackSize", 1<<20)
296         ec.set (ccnd2, "StartTime", "1s")
297         ec.set (ccnd2, "StopTime", "120s")
298         ec.register_connection(ccnd2, nsnode2)
299
300         ccndc2 = ec.register_resource("ns3::LinuxCCNDceApplication")
301         ec.set (ccndc2, "binary", "ccndc")
302         ec.set (ccndc2, "arguments", "-v;add;ccnx:/;udp;10.0.0.1")
303         ec.set (ccndc2, "stackSize", 1<<20)
304         ec.set (ccndc2, "StartTime", "2s")
305         ec.set (ccndc2, "StopTime", "120s")
306         ec.register_connection(ccndc2, nsnode2)
307
308         ccnpeek = ec.register_resource("ns3::LinuxCCNDceApplication")
309         ec.set (ccnpeek, "binary", "ccnpeek")
310         ec.set (ccnpeek, "arguments", "ccnx:/test/bunny.ts")
311         ec.set (ccnpeek, "stdinFile", "")
312         ec.set (ccnpeek, "stackSize", 1<<20)
313         ec.set (ccnpeek, "StartTime", "4s")
314         ec.set (ccnpeek, "StopTime", "120s")
315         ec.register_connection(ccnpeek, nsnode2)
316
317         ccncat = ec.register_resource("ns3::LinuxCCNDceApplication")
318         ec.set (ccncat, "binary", "ccncat")
319         ec.set (ccncat, "arguments", "ccnx:/test/bunny.ts")
320         ec.set (ccncat, "stdinFile", "")
321         ec.set (ccncat, "stackSize", 1<<20)
322         ec.set (ccncat, "StartTime", "4s")
323         ec.set (ccncat, "StopTime", "120s")
324         ec.register_connection(ccncat, nsnode2)
325
326         ccnkill2 = ec.register_resource("ns3::LinuxCCNDceApplication")
327         ec.set (ccnkill2, "binary", "ccnsmoketest")
328         ec.set (ccnkill2, "arguments", "kill")
329         ec.set (ccnkill2, "stdinFile", "")
330         ec.set (ccnkill2, "stackSize", 1<<20)
331         ec.set (ccnkill2, "StartTime", "110s")
332         ec.set (ccnkill2, "StopTime", "120s")
333         ec.register_connection(ccnkill2, nsnode2)
334
335         ec.deploy()
336
337         ec.wait_finished([ccncat, ccnkill1, ccnkill2])
338
339         print ec.trace(ccncat, "cmdline")
340         """
341         expected = "ping -c 10 -s 1000 10.0.0.2"
342         cmdline = ec.trace(ping, "cmdline")
343         self.assertTrue(cmdline.find(expected) > -1, cmdline)
344         """
345
346         print ec.trace(ccncat, "status")
347         """
348         expected = "Start Time: NS3 Time:          1s ("
349         status = ec.trace(ping, "status")
350         self.assertTrue(status.find(expected) > -1, status)
351         """
352
353         print len(ec.trace(ccncat, "stdout"))
354         """
355         expected = "10 packets transmitted, 10 received, 0% packet loss, time 9002ms"
356         stdout = ec.trace(ping, "stdout")
357         self.assertTrue(stdout.find(expected) > -1, stdout)
358         """
359
360         stderr = ec.trace(simu, "stderr")
361         expected = "DceApplication:StartApplication"
362         self.assertTrue(stderr.find(expected) > -1, stderr)
363
364         ec.shutdown()
365
366 if __name__ == '__main__':
367     unittest.main()