Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 1 | #!/usr/bin/python |
| 2 | |
Chris Sosa | 781ba6d | 2012-04-11 12:44:43 -0700 | [diff] [blame] | 3 | # Copyright (c) 2009-2012 The Chromium OS Authors. All rights reserved. |
rtc@google.com | ded2240 | 2009-10-26 22:36:21 +0000 | [diff] [blame] | 4 | # Use of this source code is governed by a BSD-style license that can be |
| 5 | # found in the LICENSE file. |
| 6 | |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 7 | """A CherryPy-based webserver to host images and build packages.""" |
| 8 | |
Chris Sosa | dbc2008 | 2012-12-10 13:39:11 -0800 | [diff] [blame] | 9 | import cherrypy |
Gilad Arnold | 55a2a37 | 2012-10-02 09:46:32 -0700 | [diff] [blame] | 10 | import json |
Sean O'Connor | 14b6a0a | 2010-03-20 23:23:48 -0700 | [diff] [blame] | 11 | import optparse |
rtc@google.com | ded2240 | 2009-10-26 22:36:21 +0000 | [diff] [blame] | 12 | import os |
Scott Zawalski | 4647ce6 | 2012-01-03 17:17:28 -0500 | [diff] [blame] | 13 | import re |
Mandeep Singh Baines | 38dcdda | 2012-12-07 17:55:33 -0800 | [diff] [blame] | 14 | import socket |
chocobo@google.com | 4dc2581 | 2009-10-27 23:46:26 +0000 | [diff] [blame] | 15 | import sys |
Chris Masone | 816e38c | 2012-05-02 12:22:36 -0700 | [diff] [blame] | 16 | import subprocess |
| 17 | import tempfile |
Gilad Arnold | d5ebaaa | 2012-10-02 11:52:38 -0700 | [diff] [blame] | 18 | import types |
rtc@google.com | ded2240 | 2009-10-26 22:36:21 +0000 | [diff] [blame] | 19 | |
Chris Sosa | 0356d3b | 2010-09-16 15:46:22 -0700 | [diff] [blame] | 20 | import autoupdate |
Gilad Arnold | c65330c | 2012-09-20 15:17:48 -0700 | [diff] [blame] | 21 | import common_util |
Chris Sosa | 47a7d4e | 2012-03-28 11:26:55 -0700 | [diff] [blame] | 22 | import downloader |
Gilad Arnold | c65330c | 2012-09-20 15:17:48 -0700 | [diff] [blame] | 23 | import log_util |
| 24 | |
| 25 | |
| 26 | # Module-local log function. |
Chris Sosa | 6a3697f | 2013-01-29 16:44:43 -0800 | [diff] [blame] | 27 | def _Log(message, *args): |
| 28 | return log_util.LogWithTag('DEVSERVER', message, *args) |
Chris Sosa | 0356d3b | 2010-09-16 15:46:22 -0700 | [diff] [blame] | 29 | |
Frank Farzan | 4016087 | 2011-12-12 18:39:18 -0800 | [diff] [blame] | 30 | |
Chris Sosa | 417e55d | 2011-01-25 16:40:48 -0800 | [diff] [blame] | 31 | CACHED_ENTRIES = 12 |
Don Garrett | f90edf0 | 2010-11-16 17:36:14 -0800 | [diff] [blame] | 32 | |
Chris Sosa | 0356d3b | 2010-09-16 15:46:22 -0700 | [diff] [blame] | 33 | # Sets up global to share between classes. |
rtc@google.com | 21a5ca3 | 2009-11-04 18:23:23 +0000 | [diff] [blame] | 34 | updater = None |
rtc@google.com | ded2240 | 2009-10-26 22:36:21 +0000 | [diff] [blame] | 35 | |
Frank Farzan | 4016087 | 2011-12-12 18:39:18 -0800 | [diff] [blame] | 36 | |
Chris Sosa | 9164ca3 | 2012-03-28 11:04:50 -0700 | [diff] [blame] | 37 | class DevServerError(Exception): |
Chris Sosa | 47a7d4e | 2012-03-28 11:26:55 -0700 | [diff] [blame] | 38 | """Exception class used by this module.""" |
| 39 | pass |
| 40 | |
| 41 | |
Scott Zawalski | 4647ce6 | 2012-01-03 17:17:28 -0500 | [diff] [blame] | 42 | def _LeadingWhiteSpaceCount(string): |
| 43 | """Count the amount of leading whitespace in a string. |
| 44 | |
| 45 | Args: |
| 46 | string: The string to count leading whitespace in. |
| 47 | Returns: |
| 48 | number of white space chars before characters start. |
| 49 | """ |
| 50 | matched = re.match('^\s+', string) |
| 51 | if matched: |
| 52 | return len(matched.group()) |
| 53 | |
| 54 | return 0 |
| 55 | |
| 56 | |
| 57 | def _PrintDocStringAsHTML(func): |
| 58 | """Make a functions docstring somewhat HTML style. |
| 59 | |
| 60 | Args: |
| 61 | func: The function to return the docstring from. |
| 62 | Returns: |
| 63 | A string that is somewhat formated for a web browser. |
| 64 | """ |
| 65 | # TODO(scottz): Make this parse Args/Returns in a prettier way. |
| 66 | # Arguments could be bolded and indented etc. |
| 67 | html_doc = [] |
| 68 | for line in func.__doc__.splitlines(): |
| 69 | leading_space = _LeadingWhiteSpaceCount(line) |
| 70 | if leading_space > 0: |
Chris Sosa | 47a7d4e | 2012-03-28 11:26:55 -0700 | [diff] [blame] | 71 | line = ' ' * leading_space + line |
Scott Zawalski | 4647ce6 | 2012-01-03 17:17:28 -0500 | [diff] [blame] | 72 | |
| 73 | html_doc.append('<BR>%s' % line) |
| 74 | |
| 75 | return '\n'.join(html_doc) |
| 76 | |
| 77 | |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 78 | def _GetConfig(options): |
| 79 | """Returns the configuration for the devserver.""" |
Mandeep Singh Baines | 38dcdda | 2012-12-07 17:55:33 -0800 | [diff] [blame] | 80 | |
| 81 | # On a system with IPv6 not compiled into the kernel, |
| 82 | # AF_INET6 sockets will return a socket.error exception. |
| 83 | # On such systems, fall-back to IPv4. |
| 84 | socket_host = '::' |
| 85 | try: |
| 86 | socket.socket(socket.AF_INET6, socket.SOCK_STREAM) |
| 87 | except socket.error: |
| 88 | socket_host = '0.0.0.0' |
| 89 | |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 90 | base_config = { 'global': |
| 91 | { 'server.log_request_headers': True, |
| 92 | 'server.protocol_version': 'HTTP/1.1', |
Mandeep Singh Baines | 38dcdda | 2012-12-07 17:55:33 -0800 | [diff] [blame] | 93 | 'server.socket_host': socket_host, |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 94 | 'server.socket_port': int(options.port), |
Chris Sosa | 374c62d | 2010-10-14 09:13:54 -0700 | [diff] [blame] | 95 | 'response.timeout': 6000, |
Chris Sosa | 6fe2394 | 2012-07-02 15:44:46 -0700 | [diff] [blame] | 96 | 'request.show_tracebacks': True, |
Chris Sosa | 72333d1 | 2012-06-13 11:28:05 -0700 | [diff] [blame] | 97 | 'server.socket_timeout': 60, |
Zdenek Behan | 1347a31 | 2011-02-10 03:59:17 +0100 | [diff] [blame] | 98 | 'tools.staticdir.root': |
| 99 | os.path.dirname(os.path.abspath(sys.argv[0])), |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 100 | }, |
Dale Curtis | c9aaf3a | 2011-08-09 15:47:40 -0700 | [diff] [blame] | 101 | '/api': |
| 102 | { |
| 103 | # Gets rid of cherrypy parsing post file for args. |
| 104 | 'request.process_request_body': False, |
| 105 | }, |
Chris Sosa | a1ef010 | 2010-10-21 16:22:35 -0700 | [diff] [blame] | 106 | '/build': |
| 107 | { |
| 108 | 'response.timeout': 100000, |
| 109 | }, |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 110 | '/update': |
| 111 | { |
| 112 | # Gets rid of cherrypy parsing post file for args. |
| 113 | 'request.process_request_body': False, |
Chris Sosa | f65f4b9 | 2010-10-21 15:57:51 -0700 | [diff] [blame] | 114 | 'response.timeout': 10000, |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 115 | }, |
| 116 | # Sets up the static dir for file hosting. |
| 117 | '/static': |
| 118 | { 'tools.staticdir.dir': 'static', |
| 119 | 'tools.staticdir.on': True, |
Chris Sosa | f65f4b9 | 2010-10-21 15:57:51 -0700 | [diff] [blame] | 120 | 'response.timeout': 10000, |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 121 | }, |
| 122 | } |
Chris Sosa | 5f118ef | 2012-07-12 11:37:50 -0700 | [diff] [blame] | 123 | if options.production: |
Chris Sosa | d1ea86b | 2012-07-12 13:35:37 -0700 | [diff] [blame] | 124 | base_config['global'].update({'server.thread_pool': 75}) |
Scott Zawalski | 1c5e7cd | 2012-02-27 13:12:52 -0500 | [diff] [blame] | 125 | |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 126 | return base_config |
rtc@google.com | 6424466 | 2009-11-12 00:52:08 +0000 | [diff] [blame] | 127 | |
Darin Petkov | e17164a | 2010-08-11 13:24:41 -0700 | [diff] [blame] | 128 | |
Zdenek Behan | 608f46c | 2011-02-19 00:47:16 +0100 | [diff] [blame] | 129 | def _PrepareToServeUpdatesOnly(image_dir, static_dir): |
Chris Sosa | 0356d3b | 2010-09-16 15:46:22 -0700 | [diff] [blame] | 130 | """Sets up symlink to image_dir for serving purposes.""" |
| 131 | assert os.path.exists(image_dir), '%s must exist.' % image_dir |
| 132 | # If we're serving out of an archived build dir (e.g. a |
| 133 | # buildbot), prepare this webserver's magic 'static/' dir with a |
| 134 | # link to the build archive. |
Gilad Arnold | c65330c | 2012-09-20 15:17:48 -0700 | [diff] [blame] | 135 | _Log('Preparing autoupdate for "serve updates only" mode.') |
Zdenek Behan | 608f46c | 2011-02-19 00:47:16 +0100 | [diff] [blame] | 136 | if os.path.lexists('%s/archive' % static_dir): |
| 137 | if image_dir != os.readlink('%s/archive' % static_dir): |
Gilad Arnold | c65330c | 2012-09-20 15:17:48 -0700 | [diff] [blame] | 138 | _Log('removing stale symlink to %s' % image_dir) |
Zdenek Behan | 608f46c | 2011-02-19 00:47:16 +0100 | [diff] [blame] | 139 | os.unlink('%s/archive' % static_dir) |
| 140 | os.symlink(image_dir, '%s/archive' % static_dir) |
Chris Sosa | cde6bf4 | 2012-05-31 18:36:39 -0700 | [diff] [blame] | 141 | |
Chris Sosa | 0356d3b | 2010-09-16 15:46:22 -0700 | [diff] [blame] | 142 | else: |
Zdenek Behan | 608f46c | 2011-02-19 00:47:16 +0100 | [diff] [blame] | 143 | os.symlink(image_dir, '%s/archive' % static_dir) |
Chris Sosa | cde6bf4 | 2012-05-31 18:36:39 -0700 | [diff] [blame] | 144 | |
Gilad Arnold | c65330c | 2012-09-20 15:17:48 -0700 | [diff] [blame] | 145 | _Log('archive dir: %s ready to be used to serve images.' % image_dir) |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 146 | |
| 147 | |
Gilad Arnold | d5ebaaa | 2012-10-02 11:52:38 -0700 | [diff] [blame] | 148 | def _GetRecursiveMemberObject(root, member_list): |
| 149 | """Returns an object corresponding to a nested member list. |
| 150 | |
| 151 | Args: |
| 152 | root: the root object to search |
| 153 | member_list: list of nested members to search |
| 154 | Returns: |
| 155 | An object corresponding to the member name list; None otherwise. |
| 156 | """ |
| 157 | for member in member_list: |
| 158 | next_root = root.__class__.__dict__.get(member) |
| 159 | if not next_root: |
| 160 | return None |
| 161 | root = next_root |
| 162 | return root |
| 163 | |
| 164 | |
| 165 | def _IsExposed(name): |
| 166 | """Returns True iff |name| has an `exposed' attribute and it is set.""" |
| 167 | return hasattr(name, 'exposed') and name.exposed |
| 168 | |
| 169 | |
Gilad Arnold | 748c832 | 2012-10-12 09:51:35 -0700 | [diff] [blame] | 170 | def _GetExposedMethod(root, nested_member, ignored=None): |
Gilad Arnold | d5ebaaa | 2012-10-02 11:52:38 -0700 | [diff] [blame] | 171 | """Returns a CherryPy-exposed method, if such exists. |
| 172 | |
| 173 | Args: |
| 174 | root: the root object for searching |
| 175 | nested_member: a slash-joined path to the nested member |
| 176 | ignored: method paths to be ignored |
| 177 | Returns: |
| 178 | A function object corresponding to the path defined by |member_list| from |
| 179 | the |root| object, if the function is exposed and not ignored; None |
| 180 | otherwise. |
| 181 | """ |
Gilad Arnold | 748c832 | 2012-10-12 09:51:35 -0700 | [diff] [blame] | 182 | method = (not (ignored and nested_member in ignored) and |
Gilad Arnold | d5ebaaa | 2012-10-02 11:52:38 -0700 | [diff] [blame] | 183 | _GetRecursiveMemberObject(root, nested_member.split('/'))) |
| 184 | if (method and type(method) == types.FunctionType and _IsExposed(method)): |
| 185 | return method |
| 186 | |
| 187 | |
Gilad Arnold | 748c832 | 2012-10-12 09:51:35 -0700 | [diff] [blame] | 188 | def _FindExposedMethods(root, prefix, unlisted=None): |
Gilad Arnold | d5ebaaa | 2012-10-02 11:52:38 -0700 | [diff] [blame] | 189 | """Finds exposed CherryPy methods. |
| 190 | |
| 191 | Args: |
| 192 | root: the root object for searching |
| 193 | prefix: slash-joined chain of members leading to current object |
| 194 | unlisted: URLs to be excluded regardless of their exposed status |
| 195 | Returns: |
| 196 | List of exposed URLs that are not unlisted. |
| 197 | """ |
| 198 | method_list = [] |
| 199 | for member in sorted(root.__class__.__dict__.keys()): |
| 200 | prefixed_member = prefix + '/' + member if prefix else member |
Gilad Arnold | 748c832 | 2012-10-12 09:51:35 -0700 | [diff] [blame] | 201 | if unlisted and prefixed_member in unlisted: |
Gilad Arnold | d5ebaaa | 2012-10-02 11:52:38 -0700 | [diff] [blame] | 202 | continue |
| 203 | member_obj = root.__class__.__dict__[member] |
| 204 | if _IsExposed(member_obj): |
| 205 | if type(member_obj) == types.FunctionType: |
| 206 | method_list.append(prefixed_member) |
| 207 | else: |
| 208 | method_list += _FindExposedMethods( |
| 209 | member_obj, prefixed_member, unlisted) |
| 210 | return method_list |
| 211 | |
| 212 | |
Dale Curtis | c9aaf3a | 2011-08-09 15:47:40 -0700 | [diff] [blame] | 213 | class ApiRoot(object): |
| 214 | """RESTful API for Dev Server information.""" |
| 215 | exposed = True |
| 216 | |
| 217 | @cherrypy.expose |
| 218 | def hostinfo(self, ip): |
| 219 | """Returns a JSON dictionary containing information about the given ip. |
| 220 | |
Gilad Arnold | 1b90839 | 2012-10-05 11:36:27 -0700 | [diff] [blame] | 221 | Args: |
| 222 | ip: address of host whose info is requested |
| 223 | Returns: |
| 224 | A JSON dictionary containing all or some of the following fields: |
| 225 | last_event_type (int): last update event type received |
| 226 | last_event_status (int): last update event status received |
| 227 | last_known_version (string): last known version reported in update ping |
| 228 | forced_update_label (string): update label to force next update ping to |
| 229 | use, set by setnextupdate |
| 230 | See the OmahaEvent class in update_engine/omaha_request_action.h for |
| 231 | event type and status code definitions. If the ip does not exist an empty |
| 232 | string is returned. |
Dale Curtis | c9aaf3a | 2011-08-09 15:47:40 -0700 | [diff] [blame] | 233 | |
Gilad Arnold | 1b90839 | 2012-10-05 11:36:27 -0700 | [diff] [blame] | 234 | Example URL: |
| 235 | http://myhost/api/hostinfo?ip=192.168.1.5 |
| 236 | """ |
Dale Curtis | c9aaf3a | 2011-08-09 15:47:40 -0700 | [diff] [blame] | 237 | return updater.HandleHostInfoPing(ip) |
| 238 | |
| 239 | @cherrypy.expose |
Gilad Arnold | 286a006 | 2012-01-12 13:47:02 -0800 | [diff] [blame] | 240 | def hostlog(self, ip): |
Gilad Arnold | 1b90839 | 2012-10-05 11:36:27 -0700 | [diff] [blame] | 241 | """Returns a JSON object containing a log of host event. |
| 242 | |
| 243 | Args: |
| 244 | ip: address of host whose event log is requested, or `all' |
| 245 | Returns: |
| 246 | A JSON encoded list (log) of dictionaries (events), each of which |
| 247 | containing a `timestamp' and other event fields, as described under |
| 248 | /api/hostinfo. |
| 249 | |
| 250 | Example URL: |
| 251 | http://myhost/api/hostlog?ip=192.168.1.5 |
| 252 | """ |
Gilad Arnold | 286a006 | 2012-01-12 13:47:02 -0800 | [diff] [blame] | 253 | return updater.HandleHostLogPing(ip) |
| 254 | |
| 255 | @cherrypy.expose |
Dale Curtis | c9aaf3a | 2011-08-09 15:47:40 -0700 | [diff] [blame] | 256 | def setnextupdate(self, ip): |
| 257 | """Allows the response to the next update ping from a host to be set. |
| 258 | |
| 259 | Takes the IP of the host and an update label as normally provided to the |
Gilad Arnold | 1b90839 | 2012-10-05 11:36:27 -0700 | [diff] [blame] | 260 | /update command. |
| 261 | """ |
Dale Curtis | c9aaf3a | 2011-08-09 15:47:40 -0700 | [diff] [blame] | 262 | body_length = int(cherrypy.request.headers['Content-Length']) |
| 263 | label = cherrypy.request.rfile.read(body_length) |
| 264 | |
| 265 | if label: |
| 266 | label = label.strip() |
| 267 | if label: |
| 268 | return updater.HandleSetUpdatePing(ip, label) |
| 269 | raise cherrypy.HTTPError(400, 'No label provided.') |
| 270 | |
| 271 | |
Gilad Arnold | 55a2a37 | 2012-10-02 09:46:32 -0700 | [diff] [blame] | 272 | @cherrypy.expose |
| 273 | def fileinfo(self, *path_args): |
| 274 | """Returns information about a given staged file. |
| 275 | |
| 276 | Args: |
| 277 | path_args: path to the file inside the server's static staging directory |
| 278 | Returns: |
| 279 | A JSON encoded dictionary with information about the said file, which may |
| 280 | contain the following keys/values: |
Gilad Arnold | 1b90839 | 2012-10-05 11:36:27 -0700 | [diff] [blame] | 281 | size (int): the file size in bytes |
| 282 | sha1 (string): a base64 encoded SHA1 hash |
| 283 | sha256 (string): a base64 encoded SHA256 hash |
| 284 | |
| 285 | Example URL: |
| 286 | http://myhost/api/fileinfo/some/path/to/file |
Gilad Arnold | 55a2a37 | 2012-10-02 09:46:32 -0700 | [diff] [blame] | 287 | """ |
| 288 | file_path = os.path.join(updater.static_dir, *path_args) |
| 289 | if not os.path.exists(file_path): |
| 290 | raise DevServerError('file not found: %s' % file_path) |
| 291 | try: |
| 292 | file_size = os.path.getsize(file_path) |
| 293 | file_sha1 = common_util.GetFileSha1(file_path) |
| 294 | file_sha256 = common_util.GetFileSha256(file_path) |
| 295 | except os.error, e: |
| 296 | raise DevServerError('failed to get info for file %s: %s' % |
| 297 | (file_path, str(e))) |
| 298 | return json.dumps( |
| 299 | {'size': file_size, 'sha1': file_sha1, 'sha256': file_sha256}) |
| 300 | |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 301 | |
David Rochberg | 7c79a81 | 2011-01-19 14:24:45 -0500 | [diff] [blame] | 302 | class DevServerRoot(object): |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 303 | """The Root Class for the Dev Server. |
| 304 | |
| 305 | CherryPy works as follows: |
| 306 | For each method in this class, cherrpy interprets root/path |
| 307 | as a call to an instance of DevServerRoot->method_name. For example, |
| 308 | a call to http://myhost/build will call build. CherryPy automatically |
| 309 | parses http args and places them as keyword arguments in each method. |
| 310 | For paths http://myhost/update/dir1/dir2, you can use *args so that |
| 311 | cherrypy uses the update method and puts the extra paths in args. |
| 312 | """ |
Gilad Arnold | f8f769f | 2012-09-24 08:43:01 -0700 | [diff] [blame] | 313 | # Method names that should not be listed on the index page. |
| 314 | _UNLISTED_METHODS = ['index', 'doc'] |
| 315 | |
Dale Curtis | c9aaf3a | 2011-08-09 15:47:40 -0700 | [diff] [blame] | 316 | api = ApiRoot() |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 317 | |
David Rochberg | 7c79a81 | 2011-01-19 14:24:45 -0500 | [diff] [blame] | 318 | def __init__(self): |
Nick Sanders | 7dcaa2e | 2011-08-04 15:20:41 -0700 | [diff] [blame] | 319 | self._builder = None |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 320 | self._download_lock_dict = common_util.LockDict() |
Chris Sosa | 47a7d4e | 2012-03-28 11:26:55 -0700 | [diff] [blame] | 321 | self._downloader_dict = {} |
David Rochberg | 7c79a81 | 2011-01-19 14:24:45 -0500 | [diff] [blame] | 322 | |
Dale Curtis | c9aaf3a | 2011-08-09 15:47:40 -0700 | [diff] [blame] | 323 | @cherrypy.expose |
David Rochberg | 7c79a81 | 2011-01-19 14:24:45 -0500 | [diff] [blame] | 324 | def build(self, board, pkg, **kwargs): |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 325 | """Builds the package specified.""" |
Nick Sanders | 7dcaa2e | 2011-08-04 15:20:41 -0700 | [diff] [blame] | 326 | import builder |
| 327 | if self._builder is None: |
| 328 | self._builder = builder.Builder() |
David Rochberg | 7c79a81 | 2011-01-19 14:24:45 -0500 | [diff] [blame] | 329 | return self._builder.Build(board, pkg, kwargs) |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 330 | |
Chris Sosa | cde6bf4 | 2012-05-31 18:36:39 -0700 | [diff] [blame] | 331 | @staticmethod |
| 332 | def _canonicalize_archive_url(archive_url): |
| 333 | """Canonicalizes archive_url strings. |
| 334 | |
| 335 | Raises: |
| 336 | DevserverError: if archive_url is not set. |
| 337 | """ |
| 338 | if archive_url: |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 339 | if not archive_url.startswith('gs://'): |
| 340 | raise DevServerError("Archive URL isn't from Google Storage.") |
| 341 | |
Chris Sosa | cde6bf4 | 2012-05-31 18:36:39 -0700 | [diff] [blame] | 342 | return archive_url.rstrip('/') |
| 343 | else: |
| 344 | raise DevServerError("Must specify an archive_url in the request") |
| 345 | |
Dale Curtis | c9aaf3a | 2011-08-09 15:47:40 -0700 | [diff] [blame] | 346 | @cherrypy.expose |
Frank Farzan | bcb571e | 2012-01-03 11:48:17 -0800 | [diff] [blame] | 347 | def download(self, **kwargs): |
| 348 | """Downloads and archives full/delta payloads from Google Storage. |
| 349 | |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 350 | THIS METHOD IS DEPRECATED: use stage(..., artifacts=...) instead. |
Chris Sosa | 47a7d4e | 2012-03-28 11:26:55 -0700 | [diff] [blame] | 351 | This methods downloads artifacts. It may download artifacts in the |
| 352 | background in which case a caller should call wait_for_status to get |
| 353 | the status of the background artifact downloads. They should use the same |
| 354 | args passed to download. |
| 355 | |
Frank Farzan | bcb571e | 2012-01-03 11:48:17 -0800 | [diff] [blame] | 356 | Args: |
| 357 | archive_url: Google Storage URL for the build. |
| 358 | |
| 359 | Example URL: |
Gilad Arnold | f8f769f | 2012-09-24 08:43:01 -0700 | [diff] [blame] | 360 | http://myhost/download?archive_url=gs://chromeos-image-archive/ |
| 361 | x86-generic/R17-1208.0.0-a1-b338 |
Frank Farzan | bcb571e | 2012-01-03 11:48:17 -0800 | [diff] [blame] | 362 | """ |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 363 | return self.stage(archive_url=kwargs.get('archive_url'), |
| 364 | artifacts='full_payload,test_suites,stateful') |
| 365 | |
| 366 | @cherrypy.expose |
| 367 | def stage(self, **kwargs): |
| 368 | """Downloads and caches the artifacts from Google Storage URL. |
| 369 | |
| 370 | Downloads and caches the artifacts Google Storage URL. Returns once these |
| 371 | have been downloaded on the devserver. A call to this will attempt to cache |
| 372 | non-specified artifacts in the background for the given from the given URL |
| 373 | following the principle of spatial locality. Spatial locality of different |
| 374 | artifacts is explicitly defined in the build_artifact module. |
| 375 | |
| 376 | These artifacts will then be available from the static/ sub-directory of |
| 377 | the devserver. |
| 378 | |
| 379 | Args: |
| 380 | archive_url: Google Storage URL for the build. |
| 381 | artifacts: Comma separated list of artifacts to download. |
| 382 | |
| 383 | Example: |
| 384 | To download the autotest and test suites tarballs: |
| 385 | http://devserver_url:<port>/stage?archive_url=gs://your_url/path& |
| 386 | artifacts=autotest,test_suites |
| 387 | To download the full update payload: |
| 388 | http://devserver_url:<port>/stage?archive_url=gs://your_url/path& |
| 389 | artifacts=full_payload |
| 390 | |
| 391 | For both these examples, one could find these artifacts at: |
| 392 | http://devserver_url:<port>/static/archive/<relative_path>* |
| 393 | |
| 394 | Note for this example, relative path is the archive_url stripped of its |
| 395 | basename i.e. path/ in the examples above. Specific example: |
| 396 | |
| 397 | gs://chromeos-image-archive/x86-mario-release/R26-3920.0.0 |
| 398 | |
| 399 | Will get staged to: |
| 400 | |
| 401 | http://devserver_url:<port>/static/archive/x86-mario-release/R26-3920.0.0 |
| 402 | """ |
Chris Sosa | cde6bf4 | 2012-05-31 18:36:39 -0700 | [diff] [blame] | 403 | archive_url = self._canonicalize_archive_url(kwargs.get('archive_url')) |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 404 | artifacts = kwargs.get('artifacts', '') |
| 405 | if not artifacts: |
| 406 | raise DevServerError('No artifacts specified.') |
Chris Sosa | 47a7d4e | 2012-03-28 11:26:55 -0700 | [diff] [blame] | 407 | |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 408 | downloader.Downloader(updater.static_dir, archive_url).Download( |
| 409 | artifacts.split(',')) |
| 410 | return 'Success' |
Chris Sosa | cde6bf4 | 2012-05-31 18:36:39 -0700 | [diff] [blame] | 411 | |
| 412 | @cherrypy.expose |
| 413 | def wait_for_status(self, **kwargs): |
| 414 | """Waits for background artifacts to be downloaded from Google Storage. |
| 415 | |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 416 | THIS METHOD IS DEPRECATED: use stage(..., artifacts=...) instead. |
Chris Sosa | cde6bf4 | 2012-05-31 18:36:39 -0700 | [diff] [blame] | 417 | Args: |
| 418 | archive_url: Google Storage URL for the build. |
| 419 | |
| 420 | Example URL: |
Gilad Arnold | f8f769f | 2012-09-24 08:43:01 -0700 | [diff] [blame] | 421 | http://myhost/wait_for_status?archive_url=gs://chromeos-image-archive/ |
| 422 | x86-generic/R17-1208.0.0-a1-b338 |
Chris Sosa | cde6bf4 | 2012-05-31 18:36:39 -0700 | [diff] [blame] | 423 | """ |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 424 | return self.stage(archive_url=kwargs.get('archive_url'), |
| 425 | artifacts='full_payload,test_suites,autotest,stateful') |
Chris Sosa | 47a7d4e | 2012-03-28 11:26:55 -0700 | [diff] [blame] | 426 | |
| 427 | @cherrypy.expose |
Chris Masone | 816e38c | 2012-05-02 12:22:36 -0700 | [diff] [blame] | 428 | def stage_debug(self, **kwargs): |
| 429 | """Downloads and stages debug symbol payloads from Google Storage. |
| 430 | |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 431 | THIS METHOD IS DEPRECATED: use stage(..., artifacts=...) instead. |
| 432 | This methods downloads the debug symbol build artifact |
| 433 | synchronously, and then stages it for use by symbolicate_dump. |
Chris Masone | 816e38c | 2012-05-02 12:22:36 -0700 | [diff] [blame] | 434 | |
| 435 | Args: |
| 436 | archive_url: Google Storage URL for the build. |
| 437 | |
| 438 | Example URL: |
Gilad Arnold | f8f769f | 2012-09-24 08:43:01 -0700 | [diff] [blame] | 439 | http://myhost/stage_debug?archive_url=gs://chromeos-image-archive/ |
| 440 | x86-generic/R17-1208.0.0-a1-b338 |
Chris Masone | 816e38c | 2012-05-02 12:22:36 -0700 | [diff] [blame] | 441 | """ |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 442 | return self.stage(archive_url=kwargs.get('archive_url'), |
| 443 | artifacts='symbols') |
Chris Masone | 816e38c | 2012-05-02 12:22:36 -0700 | [diff] [blame] | 444 | |
| 445 | @cherrypy.expose |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 446 | def symbolicate_dump(self, minidump, **kwargs): |
Chris Masone | 816e38c | 2012-05-02 12:22:36 -0700 | [diff] [blame] | 447 | """Symbolicates a minidump using pre-downloaded symbols, returns it. |
| 448 | |
| 449 | Callers will need to POST to this URL with a body of MIME-type |
| 450 | "multipart/form-data". |
| 451 | The body should include a single argument, 'minidump', containing the |
| 452 | binary-formatted minidump to symbolicate. |
| 453 | |
Chris Masone | 816e38c | 2012-05-02 12:22:36 -0700 | [diff] [blame] | 454 | Args: |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 455 | archive_url: Google Storage URL for the build. |
Chris Masone | 816e38c | 2012-05-02 12:22:36 -0700 | [diff] [blame] | 456 | minidump: The binary minidump file to symbolicate. |
| 457 | """ |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 458 | # Ensure the symbols have been staged. |
| 459 | archive_url = self._canonicalize_archive_url(kwargs.get('archive_url')) |
| 460 | if self.stage(archive_url=archive_url, artifacts='symbols') != 'Success': |
| 461 | raise DevServerError('Failed to stage symbols for %s' % archive_url) |
| 462 | |
Chris Masone | 816e38c | 2012-05-02 12:22:36 -0700 | [diff] [blame] | 463 | to_return = '' |
| 464 | with tempfile.NamedTemporaryFile() as local: |
| 465 | while True: |
| 466 | data = minidump.file.read(8192) |
| 467 | if not data: |
| 468 | break |
| 469 | local.write(data) |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 470 | |
Chris Masone | 816e38c | 2012-05-02 12:22:36 -0700 | [diff] [blame] | 471 | local.flush() |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 472 | |
| 473 | symbols_directory = os.path.join(downloader.Downloader.GetBuildDir( |
| 474 | updater.static_dir, archive_url), 'debug', 'breakpad') |
| 475 | |
| 476 | stackwalk = subprocess.Popen( |
| 477 | ['minidump_stackwalk', local.name, symbols_directory], |
| 478 | stdout=subprocess.PIPE, stderr=subprocess.PIPE) |
| 479 | |
Chris Masone | 816e38c | 2012-05-02 12:22:36 -0700 | [diff] [blame] | 480 | to_return, error_text = stackwalk.communicate() |
| 481 | if stackwalk.returncode != 0: |
| 482 | raise DevServerError("Can't generate stack trace: %s (rc=%d)" % ( |
| 483 | error_text, stackwalk.returncode)) |
| 484 | |
| 485 | return to_return |
| 486 | |
| 487 | @cherrypy.expose |
Scott Zawalski | 1695453 | 2012-03-20 15:31:36 -0400 | [diff] [blame] | 488 | def latestbuild(self, **params): |
| 489 | """Return a string representing the latest build for a given target. |
| 490 | |
| 491 | Args: |
| 492 | target: The build target, typically a combination of the board and the |
| 493 | type of build e.g. x86-mario-release. |
| 494 | milestone: The milestone to filter builds on. E.g. R16. Optional, if not |
| 495 | provided the latest RXX build will be returned. |
| 496 | Returns: |
| 497 | A string representation of the latest build if one exists, i.e. |
| 498 | R19-1993.0.0-a1-b1480. |
| 499 | An empty string if no latest could be found. |
| 500 | """ |
| 501 | if not params: |
| 502 | return _PrintDocStringAsHTML(self.latestbuild) |
| 503 | |
| 504 | if 'target' not in params: |
| 505 | raise cherrypy.HTTPError('500 Internal Server Error', |
| 506 | 'Error: target= is required!') |
| 507 | try: |
Gilad Arnold | c65330c | 2012-09-20 15:17:48 -0700 | [diff] [blame] | 508 | return common_util.GetLatestBuildVersion( |
Scott Zawalski | 1695453 | 2012-03-20 15:31:36 -0400 | [diff] [blame] | 509 | updater.static_dir, params['target'], |
| 510 | milestone=params.get('milestone')) |
Gilad Arnold | 17fe03d | 2012-10-02 10:05:01 -0700 | [diff] [blame] | 511 | except common_util.CommonUtilError as errmsg: |
Scott Zawalski | 1695453 | 2012-03-20 15:31:36 -0400 | [diff] [blame] | 512 | raise cherrypy.HTTPError('500 Internal Server Error', str(errmsg)) |
| 513 | |
| 514 | @cherrypy.expose |
Scott Zawalski | 84a39c9 | 2012-01-13 15:12:42 -0500 | [diff] [blame] | 515 | def controlfiles(self, **params): |
Scott Zawalski | 4647ce6 | 2012-01-03 17:17:28 -0500 | [diff] [blame] | 516 | """Return a control file or a list of all known control files. |
| 517 | |
| 518 | Example URL: |
| 519 | To List all control files: |
Scott Zawalski | 84a39c9 | 2012-01-13 15:12:42 -0500 | [diff] [blame] | 520 | http://dev-server/controlfiles?board=x86-alex-release&build=R18-1514.0.0 |
Scott Zawalski | 4647ce6 | 2012-01-03 17:17:28 -0500 | [diff] [blame] | 521 | To return the contents of a path: |
Scott Zawalski | 84a39c9 | 2012-01-13 15:12:42 -0500 | [diff] [blame] | 522 | http://dev-server/controlfiles?board=x86-alex-release&build=R18-1514.0.0&control_path=client/sleeptest/control |
Scott Zawalski | 4647ce6 | 2012-01-03 17:17:28 -0500 | [diff] [blame] | 523 | |
| 524 | Args: |
Scott Zawalski | 84a39c9 | 2012-01-13 15:12:42 -0500 | [diff] [blame] | 525 | build: The build i.e. x86-alex-release/R18-1514.0.0-a1-b1450. |
Scott Zawalski | 4647ce6 | 2012-01-03 17:17:28 -0500 | [diff] [blame] | 526 | control_path: If you want the contents of a control file set this |
| 527 | to the path. E.g. client/site_tests/sleeptest/control |
| 528 | Optional, if not provided return a list of control files is returned. |
| 529 | Returns: |
| 530 | Contents of a control file if control_path is provided. |
| 531 | A list of control files if no control_path is provided. |
| 532 | """ |
Scott Zawalski | 4647ce6 | 2012-01-03 17:17:28 -0500 | [diff] [blame] | 533 | if not params: |
| 534 | return _PrintDocStringAsHTML(self.controlfiles) |
| 535 | |
Scott Zawalski | 84a39c9 | 2012-01-13 15:12:42 -0500 | [diff] [blame] | 536 | if 'build' not in params: |
Scott Zawalski | 4647ce6 | 2012-01-03 17:17:28 -0500 | [diff] [blame] | 537 | raise cherrypy.HTTPError('500 Internal Server Error', |
Scott Zawalski | 84a39c9 | 2012-01-13 15:12:42 -0500 | [diff] [blame] | 538 | 'Error: build= is required!') |
Scott Zawalski | 4647ce6 | 2012-01-03 17:17:28 -0500 | [diff] [blame] | 539 | |
| 540 | if 'control_path' not in params: |
Gilad Arnold | c65330c | 2012-09-20 15:17:48 -0700 | [diff] [blame] | 541 | return common_util.GetControlFileList( |
| 542 | updater.static_dir, params['build']) |
Scott Zawalski | 4647ce6 | 2012-01-03 17:17:28 -0500 | [diff] [blame] | 543 | else: |
Gilad Arnold | c65330c | 2012-09-20 15:17:48 -0700 | [diff] [blame] | 544 | return common_util.GetControlFile( |
| 545 | updater.static_dir, params['build'], params['control_path']) |
Frank Farzan | 4016087 | 2011-12-12 18:39:18 -0800 | [diff] [blame] | 546 | |
| 547 | @cherrypy.expose |
Gilad Arnold | 6f99b98 | 2012-09-12 10:49:40 -0700 | [diff] [blame] | 548 | def stage_images(self, **kwargs): |
| 549 | """Downloads and stages a Chrome OS image from Google Storage. |
| 550 | |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 551 | THIS METHOD IS DEPRECATED: use stage(..., artifacts=...) instead. |
Gilad Arnold | 6f99b98 | 2012-09-12 10:49:40 -0700 | [diff] [blame] | 552 | This method downloads a zipped archive from a specified GS location, then |
| 553 | extracts and stages the specified list of images and stages them under |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 554 | static/BOARD/BUILD/. Download is synchronous. |
Gilad Arnold | 6f99b98 | 2012-09-12 10:49:40 -0700 | [diff] [blame] | 555 | |
| 556 | Args: |
| 557 | archive_url: Google Storage URL for the build. |
| 558 | image_types: comma-separated list of images to download, may include |
| 559 | 'test', 'recovery', and 'base' |
| 560 | |
| 561 | Example URL: |
| 562 | http://myhost/stage_images?archive_url=gs://chromeos-image-archive/ |
| 563 | x86-generic/R17-1208.0.0-a1-b338&image_types=test,base |
| 564 | """ |
Gilad Arnold | 6f99b98 | 2012-09-12 10:49:40 -0700 | [diff] [blame] | 565 | image_types = kwargs.get('image_types').split(',') |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 566 | image_types_list = [image + '_image' for image in image_types] |
| 567 | self.stage(archive_url=kwargs.get('archive_url'), artifacts=','.join( |
| 568 | image_types_list)) |
Gilad Arnold | 6f99b98 | 2012-09-12 10:49:40 -0700 | [diff] [blame] | 569 | |
| 570 | @cherrypy.expose |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 571 | def index(self): |
Gilad Arnold | f8f769f | 2012-09-24 08:43:01 -0700 | [diff] [blame] | 572 | """Presents a welcome message and documentation links.""" |
Gilad Arnold | f8f769f | 2012-09-24 08:43:01 -0700 | [diff] [blame] | 573 | return ('Welcome to the Dev Server!<br>\n' |
| 574 | '<br>\n' |
| 575 | 'Here are the available methods, click for documentation:<br>\n' |
| 576 | '<br>\n' |
| 577 | '%s' % |
| 578 | '<br>\n'.join( |
| 579 | [('<a href=doc/%s>%s</a>' % (name, name)) |
Gilad Arnold | d5ebaaa | 2012-10-02 11:52:38 -0700 | [diff] [blame] | 580 | for name in _FindExposedMethods( |
| 581 | self, '', unlisted=self._UNLISTED_METHODS)])) |
Gilad Arnold | f8f769f | 2012-09-24 08:43:01 -0700 | [diff] [blame] | 582 | |
| 583 | @cherrypy.expose |
| 584 | def doc(self, *args): |
| 585 | """Shows the documentation for available methods / URLs. |
| 586 | |
| 587 | Example: |
| 588 | http://myhost/doc/update |
| 589 | """ |
Gilad Arnold | d5ebaaa | 2012-10-02 11:52:38 -0700 | [diff] [blame] | 590 | name = '/'.join(args) |
| 591 | method = _GetExposedMethod(self, name) |
Gilad Arnold | f8f769f | 2012-09-24 08:43:01 -0700 | [diff] [blame] | 592 | if not method: |
| 593 | raise DevServerError("No exposed method named `%s'" % name) |
| 594 | if not method.__doc__: |
| 595 | raise DevServerError("No documentation for exposed method `%s'" % name) |
| 596 | return '<pre>\n%s</pre>' % method.__doc__ |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 597 | |
Dale Curtis | c9aaf3a | 2011-08-09 15:47:40 -0700 | [diff] [blame] | 598 | @cherrypy.expose |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 599 | def update(self, *args): |
Gilad Arnold | f8f769f | 2012-09-24 08:43:01 -0700 | [diff] [blame] | 600 | """Handles an update check from a Chrome OS client. |
| 601 | |
| 602 | The HTTP request should contain the standard Omaha-style XML blob. The URL |
| 603 | line may contain an additional intermediate path to the update payload. |
| 604 | |
| 605 | Example: |
| 606 | http://myhost/update/optional/path/to/payload |
| 607 | """ |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 608 | label = '/'.join(args) |
Gilad Arnold | 286a006 | 2012-01-12 13:47:02 -0800 | [diff] [blame] | 609 | body_length = int(cherrypy.request.headers.get('Content-Length', 0)) |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 610 | data = cherrypy.request.rfile.read(body_length) |
| 611 | return updater.HandleUpdatePing(data, label) |
| 612 | |
Chris Sosa | 0356d3b | 2010-09-16 15:46:22 -0700 | [diff] [blame] | 613 | |
Chris Sosa | dbc2008 | 2012-12-10 13:39:11 -0800 | [diff] [blame] | 614 | def _CleanCache(cache_dir, wipe): |
| 615 | """Wipes any excess cached items in the cache_dir. |
| 616 | |
| 617 | Args: |
| 618 | cache_dir: the directory we are wiping from. |
| 619 | wipe: If True, wipe all the contents -- not just the excess. |
| 620 | """ |
| 621 | if wipe: |
| 622 | # Clear the cache and exit on error. |
| 623 | cmd = 'rm -rf %s/*' % cache_dir |
| 624 | if os.system(cmd) != 0: |
| 625 | _Log('Failed to clear the cache with %s' % cmd) |
| 626 | sys.exit(1) |
| 627 | else: |
| 628 | # Clear all but the last N cached updates |
| 629 | cmd = ('cd %s; ls -tr | head --lines=-%d | xargs rm -rf' % |
| 630 | (cache_dir, CACHED_ENTRIES)) |
| 631 | if os.system(cmd) != 0: |
| 632 | _Log('Failed to clean up old delta cache files with %s' % cmd) |
| 633 | sys.exit(1) |
| 634 | |
| 635 | |
Chris Sosa | cde6bf4 | 2012-05-31 18:36:39 -0700 | [diff] [blame] | 636 | def main(): |
Sean O'Connor | 14b6a0a | 2010-03-20 23:23:48 -0700 | [diff] [blame] | 637 | usage = 'usage: %prog [options]' |
Gilad Arnold | 286a006 | 2012-01-12 13:47:02 -0800 | [diff] [blame] | 638 | parser = optparse.OptionParser(usage=usage) |
Gilad Arnold | 9714d9b | 2012-10-04 10:09:42 -0700 | [diff] [blame] | 639 | parser.add_option('--archive_dir', |
| 640 | metavar='PATH', |
Chris Sosa | dbc2008 | 2012-12-10 13:39:11 -0800 | [diff] [blame] | 641 | help='Enables serve-only mode. Serves archived builds only') |
Gilad Arnold | 9714d9b | 2012-10-04 10:09:42 -0700 | [diff] [blame] | 642 | parser.add_option('--board', |
| 643 | help='when pre-generating update, board for latest image') |
| 644 | parser.add_option('--clear_cache', |
Satoru Takabayashi | d733cbe | 2011-11-15 09:36:32 -0800 | [diff] [blame] | 645 | action='store_true', default=False, |
Gilad Arnold | 9714d9b | 2012-10-04 10:09:42 -0700 | [diff] [blame] | 646 | help='clear out all cached updates and exit') |
| 647 | parser.add_option('--critical_update', |
| 648 | action='store_true', default=False, |
| 649 | help='present update payload as critical') |
| 650 | parser.add_option('--data_dir', |
| 651 | metavar='PATH', |
| 652 | default=os.path.dirname(os.path.abspath(sys.argv[0])), |
| 653 | help='writable directory where static lives') |
| 654 | parser.add_option('--exit', |
| 655 | action='store_true', |
| 656 | help='do not start server (yet pregenerate/clear cache)') |
Gilad Arnold | 9714d9b | 2012-10-04 10:09:42 -0700 | [diff] [blame] | 657 | parser.add_option('--for_vm', |
| 658 | dest='vm', action='store_true', |
| 659 | help='update is for a vm image') |
Gilad Arnold | 8318eac | 2012-10-04 12:52:23 -0700 | [diff] [blame] | 660 | parser.add_option('--host_log', |
| 661 | action='store_true', default=False, |
| 662 | help='record history of host update events (/api/hostlog)') |
Gilad Arnold | 9714d9b | 2012-10-04 10:09:42 -0700 | [diff] [blame] | 663 | parser.add_option('--image', |
| 664 | metavar='FILE', |
Chris Sosa | dbc2008 | 2012-12-10 13:39:11 -0800 | [diff] [blame] | 665 | help='Force update using this image. Can only be used when ' |
| 666 | 'not in serve-only mode as it is used to generate a ' |
| 667 | 'payload.') |
Gilad Arnold | 9714d9b | 2012-10-04 10:09:42 -0700 | [diff] [blame] | 668 | parser.add_option('--logfile', |
| 669 | metavar='PATH', |
| 670 | help='log output to this file instead of stdout') |
Gilad Arnold | a564b4b | 2012-10-04 10:32:44 -0700 | [diff] [blame] | 671 | parser.add_option('--max_updates', |
Chris Sosa | 76e44b9 | 2013-01-31 12:11:38 -0800 | [diff] [blame] | 672 | metavar='NUM', default= -1, type='int', |
Gilad Arnold | a564b4b | 2012-10-04 10:32:44 -0700 | [diff] [blame] | 673 | help='maximum number of update checks handled positively ' |
| 674 | '(default: unlimited)') |
Gilad Arnold | 9714d9b | 2012-10-04 10:09:42 -0700 | [diff] [blame] | 675 | parser.add_option('-p', '--pregenerate_update', |
| 676 | action='store_true', default=False, |
Chris Sosa | dbc2008 | 2012-12-10 13:39:11 -0800 | [diff] [blame] | 677 | help='pre-generate update payload. Can only be used when ' |
| 678 | 'not in serve-only mode as it is used to generate a ' |
| 679 | 'payload.') |
Gilad Arnold | 9714d9b | 2012-10-04 10:09:42 -0700 | [diff] [blame] | 680 | parser.add_option('--payload', |
| 681 | metavar='PATH', |
| 682 | help='use update payload from specified directory') |
| 683 | parser.add_option('--port', |
| 684 | default=8080, type='int', |
| 685 | help='port for the dev server to use (default: 8080)') |
| 686 | parser.add_option('--private_key', |
| 687 | metavar='PATH', default=None, |
| 688 | help='path to the private key in pem format') |
| 689 | parser.add_option('--production', |
| 690 | action='store_true', default=False, |
| 691 | help='have the devserver use production values') |
| 692 | parser.add_option('--proxy_port', |
| 693 | metavar='PORT', default=None, type='int', |
| 694 | help='port to have the client connect to (testing support)') |
| 695 | parser.add_option('--remote_payload', |
| 696 | action='store_true', default=False, |
| 697 | help='Payload is being served from a remote machine') |
| 698 | parser.add_option('--src_image', |
| 699 | metavar='PATH', default='', |
| 700 | help='source image for generating delta updates from') |
| 701 | parser.add_option('-t', '--test_image', |
| 702 | action='store_true', |
| 703 | help='whether or not to use test images') |
| 704 | parser.add_option('-u', '--urlbase', |
| 705 | metavar='URL', |
| 706 | help='base URL for update images, other than the devserver') |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 707 | (options, _) = parser.parse_args() |
rtc@google.com | 21a5ca3 | 2009-11-04 18:23:23 +0000 | [diff] [blame] | 708 | |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 709 | devserver_dir = os.path.dirname(os.path.abspath(sys.argv[0])) |
| 710 | root_dir = os.path.realpath('%s/../..' % devserver_dir) |
Chris Sosa | 0356d3b | 2010-09-16 15:46:22 -0700 | [diff] [blame] | 711 | serve_only = False |
| 712 | |
Zdenek Behan | 608f46c | 2011-02-19 00:47:16 +0100 | [diff] [blame] | 713 | static_dir = os.path.realpath('%s/static' % options.data_dir) |
| 714 | os.system('mkdir -p %s' % static_dir) |
| 715 | |
Sean O'Connor | 14b6a0a | 2010-03-20 23:23:48 -0700 | [diff] [blame] | 716 | if options.archive_dir: |
Zdenek Behan | 608f46c | 2011-02-19 00:47:16 +0100 | [diff] [blame] | 717 | # TODO(zbehan) Remove legacy support: |
| 718 | # archive_dir is the directory where static/archive will point. |
| 719 | # If this is an absolute path, all is fine. If someone calls this |
| 720 | # using a relative path, that is relative to src/platform/dev/. |
| 721 | # That use case is unmaintainable, but since applications use it |
| 722 | # with =./static, instead of a boolean flag, we'll make this relative |
| 723 | # to devserver_dir to keep these unbroken. For now. |
| 724 | archive_dir = options.archive_dir |
| 725 | if not os.path.isabs(archive_dir): |
Chris Sosa | 47a7d4e | 2012-03-28 11:26:55 -0700 | [diff] [blame] | 726 | archive_dir = os.path.realpath(os.path.join(devserver_dir, archive_dir)) |
Zdenek Behan | 608f46c | 2011-02-19 00:47:16 +0100 | [diff] [blame] | 727 | _PrepareToServeUpdatesOnly(archive_dir, static_dir) |
Zdenek Behan | 6d93e55 | 2011-03-02 22:35:49 +0100 | [diff] [blame] | 728 | static_dir = os.path.realpath(archive_dir) |
Chris Sosa | 0356d3b | 2010-09-16 15:46:22 -0700 | [diff] [blame] | 729 | serve_only = True |
Chris Sosa | 0356d3b | 2010-09-16 15:46:22 -0700 | [diff] [blame] | 730 | |
Don Garrett | f90edf0 | 2010-11-16 17:36:14 -0800 | [diff] [blame] | 731 | cache_dir = os.path.join(static_dir, 'cache') |
Chris Sosa | dbc2008 | 2012-12-10 13:39:11 -0800 | [diff] [blame] | 732 | # If our devserver is only supposed to serve payloads, we shouldn't be mucking |
| 733 | # with the cache at all. If the devserver hadn't previously generated a cache |
| 734 | # and is expected, the caller is using it wrong. |
| 735 | if serve_only: |
| 736 | # Extra check to make sure we're not being called incorrectly. |
| 737 | if (options.clear_cache or options.exit or options.pregenerate_update or |
| 738 | options.board or options.image): |
| 739 | parser.error('Incompatible flags detected for serve_only mode.') |
Don Garrett | f90edf0 | 2010-11-16 17:36:14 -0800 | [diff] [blame] | 740 | |
Chris Sosa | dbc2008 | 2012-12-10 13:39:11 -0800 | [diff] [blame] | 741 | elif os.path.exists(cache_dir): |
| 742 | _CleanCache(cache_dir, options.clear_cache) |
Chris Sosa | 6b8c374 | 2011-01-31 12:12:17 -0800 | [diff] [blame] | 743 | else: |
| 744 | os.makedirs(cache_dir) |
Don Garrett | f90edf0 | 2010-11-16 17:36:14 -0800 | [diff] [blame] | 745 | |
Chris Sosa | dbc2008 | 2012-12-10 13:39:11 -0800 | [diff] [blame] | 746 | _Log('Using cache directory %s' % cache_dir) |
Gilad Arnold | c65330c | 2012-09-20 15:17:48 -0700 | [diff] [blame] | 747 | _Log('Data dir is %s' % options.data_dir) |
| 748 | _Log('Source root is %s' % root_dir) |
| 749 | _Log('Serving from %s' % static_dir) |
rtc@google.com | 21a5ca3 | 2009-11-04 18:23:23 +0000 | [diff] [blame] | 750 | |
Chris Sosa | 6a3697f | 2013-01-29 16:44:43 -0800 | [diff] [blame] | 751 | # We allow global use here to share with cherrypy classes. |
| 752 | # pylint: disable=W0603 |
Chris Sosa | cde6bf4 | 2012-05-31 18:36:39 -0700 | [diff] [blame] | 753 | global updater |
Andrew de los Reyes | 5262080 | 2010-04-12 13:40:07 -0700 | [diff] [blame] | 754 | updater = autoupdate.Autoupdate( |
| 755 | root_dir=root_dir, |
| 756 | static_dir=static_dir, |
Chris Sosa | 0356d3b | 2010-09-16 15:46:22 -0700 | [diff] [blame] | 757 | serve_only=serve_only, |
Andrew de los Reyes | 5262080 | 2010-04-12 13:40:07 -0700 | [diff] [blame] | 758 | urlbase=options.urlbase, |
| 759 | test_image=options.test_image, |
Chris Sosa | 5d342a2 | 2010-09-28 16:54:41 -0700 | [diff] [blame] | 760 | forced_image=options.image, |
Gilad Arnold | 0c9c860 | 2012-10-02 23:58:58 -0700 | [diff] [blame] | 761 | payload_path=options.payload, |
Don Garrett | 0ad0937 | 2010-12-06 16:20:30 -0800 | [diff] [blame] | 762 | proxy_port=options.proxy_port, |
Chris Sosa | 4136e69 | 2010-10-28 23:42:37 -0700 | [diff] [blame] | 763 | src_image=options.src_image, |
Chris Sosa | e67b78f | 2010-11-04 17:33:16 -0700 | [diff] [blame] | 764 | vm=options.vm, |
Chris Sosa | 08d55a2 | 2011-01-19 16:08:02 -0800 | [diff] [blame] | 765 | board=options.board, |
Chris Sosa | 0f1ec84 | 2011-02-14 16:33:22 -0800 | [diff] [blame] | 766 | copy_to_static_root=not options.exit, |
| 767 | private_key=options.private_key, |
Satoru Takabayashi | d733cbe | 2011-11-15 09:36:32 -0800 | [diff] [blame] | 768 | critical_update=options.critical_update, |
Gilad Arnold | 0c9c860 | 2012-10-02 23:58:58 -0700 | [diff] [blame] | 769 | remote_payload=options.remote_payload, |
Gilad Arnold | a564b4b | 2012-10-04 10:32:44 -0700 | [diff] [blame] | 770 | max_updates=options.max_updates, |
Gilad Arnold | 8318eac | 2012-10-04 12:52:23 -0700 | [diff] [blame] | 771 | host_log=options.host_log, |
Chris Sosa | 0f1ec84 | 2011-02-14 16:33:22 -0800 | [diff] [blame] | 772 | ) |
Chris Sosa | 7c93136 | 2010-10-11 19:49:01 -0700 | [diff] [blame] | 773 | |
Chris Sosa | 6a3697f | 2013-01-29 16:44:43 -0800 | [diff] [blame] | 774 | if options.pregenerate_update: |
| 775 | updater.PreGenerateUpdate() |
Chris Sosa | 0356d3b | 2010-09-16 15:46:22 -0700 | [diff] [blame] | 776 | |
Don Garrett | 0c880e2 | 2010-11-17 18:13:37 -0800 | [diff] [blame] | 777 | # If the command line requested after setup, it's time to do it. |
| 778 | if not options.exit: |
Chris Sosa | 66e2d9c | 2012-07-11 14:14:14 -0700 | [diff] [blame] | 779 | # Handle options that must be set globally in cherrypy. |
Chris Sosa | 2f1c41e | 2012-07-10 14:32:33 -0700 | [diff] [blame] | 780 | if options.production: |
Chris Sosa | 66e2d9c | 2012-07-11 14:14:14 -0700 | [diff] [blame] | 781 | cherrypy.config.update({'environment': 'production'}) |
| 782 | if not options.logfile: |
| 783 | cherrypy.config.update({'log.screen': True}) |
| 784 | else: |
| 785 | cherrypy.config.update({'log.error_file': options.logfile, |
| 786 | 'log.access_file': options.logfile}) |
Chris Sosa | 2f1c41e | 2012-07-10 14:32:33 -0700 | [diff] [blame] | 787 | |
Don Garrett | 0c880e2 | 2010-11-17 18:13:37 -0800 | [diff] [blame] | 788 | cherrypy.quickstart(DevServerRoot(), config=_GetConfig(options)) |
Chris Sosa | cde6bf4 | 2012-05-31 18:36:39 -0700 | [diff] [blame] | 789 | |
| 790 | |
| 791 | if __name__ == '__main__': |
| 792 | main() |