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