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