blob: 273c112bd10f1f01cb223ae5e4dfb3354e660b64 [file] [log] [blame]
Brian Harring3fec5a82012-03-01 05:57:03 -08001#!/usr/bin/python
2
Mike Frysingerd6925b52012-07-16 16:11:00 -04003# Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
Brian Harring3fec5a82012-03-01 05:57:03 -08004# Use of this source code is governed by a BSD-style license that can be
5# found in the LICENSE file.
6
7"""Main builder code for Chromium OS.
8
9Used by Chromium OS buildbot configuration for all Chromium OS builds including
10full and pre-flight-queue builds.
11"""
12
13import distutils.version
Mike Frysinger6903c762012-12-04 01:57:16 -050014import errno
Brian Harring3fec5a82012-03-01 05:57:03 -080015import glob
Chris Sosa4f6ffaf2012-05-01 17:05:44 -070016import logging
Brian Harring3fec5a82012-03-01 05:57:03 -080017import optparse
18import os
19import pprint
20import sys
Ryan Cui54da0702012-04-19 18:38:08 -070021import time
David James3541a132013-03-18 13:21:58 -070022import traceback
Brian Harring3fec5a82012-03-01 05:57:03 -080023
24from chromite.buildbot import builderstage as bs
Brian Harring3fec5a82012-03-01 05:57:03 -080025from chromite.buildbot import cbuildbot_config
26from chromite.buildbot import cbuildbot_stages as stages
27from chromite.buildbot import cbuildbot_results as results_lib
Brian Harring3fec5a82012-03-01 05:57:03 -080028from chromite.buildbot import constants
Brian Harring3fec5a82012-03-01 05:57:03 -080029from chromite.buildbot import remote_try
30from chromite.buildbot import repository
31from chromite.buildbot import tee
Ryan Cui16d9e1f2012-05-11 10:50:18 -070032from chromite.buildbot import trybot_patch_pool
Brian Harring3fec5a82012-03-01 05:57:03 -080033
Brian Harringc92a7012012-02-29 10:11:34 -080034from chromite.lib import cgroups
Brian Harringa184efa2012-03-04 11:51:25 -080035from chromite.lib import cleanup
Brian Harringb6cf9142012-09-01 20:43:17 -070036from chromite.lib import commandline
Brian Harring1b8c4c82012-05-29 23:03:04 -070037from chromite.lib import cros_build_lib
David Jamesa0a664e2013-02-13 09:52:01 -080038from chromite.lib import gclient
Brian Harring511055e2012-10-10 02:58:59 -070039from chromite.lib import gerrit
David James97d95872012-11-16 15:09:56 -080040from chromite.lib import git
Brian Harringaf019fb2012-05-10 15:06:13 -070041from chromite.lib import osutils
Brian Harring511055e2012-10-10 02:58:59 -070042from chromite.lib import patch as cros_patch
David James6450a0a2012-12-04 07:59:53 -080043from chromite.lib import parallel
Brian Harring3fec5a82012-03-01 05:57:03 -080044from chromite.lib import sudo
45
Ryan Cuiadd49122012-03-21 22:19:58 -070046
Brian Harring3fec5a82012-03-01 05:57:03 -080047_DEFAULT_LOG_DIR = 'cbuildbot_logs'
48_BUILDBOT_LOG_FILE = 'cbuildbot.log'
49_DEFAULT_EXT_BUILDROOT = 'trybot'
50_DEFAULT_INT_BUILDROOT = 'trybot-internal'
Brian Harring3fec5a82012-03-01 05:57:03 -080051_DISTRIBUTED_TYPES = [constants.COMMIT_QUEUE_TYPE, constants.PFQ_TYPE,
52 constants.CANARY_TYPE, constants.CHROME_PFQ_TYPE,
53 constants.PALADIN_TYPE]
Brian Harring351ce442012-03-09 16:38:14 -080054_BUILDBOT_REQUIRED_BINARIES = ('pbzip2',)
Ryan Cui1c13a252012-10-16 15:00:16 -070055_API_VERSION_ATTR = 'api_version'
Brian Harring3fec5a82012-03-01 05:57:03 -080056
57
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070058def _PrintValidConfigs(display_all=False):
Brian Harring3fec5a82012-03-01 05:57:03 -080059 """Print a list of valid buildbot configs.
60
61 Arguments:
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070062 display_all: Print all configs. Otherwise, prints only configs with
63 trybot_list=True.
Brian Harring3fec5a82012-03-01 05:57:03 -080064 """
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070065 def _GetSortKey(config_name):
66 config_dict = cbuildbot_config.config[config_name]
67 return (not config_dict['trybot_list'], config_dict['description'],
68 config_name)
69
Brian Harring3fec5a82012-03-01 05:57:03 -080070 COLUMN_WIDTH = 45
71 print 'config'.ljust(COLUMN_WIDTH), 'description'
72 print '------'.ljust(COLUMN_WIDTH), '-----------'
73 config_names = cbuildbot_config.config.keys()
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070074 config_names.sort(key=_GetSortKey)
Brian Harring3fec5a82012-03-01 05:57:03 -080075 for name in config_names:
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070076 if display_all or cbuildbot_config.config[name]['trybot_list']:
77 desc = cbuildbot_config.config[name].get('description')
78 desc = desc if desc else ''
Brian Harring3fec5a82012-03-01 05:57:03 -080079 print name.ljust(COLUMN_WIDTH), desc
80
81
82def _GetConfig(config_name):
83 """Gets the configuration for the build"""
84 if not cbuildbot_config.config.has_key(config_name):
85 print 'Non-existent configuration %s specified.' % config_name
86 print 'Please specify one of:'
87 _PrintValidConfigs()
88 sys.exit(1)
89
90 result = cbuildbot_config.config[config_name]
91
92 return result
93
94
Ryan Cuie1e4e662012-05-21 16:39:46 -070095def AcquirePoolFromOptions(options):
Ryan Cui16d9e1f2012-05-11 10:50:18 -070096 """Generate patch objects from passed in options.
Brian Harring3fec5a82012-03-01 05:57:03 -080097
98 Args:
Ryan Cui16d9e1f2012-05-11 10:50:18 -070099 options: The options object generated by optparse.
Brian Harring3fec5a82012-03-01 05:57:03 -0800100
Ryan Cuif7f24692012-05-18 16:35:33 -0700101 Returns:
102 trybot_patch_pool.TrybotPatchPool object.
103
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700104 Raises:
Brian Harring511055e2012-10-10 02:58:59 -0700105 gerrit.GerritException, cros_patch.PatchException
Brian Harring3fec5a82012-03-01 05:57:03 -0800106 """
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700107 gerrit_patches = []
108 local_patches = []
109 remote_patches = []
Brian Harring3fec5a82012-03-01 05:57:03 -0800110
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700111 if options.gerrit_patches:
Brian Harring511055e2012-10-10 02:58:59 -0700112 gerrit_patches = gerrit.GetGerritPatchInfo(
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700113 options.gerrit_patches)
114 for patch in gerrit_patches:
115 if patch.IsAlreadyMerged():
Brian Harring1b8c4c82012-05-29 23:03:04 -0700116 cros_build_lib.Warning('Patch %s has already been merged.' % str(patch))
Brian Harring3fec5a82012-03-01 05:57:03 -0800117
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700118 if options.local_patches:
David James97d95872012-11-16 15:09:56 -0800119 manifest = git.ManifestCheckout.Cached(options.sourceroot)
Brian Harring609dc4e2012-05-07 02:17:44 -0700120 local_patches = cros_patch.PrepareLocalPatches(manifest,
121 options.local_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800122
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700123 if options.remote_patches:
124 remote_patches = cros_patch.PrepareRemotePatches(
125 options.remote_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800126
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700127 return trybot_patch_pool.TrybotPatchPool(gerrit_patches, local_patches,
128 remote_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800129
130
Brian Harring3fec5a82012-03-01 05:57:03 -0800131class Builder(object):
132 """Parent class for all builder types.
133
134 This class functions as a parent class for various build types. It's intended
135 use is builder_instance.Run().
136
137 Vars:
Mike Frysinger9b223362013-03-04 21:54:26 -0500138 build_config: The configuration dictionary from cbuildbot_config.
139 options: The options provided from optparse in main().
140 release_tag: The associated "chrome os version" of this build.
Brian Harring3fec5a82012-03-01 05:57:03 -0800141 """
142
Ryan Cuie1e4e662012-05-21 16:39:46 -0700143 def __init__(self, options, build_config):
Brian Harring3fec5a82012-03-01 05:57:03 -0800144 """Initializes instance variables. Must be called by all subclasses."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800145 self.build_config = build_config
146 self.options = options
147
148 # TODO, Remove here and in config after bug chromium-os:14649 is fixed.
149 if self.build_config['chromeos_official']:
150 os.environ['CHROMEOS_OFFICIAL'] = '1'
151
David James58e0c092012-03-04 20:31:12 -0800152 self.archive_stages = {}
Brian Harring3fec5a82012-03-01 05:57:03 -0800153 self.release_tag = None
Brian Harring76d1bf62012-06-01 13:52:48 -0700154 self.patch_pool = trybot_patch_pool.TrybotPatchPool()
Brian Harring3fec5a82012-03-01 05:57:03 -0800155
Ryan Cuie1e4e662012-05-21 16:39:46 -0700156 bs.BuilderStage.SetManifestBranch(self.options.branch)
Ryan Cuif7f24692012-05-18 16:35:33 -0700157
Brian Harring3fec5a82012-03-01 05:57:03 -0800158 def Initialize(self):
159 """Runs through the initialization steps of an actual build."""
Ryan Cuif7f24692012-05-18 16:35:33 -0700160 if self.options.resume:
161 results_lib.LoadCheckpoint(self.options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800162
Brian Harring3fec5a82012-03-01 05:57:03 -0800163 self._RunStage(stages.CleanUpStage)
164
165 def _GetStageInstance(self, stage, *args, **kwargs):
166 """Helper function to get an instance given the args.
167
David James944a48e2012-03-07 12:19:03 -0800168 Useful as almost all stages just take in options and build_config.
Brian Harring3fec5a82012-03-01 05:57:03 -0800169 """
David James944a48e2012-03-07 12:19:03 -0800170 config = kwargs.pop('config', self.build_config)
171 return stage(self.options, config, *args, **kwargs)
Brian Harring3fec5a82012-03-01 05:57:03 -0800172
173 def _SetReleaseTag(self):
174 """Sets the release tag from the manifest_manager.
175
176 Must be run after sync stage as syncing enables us to have a release tag.
177 """
178 # Extract version we have decided to build into self.release_tag.
179 manifest_manager = stages.ManifestVersionedSyncStage.manifest_manager
180 if manifest_manager:
181 self.release_tag = manifest_manager.current_version
182
183 def _RunStage(self, stage, *args, **kwargs):
184 """Wrapper to run a stage."""
185 stage_instance = self._GetStageInstance(stage, *args, **kwargs)
186 return stage_instance.Run()
187
188 def GetSyncInstance(self):
189 """Returns an instance of a SyncStage that should be run.
190
191 Subclasses must override this method.
192 """
193 raise NotImplementedError()
194
195 def RunStages(self):
196 """Subclasses must override this method. Runs the appropriate code."""
197 raise NotImplementedError()
198
Brian Harring3fec5a82012-03-01 05:57:03 -0800199 def _ShouldReExecuteInBuildRoot(self):
200 """Returns True if this build should be re-executed in the buildroot."""
201 abs_buildroot = os.path.abspath(self.options.buildroot)
202 return not os.path.abspath(__file__).startswith(abs_buildroot)
203
204 def _ReExecuteInBuildroot(self, sync_instance):
205 """Reexecutes self in buildroot and returns True if build succeeds.
206
207 This allows the buildbot code to test itself when changes are patched for
208 buildbot-related code. This is a no-op if the buildroot == buildroot
209 of the running chromite checkout.
210
211 Args:
212 sync_instance: Instance of the sync stage that was run to sync.
213
214 Returns:
215 True if the Build succeeded.
216 """
Brian Harring3fec5a82012-03-01 05:57:03 -0800217 if not self.options.resume:
Ryan Cuif7f24692012-05-18 16:35:33 -0700218 results_lib.WriteCheckpoint(self.options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800219
Ryan Cui1c13a252012-10-16 15:00:16 -0700220 args = stages.BootstrapStage.FilterArgsForTargetCbuildbot(
221 self.options.buildroot, constants.PATH_TO_CBUILDBOT, self.options)
Brian Harring37e559b2012-05-22 20:47:32 -0700222
David James2333c182013-02-13 16:16:15 -0800223 # Specify a buildroot explicitly (just in case, for local trybot).
Brian Harring3fec5a82012-03-01 05:57:03 -0800224 # Suppress any timeout options given from the commandline in the
225 # invoked cbuildbot; our timeout will enforce it instead.
Ryan Cui1c13a252012-10-16 15:00:16 -0700226 args += ['--resume', '--timeout', '0', '--notee', '--nocgroups',
227 '--buildroot', os.path.abspath(self.options.buildroot)]
Brian Harringae0a5322012-09-15 01:46:51 -0700228
Brian Harring3fec5a82012-03-01 05:57:03 -0800229 if stages.ManifestVersionedSyncStage.manifest_manager:
230 ver = stages.ManifestVersionedSyncStage.manifest_manager.current_version
Ryan Cui1c13a252012-10-16 15:00:16 -0700231 args += ['--version', ver]
Brian Harring3fec5a82012-03-01 05:57:03 -0800232
233 if isinstance(sync_instance, stages.CommitQueueSyncStage):
234 vp_file = sync_instance.SaveValidationPool()
Ryan Cui1c13a252012-10-16 15:00:16 -0700235 args += ['--validation_pool', vp_file]
Brian Harring3fec5a82012-03-01 05:57:03 -0800236
David Jamesac8c2a72013-02-13 18:44:33 -0800237 # Reset the cache dir so that the child will calculate it automatically.
238 if not self.options.cache_dir_specified:
239 commandline.BaseParser.ConfigureCacheDir(None)
240
Brian Harring3fec5a82012-03-01 05:57:03 -0800241 # Re-run the command in the buildroot.
242 # Finally, be generous and give the invoked cbuildbot 30s to shutdown
243 # when something occurs. It should exit quicker, but the sigterm may
244 # hit while the system is particularly busy.
Brian Harring1b8c4c82012-05-29 23:03:04 -0700245 return_obj = cros_build_lib.RunCommand(
Ryan Cui1c13a252012-10-16 15:00:16 -0700246 args, cwd=self.options.buildroot, error_code_ok=True, kill_timeout=30)
Brian Harring3fec5a82012-03-01 05:57:03 -0800247 return return_obj.returncode == 0
248
Ryan Cuif7f24692012-05-18 16:35:33 -0700249 def _InitializeTrybotPatchPool(self):
250 """Generate patch pool from patches specified on the command line.
251
252 Do this only if we need to patch changes later on.
253 """
254 changes_stage = stages.PatchChangesStage.StageNamePrefix()
255 check_func = results_lib.Results.PreviouslyCompletedRecord
256 if not check_func(changes_stage) or self.options.bootstrap:
Ryan Cuie1e4e662012-05-21 16:39:46 -0700257 self.patch_pool = AcquirePoolFromOptions(self.options)
Ryan Cuif7f24692012-05-18 16:35:33 -0700258
259 def _GetBootstrapStage(self):
260 """Constructs and returns the BootStrapStage object.
261
262 We return None when there are no chromite patches to test, and
263 --test-bootstrap wasn't passed in.
264 """
265 stage = None
266 chromite_pool = self.patch_pool.Filter(project=constants.CHROMITE_PROJECT)
Ryan Cui5616a512012-08-17 13:39:36 -0700267 manifest_pool = self.patch_pool.FilterManifest()
David James97d95872012-11-16 15:09:56 -0800268 chromite_branch = git.GetChromiteTrackingBranch()
Ryan Cui5616a512012-08-17 13:39:36 -0700269 if (chromite_pool or manifest_pool or self.options.test_bootstrap
Ryan Cuie1e4e662012-05-21 16:39:46 -0700270 or chromite_branch != self.options.branch):
Ryan Cuif7f24692012-05-18 16:35:33 -0700271 stage = stages.BootstrapStage(self.options, self.build_config,
Ryan Cui5616a512012-08-17 13:39:36 -0700272 chromite_pool, manifest_pool)
Ryan Cuif7f24692012-05-18 16:35:33 -0700273 return stage
274
Brian Harring3fec5a82012-03-01 05:57:03 -0800275 def Run(self):
Ryan Cuif7f24692012-05-18 16:35:33 -0700276 """Main runner for this builder class. Runs build and prints summary.
277
278 Returns:
279 Whether the build succeeded.
280 """
281 self._InitializeTrybotPatchPool()
282
283 if self.options.bootstrap:
284 bootstrap_stage = self._GetBootstrapStage()
285 if bootstrap_stage:
286 # BootstrapStage blocks on re-execution of cbuildbot.
287 bootstrap_stage.Run()
288 return bootstrap_stage.returncode == 0
289
Brian Harring3fec5a82012-03-01 05:57:03 -0800290 print_report = True
David James3d4d3502012-04-09 15:12:06 -0700291 exception_thrown = False
Brian Harring3fec5a82012-03-01 05:57:03 -0800292 success = True
293 try:
294 self.Initialize()
295 sync_instance = self.GetSyncInstance()
296 sync_instance.Run()
297 self._SetReleaseTag()
298
Ryan Cui967f7cc2012-08-17 13:01:12 -0700299 # Filter out patches to manifest, since PatchChangesStage can't handle
300 # them. Manifest patches are patched in the BootstrapStage.
301 non_manifest_patches = self.patch_pool.FilterManifest(negate=True)
302 if non_manifest_patches:
303 self._RunStage(stages.PatchChangesStage, non_manifest_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800304
305 if self._ShouldReExecuteInBuildRoot():
306 print_report = False
307 success = self._ReExecuteInBuildroot(sync_instance)
308 else:
309 self.RunStages()
David James3541a132013-03-18 13:21:58 -0700310 except Exception as ex:
311 # If the build is marked as successful, but threw exceptions, that's a
312 # problem.
David James7fbf2d42012-07-14 18:23:49 -0700313 exception_thrown = True
David James3541a132013-03-18 13:21:58 -0700314 if results_lib.Results.BuildSucceededSoFar():
315 traceback.print_exc(file=sys.stdout)
David James7fbf2d42012-07-14 18:23:49 -0700316 raise
David James3541a132013-03-18 13:21:58 -0700317 if not (print_report and isinstance(ex, results_lib.StepFailure)):
318 raise
Brian Harring3fec5a82012-03-01 05:57:03 -0800319 finally:
320 if print_report:
Ryan Cuif7f24692012-05-18 16:35:33 -0700321 results_lib.WriteCheckpoint(self.options.buildroot)
Mike Frysinger9b223362013-03-04 21:54:26 -0500322 self._RunStage(stages.ReportStage, self.archive_stages,
323 self.release_tag)
Brian Harring3fec5a82012-03-01 05:57:03 -0800324 success = results_lib.Results.BuildSucceededSoFar()
David James3d4d3502012-04-09 15:12:06 -0700325 if exception_thrown and success:
326 success = False
David Jamesbb20ac82012-07-18 10:59:16 -0700327 cros_build_lib.PrintBuildbotStepWarnings()
328 print """\
David James3d4d3502012-04-09 15:12:06 -0700329Exception thrown, but all stages marked successful. This is an internal error,
330because the stage that threw the exception should be marked as failing."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800331
332 return success
333
334
335class SimpleBuilder(Builder):
336 """Builder that performs basic vetting operations."""
337
338 def GetSyncInstance(self):
339 """Sync to lkgm or TOT as necessary.
340
341 Returns: the instance of the sync stage that was run.
342 """
Chris Sosa52a81b62012-11-14 06:12:54 -0800343 if self.build_config['use_lkgm']:
Brian Harring3fec5a82012-03-01 05:57:03 -0800344 sync_stage = self._GetStageInstance(stages.LKGMSyncStage)
Chris Sosa52a81b62012-11-14 06:12:54 -0800345 elif self.build_config['use_chrome_lkgm']:
346 sync_stage = self._GetStageInstance(stages.ChromeLKGMSyncStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800347 else:
348 sync_stage = self._GetStageInstance(stages.SyncStage)
349
350 return sync_stage
351
David James4f2d8302013-03-19 06:35:58 -0700352 @staticmethod
353 def _RunParallelStages(stage_objs):
354 """Run the specified stages in parallel."""
355 steps = [stage.Run for stage in stage_objs]
356 try:
357 parallel.RunParallelSteps(steps)
358 except BaseException as ex:
359 # If a stage threw an exception, it might not have correctly reported
360 # results (e.g. because it was killed before it could report the
361 # results.) In this case, attribute the exception to any stages that
362 # didn't report back correctly (if any).
363 for stage in stage_objs:
364 if not results_lib.Results.StageHasResults(stage.name):
365 results_lib.Results.Record(stage.name, ex, str(ex))
366 raise
367
David James565bc9a2013-04-08 14:54:45 -0700368 def _RunBackgroundStagesForBoard(self, board, compilecheck):
David James58e0c092012-03-04 20:31:12 -0800369 """Run background board-specific stages for the specified board."""
David James58e0c092012-03-04 20:31:12 -0800370 archive_stage = self.archive_stages[board]
David James944a48e2012-03-07 12:19:03 -0800371 configs = self.build_config['board_specific_configs']
372 config = configs.get(board, self.build_config)
David James565bc9a2013-04-08 14:54:45 -0700373 if compilecheck:
374 self._RunStage(stages.BuildPackagesStage, board, archive_stage,
375 config=config)
376 self._RunStage(stages.UnitTestStage, board, config=config)
377 return
David James944a48e2012-03-07 12:19:03 -0800378 stage_list = [[stages.VMTestStage, board, archive_stage],
Mike Frysinger5e20ec42012-09-28 23:39:56 -0400379 [stages.SignerTestStage, board, archive_stage],
David James944a48e2012-03-07 12:19:03 -0800380 [stages.UnitTestStage, board],
Chris Sosa6ed77e52012-10-22 12:57:31 -0700381 [stages.UploadPrebuiltsStage, board, archive_stage],
382 [stages.DevInstallerPrebuiltsStage, board, archive_stage]]
Brian Harring3fec5a82012-03-01 05:57:03 -0800383
David James58e0c092012-03-04 20:31:12 -0800384 # We can not run hw tests without archiving the payloads.
385 if self.options.archive:
Chris Sosaba250522013-03-27 18:57:34 -0700386 for suite_config in config['hw_tests']:
387 if suite_config.async:
388 stage_list.append([stages.ASyncHWTestStage, board, archive_stage,
389 suite_config])
390 elif suite_config.suite == constants.HWTEST_AU_SUITE:
391 stage_list.append([stages.AUTestStage, board, archive_stage,
392 suite_config])
Chris Sosa077df812013-01-25 17:05:28 -0800393 else:
Chris Sosaba250522013-03-27 18:57:34 -0700394 stage_list.append([stages.HWTestStage, board, archive_stage,
395 suite_config])
Chris Sosa817b1f92012-07-19 15:00:23 -0700396
David James4f2d8302013-03-19 06:35:58 -0700397 stage_objs = [self._GetStageInstance(*x, config=config) for x in stage_list]
398 self._RunParallelStages(stage_objs + [archive_stage])
Brian Harring3fec5a82012-03-01 05:57:03 -0800399
400 def RunStages(self):
401 """Runs through build process."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800402 # TODO(sosa): Split these out into classes.
Brian Harring3fec5a82012-03-01 05:57:03 -0800403 if self.build_config['build_type'] == constants.CHROOT_BUILDER_TYPE:
Mike Frysingerfddaeb52012-11-20 11:17:31 -0500404 self._RunStage(stages.UprevStage, boards=[], enter_chroot=False)
David James59a0a2b2013-03-22 14:04:44 -0700405 self._RunStage(stages.InitSDKStage)
406 self._RunStage(stages.SetupBoardStage, [constants.CHROOT_BUILDER_BOARD])
David Jamesa0a664e2013-02-13 09:52:01 -0800407 self._RunStage(stages.SyncChromeStage)
David James9e27e662013-02-14 13:42:43 -0800408 self._RunStage(stages.PatchChromeStage)
Zdenek Behan62a57792012-08-31 15:09:08 +0200409 self._RunStage(stages.SDKPackageStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800410 self._RunStage(stages.SDKTestStage)
411 self._RunStage(stages.UploadPrebuiltsStage,
Chris Sosa6a5dceb2012-05-14 13:48:56 -0700412 constants.CHROOT_BUILDER_BOARD, None)
Brian Harring3fec5a82012-03-01 05:57:03 -0800413 elif self.build_config['build_type'] == constants.REFRESH_PACKAGES_TYPE:
David James59a0a2b2013-03-22 14:04:44 -0700414 self._RunStage(stages.InitSDKStage)
415 self._RunStage(stages.SetupBoardStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800416 self._RunStage(stages.RefreshPackageStatusStage)
417 else:
David James59a0a2b2013-03-22 14:04:44 -0700418 self._RunStage(stages.InitSDKStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800419 self._RunStage(stages.UprevStage)
David James59a0a2b2013-03-22 14:04:44 -0700420 self._RunStage(stages.SetupBoardStage)
David Jamesa0a664e2013-02-13 09:52:01 -0800421 self._RunStage(stages.SyncChromeStage)
David James9e27e662013-02-14 13:42:43 -0800422 self._RunStage(stages.PatchChromeStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800423
David James944a48e2012-03-07 12:19:03 -0800424 configs = self.build_config['board_specific_configs']
David James58e0c092012-03-04 20:31:12 -0800425 for board in self.build_config['boards']:
David James944a48e2012-03-07 12:19:03 -0800426 config = configs.get(board, self.build_config)
427 archive_stage = self._GetStageInstance(stages.ArchiveStage, board,
David James280447f2013-03-12 13:59:43 -0700428 self.release_tag, config=config)
David James58e0c092012-03-04 20:31:12 -0800429 self.archive_stages[board] = archive_stage
430
David James944a48e2012-03-07 12:19:03 -0800431 # Set up a process pool to run test/archive stages in the background.
432 # This process runs task(board) for each board added to the queue.
David James565bc9a2013-04-08 14:54:45 -0700433 compilecheck = (self.build_config['compilecheck'] or
434 self.options.compilecheck)
David James58e0c092012-03-04 20:31:12 -0800435 task = self._RunBackgroundStagesForBoard
Brian Harring9fdd23d2012-12-07 12:09:08 -0800436 with parallel.BackgroundTaskRunner(task) as queue:
David James944a48e2012-03-07 12:19:03 -0800437 for board in self.build_config['boards']:
David James565bc9a2013-04-08 14:54:45 -0700438 if not compilecheck:
439 archive_stage = self.archive_stages[board]
440 config = configs.get(board, self.build_config)
David James138b0af2013-03-19 14:38:57 -0700441
David James565bc9a2013-04-08 14:54:45 -0700442 # Run BuildPackages and BuildImage in the foreground, generating and
443 # using PGO data if requested.
444 built = False
445 for step in ('pgo_generate', 'pgo_use', None):
446 if config.get(step) or not step and not built:
447 kwargs = {step: True} if step else {}
448 self._RunStage(stages.BuildPackagesStage, board, archive_stage,
449 config=config, **kwargs)
450 self._RunStage(stages.BuildImageStage, board, archive_stage,
451 config=config, **kwargs)
452 if step == 'pgo_generate':
453 suite = cbuildbot_config.PGORecordTest()
454 self._RunStage(stages.HWTestStage, board, archive_stage,
455 suite, config=config)
456 built = True
David James58e0c092012-03-04 20:31:12 -0800457
David James944a48e2012-03-07 12:19:03 -0800458 # Kick off task(board) in the background.
David James565bc9a2013-04-08 14:54:45 -0700459 queue.put([board, compilecheck])
David James58e0c092012-03-04 20:31:12 -0800460
Brian Harring3fec5a82012-03-01 05:57:03 -0800461
462class DistributedBuilder(SimpleBuilder):
463 """Build class that has special logic to handle distributed builds.
464
465 These builds sync using git/manifest logic in manifest_versions. In general
466 they use a non-distributed builder code for the bulk of the work.
467 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700468 def __init__(self, *args, **kwargs):
Brian Harring3fec5a82012-03-01 05:57:03 -0800469 """Initializes a buildbot builder.
470
471 Extra variables:
472 completion_stage_class: Stage used to complete a build. Set in the Sync
473 stage.
474 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700475 super(DistributedBuilder, self).__init__(*args, **kwargs)
Brian Harring3fec5a82012-03-01 05:57:03 -0800476 self.completion_stage_class = None
477
478 def GetSyncInstance(self):
479 """Syncs the tree using one of the distributed sync logic paths.
480
481 Returns: the instance of the sync stage that was run.
482 """
483 # Determine sync class to use. CQ overrides PFQ bits so should check it
484 # first.
485 if cbuildbot_config.IsCQType(self.build_config['build_type']):
486 sync_stage = self._GetStageInstance(stages.CommitQueueSyncStage)
487 self.completion_stage_class = stages.CommitQueueCompletionStage
488 elif cbuildbot_config.IsPFQType(self.build_config['build_type']):
489 sync_stage = self._GetStageInstance(stages.LKGMCandidateSyncStage)
490 self.completion_stage_class = stages.LKGMCandidateSyncCompletionStage
491 else:
492 sync_stage = self._GetStageInstance(stages.ManifestVersionedSyncStage)
493 self.completion_stage_class = stages.ManifestVersionedSyncCompletionStage
494
495 return sync_stage
496
497 def Publish(self, was_build_successful):
498 """Completes build by publishing any required information."""
499 completion_stage = self._GetStageInstance(self.completion_stage_class,
500 was_build_successful)
501 completion_stage.Run()
502 name = completion_stage.name
503 if not results_lib.Results.WasStageSuccessful(name):
504 should_publish_changes = False
505 else:
506 should_publish_changes = (self.build_config['master'] and
507 was_build_successful)
508
509 if should_publish_changes:
510 self._RunStage(stages.PublishUprevChangesStage)
511
512 def RunStages(self):
513 """Runs simple builder logic and publishes information to overlays."""
514 was_build_successful = False
515 try:
David Jamesf55709e2012-03-13 09:10:15 -0700516 super(DistributedBuilder, self).RunStages()
517 was_build_successful = results_lib.Results.BuildSucceededSoFar()
Brian Harring3fec5a82012-03-01 05:57:03 -0800518 except SystemExit as ex:
519 # If a stage calls sys.exit(0), it's exiting with success, so that means
520 # we should mark ourselves as successful.
521 if ex.code == 0:
522 was_build_successful = True
523 raise
524 finally:
525 self.Publish(was_build_successful)
526
Brian Harring3fec5a82012-03-01 05:57:03 -0800527
528def _ConfirmBuildRoot(buildroot):
529 """Confirm with user the inferred buildroot, and mark it as confirmed."""
Brian Harring521e7242012-11-01 16:57:42 -0700530 cros_build_lib.Warning('Using default directory %s as buildroot', buildroot)
531 if not cros_build_lib.BooleanPrompt(default=False):
532 print('Please specify a different buildroot via the --buildroot option.')
Brian Harring3fec5a82012-03-01 05:57:03 -0800533 sys.exit(0)
534
535 if not os.path.exists(buildroot):
536 os.mkdir(buildroot)
537
538 repository.CreateTrybotMarker(buildroot)
539
540
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700541def _ConfirmRemoteBuildbotRun():
542 """Confirm user wants to run with --buildbot --remote."""
Brian Harring521e7242012-11-01 16:57:42 -0700543 cros_build_lib.Warning(
544 'You are about to launch a PRODUCTION job! This is *NOT* a '
545 'trybot run! Are you sure?')
546 if not cros_build_lib.BooleanPrompt(default=False):
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700547 print('Please specify --pass-through="--debug".')
548 sys.exit(0)
549
550
Ryan Cui5ba7e152012-05-10 14:36:52 -0700551def _DetermineDefaultBuildRoot(sourceroot, internal_build):
Brian Harring3fec5a82012-03-01 05:57:03 -0800552 """Default buildroot to be under the directory that contains current checkout.
553
554 Arguments:
555 internal_build: Whether the build is an internal build
Ryan Cui5ba7e152012-05-10 14:36:52 -0700556 sourceroot: Use specified sourceroot.
Brian Harring3fec5a82012-03-01 05:57:03 -0800557 """
Ryan Cui5ba7e152012-05-10 14:36:52 -0700558 if not repository.IsARepoRoot(sourceroot):
Brian Harring1b8c4c82012-05-29 23:03:04 -0700559 cros_build_lib.Die(
560 'Could not find root of local checkout at %s. Please specify '
561 'using the --sourceroot option.' % sourceroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800562
563 # Place trybot buildroot under the directory containing current checkout.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700564 top_level = os.path.dirname(os.path.realpath(sourceroot))
Brian Harring3fec5a82012-03-01 05:57:03 -0800565 if internal_build:
566 buildroot = os.path.join(top_level, _DEFAULT_INT_BUILDROOT)
567 else:
568 buildroot = os.path.join(top_level, _DEFAULT_EXT_BUILDROOT)
569
570 return buildroot
571
572
Mike Frysinger6903c762012-12-04 01:57:16 -0500573def _DisableYamaHardLinkChecks():
574 """Disable Yama kernel hardlink security checks.
575
576 The security module disables hardlinking to files you do not have
577 write access to which causes some of our build scripts problems.
578 Disable it so we don't have to worry about it.
579 """
580 PROC_PATH = '/proc/sys/kernel/yama/protected_nonaccess_hardlinks'
581 SYSCTL_PATH = PROC_PATH[len('/proc/sys/'):].replace('/', '.')
582
583 # Yama not available in this system -- nothing to do.
584 if not os.path.exists(PROC_PATH):
585 return
586
587 # Already disabled -- nothing to do.
588 if osutils.ReadFile(PROC_PATH).strip() == '0':
589 return
590
591 # Create a hardlink in a tempdir and see if we get back EPERM.
David James4bc13702013-03-26 08:08:04 -0700592 with osutils.TempDir() as tempdir:
Mike Frysinger6903c762012-12-04 01:57:16 -0500593 try:
594 os.link('/bin/sh', os.path.join(tempdir, 'sh'))
595 except OSError as e:
596 if e.errno == errno.EPERM:
597 cros_build_lib.Warning('Disabling Yama hardlink security')
598 cros_build_lib.SudoRunCommand(['sysctl', '%s=0' % SYSCTL_PATH])
599
600
Brian Harring3fec5a82012-03-01 05:57:03 -0800601def _BackupPreviousLog(log_file, backup_limit=25):
602 """Rename previous log.
603
604 Args:
605 log_file: The absolute path to the previous log.
606 """
607 if os.path.exists(log_file):
608 old_logs = sorted(glob.glob(log_file + '.*'),
609 key=distutils.version.LooseVersion)
610
611 if len(old_logs) >= backup_limit:
612 os.remove(old_logs[0])
613
614 last = 0
615 if old_logs:
616 last = int(old_logs.pop().rpartition('.')[2])
617
618 os.rename(log_file, log_file + '.' + str(last + 1))
619
Ryan Cui5616a512012-08-17 13:39:36 -0700620
David James944a48e2012-03-07 12:19:03 -0800621def _RunBuildStagesWrapper(options, build_config):
Brian Harring3fec5a82012-03-01 05:57:03 -0800622 """Helper function that wraps RunBuildStages()."""
623 def IsDistributedBuilder():
624 """Determines whether the build_config should be a DistributedBuilder."""
625 if not options.buildbot:
626 return False
627 elif build_config['build_type'] in _DISTRIBUTED_TYPES:
Brian Harring3fec5a82012-03-01 05:57:03 -0800628 # We don't do distributed logic to TOT Chrome PFQ's, nor local
629 # chrome roots (e.g. chrome try bots)
630 if chrome_rev not in [constants.CHROME_REV_TOT,
631 constants.CHROME_REV_LOCAL,
632 constants.CHROME_REV_SPEC]:
633 return True
634
635 return False
636
Brian Harring1b8c4c82012-05-29 23:03:04 -0700637 cros_build_lib.Info("cbuildbot executed with args %s"
638 % ' '.join(map(repr, sys.argv)))
Brian Harring3fec5a82012-03-01 05:57:03 -0800639
David Jamesa0a664e2013-02-13 09:52:01 -0800640 chrome_rev = build_config['chrome_rev']
641 if options.chrome_rev:
642 chrome_rev = options.chrome_rev
643 if chrome_rev == constants.CHROME_REV_TOT:
644 # Build the TOT Chrome revision.
645 svn_url = gclient.GetBaseURLs()[0]
646 options.chrome_version = gclient.GetTipOfTrunkSvnRevision(svn_url)
647 options.chrome_rev = constants.CHROME_REV_SPEC
648
David James4a404a52013-02-19 13:07:59 -0800649 # If it's likely we'll need to build Chrome, fetch the source.
Mike Frysingerf4d9ab82013-03-05 19:38:05 -0500650 if build_config['sync_chrome'] is None:
651 options.managed_chrome = (chrome_rev != constants.CHROME_REV_LOCAL and
652 (not build_config['usepkg_build_packages'] or chrome_rev or
653 build_config['useflags'] or build_config['profile'] or
654 options.rietveld_patches))
655 else:
656 options.managed_chrome = build_config['sync_chrome']
David James2333c182013-02-13 16:16:15 -0800657
658 if options.managed_chrome:
659 # Tell Chrome to fetch the source locally.
660 internal = constants.USE_CHROME_INTERNAL in (build_config['useflags'] or [])
661 chrome_src = 'chrome-src-internal' if internal else 'chrome-src'
662 options.chrome_root = os.path.join(options.cache_dir, 'distfiles', 'target',
663 chrome_src)
David James9e27e662013-02-14 13:42:43 -0800664 elif options.rietveld_patches:
David James4a404a52013-02-19 13:07:59 -0800665 cros_build_lib.Die('This builder does not support Rietveld patches.')
David James2333c182013-02-13 16:16:15 -0800666
Ryan Cuif7f24692012-05-18 16:35:33 -0700667 target = DistributedBuilder if IsDistributedBuilder() else SimpleBuilder
Ryan Cuie1e4e662012-05-21 16:39:46 -0700668 buildbot = target(options, build_config)
Brian Harringd166aaf2012-05-14 18:31:53 -0700669 if not buildbot.Run():
670 sys.exit(1)
Brian Harring3fec5a82012-03-01 05:57:03 -0800671
672
673# Parser related functions
Ryan Cui5ba7e152012-05-10 14:36:52 -0700674def _CheckLocalPatches(sourceroot, local_patches):
Brian Harring3fec5a82012-03-01 05:57:03 -0800675 """Do an early quick check of the passed-in patches.
676
677 If the branch of a project is not specified we append the current branch the
678 project is on.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700679
680 Args:
681 sourceroot: The checkout where patches are coming from.
Brian Harring3fec5a82012-03-01 05:57:03 -0800682 """
Ryan Cuicedd8a52012-03-22 02:28:35 -0700683 verified_patches = []
David James97d95872012-11-16 15:09:56 -0800684 manifest = git.ManifestCheckout.Cached(sourceroot)
Ryan Cuicedd8a52012-03-22 02:28:35 -0700685 for patch in local_patches:
Brian Harring3fec5a82012-03-01 05:57:03 -0800686 components = patch.split(':')
687 if len(components) > 2:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700688 cros_build_lib.Die(
689 'Specify local patches in project[:branch] format. Got %s' % patch)
Brian Harring3fec5a82012-03-01 05:57:03 -0800690
691 # validate project
692 project = components[0]
Brian Harring3fec5a82012-03-01 05:57:03 -0800693
Brian Harring609dc4e2012-05-07 02:17:44 -0700694 try:
695 project_dir = manifest.GetProjectPath(project, True)
696 except KeyError:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700697 cros_build_lib.Die('Project %s does not exist.' % project)
Brian Harring3fec5a82012-03-01 05:57:03 -0800698
699 # If no branch was specified, we use the project's current branch.
700 if len(components) == 1:
David James97d95872012-11-16 15:09:56 -0800701 branch = git.GetCurrentBranch(project_dir)
Brian Harring3fec5a82012-03-01 05:57:03 -0800702 if not branch:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700703 cros_build_lib.Die('Project %s is not on a branch!' % project)
Brian Harring3fec5a82012-03-01 05:57:03 -0800704 else:
705 branch = components[1]
David James97d95872012-11-16 15:09:56 -0800706 if not git.DoesLocalBranchExist(project_dir, branch):
Brian Harring1b8c4c82012-05-29 23:03:04 -0700707 cros_build_lib.Die('Project %s does not have branch %s'
708 % (project, branch))
Brian Harring3fec5a82012-03-01 05:57:03 -0800709
Brian Harring609dc4e2012-05-07 02:17:44 -0700710 verified_patches.append('%s:%s' % (project, branch))
Brian Harring3fec5a82012-03-01 05:57:03 -0800711
Ryan Cuicedd8a52012-03-22 02:28:35 -0700712 return verified_patches
Brian Harring3fec5a82012-03-01 05:57:03 -0800713
714
Brian Harring3fec5a82012-03-01 05:57:03 -0800715def _CheckChromeVersionOption(_option, _opt_str, value, parser):
716 """Upgrade other options based on chrome_version being passed."""
717 value = value.strip()
718
719 if parser.values.chrome_rev is None and value:
720 parser.values.chrome_rev = constants.CHROME_REV_SPEC
721
722 parser.values.chrome_version = value
723
724
725def _CheckChromeRootOption(_option, _opt_str, value, parser):
726 """Validate and convert chrome_root to full-path form."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800727 if parser.values.chrome_rev is None:
728 parser.values.chrome_rev = constants.CHROME_REV_LOCAL
729
Ryan Cui5ba7e152012-05-10 14:36:52 -0700730 parser.values.chrome_root = value
Brian Harring3fec5a82012-03-01 05:57:03 -0800731
732
733def _CheckChromeRevOption(_option, _opt_str, value, parser):
734 """Validate the chrome_rev option."""
735 value = value.strip()
736 if value not in constants.VALID_CHROME_REVISIONS:
737 raise optparse.OptionValueError('Invalid chrome rev specified')
738
739 parser.values.chrome_rev = value
740
741
David Jamesac8c2a72013-02-13 18:44:33 -0800742def FindCacheDir(_parser, _options):
Brian Harringae0a5322012-09-15 01:46:51 -0700743 return None
744
745
Ryan Cui5ba7e152012-05-10 14:36:52 -0700746class CustomGroup(optparse.OptionGroup):
747 def add_remote_option(self, *args, **kwargs):
748 """For arguments that are passed-through to remote trybot."""
749 return optparse.OptionGroup.add_option(self, *args,
750 remote_pass_through=True,
751 **kwargs)
752
753
Ryan Cui1c13a252012-10-16 15:00:16 -0700754class CustomOption(commandline.FilteringOption):
755 """Subclass FilteringOption class to implement pass-through and api."""
Ryan Cui5ba7e152012-05-10 14:36:52 -0700756
Ryan Cui1c13a252012-10-16 15:00:16 -0700757 ACTIONS = commandline.FilteringOption.ACTIONS + ('extend',)
758 STORE_ACTIONS = commandline.FilteringOption.STORE_ACTIONS + ('extend',)
759 TYPED_ACTIONS = commandline.FilteringOption.TYPED_ACTIONS + ('extend',)
760 ALWAYS_TYPED_ACTIONS = (commandline.FilteringOption.ALWAYS_TYPED_ACTIONS +
761 ('extend',))
Ryan Cui79319ab2012-05-21 12:59:18 -0700762
Ryan Cui5ba7e152012-05-10 14:36:52 -0700763 def __init__(self, *args, **kwargs):
764 # The remote_pass_through argument specifies whether we should directly
765 # pass the argument (with its value) onto the remote trybot.
766 self.pass_through = kwargs.pop('remote_pass_through', False)
Ryan Cui1c13a252012-10-16 15:00:16 -0700767 self.api_version = int(kwargs.pop('api', '0'))
768 commandline.FilteringOption.__init__(self, *args, **kwargs)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700769
770 def take_action(self, action, dest, opt, value, values, parser):
Ryan Cui79319ab2012-05-21 12:59:18 -0700771 if action == 'extend':
Mike Frysingerd6925b52012-07-16 16:11:00 -0400772 # If there is extra spaces between each argument, we get '' which later
773 # code barfs on, so skip those. e.g. We see this with the forms:
774 # cbuildbot -p 'proj:branch ' ...
775 # cbuildbot -p ' proj:branch' ...
776 # cbuildbot -p 'proj:branch proj2:branch' ...
777 lvalue = value.split()
Ryan Cui79319ab2012-05-21 12:59:18 -0700778 values.ensure_value(dest, []).extend(lvalue)
Ryan Cui79319ab2012-05-21 12:59:18 -0700779
Ryan Cui1c13a252012-10-16 15:00:16 -0700780 commandline.FilteringOption.take_action(
781 self, action, dest, opt, value, values, parser)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700782
783
Ryan Cui1c13a252012-10-16 15:00:16 -0700784class CustomParser(commandline.FilteringParser):
Brian Harringb6cf9142012-09-01 20:43:17 -0700785
786 DEFAULT_OPTION_CLASS = CustomOption
787
788 def add_remote_option(self, *args, **kwargs):
789 """For arguments that are passed-through to remote trybot."""
Ryan Cui1c13a252012-10-16 15:00:16 -0700790 return self.add_option(*args, remote_pass_through=True, **kwargs)
Brian Harringb6cf9142012-09-01 20:43:17 -0700791
792
Brian Harring3fec5a82012-03-01 05:57:03 -0800793def _CreateParser():
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700794 """Generate and return the parser with all the options."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800795 # Parse options
796 usage = "usage: %prog [options] buildbot_config"
Brian Harringae0a5322012-09-15 01:46:51 -0700797 parser = CustomParser(usage=usage, caching=FindCacheDir)
Brian Harring3fec5a82012-03-01 05:57:03 -0800798
799 # Main options
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400800 parser.add_option('-l', '--list', action='store_true', dest='list',
801 default=False,
802 help='List the suggested trybot configs to use (see --all)')
Brian Harring3fec5a82012-03-01 05:57:03 -0800803 parser.add_option('-a', '--all', action='store_true', dest='print_all',
804 default=False,
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400805 help='List all of the buildbot configs available w/--list')
806
807 parser.add_option('--local', default=False, action='store_true',
808 help='Specifies that this tryjob should be run locally')
809 parser.add_option('--remote', default=False, action='store_true',
810 help='Specifies that this tryjob should be run remotely')
811
Ryan Cuie1e4e662012-05-21 16:39:46 -0700812 parser.add_remote_option('-b', '--branch',
813 help='The manifest branch to test. The branch to '
814 'check the buildroot out to.')
Ryan Cui5ba7e152012-05-10 14:36:52 -0700815 parser.add_option('-r', '--buildroot', dest='buildroot', type='path',
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700816 help='Root directory where source is checked out to, and '
817 'where the build occurs. For external build configs, '
818 "defaults to 'trybot' directory at top level of your "
819 'repo-managed checkout.')
820 parser.add_remote_option('--chrome_rev', default=None, type='string',
821 action='callback', dest='chrome_rev',
822 callback=_CheckChromeRevOption,
823 help=('Revision of Chrome to use, of type [%s]'
824 % '|'.join(constants.VALID_CHROME_REVISIONS)))
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700825 parser.add_remote_option('--profile', default=None, type='string',
826 action='store', dest='profile',
827 help='Name of profile to sub-specify board variant.')
Brian Harring3fec5a82012-03-01 05:57:03 -0800828
Ryan Cuif4f84be2012-07-09 18:50:41 -0700829 #
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400830 # Patch selection options.
831 #
832
833 group = CustomGroup(
834 parser,
835 'Patch Options')
836
837 group.add_remote_option('-g', '--gerrit-patches', action='extend',
838 default=[], type='string',
839 metavar="'Id1 *int_Id2...IdN'",
840 help="Space-separated list of short-form Gerrit "
841 "Change-Id's or change numbers to patch. "
842 "Please prepend '*' to internal Change-Id's")
843 group.add_remote_option('-G', '--rietveld-patches', action='extend',
844 default=[], type='string',
845 metavar="'id1[:subdir1]...idN[:subdirN]'",
846 help='Space-separated list of short-form Rietveld '
847 'issue numbers to patch. If no subdir is '
848 'specified, the src directory is used.')
849 group.add_option('-p', '--local-patches', action='extend', default=[],
850 metavar="'<project1>[:<branch1>]...<projectN>[:<branchN>]'",
851 help='Space-separated list of project branches with '
852 'patches to apply. Projects are specified by name. '
853 'If no branch is specified the current branch of the '
854 'project will be used.')
855
856 parser.add_option_group(group)
857
858 #
859 # Remote trybot options.
860 #
861
862 group = CustomGroup(
863 parser,
864 'Remote Trybot Options (--remote)')
865
866 group.add_remote_option('--hwtest', dest='hwtest', action='store_true',
867 default=False,
868 help='Run the HWTest stage (tests on real hardware)')
869 group.add_option('--remote-description', default=None,
870 help='Attach an optional description to a --remote run '
871 'to make it easier to identify the results when it '
872 'finishes')
873 group.add_option('--slaves', action='extend', default=[],
874 help='Specify specific remote tryslaves to run on (e.g. '
875 'build149-m2); if the bot is busy, it will be queued')
876 group.add_option('--test-tryjob', action='store_true',
877 default=False,
878 help='Submit a tryjob to the test repository. Will not '
879 'show up on the production trybot waterfall.')
880
881 parser.add_option_group(group)
882
883 #
884 # Advanced options.
Ryan Cuif4f84be2012-07-09 18:50:41 -0700885 #
886
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700887 group = CustomGroup(
Brian Harring3fec5a82012-03-01 05:57:03 -0800888 parser,
889 'Advanced Options',
890 'Caution: use these options at your own risk.')
891
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400892 group.add_remote_option('--bootstrap-args', action='append', default=[],
893 help='Args passed directly to the bootstrap re-exec '
894 'to skip verification by the bootstrap code')
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700895 group.add_remote_option('--buildbot', dest='buildbot', action='store_true',
896 default=False, help='This is running on a buildbot')
897 group.add_remote_option('--buildnumber', help='build number', type='int',
898 default=0)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700899 group.add_option('--chrome_root', default=None, type='path',
900 action='callback', callback=_CheckChromeRootOption,
901 dest='chrome_root', help='Local checkout of Chrome to use.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700902 group.add_remote_option('--chrome_version', default=None, type='string',
903 action='callback', dest='chrome_version',
904 callback=_CheckChromeVersionOption,
905 help='Used with SPEC logic to force a particular SVN '
906 'revision of chrome rather than the latest.')
907 group.add_remote_option('--clobber', action='store_true', dest='clobber',
908 default=False,
909 help='Clears an old checkout before syncing')
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400910 group.add_remote_option('--latest-toolchain', action='store_true',
911 default=False,
912 help='Use the latest toolchain.')
Ryan Cui5ba7e152012-05-10 14:36:52 -0700913 parser.add_option('--log_dir', dest='log_dir', type='path',
Brian Harring3fec5a82012-03-01 05:57:03 -0800914 help=('Directory where logs are stored.'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700915 group.add_remote_option('--maxarchives', dest='max_archive_builds',
916 default=3, type='int',
917 help="Change the local saved build count limit.")
Ryan Cuibbd3d4b2012-08-17 12:20:37 -0700918 parser.add_remote_option('--manifest-repo-url',
919 help=('Overrides the default manifest repo url.'))
David James565bc9a2013-04-08 14:54:45 -0700920 group.add_remote_option('--compilecheck', action='store_true', default=False,
921 help='Only verify compilation and unit tests.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700922 group.add_remote_option('--noarchive', action='store_false', dest='archive',
923 default=True, help="Don't run archive stage.")
Ryan Cuif7f24692012-05-18 16:35:33 -0700924 group.add_remote_option('--nobootstrap', action='store_false',
925 dest='bootstrap', default=True,
926 help="Don't checkout and run from a standalone "
927 "chromite repo.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700928 group.add_remote_option('--nobuild', action='store_false', dest='build',
929 default=True,
930 help="Don't actually build (for cbuildbot dev)")
931 group.add_remote_option('--noclean', action='store_false', dest='clean',
932 default=True, help="Don't clean the buildroot")
Ryan Cuif7f24692012-05-18 16:35:33 -0700933 group.add_remote_option('--nocgroups', action='store_false', dest='cgroups',
934 default=True,
935 help='Disable cbuildbots usage of cgroups.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700936 group.add_remote_option('--noprebuilts', action='store_false',
937 dest='prebuilts', default=True,
938 help="Don't upload prebuilts.")
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400939 group.add_remote_option('--nosdk', action='store_true',
940 default=False,
941 help='Re-create the SDK from scratch.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700942 group.add_remote_option('--nosync', action='store_false', dest='sync',
943 default=True, help="Don't sync before building.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700944 group.add_remote_option('--notests', action='store_false', dest='tests',
945 default=True,
946 help='Override values from buildconfig and run no '
947 'tests.')
948 group.add_remote_option('--nouprev', action='store_false', dest='uprev',
949 default=True,
950 help='Override values from buildconfig and never '
951 'uprev.')
Brian Harring3fec5a82012-03-01 05:57:03 -0800952 group.add_option('--reference-repo', action='store', default=None,
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700953 dest='reference_repo',
954 help='Reuse git data stored in an existing repo '
955 'checkout. This can drastically reduce the network '
956 'time spent setting up the trybot checkout. By '
957 "default, if this option isn't given but cbuildbot "
958 'is invoked from a repo checkout, cbuildbot will '
959 'use the repo root.')
Ryan Cuicedd8a52012-03-22 02:28:35 -0700960 group.add_option('--resume', action='store_true', default=False,
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700961 help='Skip stages already successfully completed.')
962 group.add_remote_option('--timeout', action='store', type='int', default=0,
963 help='Specify the maximum amount of time this job '
964 'can run for, at which point the build will be '
965 'aborted. If set to zero, then there is no '
966 'timeout.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700967 group.add_remote_option('--version', dest='force_version', default=None,
968 help='Used with manifest logic. Forces use of this '
969 'version rather than create or get latest.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400970
971 parser.add_option_group(group)
972
973 #
974 # Internal options.
975 #
976
977 group = CustomGroup(
978 parser,
979 'Internal ChromeOS Build Team Options',
980 'Caution: these are for meant for the ChromeOS build team only')
981
982 group.add_remote_option('--archive-base', type='gs_path',
983 help='Base GS URL (gs://<bucket_name>/<path>) to '
984 'upload archive artifacts to')
Brian Harringab8fb5c2012-07-18 11:28:22 -0700985 group.add_remote_option('--cq-gerrit-query', dest='cq_gerrit_override',
986 default=None,
987 help=
988 "If given, this gerrit query will be used to find what patches to test, "
Brian Harringc5cabfe2012-12-19 01:04:44 -0800989 "rather than the normal 'CommitQueue=1 AND Verified=1 AND CodeReview=2' "
Brian Harringab8fb5c2012-07-18 11:28:22 -0700990 "query it defaults to. Use with care- note additionally this setting "
991 "only has an effect if the buildbot target is a cq target, and we're "
992 "in buildbot mode.")
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400993 group.add_option('--pass-through', dest='pass_through_args', action='append',
994 type='string', default=[])
995 group.add_option('--reexec-api-version', dest='output_api_version',
Ryan Cuif4f84be2012-07-09 18:50:41 -0700996 action='store_true', default=False,
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400997 help='Used for handling forwards/backwards compatibility '
998 'with --resume and --bootstrap')
999 group.add_option('--remote-trybot', dest='remote_trybot',
1000 action='store_true', default=False,
1001 help='Indicates this is running on a remote trybot machine')
1002 group.add_remote_option('--remote-patches', action='extend', default=[],
1003 help='Patches uploaded by the trybot client when run '
1004 'using the -p option')
Brian Harringf611e6e2012-07-17 18:47:44 -07001005 # Note the default here needs to be hardcoded to 3; that is the last version
1006 # that lacked this functionality.
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001007 group.add_option('--remote-version', default=3, type=int, action='store',
1008 help='Used for compatibility checks w/tryjobs running in '
1009 'older chromite instances')
1010 group.add_option('--sourceroot', type='path', default=constants.SOURCE_ROOT)
1011 group.add_remote_option('--test-bootstrap', action='store_true',
1012 default=False,
1013 help='Causes cbuildbot to bootstrap itself twice, in '
1014 'the sequence A->B->C: A(unpatched) patches and '
1015 'bootstraps B; B patches and bootstraps C')
1016 group.add_remote_option('--validation_pool', default=None,
1017 help='Path to a pickled validation pool. Intended '
1018 'for use only with the commit queue.')
1019
1020 parser.add_option_group(group)
Ryan Cuif4f84be2012-07-09 18:50:41 -07001021
1022 #
Brian Harring3fec5a82012-03-01 05:57:03 -08001023 # Debug options
Ryan Cuif4f84be2012-07-09 18:50:41 -07001024 #
Brian Harringfec89fe2012-09-23 07:30:54 -07001025 # Temporary hack; in place till --dry-run replaces --debug.
1026 # pylint: disable=W0212
Brian Harring009db502012-10-10 02:21:37 -07001027 group = parser.debug_group
Brian Harringfec89fe2012-09-23 07:30:54 -07001028 debug = [x for x in group.option_list if x._long_opts == ['--debug']][0]
1029 debug.help += " Currently functions as --dry-run in addition."
1030 debug.pass_through = True
Brian Harring3fec5a82012-03-01 05:57:03 -08001031 group.add_option('--dump_config', action='store_true', dest='dump_config',
1032 default=False,
1033 help='Dump out build config options, and exit.')
1034 group.add_option('--notee', action='store_false', dest='tee', default=True,
1035 help="Disable logging and internal tee process. Primarily "
1036 "used for debugging cbuildbot itself.")
Brian Harring3fec5a82012-03-01 05:57:03 -08001037 return parser
1038
1039
Ryan Cui85867972012-02-23 18:21:49 -08001040def _FinishParsing(options, args):
1041 """Perform some parsing tasks that need to take place after optparse.
1042
1043 This function needs to be easily testable! Keep it free of
1044 environment-dependent code. Put more detailed usage validation in
1045 _PostParseCheck().
Brian Harring3fec5a82012-03-01 05:57:03 -08001046
1047 Args:
Ryan Cui85867972012-02-23 18:21:49 -08001048 options, args: The options/args object returned by optparse
Brian Harring3fec5a82012-03-01 05:57:03 -08001049 """
Ryan Cui41023d92012-11-13 19:59:50 -08001050 # Populate options.pass_through_args.
1051 accepted, _ = commandline.FilteringParser.FilterArgs(
1052 options.parsed_args, lambda x: x.opt_inst.pass_through)
1053 options.pass_through_args.extend(accepted)
Brian Harring07039b52012-05-13 17:56:47 -07001054
Brian Harring3fec5a82012-03-01 05:57:03 -08001055 if options.chrome_root:
1056 if options.chrome_rev != constants.CHROME_REV_LOCAL:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001057 cros_build_lib.Die('Chrome rev must be %s if chrome_root is set.' %
1058 constants.CHROME_REV_LOCAL)
David Jamesa0a664e2013-02-13 09:52:01 -08001059 elif options.chrome_rev == constants.CHROME_REV_LOCAL:
1060 cros_build_lib.Die('Chrome root must be set if chrome_rev is %s.' %
1061 constants.CHROME_REV_LOCAL)
Brian Harring3fec5a82012-03-01 05:57:03 -08001062
1063 if options.chrome_version:
1064 if options.chrome_rev != constants.CHROME_REV_SPEC:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001065 cros_build_lib.Die('Chrome rev must be %s if chrome_version is set.' %
1066 constants.CHROME_REV_SPEC)
David Jamesa0a664e2013-02-13 09:52:01 -08001067 elif options.chrome_rev == constants.CHROME_REV_SPEC:
1068 cros_build_lib.Die(
1069 'Chrome rev must not be %s if chrome_version is not set.'
1070 % constants.CHROME_REV_SPEC)
Brian Harring3fec5a82012-03-01 05:57:03 -08001071
David James9e27e662013-02-14 13:42:43 -08001072 patches = bool(options.gerrit_patches or options.local_patches or
1073 options.rietveld_patches)
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001074 if options.remote:
1075 if options.local:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001076 cros_build_lib.Die('Cannot specify both --remote and --local')
Ryan Cui54da0702012-04-19 18:38:08 -07001077
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001078 if not options.buildbot and not patches:
Brian Harring7cc4b932012-11-01 16:58:55 -07001079 if not cros_build_lib.BooleanPrompt(
1080 prompt="No patches were provided; are you sure you want to just "
1081 "run a remote build of ToT?", default=False):
1082 cros_build_lib.Die('Must provide patches when running with --remote.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001083
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001084 # --debug needs to be explicitly passed through for remote invocations.
1085 release_mode_with_patches = (options.buildbot and patches and
1086 '--debug' not in options.pass_through_args)
1087 else:
1088 if len(args) > 1:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001089 cros_build_lib.Die('Multiple configs not supported if not running with '
Brian Harringf1aad832012-07-18 10:46:39 -07001090 '--remote. Got %r', args)
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001091
Ryan Cui79319ab2012-05-21 12:59:18 -07001092 if options.slaves:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001093 cros_build_lib.Die('Cannot use --slaves if not running with --remote.')
Ryan Cui79319ab2012-05-21 12:59:18 -07001094
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001095 release_mode_with_patches = (options.buildbot and patches and
1096 not options.debug)
1097
David James5734ea32012-08-15 20:23:49 -07001098 # When running in release mode, make sure we are running with checked-in code.
1099 # We want checked-in cbuildbot/scripts to prevent errors, and we want to build
1100 # a release image with checked-in code for CrOS packages.
1101 if release_mode_with_patches:
1102 cros_build_lib.Die(
1103 'Cannot provide patches when running with --buildbot!')
1104
Ryan Cuiba41ad32012-03-08 17:15:29 -08001105 if options.buildbot and options.remote_trybot:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001106 cros_build_lib.Die(
1107 '--buildbot and --remote-trybot cannot be used together.')
Ryan Cuiba41ad32012-03-08 17:15:29 -08001108
Ryan Cui85867972012-02-23 18:21:49 -08001109 # Record whether --debug was set explicitly vs. it was inferred.
1110 options.debug_forced = False
1111 if options.debug:
1112 options.debug_forced = True
1113 else:
Ryan Cui16ca5812012-03-08 20:34:27 -08001114 # We don't set debug by default for
1115 # 1. --buildbot invocations.
1116 # 2. --remote invocations, because it needs to push changes to the tryjob
1117 # repo.
1118 options.debug = not options.buildbot and not options.remote
Brian Harring3fec5a82012-03-01 05:57:03 -08001119
Ryan Cui1c13a252012-10-16 15:00:16 -07001120 # Record the configs targeted.
1121 options.build_targets = args[:]
1122
Brian Harring3fec5a82012-03-01 05:57:03 -08001123
Brian Harring1d7ba942012-04-24 06:37:18 -07001124# pylint: disable=W0613
Brian Harringae0a5322012-09-15 01:46:51 -07001125def _PostParseCheck(parser, options, args):
Ryan Cui85867972012-02-23 18:21:49 -08001126 """Perform some usage validation after we've parsed the arguments
Brian Harring3fec5a82012-03-01 05:57:03 -08001127
Ryan Cui85867972012-02-23 18:21:49 -08001128 Args:
1129 options/args: The options/args object returned by optparse
1130 """
Ryan Cuie1e4e662012-05-21 16:39:46 -07001131 if not options.branch:
David James97d95872012-11-16 15:09:56 -08001132 options.branch = git.GetChromiteTrackingBranch()
Ryan Cuie1e4e662012-05-21 16:39:46 -07001133
Brian Harringae0a5322012-09-15 01:46:51 -07001134 if not repository.IsARepoRoot(options.sourceroot):
1135 if options.local_patches:
1136 raise Exception('Could not find repo checkout at %s!'
1137 % options.sourceroot)
1138
David Jamesac8c2a72013-02-13 18:44:33 -08001139 # Because the default cache dir depends on other options, FindCacheDir
1140 # always returns None, and we setup the default here.
Brian Harringae0a5322012-09-15 01:46:51 -07001141 if options.cache_dir is None:
1142 # Note, options.sourceroot is set regardless of the path
1143 # actually existing.
David Jamesac8c2a72013-02-13 18:44:33 -08001144 if options.buildroot is not None:
Brian Harringae0a5322012-09-15 01:46:51 -07001145 options.cache_dir = os.path.join(options.buildroot, '.cache')
David Jamesac8c2a72013-02-13 18:44:33 -08001146 elif os.path.exists(options.sourceroot):
1147 options.cache_dir = os.path.join(options.sourceroot, '.cache')
Brian Harringae0a5322012-09-15 01:46:51 -07001148 else:
1149 options.cache_dir = parser.FindCacheDir(parser, options)
1150 options.cache_dir = os.path.abspath(options.cache_dir)
Brian Harring8c1d7b12012-10-04 17:36:32 -07001151 parser.ConfigureCacheDir(options.cache_dir)
Brian Harringae0a5322012-09-15 01:46:51 -07001152
1153 osutils.SafeMakedirs(options.cache_dir)
Ryan Cui5ba7e152012-05-10 14:36:52 -07001154
Brian Harring609dc4e2012-05-07 02:17:44 -07001155 if options.local_patches:
Brian Harring1d7ba942012-04-24 06:37:18 -07001156 options.local_patches = _CheckLocalPatches(
Brian Harring609dc4e2012-05-07 02:17:44 -07001157 options.sourceroot, options.local_patches)
Brian Harring1d7ba942012-04-24 06:37:18 -07001158
1159 default = os.environ.get('CBUILDBOT_DEFAULT_MODE')
1160 if (default and not any([options.local, options.buildbot,
1161 options.remote, options.remote_trybot])):
Brian Harring1b8c4c82012-05-29 23:03:04 -07001162 cros_build_lib.Info("CBUILDBOT_DEFAULT_MODE=%s env var detected, using it."
1163 % default)
Brian Harring1d7ba942012-04-24 06:37:18 -07001164 default = default.lower()
1165 if default == 'local':
1166 options.local = True
1167 elif default == 'remote':
1168 options.remote = True
1169 elif default == 'buildbot':
1170 options.buildbot = True
1171 else:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001172 cros_build_lib.Die("CBUILDBOT_DEFAULT_MODE value %s isn't supported. "
1173 % default)
Ryan Cui85867972012-02-23 18:21:49 -08001174
1175
1176def _ParseCommandLine(parser, argv):
1177 """Completely parse the commandline arguments"""
Brian Harring3fec5a82012-03-01 05:57:03 -08001178 (options, args) = parser.parse_args(argv)
Brian Harring37e559b2012-05-22 20:47:32 -07001179
1180 if options.output_api_version:
Ryan Cui724f1d32012-10-15 18:10:22 -07001181 print constants.REEXEC_API_VERSION
Brian Harring37e559b2012-05-22 20:47:32 -07001182 sys.exit(0)
1183
Ryan Cui54da0702012-04-19 18:38:08 -07001184 if options.list:
1185 _PrintValidConfigs(options.print_all)
1186 sys.exit(0)
1187
Ryan Cui8be16062012-04-24 12:05:26 -07001188 # Strip out null arguments.
1189 # TODO(rcui): Remove when buildbot is fixed
1190 args = [arg for arg in args if arg]
1191 if not args:
1192 parser.error('Invalid usage. Use -h to see usage. Use -l to list '
1193 'supported configs.')
1194
Ryan Cui85867972012-02-23 18:21:49 -08001195 _FinishParsing(options, args)
1196 return options, args
1197
1198
1199def main(argv):
David James59a0a2b2013-03-22 14:04:44 -07001200 # Turn on strict sudo checks.
1201 cros_build_lib.STRICT_SUDO = True
1202
Ryan Cui85867972012-02-23 18:21:49 -08001203 # Set umask to 022 so files created by buildbot are readable.
1204 os.umask(022)
1205
Ryan Cui85867972012-02-23 18:21:49 -08001206 parser = _CreateParser()
1207 (options, args) = _ParseCommandLine(parser, argv)
Brian Harring3fec5a82012-03-01 05:57:03 -08001208
Brian Harringae0a5322012-09-15 01:46:51 -07001209 _PostParseCheck(parser, options, args)
Brian Harring3fec5a82012-03-01 05:57:03 -08001210
Mike Frysinger8fd67dc2012-12-03 23:51:18 -05001211 cros_build_lib.AssertOutsideChroot()
Zdenek Behan98ec2fb2012-08-31 17:12:18 +02001212
Brian Harring3fec5a82012-03-01 05:57:03 -08001213 if options.remote:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001214 cros_build_lib.logger.setLevel(logging.WARNING)
Ryan Cui16ca5812012-03-08 20:34:27 -08001215
Brian Harring3fec5a82012-03-01 05:57:03 -08001216 # Verify configs are valid.
Aviv Kesheta96a2a92013-02-05 17:21:51 -08001217 # If hwtest flag is enabled, verify that config board is in whitelist.
Brian Harring3fec5a82012-03-01 05:57:03 -08001218 for bot in args:
Aviv Kesheta96a2a92013-02-05 17:21:51 -08001219 build_config = _GetConfig(bot)
1220 if options.hwtest:
1221 if not set(build_config['boards']).issubset(
1222 set(constants.HWTEST_BOARD_WHITELIST)):
1223 cros_build_lib.Die('The test lab is unable to run hwtest tryjobs '
1224 'with the given board(s). The currently '
1225 'supported boards are %s. If you are root '
1226 'causing a critical bug and need temporary '
1227 'support please contact the lab '
1228 'team.' % constants.HWTEST_BOARD_WHITELIST)
Brian Harring3fec5a82012-03-01 05:57:03 -08001229
1230 # Verify gerrit patches are valid.
Ryan Cui16ca5812012-03-08 20:34:27 -08001231 print 'Verifying patches...'
Ryan Cuie1e4e662012-05-21 16:39:46 -07001232 patch_pool = AcquirePoolFromOptions(options)
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001233
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001234 # --debug need to be explicitly passed through for remote invocations.
1235 if options.buildbot and '--debug' not in options.pass_through_args:
1236 _ConfirmRemoteBuildbotRun()
1237
Ryan Cui16ca5812012-03-08 20:34:27 -08001238 print 'Submitting tryjob...'
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001239 tryjob = remote_try.RemoteTryJob(options, args, patch_pool.local_patches)
Ryan Cuia25d8eb2012-07-11 14:54:27 -07001240 tryjob.Submit(testjob=options.test_tryjob, dryrun=False)
Ryan Cui16ca5812012-03-08 20:34:27 -08001241 print 'Tryjob submitted!'
1242 print ('Go to %s to view the status of your job.'
Ryan Cui4906e1c2012-04-03 20:09:34 -07001243 % tryjob.GetTrybotWaterfallLink())
Brian Harring3fec5a82012-03-01 05:57:03 -08001244 sys.exit(0)
Ryan Cui54da0702012-04-19 18:38:08 -07001245 elif (not options.buildbot and not options.remote_trybot
1246 and not options.resume and not options.local):
Brian Harring1b8c4c82012-05-29 23:03:04 -07001247 cros_build_lib.Warning(
1248 'Running in LOCAL TRYBOT mode! Use --remote to submit REMOTE '
1249 'tryjobs. Use --local to suppress this message.')
1250 cros_build_lib.Warning(
Ryan Cui51591352012-07-09 15:15:53 -07001251 'In the future, --local will be required to run the local '
Brian Harring1b8c4c82012-05-29 23:03:04 -07001252 'trybot.')
Ryan Cui54da0702012-04-19 18:38:08 -07001253 time.sleep(5)
Brian Harring3fec5a82012-03-01 05:57:03 -08001254
Ryan Cui8be16062012-04-24 12:05:26 -07001255 # Only expecting one config
1256 bot_id = args[-1]
1257 build_config = _GetConfig(bot_id)
Brian Harring3fec5a82012-03-01 05:57:03 -08001258
1259 if options.reference_repo is None:
Ryan Cui5ba7e152012-05-10 14:36:52 -07001260 repo_path = os.path.join(options.sourceroot, '.repo')
Brian Harring3fec5a82012-03-01 05:57:03 -08001261 # If we're being run from a repo checkout, reuse the repo's git pool to
1262 # cut down on sync time.
1263 if os.path.exists(repo_path):
Ryan Cui5ba7e152012-05-10 14:36:52 -07001264 options.reference_repo = options.sourceroot
Brian Harring3fec5a82012-03-01 05:57:03 -08001265 elif options.reference_repo:
1266 if not os.path.exists(options.reference_repo):
1267 parser.error('Reference path %s does not exist'
1268 % (options.reference_repo,))
1269 elif not os.path.exists(os.path.join(options.reference_repo, '.repo')):
1270 parser.error('Reference path %s does not look to be the base of a '
1271 'repo checkout; no .repo exists in the root.'
1272 % (options.reference_repo,))
Ryan Cuid4a24212012-04-04 18:08:12 -07001273
Brian Harringf11bf682012-05-14 15:53:43 -07001274 if (options.buildbot or options.remote_trybot) and not options.resume:
Brian Harring470f6112012-03-02 11:47:10 -08001275 if not options.cgroups:
Ryan Cuid4a24212012-04-04 18:08:12 -07001276 parser.error('Options --buildbot/--remote-trybot and --nocgroups cannot '
1277 'be used together. Cgroup support is required for '
1278 'buildbot/remote-trybot mode.')
Mike Frysingera78a56e2012-11-20 06:02:30 -05001279 if not cgroups.Cgroup.IsSupported():
Ryan Cuid4a24212012-04-04 18:08:12 -07001280 parser.error('Option --buildbot/--remote-trybot was given, but this '
1281 'system does not support cgroups. Failing.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001282
David Jamesaad5cc72012-10-26 15:03:13 -07001283 missing = osutils.FindMissingBinaries(_BUILDBOT_REQUIRED_BINARIES)
Brian Harring351ce442012-03-09 16:38:14 -08001284 if missing:
Ryan Cuid4a24212012-04-04 18:08:12 -07001285 parser.error("Option --buildbot/--remote-trybot requires the following "
1286 "binaries which couldn't be found in $PATH: %s"
Brian Harring351ce442012-03-09 16:38:14 -08001287 % (', '.join(missing)))
1288
Brian Harring3fec5a82012-03-01 05:57:03 -08001289 if options.reference_repo:
1290 options.reference_repo = os.path.abspath(options.reference_repo)
1291
1292 if options.dump_config:
1293 # This works, but option ordering is bad...
1294 print 'Configuration %s:' % bot_id
1295 pretty_printer = pprint.PrettyPrinter(indent=2)
1296 pretty_printer.pprint(build_config)
1297 sys.exit(0)
1298
1299 if not options.buildroot:
1300 if options.buildbot:
Mike Frysinger6903c762012-12-04 01:57:16 -05001301 parser.error('Please specify a buildroot with the --buildbot option.')
Matt Tennantd55b1f42012-04-13 14:15:01 -07001302
Ryan Cui5ba7e152012-05-10 14:36:52 -07001303 options.buildroot = _DetermineDefaultBuildRoot(options.sourceroot,
1304 build_config['internal'])
Brian Harring470f6112012-03-02 11:47:10 -08001305 # We use a marker file in the buildroot to indicate the user has
1306 # consented to using this directory.
1307 if not os.path.exists(repository.GetTrybotMarkerPath(options.buildroot)):
1308 _ConfirmBuildRoot(options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -08001309
1310 # Sanity check of buildroot- specifically that it's not pointing into the
1311 # midst of an existing repo since git-repo doesn't support nesting.
Brian Harring3fec5a82012-03-01 05:57:03 -08001312 if (not repository.IsARepoRoot(options.buildroot) and
David James6b80dc62012-02-29 15:34:40 -08001313 repository.InARepoRepository(options.buildroot)):
Brian Harring3fec5a82012-03-01 05:57:03 -08001314 parser.error('Configured buildroot %s points into a repository checkout, '
1315 'rather than the root of it. This is not supported.'
1316 % options.buildroot)
1317
Chris Sosab5ea3b42012-10-25 15:25:20 -07001318 if not options.log_dir:
1319 options.log_dir = os.path.join(options.buildroot, _DEFAULT_LOG_DIR)
1320
Brian Harringd166aaf2012-05-14 18:31:53 -07001321 log_file = None
1322 if options.tee:
Chris Sosab5ea3b42012-10-25 15:25:20 -07001323 log_file = os.path.join(options.log_dir, _BUILDBOT_LOG_FILE)
1324 osutils.SafeMakedirs(options.log_dir)
Brian Harringd166aaf2012-05-14 18:31:53 -07001325 _BackupPreviousLog(log_file)
1326
Brian Harring1b8c4c82012-05-29 23:03:04 -07001327 with cros_build_lib.ContextManagerStack() as stack:
Brian Harringc2d09d92012-05-13 22:03:15 -07001328 critical_section = stack.Add(cleanup.EnforcedCleanupSection)
1329 stack.Add(sudo.SudoKeepAlive)
Brian Harringd166aaf2012-05-14 18:31:53 -07001330
Brian Harringc2d09d92012-05-13 22:03:15 -07001331 if not options.resume:
Brian Harring2bf55e12012-05-13 21:31:55 -07001332 # If we're in resume mode, use our parents tempdir rather than
1333 # nesting another layer.
David James4bc13702013-03-26 08:08:04 -07001334 stack.Add(osutils.TempDir, prefix='cbuildbot-tmp', set_global=True)
Brian Harringc2d09d92012-05-13 22:03:15 -07001335 logging.debug("Cbuildbot tempdir is %r.", os.environ.get('TMP'))
Brian Harringd166aaf2012-05-14 18:31:53 -07001336
Brian Harringead69102012-07-31 15:54:07 -07001337 # TODO(ferringb): update this once https://gerrit.chromium.org/gerrit/25359
1338 # is landed- it's sensitive to the manifest-versions cache path.
Brian Harringae0a5322012-09-15 01:46:51 -07001339 options.preserve_paths = set(['manifest-versions', '.cache',
Brian Harringead69102012-07-31 15:54:07 -07001340 'manifest-versions-internal'])
Brian Harringd166aaf2012-05-14 18:31:53 -07001341 if log_file is not None:
1342 stack.Add(tee.Tee, log_file)
Brian Harring2d8f9ff2012-06-30 15:58:28 -07001343 options.preserve_paths.add(_DEFAULT_LOG_DIR)
Brian Harringd166aaf2012-05-14 18:31:53 -07001344
Brian Harringc2d09d92012-05-13 22:03:15 -07001345 if options.cgroups:
1346 stack.Add(cgroups.SimpleContainChildren, 'cbuildbot')
Brian Harringa184efa2012-03-04 11:51:25 -08001347
Brian Harringc2d09d92012-05-13 22:03:15 -07001348 # Mark everything between EnforcedCleanupSection and here as having to
1349 # be rolled back via the contextmanager cleanup handlers. This
1350 # ensures that sudo bits cannot outlive cbuildbot, that anything
1351 # cgroups would kill gets killed, etc.
1352 critical_section.ForkWatchdog()
Brian Harringd166aaf2012-05-14 18:31:53 -07001353
Brian Harringc2d09d92012-05-13 22:03:15 -07001354 if options.timeout > 0:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001355 stack.Add(cros_build_lib.Timeout, options.timeout)
Brian Harringa184efa2012-03-04 11:51:25 -08001356
Brian Harringc2d09d92012-05-13 22:03:15 -07001357 if not options.buildbot:
1358 build_config = cbuildbot_config.OverrideConfigForTrybot(
1359 build_config,
David Jamese8dcfc42013-03-21 19:49:49 -07001360 options)
Brian Harringc2d09d92012-05-13 22:03:15 -07001361
Mike Frysinger6903c762012-12-04 01:57:16 -05001362 if options.buildbot or options.remote_trybot:
1363 _DisableYamaHardLinkChecks()
1364
Brian Harringc2d09d92012-05-13 22:03:15 -07001365 _RunBuildStagesWrapper(options, build_config)