• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1#!/usr/bin/env python
2# Copyright 2014 The LibYuv Project Authors. All rights reserved.
3#
4# Use of this source code is governed by a BSD-style license
5# that can be found in the LICENSE file in the root of the source
6# tree. An additional intellectual property rights grant can be found
7# in the file PATENTS. All contributing project authors may
8# be found in the AUTHORS file in the root of the source tree.
9
10"""Script to download a Chromium checkout into the workspace.
11
12The script downloads a full Chromium Git clone and its DEPS.
13
14The following environment variable can be used to alter the behavior:
15* CHROMIUM_NO_HISTORY - If set to 1, a Git checkout with no history will be
16  downloaded. This is consumes less bandwidth and disk space but is known to be
17  slower in general if you have a high-speed connection.
18
19After a successful sync has completed, a .last_sync_chromium file is written to
20the chromium directory. While it exists, no more gclient sync operations will be
21performed until the --target-revision changes or the SCRIPT_VERSION constant is
22incremented. The file can be removed manually to force a new sync.
23"""
24
25import argparse
26import os
27import subprocess
28import sys
29
30# Bump this whenever the algorithm changes and you need bots/devs to re-sync,
31# ignoring the .last_sync_chromium file
32SCRIPT_VERSION = 4
33
34ROOT_DIR = os.path.dirname(os.path.abspath(__file__))
35CHROMIUM_NO_HISTORY = 'CHROMIUM_NO_HISTORY'
36
37def _parse_gclient_dict():
38  gclient_dict = {}
39  try:
40    main_gclient = os.path.join(os.path.dirname(ROOT_DIR), '.gclient')
41    with open(main_gclient, 'rb') as deps_content:
42      exec(deps_content, gclient_dict)
43  except Exception as e:
44    print >> sys.stderr, 'error while parsing .gclient:', e
45  return gclient_dict
46
47
48def get_cache_dir():
49  return _parse_gclient_dict().get('cache_dir')
50
51
52def get_target_os_list():
53  return ','.join(_parse_gclient_dict().get('target_os', []))
54
55
56def main():
57  CR_DIR = os.path.join(ROOT_DIR, 'chromium')
58
59  p = argparse.ArgumentParser()
60  p.add_argument('--target-revision', required=True,
61                 help='The target chromium git revision [REQUIRED]')
62  p.add_argument('--chromium-dir', default=CR_DIR,
63                 help=('The path to the chromium directory to sync '
64                       '(default: %(default)r)'))
65  opts = p.parse_args()
66  opts.chromium_dir = os.path.abspath(opts.chromium_dir)
67
68  target_os_list = get_target_os_list()
69
70  # Do a quick check to see if we were successful last time to make runhooks
71  # sooper fast.
72  flag_file = os.path.join(opts.chromium_dir, '.last_sync_chromium')
73  flag_file_content = '\n'.join([
74    str(SCRIPT_VERSION),
75    opts.target_revision,
76    repr(target_os_list),
77  ])
78  if (os.path.exists(os.path.join(opts.chromium_dir, 'src')) and
79      os.path.exists(flag_file)):
80    with open(flag_file, 'r') as f:
81      if f.read() == flag_file_content:
82        print 'Chromium already up to date: ', opts.target_revision
83        return 0
84    os.unlink(flag_file)
85
86  env = os.environ.copy()
87
88  # Avoid downloading NaCl toolchain as part of the Chromium hooks.
89  env['GYP_CHROMIUM_NO_ACTION'] = '1'
90  gclient_cmd = 'gclient.bat' if sys.platform.startswith('win') else 'gclient'
91  args = [
92      gclient_cmd, 'sync', '--force', '--revision', 'src@'+opts.target_revision
93  ]
94
95  if os.environ.get('CHROME_HEADLESS') == '1':
96    # Running on a buildbot.
97    args.append('-vvv')
98
99    if sys.platform.startswith('win'):
100      cache_path = os.path.join(os.path.splitdrive(ROOT_DIR)[0] + os.path.sep,
101                                'b', 'git-cache')
102    else:
103      cache_path = '/b/git-cache'
104  else:
105    # Support developers setting the cache_dir in .gclient.
106    cache_path = get_cache_dir()
107
108  # Allow for users with poor internet connections to download a Git clone
109  # without history (saves several gigs but is generally slower and doesn't work
110  # with the Git cache).
111  if os.environ.get(CHROMIUM_NO_HISTORY) == '1':
112    if cache_path:
113      print >> sys.stderr, (
114          'You cannot use "no-history" mode for syncing Chrome (i.e. set the '
115          '%s environment variable to 1) when you have cache_dir configured in '
116          'your .gclient.' % CHROMIUM_NO_HISTORY)
117      return 1
118    args.append('--no-history')
119    gclient_entries_file = os.path.join(opts.chromium_dir, '.gclient_entries')
120  else:
121    # Write a temporary .gclient file that has the cache_dir variable added.
122    gclientfile = os.path.join(opts.chromium_dir, '.gclient')
123    with open(gclientfile, 'rb') as spec:
124      spec = spec.read().splitlines()
125      spec[-1] = 'cache_dir = %r' % (cache_path,)
126    with open(gclientfile + '.tmp', 'wb') as f:
127      f.write('\n'.join(spec))
128
129    args += [
130      '--gclientfile', '.gclient.tmp',
131      '--delete_unversioned_trees', '--reset', '--upstream'
132    ]
133    gclient_entries_file = os.path.join(opts.chromium_dir,
134                                        '.gclient.tmp_entries')
135
136  # To avoid gclient sync problems when DEPS entries have been removed we must
137  # wipe the gclient's entries file that contains cached URLs for all DEPS.
138  if os.path.exists(gclient_entries_file):
139    os.unlink(gclient_entries_file)
140
141  if target_os_list:
142    args += ['--deps=' + target_os_list]
143
144  print 'Running "%s" in %s' % (' '.join(args), opts.chromium_dir)
145  ret = subprocess.call(args, cwd=opts.chromium_dir, env=env)
146  if ret == 0:
147    with open(flag_file, 'wb') as f:
148      f.write(flag_file_content)
149
150  return ret
151
152
153if __name__ == '__main__':
154  sys.exit(main())
155