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