a3e0ba5fcb5008e073bede754d445fe78c934d22
[nepi.git] / test / resources / linux / ns3 / cross_ns3_linux_tuntapfdlink_ping.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 version 2 as
8 #    published by the Free Software Foundation;
9 #
10 #    This program is distributed in the hope that it will be useful,
11 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
12 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 #    GNU General Public License for more details.
14 #
15 #    You should have received a copy of the GNU General Public License
16 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 #
18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
19
20 from nepi.execution.ec import ExperimentController 
21 from nepi.execution.resource import ResourceState, ResourceAction
22 from nepi.execution.trace import TraceAttr
23
24 from test_utils import skipIfNotAlive
25
26 import os
27 import time
28 import unittest
29
30 def add_ns3_node(ec, simu):
31     node = ec.register_resource("ns3::Node")
32     ec.set(node, "enableStack", True)
33     ec.register_connection(node, simu)
34
35     """
36     ipv4 = ec.register_resource("ns3::Ipv4L3Protocol")
37     ec.register_connection(node, ipv4)
38
39     arp = ec.register_resource("ns3::ArpL3Protocol")
40     ec.register_connection(node, arp)
41     
42     icmp = ec.register_resource("ns3::Icmpv4L4Protocol")
43     ec.register_connection(node, icmp)
44
45     udp = ec.register_resource("ns3::UdpL4Protocol")
46     ec.register_connection(node, udp)
47     """
48
49     return node
50
51 def add_fd_device(ec, node, ip, prefix):
52     dev = ec.register_resource("ns3::FdNetDevice")
53     ec.set(dev, "ip", ip)
54     ec.set(dev, "prefix", prefix)
55     ec.register_connection(node, dev)
56
57     return dev
58
59 def add_tap_device(ec, node, ip, prefix):
60     dev = ec.register_resource("linux::Tap")
61     ec.set(dev, "ip", ip)
62     ec.set(dev, "prefix", prefix)
63     ec.register_connection(node, dev)
64     
65     return dev
66
67 def add_point2point_device(ec, node, ip, prefix):
68     dev = ec.register_resource("ns3::PointToPointNetDevice")
69     ec.set(dev, "ip", ip)
70     ec.set(dev, "prefix", prefix)
71     ec.register_connection(node, dev)
72
73     queue = ec.register_resource("ns3::DropTailQueue")
74     ec.register_connection(dev, queue)
75
76     return dev
77
78 class LinuxNS3FdNetDeviceTest(unittest.TestCase):
79     def setUp(self):
80         self.fedora_host = "nepi2.pl.sophia.inria.fr"
81         self.fedora_user = "inria_nepi"
82         self.fedora_identity = "%s/.ssh/id_rsa_planetlab" % (os.environ['HOME'])
83
84         self.ubuntu_host = "roseval.pl.sophia.inria.fr"
85         self.ubuntu_user = "inria_nepi"
86         self.ubuntu_identity = "%s/.ssh/id_rsa" % (os.environ['HOME'])
87
88     @skipIfNotAlive
89     def t_cross_ping(self, host, user = None, identity = None):
90         ec = ExperimentController(exp_id = "test-linux-ns3-tap-fd")
91         
92         node = ec.register_resource("linux::Node")
93         if host == "localhost":
94             ec.set(node, "hostname", "localhost")
95         else:
96             ec.set(node, "hostname", host)
97             ec.set(node, "username", user)
98             ec.set(node, "identity", identity)
99         
100         ec.set(node, "cleanProcesses", True)
101         ec.set(node, "cleanExperiment", True)
102
103         simu = ec.register_resource("linux::ns3::Simulation")
104         ec.set(simu, "simulatorImplementationType", "ns3::RealtimeSimulatorImpl")
105         ec.set(simu, "checksumEnabled", True)
106         ec.set(simu, "verbose", True)
107         #ec.set(simu, "buildMode", "debug")
108         #ec.set(simu, "nsLog", "FdNetDevice")
109         ec.register_connection(simu, node)
110
111         nsnode1 = add_ns3_node(ec, simu)
112         dev1 = add_point2point_device(ec, nsnode1, "10.0.0.1", "30")
113
114         nsnode2 = add_ns3_node(ec, simu)
115         dev2 = add_point2point_device(ec, nsnode2, "10.0.0.2", "30")
116         
117         # Add routes on the NS3 side
118         r1 = ec.register_resource("ns3::Route")
119         ec.set(r1, "network", "10.0.1.0")
120         ec.set(r1, "prefix", "30")
121         ec.set(r1, "nexthop", "10.0.0.1")
122         ec.register_connection(r1, nsnode2)
123
124         # Create channel
125         chan = ec.register_resource("ns3::PointToPointChannel")
126         ec.set(chan, "Delay", "0s")
127         ec.register_connection(chan, dev1)
128         ec.register_connection(chan, dev2)
129
130         fddev = add_fd_device(ec, nsnode1, "10.0.1.2", "30")
131         ec.enable_trace(fddev, "pcap")
132         ec.enable_trace(fddev, "promiscPcap")
133         ec.enable_trace(fddev, "ascii")
134
135         tap = add_tap_device(ec, node, "10.0.1.1", "30")
136
137         crosslink = ec.register_resource("linux::ns3::TunTapFdLink")
138         ec.register_connection(crosslink, tap)
139         ec.register_connection(crosslink, fddev)
140
141         # Add routes on the localhost side
142         r2 = ec.register_resource("linux::Route")
143         ec.set(r2, "network", "10.0.0.0")
144         ec.set(r2, "prefix", "30")
145         ec.set(r2, "nexthop", "10.0.1.2")
146         ec.register_connection(r2, tap)
147
148         app = ec.register_resource("linux::Application")
149         ec.set(app, "command", "ping -c3 10.0.0.1")
150         ec.register_connection(app, node)
151
152         ec.register_condition(app, ResourceAction.START, simu, 
153                 ResourceState.STARTED, time="5s")
154
155         ec.deploy()
156
157         ec.wait_finished([app])
158
159         stdout = ec.trace(app, "stdout")
160         print stdout
161         expected = "3 packets transmitted, 3 received, 0% packet loss"
162         self.assertTrue(stdout.find(expected) > -1)
163
164         ## Releasing to force ns3 to flush the traces
165         ec.release()
166         pcap = ec.trace(fddev, "pcap")
167
168         self.assertTrue(len(pcap) > 4000)
169         ec.shutdown()
170
171     def ztest_cross_ping_fedora(self):
172         self.t_cross_ping(self.fedora_host, self.fedora_user, self.fedora_identity)
173
174     def test_cross_ping_ubuntu(self):
175         self.t_cross_ping(self.ubuntu_host, self.ubuntu_user, self.ubuntu_identity)
176
177     def test_cross_ping_local(self):
178         self.t_cross_ping("localhost")
179
180
181 if __name__ == '__main__':
182     unittest.main()
183