blob: 91b1931a96c4ce27865b21e29f33c485ff5a4b89 [file] [log] [blame]
#!/usr/bin/env python
# Copyright (c) 2014 The WebRTC project authors. All Rights Reserved.
# Use of this source code is governed by a BSD-style license
# that can be found in the LICENSE file in the root of the source
# tree. An additional intellectual property rights grant can be found
# in the file PATENTS. All contributing project authors may
# be found in the AUTHORS file in the root of the source tree.
"""Script to download a Chromium checkout into the workspace.
The script downloads a full Chromium Git clone and its DEPS.
The following environment variable can be used to alter the behavior:
* CHROMIUM_NO_HISTORY - If set to 1, a Git checkout with no history will be
downloaded. This is consumes less bandwidth and disk space but is known to be
slower in general if you have a high-speed connection.
After a successful sync has completed, a .last_sync_chromium file is written to
the chromium directory. While it exists, no more gclient sync operations will be
performed until the --target-revision changes or the SCRIPT_VERSION constant is
incremented. The file can be removed manually to force a new sync.
import argparse
import os
import shutil
import subprocess
import sys
import textwrap
# Bump this whenever the algorithm changes and you need bots/devs to re-sync,
# ignoring the .last_sync_chromium file
ROOT_DIR = os.path.dirname(os.path.abspath(__file__))
# Duplicated from depot_tools/ since we cannot depend on that:
"win32": "win",
"win": "win",
"cygwin": "win",
"darwin": "mac",
"mac": "mac",
"unix": "unix",
"linux": "unix",
"linux2": "unix",
"linux3": "unix",
"android": "android",
def _parse_gclient_dict():
gclient_dict = {}
main_gclient = os.path.join(os.path.dirname(ROOT_DIR), '.gclient')
with open(main_gclient, 'rb') as deps_content:
exec(deps_content, gclient_dict)
except Exception as e:
print >> sys.stderr, 'error while parsing .gclient:', e
return gclient_dict
def get_cache_dir():
return _parse_gclient_dict().get('cache_dir')
def get_target_os_list():
# Always add the currently running OS since the --deps option will override
# that if specified:
target_os_list = [DEPS_OS_CHOICES.get(sys.platform, 'unix')]
# Add any target_os entries from .gclient.
target_os_list += _parse_gclient_dict().get('target_os', [])
return ','.join(target_os_list)
def main():
CR_DIR = os.path.join(ROOT_DIR, 'chromium')
p = argparse.ArgumentParser()
p.add_argument('--target-revision', required=True,
help='The target chromium git revision [REQUIRED]')
p.add_argument('--chromium-dir', default=CR_DIR,
help=('The path to the chromium directory to sync '
'(default: %(default)r)'))
opts = p.parse_args()
opts.chromium_dir = os.path.abspath(opts.chromium_dir)
target_os_list = get_target_os_list()
# Do a quick check to see if we were successful last time to make runhooks
# sooper fast.
flag_file = os.path.join(opts.chromium_dir, '.last_sync_chromium')
flag_file_content = '\n'.join([
if (os.path.exists(os.path.join(opts.chromium_dir, 'src')) and
with open(flag_file, 'r') as f:
if == flag_file_content:
print 'Chromium already up to date: ', opts.target_revision
return 0
env = os.environ.copy()
# Workaround to avoid sync failure due move in
# TODO(kjellander): Remove this after the summer of 2015.
freetype_src = os.path.join(CR_DIR, 'src', 'third_party', 'freetype-android',
if os.path.isdir(freetype_src):
# Avoid downloading NaCl toolchain as part of the Chromium hooks.
env.setdefault('GYP_DEFINES', '')
env['GYP_DEFINES'] += ' disable_nacl=1'
gclient_cmd = 'gclient.bat' if sys.platform.startswith('win') else 'gclient'
args = [
gclient_cmd, 'sync', '--force', '--revision', 'src@'+opts.target_revision
if os.environ.get('CHROME_HEADLESS') == '1':
# Running on a buildbot.
if sys.platform.startswith('win'):
cache_path = os.path.join(os.path.splitdrive(ROOT_DIR)[0] + os.path.sep,
'b', 'git-cache')
cache_path = '/b/git-cache'
# Verbose, but not as verbose as on the buildbots.
# Support developers setting the cache_dir in .gclient.
cache_path = get_cache_dir()
# Allow for users with poor internet connections to download a Git clone
# without history (saves several gigs but is generally slower and doesn't work
# with the Git cache).
if os.environ.get(CHROMIUM_NO_HISTORY) == '1':
if cache_path:
print >> sys.stderr, (
'You cannot use "no-history" mode for syncing Chrome (i.e. set the '
'%s environment variable to 1) when you have cache_dir configured in '
'your .gclient.' % CHROMIUM_NO_HISTORY)
return 1
gclient_entries_file = os.path.join(opts.chromium_dir, '.gclient_entries')
# Write a temporary .gclient file that has the cache_dir variable added.
gclientfile = os.path.join(opts.chromium_dir, '.gclient')
with open(gclientfile, 'rb') as spec:
spec =
spec[-1] = 'cache_dir = %r' % (cache_path,)
with open(gclientfile + '.tmp', 'wb') as f:
args += [
'--gclientfile', '.gclient.tmp',
'--delete_unversioned_trees', '--reset', '--upstream'
gclient_entries_file = os.path.join(opts.chromium_dir,
# To avoid gclient sync problems when DEPS entries have been removed we must
# wipe the gclient's entries file that contains cached URLs for all DEPS.
if os.path.exists(gclient_entries_file):
if target_os_list:
args += ['--deps=' + target_os_list]
print textwrap.dedent("""\
| NOTICE: This sync of Chromium will take a long time as several |
| gigabytes of data are downloaded. If this is your initial |
| sync and it's interrupted, try running 'gclient sync' again.|
| If that fails, wipe everything clean and start over again. |
print 'Running "%s" in %s' % (' '.join(args), opts.chromium_dir)
ret =, cwd=opts.chromium_dir, env=env)
if ret == 0:
with open(flag_file, 'wb') as f:
return ret
if __name__ == '__main__':