blob: 5b00db36aa00035ee7de8cc70c8bfafb57b51df6 [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
David Jamesf421c6d2013-04-11 15:37:57 -0700233 pool = getattr(sync_instance, 'pool', None)
234 if pool:
235 filename = os.path.join(self.options.buildroot, 'validation_pool.dump')
236 pool.Save(filename)
237 args += ['--validation_pool', filename]
Brian Harring3fec5a82012-03-01 05:57:03 -0800238
David Jamesac8c2a72013-02-13 18:44:33 -0800239 # Reset the cache dir so that the child will calculate it automatically.
240 if not self.options.cache_dir_specified:
241 commandline.BaseParser.ConfigureCacheDir(None)
242
Brian Harring3fec5a82012-03-01 05:57:03 -0800243 # Re-run the command in the buildroot.
244 # Finally, be generous and give the invoked cbuildbot 30s to shutdown
245 # when something occurs. It should exit quicker, but the sigterm may
246 # hit while the system is particularly busy.
Brian Harring1b8c4c82012-05-29 23:03:04 -0700247 return_obj = cros_build_lib.RunCommand(
Ryan Cui1c13a252012-10-16 15:00:16 -0700248 args, cwd=self.options.buildroot, error_code_ok=True, kill_timeout=30)
Brian Harring3fec5a82012-03-01 05:57:03 -0800249 return return_obj.returncode == 0
250
Ryan Cuif7f24692012-05-18 16:35:33 -0700251 def _InitializeTrybotPatchPool(self):
252 """Generate patch pool from patches specified on the command line.
253
254 Do this only if we need to patch changes later on.
255 """
256 changes_stage = stages.PatchChangesStage.StageNamePrefix()
257 check_func = results_lib.Results.PreviouslyCompletedRecord
258 if not check_func(changes_stage) or self.options.bootstrap:
Ryan Cuie1e4e662012-05-21 16:39:46 -0700259 self.patch_pool = AcquirePoolFromOptions(self.options)
Ryan Cuif7f24692012-05-18 16:35:33 -0700260
261 def _GetBootstrapStage(self):
262 """Constructs and returns the BootStrapStage object.
263
264 We return None when there are no chromite patches to test, and
265 --test-bootstrap wasn't passed in.
266 """
267 stage = None
268 chromite_pool = self.patch_pool.Filter(project=constants.CHROMITE_PROJECT)
Ryan Cui5616a512012-08-17 13:39:36 -0700269 manifest_pool = self.patch_pool.FilterManifest()
David James97d95872012-11-16 15:09:56 -0800270 chromite_branch = git.GetChromiteTrackingBranch()
Ryan Cui5616a512012-08-17 13:39:36 -0700271 if (chromite_pool or manifest_pool or self.options.test_bootstrap
Ryan Cuie1e4e662012-05-21 16:39:46 -0700272 or chromite_branch != self.options.branch):
Ryan Cuif7f24692012-05-18 16:35:33 -0700273 stage = stages.BootstrapStage(self.options, self.build_config,
Ryan Cui5616a512012-08-17 13:39:36 -0700274 chromite_pool, manifest_pool)
Ryan Cuif7f24692012-05-18 16:35:33 -0700275 return stage
276
Brian Harring3fec5a82012-03-01 05:57:03 -0800277 def Run(self):
Ryan Cuif7f24692012-05-18 16:35:33 -0700278 """Main runner for this builder class. Runs build and prints summary.
279
280 Returns:
281 Whether the build succeeded.
282 """
283 self._InitializeTrybotPatchPool()
284
285 if self.options.bootstrap:
286 bootstrap_stage = self._GetBootstrapStage()
287 if bootstrap_stage:
288 # BootstrapStage blocks on re-execution of cbuildbot.
289 bootstrap_stage.Run()
290 return bootstrap_stage.returncode == 0
291
Brian Harring3fec5a82012-03-01 05:57:03 -0800292 print_report = True
David James3d4d3502012-04-09 15:12:06 -0700293 exception_thrown = False
Brian Harring3fec5a82012-03-01 05:57:03 -0800294 success = True
295 try:
296 self.Initialize()
297 sync_instance = self.GetSyncInstance()
298 sync_instance.Run()
299 self._SetReleaseTag()
300
Ryan Cui967f7cc2012-08-17 13:01:12 -0700301 # Filter out patches to manifest, since PatchChangesStage can't handle
302 # them. Manifest patches are patched in the BootstrapStage.
303 non_manifest_patches = self.patch_pool.FilterManifest(negate=True)
304 if non_manifest_patches:
305 self._RunStage(stages.PatchChangesStage, non_manifest_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800306
307 if self._ShouldReExecuteInBuildRoot():
308 print_report = False
309 success = self._ReExecuteInBuildroot(sync_instance)
310 else:
311 self.RunStages()
David James3541a132013-03-18 13:21:58 -0700312 except Exception as ex:
313 # If the build is marked as successful, but threw exceptions, that's a
314 # problem.
David James7fbf2d42012-07-14 18:23:49 -0700315 exception_thrown = True
David James3541a132013-03-18 13:21:58 -0700316 if results_lib.Results.BuildSucceededSoFar():
317 traceback.print_exc(file=sys.stdout)
David James7fbf2d42012-07-14 18:23:49 -0700318 raise
David James3541a132013-03-18 13:21:58 -0700319 if not (print_report and isinstance(ex, results_lib.StepFailure)):
320 raise
Brian Harring3fec5a82012-03-01 05:57:03 -0800321 finally:
322 if print_report:
Ryan Cuif7f24692012-05-18 16:35:33 -0700323 results_lib.WriteCheckpoint(self.options.buildroot)
Mike Frysinger9b223362013-03-04 21:54:26 -0500324 self._RunStage(stages.ReportStage, self.archive_stages,
325 self.release_tag)
Brian Harring3fec5a82012-03-01 05:57:03 -0800326 success = results_lib.Results.BuildSucceededSoFar()
David James3d4d3502012-04-09 15:12:06 -0700327 if exception_thrown and success:
328 success = False
David Jamesbb20ac82012-07-18 10:59:16 -0700329 cros_build_lib.PrintBuildbotStepWarnings()
330 print """\
David James3d4d3502012-04-09 15:12:06 -0700331Exception thrown, but all stages marked successful. This is an internal error,
332because the stage that threw the exception should be marked as failing."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800333
334 return success
335
336
337class SimpleBuilder(Builder):
338 """Builder that performs basic vetting operations."""
339
340 def GetSyncInstance(self):
341 """Sync to lkgm or TOT as necessary.
342
343 Returns: the instance of the sync stage that was run.
344 """
Chris Sosa52a81b62012-11-14 06:12:54 -0800345 if self.build_config['use_lkgm']:
Brian Harring3fec5a82012-03-01 05:57:03 -0800346 sync_stage = self._GetStageInstance(stages.LKGMSyncStage)
Chris Sosa52a81b62012-11-14 06:12:54 -0800347 elif self.build_config['use_chrome_lkgm']:
348 sync_stage = self._GetStageInstance(stages.ChromeLKGMSyncStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800349 else:
350 sync_stage = self._GetStageInstance(stages.SyncStage)
351
352 return sync_stage
353
David James4f2d8302013-03-19 06:35:58 -0700354 @staticmethod
355 def _RunParallelStages(stage_objs):
356 """Run the specified stages in parallel."""
357 steps = [stage.Run for stage in stage_objs]
358 try:
359 parallel.RunParallelSteps(steps)
360 except BaseException as ex:
361 # If a stage threw an exception, it might not have correctly reported
362 # results (e.g. because it was killed before it could report the
363 # results.) In this case, attribute the exception to any stages that
364 # didn't report back correctly (if any).
365 for stage in stage_objs:
366 if not results_lib.Results.StageHasResults(stage.name):
367 results_lib.Results.Record(stage.name, ex, str(ex))
368 raise
369
David James565bc9a2013-04-08 14:54:45 -0700370 def _RunBackgroundStagesForBoard(self, board, compilecheck):
David James58e0c092012-03-04 20:31:12 -0800371 """Run background board-specific stages for the specified board."""
David James58e0c092012-03-04 20:31:12 -0800372 archive_stage = self.archive_stages[board]
David James944a48e2012-03-07 12:19:03 -0800373 configs = self.build_config['board_specific_configs']
374 config = configs.get(board, self.build_config)
David James565bc9a2013-04-08 14:54:45 -0700375 if compilecheck:
376 self._RunStage(stages.BuildPackagesStage, board, archive_stage,
377 config=config)
378 self._RunStage(stages.UnitTestStage, board, config=config)
379 return
David James944a48e2012-03-07 12:19:03 -0800380 stage_list = [[stages.VMTestStage, board, archive_stage],
Mike Frysinger5e20ec42012-09-28 23:39:56 -0400381 [stages.SignerTestStage, board, archive_stage],
David James944a48e2012-03-07 12:19:03 -0800382 [stages.UnitTestStage, board],
Chris Sosa6ed77e52012-10-22 12:57:31 -0700383 [stages.UploadPrebuiltsStage, board, archive_stage],
384 [stages.DevInstallerPrebuiltsStage, board, archive_stage]]
Brian Harring3fec5a82012-03-01 05:57:03 -0800385
David James58e0c092012-03-04 20:31:12 -0800386 # We can not run hw tests without archiving the payloads.
387 if self.options.archive:
Chris Sosaba250522013-03-27 18:57:34 -0700388 for suite_config in config['hw_tests']:
389 if suite_config.async:
390 stage_list.append([stages.ASyncHWTestStage, board, archive_stage,
391 suite_config])
392 elif suite_config.suite == constants.HWTEST_AU_SUITE:
393 stage_list.append([stages.AUTestStage, board, archive_stage,
394 suite_config])
Chris Sosa077df812013-01-25 17:05:28 -0800395 else:
Chris Sosaba250522013-03-27 18:57:34 -0700396 stage_list.append([stages.HWTestStage, board, archive_stage,
397 suite_config])
Chris Sosa817b1f92012-07-19 15:00:23 -0700398
David James4f2d8302013-03-19 06:35:58 -0700399 stage_objs = [self._GetStageInstance(*x, config=config) for x in stage_list]
400 self._RunParallelStages(stage_objs + [archive_stage])
Brian Harring3fec5a82012-03-01 05:57:03 -0800401
402 def RunStages(self):
403 """Runs through build process."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800404 # TODO(sosa): Split these out into classes.
David James816a5942013-04-11 22:59:32 -0700405 if self.build_config['build_type'] == constants.PRE_CQ_LAUNCHER_TYPE:
406 self._RunStage(stages.PreCQLauncherStage)
407 elif self.build_config['build_type'] == constants.CHROOT_BUILDER_TYPE:
Mike Frysingerfddaeb52012-11-20 11:17:31 -0500408 self._RunStage(stages.UprevStage, boards=[], enter_chroot=False)
David James59a0a2b2013-03-22 14:04:44 -0700409 self._RunStage(stages.InitSDKStage)
410 self._RunStage(stages.SetupBoardStage, [constants.CHROOT_BUILDER_BOARD])
David Jamesa0a664e2013-02-13 09:52:01 -0800411 self._RunStage(stages.SyncChromeStage)
David James9e27e662013-02-14 13:42:43 -0800412 self._RunStage(stages.PatchChromeStage)
Zdenek Behan62a57792012-08-31 15:09:08 +0200413 self._RunStage(stages.SDKPackageStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800414 self._RunStage(stages.SDKTestStage)
415 self._RunStage(stages.UploadPrebuiltsStage,
Chris Sosa6a5dceb2012-05-14 13:48:56 -0700416 constants.CHROOT_BUILDER_BOARD, None)
Brian Harring3fec5a82012-03-01 05:57:03 -0800417 elif self.build_config['build_type'] == constants.REFRESH_PACKAGES_TYPE:
David James59a0a2b2013-03-22 14:04:44 -0700418 self._RunStage(stages.InitSDKStage)
419 self._RunStage(stages.SetupBoardStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800420 self._RunStage(stages.RefreshPackageStatusStage)
421 else:
David James59a0a2b2013-03-22 14:04:44 -0700422 self._RunStage(stages.InitSDKStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800423 self._RunStage(stages.UprevStage)
David James59a0a2b2013-03-22 14:04:44 -0700424 self._RunStage(stages.SetupBoardStage)
David Jamesa0a664e2013-02-13 09:52:01 -0800425 self._RunStage(stages.SyncChromeStage)
David James9e27e662013-02-14 13:42:43 -0800426 self._RunStage(stages.PatchChromeStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800427
David James944a48e2012-03-07 12:19:03 -0800428 configs = self.build_config['board_specific_configs']
David James58e0c092012-03-04 20:31:12 -0800429 for board in self.build_config['boards']:
David James944a48e2012-03-07 12:19:03 -0800430 config = configs.get(board, self.build_config)
431 archive_stage = self._GetStageInstance(stages.ArchiveStage, board,
David James280447f2013-03-12 13:59:43 -0700432 self.release_tag, config=config)
David James58e0c092012-03-04 20:31:12 -0800433 self.archive_stages[board] = archive_stage
434
David James944a48e2012-03-07 12:19:03 -0800435 # Set up a process pool to run test/archive stages in the background.
436 # This process runs task(board) for each board added to the queue.
David James565bc9a2013-04-08 14:54:45 -0700437 compilecheck = (self.build_config['compilecheck'] or
438 self.options.compilecheck)
David James58e0c092012-03-04 20:31:12 -0800439 task = self._RunBackgroundStagesForBoard
Brian Harring9fdd23d2012-12-07 12:09:08 -0800440 with parallel.BackgroundTaskRunner(task) as queue:
David James944a48e2012-03-07 12:19:03 -0800441 for board in self.build_config['boards']:
David James565bc9a2013-04-08 14:54:45 -0700442 if not compilecheck:
443 archive_stage = self.archive_stages[board]
444 config = configs.get(board, self.build_config)
David James138b0af2013-03-19 14:38:57 -0700445
David James565bc9a2013-04-08 14:54:45 -0700446 # Run BuildPackages and BuildImage in the foreground, generating and
447 # using PGO data if requested.
448 built = False
449 for step in ('pgo_generate', 'pgo_use', None):
450 if config.get(step) or not step and not built:
451 kwargs = {step: True} if step else {}
452 self._RunStage(stages.BuildPackagesStage, board, archive_stage,
453 config=config, **kwargs)
454 self._RunStage(stages.BuildImageStage, board, archive_stage,
455 config=config, **kwargs)
456 if step == 'pgo_generate':
457 suite = cbuildbot_config.PGORecordTest()
458 self._RunStage(stages.HWTestStage, board, archive_stage,
459 suite, config=config)
460 built = True
David James58e0c092012-03-04 20:31:12 -0800461
David James944a48e2012-03-07 12:19:03 -0800462 # Kick off task(board) in the background.
David James565bc9a2013-04-08 14:54:45 -0700463 queue.put([board, compilecheck])
David James58e0c092012-03-04 20:31:12 -0800464
Brian Harring3fec5a82012-03-01 05:57:03 -0800465
466class DistributedBuilder(SimpleBuilder):
467 """Build class that has special logic to handle distributed builds.
468
469 These builds sync using git/manifest logic in manifest_versions. In general
470 they use a non-distributed builder code for the bulk of the work.
471 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700472 def __init__(self, *args, **kwargs):
Brian Harring3fec5a82012-03-01 05:57:03 -0800473 """Initializes a buildbot builder.
474
475 Extra variables:
476 completion_stage_class: Stage used to complete a build. Set in the Sync
477 stage.
478 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700479 super(DistributedBuilder, self).__init__(*args, **kwargs)
Brian Harring3fec5a82012-03-01 05:57:03 -0800480 self.completion_stage_class = None
David Jamesf421c6d2013-04-11 15:37:57 -0700481 self.sync_stage = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800482
483 def GetSyncInstance(self):
484 """Syncs the tree using one of the distributed sync logic paths.
485
486 Returns: the instance of the sync stage that was run.
487 """
488 # Determine sync class to use. CQ overrides PFQ bits so should check it
489 # first.
David Jamesf421c6d2013-04-11 15:37:57 -0700490 if self.build_config['pre_cq'] or self.options.pre_cq:
491 sync_stage = self._GetStageInstance(stages.PreCQSyncStage,
492 self.patch_pool.gerrit_patches)
493 self.completion_stage_class = stages.PreCQCompletionStage
494 self.patch_pool.gerrit_patches = []
495 elif cbuildbot_config.IsCQType(self.build_config['build_type']):
Brian Harring3fec5a82012-03-01 05:57:03 -0800496 sync_stage = self._GetStageInstance(stages.CommitQueueSyncStage)
497 self.completion_stage_class = stages.CommitQueueCompletionStage
498 elif cbuildbot_config.IsPFQType(self.build_config['build_type']):
499 sync_stage = self._GetStageInstance(stages.LKGMCandidateSyncStage)
500 self.completion_stage_class = stages.LKGMCandidateSyncCompletionStage
501 else:
502 sync_stage = self._GetStageInstance(stages.ManifestVersionedSyncStage)
503 self.completion_stage_class = stages.ManifestVersionedSyncCompletionStage
504
David Jamesf421c6d2013-04-11 15:37:57 -0700505 self.sync_stage = sync_stage
506 return self.sync_stage
Brian Harring3fec5a82012-03-01 05:57:03 -0800507
508 def Publish(self, was_build_successful):
509 """Completes build by publishing any required information."""
510 completion_stage = self._GetStageInstance(self.completion_stage_class,
David Jamesf421c6d2013-04-11 15:37:57 -0700511 self.sync_stage,
Brian Harring3fec5a82012-03-01 05:57:03 -0800512 was_build_successful)
513 completion_stage.Run()
514 name = completion_stage.name
David Jamesf421c6d2013-04-11 15:37:57 -0700515 if (self.build_config['pre_cq'] or self.options.pre_cq or
516 not results_lib.Results.WasStageSuccessful(name)):
Brian Harring3fec5a82012-03-01 05:57:03 -0800517 should_publish_changes = False
518 else:
519 should_publish_changes = (self.build_config['master'] and
520 was_build_successful)
521
522 if should_publish_changes:
523 self._RunStage(stages.PublishUprevChangesStage)
524
525 def RunStages(self):
526 """Runs simple builder logic and publishes information to overlays."""
527 was_build_successful = False
528 try:
David Jamesf55709e2012-03-13 09:10:15 -0700529 super(DistributedBuilder, self).RunStages()
530 was_build_successful = results_lib.Results.BuildSucceededSoFar()
Brian Harring3fec5a82012-03-01 05:57:03 -0800531 except SystemExit as ex:
532 # If a stage calls sys.exit(0), it's exiting with success, so that means
533 # we should mark ourselves as successful.
534 if ex.code == 0:
535 was_build_successful = True
536 raise
537 finally:
538 self.Publish(was_build_successful)
539
Brian Harring3fec5a82012-03-01 05:57:03 -0800540
541def _ConfirmBuildRoot(buildroot):
542 """Confirm with user the inferred buildroot, and mark it as confirmed."""
Brian Harring521e7242012-11-01 16:57:42 -0700543 cros_build_lib.Warning('Using default directory %s as buildroot', buildroot)
544 if not cros_build_lib.BooleanPrompt(default=False):
545 print('Please specify a different buildroot via the --buildroot option.')
Brian Harring3fec5a82012-03-01 05:57:03 -0800546 sys.exit(0)
547
548 if not os.path.exists(buildroot):
549 os.mkdir(buildroot)
550
551 repository.CreateTrybotMarker(buildroot)
552
553
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700554def _ConfirmRemoteBuildbotRun():
555 """Confirm user wants to run with --buildbot --remote."""
Brian Harring521e7242012-11-01 16:57:42 -0700556 cros_build_lib.Warning(
557 'You are about to launch a PRODUCTION job! This is *NOT* a '
558 'trybot run! Are you sure?')
559 if not cros_build_lib.BooleanPrompt(default=False):
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700560 print('Please specify --pass-through="--debug".')
561 sys.exit(0)
562
563
Ryan Cui5ba7e152012-05-10 14:36:52 -0700564def _DetermineDefaultBuildRoot(sourceroot, internal_build):
Brian Harring3fec5a82012-03-01 05:57:03 -0800565 """Default buildroot to be under the directory that contains current checkout.
566
567 Arguments:
568 internal_build: Whether the build is an internal build
Ryan Cui5ba7e152012-05-10 14:36:52 -0700569 sourceroot: Use specified sourceroot.
Brian Harring3fec5a82012-03-01 05:57:03 -0800570 """
Ryan Cui5ba7e152012-05-10 14:36:52 -0700571 if not repository.IsARepoRoot(sourceroot):
Brian Harring1b8c4c82012-05-29 23:03:04 -0700572 cros_build_lib.Die(
573 'Could not find root of local checkout at %s. Please specify '
574 'using the --sourceroot option.' % sourceroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800575
576 # Place trybot buildroot under the directory containing current checkout.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700577 top_level = os.path.dirname(os.path.realpath(sourceroot))
Brian Harring3fec5a82012-03-01 05:57:03 -0800578 if internal_build:
579 buildroot = os.path.join(top_level, _DEFAULT_INT_BUILDROOT)
580 else:
581 buildroot = os.path.join(top_level, _DEFAULT_EXT_BUILDROOT)
582
583 return buildroot
584
585
Mike Frysinger6903c762012-12-04 01:57:16 -0500586def _DisableYamaHardLinkChecks():
587 """Disable Yama kernel hardlink security checks.
588
589 The security module disables hardlinking to files you do not have
590 write access to which causes some of our build scripts problems.
591 Disable it so we don't have to worry about it.
592 """
593 PROC_PATH = '/proc/sys/kernel/yama/protected_nonaccess_hardlinks'
594 SYSCTL_PATH = PROC_PATH[len('/proc/sys/'):].replace('/', '.')
595
596 # Yama not available in this system -- nothing to do.
597 if not os.path.exists(PROC_PATH):
598 return
599
600 # Already disabled -- nothing to do.
601 if osutils.ReadFile(PROC_PATH).strip() == '0':
602 return
603
604 # Create a hardlink in a tempdir and see if we get back EPERM.
David James4bc13702013-03-26 08:08:04 -0700605 with osutils.TempDir() as tempdir:
Mike Frysinger6903c762012-12-04 01:57:16 -0500606 try:
607 os.link('/bin/sh', os.path.join(tempdir, 'sh'))
608 except OSError as e:
609 if e.errno == errno.EPERM:
610 cros_build_lib.Warning('Disabling Yama hardlink security')
611 cros_build_lib.SudoRunCommand(['sysctl', '%s=0' % SYSCTL_PATH])
612
613
Brian Harring3fec5a82012-03-01 05:57:03 -0800614def _BackupPreviousLog(log_file, backup_limit=25):
615 """Rename previous log.
616
617 Args:
618 log_file: The absolute path to the previous log.
619 """
620 if os.path.exists(log_file):
621 old_logs = sorted(glob.glob(log_file + '.*'),
622 key=distutils.version.LooseVersion)
623
624 if len(old_logs) >= backup_limit:
625 os.remove(old_logs[0])
626
627 last = 0
628 if old_logs:
629 last = int(old_logs.pop().rpartition('.')[2])
630
631 os.rename(log_file, log_file + '.' + str(last + 1))
632
Ryan Cui5616a512012-08-17 13:39:36 -0700633
David James944a48e2012-03-07 12:19:03 -0800634def _RunBuildStagesWrapper(options, build_config):
Brian Harring3fec5a82012-03-01 05:57:03 -0800635 """Helper function that wraps RunBuildStages()."""
636 def IsDistributedBuilder():
637 """Determines whether the build_config should be a DistributedBuilder."""
David Jamesf421c6d2013-04-11 15:37:57 -0700638 if build_config['pre_cq'] or options.pre_cq:
639 return True
640 elif not options.buildbot:
Brian Harring3fec5a82012-03-01 05:57:03 -0800641 return False
642 elif build_config['build_type'] in _DISTRIBUTED_TYPES:
Brian Harring3fec5a82012-03-01 05:57:03 -0800643 # We don't do distributed logic to TOT Chrome PFQ's, nor local
644 # chrome roots (e.g. chrome try bots)
645 if chrome_rev not in [constants.CHROME_REV_TOT,
646 constants.CHROME_REV_LOCAL,
647 constants.CHROME_REV_SPEC]:
648 return True
649
650 return False
651
Brian Harring1b8c4c82012-05-29 23:03:04 -0700652 cros_build_lib.Info("cbuildbot executed with args %s"
653 % ' '.join(map(repr, sys.argv)))
Brian Harring3fec5a82012-03-01 05:57:03 -0800654
David Jamesa0a664e2013-02-13 09:52:01 -0800655 chrome_rev = build_config['chrome_rev']
656 if options.chrome_rev:
657 chrome_rev = options.chrome_rev
658 if chrome_rev == constants.CHROME_REV_TOT:
659 # Build the TOT Chrome revision.
660 svn_url = gclient.GetBaseURLs()[0]
661 options.chrome_version = gclient.GetTipOfTrunkSvnRevision(svn_url)
662 options.chrome_rev = constants.CHROME_REV_SPEC
663
David James4a404a52013-02-19 13:07:59 -0800664 # If it's likely we'll need to build Chrome, fetch the source.
Mike Frysingerf4d9ab82013-03-05 19:38:05 -0500665 if build_config['sync_chrome'] is None:
666 options.managed_chrome = (chrome_rev != constants.CHROME_REV_LOCAL and
667 (not build_config['usepkg_build_packages'] or chrome_rev or
668 build_config['useflags'] or build_config['profile'] or
669 options.rietveld_patches))
670 else:
671 options.managed_chrome = build_config['sync_chrome']
David James2333c182013-02-13 16:16:15 -0800672
673 if options.managed_chrome:
674 # Tell Chrome to fetch the source locally.
675 internal = constants.USE_CHROME_INTERNAL in (build_config['useflags'] or [])
676 chrome_src = 'chrome-src-internal' if internal else 'chrome-src'
677 options.chrome_root = os.path.join(options.cache_dir, 'distfiles', 'target',
678 chrome_src)
David James9e27e662013-02-14 13:42:43 -0800679 elif options.rietveld_patches:
David James4a404a52013-02-19 13:07:59 -0800680 cros_build_lib.Die('This builder does not support Rietveld patches.')
David James2333c182013-02-13 16:16:15 -0800681
Ryan Cuif7f24692012-05-18 16:35:33 -0700682 target = DistributedBuilder if IsDistributedBuilder() else SimpleBuilder
Ryan Cuie1e4e662012-05-21 16:39:46 -0700683 buildbot = target(options, build_config)
Brian Harringd166aaf2012-05-14 18:31:53 -0700684 if not buildbot.Run():
685 sys.exit(1)
Brian Harring3fec5a82012-03-01 05:57:03 -0800686
687
688# Parser related functions
Ryan Cui5ba7e152012-05-10 14:36:52 -0700689def _CheckLocalPatches(sourceroot, local_patches):
Brian Harring3fec5a82012-03-01 05:57:03 -0800690 """Do an early quick check of the passed-in patches.
691
692 If the branch of a project is not specified we append the current branch the
693 project is on.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700694
695 Args:
696 sourceroot: The checkout where patches are coming from.
Brian Harring3fec5a82012-03-01 05:57:03 -0800697 """
Ryan Cuicedd8a52012-03-22 02:28:35 -0700698 verified_patches = []
David James97d95872012-11-16 15:09:56 -0800699 manifest = git.ManifestCheckout.Cached(sourceroot)
Ryan Cuicedd8a52012-03-22 02:28:35 -0700700 for patch in local_patches:
Brian Harring3fec5a82012-03-01 05:57:03 -0800701 components = patch.split(':')
702 if len(components) > 2:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700703 cros_build_lib.Die(
704 'Specify local patches in project[:branch] format. Got %s' % patch)
Brian Harring3fec5a82012-03-01 05:57:03 -0800705
706 # validate project
707 project = components[0]
Brian Harring3fec5a82012-03-01 05:57:03 -0800708
Brian Harring609dc4e2012-05-07 02:17:44 -0700709 try:
710 project_dir = manifest.GetProjectPath(project, True)
711 except KeyError:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700712 cros_build_lib.Die('Project %s does not exist.' % project)
Brian Harring3fec5a82012-03-01 05:57:03 -0800713
714 # If no branch was specified, we use the project's current branch.
715 if len(components) == 1:
David James97d95872012-11-16 15:09:56 -0800716 branch = git.GetCurrentBranch(project_dir)
Brian Harring3fec5a82012-03-01 05:57:03 -0800717 if not branch:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700718 cros_build_lib.Die('Project %s is not on a branch!' % project)
Brian Harring3fec5a82012-03-01 05:57:03 -0800719 else:
720 branch = components[1]
David James97d95872012-11-16 15:09:56 -0800721 if not git.DoesLocalBranchExist(project_dir, branch):
Brian Harring1b8c4c82012-05-29 23:03:04 -0700722 cros_build_lib.Die('Project %s does not have branch %s'
723 % (project, branch))
Brian Harring3fec5a82012-03-01 05:57:03 -0800724
Brian Harring609dc4e2012-05-07 02:17:44 -0700725 verified_patches.append('%s:%s' % (project, branch))
Brian Harring3fec5a82012-03-01 05:57:03 -0800726
Ryan Cuicedd8a52012-03-22 02:28:35 -0700727 return verified_patches
Brian Harring3fec5a82012-03-01 05:57:03 -0800728
729
Brian Harring3fec5a82012-03-01 05:57:03 -0800730def _CheckChromeVersionOption(_option, _opt_str, value, parser):
731 """Upgrade other options based on chrome_version being passed."""
732 value = value.strip()
733
734 if parser.values.chrome_rev is None and value:
735 parser.values.chrome_rev = constants.CHROME_REV_SPEC
736
737 parser.values.chrome_version = value
738
739
740def _CheckChromeRootOption(_option, _opt_str, value, parser):
741 """Validate and convert chrome_root to full-path form."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800742 if parser.values.chrome_rev is None:
743 parser.values.chrome_rev = constants.CHROME_REV_LOCAL
744
Ryan Cui5ba7e152012-05-10 14:36:52 -0700745 parser.values.chrome_root = value
Brian Harring3fec5a82012-03-01 05:57:03 -0800746
747
748def _CheckChromeRevOption(_option, _opt_str, value, parser):
749 """Validate the chrome_rev option."""
750 value = value.strip()
751 if value not in constants.VALID_CHROME_REVISIONS:
752 raise optparse.OptionValueError('Invalid chrome rev specified')
753
754 parser.values.chrome_rev = value
755
756
David Jamesac8c2a72013-02-13 18:44:33 -0800757def FindCacheDir(_parser, _options):
Brian Harringae0a5322012-09-15 01:46:51 -0700758 return None
759
760
Ryan Cui5ba7e152012-05-10 14:36:52 -0700761class CustomGroup(optparse.OptionGroup):
762 def add_remote_option(self, *args, **kwargs):
763 """For arguments that are passed-through to remote trybot."""
764 return optparse.OptionGroup.add_option(self, *args,
765 remote_pass_through=True,
766 **kwargs)
767
768
Ryan Cui1c13a252012-10-16 15:00:16 -0700769class CustomOption(commandline.FilteringOption):
770 """Subclass FilteringOption class to implement pass-through and api."""
Ryan Cui5ba7e152012-05-10 14:36:52 -0700771
Ryan Cui1c13a252012-10-16 15:00:16 -0700772 ACTIONS = commandline.FilteringOption.ACTIONS + ('extend',)
773 STORE_ACTIONS = commandline.FilteringOption.STORE_ACTIONS + ('extend',)
774 TYPED_ACTIONS = commandline.FilteringOption.TYPED_ACTIONS + ('extend',)
775 ALWAYS_TYPED_ACTIONS = (commandline.FilteringOption.ALWAYS_TYPED_ACTIONS +
776 ('extend',))
Ryan Cui79319ab2012-05-21 12:59:18 -0700777
Ryan Cui5ba7e152012-05-10 14:36:52 -0700778 def __init__(self, *args, **kwargs):
779 # The remote_pass_through argument specifies whether we should directly
780 # pass the argument (with its value) onto the remote trybot.
781 self.pass_through = kwargs.pop('remote_pass_through', False)
Ryan Cui1c13a252012-10-16 15:00:16 -0700782 self.api_version = int(kwargs.pop('api', '0'))
783 commandline.FilteringOption.__init__(self, *args, **kwargs)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700784
785 def take_action(self, action, dest, opt, value, values, parser):
Ryan Cui79319ab2012-05-21 12:59:18 -0700786 if action == 'extend':
Mike Frysingerd6925b52012-07-16 16:11:00 -0400787 # If there is extra spaces between each argument, we get '' which later
788 # code barfs on, so skip those. e.g. We see this with the forms:
789 # cbuildbot -p 'proj:branch ' ...
790 # cbuildbot -p ' proj:branch' ...
791 # cbuildbot -p 'proj:branch proj2:branch' ...
792 lvalue = value.split()
Ryan Cui79319ab2012-05-21 12:59:18 -0700793 values.ensure_value(dest, []).extend(lvalue)
Ryan Cui79319ab2012-05-21 12:59:18 -0700794
Ryan Cui1c13a252012-10-16 15:00:16 -0700795 commandline.FilteringOption.take_action(
796 self, action, dest, opt, value, values, parser)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700797
798
Ryan Cui1c13a252012-10-16 15:00:16 -0700799class CustomParser(commandline.FilteringParser):
Brian Harringb6cf9142012-09-01 20:43:17 -0700800
801 DEFAULT_OPTION_CLASS = CustomOption
802
803 def add_remote_option(self, *args, **kwargs):
804 """For arguments that are passed-through to remote trybot."""
Ryan Cui1c13a252012-10-16 15:00:16 -0700805 return self.add_option(*args, remote_pass_through=True, **kwargs)
Brian Harringb6cf9142012-09-01 20:43:17 -0700806
807
Brian Harring3fec5a82012-03-01 05:57:03 -0800808def _CreateParser():
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700809 """Generate and return the parser with all the options."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800810 # Parse options
811 usage = "usage: %prog [options] buildbot_config"
Brian Harringae0a5322012-09-15 01:46:51 -0700812 parser = CustomParser(usage=usage, caching=FindCacheDir)
Brian Harring3fec5a82012-03-01 05:57:03 -0800813
814 # Main options
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400815 parser.add_option('-l', '--list', action='store_true', dest='list',
816 default=False,
817 help='List the suggested trybot configs to use (see --all)')
Brian Harring3fec5a82012-03-01 05:57:03 -0800818 parser.add_option('-a', '--all', action='store_true', dest='print_all',
819 default=False,
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400820 help='List all of the buildbot configs available w/--list')
821
822 parser.add_option('--local', default=False, action='store_true',
823 help='Specifies that this tryjob should be run locally')
824 parser.add_option('--remote', default=False, action='store_true',
825 help='Specifies that this tryjob should be run remotely')
826
Ryan Cuie1e4e662012-05-21 16:39:46 -0700827 parser.add_remote_option('-b', '--branch',
828 help='The manifest branch to test. The branch to '
829 'check the buildroot out to.')
Ryan Cui5ba7e152012-05-10 14:36:52 -0700830 parser.add_option('-r', '--buildroot', dest='buildroot', type='path',
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700831 help='Root directory where source is checked out to, and '
832 'where the build occurs. For external build configs, '
833 "defaults to 'trybot' directory at top level of your "
834 'repo-managed checkout.')
835 parser.add_remote_option('--chrome_rev', default=None, type='string',
836 action='callback', dest='chrome_rev',
837 callback=_CheckChromeRevOption,
838 help=('Revision of Chrome to use, of type [%s]'
839 % '|'.join(constants.VALID_CHROME_REVISIONS)))
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700840 parser.add_remote_option('--profile', default=None, type='string',
841 action='store', dest='profile',
842 help='Name of profile to sub-specify board variant.')
Brian Harring3fec5a82012-03-01 05:57:03 -0800843
Ryan Cuif4f84be2012-07-09 18:50:41 -0700844 #
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400845 # Patch selection options.
846 #
847
848 group = CustomGroup(
849 parser,
850 'Patch Options')
851
852 group.add_remote_option('-g', '--gerrit-patches', action='extend',
853 default=[], type='string',
854 metavar="'Id1 *int_Id2...IdN'",
855 help="Space-separated list of short-form Gerrit "
856 "Change-Id's or change numbers to patch. "
857 "Please prepend '*' to internal Change-Id's")
858 group.add_remote_option('-G', '--rietveld-patches', action='extend',
859 default=[], type='string',
860 metavar="'id1[:subdir1]...idN[:subdirN]'",
861 help='Space-separated list of short-form Rietveld '
862 'issue numbers to patch. If no subdir is '
863 'specified, the src directory is used.')
864 group.add_option('-p', '--local-patches', action='extend', default=[],
865 metavar="'<project1>[:<branch1>]...<projectN>[:<branchN>]'",
866 help='Space-separated list of project branches with '
867 'patches to apply. Projects are specified by name. '
868 'If no branch is specified the current branch of the '
869 'project will be used.')
870
871 parser.add_option_group(group)
872
873 #
874 # Remote trybot options.
875 #
876
877 group = CustomGroup(
878 parser,
879 'Remote Trybot Options (--remote)')
880
881 group.add_remote_option('--hwtest', dest='hwtest', action='store_true',
882 default=False,
883 help='Run the HWTest stage (tests on real hardware)')
884 group.add_option('--remote-description', default=None,
885 help='Attach an optional description to a --remote run '
886 'to make it easier to identify the results when it '
887 'finishes')
888 group.add_option('--slaves', action='extend', default=[],
889 help='Specify specific remote tryslaves to run on (e.g. '
890 'build149-m2); if the bot is busy, it will be queued')
891 group.add_option('--test-tryjob', action='store_true',
892 default=False,
893 help='Submit a tryjob to the test repository. Will not '
894 'show up on the production trybot waterfall.')
895
896 parser.add_option_group(group)
897
898 #
899 # Advanced options.
Ryan Cuif4f84be2012-07-09 18:50:41 -0700900 #
901
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700902 group = CustomGroup(
Brian Harring3fec5a82012-03-01 05:57:03 -0800903 parser,
904 'Advanced Options',
905 'Caution: use these options at your own risk.')
906
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400907 group.add_remote_option('--bootstrap-args', action='append', default=[],
908 help='Args passed directly to the bootstrap re-exec '
909 'to skip verification by the bootstrap code')
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700910 group.add_remote_option('--buildbot', dest='buildbot', action='store_true',
911 default=False, help='This is running on a buildbot')
912 group.add_remote_option('--buildnumber', help='build number', type='int',
913 default=0)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700914 group.add_option('--chrome_root', default=None, type='path',
915 action='callback', callback=_CheckChromeRootOption,
916 dest='chrome_root', help='Local checkout of Chrome to use.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700917 group.add_remote_option('--chrome_version', default=None, type='string',
918 action='callback', dest='chrome_version',
919 callback=_CheckChromeVersionOption,
920 help='Used with SPEC logic to force a particular SVN '
921 'revision of chrome rather than the latest.')
922 group.add_remote_option('--clobber', action='store_true', dest='clobber',
923 default=False,
924 help='Clears an old checkout before syncing')
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400925 group.add_remote_option('--latest-toolchain', action='store_true',
926 default=False,
927 help='Use the latest toolchain.')
Ryan Cui5ba7e152012-05-10 14:36:52 -0700928 parser.add_option('--log_dir', dest='log_dir', type='path',
Brian Harring3fec5a82012-03-01 05:57:03 -0800929 help=('Directory where logs are stored.'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700930 group.add_remote_option('--maxarchives', dest='max_archive_builds',
931 default=3, type='int',
932 help="Change the local saved build count limit.")
Ryan Cuibbd3d4b2012-08-17 12:20:37 -0700933 parser.add_remote_option('--manifest-repo-url',
934 help=('Overrides the default manifest repo url.'))
David James565bc9a2013-04-08 14:54:45 -0700935 group.add_remote_option('--compilecheck', action='store_true', default=False,
936 help='Only verify compilation and unit tests.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700937 group.add_remote_option('--noarchive', action='store_false', dest='archive',
938 default=True, help="Don't run archive stage.")
Ryan Cuif7f24692012-05-18 16:35:33 -0700939 group.add_remote_option('--nobootstrap', action='store_false',
940 dest='bootstrap', default=True,
941 help="Don't checkout and run from a standalone "
942 "chromite repo.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700943 group.add_remote_option('--nobuild', action='store_false', dest='build',
944 default=True,
945 help="Don't actually build (for cbuildbot dev)")
946 group.add_remote_option('--noclean', action='store_false', dest='clean',
947 default=True, help="Don't clean the buildroot")
Ryan Cuif7f24692012-05-18 16:35:33 -0700948 group.add_remote_option('--nocgroups', action='store_false', dest='cgroups',
949 default=True,
950 help='Disable cbuildbots usage of cgroups.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700951 group.add_remote_option('--noprebuilts', action='store_false',
952 dest='prebuilts', default=True,
953 help="Don't upload prebuilts.")
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400954 group.add_remote_option('--nosdk', action='store_true',
955 default=False,
956 help='Re-create the SDK from scratch.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700957 group.add_remote_option('--nosync', action='store_false', dest='sync',
958 default=True, help="Don't sync before building.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700959 group.add_remote_option('--notests', action='store_false', dest='tests',
960 default=True,
961 help='Override values from buildconfig and run no '
962 'tests.')
963 group.add_remote_option('--nouprev', action='store_false', dest='uprev',
964 default=True,
965 help='Override values from buildconfig and never '
966 'uprev.')
Brian Harring3fec5a82012-03-01 05:57:03 -0800967 group.add_option('--reference-repo', action='store', default=None,
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700968 dest='reference_repo',
969 help='Reuse git data stored in an existing repo '
970 'checkout. This can drastically reduce the network '
971 'time spent setting up the trybot checkout. By '
972 "default, if this option isn't given but cbuildbot "
973 'is invoked from a repo checkout, cbuildbot will '
974 'use the repo root.')
Ryan Cuicedd8a52012-03-22 02:28:35 -0700975 group.add_option('--resume', action='store_true', default=False,
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700976 help='Skip stages already successfully completed.')
977 group.add_remote_option('--timeout', action='store', type='int', default=0,
978 help='Specify the maximum amount of time this job '
979 'can run for, at which point the build will be '
980 'aborted. If set to zero, then there is no '
981 'timeout.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700982 group.add_remote_option('--version', dest='force_version', default=None,
983 help='Used with manifest logic. Forces use of this '
984 'version rather than create or get latest.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400985
986 parser.add_option_group(group)
987
988 #
989 # Internal options.
990 #
991
992 group = CustomGroup(
993 parser,
994 'Internal ChromeOS Build Team Options',
995 'Caution: these are for meant for the ChromeOS build team only')
996
997 group.add_remote_option('--archive-base', type='gs_path',
998 help='Base GS URL (gs://<bucket_name>/<path>) to '
999 'upload archive artifacts to')
Brian Harringab8fb5c2012-07-18 11:28:22 -07001000 group.add_remote_option('--cq-gerrit-query', dest='cq_gerrit_override',
1001 default=None,
1002 help=
1003 "If given, this gerrit query will be used to find what patches to test, "
Brian Harringc5cabfe2012-12-19 01:04:44 -08001004 "rather than the normal 'CommitQueue=1 AND Verified=1 AND CodeReview=2' "
Brian Harringab8fb5c2012-07-18 11:28:22 -07001005 "query it defaults to. Use with care- note additionally this setting "
1006 "only has an effect if the buildbot target is a cq target, and we're "
1007 "in buildbot mode.")
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001008 group.add_option('--pass-through', dest='pass_through_args', action='append',
1009 type='string', default=[])
David Jamesf421c6d2013-04-11 15:37:57 -07001010 group.add_remote_option('--pre-cq', action='store_true', default=False,
1011 help='Mark CLs as tested by the PreCQ on success.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001012 group.add_option('--reexec-api-version', dest='output_api_version',
Ryan Cuif4f84be2012-07-09 18:50:41 -07001013 action='store_true', default=False,
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001014 help='Used for handling forwards/backwards compatibility '
1015 'with --resume and --bootstrap')
1016 group.add_option('--remote-trybot', dest='remote_trybot',
1017 action='store_true', default=False,
1018 help='Indicates this is running on a remote trybot machine')
1019 group.add_remote_option('--remote-patches', action='extend', default=[],
1020 help='Patches uploaded by the trybot client when run '
1021 'using the -p option')
Brian Harringf611e6e2012-07-17 18:47:44 -07001022 # Note the default here needs to be hardcoded to 3; that is the last version
1023 # that lacked this functionality.
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001024 group.add_option('--remote-version', default=3, type=int, action='store',
1025 help='Used for compatibility checks w/tryjobs running in '
1026 'older chromite instances')
1027 group.add_option('--sourceroot', type='path', default=constants.SOURCE_ROOT)
1028 group.add_remote_option('--test-bootstrap', action='store_true',
1029 default=False,
1030 help='Causes cbuildbot to bootstrap itself twice, in '
1031 'the sequence A->B->C: A(unpatched) patches and '
1032 'bootstraps B; B patches and bootstraps C')
1033 group.add_remote_option('--validation_pool', default=None,
1034 help='Path to a pickled validation pool. Intended '
1035 'for use only with the commit queue.')
1036
1037 parser.add_option_group(group)
Ryan Cuif4f84be2012-07-09 18:50:41 -07001038
1039 #
Brian Harring3fec5a82012-03-01 05:57:03 -08001040 # Debug options
Ryan Cuif4f84be2012-07-09 18:50:41 -07001041 #
Brian Harringfec89fe2012-09-23 07:30:54 -07001042 # Temporary hack; in place till --dry-run replaces --debug.
1043 # pylint: disable=W0212
Brian Harring009db502012-10-10 02:21:37 -07001044 group = parser.debug_group
Brian Harringfec89fe2012-09-23 07:30:54 -07001045 debug = [x for x in group.option_list if x._long_opts == ['--debug']][0]
1046 debug.help += " Currently functions as --dry-run in addition."
1047 debug.pass_through = True
Brian Harring3fec5a82012-03-01 05:57:03 -08001048 group.add_option('--dump_config', action='store_true', dest='dump_config',
1049 default=False,
1050 help='Dump out build config options, and exit.')
1051 group.add_option('--notee', action='store_false', dest='tee', default=True,
1052 help="Disable logging and internal tee process. Primarily "
1053 "used for debugging cbuildbot itself.")
Brian Harring3fec5a82012-03-01 05:57:03 -08001054 return parser
1055
1056
Ryan Cui85867972012-02-23 18:21:49 -08001057def _FinishParsing(options, args):
1058 """Perform some parsing tasks that need to take place after optparse.
1059
1060 This function needs to be easily testable! Keep it free of
1061 environment-dependent code. Put more detailed usage validation in
1062 _PostParseCheck().
Brian Harring3fec5a82012-03-01 05:57:03 -08001063
1064 Args:
Ryan Cui85867972012-02-23 18:21:49 -08001065 options, args: The options/args object returned by optparse
Brian Harring3fec5a82012-03-01 05:57:03 -08001066 """
Ryan Cui41023d92012-11-13 19:59:50 -08001067 # Populate options.pass_through_args.
1068 accepted, _ = commandline.FilteringParser.FilterArgs(
1069 options.parsed_args, lambda x: x.opt_inst.pass_through)
1070 options.pass_through_args.extend(accepted)
Brian Harring07039b52012-05-13 17:56:47 -07001071
Brian Harring3fec5a82012-03-01 05:57:03 -08001072 if options.chrome_root:
1073 if options.chrome_rev != constants.CHROME_REV_LOCAL:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001074 cros_build_lib.Die('Chrome rev must be %s if chrome_root is set.' %
1075 constants.CHROME_REV_LOCAL)
David Jamesa0a664e2013-02-13 09:52:01 -08001076 elif options.chrome_rev == constants.CHROME_REV_LOCAL:
1077 cros_build_lib.Die('Chrome root must be set if chrome_rev is %s.' %
1078 constants.CHROME_REV_LOCAL)
Brian Harring3fec5a82012-03-01 05:57:03 -08001079
1080 if options.chrome_version:
1081 if options.chrome_rev != constants.CHROME_REV_SPEC:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001082 cros_build_lib.Die('Chrome rev must be %s if chrome_version is set.' %
1083 constants.CHROME_REV_SPEC)
David Jamesa0a664e2013-02-13 09:52:01 -08001084 elif options.chrome_rev == constants.CHROME_REV_SPEC:
1085 cros_build_lib.Die(
1086 'Chrome rev must not be %s if chrome_version is not set.'
1087 % constants.CHROME_REV_SPEC)
Brian Harring3fec5a82012-03-01 05:57:03 -08001088
David James9e27e662013-02-14 13:42:43 -08001089 patches = bool(options.gerrit_patches or options.local_patches or
1090 options.rietveld_patches)
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001091 if options.remote:
1092 if options.local:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001093 cros_build_lib.Die('Cannot specify both --remote and --local')
Ryan Cui54da0702012-04-19 18:38:08 -07001094
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001095 if not options.buildbot and not patches:
Brian Harring7cc4b932012-11-01 16:58:55 -07001096 if not cros_build_lib.BooleanPrompt(
1097 prompt="No patches were provided; are you sure you want to just "
1098 "run a remote build of ToT?", default=False):
1099 cros_build_lib.Die('Must provide patches when running with --remote.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001100
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001101 # --debug needs to be explicitly passed through for remote invocations.
1102 release_mode_with_patches = (options.buildbot and patches and
1103 '--debug' not in options.pass_through_args)
1104 else:
1105 if len(args) > 1:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001106 cros_build_lib.Die('Multiple configs not supported if not running with '
Brian Harringf1aad832012-07-18 10:46:39 -07001107 '--remote. Got %r', args)
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001108
Ryan Cui79319ab2012-05-21 12:59:18 -07001109 if options.slaves:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001110 cros_build_lib.Die('Cannot use --slaves if not running with --remote.')
Ryan Cui79319ab2012-05-21 12:59:18 -07001111
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001112 release_mode_with_patches = (options.buildbot and patches and
1113 not options.debug)
1114
David James5734ea32012-08-15 20:23:49 -07001115 # When running in release mode, make sure we are running with checked-in code.
1116 # We want checked-in cbuildbot/scripts to prevent errors, and we want to build
1117 # a release image with checked-in code for CrOS packages.
1118 if release_mode_with_patches:
1119 cros_build_lib.Die(
1120 'Cannot provide patches when running with --buildbot!')
1121
Ryan Cuiba41ad32012-03-08 17:15:29 -08001122 if options.buildbot and options.remote_trybot:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001123 cros_build_lib.Die(
1124 '--buildbot and --remote-trybot cannot be used together.')
Ryan Cuiba41ad32012-03-08 17:15:29 -08001125
Ryan Cui85867972012-02-23 18:21:49 -08001126 # Record whether --debug was set explicitly vs. it was inferred.
1127 options.debug_forced = False
1128 if options.debug:
1129 options.debug_forced = True
1130 else:
Ryan Cui16ca5812012-03-08 20:34:27 -08001131 # We don't set debug by default for
1132 # 1. --buildbot invocations.
1133 # 2. --remote invocations, because it needs to push changes to the tryjob
1134 # repo.
1135 options.debug = not options.buildbot and not options.remote
Brian Harring3fec5a82012-03-01 05:57:03 -08001136
Ryan Cui1c13a252012-10-16 15:00:16 -07001137 # Record the configs targeted.
1138 options.build_targets = args[:]
1139
Brian Harring3fec5a82012-03-01 05:57:03 -08001140
Brian Harring1d7ba942012-04-24 06:37:18 -07001141# pylint: disable=W0613
Brian Harringae0a5322012-09-15 01:46:51 -07001142def _PostParseCheck(parser, options, args):
Ryan Cui85867972012-02-23 18:21:49 -08001143 """Perform some usage validation after we've parsed the arguments
Brian Harring3fec5a82012-03-01 05:57:03 -08001144
Ryan Cui85867972012-02-23 18:21:49 -08001145 Args:
1146 options/args: The options/args object returned by optparse
1147 """
Ryan Cuie1e4e662012-05-21 16:39:46 -07001148 if not options.branch:
David James97d95872012-11-16 15:09:56 -08001149 options.branch = git.GetChromiteTrackingBranch()
Ryan Cuie1e4e662012-05-21 16:39:46 -07001150
Brian Harringae0a5322012-09-15 01:46:51 -07001151 if not repository.IsARepoRoot(options.sourceroot):
1152 if options.local_patches:
1153 raise Exception('Could not find repo checkout at %s!'
1154 % options.sourceroot)
1155
David Jamesac8c2a72013-02-13 18:44:33 -08001156 # Because the default cache dir depends on other options, FindCacheDir
1157 # always returns None, and we setup the default here.
Brian Harringae0a5322012-09-15 01:46:51 -07001158 if options.cache_dir is None:
1159 # Note, options.sourceroot is set regardless of the path
1160 # actually existing.
David Jamesac8c2a72013-02-13 18:44:33 -08001161 if options.buildroot is not None:
Brian Harringae0a5322012-09-15 01:46:51 -07001162 options.cache_dir = os.path.join(options.buildroot, '.cache')
David Jamesac8c2a72013-02-13 18:44:33 -08001163 elif os.path.exists(options.sourceroot):
1164 options.cache_dir = os.path.join(options.sourceroot, '.cache')
Brian Harringae0a5322012-09-15 01:46:51 -07001165 else:
1166 options.cache_dir = parser.FindCacheDir(parser, options)
1167 options.cache_dir = os.path.abspath(options.cache_dir)
Brian Harring8c1d7b12012-10-04 17:36:32 -07001168 parser.ConfigureCacheDir(options.cache_dir)
Brian Harringae0a5322012-09-15 01:46:51 -07001169
1170 osutils.SafeMakedirs(options.cache_dir)
Ryan Cui5ba7e152012-05-10 14:36:52 -07001171
Brian Harring609dc4e2012-05-07 02:17:44 -07001172 if options.local_patches:
Brian Harring1d7ba942012-04-24 06:37:18 -07001173 options.local_patches = _CheckLocalPatches(
Brian Harring609dc4e2012-05-07 02:17:44 -07001174 options.sourceroot, options.local_patches)
Brian Harring1d7ba942012-04-24 06:37:18 -07001175
1176 default = os.environ.get('CBUILDBOT_DEFAULT_MODE')
1177 if (default and not any([options.local, options.buildbot,
1178 options.remote, options.remote_trybot])):
Brian Harring1b8c4c82012-05-29 23:03:04 -07001179 cros_build_lib.Info("CBUILDBOT_DEFAULT_MODE=%s env var detected, using it."
1180 % default)
Brian Harring1d7ba942012-04-24 06:37:18 -07001181 default = default.lower()
1182 if default == 'local':
1183 options.local = True
1184 elif default == 'remote':
1185 options.remote = True
1186 elif default == 'buildbot':
1187 options.buildbot = True
1188 else:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001189 cros_build_lib.Die("CBUILDBOT_DEFAULT_MODE value %s isn't supported. "
1190 % default)
Ryan Cui85867972012-02-23 18:21:49 -08001191
1192
1193def _ParseCommandLine(parser, argv):
1194 """Completely parse the commandline arguments"""
Brian Harring3fec5a82012-03-01 05:57:03 -08001195 (options, args) = parser.parse_args(argv)
Brian Harring37e559b2012-05-22 20:47:32 -07001196
1197 if options.output_api_version:
Ryan Cui724f1d32012-10-15 18:10:22 -07001198 print constants.REEXEC_API_VERSION
Brian Harring37e559b2012-05-22 20:47:32 -07001199 sys.exit(0)
1200
Ryan Cui54da0702012-04-19 18:38:08 -07001201 if options.list:
1202 _PrintValidConfigs(options.print_all)
1203 sys.exit(0)
1204
Ryan Cui8be16062012-04-24 12:05:26 -07001205 # Strip out null arguments.
1206 # TODO(rcui): Remove when buildbot is fixed
1207 args = [arg for arg in args if arg]
1208 if not args:
1209 parser.error('Invalid usage. Use -h to see usage. Use -l to list '
1210 'supported configs.')
1211
Ryan Cui85867972012-02-23 18:21:49 -08001212 _FinishParsing(options, args)
1213 return options, args
1214
1215
1216def main(argv):
David James59a0a2b2013-03-22 14:04:44 -07001217 # Turn on strict sudo checks.
1218 cros_build_lib.STRICT_SUDO = True
1219
Ryan Cui85867972012-02-23 18:21:49 -08001220 # Set umask to 022 so files created by buildbot are readable.
1221 os.umask(022)
1222
Ryan Cui85867972012-02-23 18:21:49 -08001223 parser = _CreateParser()
1224 (options, args) = _ParseCommandLine(parser, argv)
Brian Harring3fec5a82012-03-01 05:57:03 -08001225
Brian Harringae0a5322012-09-15 01:46:51 -07001226 _PostParseCheck(parser, options, args)
Brian Harring3fec5a82012-03-01 05:57:03 -08001227
Mike Frysinger8fd67dc2012-12-03 23:51:18 -05001228 cros_build_lib.AssertOutsideChroot()
Zdenek Behan98ec2fb2012-08-31 17:12:18 +02001229
Brian Harring3fec5a82012-03-01 05:57:03 -08001230 if options.remote:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001231 cros_build_lib.logger.setLevel(logging.WARNING)
Ryan Cui16ca5812012-03-08 20:34:27 -08001232
Brian Harring3fec5a82012-03-01 05:57:03 -08001233 # Verify configs are valid.
Aviv Kesheta96a2a92013-02-05 17:21:51 -08001234 # If hwtest flag is enabled, verify that config board is in whitelist.
Brian Harring3fec5a82012-03-01 05:57:03 -08001235 for bot in args:
Aviv Kesheta96a2a92013-02-05 17:21:51 -08001236 build_config = _GetConfig(bot)
1237 if options.hwtest:
1238 if not set(build_config['boards']).issubset(
1239 set(constants.HWTEST_BOARD_WHITELIST)):
1240 cros_build_lib.Die('The test lab is unable to run hwtest tryjobs '
1241 'with the given board(s). The currently '
1242 'supported boards are %s. If you are root '
1243 'causing a critical bug and need temporary '
1244 'support please contact the lab '
1245 'team.' % constants.HWTEST_BOARD_WHITELIST)
Brian Harring3fec5a82012-03-01 05:57:03 -08001246
1247 # Verify gerrit patches are valid.
Ryan Cui16ca5812012-03-08 20:34:27 -08001248 print 'Verifying patches...'
Ryan Cuie1e4e662012-05-21 16:39:46 -07001249 patch_pool = AcquirePoolFromOptions(options)
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001250
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001251 # --debug need to be explicitly passed through for remote invocations.
1252 if options.buildbot and '--debug' not in options.pass_through_args:
1253 _ConfirmRemoteBuildbotRun()
1254
Ryan Cui16ca5812012-03-08 20:34:27 -08001255 print 'Submitting tryjob...'
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001256 tryjob = remote_try.RemoteTryJob(options, args, patch_pool.local_patches)
Ryan Cuia25d8eb2012-07-11 14:54:27 -07001257 tryjob.Submit(testjob=options.test_tryjob, dryrun=False)
Ryan Cui16ca5812012-03-08 20:34:27 -08001258 print 'Tryjob submitted!'
1259 print ('Go to %s to view the status of your job.'
Ryan Cui4906e1c2012-04-03 20:09:34 -07001260 % tryjob.GetTrybotWaterfallLink())
Brian Harring3fec5a82012-03-01 05:57:03 -08001261 sys.exit(0)
Ryan Cui54da0702012-04-19 18:38:08 -07001262 elif (not options.buildbot and not options.remote_trybot
1263 and not options.resume and not options.local):
Brian Harring1b8c4c82012-05-29 23:03:04 -07001264 cros_build_lib.Warning(
1265 'Running in LOCAL TRYBOT mode! Use --remote to submit REMOTE '
1266 'tryjobs. Use --local to suppress this message.')
1267 cros_build_lib.Warning(
Ryan Cui51591352012-07-09 15:15:53 -07001268 'In the future, --local will be required to run the local '
Brian Harring1b8c4c82012-05-29 23:03:04 -07001269 'trybot.')
Ryan Cui54da0702012-04-19 18:38:08 -07001270 time.sleep(5)
Brian Harring3fec5a82012-03-01 05:57:03 -08001271
Ryan Cui8be16062012-04-24 12:05:26 -07001272 # Only expecting one config
1273 bot_id = args[-1]
1274 build_config = _GetConfig(bot_id)
Brian Harring3fec5a82012-03-01 05:57:03 -08001275
1276 if options.reference_repo is None:
Ryan Cui5ba7e152012-05-10 14:36:52 -07001277 repo_path = os.path.join(options.sourceroot, '.repo')
Brian Harring3fec5a82012-03-01 05:57:03 -08001278 # If we're being run from a repo checkout, reuse the repo's git pool to
1279 # cut down on sync time.
1280 if os.path.exists(repo_path):
Ryan Cui5ba7e152012-05-10 14:36:52 -07001281 options.reference_repo = options.sourceroot
Brian Harring3fec5a82012-03-01 05:57:03 -08001282 elif options.reference_repo:
1283 if not os.path.exists(options.reference_repo):
1284 parser.error('Reference path %s does not exist'
1285 % (options.reference_repo,))
1286 elif not os.path.exists(os.path.join(options.reference_repo, '.repo')):
1287 parser.error('Reference path %s does not look to be the base of a '
1288 'repo checkout; no .repo exists in the root.'
1289 % (options.reference_repo,))
Ryan Cuid4a24212012-04-04 18:08:12 -07001290
Brian Harringf11bf682012-05-14 15:53:43 -07001291 if (options.buildbot or options.remote_trybot) and not options.resume:
Brian Harring470f6112012-03-02 11:47:10 -08001292 if not options.cgroups:
Ryan Cuid4a24212012-04-04 18:08:12 -07001293 parser.error('Options --buildbot/--remote-trybot and --nocgroups cannot '
1294 'be used together. Cgroup support is required for '
1295 'buildbot/remote-trybot mode.')
Mike Frysingera78a56e2012-11-20 06:02:30 -05001296 if not cgroups.Cgroup.IsSupported():
Ryan Cuid4a24212012-04-04 18:08:12 -07001297 parser.error('Option --buildbot/--remote-trybot was given, but this '
1298 'system does not support cgroups. Failing.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001299
David Jamesaad5cc72012-10-26 15:03:13 -07001300 missing = osutils.FindMissingBinaries(_BUILDBOT_REQUIRED_BINARIES)
Brian Harring351ce442012-03-09 16:38:14 -08001301 if missing:
Ryan Cuid4a24212012-04-04 18:08:12 -07001302 parser.error("Option --buildbot/--remote-trybot requires the following "
1303 "binaries which couldn't be found in $PATH: %s"
Brian Harring351ce442012-03-09 16:38:14 -08001304 % (', '.join(missing)))
1305
Brian Harring3fec5a82012-03-01 05:57:03 -08001306 if options.reference_repo:
1307 options.reference_repo = os.path.abspath(options.reference_repo)
1308
1309 if options.dump_config:
1310 # This works, but option ordering is bad...
1311 print 'Configuration %s:' % bot_id
1312 pretty_printer = pprint.PrettyPrinter(indent=2)
1313 pretty_printer.pprint(build_config)
1314 sys.exit(0)
1315
1316 if not options.buildroot:
1317 if options.buildbot:
Mike Frysinger6903c762012-12-04 01:57:16 -05001318 parser.error('Please specify a buildroot with the --buildbot option.')
Matt Tennantd55b1f42012-04-13 14:15:01 -07001319
Ryan Cui5ba7e152012-05-10 14:36:52 -07001320 options.buildroot = _DetermineDefaultBuildRoot(options.sourceroot,
1321 build_config['internal'])
Brian Harring470f6112012-03-02 11:47:10 -08001322 # We use a marker file in the buildroot to indicate the user has
1323 # consented to using this directory.
1324 if not os.path.exists(repository.GetTrybotMarkerPath(options.buildroot)):
1325 _ConfirmBuildRoot(options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -08001326
1327 # Sanity check of buildroot- specifically that it's not pointing into the
1328 # midst of an existing repo since git-repo doesn't support nesting.
Brian Harring3fec5a82012-03-01 05:57:03 -08001329 if (not repository.IsARepoRoot(options.buildroot) and
David James6b80dc62012-02-29 15:34:40 -08001330 repository.InARepoRepository(options.buildroot)):
Brian Harring3fec5a82012-03-01 05:57:03 -08001331 parser.error('Configured buildroot %s points into a repository checkout, '
1332 'rather than the root of it. This is not supported.'
1333 % options.buildroot)
1334
Chris Sosab5ea3b42012-10-25 15:25:20 -07001335 if not options.log_dir:
1336 options.log_dir = os.path.join(options.buildroot, _DEFAULT_LOG_DIR)
1337
Brian Harringd166aaf2012-05-14 18:31:53 -07001338 log_file = None
1339 if options.tee:
Chris Sosab5ea3b42012-10-25 15:25:20 -07001340 log_file = os.path.join(options.log_dir, _BUILDBOT_LOG_FILE)
1341 osutils.SafeMakedirs(options.log_dir)
Brian Harringd166aaf2012-05-14 18:31:53 -07001342 _BackupPreviousLog(log_file)
1343
Brian Harring1b8c4c82012-05-29 23:03:04 -07001344 with cros_build_lib.ContextManagerStack() as stack:
Brian Harringc2d09d92012-05-13 22:03:15 -07001345 critical_section = stack.Add(cleanup.EnforcedCleanupSection)
1346 stack.Add(sudo.SudoKeepAlive)
Brian Harringd166aaf2012-05-14 18:31:53 -07001347
Brian Harringc2d09d92012-05-13 22:03:15 -07001348 if not options.resume:
Brian Harring2bf55e12012-05-13 21:31:55 -07001349 # If we're in resume mode, use our parents tempdir rather than
1350 # nesting another layer.
David James4bc13702013-03-26 08:08:04 -07001351 stack.Add(osutils.TempDir, prefix='cbuildbot-tmp', set_global=True)
Brian Harringc2d09d92012-05-13 22:03:15 -07001352 logging.debug("Cbuildbot tempdir is %r.", os.environ.get('TMP'))
Brian Harringd166aaf2012-05-14 18:31:53 -07001353
Brian Harringead69102012-07-31 15:54:07 -07001354 # TODO(ferringb): update this once https://gerrit.chromium.org/gerrit/25359
1355 # is landed- it's sensitive to the manifest-versions cache path.
Brian Harringae0a5322012-09-15 01:46:51 -07001356 options.preserve_paths = set(['manifest-versions', '.cache',
Brian Harringead69102012-07-31 15:54:07 -07001357 'manifest-versions-internal'])
Brian Harringd166aaf2012-05-14 18:31:53 -07001358 if log_file is not None:
1359 stack.Add(tee.Tee, log_file)
Brian Harring2d8f9ff2012-06-30 15:58:28 -07001360 options.preserve_paths.add(_DEFAULT_LOG_DIR)
Brian Harringd166aaf2012-05-14 18:31:53 -07001361
Brian Harringc2d09d92012-05-13 22:03:15 -07001362 if options.cgroups:
1363 stack.Add(cgroups.SimpleContainChildren, 'cbuildbot')
Brian Harringa184efa2012-03-04 11:51:25 -08001364
Brian Harringc2d09d92012-05-13 22:03:15 -07001365 # Mark everything between EnforcedCleanupSection and here as having to
1366 # be rolled back via the contextmanager cleanup handlers. This
1367 # ensures that sudo bits cannot outlive cbuildbot, that anything
1368 # cgroups would kill gets killed, etc.
1369 critical_section.ForkWatchdog()
Brian Harringd166aaf2012-05-14 18:31:53 -07001370
Brian Harringc2d09d92012-05-13 22:03:15 -07001371 if options.timeout > 0:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001372 stack.Add(cros_build_lib.Timeout, options.timeout)
Brian Harringa184efa2012-03-04 11:51:25 -08001373
Brian Harringc2d09d92012-05-13 22:03:15 -07001374 if not options.buildbot:
1375 build_config = cbuildbot_config.OverrideConfigForTrybot(
1376 build_config,
David Jamese8dcfc42013-03-21 19:49:49 -07001377 options)
Brian Harringc2d09d92012-05-13 22:03:15 -07001378
Mike Frysinger6903c762012-12-04 01:57:16 -05001379 if options.buildbot or options.remote_trybot:
1380 _DisableYamaHardLinkChecks()
1381
Brian Harringc2d09d92012-05-13 22:03:15 -07001382 _RunBuildStagesWrapper(options, build_config)