s/dedicatedSlice/cleanProc/g
[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 re
11 import shutil
12 import tempfile
13 import test_util
14 import time
15 import unittest
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         pl_desc.set_attribute_value("p2pDeployment", False) # it's interactive, we don't want it in tests
71         pl_desc.set_attribute_value("cleanProc", True)
72
73         pl_desc2 = exp_desc.add_testbed_description(pl_provider)
74         pl_desc2.set_attribute_value("homeDirectory", self.root_dir+"v2")
75         pl_desc2.set_attribute_value("slice", slicename2)
76         pl_desc2.set_attribute_value("sliceSSHKey", pl_ssh_key)
77         pl_desc2.set_attribute_value("authUser", pl_user)
78         pl_desc2.set_attribute_value("authPass", pl_pwd)
79         pl_desc2.set_attribute_value("plcHost", plchost2)
80         pl_desc2.set_attribute_value("tapPortBase", self.port_base+500)
81         pl_desc2.set_attribute_value("p2pDeployment", False) # it's interactive, we don't want it in tests
82         pl_desc2.set_attribute_value("cleanProc", True)
83         
84         return pl_desc, pl_desc2, exp_desc
85     
86     def make_pl_tapnode(self, pl, tapip, hostname, label_prefix):
87         node1 = pl.create("Node")
88         node1.set_attribute_value("hostname", hostname)
89         node1.set_attribute_value("label", label_prefix)
90         iface1 = pl.create("NodeInterface")
91         iface1.set_attribute_value("label", label_prefix+"iface")
92         if tapip:
93             tap1 = pl.create("TapInterface")
94             tap1.enable_trace("packets") # for error output
95             tap1.set_attribute_value("label", label_prefix+"tap")
96             
97             node1.connector("devs").connect(tap1.connector("node"))
98             
99             tap1ip = tap1.add_address()
100             tap1ip.set_attribute_value("Address", tapip)
101             tap1ip.set_attribute_value("NetPrefix", 24)
102             tap1ip.set_attribute_value("Broadcast", False)
103         else:
104             tap1 = None
105             tap1ip = None
106         inet = pl.create("Internet")
107         node1.connector("devs").connect(iface1.connector("node"))
108         iface1.connector("inet").connect(inet.connector("devs"))
109         
110         return node1, iface1, tap1, tap1ip, inet
111
112     def make_ns_in_pl(self, pl, exp, node1, iface1, root):
113         ns3_testbed_id = "ns3"
114         
115         # Add NS3 support in node1
116         plnepi = pl.create("NepiDependency")
117         plns3 = pl.create("NS3Dependency")
118         plnepi.connector("node").connect(node1.connector("deps"))
119         plns3.connector("node").connect(node1.connector("deps"))
120
121         # Create NS3 testbed running in node1
122         ns3_provider = FactoriesProvider(ns3_testbed_id)
123         ns3_desc = exp.add_testbed_description(ns3_provider)
124         ns3_desc.set_attribute_value("rootDirectory", root)
125         ns3_desc.set_attribute_value("SimulatorImplementationType", "ns3::RealtimeSimulatorImpl")
126         ns3_desc.set_attribute_value("ChecksumEnabled", True)
127         ns3_desc.set_attribute_value(DC.DEPLOYMENT_HOST, "{#[%s].addr[0].[Address]#}" % (
128             iface1.get_attribute_value("label"),))
129         ns3_desc.set_attribute_value(DC.DEPLOYMENT_USER, 
130             pl.get_attribute_value("slice"))
131         ns3_desc.set_attribute_value(DC.DEPLOYMENT_KEY, 
132             pl.get_attribute_value("sliceSSHKey"))
133         ns3_desc.set_attribute_value(DC.DEPLOYMENT_MODE, DC.MODE_DAEMON)
134         ns3_desc.set_attribute_value(DC.DEPLOYMENT_COMMUNICATION, DC.ACCESS_SSH)
135         ns3_desc.set_attribute_value(DC.DEPLOYMENT_ENVIRONMENT_SETUP,
136             "{#[%s].[%s]#}" % (
137                 node1.get_attribute_value("label"),
138                 ATTR_NEPI_TESTBED_ENVIRONMENT_SETUP,))
139         ns3_desc.set_attribute_value(DC.LOG_LEVEL, DC.DEBUG_LEVEL)
140         
141         return ns3_desc
142     
143     
144     def _test_plns3_crossconnect(self, proto):
145         pl, pl2, exp = self.make_experiment_desc()
146         
147         # Create PL node, ifaces, assign addresses
148         node1, iface1, _, _, inet1 = self.make_pl_tapnode(pl, 
149             None, self.host1pl1, "node1")
150         node2, iface2, tap2, tap2ip, inet2 = self.make_pl_tapnode(pl2, 
151             "192.168.2.3", self.host1pl2, "node2")
152
153         # Create NS3 instance in node1
154         # With a node and all required protocols to be pinged
155         ns3 = self.make_ns_in_pl(pl, exp, node1, iface1, "tb-ns-rcross-1")
156
157         ns1 = ns3.create("ns3::Node")
158         ipv41 = ns3.create("ns3::Ipv4L3Protocol")
159         arp1  = ns3.create("ns3::ArpL3Protocol")
160         icmp1 = ns3.create("ns3::Icmpv4L4Protocol")
161         ns1.connector("protos").connect(ipv41.connector("node"))
162         ns1.connector("protos").connect(arp1.connector("node"))
163         ns1.connector("protos").connect(icmp1.connector("node"))
164         ns1if = ns3.create("ns3::FdNetDevice")
165         ns1if.enable_trace("FdPcapTrace")
166         ns1if.set_attribute_value("label", "ns1if")
167         ns1tc = ns3.create("ns3::Nepi::TunChannel")
168         ns1.connector("devs").connect(ns1if.connector("node"))
169         ns1tc.connector("fd->").connect(ns1if.connector("->fd"))
170         ip1 = ns1if.add_address()
171         ip1.set_attribute_value("Address", "192.168.2.2")
172         ip1.set_attribute_value("NetPrefix", 24)
173         ip1.set_attribute_value("Broadcast", False)
174             
175         # Connect the two
176         tap2.connector(proto).connect(ns1tc.connector(proto))
177         
178         # Create PlanetLab ping application, pinging the from one PL to another
179         ping = pl2.create("Application")
180         ping.set_attribute_value("command", "ping -qc10 {#[ns1if].addr[0].[Address]#}")
181         ping.enable_trace("stdout")
182         ping.enable_trace("stderr")
183         ping.connector("node").connect(node2.connector("apps"))
184
185         comp_result = r"""PING .* \(.*\) \d*\(\d*\) bytes of data.
186
187 --- .* ping statistics ---
188 10 packets transmitted, 10 received, 0% packet loss, time \d*ms.*
189 """
190
191         xml = exp.to_xml()
192
193         controller = ExperimentController(xml, self.root_dir)
194         
195         try:
196             controller.start()
197
198             while not controller.is_finished(ping.guid):
199                 time.sleep(0.5)
200               
201             ping_result = controller.trace(ping.guid, "stdout")
202             tap2_trace = controller.trace(tap2.guid, "packets")
203         finally:
204             try:
205                 controller.stop()
206             except:
207                 import traceback
208                 traceback.print_exc()
209             try:
210                 controller.shutdown()
211             except:
212                 import traceback
213                 traceback.print_exc()
214
215         # asserts at the end, to make sure there's proper cleanup
216         self.assertTrue(re.match(comp_result, ping_result, re.MULTILINE),
217             "Unexpected trace:\n%s\nTap trace:\n%s\n" % (
218                 ping_result,
219                 tap2_trace) )
220
221     @test_util.skipUnless(test_util.pl_auth() is not None, 
222         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
223     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
224         "Test is expensive, requires NEPI_FULL_TESTS=yes")
225     def test_plns3_crossconnect_udp(self):
226         self._test_plns3_crossconnect("udp")
227
228     @test_util.skipUnless(test_util.pl_auth() is not None, 
229         "Test requires PlanetLab authentication info (PL_USER and PL_PASS environment variables)")
230     @test_util.skipUnless(os.environ.get('NEPI_FULL_TESTS','').lower() in ('1','yes','true','on'),
231         "Test is expensive, requires NEPI_FULL_TESTS=yes")
232     def test_plns3_crossconnect_tcp(self):
233         self._test_plns3_crossconnect("tcp")
234
235
236 if __name__ == '__main__':
237     unittest.main()
238