blob: 7d8fd55f0dad1aa598fc7e201b196711d64e8bb4 [file] [log] [blame]
# Copyright (c) 2009-2012 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Chromium OS development server that can be used for all forms of update.
This devserver can be used to perform system-wide autoupdate and update
of specific portage packages on devices running Chromium OS derived operating
systems. It mainly operates in two modes:
1) archive mode: In this mode, the devserver is configured to stage and
serve artifacts from Google Storage using the credentials provided to it before
it is run. The easiest way to understand this is that the devserver is
functioning as a local cache for artifacts produced and uploaded by build
servers. Users of this form of devserver can either download the artifacts
from the devservers static directory OR use the update RPC to perform a
system-wide autoupdate. Archive mode is always active.
2) artifact-generation mode: in this mode, the devserver will attempt to
generate update payloads and build artifacts when requested. This mode only
works in the Chromium OS chroot as it uses build tools only present in the
chroot (emerge, cros_generate_update_payload, etc.). By default, when a device
requests an update from this form of devserver, the devserver will attempt to
discover if a more recent build of the board has been built by the developer
and generate a payload that the requested system can autoupdate to. In addition,
it accepts gmerge requests from devices that will stage the newest version of
a particular package from a developer's chroot onto a requesting device.
For example:
gmerge gmerge -d <devserver_url>
devserver will see if a newer package of gmerge is available. If gmerge is
cros_work'd on, it will re-build gmerge. After this, gmerge will install that
version of gmerge that the devserver just created/found.
For autoupdates, there are many more advanced options that can help specify
how to update and which payload to give to a requester.
import json
import optparse
import os
import re
import shutil
import socket
import subprocess
import sys
import tempfile
import threading
import types
from logging import handlers
import cherrypy
from cherrypy import _cplogging as cplogging
from cherrypy.process import plugins
import autoupdate
import common_util
import downloader
import log_util
import xbuddy
# Module-local log function.
def _Log(message, *args):
return log_util.LogWithTag('DEVSERVER', message, *args)
TELEMETRY_FOLDER = 'telemetry_src'
TELEMETRY_DEPS = ['dep-telemetry_dep.tar.bz2',
# Sets up global to share between classes.
updater = None
# Log rotation parameters. These settings correspond to once a week
# at midnight between Friday and Saturday, with about three months
# of old logs kept for backup.
# For more, see the documentation for
# logging.handlers.TimedRotatingFileHandler
class DevServerError(Exception):
"""Exception class used by this module."""
class DevServerHTTPError(cherrypy.HTTPError):
"""Exception class to log the HTTPResponse before routing it to cherrypy."""
def __init__(self, status, message):
@param status: HTTPResponse status.
@param message: Message associated with the response.
cherrypy.HTTPError.__init__(self, status, message)
_Log('HTTPError status: %s message: %s', status, message)
def _LeadingWhiteSpaceCount(string):
"""Count the amount of leading whitespace in a string.
string: The string to count leading whitespace in.
number of white space chars before characters start.
matched = re.match('^\s+', string)
if matched:
return len(
return 0
def _PrintDocStringAsHTML(func):
"""Make a functions docstring somewhat HTML style.
func: The function to return the docstring from.
A string that is somewhat formated for a web browser.
# TODO(scottz): Make this parse Args/Returns in a prettier way.
# Arguments could be bolded and indented etc.
html_doc = []
for line in func.__doc__.splitlines():
leading_space = _LeadingWhiteSpaceCount(line)
if leading_space > 0:
line = '&nbsp;' * leading_space + line
html_doc.append('<BR>%s' % line)
return '\n'.join(html_doc)
def _GetConfig(options):
"""Returns the configuration for the devserver."""
# On a system with IPv6 not compiled into the kernel,
# AF_INET6 sockets will return a socket.error exception.
# On such systems, fall-back to IPv4.
socket_host = '::'
socket.socket(socket.AF_INET6, socket.SOCK_STREAM)
except socket.error:
socket_host = ''
base_config = { 'global':
{ 'server.log_request_headers': True,
'server.protocol_version': 'HTTP/1.1',
'server.socket_host': socket_host,
'server.socket_port': int(options.port),
'response.timeout': 6000,
'request.show_tracebacks': True,
'server.socket_timeout': 60,
'server.thread_pool': 2,
# Gets rid of cherrypy parsing post file for args.
'request.process_request_body': False,
'response.timeout': 100000,
# Gets rid of cherrypy parsing post file for args.
'request.process_request_body': False,
'response.timeout': 10000,
# Sets up the static dir for file hosting.
{ 'tools.staticdir.dir': options.static_dir,
'tools.staticdir.on': True,
'response.timeout': 10000,
if options.production:
base_config['global'].update({'server.thread_pool': 150})
return base_config
def _GetRecursiveMemberObject(root, member_list):
"""Returns an object corresponding to a nested member list.
root: the root object to search
member_list: list of nested members to search
An object corresponding to the member name list; None otherwise.
for member in member_list:
next_root = root.__class__.__dict__.get(member)
if not next_root:
return None
root = next_root
return root
def _IsExposed(name):
"""Returns True iff |name| has an `exposed' attribute and it is set."""
return hasattr(name, 'exposed') and
def _GetExposedMethod(root, nested_member, ignored=None):
"""Returns a CherryPy-exposed method, if such exists.
root: the root object for searching
nested_member: a slash-joined path to the nested member
ignored: method paths to be ignored
A function object corresponding to the path defined by |member_list| from
the |root| object, if the function is exposed and not ignored; None
method = (not (ignored and nested_member in ignored) and
_GetRecursiveMemberObject(root, nested_member.split('/')))
if (method and type(method) == types.FunctionType and _IsExposed(method)):
return method
def _FindExposedMethods(root, prefix, unlisted=None):
"""Finds exposed CherryPy methods.
root: the root object for searching
prefix: slash-joined chain of members leading to current object
unlisted: URLs to be excluded regardless of their exposed status
List of exposed URLs that are not unlisted.
method_list = []
for member in sorted(root.__class__.__dict__.keys()):
prefixed_member = prefix + '/' + member if prefix else member
if unlisted and prefixed_member in unlisted:
member_obj = root.__class__.__dict__[member]
if _IsExposed(member_obj):
if type(member_obj) == types.FunctionType:
method_list += _FindExposedMethods(
member_obj, prefixed_member, unlisted)
return method_list
class ApiRoot(object):
"""RESTful API for Dev Server information."""
exposed = True
def hostinfo(self, ip):
"""Returns a JSON dictionary containing information about the given ip.
ip: address of host whose info is requested
A JSON dictionary containing all or some of the following fields:
last_event_type (int): last update event type received
last_event_status (int): last update event status received
last_known_version (string): last known version reported in update ping
forced_update_label (string): update label to force next update ping to
use, set by setnextupdate
See the OmahaEvent class in update_engine/omaha_request_action.h for
event type and status code definitions. If the ip does not exist an empty
string is returned.
Example URL:
return updater.HandleHostInfoPing(ip)
def hostlog(self, ip):
"""Returns a JSON object containing a log of host event.
ip: address of host whose event log is requested, or `all'
A JSON encoded list (log) of dictionaries (events), each of which
containing a `timestamp' and other event fields, as described under
Example URL:
return updater.HandleHostLogPing(ip)
def setnextupdate(self, ip):
"""Allows the response to the next update ping from a host to be set.
Takes the IP of the host and an update label as normally provided to the
/update command.
body_length = int(cherrypy.request.headers['Content-Length'])
label =
if label:
label = label.strip()
if label:
return updater.HandleSetUpdatePing(ip, label)
raise DevServerHTTPError(400, 'No label provided.')
def fileinfo(self, *path_args):
"""Returns information about a given staged file.
path_args: path to the file inside the server's static staging directory
A JSON encoded dictionary with information about the said file, which may
contain the following keys/values:
size (int): the file size in bytes
sha1 (string): a base64 encoded SHA1 hash
sha256 (string): a base64 encoded SHA256 hash
Example URL:
file_path = os.path.join(updater.static_dir, *path_args)
if not os.path.exists(file_path):
raise DevServerError('file not found: %s' % file_path)
file_size = os.path.getsize(file_path)
file_sha1 = common_util.GetFileSha1(file_path)
file_sha256 = common_util.GetFileSha256(file_path)
except os.error, e:
raise DevServerError('failed to get info for file %s: %s' %
(file_path, e))
is_delta = autoupdate.Autoupdate.IsDeltaFormatFile(file_path)
return json.dumps({
autoupdate.Autoupdate.SIZE_ATTR: file_size,
autoupdate.Autoupdate.SHA1_ATTR: file_sha1,
autoupdate.Autoupdate.SHA256_ATTR: file_sha256,
autoupdate.Autoupdate.ISDELTA_ATTR: is_delta
class DevServerRoot(object):
"""The Root Class for the Dev Server.
CherryPy works as follows:
For each method in this class, cherrpy interprets root/path
as a call to an instance of DevServerRoot->method_name. For example,
a call to http://myhost/build will call build. CherryPy automatically
parses http args and places them as keyword arguments in each method.
For paths http://myhost/update/dir1/dir2, you can use *args so that
cherrypy uses the update method and puts the extra paths in args.
# Method names that should not be listed on the index page.
_UNLISTED_METHODS = ['index', 'doc']
api = ApiRoot()
# Number of threads that devserver is staging images.
_staging_thread_count = 0
# Lock used to lock increasing/decreasing count.
_staging_thread_count_lock = threading.Lock()
def __init__(self, _xbuddy):
self._builder = None
self._telemetry_lock_dict = common_util.LockDict()
self._xbuddy = _xbuddy
def _get_artifacts(kwargs):
"""Returns a tuple of named and file artifacts given the stage rpc kwargs.
Raises: DevserverError if no artifacts would be returned.
artifacts = kwargs.get('artifacts')
files = kwargs.get('files')
if not artifacts and not files:
raise DevServerError('No artifacts specified.')
# Note we NEED to coerce files to a string as we get raw unicode from
# cherrypy and we treat files as strings elsewhere in the code.
return (str(artifacts).split(',') if artifacts else [],
str(files).split(',') if files else [])
def build(self, board, pkg, **kwargs):
"""Builds the package specified."""
import builder
if self._builder is None:
self._builder = builder.Builder()
return self._builder.Build(board, pkg, kwargs)
def _canonicalize_archive_url(archive_url):
"""Canonicalizes archive_url strings.
DevserverError: if archive_url is not set.
if archive_url:
if not archive_url.startswith('gs://'):
raise DevServerError("Archive URL isn't from Google Storage (%s) ." %
return archive_url.rstrip('/')
raise DevServerError("Must specify an archive_url in the request")
def is_staged(self, **kwargs):
"""Check if artifacts have been downloaded.
async: True to return without waiting for download to complete.
artifacts: Comma separated list of named artifacts to download.
These are defined in artifact_info and have their implementation
files: Comma separated list of file artifacts to stage. These
will be available as is in the corresponding static directory with no
custom post-processing.
returns: True of all artifacts are staged.
To check if autotest and test_suites are staged:
archive_url = self._canonicalize_archive_url(kwargs.get('archive_url'))
artifacts, files = self._get_artifacts(kwargs)
return str(downloader.Downloader(updater.static_dir, archive_url).IsStaged(
artifacts, files))
def stage(self, **kwargs):
"""Downloads and caches the artifacts from Google Storage URL.
Downloads and caches the artifacts Google Storage URL. Returns once these
have been downloaded on the devserver. A call to this will attempt to cache
non-specified artifacts in the background for the given from the given URL
following the principle of spatial locality. Spatial locality of different
artifacts is explicitly defined in the build_artifact module.
These artifacts will then be available from the static/ sub-directory of
the devserver.
archive_url: Google Storage URL for the build.
async: True to return without waiting for download to complete.
artifacts: Comma separated list of named artifacts to download.
These are defined in artifact_info and have their implementation
files: Comma separated list of files to stage. These
will be available as is in the corresponding static directory with no
custom post-processing.
To download the autotest and test suites tarballs:
To download the full update payload:
To download just a file called blah.bin:
For both these examples, one could find these artifacts at:
Note for this example, relative path is the archive_url stripped of its
basename i.e. path/ in the examples above. Specific example:
Will get staged to:
archive_url = self._canonicalize_archive_url(kwargs.get('archive_url'))
async = kwargs.get('async', False)
artifacts, files = self._get_artifacts(kwargs)
with DevServerRoot._staging_thread_count_lock:
DevServerRoot._staging_thread_count += 1
downloader.Downloader(updater.static_dir, archive_url).Download(
artifacts, files, async=async)
with DevServerRoot._staging_thread_count_lock:
DevServerRoot._staging_thread_count -= 1
return 'Success'
def setup_telemetry(self, **kwargs):
"""Extracts and sets up telemetry
This method goes through the telemetry deps packages, and stages them on
the devserver to be used by the drones and the telemetry tests.
archive_url: Google Storage URL for the build.
Path to the source folder for the telemetry codebase once it is staged.
archive_url = kwargs.get('archive_url')
self.stage(archive_url=archive_url, artifacts='autotest')
build = '/'.join(downloader.Downloader.ParseUrl(archive_url))
build_path = os.path.join(updater.static_dir, build)
deps_path = os.path.join(build_path, 'autotest/packages')
telemetry_path = os.path.join(build_path, TELEMETRY_FOLDER)
src_folder = os.path.join(telemetry_path, 'src')
with self._telemetry_lock_dict.lock(telemetry_path):
if os.path.exists(src_folder):
# Telemetry is already fully stage return
return src_folder
# Copy over the required deps tar balls to the telemetry directory.
for dep in TELEMETRY_DEPS:
dep_path = os.path.join(deps_path, dep)
if not os.path.exists(dep_path):
# This dep does not exist (could be new), do not extract it.
common_util.ExtractTarball(dep_path, telemetry_path)
except common_util.CommonUtilError as e:
raise DevServerError(str(e))
# By default all the tarballs extract to test_src but some parts of
# the telemetry code specifically hardcoded to exist inside of 'src'.
test_src = os.path.join(telemetry_path, 'test_src')
shutil.move(test_src, src_folder)
except shutil.Error:
# This can occur if src_folder already exists. Remove and retry move.
raise DevServerError('Failure in telemetry setup for build %s. Appears'
' that the test_src to src move failed.' % build)
return src_folder
def symbolicate_dump(self, minidump, **kwargs):
"""Symbolicates a minidump using pre-downloaded symbols, returns it.
Callers will need to POST to this URL with a body of MIME-type
The body should include a single argument, 'minidump', containing the
binary-formatted minidump to symbolicate.
archive_url: Google Storage URL for the build.
minidump: The binary minidump file to symbolicate.
# Ensure the symbols have been staged.
archive_url = self._canonicalize_archive_url(kwargs.get('archive_url'))
if self.stage(archive_url=archive_url, artifacts='symbols') != 'Success':
raise DevServerError('Failed to stage symbols for %s' % archive_url)
to_return = ''
with tempfile.NamedTemporaryFile() as local:
while True:
data =
if not data:
symbols_directory = os.path.join(downloader.Downloader.GetBuildDir(
updater.static_dir, archive_url), 'debug', 'breakpad')
stackwalk = subprocess.Popen(
['minidump_stackwalk',, symbols_directory],
stdout=subprocess.PIPE, stderr=subprocess.PIPE)
to_return, error_text = stackwalk.communicate()
if stackwalk.returncode != 0:
raise DevServerError("Can't generate stack trace: %s (rc=%d)" % (
error_text, stackwalk.returncode))
return to_return
def latestbuild(self, **params):
"""Return a string representing the latest build for a given target.
target: The build target, typically a combination of the board and the
type of build e.g. x86-mario-release.
milestone: The milestone to filter builds on. E.g. R16. Optional, if not
provided the latest RXX build will be returned.
A string representation of the latest build if one exists, i.e.
An empty string if no latest could be found.
if not params:
return _PrintDocStringAsHTML(self.latestbuild)
if 'target' not in params:
raise DevServerHTTPError(500, 'Error: target= is required!')
return common_util.GetLatestBuildVersion(
updater.static_dir, params['target'],
except common_util.CommonUtilError as errmsg:
raise DevServerHTTPError(500, str(errmsg))
def controlfiles(self, **params):
"""Return a control file or a list of all known control files.
Example URL:
To List all control files:
To List all control files for, say, the bvt suite:
To return the contents of a path:
build: The build i.e. x86-alex-release/R18-1514.0.0-a1-b1450.
control_path: If you want the contents of a control file set this
to the path. E.g. client/site_tests/sleeptest/control
Optional, if not provided return a list of control files is returned.
suite_name: If control_path is not specified but a suite_name is
specified, list the control files belonging to that suite instead of
all control files. The empty string for suite_name will list all control
files for the build.
Contents of a control file if control_path is provided.
A list of control files if no control_path is provided.
if not params:
return _PrintDocStringAsHTML(self.controlfiles)
if 'build' not in params:
raise DevServerHTTPError(500, 'Error: build= is required!')
if 'control_path' not in params:
if 'suite_name' in params and params['suite_name']:
return common_util.GetControlFileListForSuite(
updater.static_dir, params['build'], params['suite_name'])
return common_util.GetControlFileList(
updater.static_dir, params['build'])
return common_util.GetControlFile(
updater.static_dir, params['build'], params['control_path'])
def xbuddy(self, *args, **kwargs):
"""The full xBuddy call, returns resource specified by path_parts.
path_parts: the path following xbuddy/ in the call url is split into the
components of the path. The path can be understood as
"{local|remote}/build_id/artifact" where build_id is composed of
The first path element is optional, and can be "remote" or "local"
If local (the default), devserver will not attempt to access Google
Storage, and will only search the static directory for the files.
If remote, devserver will try to obtain the artifact off GS if it's
not found locally.
The board is the familiar board name, optionally suffixed.
The version can be the google storage version number, and may also be
any of a number of xBuddy defined version aliases that will be
translated into the latest built image that fits the description.
Defaults to latest.
The artifact is one of a number of image or artifact aliases used by
xbuddy, defined in xbuddy:ALIASES. Defaults to test.
return_dir: {true|false}
if set to true, returns the url to the update.gz
Example URL:
A redirect to the image or update file on the devserver.
e.g. http://host:port/static/archive/x86-generic-release/
or if return_dir is True, return path to the folder where
the artifact is.
boolean_string = kwargs.get('return_dir')
return_dir = xbuddy.XBuddy.ParseBoolean(boolean_string)
build_id, file_name = self._xbuddy.Get(args)
if return_dir:
directory = os.path.join(cherrypy.request.base, 'static', build_id)
_Log("Directory requested, returning: %s", directory)
return directory
build_id = '/' + os.path.join('static', build_id, file_name)
_Log("Payload requested, returning: %s", build_id)
raise cherrypy.HTTPRedirect(build_id, 302)
def xbuddy_list(self):
"""Lists the currently available images & time since last access.
@return: A string representation of a list of tuples
[(build_id, time since last access),...]
return self._xbuddy.List()
def xbuddy_capacity(self):
"""Returns the number of images cached by xBuddy.
@return: Capacity of this devserver.
return self._xbuddy.Capacity()
def index(self):
"""Presents a welcome message and documentation links."""
return ('Welcome to the Dev Server!<br>\n'
'Here are the available methods, click for documentation:<br>\n'
'%s' %
[('<a href=doc/%s>%s</a>' % (name, name))
for name in _FindExposedMethods(
self, '', unlisted=self._UNLISTED_METHODS)]))
def doc(self, *args):
"""Shows the documentation for available methods / URLs.
name = '/'.join(args)
method = _GetExposedMethod(self, name)
if not method:
raise DevServerError("No exposed method named `%s'" % name)
if not method.__doc__:
raise DevServerError("No documentation for exposed method `%s'" % name)
return '<pre>\n%s</pre>' % method.__doc__
def update(self, *args):
"""Handles an update check from a Chrome OS client.
The HTTP request should contain the standard Omaha-style XML blob. The URL
line may contain an additional intermediate path to the update payload.
This request can be handled in one of 4 ways, depending on the devsever
settings and intermediate path.
1. No intermediate path
If no intermediate path is given, the default behavior is to generate an
update payload from the latest test image locally built for the board
specified in the xml. Devserver serves the generated payload.
2. Path explicitly invokes XBuddy
If there is a path given, it can explicitly invoke xbuddy by prefixing it
with 'xbuddy'. This path is then used to acquire an image binary for the
devserver to generate an update payload from. Devserver then serves this
3. Path is left for the devserver to interpret.
If the path given doesn't explicitly invoke xbuddy, devserver will attempt
to generate a payload from the test image in that directory and serve it.
4. The devserver is in a 'forced' mode. TO BE DEPRECATED
This comes from the usage of --forced_payload or --image when starting the
devserver. No matter what path (or no path) gets passed in, devserver will
serve the update payload (--forced_payload) or generate an update payload
from the image (--image).
1. No intermediate path
update_engine_client --omaha_url=http://myhost/update
This generates an update payload from the latest test image locally built
for the board specified in the xml.
2. Explicitly invoke xbuddy
update_engine_client --omaha_url=
This would go to GS to download the dev image for the board, from which
the devserver would generate a payload to serve.
3. Give a path for devserver to interpret
update_engine_client --omaha_url=http://myhost/update/some/random/path
This would attempt, in order to:
a) Generate an update from a test image binary if found in
b) Serve an update payload found in static_dir/some/random/path.
c) Hope that some/random/path takes the form "board/version" and
and attempt to download an update payload for that board/version
from GS.
label = '/'.join(args)
body_length = int(cherrypy.request.headers.get('Content-Length', 0))
data =
return updater.HandleUpdatePing(data, label)
def check_health(self):
"""Collect the health status of devserver to see if it's ready for staging.
@return: A JSON dictionary containing all or some of the following fields:
free_disk (int): free disk space in GB
staging_thread_count (int): number of devserver threads currently
staging an image
# Get free disk space.
stat = os.statvfs(updater.static_dir)
free_disk = stat.f_bsize * stat.f_bavail / 1000000000
return json.dumps({
'free_disk': free_disk,
'staging_thread_count': DevServerRoot._staging_thread_count,
def _CleanCache(cache_dir, wipe):
"""Wipes any excess cached items in the cache_dir.
cache_dir: the directory we are wiping from.
wipe: If True, wipe all the contents -- not just the excess.
if wipe:
# Clear the cache and exit on error.
cmd = 'rm -rf %s/*' % cache_dir
if os.system(cmd) != 0:
_Log('Failed to clear the cache with %s' % cmd)
# Clear all but the last N cached updates
cmd = ('cd %s; ls -tr | head --lines=-%d | xargs rm -rf' %
(cache_dir, CACHED_ENTRIES))
if os.system(cmd) != 0:
_Log('Failed to clean up old delta cache files with %s' % cmd)
def _AddTestingOptions(parser):
group = optparse.OptionGroup(
parser, 'Advanced Testing Options', 'These are used by test scripts and '
'developers writing integration tests utilizing the devserver. They are '
'not intended to be really used outside the scope of someone '
'knowledgable about the test.')
help='do not start the server (yet pregenerate/clear cache)')
action='store_true', default=False,
help='record history of host update events (/api/hostlog)')
metavar='NUM', default= -1, type='int',
help='maximum number of update checks handled positively '
'(default: unlimited)')
metavar='PATH', default=None,
help='path to the private key in pem format. If this is set '
'the devserver will generate update payloads that are '
'signed with this key.')
metavar='PORT', default=None, type='int',
help='port to have the client connect to -- basically the '
'devserver lies to the update to tell it to get the payload '
'from a different port that will proxy the request back to '
'the devserver. The proxy must be managed outside the '
action='store_true', default=False,
help='Payload is being served from a remote machine')
group.add_option('-u', '--urlbase',
help='base URL for update images, other than the '
'devserver. Use in conjunction with remote_payload.')
def _AddUpdateOptions(parser):
group = optparse.OptionGroup(
parser, 'Autoupdate Options', 'These options can be used to change '
'how the devserver either generates or serve update payloads. Please '
'note that all of these option affect how a payload is generated and so '
'do not work in archive-only mode.')
help='By default the devserver will create an update '
'payload from the latest image built for the board '
'a device that is requesting an update has. When we '
'pre-generate an update (see below) and we do not specify '
'another update_type option like image or payload, the '
'devserver needs to know the board to generate the latest '
'image for. This is that board.')
action='store_true', default=False,
help='Present update payload as critical')
help='Generate and serve an update using this image to any '
'device that requests an update.')
dest='patch_kernel', action='store_false', default=True,
help='When generating an update payload, do not patch the '
'kernel with kernel verification blob from the stateful '
help='use the update payload from specified directory '
group.add_option('-p', '--pregenerate_update',
action='store_true', default=False,
help='pre-generate the update payload before accepting '
'update requests. Useful to help debug payload generation '
'issues quickly. Also if an update payload will take a '
'long time to generate, a client may timeout if you do not'
'pregenerate the update.')
metavar='PATH', default='',
help='If specified, delta updates will be generated using '
'this image as the source image. Delta updates are when '
'you are updating from a "source image" to a another '
def _AddProductionOptions(parser):
group = optparse.OptionGroup(
parser, 'Advanced Server Options', 'These options can be used to changed '
'for advanced server behavior.')
action='store_true', default=False,
help='At startup, removes all cached entries from the'
'devserver\'s cache.')
help='log output to this file instead of stdout')
help='path to output a pid file for the server.')
action='store_true', default=False,
help='have the devserver use production values when '
'starting up. This includes using more threads and '
'performing less logging.')
def _MakeLogHandler(logfile):
"""Create a LogHandler instance used to log all messages."""
hdlr_cls = handlers.TimedRotatingFileHandler
hdlr = hdlr_cls(logfile, when=_LOG_ROTATION_TIME,
return hdlr
def main():
usage = '\n\n'.join(['usage: %prog [options]', __doc__])
parser = optparse.OptionParser(usage=usage)
# get directory that the devserver is run from
devserver_dir = os.path.dirname(os.path.abspath(sys.argv[0]))
default_static_dir = '%s/static' % devserver_dir
help='writable static directory')
default=8080, type='int',
help='port for the dev server to use (default: 8080)')
parser.add_option('-t', '--test_image',
parser.add_option('-x', '--xbuddy_manage_builds',
help='If set, allow xbuddy to manage images in'
(options, _) = parser.parse_args()
# Handle options that must be set globally in cherrypy. Do this
# work up front, because calls to _Log() below depend on this
# initialization.
if options.production:
cherrypy.config.update({'environment': 'production'})
if not options.logfile:
cherrypy.config.update({'log.screen': True})
cherrypy.config.update({'log.error_file': '',
'log.access_file': ''})
hdlr = _MakeLogHandler(options.logfile)
# Pylint can't seem to process these two calls properly
# pylint: disable=E1101
# pylint: enable=E1101
root_dir = os.path.realpath('%s/../..' % devserver_dir)
# set static_dir, from which everything will be served
options.static_dir = os.path.realpath(options.static_dir)
cache_dir = os.path.join(options.static_dir, 'cache')
# If our devserver is only supposed to serve payloads, we shouldn't be
# mucking with the cache at all. If the devserver hadn't previously
# generated a cache and is expected, the caller is using it wrong.
if os.path.exists(cache_dir):
_CleanCache(cache_dir, options.clear_cache)
_Log('Using cache directory %s' % cache_dir)
_Log('Source root is %s' % root_dir)
_Log('Serving from %s' % options.static_dir)
_xbuddy = xbuddy.XBuddy(options.xbuddy_manage_builds,
# We allow global use here to share with cherrypy classes.
# pylint: disable=W0603
global updater
updater = autoupdate.Autoupdate(
copy_to_static_root=not options.exit,
if options.pregenerate_update:
if options.exit:
dev_server = DevServerRoot(_xbuddy)
if options.pidfile:
plugins.PIDFile(cherrypy.engine, options.pidfile).subscribe()
cherrypy.quickstart(dev_server, config=_GetConfig(options))
if __name__ == '__main__':