OLD | NEW |
| (Empty) |
1 # Copyright (c) 2012 The Chromium Authors. All rights reserved. | |
2 # Use of this source code is governed by a BSD-style license that can be | |
3 # found in the LICENSE file. | |
4 | |
5 import contextlib | |
6 import httplib | |
7 import logging | |
8 import os | |
9 import tempfile | |
10 import time | |
11 | |
12 from pylib import android_commands | |
13 from pylib import constants | |
14 from pylib import ports | |
15 from pylib.chrome_test_server_spawner import SpawningServer | |
16 from pylib.flag_changer import FlagChanger | |
17 from pylib.forwarder import Forwarder | |
18 from pylib.valgrind_tools import CreateTool | |
19 # TODO(frankf): Move this to pylib/utils | |
20 import lighttpd_server | |
21 | |
22 | |
23 # A file on device to store ports of net test server. The format of the file is | |
24 # test-spawner-server-port:test-server-port | |
25 NET_TEST_SERVER_PORT_INFO_FILE = 'net-test-server-ports' | |
26 | |
27 | |
28 class BaseTestRunner(object): | |
29 """Base class for running tests on a single device. | |
30 | |
31 A subclass should implement RunTests() with no parameter, so that calling | |
32 the Run() method will set up tests, run them and tear them down. | |
33 """ | |
34 | |
35 def __init__(self, device, tool, build_type): | |
36 """ | |
37 Args: | |
38 device: Tests will run on the device of this ID. | |
39 shard_index: Index number of the shard on which the test suite will run. | |
40 build_type: 'Release' or 'Debug'. | |
41 """ | |
42 self.device = device | |
43 self.adb = android_commands.AndroidCommands(device=device) | |
44 self.tool = CreateTool(tool, self.adb) | |
45 self._http_server = None | |
46 self._forwarder = None | |
47 self._forwarder_device_port = 8000 | |
48 self.forwarder_base_url = ('http://localhost:%d' % | |
49 self._forwarder_device_port) | |
50 self.flags = FlagChanger(self.adb) | |
51 self.flags.AddFlags(['--disable-fre']) | |
52 self._spawning_server = None | |
53 self._spawner_forwarder = None | |
54 # We will allocate port for test server spawner when calling method | |
55 # LaunchChromeTestServerSpawner and allocate port for test server when | |
56 # starting it in TestServerThread. | |
57 self.test_server_spawner_port = 0 | |
58 self.test_server_port = 0 | |
59 self.build_type = build_type | |
60 | |
61 def _PushTestServerPortInfoToDevice(self): | |
62 """Pushes the latest port information to device.""" | |
63 self.adb.SetFileContents(self.adb.GetExternalStorage() + '/' + | |
64 NET_TEST_SERVER_PORT_INFO_FILE, | |
65 '%d:%d' % (self.test_server_spawner_port, | |
66 self.test_server_port)) | |
67 | |
68 def RunTest(self, test): | |
69 """Runs a test. Needs to be overridden. | |
70 | |
71 Args: | |
72 test: A test to run. | |
73 | |
74 Returns: | |
75 Tuple containing: (test_result.TestResults, tests to rerun or None) | |
76 """ | |
77 raise NotImplementedError | |
78 | |
79 def SetUp(self): | |
80 """Run once before all tests are run.""" | |
81 Forwarder.KillDevice(self.adb, self.tool) | |
82 | |
83 def TearDown(self): | |
84 """Run once after all tests are run.""" | |
85 self.ShutdownHelperToolsForTestSuite() | |
86 | |
87 def CopyTestData(self, test_data_paths, dest_dir): | |
88 """Copies |test_data_paths| list of files/directories to |dest_dir|. | |
89 | |
90 Args: | |
91 test_data_paths: A list of files or directories relative to |dest_dir| | |
92 which should be copied to the device. The paths must exist in | |
93 |CHROME_DIR|. | |
94 dest_dir: Absolute path to copy to on the device. | |
95 """ | |
96 for p in test_data_paths: | |
97 self.adb.PushIfNeeded( | |
98 os.path.join(constants.CHROME_DIR, p), | |
99 os.path.join(dest_dir, p)) | |
100 | |
101 def LaunchTestHttpServer(self, document_root, port=None, | |
102 extra_config_contents=None): | |
103 """Launches an HTTP server to serve HTTP tests. | |
104 | |
105 Args: | |
106 document_root: Document root of the HTTP server. | |
107 port: port on which we want to the http server bind. | |
108 extra_config_contents: Extra config contents for the HTTP server. | |
109 """ | |
110 self._http_server = lighttpd_server.LighttpdServer( | |
111 document_root, port=port, extra_config_contents=extra_config_contents) | |
112 if self._http_server.StartupHttpServer(): | |
113 logging.info('http server started: http://localhost:%s', | |
114 self._http_server.port) | |
115 else: | |
116 logging.critical('Failed to start http server') | |
117 self.StartForwarderForHttpServer() | |
118 return (self._forwarder_device_port, self._http_server.port) | |
119 | |
120 def _CreateAndRunForwarder( | |
121 self, adb, port_pairs, tool, host_name, build_type): | |
122 """Creates and run a forwarder.""" | |
123 forwarder = Forwarder(adb, build_type) | |
124 forwarder.Run(port_pairs, tool, host_name) | |
125 return forwarder | |
126 | |
127 def StartForwarder(self, port_pairs): | |
128 """Starts TCP traffic forwarding for the given |port_pairs|. | |
129 | |
130 Args: | |
131 host_port_pairs: A list of (device_port, local_port) tuples to forward. | |
132 """ | |
133 if self._forwarder: | |
134 self._forwarder.Close() | |
135 self._forwarder = self._CreateAndRunForwarder( | |
136 self.adb, port_pairs, self.tool, '127.0.0.1', self.build_type) | |
137 | |
138 def StartForwarderForHttpServer(self): | |
139 """Starts a forwarder for the HTTP server. | |
140 | |
141 The forwarder forwards HTTP requests and responses between host and device. | |
142 """ | |
143 self.StartForwarder([(self._forwarder_device_port, self._http_server.port)]) | |
144 | |
145 def RestartHttpServerForwarderIfNecessary(self): | |
146 """Restarts the forwarder if it's not open.""" | |
147 # Checks to see if the http server port is being used. If not forwards the | |
148 # request. | |
149 # TODO(dtrainor): This is not always reliable because sometimes the port | |
150 # will be left open even after the forwarder has been killed. | |
151 if not ports.IsDevicePortUsed(self.adb, | |
152 self._forwarder_device_port): | |
153 self.StartForwarderForHttpServer() | |
154 | |
155 def ShutdownHelperToolsForTestSuite(self): | |
156 """Shuts down the server and the forwarder.""" | |
157 # Forwarders should be killed before the actual servers they're forwarding | |
158 # to as they are clients potentially with open connections and to allow for | |
159 # proper hand-shake/shutdown. | |
160 Forwarder.KillDevice(self.adb, self.tool) | |
161 if self._http_server: | |
162 self._http_server.ShutdownHttpServer() | |
163 if self._spawning_server: | |
164 self._spawning_server.Stop() | |
165 self.flags.Restore() | |
166 | |
167 def LaunchChromeTestServerSpawner(self): | |
168 """Launches test server spawner.""" | |
169 server_ready = False | |
170 error_msgs = [] | |
171 # Try 3 times to launch test spawner server. | |
172 for i in xrange(0, 3): | |
173 # Do not allocate port for test server here. We will allocate | |
174 # different port for individual test in TestServerThread. | |
175 self.test_server_spawner_port = ports.AllocateTestServerPort() | |
176 self._spawning_server = SpawningServer(self.test_server_spawner_port, | |
177 self.adb, | |
178 self.tool, | |
179 self.build_type) | |
180 self._spawning_server.Start() | |
181 server_ready, error_msg = ports.IsHttpServerConnectable( | |
182 '127.0.0.1', self.test_server_spawner_port, path='/ping', | |
183 expected_read='ready') | |
184 if server_ready: | |
185 break | |
186 else: | |
187 error_msgs.append(error_msg) | |
188 self._spawning_server.Stop() | |
189 # Wait for 2 seconds then restart. | |
190 time.sleep(2) | |
191 if not server_ready: | |
192 logging.error(';'.join(error_msgs)) | |
193 raise Exception('Can not start the test spawner server.') | |
194 self._PushTestServerPortInfoToDevice() | |
195 self._spawner_forwarder = self._CreateAndRunForwarder( | |
196 self.adb, | |
197 [(self.test_server_spawner_port, self.test_server_spawner_port)], | |
198 self.tool, '127.0.0.1', self.build_type) | |
OLD | NEW |