Simple cross ping experiment between linux and ns3
[nepi.git] / test / resources / linux / ns3 / cross_ns3_linux_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 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 from nepi.execution.ec import ExperimentController 
22 from nepi.execution.resource import ResourceState, ResourceAction
23 from nepi.execution.trace import TraceAttr
24
25 from test_utils import skipIfNotAlive
26
27 import os
28 import time
29 import unittest
30
31 def add_ns3_node(ec, simu):
32     node = ec.register_resource("ns3::Node")
33     ec.register_connection(node, simu)
34
35     ipv4 = ec.register_resource("ns3::Ipv4L3Protocol")
36     ec.register_connection(node, ipv4)
37
38     arp = ec.register_resource("ns3::ArpL3Protocol")
39     ec.register_connection(node, arp)
40     
41     icmp = ec.register_resource("ns3::Icmpv4L4Protocol")
42     ec.register_connection(node, icmp)
43
44     udp = ec.register_resource("ns3::UdpL4Protocol")
45     ec.register_connection(node, udp)
46
47     return node
48
49 def add_fd_device(ec, node, ip, prefix):
50     dev = ec.register_resource("ns3::FdNetDevice")
51     ec.set(dev, "ip", ip)
52     ec.set(dev, "prefix", prefix)
53     ec.register_connection(node, dev)
54
55     return dev
56
57 def add_tap_device(ec, node, ip, prefix):
58     dev = ec.register_resource("linux::Tap")
59     ec.set(dev, "ip", ip)
60     ec.set(dev, "prefix", prefix)
61     ec.register_connection(node, dev)
62     
63     return dev
64
65 def add_point2point_device(ec, node, ip, prefix):
66     dev = ec.register_resource("ns3::PointToPointNetDevice")
67     ec.set(dev, "ip", ip)
68     ec.set(dev, "prefix", prefix)
69     ec.register_connection(node, dev)
70
71     queue = ec.register_resource("ns3::DropTailQueue")
72     ec.register_connection(dev, queue)
73
74     return dev
75
76 class LinuxNS3FdNetDeviceTest(unittest.TestCase):
77     def setUp(self):
78         self.fedora_host = "nepi2.pl.sophia.inria.fr"
79         self.fedora_user = "inria_nepi"
80         self.fedora_identity = "%s/.ssh/id_rsa_planetlab" % (os.environ['HOME'])
81
82     @skipIfNotAlive
83     def t_cross_ping(self, host, user = None, identity = None):
84         ec = ExperimentController(exp_id = "test-linux-ns3-tap-fd")
85         
86         node = ec.register_resource("linux::Node")
87         if host == "localhost":
88             ec.set(node, "hostname", "localhost")
89         else:
90             ec.set(node, "hostname", host)
91             ec.set(node, "username", user)
92             ec.set(node, "identity", identity)
93         
94         ec.set(node, "cleanProcesses", True)
95         ec.set(node, "cleanExperiment", True)
96
97         simu = ec.register_resource("linux::ns3::Simulation")
98         ec.set(simu, "simulatorImplementationType", "ns3::RealtimeSimulatorImpl")
99         ec.set(simu, "checksumEnabled", True)
100         ec.set(simu, "verbose", True)
101         #ec.set(simu, "buildMode", "debug")
102         #ec.set(simu, "nsLog", "FdNetDevice")
103         ec.register_connection(simu, node)
104
105         nsnode1 = add_ns3_node(ec, simu)
106         dev1 = add_point2point_device(ec, nsnode1, "10.0.0.1", "30")
107
108         nsnode2 = add_ns3_node(ec, simu)
109         dev2 = add_point2point_device(ec, nsnode2, "10.0.0.2", "30")
110         
111         # Add routes on the NS3 side
112         r1 = ec.register_resource("ns3::Route")
113         ec.set(r1, "network", "10.0.1.0")
114         ec.set(r1, "prefix", "30")
115         ec.set(r1, "nexthop", "10.0.0.1")
116         ec.register_connection(r1, nsnode2)
117
118         # Create channel
119         chan = ec.register_resource("ns3::PointToPointChannel")
120         ec.set(chan, "Delay", "0s")
121         ec.register_connection(chan, dev1)
122         ec.register_connection(chan, dev2)
123
124         fddev = add_fd_device(ec, nsnode1, "10.0.1.2", "30")
125         ec.enable_trace(fddev, "pcap")
126         ec.enable_trace(fddev, "promiscPcap")
127         ec.enable_trace(fddev, "ascii")
128
129         tap = add_tap_device(ec, node, "10.0.1.1", "30")
130
131         crosslink = ec.register_resource("linux::ns3::TapFdLink")
132         ec.register_connection(crosslink, tap)
133         ec.register_connection(crosslink, fddev)
134
135         # Add routes on the localhost side
136         r2 = ec.register_resource("linux::Route")
137         ec.set(r2, "network", "10.0.0.0")
138         ec.set(r2, "prefix", "30")
139         ec.set(r2, "nexthop", "10.0.1.2")
140         ec.register_connection(r2, tap)
141
142         app = ec.register_resource("linux::Application")
143         ec.set(app, "command", "ping -c3 10.0.0.1")
144         ec.register_connection(app, node)
145
146         ec.register_condition(app, ResourceAction.START, simu, 
147                 ResourceState.STARTED, time="5s")
148
149         ec.deploy()
150
151         ec.wait_finished([app])
152
153         stdout = ec.trace(app, "stdout")
154         expected = "3 packets transmitted, 3 received, 0% packet loss"
155         self.assertTrue(stdout.find(expected) > -1)
156
157         ## Releasing to force ns3 to flush the traces
158         ec.release()
159         pcap = ec.trace(fddev, "pcap")
160
161         self.assertTrue(len(pcap) > 4000)
162         ec.shutdown()
163
164     def ztest_cross_ping_fedora(self):
165         self.t_cross_ping(self.fedora_host, self.fedora_user, self.fedora_identity)
166
167     def test_cross_ping_local(self):
168         self.t_cross_ping("localhost")
169
170
171 if __name__ == '__main__':
172     unittest.main()
173