Added attributes for ns-3 simulator. Realtime mode working
[nepi.git] / test / resources / linux / ns3 / ns3simulation.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 #
23 # Network topology
24 #
25 #       n0    n1   n2   n3
26 #       |     |    |    |
27 #       -----------------
28 #
29 #  node n0 sends IGMP traffic to node n3
30
31
32 from nepi.execution.ec import ExperimentController 
33
34 import os
35 import time
36 import unittest
37
38 class LinuxNS3ClientTest(unittest.TestCase):
39     def setUp(self):
40         self.fedora_host = "nepi2.pl.sophia.inria.fr"
41         #self.fedora_host = "peeramide.irisa.fr"
42         self.fedora_user = "inria_test"
43
44     def ztest_simple_ping(self):
45         ec = ExperimentController(exp_id = "test-ns3-ping")
46         
47         node = ec.register_resource("LinuxNode")
48         ec.set(node, "hostname", self.fedora_host)
49         ec.set(node, "username", self.fedora_user)
50         ec.set(node, "cleanProcesses", True)
51         ec.set(node, "cleanHome", True)
52
53         simu = ec.register_resource("LinuxNS3Simulation")
54         ec.set(simu, "verbose", True)
55         ec.set(simu, "nsLog", "V4Ping:Node")
56         ec.register_connection(simu, node)
57
58         nsnode1 = ec.register_resource("ns3::Node")
59         ec.register_connection(nsnode1, simu)
60
61         ipv41 = ec.register_resource("ns3::Ipv4L3Protocol")
62         ec.register_connection(nsnode1, ipv41)
63
64         arp1 = ec.register_resource("ns3::ArpL3Protocol")
65         ec.register_connection(nsnode1, arp1)
66         
67         icmp1 = ec.register_resource("ns3::Icmpv4L4Protocol")
68         ec.register_connection(nsnode1, icmp1)
69
70         p1 = ec.register_resource("ns3::PointToPointNetDevice")
71         ec.set(p1, "ip", "10.0.0.1")
72         ec.set(p1, "prefix", "30")
73         ec.register_connection(nsnode1, p1)
74         q1 = ec.register_resource("ns3::DropTailQueue")
75         ec.register_connection(p1, q1)
76
77         nsnode2 = ec.register_resource("ns3::Node")
78         ec.register_connection(nsnode2, simu)
79
80         ipv42 = ec.register_resource("ns3::Ipv4L3Protocol")
81         ec.register_connection(nsnode2, ipv42)
82
83         arp2 = ec.register_resource("ns3::ArpL3Protocol")
84         ec.register_connection(nsnode2, arp2)
85         
86         icmp2 = ec.register_resource("ns3::Icmpv4L4Protocol")
87         ec.register_connection(nsnode2, icmp2)
88
89         p2 = ec.register_resource("ns3::PointToPointNetDevice")
90         ec.set(p2, "ip", "10.0.0.2")
91         ec.set(p2, "prefix", "30")
92         ec.register_connection(nsnode2, p2)
93         q2 = ec.register_resource("ns3::DropTailQueue")
94         ec.register_connection(p2, q2)
95
96         # Create channel
97         chan = ec.register_resource("ns3::PointToPointChannel")
98         ec.set(chan, "Delay", "0s")
99         ec.register_connection(chan, p1)
100         ec.register_connection(chan, p2)
101
102         ### create pinger
103         ping = ec.register_resource("ns3::V4Ping")
104         ec.set (ping, "Remote", "10.0.0.2")
105         ec.set (ping, "Interval", "1s")
106         ec.set (ping, "Verbose", True)
107         ec.set (ping, "StartTime", "0s")
108         ec.set (ping, "StopTime", "20s")
109         ec.register_connection(ping, nsnode1)
110
111         ec.deploy()
112
113         ec.wait_finished([ping])
114         
115         stdout = ec.trace(simu, "stdout") 
116
117         expected = "20 packets transmitted, 20 received, 0% packet loss"
118         self.assertTrue(stdout.find(expected) > -1)
119
120         ec.shutdown()
121
122     def ztest_real_time(self):
123         ec = ExperimentController(exp_id = "test-ns3-real-time")
124         
125         node = ec.register_resource("LinuxNode")
126         ec.set(node, "hostname", self.fedora_host)
127         ec.set(node, "username", self.fedora_user)
128         ec.set(node, "cleanProcesses", True)
129         ec.set(node, "cleanHome", True)
130
131         simu = ec.register_resource("LinuxNS3Simulation")
132         ec.set(simu, "verbose", True)
133         ec.set(simu, "simulatorImplementationType", "ns3::RealtimeSimulatorImpl")
134         ec.set(simu, "checksumEnabled", True)
135         ec.register_connection(simu, node)
136
137         nsnode1 = ec.register_resource("ns3::Node")
138         ec.register_connection(nsnode1, simu)
139
140         ipv41 = ec.register_resource("ns3::Ipv4L3Protocol")
141         ec.register_connection(nsnode1, ipv41)
142
143         arp1 = ec.register_resource("ns3::ArpL3Protocol")
144         ec.register_connection(nsnode1, arp1)
145         
146         icmp1 = ec.register_resource("ns3::Icmpv4L4Protocol")
147         ec.register_connection(nsnode1, icmp1)
148
149         p1 = ec.register_resource("ns3::PointToPointNetDevice")
150         ec.set(p1, "ip", "10.0.0.1")
151         ec.set(p1, "prefix", "30")
152         ec.register_connection(nsnode1, p1)
153         q1 = ec.register_resource("ns3::DropTailQueue")
154         ec.register_connection(p1, q1)
155
156         nsnode2 = ec.register_resource("ns3::Node")
157         ec.register_connection(nsnode2, simu)
158
159         ipv42 = ec.register_resource("ns3::Ipv4L3Protocol")
160         ec.register_connection(nsnode2, ipv42)
161
162         arp2 = ec.register_resource("ns3::ArpL3Protocol")
163         ec.register_connection(nsnode2, arp2)
164         
165         icmp2 = ec.register_resource("ns3::Icmpv4L4Protocol")
166         ec.register_connection(nsnode2, icmp2)
167
168         p2 = ec.register_resource("ns3::PointToPointNetDevice")
169         ec.set(p2, "ip", "10.0.0.2")
170         ec.set(p2, "prefix", "30")
171         ec.register_connection(nsnode2, p2)
172         q2 = ec.register_resource("ns3::DropTailQueue")
173         ec.register_connection(p2, q2)
174
175         # Create channel
176         chan = ec.register_resource("ns3::PointToPointChannel")
177         ec.set(chan, "Delay", "0s")
178         ec.register_connection(chan, p1)
179         ec.register_connection(chan, p2)
180
181         ### create pinger
182         ping = ec.register_resource("ns3::V4Ping")
183         ec.set (ping, "Remote", "10.0.0.2")
184         ec.set (ping, "Interval", "1s")
185         ec.set (ping, "Verbose", True)
186         ec.set (ping, "StartTime", "0s")
187         ec.set (ping, "StopTime", "20s")
188         ec.register_connection(ping, nsnode1)
189
190         ec.deploy()
191
192         ec.wait_finished([ping])
193        
194         stdout = ec.trace(simu, "stdout") 
195
196         expected = "20 packets transmitted, 20 received, 0% packet loss"
197         self.assertTrue(stdout.find(expected) > -1)
198
199         rm = ec.get_resource(ping)
200         start_time = rm.start_time
201         stop_time = rm.stop_time
202         delta =  stop_time - start_time
203
204         self.assertTrue(delta.seconds >= 20)
205         self.assertTrue(delta.seconds < 25)
206
207         ec.shutdown()
208
209     def test_stop_time(self):
210         ec = ExperimentController(exp_id = "test-ns3-stop-time")
211         
212         node = ec.register_resource("LinuxNode")
213         ec.set(node, "hostname", self.fedora_host)
214         ec.set(node, "username", self.fedora_user)
215         ec.set(node, "cleanProcesses", True)
216         #ec.set(node, "cleanHome", True)
217
218         simu = ec.register_resource("LinuxNS3Simulation")
219         ec.set(simu, "verbose", True)
220         ec.set(simu, "simulatorImplementationType", "ns3::RealtimeSimulatorImpl")
221         ec.set(simu, "checksumEnabled", True)
222         ec.set(simu, "stopTime", "20s")
223         ec.register_connection(simu, node)
224
225         ec.deploy()
226
227         ec.wait_finished([simu])
228        
229         rm = ec.get_resource(simu)
230         start_time = rm.start_time
231         stop_time = rm.stop_time
232         delta =  stop_time - start_time
233
234         print delta.seconds
235         self.assertTrue(delta.seconds >= 20)
236         self.assertTrue(delta.seconds < 25)
237
238         ec.shutdown()
239
240 if __name__ == '__main__':
241     unittest.main()
242