blob: 63f04bff7e51662304fe9e15127b1ac0b15b821f [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
David James1fddb8f2013-04-25 15:23:07 -070013import collections
Brian Harring3fec5a82012-03-01 05:57:03 -080014import distutils.version
Mike Frysinger6903c762012-12-04 01:57:16 -050015import errno
Brian Harring3fec5a82012-03-01 05:57:03 -080016import glob
Chris Sosa4f6ffaf2012-05-01 17:05:44 -070017import logging
Brian Harring3fec5a82012-03-01 05:57:03 -080018import optparse
19import os
20import pprint
21import sys
Ryan Cui54da0702012-04-19 18:38:08 -070022import time
David James3541a132013-03-18 13:21:58 -070023import traceback
Brian Harring3fec5a82012-03-01 05:57:03 -080024
25from chromite.buildbot import builderstage as bs
Brian Harring3fec5a82012-03-01 05:57:03 -080026from chromite.buildbot import cbuildbot_config
27from chromite.buildbot import cbuildbot_stages as stages
28from chromite.buildbot import cbuildbot_results as results_lib
Brian Harring3fec5a82012-03-01 05:57:03 -080029from chromite.buildbot import constants
Brian Harring3fec5a82012-03-01 05:57:03 -080030from chromite.buildbot import remote_try
31from chromite.buildbot import repository
32from chromite.buildbot import tee
Ryan Cui16d9e1f2012-05-11 10:50:18 -070033from chromite.buildbot import trybot_patch_pool
Brian Harring3fec5a82012-03-01 05:57:03 -080034
Brian Harringc92a7012012-02-29 10:11:34 -080035from chromite.lib import cgroups
Brian Harringa184efa2012-03-04 11:51:25 -080036from chromite.lib import cleanup
Brian Harringb6cf9142012-09-01 20:43:17 -070037from chromite.lib import commandline
Brian Harring1b8c4c82012-05-29 23:03:04 -070038from chromite.lib import cros_build_lib
David Jamesa0a664e2013-02-13 09:52:01 -080039from chromite.lib import gclient
Brian Harring511055e2012-10-10 02:58:59 -070040from chromite.lib import gerrit
David James97d95872012-11-16 15:09:56 -080041from chromite.lib import git
Brian Harringaf019fb2012-05-10 15:06:13 -070042from chromite.lib import osutils
Brian Harring511055e2012-10-10 02:58:59 -070043from chromite.lib import patch as cros_patch
David James6450a0a2012-12-04 07:59:53 -080044from chromite.lib import parallel
Brian Harring3fec5a82012-03-01 05:57:03 -080045from chromite.lib import sudo
46
Ryan Cuiadd49122012-03-21 22:19:58 -070047
Brian Harring3fec5a82012-03-01 05:57:03 -080048_DEFAULT_LOG_DIR = 'cbuildbot_logs'
49_BUILDBOT_LOG_FILE = 'cbuildbot.log'
50_DEFAULT_EXT_BUILDROOT = 'trybot'
51_DEFAULT_INT_BUILDROOT = 'trybot-internal'
Matt Tennant8a8118a2013-09-11 14:52:15 -070052_DISTRIBUTED_TYPES = [constants.PFQ_TYPE, constants.CANARY_TYPE,
53 constants.CHROME_PFQ_TYPE, 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
Matt Tennant759e2352013-09-27 15:14:44 -0700134 This class functions as an abstract parent class for various build types.
135 Its intended use is builder_instance.Run().
Brian Harring3fec5a82012-03-01 05:57:03 -0800136
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
Brian Harring3fec5a82012-03-01 05:57:03 -0800148 if self.build_config['chromeos_official']:
149 os.environ['CHROMEOS_OFFICIAL'] = '1'
150
David James58e0c092012-03-04 20:31:12 -0800151 self.archive_stages = {}
Brian Harring3fec5a82012-03-01 05:57:03 -0800152 self.release_tag = None
Brian Harring76d1bf62012-06-01 13:52:48 -0700153 self.patch_pool = trybot_patch_pool.TrybotPatchPool()
Brian Harring3fec5a82012-03-01 05:57:03 -0800154
Ryan Cuie1e4e662012-05-21 16:39:46 -0700155 bs.BuilderStage.SetManifestBranch(self.options.branch)
Ryan Cuif7f24692012-05-18 16:35:33 -0700156
Brian Harring3fec5a82012-03-01 05:57:03 -0800157 def Initialize(self):
158 """Runs through the initialization steps of an actual build."""
Ryan Cuif7f24692012-05-18 16:35:33 -0700159 if self.options.resume:
160 results_lib.LoadCheckpoint(self.options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800161
Brian Harring3fec5a82012-03-01 05:57:03 -0800162 self._RunStage(stages.CleanUpStage)
163
164 def _GetStageInstance(self, stage, *args, **kwargs):
Matt Tennant759e2352013-09-27 15:14:44 -0700165 """Helper function to get a stage instance given the args.
Brian Harring3fec5a82012-03-01 05:57:03 -0800166
David James944a48e2012-03-07 12:19:03 -0800167 Useful as almost all stages just take in options and build_config.
Brian Harring3fec5a82012-03-01 05:57:03 -0800168 """
Matt Tennant759e2352013-09-27 15:14:44 -0700169 # Normally the current build config is used, but that config can be
170 # overridden with a config kwarg. For example, when getting a stage
171 # for a "child" config.
David James944a48e2012-03-07 12:19:03 -0800172 config = kwargs.pop('config', self.build_config)
173 return stage(self.options, config, *args, **kwargs)
Brian Harring3fec5a82012-03-01 05:57:03 -0800174
175 def _SetReleaseTag(self):
176 """Sets the release tag from the manifest_manager.
177
178 Must be run after sync stage as syncing enables us to have a release tag.
179 """
180 # Extract version we have decided to build into self.release_tag.
181 manifest_manager = stages.ManifestVersionedSyncStage.manifest_manager
182 if manifest_manager:
183 self.release_tag = manifest_manager.current_version
184
185 def _RunStage(self, stage, *args, **kwargs):
Matt Tennant759e2352013-09-27 15:14:44 -0700186 """Wrapper to run a stage.
187
188 Args:
189 stage: A BuilderStage class.
190 args: args to pass to stage constructor.
191 kwargs: kwargs to pass to stage constructor.
192 Returns:
193
194 Whatever the stage's Run method returns.
195 """
Brian Harring3fec5a82012-03-01 05:57:03 -0800196 stage_instance = self._GetStageInstance(stage, *args, **kwargs)
197 return stage_instance.Run()
198
199 def GetSyncInstance(self):
200 """Returns an instance of a SyncStage that should be run.
201
202 Subclasses must override this method.
203 """
204 raise NotImplementedError()
205
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400206 def GetCompletionInstance(self):
207 """Returns the LKGMCandidateSyncCompletionStage for this build.
208
209 Subclasses may override this method.
210
211 Returns: None
212 """
213 return None
214
Brian Harring3fec5a82012-03-01 05:57:03 -0800215 def RunStages(self):
216 """Subclasses must override this method. Runs the appropriate code."""
217 raise NotImplementedError()
218
Brian Harring3fec5a82012-03-01 05:57:03 -0800219 def _ShouldReExecuteInBuildRoot(self):
220 """Returns True if this build should be re-executed in the buildroot."""
Ryan Cui88b901c2013-06-21 11:35:30 -0700221 # The commandline --noreexec flag can override the config.
222 if not (self.options.postsync_reexec and
223 self.build_config['postsync_reexec']):
224 return False
225
Brian Harring3fec5a82012-03-01 05:57:03 -0800226 abs_buildroot = os.path.abspath(self.options.buildroot)
227 return not os.path.abspath(__file__).startswith(abs_buildroot)
228
229 def _ReExecuteInBuildroot(self, sync_instance):
230 """Reexecutes self in buildroot and returns True if build succeeds.
231
232 This allows the buildbot code to test itself when changes are patched for
233 buildbot-related code. This is a no-op if the buildroot == buildroot
234 of the running chromite checkout.
235
236 Args:
237 sync_instance: Instance of the sync stage that was run to sync.
238
239 Returns:
240 True if the Build succeeded.
241 """
Brian Harring3fec5a82012-03-01 05:57:03 -0800242 if not self.options.resume:
Ryan Cuif7f24692012-05-18 16:35:33 -0700243 results_lib.WriteCheckpoint(self.options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800244
Ryan Cui1c13a252012-10-16 15:00:16 -0700245 args = stages.BootstrapStage.FilterArgsForTargetCbuildbot(
246 self.options.buildroot, constants.PATH_TO_CBUILDBOT, self.options)
Brian Harring37e559b2012-05-22 20:47:32 -0700247
David James2333c182013-02-13 16:16:15 -0800248 # Specify a buildroot explicitly (just in case, for local trybot).
Brian Harring3fec5a82012-03-01 05:57:03 -0800249 # Suppress any timeout options given from the commandline in the
250 # invoked cbuildbot; our timeout will enforce it instead.
Ryan Cui1c13a252012-10-16 15:00:16 -0700251 args += ['--resume', '--timeout', '0', '--notee', '--nocgroups',
252 '--buildroot', os.path.abspath(self.options.buildroot)]
Brian Harringae0a5322012-09-15 01:46:51 -0700253
Brian Harring3fec5a82012-03-01 05:57:03 -0800254 if stages.ManifestVersionedSyncStage.manifest_manager:
255 ver = stages.ManifestVersionedSyncStage.manifest_manager.current_version
Ryan Cui1c13a252012-10-16 15:00:16 -0700256 args += ['--version', ver]
Brian Harring3fec5a82012-03-01 05:57:03 -0800257
David Jamesf421c6d2013-04-11 15:37:57 -0700258 pool = getattr(sync_instance, 'pool', None)
259 if pool:
260 filename = os.path.join(self.options.buildroot, 'validation_pool.dump')
261 pool.Save(filename)
262 args += ['--validation_pool', filename]
Brian Harring3fec5a82012-03-01 05:57:03 -0800263
David Jamesac8c2a72013-02-13 18:44:33 -0800264 # Reset the cache dir so that the child will calculate it automatically.
265 if not self.options.cache_dir_specified:
266 commandline.BaseParser.ConfigureCacheDir(None)
267
Brian Harring3fec5a82012-03-01 05:57:03 -0800268 # Re-run the command in the buildroot.
269 # Finally, be generous and give the invoked cbuildbot 30s to shutdown
270 # when something occurs. It should exit quicker, but the sigterm may
271 # hit while the system is particularly busy.
Brian Harring1b8c4c82012-05-29 23:03:04 -0700272 return_obj = cros_build_lib.RunCommand(
Ryan Cui1c13a252012-10-16 15:00:16 -0700273 args, cwd=self.options.buildroot, error_code_ok=True, kill_timeout=30)
Brian Harring3fec5a82012-03-01 05:57:03 -0800274 return return_obj.returncode == 0
275
Ryan Cuif7f24692012-05-18 16:35:33 -0700276 def _InitializeTrybotPatchPool(self):
277 """Generate patch pool from patches specified on the command line.
278
279 Do this only if we need to patch changes later on.
280 """
281 changes_stage = stages.PatchChangesStage.StageNamePrefix()
282 check_func = results_lib.Results.PreviouslyCompletedRecord
283 if not check_func(changes_stage) or self.options.bootstrap:
Ryan Cuie1e4e662012-05-21 16:39:46 -0700284 self.patch_pool = AcquirePoolFromOptions(self.options)
Ryan Cuif7f24692012-05-18 16:35:33 -0700285
286 def _GetBootstrapStage(self):
287 """Constructs and returns the BootStrapStage object.
288
289 We return None when there are no chromite patches to test, and
290 --test-bootstrap wasn't passed in.
291 """
292 stage = None
293 chromite_pool = self.patch_pool.Filter(project=constants.CHROMITE_PROJECT)
Ryan Cui5616a512012-08-17 13:39:36 -0700294 manifest_pool = self.patch_pool.FilterManifest()
David James97d95872012-11-16 15:09:56 -0800295 chromite_branch = git.GetChromiteTrackingBranch()
Ryan Cui5616a512012-08-17 13:39:36 -0700296 if (chromite_pool or manifest_pool or self.options.test_bootstrap
Ryan Cuie1e4e662012-05-21 16:39:46 -0700297 or chromite_branch != self.options.branch):
Ryan Cuif7f24692012-05-18 16:35:33 -0700298 stage = stages.BootstrapStage(self.options, self.build_config,
Ryan Cui5616a512012-08-17 13:39:36 -0700299 chromite_pool, manifest_pool)
Ryan Cuif7f24692012-05-18 16:35:33 -0700300 return stage
301
Brian Harring3fec5a82012-03-01 05:57:03 -0800302 def Run(self):
Ryan Cuif7f24692012-05-18 16:35:33 -0700303 """Main runner for this builder class. Runs build and prints summary.
304
305 Returns:
306 Whether the build succeeded.
307 """
308 self._InitializeTrybotPatchPool()
309
310 if self.options.bootstrap:
311 bootstrap_stage = self._GetBootstrapStage()
312 if bootstrap_stage:
313 # BootstrapStage blocks on re-execution of cbuildbot.
314 bootstrap_stage.Run()
315 return bootstrap_stage.returncode == 0
316
Brian Harring3fec5a82012-03-01 05:57:03 -0800317 print_report = True
David James3d4d3502012-04-09 15:12:06 -0700318 exception_thrown = False
Brian Harring3fec5a82012-03-01 05:57:03 -0800319 success = True
David James9ebb2a42013-08-13 20:29:57 -0700320 sync_instance = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800321 try:
322 self.Initialize()
323 sync_instance = self.GetSyncInstance()
324 sync_instance.Run()
325 self._SetReleaseTag()
326
Ryan Cui88b901c2013-06-21 11:35:30 -0700327 if self.options.postsync_patch and self.build_config['postsync_patch']:
328 # Filter out patches to manifest, since PatchChangesStage can't handle
329 # them. Manifest patches are patched in the BootstrapStage.
330 non_manifest_patches = self.patch_pool.FilterManifest(negate=True)
331 if non_manifest_patches:
332 self._RunStage(stages.PatchChangesStage, non_manifest_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800333
334 if self._ShouldReExecuteInBuildRoot():
335 print_report = False
336 success = self._ReExecuteInBuildroot(sync_instance)
337 else:
338 self.RunStages()
Matt Tennant759e2352013-09-27 15:14:44 -0700339
David James3541a132013-03-18 13:21:58 -0700340 except Exception as ex:
341 # If the build is marked as successful, but threw exceptions, that's a
342 # problem.
David James7fbf2d42012-07-14 18:23:49 -0700343 exception_thrown = True
David James3541a132013-03-18 13:21:58 -0700344 if results_lib.Results.BuildSucceededSoFar():
345 traceback.print_exc(file=sys.stdout)
David James7fbf2d42012-07-14 18:23:49 -0700346 raise
Matt Tennant759e2352013-09-27 15:14:44 -0700347
David James3541a132013-03-18 13:21:58 -0700348 if not (print_report and isinstance(ex, results_lib.StepFailure)):
349 raise
Matt Tennant759e2352013-09-27 15:14:44 -0700350
Brian Harring3fec5a82012-03-01 05:57:03 -0800351 finally:
352 if print_report:
Ryan Cuif7f24692012-05-18 16:35:33 -0700353 results_lib.WriteCheckpoint(self.options.buildroot)
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400354 completion_instance = self.GetCompletionInstance()
Mike Frysinger9b223362013-03-04 21:54:26 -0500355 self._RunStage(stages.ReportStage, self.archive_stages,
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400356 self.release_tag, sync_instance, completion_instance)
Brian Harring3fec5a82012-03-01 05:57:03 -0800357 success = results_lib.Results.BuildSucceededSoFar()
David James3d4d3502012-04-09 15:12:06 -0700358 if exception_thrown and success:
359 success = False
David Jamesbb20ac82012-07-18 10:59:16 -0700360 cros_build_lib.PrintBuildbotStepWarnings()
361 print """\
David James3d4d3502012-04-09 15:12:06 -0700362Exception thrown, but all stages marked successful. This is an internal error,
363because the stage that threw the exception should be marked as failing."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800364
365 return success
366
367
David James1fddb8f2013-04-25 15:23:07 -0700368BoardConfig = collections.namedtuple('BoardConfig', ['board', 'name'])
369
370
Brian Harring3fec5a82012-03-01 05:57:03 -0800371class SimpleBuilder(Builder):
372 """Builder that performs basic vetting operations."""
373
374 def GetSyncInstance(self):
375 """Sync to lkgm or TOT as necessary.
376
Matt Tennant759e2352013-09-27 15:14:44 -0700377 Returns: the instance of the sync stage to run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800378 """
Ryan Cui88b901c2013-06-21 11:35:30 -0700379 if self.options.force_version:
380 sync_stage = self._GetStageInstance(stages.ManifestVersionedSyncStage)
381 elif self.build_config['use_lkgm']:
Brian Harring3fec5a82012-03-01 05:57:03 -0800382 sync_stage = self._GetStageInstance(stages.LKGMSyncStage)
Chris Sosa52a81b62012-11-14 06:12:54 -0800383 elif self.build_config['use_chrome_lkgm']:
384 sync_stage = self._GetStageInstance(stages.ChromeLKGMSyncStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800385 else:
386 sync_stage = self._GetStageInstance(stages.SyncStage)
387
388 return sync_stage
389
David James4f2d8302013-03-19 06:35:58 -0700390 @staticmethod
391 def _RunParallelStages(stage_objs):
Matt Tennant759e2352013-09-27 15:14:44 -0700392 """Run the specified stages in parallel.
393
394 Args:
395 stage_objs: BuilderStage objects.
396 """
David James4f2d8302013-03-19 06:35:58 -0700397 steps = [stage.Run for stage in stage_objs]
398 try:
399 parallel.RunParallelSteps(steps)
400 except BaseException as ex:
401 # If a stage threw an exception, it might not have correctly reported
402 # results (e.g. because it was killed before it could report the
403 # results.) In this case, attribute the exception to any stages that
404 # didn't report back correctly (if any).
405 for stage in stage_objs:
406 if not results_lib.Results.StageHasResults(stage.name):
407 results_lib.Results.Record(stage.name, ex, str(ex))
Matt Tennant759e2352013-09-27 15:14:44 -0700408
David James4f2d8302013-03-19 06:35:58 -0700409 raise
410
David James1fddb8f2013-04-25 15:23:07 -0700411 def _RunBackgroundStagesForBoard(self, config, board, compilecheck):
Matt Tennant759e2352013-09-27 15:14:44 -0700412 """Run background board-specific stages for the specified board.
413
414 Args:
415 config: Build config dict.
416 board: Board name.
417 compilecheck: Boolean. If True, run only the compile steps.
418 """
David James1fddb8f2013-04-25 15:23:07 -0700419 archive_stage = self.archive_stages[BoardConfig(board, config['name'])]
420 if config['pgo_generate']:
Ahmad Sharifa2db40a2013-07-22 13:51:52 -0400421 self._RunParallelStages([archive_stage])
David James1fddb8f2013-04-25 15:23:07 -0700422 return
Matt Tennant759e2352013-09-27 15:14:44 -0700423
David James565bc9a2013-04-08 14:54:45 -0700424 if compilecheck:
425 self._RunStage(stages.BuildPackagesStage, board, archive_stage,
426 config=config)
427 self._RunStage(stages.UnitTestStage, board, config=config)
428 return
Matt Tennant759e2352013-09-27 15:14:44 -0700429
Ryan Cui3ea98e02013-08-07 16:01:48 -0700430 stage_list = []
431 if self.options.chrome_sdk and self.build_config['chrome_sdk']:
432 stage_list.append([stages.ChromeSDKStage, board, archive_stage])
433 stage_list += [[stages.VMTestStage, board, archive_stage],
434 [stages.SignerTestStage, board, archive_stage],
435 [stages.UnitTestStage, board],
436 [stages.UploadPrebuiltsStage, board, archive_stage],
437 [stages.DevInstallerPrebuiltsStage, board, archive_stage]]
Brian Harring3fec5a82012-03-01 05:57:03 -0800438
David James58e0c092012-03-04 20:31:12 -0800439 # We can not run hw tests without archiving the payloads.
440 if self.options.archive:
Chris Sosaba250522013-03-27 18:57:34 -0700441 for suite_config in config['hw_tests']:
442 if suite_config.async:
443 stage_list.append([stages.ASyncHWTestStage, board, archive_stage,
444 suite_config])
445 elif suite_config.suite == constants.HWTEST_AU_SUITE:
446 stage_list.append([stages.AUTestStage, board, archive_stage,
447 suite_config])
Aviv Keshet23efd042013-10-01 13:59:08 -0700448 elif suite_config.suite == constants.HWTEST_QAV_SUITE:
449 stage_list.append([stages.QATestStage, board,
450 archive_stage, suite_config])
Chris Sosa077df812013-01-25 17:05:28 -0800451 else:
Chris Sosaba250522013-03-27 18:57:34 -0700452 stage_list.append([stages.HWTestStage, board, archive_stage,
453 suite_config])
Chris Sosa817b1f92012-07-19 15:00:23 -0700454
David James4f2d8302013-03-19 06:35:58 -0700455 stage_objs = [self._GetStageInstance(*x, config=config) for x in stage_list]
456 self._RunParallelStages(stage_objs + [archive_stage])
Brian Harring3fec5a82012-03-01 05:57:03 -0800457
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400458 def _RunChrootBuilderTypeBuild(self):
459 """Runs through stages of a CHROOT_BUILDER_TYPE build."""
460 self._RunStage(stages.UprevStage, boards=[], enter_chroot=False)
461 self._RunStage(stages.InitSDKStage)
462 self._RunStage(stages.SetupBoardStage, [constants.CHROOT_BUILDER_BOARD])
463 self._RunStage(stages.SyncChromeStage)
464 self._RunStage(stages.PatchChromeStage)
465 self._RunStage(stages.SDKPackageStage)
466 self._RunStage(stages.SDKTestStage)
467 self._RunStage(stages.UploadPrebuiltsStage,
468 constants.CHROOT_BUILDER_BOARD, None)
469
470 def _RunRefreshPackagesTypeBuild(self):
471 """Runs through the stages of a REFRESH_PACKAGES_TYPE build."""
472 self._RunStage(stages.InitSDKStage)
473 self._RunStage(stages.SetupBoardStage)
474 self._RunStage(stages.RefreshPackageStatusStage)
475
476 def _RunDefaultTypeBuild(self):
477 """Runs through the stages of a non-special-type build."""
478 self._RunStage(stages.InitSDKStage)
479 self._RunStage(stages.UprevStage)
480 self._RunStage(stages.SetupBoardStage)
481
482 # We need a handle to this stage to extract info from it.
483 # TODO(mtennant): Just have _RunStage return the stage object, since
484 # nothing uses the return value of _RunStage now, and the Run method
485 # of stage objects does not appear to return anything, either.
486 sync_chrome_stage = self._GetStageInstance(stages.SyncChromeStage)
487 sync_chrome_stage.Run()
488 self._RunStage(stages.PatchChromeStage)
489
490 # Prepare stages to run in background.
491 configs = self.build_config['child_configs'] or [self.build_config]
492 tasks = []
493 for config in configs:
494 for board in config['boards']:
495 archive_stage = self._GetStageInstance(
496 stages.ArchiveStage, board, self.release_tag, config=config,
497 chrome_version=sync_chrome_stage.chrome_version)
498 board_config = BoardConfig(board, config['name'])
499 self.archive_stages[board_config] = archive_stage
500 tasks.append((config, board, archive_stage))
501
502 # Set up a process pool to run test/archive stages in the background.
503 # This process runs task(board) for each board added to the queue.
504 task_runner = self._RunBackgroundStagesForBoard
505 with parallel.BackgroundTaskRunner(task_runner) as queue:
506 for config, board, archive_stage in tasks:
507 compilecheck = config['compilecheck'] or self.options.compilecheck
508 if not compilecheck:
509 # Run BuildPackages and BuildImage in the foreground, generating
510 # or using PGO data if requested.
511 kwargs = {'archive_stage': archive_stage, 'config': config}
512 if config['pgo_generate']:
513 kwargs['pgo_generate'] = True
514 elif config['pgo_use']:
515 kwargs['pgo_use'] = True
516
517 self._RunStage(stages.BuildPackagesStage, board, **kwargs)
518 self._RunStage(stages.BuildImageStage, board, **kwargs)
519
520 if config['pgo_generate']:
521 suite = cbuildbot_config.PGORecordTest()
522 self._RunStage(stages.HWTestStage, board, archive_stage, suite,
523 config=config)
524
525 # Kick off our background stages.
526 queue.put([config, board, compilecheck])
527
Brian Harring3fec5a82012-03-01 05:57:03 -0800528 def RunStages(self):
529 """Runs through build process."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800530 # TODO(sosa): Split these out into classes.
David James816a5942013-04-11 22:59:32 -0700531 if self.build_config['build_type'] == constants.PRE_CQ_LAUNCHER_TYPE:
532 self._RunStage(stages.PreCQLauncherStage)
Ryan Cui88b901c2013-06-21 11:35:30 -0700533 elif self.build_config['build_type'] == constants.CREATE_BRANCH_TYPE:
534 self._RunStage(stages.BranchUtilStage)
David James816a5942013-04-11 22:59:32 -0700535 elif self.build_config['build_type'] == constants.CHROOT_BUILDER_TYPE:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400536 self._RunChrootBuilderTypeBuild()
Brian Harring3fec5a82012-03-01 05:57:03 -0800537 elif self.build_config['build_type'] == constants.REFRESH_PACKAGES_TYPE:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400538 self._RunRefreshPackagesTypeBuild()
Brian Harring3fec5a82012-03-01 05:57:03 -0800539 else:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400540 self._RunDefaultTypeBuild()
David James58e0c092012-03-04 20:31:12 -0800541
Brian Harring3fec5a82012-03-01 05:57:03 -0800542
543class DistributedBuilder(SimpleBuilder):
544 """Build class that has special logic to handle distributed builds.
545
546 These builds sync using git/manifest logic in manifest_versions. In general
547 they use a non-distributed builder code for the bulk of the work.
548 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700549 def __init__(self, *args, **kwargs):
Brian Harring3fec5a82012-03-01 05:57:03 -0800550 """Initializes a buildbot builder.
551
552 Extra variables:
553 completion_stage_class: Stage used to complete a build. Set in the Sync
554 stage.
555 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700556 super(DistributedBuilder, self).__init__(*args, **kwargs)
Brian Harring3fec5a82012-03-01 05:57:03 -0800557 self.completion_stage_class = None
David Jamesf421c6d2013-04-11 15:37:57 -0700558 self.sync_stage = None
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400559 self._completion_stage = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800560
561 def GetSyncInstance(self):
562 """Syncs the tree using one of the distributed sync logic paths.
563
Matt Tennant759e2352013-09-27 15:14:44 -0700564 Returns: the instance of the sync stage to run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800565 """
566 # Determine sync class to use. CQ overrides PFQ bits so should check it
567 # first.
David Jamesf421c6d2013-04-11 15:37:57 -0700568 if self.build_config['pre_cq'] or self.options.pre_cq:
569 sync_stage = self._GetStageInstance(stages.PreCQSyncStage,
570 self.patch_pool.gerrit_patches)
571 self.completion_stage_class = stages.PreCQCompletionStage
572 self.patch_pool.gerrit_patches = []
573 elif cbuildbot_config.IsCQType(self.build_config['build_type']):
Brian Harring3fec5a82012-03-01 05:57:03 -0800574 sync_stage = self._GetStageInstance(stages.CommitQueueSyncStage)
575 self.completion_stage_class = stages.CommitQueueCompletionStage
576 elif cbuildbot_config.IsPFQType(self.build_config['build_type']):
577 sync_stage = self._GetStageInstance(stages.LKGMCandidateSyncStage)
578 self.completion_stage_class = stages.LKGMCandidateSyncCompletionStage
579 else:
580 sync_stage = self._GetStageInstance(stages.ManifestVersionedSyncStage)
581 self.completion_stage_class = stages.ManifestVersionedSyncCompletionStage
582
David Jamesf421c6d2013-04-11 15:37:57 -0700583 self.sync_stage = sync_stage
584 return self.sync_stage
Brian Harring3fec5a82012-03-01 05:57:03 -0800585
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400586 def GetCompletionInstance(self):
587 """Returns the completion_stage_class instance that was used for this build.
588
589 Returns None if the completion_stage instance was not yet created (this
590 occurs during Publish).
591 """
592 return self._completion_stage
593
Brian Harring3fec5a82012-03-01 05:57:03 -0800594 def Publish(self, was_build_successful):
595 """Completes build by publishing any required information."""
596 completion_stage = self._GetStageInstance(self.completion_stage_class,
David Jamesf421c6d2013-04-11 15:37:57 -0700597 self.sync_stage,
Brian Harring3fec5a82012-03-01 05:57:03 -0800598 was_build_successful)
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400599 self._completion_stage = completion_stage
Brian Harring3fec5a82012-03-01 05:57:03 -0800600 completion_stage.Run()
601 name = completion_stage.name
David Jamesf421c6d2013-04-11 15:37:57 -0700602 if (self.build_config['pre_cq'] or self.options.pre_cq or
603 not results_lib.Results.WasStageSuccessful(name)):
Brian Harring3fec5a82012-03-01 05:57:03 -0800604 should_publish_changes = False
605 else:
606 should_publish_changes = (self.build_config['master'] and
607 was_build_successful)
608
609 if should_publish_changes:
610 self._RunStage(stages.PublishUprevChangesStage)
611
612 def RunStages(self):
613 """Runs simple builder logic and publishes information to overlays."""
614 was_build_successful = False
David James843ed252013-09-11 16:18:10 -0700615 try:
616 super(DistributedBuilder, self).RunStages()
617 was_build_successful = results_lib.Results.BuildSucceededSoFar()
618 except SystemExit as ex:
619 # If a stage calls sys.exit(0), it's exiting with success, so that means
620 # we should mark ourselves as successful.
621 if ex.code == 0:
622 was_build_successful = True
623 raise
624 finally:
625 self.Publish(was_build_successful)
Brian Harring3fec5a82012-03-01 05:57:03 -0800626
Brian Harring3fec5a82012-03-01 05:57:03 -0800627
628def _ConfirmBuildRoot(buildroot):
629 """Confirm with user the inferred buildroot, and mark it as confirmed."""
Brian Harring521e7242012-11-01 16:57:42 -0700630 cros_build_lib.Warning('Using default directory %s as buildroot', buildroot)
631 if not cros_build_lib.BooleanPrompt(default=False):
632 print('Please specify a different buildroot via the --buildroot option.')
Brian Harring3fec5a82012-03-01 05:57:03 -0800633 sys.exit(0)
634
635 if not os.path.exists(buildroot):
636 os.mkdir(buildroot)
637
638 repository.CreateTrybotMarker(buildroot)
639
640
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700641def _ConfirmRemoteBuildbotRun():
642 """Confirm user wants to run with --buildbot --remote."""
Brian Harring521e7242012-11-01 16:57:42 -0700643 cros_build_lib.Warning(
644 'You are about to launch a PRODUCTION job! This is *NOT* a '
645 'trybot run! Are you sure?')
646 if not cros_build_lib.BooleanPrompt(default=False):
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700647 print('Please specify --pass-through="--debug".')
648 sys.exit(0)
649
650
Ryan Cui5ba7e152012-05-10 14:36:52 -0700651def _DetermineDefaultBuildRoot(sourceroot, internal_build):
Brian Harring3fec5a82012-03-01 05:57:03 -0800652 """Default buildroot to be under the directory that contains current checkout.
653
654 Arguments:
655 internal_build: Whether the build is an internal build
Ryan Cui5ba7e152012-05-10 14:36:52 -0700656 sourceroot: Use specified sourceroot.
Brian Harring3fec5a82012-03-01 05:57:03 -0800657 """
Ryan Cui5ba7e152012-05-10 14:36:52 -0700658 if not repository.IsARepoRoot(sourceroot):
Brian Harring1b8c4c82012-05-29 23:03:04 -0700659 cros_build_lib.Die(
660 'Could not find root of local checkout at %s. Please specify '
661 'using the --sourceroot option.' % sourceroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800662
663 # Place trybot buildroot under the directory containing current checkout.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700664 top_level = os.path.dirname(os.path.realpath(sourceroot))
Brian Harring3fec5a82012-03-01 05:57:03 -0800665 if internal_build:
666 buildroot = os.path.join(top_level, _DEFAULT_INT_BUILDROOT)
667 else:
668 buildroot = os.path.join(top_level, _DEFAULT_EXT_BUILDROOT)
669
670 return buildroot
671
672
Mike Frysinger6903c762012-12-04 01:57:16 -0500673def _DisableYamaHardLinkChecks():
674 """Disable Yama kernel hardlink security checks.
675
676 The security module disables hardlinking to files you do not have
677 write access to which causes some of our build scripts problems.
678 Disable it so we don't have to worry about it.
679 """
680 PROC_PATH = '/proc/sys/kernel/yama/protected_nonaccess_hardlinks'
681 SYSCTL_PATH = PROC_PATH[len('/proc/sys/'):].replace('/', '.')
682
683 # Yama not available in this system -- nothing to do.
684 if not os.path.exists(PROC_PATH):
685 return
686
687 # Already disabled -- nothing to do.
688 if osutils.ReadFile(PROC_PATH).strip() == '0':
689 return
690
691 # Create a hardlink in a tempdir and see if we get back EPERM.
David James4bc13702013-03-26 08:08:04 -0700692 with osutils.TempDir() as tempdir:
Mike Frysinger6903c762012-12-04 01:57:16 -0500693 try:
694 os.link('/bin/sh', os.path.join(tempdir, 'sh'))
695 except OSError as e:
696 if e.errno == errno.EPERM:
697 cros_build_lib.Warning('Disabling Yama hardlink security')
698 cros_build_lib.SudoRunCommand(['sysctl', '%s=0' % SYSCTL_PATH])
699
700
Brian Harring3fec5a82012-03-01 05:57:03 -0800701def _BackupPreviousLog(log_file, backup_limit=25):
702 """Rename previous log.
703
704 Args:
705 log_file: The absolute path to the previous log.
706 """
707 if os.path.exists(log_file):
708 old_logs = sorted(glob.glob(log_file + '.*'),
709 key=distutils.version.LooseVersion)
710
711 if len(old_logs) >= backup_limit:
712 os.remove(old_logs[0])
713
714 last = 0
715 if old_logs:
716 last = int(old_logs.pop().rpartition('.')[2])
717
718 os.rename(log_file, log_file + '.' + str(last + 1))
719
Ryan Cui5616a512012-08-17 13:39:36 -0700720
David James944a48e2012-03-07 12:19:03 -0800721def _RunBuildStagesWrapper(options, build_config):
Brian Harring3fec5a82012-03-01 05:57:03 -0800722 """Helper function that wraps RunBuildStages()."""
723 def IsDistributedBuilder():
724 """Determines whether the build_config should be a DistributedBuilder."""
David Jamesf421c6d2013-04-11 15:37:57 -0700725 if build_config['pre_cq'] or options.pre_cq:
726 return True
727 elif not options.buildbot:
Brian Harring3fec5a82012-03-01 05:57:03 -0800728 return False
729 elif build_config['build_type'] in _DISTRIBUTED_TYPES:
Brian Harring3fec5a82012-03-01 05:57:03 -0800730 # We don't do distributed logic to TOT Chrome PFQ's, nor local
731 # chrome roots (e.g. chrome try bots)
732 if chrome_rev not in [constants.CHROME_REV_TOT,
733 constants.CHROME_REV_LOCAL,
734 constants.CHROME_REV_SPEC]:
735 return True
736
737 return False
738
Brian Harring1b8c4c82012-05-29 23:03:04 -0700739 cros_build_lib.Info("cbuildbot executed with args %s"
740 % ' '.join(map(repr, sys.argv)))
Brian Harring3fec5a82012-03-01 05:57:03 -0800741
David Jamesa0a664e2013-02-13 09:52:01 -0800742 chrome_rev = build_config['chrome_rev']
743 if options.chrome_rev:
744 chrome_rev = options.chrome_rev
745 if chrome_rev == constants.CHROME_REV_TOT:
746 # Build the TOT Chrome revision.
747 svn_url = gclient.GetBaseURLs()[0]
748 options.chrome_version = gclient.GetTipOfTrunkSvnRevision(svn_url)
749 options.chrome_rev = constants.CHROME_REV_SPEC
750
David James4a404a52013-02-19 13:07:59 -0800751 # If it's likely we'll need to build Chrome, fetch the source.
Mike Frysingerf4d9ab82013-03-05 19:38:05 -0500752 if build_config['sync_chrome'] is None:
753 options.managed_chrome = (chrome_rev != constants.CHROME_REV_LOCAL and
754 (not build_config['usepkg_build_packages'] or chrome_rev or
David James3cce4642013-05-10 17:50:23 -0700755 build_config['profile'] or options.rietveld_patches))
Mike Frysingerf4d9ab82013-03-05 19:38:05 -0500756 else:
757 options.managed_chrome = build_config['sync_chrome']
David James2333c182013-02-13 16:16:15 -0800758
759 if options.managed_chrome:
760 # Tell Chrome to fetch the source locally.
761 internal = constants.USE_CHROME_INTERNAL in (build_config['useflags'] or [])
762 chrome_src = 'chrome-src-internal' if internal else 'chrome-src'
763 options.chrome_root = os.path.join(options.cache_dir, 'distfiles', 'target',
764 chrome_src)
David James9e27e662013-02-14 13:42:43 -0800765 elif options.rietveld_patches:
David James4a404a52013-02-19 13:07:59 -0800766 cros_build_lib.Die('This builder does not support Rietveld patches.')
David James2333c182013-02-13 16:16:15 -0800767
Ryan Cuif7f24692012-05-18 16:35:33 -0700768 target = DistributedBuilder if IsDistributedBuilder() else SimpleBuilder
Ryan Cuie1e4e662012-05-21 16:39:46 -0700769 buildbot = target(options, build_config)
Brian Harringd166aaf2012-05-14 18:31:53 -0700770 if not buildbot.Run():
771 sys.exit(1)
Brian Harring3fec5a82012-03-01 05:57:03 -0800772
773
774# Parser related functions
Ryan Cui5ba7e152012-05-10 14:36:52 -0700775def _CheckLocalPatches(sourceroot, local_patches):
Brian Harring3fec5a82012-03-01 05:57:03 -0800776 """Do an early quick check of the passed-in patches.
777
778 If the branch of a project is not specified we append the current branch the
779 project is on.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700780
781 Args:
782 sourceroot: The checkout where patches are coming from.
Brian Harring3fec5a82012-03-01 05:57:03 -0800783 """
Ryan Cuicedd8a52012-03-22 02:28:35 -0700784 verified_patches = []
David James97d95872012-11-16 15:09:56 -0800785 manifest = git.ManifestCheckout.Cached(sourceroot)
Ryan Cuicedd8a52012-03-22 02:28:35 -0700786 for patch in local_patches:
Brian Harring3fec5a82012-03-01 05:57:03 -0800787 components = patch.split(':')
788 if len(components) > 2:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700789 cros_build_lib.Die(
790 'Specify local patches in project[:branch] format. Got %s' % patch)
Brian Harring3fec5a82012-03-01 05:57:03 -0800791
792 # validate project
793 project = components[0]
Brian Harring3fec5a82012-03-01 05:57:03 -0800794
Brian Harring609dc4e2012-05-07 02:17:44 -0700795 try:
796 project_dir = manifest.GetProjectPath(project, True)
797 except KeyError:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700798 cros_build_lib.Die('Project %s does not exist.' % project)
Brian Harring3fec5a82012-03-01 05:57:03 -0800799
800 # If no branch was specified, we use the project's current branch.
801 if len(components) == 1:
David James97d95872012-11-16 15:09:56 -0800802 branch = git.GetCurrentBranch(project_dir)
Brian Harring3fec5a82012-03-01 05:57:03 -0800803 if not branch:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700804 cros_build_lib.Die('Project %s is not on a branch!' % project)
Brian Harring3fec5a82012-03-01 05:57:03 -0800805 else:
806 branch = components[1]
David James97d95872012-11-16 15:09:56 -0800807 if not git.DoesLocalBranchExist(project_dir, branch):
Brian Harring1b8c4c82012-05-29 23:03:04 -0700808 cros_build_lib.Die('Project %s does not have branch %s'
809 % (project, branch))
Brian Harring3fec5a82012-03-01 05:57:03 -0800810
Brian Harring609dc4e2012-05-07 02:17:44 -0700811 verified_patches.append('%s:%s' % (project, branch))
Brian Harring3fec5a82012-03-01 05:57:03 -0800812
Ryan Cuicedd8a52012-03-22 02:28:35 -0700813 return verified_patches
Brian Harring3fec5a82012-03-01 05:57:03 -0800814
815
Brian Harring3fec5a82012-03-01 05:57:03 -0800816def _CheckChromeVersionOption(_option, _opt_str, value, parser):
817 """Upgrade other options based on chrome_version being passed."""
818 value = value.strip()
819
820 if parser.values.chrome_rev is None and value:
821 parser.values.chrome_rev = constants.CHROME_REV_SPEC
822
823 parser.values.chrome_version = value
824
825
826def _CheckChromeRootOption(_option, _opt_str, value, parser):
827 """Validate and convert chrome_root to full-path form."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800828 if parser.values.chrome_rev is None:
829 parser.values.chrome_rev = constants.CHROME_REV_LOCAL
830
Ryan Cui5ba7e152012-05-10 14:36:52 -0700831 parser.values.chrome_root = value
Brian Harring3fec5a82012-03-01 05:57:03 -0800832
833
834def _CheckChromeRevOption(_option, _opt_str, value, parser):
835 """Validate the chrome_rev option."""
836 value = value.strip()
837 if value not in constants.VALID_CHROME_REVISIONS:
838 raise optparse.OptionValueError('Invalid chrome rev specified')
839
840 parser.values.chrome_rev = value
841
842
David Jamesac8c2a72013-02-13 18:44:33 -0800843def FindCacheDir(_parser, _options):
Brian Harringae0a5322012-09-15 01:46:51 -0700844 return None
845
846
Ryan Cui5ba7e152012-05-10 14:36:52 -0700847class CustomGroup(optparse.OptionGroup):
848 def add_remote_option(self, *args, **kwargs):
849 """For arguments that are passed-through to remote trybot."""
850 return optparse.OptionGroup.add_option(self, *args,
851 remote_pass_through=True,
852 **kwargs)
853
854
Ryan Cui1c13a252012-10-16 15:00:16 -0700855class CustomOption(commandline.FilteringOption):
856 """Subclass FilteringOption class to implement pass-through and api."""
Ryan Cui5ba7e152012-05-10 14:36:52 -0700857
Ryan Cui1c13a252012-10-16 15:00:16 -0700858 ACTIONS = commandline.FilteringOption.ACTIONS + ('extend',)
859 STORE_ACTIONS = commandline.FilteringOption.STORE_ACTIONS + ('extend',)
860 TYPED_ACTIONS = commandline.FilteringOption.TYPED_ACTIONS + ('extend',)
861 ALWAYS_TYPED_ACTIONS = (commandline.FilteringOption.ALWAYS_TYPED_ACTIONS +
862 ('extend',))
Ryan Cui79319ab2012-05-21 12:59:18 -0700863
Ryan Cui5ba7e152012-05-10 14:36:52 -0700864 def __init__(self, *args, **kwargs):
865 # The remote_pass_through argument specifies whether we should directly
866 # pass the argument (with its value) onto the remote trybot.
867 self.pass_through = kwargs.pop('remote_pass_through', False)
Ryan Cui1c13a252012-10-16 15:00:16 -0700868 self.api_version = int(kwargs.pop('api', '0'))
869 commandline.FilteringOption.__init__(self, *args, **kwargs)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700870
871 def take_action(self, action, dest, opt, value, values, parser):
Ryan Cui79319ab2012-05-21 12:59:18 -0700872 if action == 'extend':
Mike Frysingerd6925b52012-07-16 16:11:00 -0400873 # If there is extra spaces between each argument, we get '' which later
874 # code barfs on, so skip those. e.g. We see this with the forms:
875 # cbuildbot -p 'proj:branch ' ...
876 # cbuildbot -p ' proj:branch' ...
877 # cbuildbot -p 'proj:branch proj2:branch' ...
878 lvalue = value.split()
Ryan Cui79319ab2012-05-21 12:59:18 -0700879 values.ensure_value(dest, []).extend(lvalue)
Ryan Cui79319ab2012-05-21 12:59:18 -0700880
Ryan Cui1c13a252012-10-16 15:00:16 -0700881 commandline.FilteringOption.take_action(
882 self, action, dest, opt, value, values, parser)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700883
884
Ryan Cui1c13a252012-10-16 15:00:16 -0700885class CustomParser(commandline.FilteringParser):
Brian Harringb6cf9142012-09-01 20:43:17 -0700886
887 DEFAULT_OPTION_CLASS = CustomOption
888
889 def add_remote_option(self, *args, **kwargs):
890 """For arguments that are passed-through to remote trybot."""
Ryan Cui1c13a252012-10-16 15:00:16 -0700891 return self.add_option(*args, remote_pass_through=True, **kwargs)
Brian Harringb6cf9142012-09-01 20:43:17 -0700892
893
Brian Harring3fec5a82012-03-01 05:57:03 -0800894def _CreateParser():
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700895 """Generate and return the parser with all the options."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800896 # Parse options
897 usage = "usage: %prog [options] buildbot_config"
Brian Harringae0a5322012-09-15 01:46:51 -0700898 parser = CustomParser(usage=usage, caching=FindCacheDir)
Brian Harring3fec5a82012-03-01 05:57:03 -0800899
900 # Main options
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400901 parser.add_option('-l', '--list', action='store_true', dest='list',
902 default=False,
903 help='List the suggested trybot configs to use (see --all)')
Brian Harring3fec5a82012-03-01 05:57:03 -0800904 parser.add_option('-a', '--all', action='store_true', dest='print_all',
905 default=False,
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400906 help='List all of the buildbot configs available w/--list')
907
908 parser.add_option('--local', default=False, action='store_true',
Ryan Cui88b901c2013-06-21 11:35:30 -0700909 help='Specifies that this tryjob should be run locally. '
910 'Implies --debug.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400911 parser.add_option('--remote', default=False, action='store_true',
Ryan Cui88b901c2013-06-21 11:35:30 -0700912 help='Specifies that this tryjob should be run remotely.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400913
Ryan Cuie1e4e662012-05-21 16:39:46 -0700914 parser.add_remote_option('-b', '--branch',
915 help='The manifest branch to test. The branch to '
916 'check the buildroot out to.')
Ryan Cui5ba7e152012-05-10 14:36:52 -0700917 parser.add_option('-r', '--buildroot', dest='buildroot', type='path',
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700918 help='Root directory where source is checked out to, and '
919 'where the build occurs. For external build configs, '
920 "defaults to 'trybot' directory at top level of your "
921 'repo-managed checkout.')
922 parser.add_remote_option('--chrome_rev', default=None, type='string',
923 action='callback', dest='chrome_rev',
924 callback=_CheckChromeRevOption,
925 help=('Revision of Chrome to use, of type [%s]'
926 % '|'.join(constants.VALID_CHROME_REVISIONS)))
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700927 parser.add_remote_option('--profile', default=None, type='string',
928 action='store', dest='profile',
929 help='Name of profile to sub-specify board variant.')
Brian Harring3fec5a82012-03-01 05:57:03 -0800930
Ryan Cuif4f84be2012-07-09 18:50:41 -0700931 #
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400932 # Patch selection options.
933 #
934
935 group = CustomGroup(
936 parser,
937 'Patch Options')
938
939 group.add_remote_option('-g', '--gerrit-patches', action='extend',
940 default=[], type='string',
941 metavar="'Id1 *int_Id2...IdN'",
942 help="Space-separated list of short-form Gerrit "
943 "Change-Id's or change numbers to patch. "
944 "Please prepend '*' to internal Change-Id's")
945 group.add_remote_option('-G', '--rietveld-patches', action='extend',
946 default=[], type='string',
947 metavar="'id1[:subdir1]...idN[:subdirN]'",
948 help='Space-separated list of short-form Rietveld '
949 'issue numbers to patch. If no subdir is '
950 'specified, the src directory is used.')
951 group.add_option('-p', '--local-patches', action='extend', default=[],
952 metavar="'<project1>[:<branch1>]...<projectN>[:<branchN>]'",
953 help='Space-separated list of project branches with '
954 'patches to apply. Projects are specified by name. '
955 'If no branch is specified the current branch of the '
956 'project will be used.')
957
958 parser.add_option_group(group)
959
960 #
961 # Remote trybot options.
962 #
963
964 group = CustomGroup(
965 parser,
966 'Remote Trybot Options (--remote)')
967
968 group.add_remote_option('--hwtest', dest='hwtest', action='store_true',
969 default=False,
970 help='Run the HWTest stage (tests on real hardware)')
971 group.add_option('--remote-description', default=None,
972 help='Attach an optional description to a --remote run '
973 'to make it easier to identify the results when it '
974 'finishes')
975 group.add_option('--slaves', action='extend', default=[],
976 help='Specify specific remote tryslaves to run on (e.g. '
977 'build149-m2); if the bot is busy, it will be queued')
978 group.add_option('--test-tryjob', action='store_true',
979 default=False,
980 help='Submit a tryjob to the test repository. Will not '
981 'show up on the production trybot waterfall.')
982
983 parser.add_option_group(group)
984
985 #
Ryan Cui88b901c2013-06-21 11:35:30 -0700986 # Branch creation options.
987 #
988
989 group = CustomGroup(
990 parser,
991 'Branch Creation Options (used with branch-util)')
992
993 group.add_remote_option('--branch-name',
994 help='The branch to create or delete.')
995 group.add_remote_option('--delete-branch', default=False, action='store_true',
996 help='Delete the branch specified in --branch-name.')
997 group.add_remote_option('--rename-to', type='string',
998 help='Rename a branch to the specified name.')
999 group.add_remote_option('--force-create', default=False, action='store_true',
1000 help='Overwrites an existing branch.')
1001
1002 parser.add_option_group(group)
1003
1004 #
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001005 # Advanced options.
Ryan Cuif4f84be2012-07-09 18:50:41 -07001006 #
1007
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001008 group = CustomGroup(
Brian Harring3fec5a82012-03-01 05:57:03 -08001009 parser,
1010 'Advanced Options',
1011 'Caution: use these options at your own risk.')
1012
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001013 group.add_remote_option('--bootstrap-args', action='append', default=[],
1014 help='Args passed directly to the bootstrap re-exec '
1015 'to skip verification by the bootstrap code')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001016 group.add_remote_option('--buildbot', dest='buildbot', action='store_true',
1017 default=False, help='This is running on a buildbot')
1018 group.add_remote_option('--buildnumber', help='build number', type='int',
1019 default=0)
Ryan Cui5ba7e152012-05-10 14:36:52 -07001020 group.add_option('--chrome_root', default=None, type='path',
1021 action='callback', callback=_CheckChromeRootOption,
1022 dest='chrome_root', help='Local checkout of Chrome to use.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001023 group.add_remote_option('--chrome_version', default=None, type='string',
1024 action='callback', dest='chrome_version',
1025 callback=_CheckChromeVersionOption,
1026 help='Used with SPEC logic to force a particular SVN '
1027 'revision of chrome rather than the latest.')
1028 group.add_remote_option('--clobber', action='store_true', dest='clobber',
1029 default=False,
1030 help='Clears an old checkout before syncing')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001031 group.add_remote_option('--latest-toolchain', action='store_true',
1032 default=False,
1033 help='Use the latest toolchain.')
Ryan Cui5ba7e152012-05-10 14:36:52 -07001034 parser.add_option('--log_dir', dest='log_dir', type='path',
Brian Harring3fec5a82012-03-01 05:57:03 -08001035 help=('Directory where logs are stored.'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001036 group.add_remote_option('--maxarchives', dest='max_archive_builds',
1037 default=3, type='int',
1038 help="Change the local saved build count limit.")
Ryan Cuibbd3d4b2012-08-17 12:20:37 -07001039 parser.add_remote_option('--manifest-repo-url',
1040 help=('Overrides the default manifest repo url.'))
David James565bc9a2013-04-08 14:54:45 -07001041 group.add_remote_option('--compilecheck', action='store_true', default=False,
1042 help='Only verify compilation and unit tests.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001043 group.add_remote_option('--noarchive', action='store_false', dest='archive',
1044 default=True, help="Don't run archive stage.")
Ryan Cuif7f24692012-05-18 16:35:33 -07001045 group.add_remote_option('--nobootstrap', action='store_false',
1046 dest='bootstrap', default=True,
1047 help="Don't checkout and run from a standalone "
1048 "chromite repo.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001049 group.add_remote_option('--nobuild', action='store_false', dest='build',
1050 default=True,
1051 help="Don't actually build (for cbuildbot dev)")
1052 group.add_remote_option('--noclean', action='store_false', dest='clean',
1053 default=True, help="Don't clean the buildroot")
Ryan Cuif7f24692012-05-18 16:35:33 -07001054 group.add_remote_option('--nocgroups', action='store_false', dest='cgroups',
1055 default=True,
1056 help='Disable cbuildbots usage of cgroups.')
Ryan Cui3ea98e02013-08-07 16:01:48 -07001057 group.add_remote_option('--nochromesdk', action='store_false',
1058 dest='chrome_sdk', default=True,
1059 help="Don't run the ChromeSDK stage which builds "
1060 "Chrome outside of the chroot.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001061 group.add_remote_option('--noprebuilts', action='store_false',
1062 dest='prebuilts', default=True,
1063 help="Don't upload prebuilts.")
Ryan Cui88b901c2013-06-21 11:35:30 -07001064 group.add_remote_option('--nopatch', action='store_false',
1065 dest='postsync_patch', default=True,
1066 help=("Don't run PatchChanges stage. This does not "
1067 "disable patching in of chromite patches "
1068 "during BootstrapStage."))
1069 group.add_remote_option('--noreexec', action='store_false',
1070 dest='postsync_reexec', default=True,
1071 help="Don't reexec into the buildroot after syncing.")
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001072 group.add_remote_option('--nosdk', action='store_true',
1073 default=False,
1074 help='Re-create the SDK from scratch.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001075 group.add_remote_option('--nosync', action='store_false', dest='sync',
1076 default=True, help="Don't sync before building.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001077 group.add_remote_option('--notests', action='store_false', dest='tests',
1078 default=True,
1079 help='Override values from buildconfig and run no '
1080 'tests.')
1081 group.add_remote_option('--nouprev', action='store_false', dest='uprev',
1082 default=True,
1083 help='Override values from buildconfig and never '
1084 'uprev.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001085 group.add_option('--reference-repo', action='store', default=None,
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001086 dest='reference_repo',
1087 help='Reuse git data stored in an existing repo '
1088 'checkout. This can drastically reduce the network '
1089 'time spent setting up the trybot checkout. By '
1090 "default, if this option isn't given but cbuildbot "
1091 'is invoked from a repo checkout, cbuildbot will '
1092 'use the repo root.')
Ryan Cuicedd8a52012-03-22 02:28:35 -07001093 group.add_option('--resume', action='store_true', default=False,
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001094 help='Skip stages already successfully completed.')
1095 group.add_remote_option('--timeout', action='store', type='int', default=0,
1096 help='Specify the maximum amount of time this job '
1097 'can run for, at which point the build will be '
1098 'aborted. If set to zero, then there is no '
1099 'timeout.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001100 group.add_remote_option('--version', dest='force_version', default=None,
1101 help='Used with manifest logic. Forces use of this '
Aviv Keshetc2c123d2013-10-14 18:06:12 -04001102 'version rather than create or get latest. '
1103 'Examples: 4815.0.0-rc1, 4815.1.2')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001104
1105 parser.add_option_group(group)
1106
1107 #
1108 # Internal options.
1109 #
1110
1111 group = CustomGroup(
1112 parser,
1113 'Internal ChromeOS Build Team Options',
1114 'Caution: these are for meant for the ChromeOS build team only')
1115
1116 group.add_remote_option('--archive-base', type='gs_path',
1117 help='Base GS URL (gs://<bucket_name>/<path>) to '
1118 'upload archive artifacts to')
Brian Harringab8fb5c2012-07-18 11:28:22 -07001119 group.add_remote_option('--cq-gerrit-query', dest='cq_gerrit_override',
1120 default=None,
1121 help=
1122 "If given, this gerrit query will be used to find what patches to test, "
Brian Harringc5cabfe2012-12-19 01:04:44 -08001123 "rather than the normal 'CommitQueue=1 AND Verified=1 AND CodeReview=2' "
Brian Harringab8fb5c2012-07-18 11:28:22 -07001124 "query it defaults to. Use with care- note additionally this setting "
1125 "only has an effect if the buildbot target is a cq target, and we're "
1126 "in buildbot mode.")
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001127 group.add_option('--pass-through', dest='pass_through_args', action='append',
1128 type='string', default=[])
David Jamesf421c6d2013-04-11 15:37:57 -07001129 group.add_remote_option('--pre-cq', action='store_true', default=False,
1130 help='Mark CLs as tested by the PreCQ on success.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001131 group.add_option('--reexec-api-version', dest='output_api_version',
Ryan Cuif4f84be2012-07-09 18:50:41 -07001132 action='store_true', default=False,
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001133 help='Used for handling forwards/backwards compatibility '
1134 'with --resume and --bootstrap')
1135 group.add_option('--remote-trybot', dest='remote_trybot',
1136 action='store_true', default=False,
1137 help='Indicates this is running on a remote trybot machine')
1138 group.add_remote_option('--remote-patches', action='extend', default=[],
1139 help='Patches uploaded by the trybot client when run '
1140 'using the -p option')
Brian Harringf611e6e2012-07-17 18:47:44 -07001141 # Note the default here needs to be hardcoded to 3; that is the last version
1142 # that lacked this functionality.
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001143 group.add_option('--remote-version', default=3, type=int, action='store',
1144 help='Used for compatibility checks w/tryjobs running in '
1145 'older chromite instances')
1146 group.add_option('--sourceroot', type='path', default=constants.SOURCE_ROOT)
1147 group.add_remote_option('--test-bootstrap', action='store_true',
1148 default=False,
1149 help='Causes cbuildbot to bootstrap itself twice, in '
1150 'the sequence A->B->C: A(unpatched) patches and '
1151 'bootstraps B; B patches and bootstraps C')
1152 group.add_remote_option('--validation_pool', default=None,
1153 help='Path to a pickled validation pool. Intended '
1154 'for use only with the commit queue.')
1155
1156 parser.add_option_group(group)
Ryan Cuif4f84be2012-07-09 18:50:41 -07001157
1158 #
Brian Harring3fec5a82012-03-01 05:57:03 -08001159 # Debug options
Ryan Cuif4f84be2012-07-09 18:50:41 -07001160 #
Brian Harringfec89fe2012-09-23 07:30:54 -07001161 # Temporary hack; in place till --dry-run replaces --debug.
1162 # pylint: disable=W0212
Brian Harring009db502012-10-10 02:21:37 -07001163 group = parser.debug_group
Brian Harringfec89fe2012-09-23 07:30:54 -07001164 debug = [x for x in group.option_list if x._long_opts == ['--debug']][0]
1165 debug.help += " Currently functions as --dry-run in addition."
1166 debug.pass_through = True
Brian Harring3fec5a82012-03-01 05:57:03 -08001167 group.add_option('--dump_config', action='store_true', dest='dump_config',
1168 default=False,
1169 help='Dump out build config options, and exit.')
1170 group.add_option('--notee', action='store_false', dest='tee', default=True,
1171 help="Disable logging and internal tee process. Primarily "
1172 "used for debugging cbuildbot itself.")
Brian Harring3fec5a82012-03-01 05:57:03 -08001173 return parser
1174
1175
Ryan Cui85867972012-02-23 18:21:49 -08001176def _FinishParsing(options, args):
1177 """Perform some parsing tasks that need to take place after optparse.
1178
1179 This function needs to be easily testable! Keep it free of
1180 environment-dependent code. Put more detailed usage validation in
1181 _PostParseCheck().
Brian Harring3fec5a82012-03-01 05:57:03 -08001182
1183 Args:
Matt Tennant759e2352013-09-27 15:14:44 -07001184 options: The options object returned by optparse
1185 args: The args object returned by optparse
Brian Harring3fec5a82012-03-01 05:57:03 -08001186 """
Ryan Cui41023d92012-11-13 19:59:50 -08001187 # Populate options.pass_through_args.
1188 accepted, _ = commandline.FilteringParser.FilterArgs(
1189 options.parsed_args, lambda x: x.opt_inst.pass_through)
1190 options.pass_through_args.extend(accepted)
Brian Harring07039b52012-05-13 17:56:47 -07001191
Brian Harring3fec5a82012-03-01 05:57:03 -08001192 if options.chrome_root:
1193 if options.chrome_rev != constants.CHROME_REV_LOCAL:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001194 cros_build_lib.Die('Chrome rev must be %s if chrome_root is set.' %
1195 constants.CHROME_REV_LOCAL)
David Jamesa0a664e2013-02-13 09:52:01 -08001196 elif options.chrome_rev == constants.CHROME_REV_LOCAL:
1197 cros_build_lib.Die('Chrome root must be set if chrome_rev is %s.' %
1198 constants.CHROME_REV_LOCAL)
Brian Harring3fec5a82012-03-01 05:57:03 -08001199
1200 if options.chrome_version:
1201 if options.chrome_rev != constants.CHROME_REV_SPEC:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001202 cros_build_lib.Die('Chrome rev must be %s if chrome_version is set.' %
1203 constants.CHROME_REV_SPEC)
David Jamesa0a664e2013-02-13 09:52:01 -08001204 elif options.chrome_rev == constants.CHROME_REV_SPEC:
1205 cros_build_lib.Die(
1206 'Chrome rev must not be %s if chrome_version is not set.'
1207 % constants.CHROME_REV_SPEC)
Brian Harring3fec5a82012-03-01 05:57:03 -08001208
David James9e27e662013-02-14 13:42:43 -08001209 patches = bool(options.gerrit_patches or options.local_patches or
1210 options.rietveld_patches)
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001211 if options.remote:
1212 if options.local:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001213 cros_build_lib.Die('Cannot specify both --remote and --local')
Ryan Cui54da0702012-04-19 18:38:08 -07001214
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001215 if not options.buildbot and not patches:
Brian Harring7cc4b932012-11-01 16:58:55 -07001216 if not cros_build_lib.BooleanPrompt(
1217 prompt="No patches were provided; are you sure you want to just "
1218 "run a remote build of ToT?", default=False):
1219 cros_build_lib.Die('Must provide patches when running with --remote.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001220
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001221 # --debug needs to be explicitly passed through for remote invocations.
1222 release_mode_with_patches = (options.buildbot and patches and
1223 '--debug' not in options.pass_through_args)
1224 else:
1225 if len(args) > 1:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001226 cros_build_lib.Die('Multiple configs not supported if not running with '
Brian Harringf1aad832012-07-18 10:46:39 -07001227 '--remote. Got %r', args)
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001228
Ryan Cui79319ab2012-05-21 12:59:18 -07001229 if options.slaves:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001230 cros_build_lib.Die('Cannot use --slaves if not running with --remote.')
Ryan Cui79319ab2012-05-21 12:59:18 -07001231
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001232 release_mode_with_patches = (options.buildbot and patches and
1233 not options.debug)
1234
David James5734ea32012-08-15 20:23:49 -07001235 # When running in release mode, make sure we are running with checked-in code.
1236 # We want checked-in cbuildbot/scripts to prevent errors, and we want to build
1237 # a release image with checked-in code for CrOS packages.
1238 if release_mode_with_patches:
1239 cros_build_lib.Die(
1240 'Cannot provide patches when running with --buildbot!')
1241
Ryan Cuiba41ad32012-03-08 17:15:29 -08001242 if options.buildbot and options.remote_trybot:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001243 cros_build_lib.Die(
1244 '--buildbot and --remote-trybot cannot be used together.')
Ryan Cuiba41ad32012-03-08 17:15:29 -08001245
Ryan Cui85867972012-02-23 18:21:49 -08001246 # Record whether --debug was set explicitly vs. it was inferred.
1247 options.debug_forced = False
1248 if options.debug:
1249 options.debug_forced = True
Ryan Cui88b901c2013-06-21 11:35:30 -07001250 if not options.debug:
Ryan Cui16ca5812012-03-08 20:34:27 -08001251 # We don't set debug by default for
1252 # 1. --buildbot invocations.
1253 # 2. --remote invocations, because it needs to push changes to the tryjob
1254 # repo.
1255 options.debug = not options.buildbot and not options.remote
Brian Harring3fec5a82012-03-01 05:57:03 -08001256
Ryan Cui1c13a252012-10-16 15:00:16 -07001257 # Record the configs targeted.
1258 options.build_targets = args[:]
1259
Ryan Cui88b901c2013-06-21 11:35:30 -07001260 if constants.BRANCH_UTIL_CONFIG in options.build_targets:
Ryan Cui7bd8db62013-08-08 16:29:51 -07001261 if options.remote:
1262 cros_build_lib.Die(
1263 'Running branch-util as a remote tryjob is not yet supported.')
Ryan Cui88b901c2013-06-21 11:35:30 -07001264 if len(options.build_targets) > 1:
1265 cros_build_lib.Die(
1266 'Cannot run branch-util with any other configs.')
1267 if not options.branch_name:
1268 cros_build_lib.Die(
1269 'Must specify --branch-name with the branch-util config.')
1270 if not any([options.force_version, options.delete_branch,
1271 options.rename_to]):
1272 cros_build_lib.Die(
1273 'Must specify --version with the branch-util config, unless '
1274 'running with --delete-branch or --rename-to.')
1275 elif any([options.delete_branch, options.rename_to, options.branch_name]):
1276 cros_build_lib.Die(
1277 'Cannot specify --delete-branch, --rename-to or --branch-name when not '
1278 'running the %s config', constants.BRANCH_UTIL_CONFIG)
1279
Brian Harring3fec5a82012-03-01 05:57:03 -08001280
Brian Harring1d7ba942012-04-24 06:37:18 -07001281# pylint: disable=W0613
Brian Harringae0a5322012-09-15 01:46:51 -07001282def _PostParseCheck(parser, options, args):
Ryan Cui85867972012-02-23 18:21:49 -08001283 """Perform some usage validation after we've parsed the arguments
Brian Harring3fec5a82012-03-01 05:57:03 -08001284
Ryan Cui85867972012-02-23 18:21:49 -08001285 Args:
1286 options/args: The options/args object returned by optparse
1287 """
Ryan Cuie1e4e662012-05-21 16:39:46 -07001288 if not options.branch:
David James97d95872012-11-16 15:09:56 -08001289 options.branch = git.GetChromiteTrackingBranch()
Ryan Cuie1e4e662012-05-21 16:39:46 -07001290
Brian Harringae0a5322012-09-15 01:46:51 -07001291 if not repository.IsARepoRoot(options.sourceroot):
1292 if options.local_patches:
1293 raise Exception('Could not find repo checkout at %s!'
1294 % options.sourceroot)
1295
David Jamesac8c2a72013-02-13 18:44:33 -08001296 # Because the default cache dir depends on other options, FindCacheDir
1297 # always returns None, and we setup the default here.
Brian Harringae0a5322012-09-15 01:46:51 -07001298 if options.cache_dir is None:
1299 # Note, options.sourceroot is set regardless of the path
1300 # actually existing.
David Jamesac8c2a72013-02-13 18:44:33 -08001301 if options.buildroot is not None:
Brian Harringae0a5322012-09-15 01:46:51 -07001302 options.cache_dir = os.path.join(options.buildroot, '.cache')
David Jamesac8c2a72013-02-13 18:44:33 -08001303 elif os.path.exists(options.sourceroot):
1304 options.cache_dir = os.path.join(options.sourceroot, '.cache')
Brian Harringae0a5322012-09-15 01:46:51 -07001305 else:
1306 options.cache_dir = parser.FindCacheDir(parser, options)
1307 options.cache_dir = os.path.abspath(options.cache_dir)
Brian Harring8c1d7b12012-10-04 17:36:32 -07001308 parser.ConfigureCacheDir(options.cache_dir)
Brian Harringae0a5322012-09-15 01:46:51 -07001309
1310 osutils.SafeMakedirs(options.cache_dir)
Ryan Cui5ba7e152012-05-10 14:36:52 -07001311
Brian Harring609dc4e2012-05-07 02:17:44 -07001312 if options.local_patches:
Brian Harring1d7ba942012-04-24 06:37:18 -07001313 options.local_patches = _CheckLocalPatches(
Brian Harring609dc4e2012-05-07 02:17:44 -07001314 options.sourceroot, options.local_patches)
Brian Harring1d7ba942012-04-24 06:37:18 -07001315
1316 default = os.environ.get('CBUILDBOT_DEFAULT_MODE')
1317 if (default and not any([options.local, options.buildbot,
1318 options.remote, options.remote_trybot])):
Brian Harring1b8c4c82012-05-29 23:03:04 -07001319 cros_build_lib.Info("CBUILDBOT_DEFAULT_MODE=%s env var detected, using it."
1320 % default)
Brian Harring1d7ba942012-04-24 06:37:18 -07001321 default = default.lower()
1322 if default == 'local':
1323 options.local = True
1324 elif default == 'remote':
1325 options.remote = True
1326 elif default == 'buildbot':
1327 options.buildbot = True
1328 else:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001329 cros_build_lib.Die("CBUILDBOT_DEFAULT_MODE value %s isn't supported. "
1330 % default)
Ryan Cui85867972012-02-23 18:21:49 -08001331
1332
1333def _ParseCommandLine(parser, argv):
1334 """Completely parse the commandline arguments"""
Brian Harring3fec5a82012-03-01 05:57:03 -08001335 (options, args) = parser.parse_args(argv)
Brian Harring37e559b2012-05-22 20:47:32 -07001336
1337 if options.output_api_version:
Ryan Cui724f1d32012-10-15 18:10:22 -07001338 print constants.REEXEC_API_VERSION
Brian Harring37e559b2012-05-22 20:47:32 -07001339 sys.exit(0)
1340
Ryan Cui54da0702012-04-19 18:38:08 -07001341 if options.list:
1342 _PrintValidConfigs(options.print_all)
1343 sys.exit(0)
1344
Ryan Cui8be16062012-04-24 12:05:26 -07001345 # Strip out null arguments.
1346 # TODO(rcui): Remove when buildbot is fixed
1347 args = [arg for arg in args if arg]
1348 if not args:
1349 parser.error('Invalid usage. Use -h to see usage. Use -l to list '
1350 'supported configs.')
1351
Ryan Cui85867972012-02-23 18:21:49 -08001352 _FinishParsing(options, args)
1353 return options, args
1354
1355
Matt Tennant759e2352013-09-27 15:14:44 -07001356# TODO(build): This function is too damn long.
Ryan Cui85867972012-02-23 18:21:49 -08001357def main(argv):
David James59a0a2b2013-03-22 14:04:44 -07001358 # Turn on strict sudo checks.
1359 cros_build_lib.STRICT_SUDO = True
1360
Ryan Cui85867972012-02-23 18:21:49 -08001361 # Set umask to 022 so files created by buildbot are readable.
Mike Frysinger60ec1012013-10-21 00:11:10 -04001362 os.umask(0o22)
Ryan Cui85867972012-02-23 18:21:49 -08001363
Ryan Cui85867972012-02-23 18:21:49 -08001364 parser = _CreateParser()
1365 (options, args) = _ParseCommandLine(parser, argv)
Brian Harring3fec5a82012-03-01 05:57:03 -08001366
Brian Harringae0a5322012-09-15 01:46:51 -07001367 _PostParseCheck(parser, options, args)
Brian Harring3fec5a82012-03-01 05:57:03 -08001368
Mike Frysinger8fd67dc2012-12-03 23:51:18 -05001369 cros_build_lib.AssertOutsideChroot()
Zdenek Behan98ec2fb2012-08-31 17:12:18 +02001370
Brian Harring3fec5a82012-03-01 05:57:03 -08001371 if options.remote:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001372 cros_build_lib.logger.setLevel(logging.WARNING)
Ryan Cui16ca5812012-03-08 20:34:27 -08001373
Brian Harring3fec5a82012-03-01 05:57:03 -08001374 # Verify configs are valid.
Dan Shi0bdb7132013-07-30 16:22:12 -07001375 # If hwtest flag is enabled, post a warning that HWTest step may fail if the
1376 # specified board is not a released platform or it is a generic overlay.
Brian Harring3fec5a82012-03-01 05:57:03 -08001377 for bot in args:
Aviv Kesheta96a2a92013-02-05 17:21:51 -08001378 build_config = _GetConfig(bot)
1379 if options.hwtest:
Dan Shi0bdb7132013-07-30 16:22:12 -07001380 cros_build_lib.Warning(
1381 'If %s is not a released platform or it is a generic overlay, '
1382 'the HWTest step will most likely not run; please ask the lab '
1383 'team for help if this is unexpected.' % build_config['boards'])
Brian Harring3fec5a82012-03-01 05:57:03 -08001384
1385 # Verify gerrit patches are valid.
Ryan Cui16ca5812012-03-08 20:34:27 -08001386 print 'Verifying patches...'
Ryan Cuie1e4e662012-05-21 16:39:46 -07001387 patch_pool = AcquirePoolFromOptions(options)
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001388
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001389 # --debug need to be explicitly passed through for remote invocations.
1390 if options.buildbot and '--debug' not in options.pass_through_args:
1391 _ConfirmRemoteBuildbotRun()
1392
Ryan Cui16ca5812012-03-08 20:34:27 -08001393 print 'Submitting tryjob...'
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001394 tryjob = remote_try.RemoteTryJob(options, args, patch_pool.local_patches)
Ryan Cuia25d8eb2012-07-11 14:54:27 -07001395 tryjob.Submit(testjob=options.test_tryjob, dryrun=False)
Ryan Cui16ca5812012-03-08 20:34:27 -08001396 print 'Tryjob submitted!'
1397 print ('Go to %s to view the status of your job.'
Ryan Cui4906e1c2012-04-03 20:09:34 -07001398 % tryjob.GetTrybotWaterfallLink())
Brian Harring3fec5a82012-03-01 05:57:03 -08001399 sys.exit(0)
Matt Tennant759e2352013-09-27 15:14:44 -07001400
Ryan Cui54da0702012-04-19 18:38:08 -07001401 elif (not options.buildbot and not options.remote_trybot
1402 and not options.resume and not options.local):
Ryan Cui88b901c2013-06-21 11:35:30 -07001403 options.local = True
Brian Harring1b8c4c82012-05-29 23:03:04 -07001404 cros_build_lib.Warning(
1405 'Running in LOCAL TRYBOT mode! Use --remote to submit REMOTE '
1406 'tryjobs. Use --local to suppress this message.')
1407 cros_build_lib.Warning(
Ryan Cui51591352012-07-09 15:15:53 -07001408 'In the future, --local will be required to run the local '
Brian Harring1b8c4c82012-05-29 23:03:04 -07001409 'trybot.')
Ryan Cui54da0702012-04-19 18:38:08 -07001410 time.sleep(5)
Brian Harring3fec5a82012-03-01 05:57:03 -08001411
Matt Tennant759e2352013-09-27 15:14:44 -07001412 # Only one config arg is allowed in this mode, which was confirmed earlier.
Ryan Cui8be16062012-04-24 12:05:26 -07001413 bot_id = args[-1]
1414 build_config = _GetConfig(bot_id)
Brian Harring3fec5a82012-03-01 05:57:03 -08001415
1416 if options.reference_repo is None:
Ryan Cui5ba7e152012-05-10 14:36:52 -07001417 repo_path = os.path.join(options.sourceroot, '.repo')
Brian Harring3fec5a82012-03-01 05:57:03 -08001418 # If we're being run from a repo checkout, reuse the repo's git pool to
1419 # cut down on sync time.
1420 if os.path.exists(repo_path):
Ryan Cui5ba7e152012-05-10 14:36:52 -07001421 options.reference_repo = options.sourceroot
Brian Harring3fec5a82012-03-01 05:57:03 -08001422 elif options.reference_repo:
1423 if not os.path.exists(options.reference_repo):
1424 parser.error('Reference path %s does not exist'
1425 % (options.reference_repo,))
1426 elif not os.path.exists(os.path.join(options.reference_repo, '.repo')):
1427 parser.error('Reference path %s does not look to be the base of a '
1428 'repo checkout; no .repo exists in the root.'
1429 % (options.reference_repo,))
Ryan Cuid4a24212012-04-04 18:08:12 -07001430
Brian Harringf11bf682012-05-14 15:53:43 -07001431 if (options.buildbot or options.remote_trybot) and not options.resume:
Brian Harring470f6112012-03-02 11:47:10 -08001432 if not options.cgroups:
Ryan Cuid4a24212012-04-04 18:08:12 -07001433 parser.error('Options --buildbot/--remote-trybot and --nocgroups cannot '
1434 'be used together. Cgroup support is required for '
1435 'buildbot/remote-trybot mode.')
Mike Frysingera78a56e2012-11-20 06:02:30 -05001436 if not cgroups.Cgroup.IsSupported():
Ryan Cuid4a24212012-04-04 18:08:12 -07001437 parser.error('Option --buildbot/--remote-trybot was given, but this '
1438 'system does not support cgroups. Failing.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001439
David Jamesaad5cc72012-10-26 15:03:13 -07001440 missing = osutils.FindMissingBinaries(_BUILDBOT_REQUIRED_BINARIES)
Brian Harring351ce442012-03-09 16:38:14 -08001441 if missing:
Ryan Cuid4a24212012-04-04 18:08:12 -07001442 parser.error("Option --buildbot/--remote-trybot requires the following "
1443 "binaries which couldn't be found in $PATH: %s"
Brian Harring351ce442012-03-09 16:38:14 -08001444 % (', '.join(missing)))
1445
Brian Harring3fec5a82012-03-01 05:57:03 -08001446 if options.reference_repo:
1447 options.reference_repo = os.path.abspath(options.reference_repo)
1448
1449 if options.dump_config:
1450 # This works, but option ordering is bad...
1451 print 'Configuration %s:' % bot_id
1452 pretty_printer = pprint.PrettyPrinter(indent=2)
1453 pretty_printer.pprint(build_config)
1454 sys.exit(0)
1455
1456 if not options.buildroot:
1457 if options.buildbot:
Mike Frysinger6903c762012-12-04 01:57:16 -05001458 parser.error('Please specify a buildroot with the --buildbot option.')
Matt Tennantd55b1f42012-04-13 14:15:01 -07001459
Ryan Cui5ba7e152012-05-10 14:36:52 -07001460 options.buildroot = _DetermineDefaultBuildRoot(options.sourceroot,
1461 build_config['internal'])
Brian Harring470f6112012-03-02 11:47:10 -08001462 # We use a marker file in the buildroot to indicate the user has
1463 # consented to using this directory.
1464 if not os.path.exists(repository.GetTrybotMarkerPath(options.buildroot)):
1465 _ConfirmBuildRoot(options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -08001466
1467 # Sanity check of buildroot- specifically that it's not pointing into the
1468 # midst of an existing repo since git-repo doesn't support nesting.
Brian Harring3fec5a82012-03-01 05:57:03 -08001469 if (not repository.IsARepoRoot(options.buildroot) and
David James13a69c92013-05-09 10:37:42 -07001470 git.FindRepoDir(options.buildroot)):
Brian Harring3fec5a82012-03-01 05:57:03 -08001471 parser.error('Configured buildroot %s points into a repository checkout, '
1472 'rather than the root of it. This is not supported.'
1473 % options.buildroot)
1474
Chris Sosab5ea3b42012-10-25 15:25:20 -07001475 if not options.log_dir:
1476 options.log_dir = os.path.join(options.buildroot, _DEFAULT_LOG_DIR)
1477
Brian Harringd166aaf2012-05-14 18:31:53 -07001478 log_file = None
1479 if options.tee:
Chris Sosab5ea3b42012-10-25 15:25:20 -07001480 log_file = os.path.join(options.log_dir, _BUILDBOT_LOG_FILE)
1481 osutils.SafeMakedirs(options.log_dir)
Brian Harringd166aaf2012-05-14 18:31:53 -07001482 _BackupPreviousLog(log_file)
1483
Brian Harring1b8c4c82012-05-29 23:03:04 -07001484 with cros_build_lib.ContextManagerStack() as stack:
Aaron Gable881fccb2013-09-27 18:35:24 -07001485 # TODO(ferringb): update this once
1486 # https://chromium-review.googlesource.com/25359
David Jamescebc7272013-07-17 16:45:05 -07001487 # is landed- it's sensitive to the manifest-versions cache path.
1488 options.preserve_paths = set(['manifest-versions', '.cache',
1489 'manifest-versions-internal'])
1490 if log_file is not None:
1491 # We don't want the critical section to try to clean up the tee process,
1492 # so we run Tee (forked off) outside of it. This prevents a deadlock
1493 # because the Tee process only exits when its pipe is closed, and the
1494 # critical section accidentally holds on to that file handle.
1495 stack.Add(tee.Tee, log_file)
1496 options.preserve_paths.add(_DEFAULT_LOG_DIR)
1497
Brian Harringc2d09d92012-05-13 22:03:15 -07001498 critical_section = stack.Add(cleanup.EnforcedCleanupSection)
1499 stack.Add(sudo.SudoKeepAlive)
Brian Harringd166aaf2012-05-14 18:31:53 -07001500
Brian Harringc2d09d92012-05-13 22:03:15 -07001501 if not options.resume:
Brian Harring2bf55e12012-05-13 21:31:55 -07001502 # If we're in resume mode, use our parents tempdir rather than
1503 # nesting another layer.
David James4bc13702013-03-26 08:08:04 -07001504 stack.Add(osutils.TempDir, prefix='cbuildbot-tmp', set_global=True)
Brian Harringc2d09d92012-05-13 22:03:15 -07001505 logging.debug("Cbuildbot tempdir is %r.", os.environ.get('TMP'))
Brian Harringd166aaf2012-05-14 18:31:53 -07001506
Brian Harringc2d09d92012-05-13 22:03:15 -07001507 if options.cgroups:
1508 stack.Add(cgroups.SimpleContainChildren, 'cbuildbot')
Brian Harringa184efa2012-03-04 11:51:25 -08001509
Brian Harringc2d09d92012-05-13 22:03:15 -07001510 # Mark everything between EnforcedCleanupSection and here as having to
1511 # be rolled back via the contextmanager cleanup handlers. This
1512 # ensures that sudo bits cannot outlive cbuildbot, that anything
1513 # cgroups would kill gets killed, etc.
David Jamesfb3aac92013-10-16 13:26:52 -07001514 stack.Add(critical_section.ForkWatchdog)
Brian Harringd166aaf2012-05-14 18:31:53 -07001515
Brian Harringc2d09d92012-05-13 22:03:15 -07001516 if options.timeout > 0:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001517 stack.Add(cros_build_lib.Timeout, options.timeout)
Brian Harringa184efa2012-03-04 11:51:25 -08001518
Brian Harringc2d09d92012-05-13 22:03:15 -07001519 if not options.buildbot:
1520 build_config = cbuildbot_config.OverrideConfigForTrybot(
1521 build_config,
David Jamese8dcfc42013-03-21 19:49:49 -07001522 options)
Brian Harringc2d09d92012-05-13 22:03:15 -07001523
Mike Frysinger6903c762012-12-04 01:57:16 -05001524 if options.buildbot or options.remote_trybot:
1525 _DisableYamaHardLinkChecks()
1526
Brian Harringc2d09d92012-05-13 22:03:15 -07001527 _RunBuildStagesWrapper(options, build_config)