bb_run_bot.py revision a1401311d1ab56c4ed0a474bd38c108f75cb0cd9 
1#!/usr/bin/env python
2#
3# Copyright (c) 2013 The Chromium Authors. All rights reserved.
4# Use of this source code is governed by a BSD-style license that can be
5# found in the LICENSE file.
6
7import collections
8import copy
9import json
10import os
11import pipes
12import re
13import subprocess
14import sys
15
16import bb_utils
17
18sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
19from pylib import constants
20
21
22CHROMIUM_COVERAGE_BUCKET = 'chromium-code-coverage'
23
24_BotConfig = collections.namedtuple(
25    'BotConfig', ['bot_id', 'host_obj', 'test_obj'])
26
27HostConfig = collections.namedtuple(
28    'HostConfig',
29    ['script', 'host_steps', 'extra_args', 'extra_gyp_defines', 'target_arch'])
30
31TestConfig = collections.namedtuple('Tests', ['script', 'tests', 'extra_args'])
32
33
34def BotConfig(bot_id, host_object, test_object=None):
35  return _BotConfig(bot_id, host_object, test_object)
36
37
38def DictDiff(d1, d2):
39  diff = []
40  for key in sorted(set(d1.keys() + d2.keys())):
41    if key in d1 and d1[key] != d2.get(key):
42      diff.append('- %s=%s' % (key, pipes.quote(d1[key])))
43    if key in d2 and d2[key] != d1.get(key):
44      diff.append('+ %s=%s' % (key, pipes.quote(d2[key])))
45  return '\n'.join(diff)
46
47
48def GetEnvironment(host_obj, testing, extra_env_vars=None):
49  init_env = dict(os.environ)
50  init_env['GYP_GENERATORS'] = 'ninja'
51  if extra_env_vars:
52    init_env.update(extra_env_vars)
53  envsetup_cmd = '. build/android/envsetup.sh'
54  if testing:
55    # Skip envsetup to avoid presubmit dependence on android deps.
56    print 'Testing mode - skipping "%s"' % envsetup_cmd
57    envsetup_cmd = ':'
58  else:
59    print 'Running %s' % envsetup_cmd
60  proc = subprocess.Popen(['bash', '-exc',
61    envsetup_cmd + ' >&2; python build/android/buildbot/env_to_json.py'],
62    stdout=subprocess.PIPE, stderr=subprocess.PIPE,
63    cwd=bb_utils.CHROME_SRC, env=init_env)
64  json_env, envsetup_output = proc.communicate()
65  if proc.returncode != 0:
66    print >> sys.stderr, 'FATAL Failure in envsetup.'
67    print >> sys.stderr, envsetup_output
68    sys.exit(1)
69  env = json.loads(json_env)
70  env['GYP_DEFINES'] = env.get('GYP_DEFINES', '') + \
71      ' fastbuild=1 use_goma=1 gomadir=%s' % bb_utils.GOMA_DIR
72  if host_obj.target_arch:
73    env['GYP_DEFINES'] += ' target_arch=%s' % host_obj.target_arch
74  extra_gyp = host_obj.extra_gyp_defines
75  if extra_gyp:
76    env['GYP_DEFINES'] += ' %s' % extra_gyp
77    if re.search('(asan|clang)=1', extra_gyp):
78      env.pop('CXX_target', None)
79
80  # Bots checkout chrome in /b/build/slave/<name>/build/src
81  build_internal_android = os.path.abspath(os.path.join(
82      bb_utils.CHROME_SRC, '..', '..', '..', '..', '..', 'build_internal',
83      'scripts', 'slave', 'android'))
84  if os.path.exists(build_internal_android):
85    env['PATH'] = os.pathsep.join([build_internal_android, env['PATH']])
86  return env
87
88
89def GetCommands(options, bot_config):
90  """Get a formatted list of commands.
91
92  Args:
93    options: Options object.
94    bot_config: A BotConfig named tuple.
95    host_step_script: Host step script.
96    device_step_script: Device step script.
97  Returns:
98    list of Command objects.
99  """
100  property_args = bb_utils.EncodeProperties(options)
101  commands = [[bot_config.host_obj.script,
102               '--steps=%s' % ','.join(bot_config.host_obj.host_steps)] +
103              property_args + (bot_config.host_obj.extra_args or [])]
104
105  test_obj = bot_config.test_obj
106  if test_obj:
107    run_test_cmd = [test_obj.script] + property_args
108    for test in test_obj.tests:
109      run_test_cmd.extend(['-f', test])
110    if test_obj.extra_args:
111      run_test_cmd.extend(test_obj.extra_args)
112    commands.append(run_test_cmd)
113  return commands
114
115
116def GetBotStepMap():
117  compile_step = ['compile']
118  std_host_tests = ['check_webview_licenses', 'findbugs']
119  std_build_steps = ['compile', 'zip_build']
120  std_test_steps = ['extract_build']
121  std_tests = ['ui', 'unit']
122  flakiness_server = (
123      '--flakiness-server=%s' % constants.UPSTREAM_FLAKINESS_SERVER)
124  experimental = ['--experimental']
125
126  B = BotConfig
127  H = (lambda steps, extra_args=None, extra_gyp=None, target_arch=None :
128       HostConfig('build/android/buildbot/bb_host_steps.py', steps, extra_args,
129                  extra_gyp, target_arch))
130  T = (lambda tests, extra_args=None :
131       TestConfig('build/android/buildbot/bb_device_steps.py', tests,
132                  extra_args))
133
134  bot_configs = [
135      # Main builders
136      B('main-builder-dbg', H(std_build_steps + std_host_tests)),
137      B('main-builder-rel', H(std_build_steps)),
138      B('main-clang-builder',
139        H(compile_step, extra_gyp='clang=1 component=shared_library')),
140      B('main-clobber', H(compile_step)),
141      B('main-tests', H(std_test_steps), T(std_tests, [flakiness_server])),
142
143      # Other waterfalls
144      B('asan-builder-tests', H(compile_step,
145                                extra_gyp='asan=1 component=shared_library'),
146        T(std_tests, ['--asan', '--asan-symbolize'])),
147      B('blink-try-builder', H(compile_step)),
148      B('chromedriver-fyi-tests-dbg', H(std_test_steps),
149        T(['chromedriver'], ['--install=ChromeShell'])),
150      B('fyi-x86-builder-dbg',
151        H(compile_step + std_host_tests, experimental, target_arch='x86')),
152      B('fyi-builder-dbg',
153        H(std_build_steps + std_host_tests, experimental,
154          extra_gyp='emma_coverage=1 android_lint=1')),
155      B('x86-builder-dbg',
156        H(compile_step + std_host_tests, target_arch='x86')),
157      B('fyi-builder-rel', H(std_build_steps,  experimental)),
158      B('fyi-tests', H(std_test_steps),
159        T(std_tests, ['--experimental', flakiness_server,
160                      '--coverage-bucket', CHROMIUM_COVERAGE_BUCKET])),
161      B('fyi-component-builder-tests-dbg',
162        H(compile_step, extra_gyp='component=shared_library'),
163        T(std_tests, ['--experimental', flakiness_server])),
164      B('gpu-builder-tests-dbg', H(compile_step), T(['gpu'])),
165      # Pass empty T([]) so that logcat monitor and device status check are run.
166      B('perf-bisect-builder-tests-dbg', H(['bisect_perf_regression']), T([])),
167      B('perf-tests-rel', H(std_test_steps),
168        T([], ['--install=ChromeShell'])),
169      B('webkit-latest-webkit-tests', H(std_test_steps),
170        T(['webkit_layout', 'webkit'], ['--auto-reconnect'])),
171      B('webkit-latest-contentshell', H(compile_step),
172        T(['webkit_layout'], ['--auto-reconnect'])),
173      B('builder-unit-tests', H(compile_step), T(['unit'])),
174      B('webrtc-chromium-builder',
175        H(std_build_steps,
176          extra_args=['--build-targets=android_builder_chromium_webrtc'])),
177      B('webrtc-native-builder',
178        H(std_build_steps,
179          extra_args=['--build-targets=android_builder_webrtc'],
180          extra_gyp='include_tests=1 enable_tracing=1')),
181      B('webrtc-chromium-tests', H(std_test_steps),
182        T(['webrtc_chromium'],
183          [flakiness_server, '--gtest-filter=WebRtc*'])),
184      B('webrtc-native-tests', H(std_test_steps),
185        T(['webrtc_native'], [flakiness_server])),
186
187      # Generic builder config (for substring match).
188      B('builder', H(std_build_steps)),
189  ]
190
191  bot_map = dict((config.bot_id, config) for config in bot_configs)
192
193  # These bots have identical configuration to ones defined earlier.
194  copy_map = [
195      ('lkgr-clobber', 'main-clobber'),
196      ('try-builder-dbg', 'main-builder-dbg'),
197      ('try-builder-rel', 'main-builder-rel'),
198      ('try-clang-builder', 'main-clang-builder'),
199      ('try-fyi-builder-dbg', 'fyi-builder-dbg'),
200      ('try-x86-builder-dbg', 'x86-builder-dbg'),
201      ('try-tests', 'main-tests'),
202      ('try-fyi-tests', 'fyi-tests'),
203      ('webkit-latest-tests', 'main-tests'),
204  ]
205  for to_id, from_id in copy_map:
206    assert to_id not in bot_map
207    # pylint: disable=W0212
208    bot_map[to_id] = copy.deepcopy(bot_map[from_id])._replace(bot_id=to_id)
209
210    # Trybots do not upload to flakiness dashboard. They should be otherwise
211    # identical in configuration to their trunk building counterparts.
212    test_obj = bot_map[to_id].test_obj
213    if to_id.startswith('try') and test_obj:
214      extra_args = test_obj.extra_args
215      if extra_args and flakiness_server in extra_args:
216        extra_args.remove(flakiness_server)
217  return bot_map
218
219
220# Return an object from the map, looking first for an exact id match.
221# If this fails, look for an id which is a substring of the specified id.
222# Choose the longest of all substring matches.
223# pylint: disable=W0622
224def GetBestMatch(id_map, id):
225  config = id_map.get(id)
226  if not config:
227    substring_matches = filter(lambda x: x in id, id_map.iterkeys())
228    if substring_matches:
229      max_id = max(substring_matches, key=len)
230      print 'Using config from id="%s" (substring match).' % max_id
231      config = id_map[max_id]
232  return config
233
234
235def GetRunBotOptParser():
236  parser = bb_utils.GetParser()
237  parser.add_option('--bot-id', help='Specify bot id directly.')
238  parser.add_option('--testing', action='store_true',
239                    help='For testing: print, but do not run commands')
240
241  return parser
242
243
244def GetBotConfig(options, bot_step_map):
245  bot_id = options.bot_id or options.factory_properties.get('android_bot_id')
246  if not bot_id:
247    print (sys.stderr,
248           'A bot id must be specified through option or factory_props.')
249    return
250
251  bot_config = GetBestMatch(bot_step_map, bot_id)
252  if not bot_config:
253    print 'Error: config for id="%s" cannot be inferred.' % bot_id
254  return bot_config
255
256
257def RunBotCommands(options, commands, env):
258  print 'Environment changes:'
259  print DictDiff(dict(os.environ), env)
260
261  for command in commands:
262    print bb_utils.CommandToString(command)
263    sys.stdout.flush()
264    if options.testing:
265      env['BUILDBOT_TESTING'] = '1'
266    return_code = subprocess.call(command, cwd=bb_utils.CHROME_SRC, env=env)
267    if return_code != 0:
268      return return_code
269
270
271def main(argv):
272  parser = GetRunBotOptParser()
273  options, args = parser.parse_args(argv[1:])
274  if args:
275    parser.error('Unused args: %s' % args)
276
277  bot_config = GetBotConfig(options, GetBotStepMap())
278  if not bot_config:
279    sys.exit(1)
280
281  print 'Using config:', bot_config
282
283  commands = GetCommands(options, bot_config)
284  for command in commands:
285    print 'Will run: ', bb_utils.CommandToString(command)
286  print
287
288  env = GetEnvironment(bot_config.host_obj, options.testing)
289  return RunBotCommands(options, commands, env)
290
291
292if __name__ == '__main__':
293  sys.exit(main(sys.argv))
294