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