Various fixes:
[nepi.git] / test / testbeds / planetlab / integration_cross.py
1 #!/usr/bin/env python
2 # -*- coding: utf-8 -*-
3
4 import getpass
5 from nepi.core.design import ExperimentDescription, FactoriesProvider
6 from nepi.core.execute import ExperimentController
7 from nepi.util import proxy
8 from nepi.util.constants import DeploymentConfiguration as DC, ATTR_NEPI_TESTBED_ENVIRONMENT_SETUP
9 import os
10 import shutil
11 import tempfile
12 import test_util
13 import time
14 import unittest
15 import re
16
17 class PlanetLabMultiIntegrationTestCase(unittest.TestCase):
18     testbed_id = "planetlab"
19     
20     slicename1 = "inria_nepi"
21     plchost1 = "nepiplc.pl.sophia.inria.fr"
22
23     slicename2 = "inria_nepi12"
24     plchost2 = "www.planet-lab.eu"
25     
26     host1pl1 = "nepi1.pl.sophia.inria.fr"
27     host2pl1 = "nepi2.pl.sophia.inria.fr"
28
29     host1pl2 = "planetlab1.utt.fr"
30     host2pl2 = "planetlab2.utt.fr"
31
32     port_base = 2000 + (os.getpid() % 1000) * 13
33     
34     def setUp(self):
35         self.root_dir = tempfile.mkdtemp()
36         self.__class__.port_base = self.port_base + 100
37
38     def tearDown(self):
39         try:
40             shutil.rmtree(self.root_dir)
41         except:
42             # retry
43             time.sleep(0.1)
44             shutil.rmtree(self.root_dir)
45
46     def make_experiment_desc(self):
47         testbed_id = self.testbed_id
48         
49         slicename1 = self.slicename1
50         plchost1 = self.plchost1
51         
52         slicename2 = self.slicename2
53         plchost2 = self.plchost2
54         
55         pl_ssh_key = os.environ.get(
56             "PL_SSH_KEY",
57             "%s/.ssh/id_rsa_planetlab" % (os.environ['HOME'],) )
58         pl_user, pl_pwd = test_util.pl_auth()
59
60         exp_desc = ExperimentDescription()
61         pl_provider = FactoriesProvider(testbed_id)
62         pl_desc = exp_desc.add_testbed_description(pl_provider)
63         pl_desc.set_attribute_value("homeDirectory", self.root_dir)
64         pl_desc.set_attribute_value("slice", slicename1)
65         pl_desc.set_attribute_value("sliceSSHKey", pl_ssh_key)
66         pl_desc.set_attribute_value("authUser", pl_user)
67         pl_desc.set_attribute_value("authPass", pl_pwd)
68         pl_desc.set_attribute_value("plcHost", plchost1)
69         pl_desc.set_attribute_value("tapPortBase", self.port_base)
70
71         pl_desc2 = exp_desc.add_testbed_description(pl_provider)
72         pl_desc2.set_attribute_value("homeDirectory", self.root_dir+"v2")
73         pl_desc2.set_attribute_value("slice", slicename2)
74         pl_desc2.set_attribute_value("sliceSSHKey", pl_ssh_key)
75         pl_desc2.set_attribute_value("authUser", pl_user)
76         pl_desc2.set_attribute_value("authPass", pl_pwd)
77         pl_desc2.set_attribute_value("plcHost", plchost2)
78         pl_desc2.set_attribute_value("tapPortBase", self.port_base+100)
79         
80         return pl_desc, pl_desc2, exp_desc
81     
82     def make_pl_tapnode(self, pl, tapip, hostname, label_prefix):
83         node1 = pl.create("Node")
84         node1.set_attribute_value("hostname", hostname)
85         node1.set_attribute_value("label", label_prefix)
86         iface1 = pl.create("NodeInterface")
87         iface1.set_attribute_value("label", label_prefix+"iface")
88         if tapip:
89             tap1 = pl.create("TapInterface")
90             tap1.enable_trace("packets") # for error output
91             tap1.set_attribute_value("label", label_prefix+"tap")
92             
93             node1.connector("devs").connect(tap1.connector("node"))
94             
95             tap1ip = tap1.add_address()
96             tap1ip.set_attribute_value("Address", tapip)
97             tap1ip.set_attribute_value("NetPrefix", 24)
98             tap1ip.set_attribute_value("Broadcast", False)
99         else:
100             tap1 = None
101             tap1ip = None
102         inet = pl.create("Internet")
103         node1.connector("devs").connect(iface1.connector("node"))
104         iface1.connector("inet").connect(inet.connector("devs"))
105         
106         return node1, iface1, tap1, tap1ip, inet
107
108     def make_ns_in_pl(self, pl, exp, node1, iface1, root):
109         ns3_testbed_id = "ns3"
110         
111         # Add NS3 support in node1
112         plnepi = pl.create("NepiDependency")
113         plns3 = pl.create("NS3Dependency")
114         plnepi.connector("node").connect(node1.connector("deps"))
115         plns3.connector("node").connect(node1.connector("deps"))
116
117         # Create NS3 testbed running in node1
118         ns3_provider = FactoriesProvider(ns3_testbed_id)
119         ns3_desc = exp.add_testbed_description(ns3_provider)
120         ns3_desc.set_attribute_value("rootDirectory", root)
121         ns3_desc.set_attribute_value("SimulatorImplementationType", "ns3::RealtimeSimulatorImpl")
122         ns3_desc.set_attribute_value("ChecksumEnabled", True)
123         ns3_desc.set_attribute_value(DC.DEPLOYMENT_HOST, "{#[%s].addr[0].[Address]#}" % (
124             iface1.get_attribute_value("label"),))
125         ns3_desc.set_attribute_value(DC.DEPLOYMENT_USER, 
126             pl.get_attribute_value("slice"))
127         ns3_desc.set_attribute_value(DC.DEPLOYMENT_KEY, 
128             pl.get_attribute_value("sliceSSHKey"))
129         ns3_desc.set_attribute_value(DC.DEPLOYMENT_MODE, DC.MODE_DAEMON)
130         ns3_desc.set_attribute_value(DC.DEPLOYMENT_COMMUNICATION, DC.ACCESS_SSH)
131         ns3_desc.set_attribute_value(DC.DEPLOYMENT_ENVIRONMENT_SETUP,
132             "{#[%s].[%s]#}" % (
133                 node1.get_attribute_value("label"),
134                 ATTR_NEPI_TESTBED_ENVIRONMENT_SETUP,))
135         ns3_desc.set_attribute_value(DC.LOG_LEVEL, DC.DEBUG_LEVEL)
136         
137         return ns3_desc
138     
139     
140     def _test_plns3_crossconnect(self, proto):
141         pl, pl2, exp = self.make_experiment_desc()
142         
143         # Create PL node, ifaces, assign addresses
144         node1, iface1, _, _, inet1 = self.make_pl_tapnode(pl, 
145             None, self.host1pl1, "node1")
146         node2, iface2, tap2, tap2ip, inet2 = self.make_pl_tapnode(pl2, 
147             "192.168.2.3", self.host1pl2, "node2")
148
149         # Create NS3 instance in node1
150         # With a node and all required protocols to be pinged
151         ns3 = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns-rcross-1")
152
153         ns1 = ns3.create("ns3::Node")
154         ipv41 = ns3.create("ns3::Ipv4L3Protocol")
155         arp1  = ns3.create("ns3::ArpL3Protocol")
156         icmp1 = ns3.create("ns3::Icmpv4L4Protocol")
157         ns1.connector("protos").connect(ipv41.connector("node"))
158         ns1.connector("protos").connect(arp1.connector("node"))
159         ns1.connector("protos").connect(icmp1.connector("node"))
160         ns1if = ns3.create("ns3::FileDescriptorNetDevice")
161         ns1if.enable_trace("FileDescriptorPcapTrace")
162         ns1if.set_attribute_value("label", "ns1if")
163         ns1tc = ns3.create("ns3::Nepi::TunChannel")
164         ns1.connector("devs").connect(ns1if.connector("node"))
165         ns1tc.connector("fd->").connect(ns1if.connector("->fd"))
166         ip1 = ns1if.add_address()
167         ip1.set_attribute_value("Address", "192.168.2.2")
168         ip1.set_attribute_value("NetPrefix", 24)
169         ip1.set_attribute_value("Broadcast", False)
170             
171         # Connect the two
172         tap2.connector(proto).connect(ns1tc.connector(proto))
173         
174         # Create PlanetLab ping application, pinging the from one PL to another
175         ping = pl2.create("Application")
176         ping.set_attribute_value("command", "ping -qc10 {#[ns1if].addr[0].[Address]#}")
177         ping.enable_trace("stdout")
178         ping.enable_trace("stderr")
179         ping.connector("node").connect(node2.connector("apps"))
180
181         comp_result = r"""PING .* \(.*\) \d*\(\d*\) bytes of data.
182
183 --- .* ping statistics ---
184 10 packets transmitted, 10 received, 0% packet loss, time \d*ms.*
185 """
186
187         xml = exp.to_xml()
188
189         controller = ExperimentController(xml, self.root_dir)
190         
191         try:
192             controller.start()
193
194             while not controller.is_finished(ping.guid):
195                 time.sleep(0.5)
196               
197             ping_result = controller.trace(ping.guid, "stdout")
198             tap2_trace = controller.trace(tap2.guid, "packets")
199         finally:
200             controller.stop()
201             controller.shutdown()
202
203         # asserts at the end, to make sure there's proper cleanup
204         self.assertTrue(re.match(comp_result, ping_result, re.MULTILINE),
205             "Unexpected trace:\n%s\nTap trace:\n%s\n" % (
206                 ping_result,
207                 tap2_trace) )
208
209     @test_util.skipUnless(test_util.pl_auth() is not None, 
210         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
211     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
212         "Test is expensive, requires NEPI_FULL_TESTS=yes")
213     def test_plns3_crossconnect_udp(self):
214         self._test_plns3_crossconnect("udp")
215
216     @test_util.skipUnless(test_util.pl_auth() is not None, 
217         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
218     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
219         "Test is expensive, requires NEPI_FULL_TESTS=yes")
220     def test_plns3_crossconnect_tcp(self):
221         self._test_plns3_crossconnect("tcp")
222
223
224 if __name__ == '__main__':
225     unittest.main()
226