blob: f0c17cd131d01482eb8006943a2923da4c0d4cef [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
206 def RunStages(self):
207 """Subclasses must override this method. Runs the appropriate code."""
208 raise NotImplementedError()
209
Brian Harring3fec5a82012-03-01 05:57:03 -0800210 def _ShouldReExecuteInBuildRoot(self):
211 """Returns True if this build should be re-executed in the buildroot."""
Ryan Cui88b901c2013-06-21 11:35:30 -0700212 # The commandline --noreexec flag can override the config.
213 if not (self.options.postsync_reexec and
214 self.build_config['postsync_reexec']):
215 return False
216
Brian Harring3fec5a82012-03-01 05:57:03 -0800217 abs_buildroot = os.path.abspath(self.options.buildroot)
218 return not os.path.abspath(__file__).startswith(abs_buildroot)
219
220 def _ReExecuteInBuildroot(self, sync_instance):
221 """Reexecutes self in buildroot and returns True if build succeeds.
222
223 This allows the buildbot code to test itself when changes are patched for
224 buildbot-related code. This is a no-op if the buildroot == buildroot
225 of the running chromite checkout.
226
227 Args:
228 sync_instance: Instance of the sync stage that was run to sync.
229
230 Returns:
231 True if the Build succeeded.
232 """
Brian Harring3fec5a82012-03-01 05:57:03 -0800233 if not self.options.resume:
Ryan Cuif7f24692012-05-18 16:35:33 -0700234 results_lib.WriteCheckpoint(self.options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800235
Ryan Cui1c13a252012-10-16 15:00:16 -0700236 args = stages.BootstrapStage.FilterArgsForTargetCbuildbot(
237 self.options.buildroot, constants.PATH_TO_CBUILDBOT, self.options)
Brian Harring37e559b2012-05-22 20:47:32 -0700238
David James2333c182013-02-13 16:16:15 -0800239 # Specify a buildroot explicitly (just in case, for local trybot).
Brian Harring3fec5a82012-03-01 05:57:03 -0800240 # Suppress any timeout options given from the commandline in the
241 # invoked cbuildbot; our timeout will enforce it instead.
Ryan Cui1c13a252012-10-16 15:00:16 -0700242 args += ['--resume', '--timeout', '0', '--notee', '--nocgroups',
243 '--buildroot', os.path.abspath(self.options.buildroot)]
Brian Harringae0a5322012-09-15 01:46:51 -0700244
Brian Harring3fec5a82012-03-01 05:57:03 -0800245 if stages.ManifestVersionedSyncStage.manifest_manager:
246 ver = stages.ManifestVersionedSyncStage.manifest_manager.current_version
Ryan Cui1c13a252012-10-16 15:00:16 -0700247 args += ['--version', ver]
Brian Harring3fec5a82012-03-01 05:57:03 -0800248
David Jamesf421c6d2013-04-11 15:37:57 -0700249 pool = getattr(sync_instance, 'pool', None)
250 if pool:
251 filename = os.path.join(self.options.buildroot, 'validation_pool.dump')
252 pool.Save(filename)
253 args += ['--validation_pool', filename]
Brian Harring3fec5a82012-03-01 05:57:03 -0800254
David Jamesac8c2a72013-02-13 18:44:33 -0800255 # Reset the cache dir so that the child will calculate it automatically.
256 if not self.options.cache_dir_specified:
257 commandline.BaseParser.ConfigureCacheDir(None)
258
Brian Harring3fec5a82012-03-01 05:57:03 -0800259 # Re-run the command in the buildroot.
260 # Finally, be generous and give the invoked cbuildbot 30s to shutdown
261 # when something occurs. It should exit quicker, but the sigterm may
262 # hit while the system is particularly busy.
Brian Harring1b8c4c82012-05-29 23:03:04 -0700263 return_obj = cros_build_lib.RunCommand(
Ryan Cui1c13a252012-10-16 15:00:16 -0700264 args, cwd=self.options.buildroot, error_code_ok=True, kill_timeout=30)
Brian Harring3fec5a82012-03-01 05:57:03 -0800265 return return_obj.returncode == 0
266
Ryan Cuif7f24692012-05-18 16:35:33 -0700267 def _InitializeTrybotPatchPool(self):
268 """Generate patch pool from patches specified on the command line.
269
270 Do this only if we need to patch changes later on.
271 """
272 changes_stage = stages.PatchChangesStage.StageNamePrefix()
273 check_func = results_lib.Results.PreviouslyCompletedRecord
274 if not check_func(changes_stage) or self.options.bootstrap:
Ryan Cuie1e4e662012-05-21 16:39:46 -0700275 self.patch_pool = AcquirePoolFromOptions(self.options)
Ryan Cuif7f24692012-05-18 16:35:33 -0700276
277 def _GetBootstrapStage(self):
278 """Constructs and returns the BootStrapStage object.
279
280 We return None when there are no chromite patches to test, and
281 --test-bootstrap wasn't passed in.
282 """
283 stage = None
284 chromite_pool = self.patch_pool.Filter(project=constants.CHROMITE_PROJECT)
Ryan Cui5616a512012-08-17 13:39:36 -0700285 manifest_pool = self.patch_pool.FilterManifest()
David James97d95872012-11-16 15:09:56 -0800286 chromite_branch = git.GetChromiteTrackingBranch()
Ryan Cui5616a512012-08-17 13:39:36 -0700287 if (chromite_pool or manifest_pool or self.options.test_bootstrap
Ryan Cuie1e4e662012-05-21 16:39:46 -0700288 or chromite_branch != self.options.branch):
Ryan Cuif7f24692012-05-18 16:35:33 -0700289 stage = stages.BootstrapStage(self.options, self.build_config,
Ryan Cui5616a512012-08-17 13:39:36 -0700290 chromite_pool, manifest_pool)
Ryan Cuif7f24692012-05-18 16:35:33 -0700291 return stage
292
Brian Harring3fec5a82012-03-01 05:57:03 -0800293 def Run(self):
Ryan Cuif7f24692012-05-18 16:35:33 -0700294 """Main runner for this builder class. Runs build and prints summary.
295
296 Returns:
297 Whether the build succeeded.
298 """
299 self._InitializeTrybotPatchPool()
300
301 if self.options.bootstrap:
302 bootstrap_stage = self._GetBootstrapStage()
303 if bootstrap_stage:
304 # BootstrapStage blocks on re-execution of cbuildbot.
305 bootstrap_stage.Run()
306 return bootstrap_stage.returncode == 0
307
Brian Harring3fec5a82012-03-01 05:57:03 -0800308 print_report = True
David James3d4d3502012-04-09 15:12:06 -0700309 exception_thrown = False
Brian Harring3fec5a82012-03-01 05:57:03 -0800310 success = True
David James9ebb2a42013-08-13 20:29:57 -0700311 sync_instance = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800312 try:
313 self.Initialize()
314 sync_instance = self.GetSyncInstance()
315 sync_instance.Run()
316 self._SetReleaseTag()
317
Ryan Cui88b901c2013-06-21 11:35:30 -0700318 if self.options.postsync_patch and self.build_config['postsync_patch']:
319 # Filter out patches to manifest, since PatchChangesStage can't handle
320 # them. Manifest patches are patched in the BootstrapStage.
321 non_manifest_patches = self.patch_pool.FilterManifest(negate=True)
322 if non_manifest_patches:
323 self._RunStage(stages.PatchChangesStage, non_manifest_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800324
325 if self._ShouldReExecuteInBuildRoot():
326 print_report = False
327 success = self._ReExecuteInBuildroot(sync_instance)
328 else:
329 self.RunStages()
Matt Tennant759e2352013-09-27 15:14:44 -0700330
David James3541a132013-03-18 13:21:58 -0700331 except Exception as ex:
332 # If the build is marked as successful, but threw exceptions, that's a
333 # problem.
David James7fbf2d42012-07-14 18:23:49 -0700334 exception_thrown = True
David James3541a132013-03-18 13:21:58 -0700335 if results_lib.Results.BuildSucceededSoFar():
336 traceback.print_exc(file=sys.stdout)
David James7fbf2d42012-07-14 18:23:49 -0700337 raise
Matt Tennant759e2352013-09-27 15:14:44 -0700338
David James3541a132013-03-18 13:21:58 -0700339 if not (print_report and isinstance(ex, results_lib.StepFailure)):
340 raise
Matt Tennant759e2352013-09-27 15:14:44 -0700341
Brian Harring3fec5a82012-03-01 05:57:03 -0800342 finally:
343 if print_report:
Ryan Cuif7f24692012-05-18 16:35:33 -0700344 results_lib.WriteCheckpoint(self.options.buildroot)
Mike Frysinger9b223362013-03-04 21:54:26 -0500345 self._RunStage(stages.ReportStage, self.archive_stages,
David James9ebb2a42013-08-13 20:29:57 -0700346 self.release_tag, sync_instance)
Brian Harring3fec5a82012-03-01 05:57:03 -0800347 success = results_lib.Results.BuildSucceededSoFar()
David James3d4d3502012-04-09 15:12:06 -0700348 if exception_thrown and success:
349 success = False
David Jamesbb20ac82012-07-18 10:59:16 -0700350 cros_build_lib.PrintBuildbotStepWarnings()
351 print """\
David James3d4d3502012-04-09 15:12:06 -0700352Exception thrown, but all stages marked successful. This is an internal error,
353because the stage that threw the exception should be marked as failing."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800354
355 return success
356
357
David James1fddb8f2013-04-25 15:23:07 -0700358BoardConfig = collections.namedtuple('BoardConfig', ['board', 'name'])
359
360
Brian Harring3fec5a82012-03-01 05:57:03 -0800361class SimpleBuilder(Builder):
362 """Builder that performs basic vetting operations."""
363
364 def GetSyncInstance(self):
365 """Sync to lkgm or TOT as necessary.
366
Matt Tennant759e2352013-09-27 15:14:44 -0700367 Returns: the instance of the sync stage to run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800368 """
Ryan Cui88b901c2013-06-21 11:35:30 -0700369 if self.options.force_version:
370 sync_stage = self._GetStageInstance(stages.ManifestVersionedSyncStage)
371 elif self.build_config['use_lkgm']:
Brian Harring3fec5a82012-03-01 05:57:03 -0800372 sync_stage = self._GetStageInstance(stages.LKGMSyncStage)
Chris Sosa52a81b62012-11-14 06:12:54 -0800373 elif self.build_config['use_chrome_lkgm']:
374 sync_stage = self._GetStageInstance(stages.ChromeLKGMSyncStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800375 else:
376 sync_stage = self._GetStageInstance(stages.SyncStage)
377
378 return sync_stage
379
David James4f2d8302013-03-19 06:35:58 -0700380 @staticmethod
381 def _RunParallelStages(stage_objs):
Matt Tennant759e2352013-09-27 15:14:44 -0700382 """Run the specified stages in parallel.
383
384 Args:
385 stage_objs: BuilderStage objects.
386 """
David James4f2d8302013-03-19 06:35:58 -0700387 steps = [stage.Run for stage in stage_objs]
388 try:
389 parallel.RunParallelSteps(steps)
390 except BaseException as ex:
391 # If a stage threw an exception, it might not have correctly reported
392 # results (e.g. because it was killed before it could report the
393 # results.) In this case, attribute the exception to any stages that
394 # didn't report back correctly (if any).
395 for stage in stage_objs:
396 if not results_lib.Results.StageHasResults(stage.name):
397 results_lib.Results.Record(stage.name, ex, str(ex))
Matt Tennant759e2352013-09-27 15:14:44 -0700398
David James4f2d8302013-03-19 06:35:58 -0700399 raise
400
David James1fddb8f2013-04-25 15:23:07 -0700401 def _RunBackgroundStagesForBoard(self, config, board, compilecheck):
Matt Tennant759e2352013-09-27 15:14:44 -0700402 """Run background board-specific stages for the specified board.
403
404 Args:
405 config: Build config dict.
406 board: Board name.
407 compilecheck: Boolean. If True, run only the compile steps.
408 """
David James1fddb8f2013-04-25 15:23:07 -0700409 archive_stage = self.archive_stages[BoardConfig(board, config['name'])]
410 if config['pgo_generate']:
Ahmad Sharifa2db40a2013-07-22 13:51:52 -0400411 self._RunParallelStages([archive_stage])
David James1fddb8f2013-04-25 15:23:07 -0700412 return
Matt Tennant759e2352013-09-27 15:14:44 -0700413
David James565bc9a2013-04-08 14:54:45 -0700414 if compilecheck:
415 self._RunStage(stages.BuildPackagesStage, board, archive_stage,
416 config=config)
417 self._RunStage(stages.UnitTestStage, board, config=config)
418 return
Matt Tennant759e2352013-09-27 15:14:44 -0700419
Ryan Cui3ea98e02013-08-07 16:01:48 -0700420 stage_list = []
421 if self.options.chrome_sdk and self.build_config['chrome_sdk']:
422 stage_list.append([stages.ChromeSDKStage, board, archive_stage])
423 stage_list += [[stages.VMTestStage, board, archive_stage],
424 [stages.SignerTestStage, board, archive_stage],
425 [stages.UnitTestStage, board],
426 [stages.UploadPrebuiltsStage, board, archive_stage],
427 [stages.DevInstallerPrebuiltsStage, board, archive_stage]]
Brian Harring3fec5a82012-03-01 05:57:03 -0800428
David James58e0c092012-03-04 20:31:12 -0800429 # We can not run hw tests without archiving the payloads.
430 if self.options.archive:
Chris Sosaba250522013-03-27 18:57:34 -0700431 for suite_config in config['hw_tests']:
432 if suite_config.async:
433 stage_list.append([stages.ASyncHWTestStage, board, archive_stage,
434 suite_config])
435 elif suite_config.suite == constants.HWTEST_AU_SUITE:
436 stage_list.append([stages.AUTestStage, board, archive_stage,
437 suite_config])
Chris Sosa077df812013-01-25 17:05:28 -0800438 else:
Chris Sosaba250522013-03-27 18:57:34 -0700439 stage_list.append([stages.HWTestStage, board, archive_stage,
440 suite_config])
Chris Sosa817b1f92012-07-19 15:00:23 -0700441
David James4f2d8302013-03-19 06:35:58 -0700442 stage_objs = [self._GetStageInstance(*x, config=config) for x in stage_list]
443 self._RunParallelStages(stage_objs + [archive_stage])
Brian Harring3fec5a82012-03-01 05:57:03 -0800444
445 def RunStages(self):
446 """Runs through build process."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800447 # TODO(sosa): Split these out into classes.
David James816a5942013-04-11 22:59:32 -0700448 if self.build_config['build_type'] == constants.PRE_CQ_LAUNCHER_TYPE:
449 self._RunStage(stages.PreCQLauncherStage)
Ryan Cui88b901c2013-06-21 11:35:30 -0700450 elif self.build_config['build_type'] == constants.CREATE_BRANCH_TYPE:
451 self._RunStage(stages.BranchUtilStage)
David James816a5942013-04-11 22:59:32 -0700452 elif self.build_config['build_type'] == constants.CHROOT_BUILDER_TYPE:
Mike Frysingerfddaeb52012-11-20 11:17:31 -0500453 self._RunStage(stages.UprevStage, boards=[], enter_chroot=False)
David James59a0a2b2013-03-22 14:04:44 -0700454 self._RunStage(stages.InitSDKStage)
455 self._RunStage(stages.SetupBoardStage, [constants.CHROOT_BUILDER_BOARD])
David Jamesa0a664e2013-02-13 09:52:01 -0800456 self._RunStage(stages.SyncChromeStage)
David James9e27e662013-02-14 13:42:43 -0800457 self._RunStage(stages.PatchChromeStage)
Zdenek Behan62a57792012-08-31 15:09:08 +0200458 self._RunStage(stages.SDKPackageStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800459 self._RunStage(stages.SDKTestStage)
460 self._RunStage(stages.UploadPrebuiltsStage,
Chris Sosa6a5dceb2012-05-14 13:48:56 -0700461 constants.CHROOT_BUILDER_BOARD, None)
Brian Harring3fec5a82012-03-01 05:57:03 -0800462 elif self.build_config['build_type'] == constants.REFRESH_PACKAGES_TYPE:
David James59a0a2b2013-03-22 14:04:44 -0700463 self._RunStage(stages.InitSDKStage)
464 self._RunStage(stages.SetupBoardStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800465 self._RunStage(stages.RefreshPackageStatusStage)
466 else:
David James59a0a2b2013-03-22 14:04:44 -0700467 self._RunStage(stages.InitSDKStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800468 self._RunStage(stages.UprevStage)
David James59a0a2b2013-03-22 14:04:44 -0700469 self._RunStage(stages.SetupBoardStage)
Matt Tennant759e2352013-09-27 15:14:44 -0700470
Mike Frysingerb1677a72013-04-25 17:38:16 -0400471 # We need a handle to this stage to extract info from it.
Matt Tennant759e2352013-09-27 15:14:44 -0700472 # TODO(mtennant): Just have _RunStage return the stage object, since
473 # nothing uses the return value of _RunStage now, and the Run method
474 # of stage objects does not appear to return anything, either.
Mike Frysingerb1677a72013-04-25 17:38:16 -0400475 sync_chrome_stage = self._GetStageInstance(stages.SyncChromeStage)
476 sync_chrome_stage.Run()
David James9e27e662013-02-14 13:42:43 -0800477 self._RunStage(stages.PatchChromeStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800478
Matt Tennant759e2352013-09-27 15:14:44 -0700479 # Prepare stages to run in background.
David James1fddb8f2013-04-25 15:23:07 -0700480 configs = self.build_config['child_configs'] or [self.build_config]
481 tasks = []
482 for config in configs:
483 for board in config['boards']:
Mike Frysingerb1677a72013-04-25 17:38:16 -0400484 archive_stage = self._GetStageInstance(
485 stages.ArchiveStage, board, self.release_tag, config=config,
486 chrome_version=sync_chrome_stage.chrome_version)
David James1fddb8f2013-04-25 15:23:07 -0700487 board_config = BoardConfig(board, config['name'])
488 self.archive_stages[board_config] = archive_stage
489 tasks.append((config, board, archive_stage))
David James58e0c092012-03-04 20:31:12 -0800490
David James944a48e2012-03-07 12:19:03 -0800491 # Set up a process pool to run test/archive stages in the background.
492 # This process runs task(board) for each board added to the queue.
Matt Tennant759e2352013-09-27 15:14:44 -0700493 task_runner = self._RunBackgroundStagesForBoard
494 with parallel.BackgroundTaskRunner(task_runner) as queue:
David James1fddb8f2013-04-25 15:23:07 -0700495 for config, board, archive_stage in tasks:
496 compilecheck = config['compilecheck'] or self.options.compilecheck
David James565bc9a2013-04-08 14:54:45 -0700497 if not compilecheck:
David James1fddb8f2013-04-25 15:23:07 -0700498 # Run BuildPackages and BuildImage in the foreground, generating
499 # or using PGO data if requested.
500 kwargs = {'archive_stage': archive_stage, 'config': config}
501 if config['pgo_generate']:
502 kwargs['pgo_generate'] = True
503 elif config['pgo_use']:
504 kwargs['pgo_use'] = True
Matt Tennant759e2352013-09-27 15:14:44 -0700505
David James1fddb8f2013-04-25 15:23:07 -0700506 self._RunStage(stages.BuildPackagesStage, board, **kwargs)
507 self._RunStage(stages.BuildImageStage, board, **kwargs)
David James138b0af2013-03-19 14:38:57 -0700508
David James1fddb8f2013-04-25 15:23:07 -0700509 if config['pgo_generate']:
510 suite = cbuildbot_config.PGORecordTest()
511 self._RunStage(stages.HWTestStage, board, archive_stage, suite,
512 config=config)
David James58e0c092012-03-04 20:31:12 -0800513
David James1fddb8f2013-04-25 15:23:07 -0700514 # Kick off our background stages.
515 queue.put([config, board, compilecheck])
David James58e0c092012-03-04 20:31:12 -0800516
Brian Harring3fec5a82012-03-01 05:57:03 -0800517
518class DistributedBuilder(SimpleBuilder):
519 """Build class that has special logic to handle distributed builds.
520
521 These builds sync using git/manifest logic in manifest_versions. In general
522 they use a non-distributed builder code for the bulk of the work.
523 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700524 def __init__(self, *args, **kwargs):
Brian Harring3fec5a82012-03-01 05:57:03 -0800525 """Initializes a buildbot builder.
526
527 Extra variables:
528 completion_stage_class: Stage used to complete a build. Set in the Sync
529 stage.
530 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700531 super(DistributedBuilder, self).__init__(*args, **kwargs)
Brian Harring3fec5a82012-03-01 05:57:03 -0800532 self.completion_stage_class = None
David Jamesf421c6d2013-04-11 15:37:57 -0700533 self.sync_stage = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800534
535 def GetSyncInstance(self):
536 """Syncs the tree using one of the distributed sync logic paths.
537
Matt Tennant759e2352013-09-27 15:14:44 -0700538 Returns: the instance of the sync stage to run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800539 """
540 # Determine sync class to use. CQ overrides PFQ bits so should check it
541 # first.
David Jamesf421c6d2013-04-11 15:37:57 -0700542 if self.build_config['pre_cq'] or self.options.pre_cq:
543 sync_stage = self._GetStageInstance(stages.PreCQSyncStage,
544 self.patch_pool.gerrit_patches)
545 self.completion_stage_class = stages.PreCQCompletionStage
546 self.patch_pool.gerrit_patches = []
547 elif cbuildbot_config.IsCQType(self.build_config['build_type']):
Brian Harring3fec5a82012-03-01 05:57:03 -0800548 sync_stage = self._GetStageInstance(stages.CommitQueueSyncStage)
549 self.completion_stage_class = stages.CommitQueueCompletionStage
550 elif cbuildbot_config.IsPFQType(self.build_config['build_type']):
551 sync_stage = self._GetStageInstance(stages.LKGMCandidateSyncStage)
552 self.completion_stage_class = stages.LKGMCandidateSyncCompletionStage
553 else:
554 sync_stage = self._GetStageInstance(stages.ManifestVersionedSyncStage)
555 self.completion_stage_class = stages.ManifestVersionedSyncCompletionStage
556
David Jamesf421c6d2013-04-11 15:37:57 -0700557 self.sync_stage = sync_stage
558 return self.sync_stage
Brian Harring3fec5a82012-03-01 05:57:03 -0800559
560 def Publish(self, was_build_successful):
561 """Completes build by publishing any required information."""
562 completion_stage = self._GetStageInstance(self.completion_stage_class,
David Jamesf421c6d2013-04-11 15:37:57 -0700563 self.sync_stage,
Brian Harring3fec5a82012-03-01 05:57:03 -0800564 was_build_successful)
565 completion_stage.Run()
566 name = completion_stage.name
David Jamesf421c6d2013-04-11 15:37:57 -0700567 if (self.build_config['pre_cq'] or self.options.pre_cq or
568 not results_lib.Results.WasStageSuccessful(name)):
Brian Harring3fec5a82012-03-01 05:57:03 -0800569 should_publish_changes = False
570 else:
571 should_publish_changes = (self.build_config['master'] and
572 was_build_successful)
573
574 if should_publish_changes:
575 self._RunStage(stages.PublishUprevChangesStage)
576
577 def RunStages(self):
578 """Runs simple builder logic and publishes information to overlays."""
579 was_build_successful = False
David James843ed252013-09-11 16:18:10 -0700580 try:
581 super(DistributedBuilder, self).RunStages()
582 was_build_successful = results_lib.Results.BuildSucceededSoFar()
583 except SystemExit as ex:
584 # If a stage calls sys.exit(0), it's exiting with success, so that means
585 # we should mark ourselves as successful.
586 if ex.code == 0:
587 was_build_successful = True
588 raise
589 finally:
590 self.Publish(was_build_successful)
Brian Harring3fec5a82012-03-01 05:57:03 -0800591
Brian Harring3fec5a82012-03-01 05:57:03 -0800592
593def _ConfirmBuildRoot(buildroot):
594 """Confirm with user the inferred buildroot, and mark it as confirmed."""
Brian Harring521e7242012-11-01 16:57:42 -0700595 cros_build_lib.Warning('Using default directory %s as buildroot', buildroot)
596 if not cros_build_lib.BooleanPrompt(default=False):
597 print('Please specify a different buildroot via the --buildroot option.')
Brian Harring3fec5a82012-03-01 05:57:03 -0800598 sys.exit(0)
599
600 if not os.path.exists(buildroot):
601 os.mkdir(buildroot)
602
603 repository.CreateTrybotMarker(buildroot)
604
605
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700606def _ConfirmRemoteBuildbotRun():
607 """Confirm user wants to run with --buildbot --remote."""
Brian Harring521e7242012-11-01 16:57:42 -0700608 cros_build_lib.Warning(
609 'You are about to launch a PRODUCTION job! This is *NOT* a '
610 'trybot run! Are you sure?')
611 if not cros_build_lib.BooleanPrompt(default=False):
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700612 print('Please specify --pass-through="--debug".')
613 sys.exit(0)
614
615
Ryan Cui5ba7e152012-05-10 14:36:52 -0700616def _DetermineDefaultBuildRoot(sourceroot, internal_build):
Brian Harring3fec5a82012-03-01 05:57:03 -0800617 """Default buildroot to be under the directory that contains current checkout.
618
619 Arguments:
620 internal_build: Whether the build is an internal build
Ryan Cui5ba7e152012-05-10 14:36:52 -0700621 sourceroot: Use specified sourceroot.
Brian Harring3fec5a82012-03-01 05:57:03 -0800622 """
Ryan Cui5ba7e152012-05-10 14:36:52 -0700623 if not repository.IsARepoRoot(sourceroot):
Brian Harring1b8c4c82012-05-29 23:03:04 -0700624 cros_build_lib.Die(
625 'Could not find root of local checkout at %s. Please specify '
626 'using the --sourceroot option.' % sourceroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800627
628 # Place trybot buildroot under the directory containing current checkout.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700629 top_level = os.path.dirname(os.path.realpath(sourceroot))
Brian Harring3fec5a82012-03-01 05:57:03 -0800630 if internal_build:
631 buildroot = os.path.join(top_level, _DEFAULT_INT_BUILDROOT)
632 else:
633 buildroot = os.path.join(top_level, _DEFAULT_EXT_BUILDROOT)
634
635 return buildroot
636
637
Mike Frysinger6903c762012-12-04 01:57:16 -0500638def _DisableYamaHardLinkChecks():
639 """Disable Yama kernel hardlink security checks.
640
641 The security module disables hardlinking to files you do not have
642 write access to which causes some of our build scripts problems.
643 Disable it so we don't have to worry about it.
644 """
645 PROC_PATH = '/proc/sys/kernel/yama/protected_nonaccess_hardlinks'
646 SYSCTL_PATH = PROC_PATH[len('/proc/sys/'):].replace('/', '.')
647
648 # Yama not available in this system -- nothing to do.
649 if not os.path.exists(PROC_PATH):
650 return
651
652 # Already disabled -- nothing to do.
653 if osutils.ReadFile(PROC_PATH).strip() == '0':
654 return
655
656 # Create a hardlink in a tempdir and see if we get back EPERM.
David James4bc13702013-03-26 08:08:04 -0700657 with osutils.TempDir() as tempdir:
Mike Frysinger6903c762012-12-04 01:57:16 -0500658 try:
659 os.link('/bin/sh', os.path.join(tempdir, 'sh'))
660 except OSError as e:
661 if e.errno == errno.EPERM:
662 cros_build_lib.Warning('Disabling Yama hardlink security')
663 cros_build_lib.SudoRunCommand(['sysctl', '%s=0' % SYSCTL_PATH])
664
665
Brian Harring3fec5a82012-03-01 05:57:03 -0800666def _BackupPreviousLog(log_file, backup_limit=25):
667 """Rename previous log.
668
669 Args:
670 log_file: The absolute path to the previous log.
671 """
672 if os.path.exists(log_file):
673 old_logs = sorted(glob.glob(log_file + '.*'),
674 key=distutils.version.LooseVersion)
675
676 if len(old_logs) >= backup_limit:
677 os.remove(old_logs[0])
678
679 last = 0
680 if old_logs:
681 last = int(old_logs.pop().rpartition('.')[2])
682
683 os.rename(log_file, log_file + '.' + str(last + 1))
684
Ryan Cui5616a512012-08-17 13:39:36 -0700685
David James944a48e2012-03-07 12:19:03 -0800686def _RunBuildStagesWrapper(options, build_config):
Brian Harring3fec5a82012-03-01 05:57:03 -0800687 """Helper function that wraps RunBuildStages()."""
688 def IsDistributedBuilder():
689 """Determines whether the build_config should be a DistributedBuilder."""
David Jamesf421c6d2013-04-11 15:37:57 -0700690 if build_config['pre_cq'] or options.pre_cq:
691 return True
692 elif not options.buildbot:
Brian Harring3fec5a82012-03-01 05:57:03 -0800693 return False
694 elif build_config['build_type'] in _DISTRIBUTED_TYPES:
Brian Harring3fec5a82012-03-01 05:57:03 -0800695 # We don't do distributed logic to TOT Chrome PFQ's, nor local
696 # chrome roots (e.g. chrome try bots)
697 if chrome_rev not in [constants.CHROME_REV_TOT,
698 constants.CHROME_REV_LOCAL,
699 constants.CHROME_REV_SPEC]:
700 return True
701
702 return False
703
Brian Harring1b8c4c82012-05-29 23:03:04 -0700704 cros_build_lib.Info("cbuildbot executed with args %s"
705 % ' '.join(map(repr, sys.argv)))
Brian Harring3fec5a82012-03-01 05:57:03 -0800706
David Jamesa0a664e2013-02-13 09:52:01 -0800707 chrome_rev = build_config['chrome_rev']
708 if options.chrome_rev:
709 chrome_rev = options.chrome_rev
710 if chrome_rev == constants.CHROME_REV_TOT:
711 # Build the TOT Chrome revision.
712 svn_url = gclient.GetBaseURLs()[0]
713 options.chrome_version = gclient.GetTipOfTrunkSvnRevision(svn_url)
714 options.chrome_rev = constants.CHROME_REV_SPEC
715
David James4a404a52013-02-19 13:07:59 -0800716 # If it's likely we'll need to build Chrome, fetch the source.
Mike Frysingerf4d9ab82013-03-05 19:38:05 -0500717 if build_config['sync_chrome'] is None:
718 options.managed_chrome = (chrome_rev != constants.CHROME_REV_LOCAL and
719 (not build_config['usepkg_build_packages'] or chrome_rev or
David James3cce4642013-05-10 17:50:23 -0700720 build_config['profile'] or options.rietveld_patches))
Mike Frysingerf4d9ab82013-03-05 19:38:05 -0500721 else:
722 options.managed_chrome = build_config['sync_chrome']
David James2333c182013-02-13 16:16:15 -0800723
724 if options.managed_chrome:
725 # Tell Chrome to fetch the source locally.
726 internal = constants.USE_CHROME_INTERNAL in (build_config['useflags'] or [])
727 chrome_src = 'chrome-src-internal' if internal else 'chrome-src'
728 options.chrome_root = os.path.join(options.cache_dir, 'distfiles', 'target',
729 chrome_src)
David James9e27e662013-02-14 13:42:43 -0800730 elif options.rietveld_patches:
David James4a404a52013-02-19 13:07:59 -0800731 cros_build_lib.Die('This builder does not support Rietveld patches.')
David James2333c182013-02-13 16:16:15 -0800732
Ryan Cuif7f24692012-05-18 16:35:33 -0700733 target = DistributedBuilder if IsDistributedBuilder() else SimpleBuilder
Ryan Cuie1e4e662012-05-21 16:39:46 -0700734 buildbot = target(options, build_config)
Brian Harringd166aaf2012-05-14 18:31:53 -0700735 if not buildbot.Run():
736 sys.exit(1)
Brian Harring3fec5a82012-03-01 05:57:03 -0800737
738
739# Parser related functions
Ryan Cui5ba7e152012-05-10 14:36:52 -0700740def _CheckLocalPatches(sourceroot, local_patches):
Brian Harring3fec5a82012-03-01 05:57:03 -0800741 """Do an early quick check of the passed-in patches.
742
743 If the branch of a project is not specified we append the current branch the
744 project is on.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700745
746 Args:
747 sourceroot: The checkout where patches are coming from.
Brian Harring3fec5a82012-03-01 05:57:03 -0800748 """
Ryan Cuicedd8a52012-03-22 02:28:35 -0700749 verified_patches = []
David James97d95872012-11-16 15:09:56 -0800750 manifest = git.ManifestCheckout.Cached(sourceroot)
Ryan Cuicedd8a52012-03-22 02:28:35 -0700751 for patch in local_patches:
Brian Harring3fec5a82012-03-01 05:57:03 -0800752 components = patch.split(':')
753 if len(components) > 2:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700754 cros_build_lib.Die(
755 'Specify local patches in project[:branch] format. Got %s' % patch)
Brian Harring3fec5a82012-03-01 05:57:03 -0800756
757 # validate project
758 project = components[0]
Brian Harring3fec5a82012-03-01 05:57:03 -0800759
Brian Harring609dc4e2012-05-07 02:17:44 -0700760 try:
761 project_dir = manifest.GetProjectPath(project, True)
762 except KeyError:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700763 cros_build_lib.Die('Project %s does not exist.' % project)
Brian Harring3fec5a82012-03-01 05:57:03 -0800764
765 # If no branch was specified, we use the project's current branch.
766 if len(components) == 1:
David James97d95872012-11-16 15:09:56 -0800767 branch = git.GetCurrentBranch(project_dir)
Brian Harring3fec5a82012-03-01 05:57:03 -0800768 if not branch:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700769 cros_build_lib.Die('Project %s is not on a branch!' % project)
Brian Harring3fec5a82012-03-01 05:57:03 -0800770 else:
771 branch = components[1]
David James97d95872012-11-16 15:09:56 -0800772 if not git.DoesLocalBranchExist(project_dir, branch):
Brian Harring1b8c4c82012-05-29 23:03:04 -0700773 cros_build_lib.Die('Project %s does not have branch %s'
774 % (project, branch))
Brian Harring3fec5a82012-03-01 05:57:03 -0800775
Brian Harring609dc4e2012-05-07 02:17:44 -0700776 verified_patches.append('%s:%s' % (project, branch))
Brian Harring3fec5a82012-03-01 05:57:03 -0800777
Ryan Cuicedd8a52012-03-22 02:28:35 -0700778 return verified_patches
Brian Harring3fec5a82012-03-01 05:57:03 -0800779
780
Brian Harring3fec5a82012-03-01 05:57:03 -0800781def _CheckChromeVersionOption(_option, _opt_str, value, parser):
782 """Upgrade other options based on chrome_version being passed."""
783 value = value.strip()
784
785 if parser.values.chrome_rev is None and value:
786 parser.values.chrome_rev = constants.CHROME_REV_SPEC
787
788 parser.values.chrome_version = value
789
790
791def _CheckChromeRootOption(_option, _opt_str, value, parser):
792 """Validate and convert chrome_root to full-path form."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800793 if parser.values.chrome_rev is None:
794 parser.values.chrome_rev = constants.CHROME_REV_LOCAL
795
Ryan Cui5ba7e152012-05-10 14:36:52 -0700796 parser.values.chrome_root = value
Brian Harring3fec5a82012-03-01 05:57:03 -0800797
798
799def _CheckChromeRevOption(_option, _opt_str, value, parser):
800 """Validate the chrome_rev option."""
801 value = value.strip()
802 if value not in constants.VALID_CHROME_REVISIONS:
803 raise optparse.OptionValueError('Invalid chrome rev specified')
804
805 parser.values.chrome_rev = value
806
807
David Jamesac8c2a72013-02-13 18:44:33 -0800808def FindCacheDir(_parser, _options):
Brian Harringae0a5322012-09-15 01:46:51 -0700809 return None
810
811
Ryan Cui5ba7e152012-05-10 14:36:52 -0700812class CustomGroup(optparse.OptionGroup):
813 def add_remote_option(self, *args, **kwargs):
814 """For arguments that are passed-through to remote trybot."""
815 return optparse.OptionGroup.add_option(self, *args,
816 remote_pass_through=True,
817 **kwargs)
818
819
Ryan Cui1c13a252012-10-16 15:00:16 -0700820class CustomOption(commandline.FilteringOption):
821 """Subclass FilteringOption class to implement pass-through and api."""
Ryan Cui5ba7e152012-05-10 14:36:52 -0700822
Ryan Cui1c13a252012-10-16 15:00:16 -0700823 ACTIONS = commandline.FilteringOption.ACTIONS + ('extend',)
824 STORE_ACTIONS = commandline.FilteringOption.STORE_ACTIONS + ('extend',)
825 TYPED_ACTIONS = commandline.FilteringOption.TYPED_ACTIONS + ('extend',)
826 ALWAYS_TYPED_ACTIONS = (commandline.FilteringOption.ALWAYS_TYPED_ACTIONS +
827 ('extend',))
Ryan Cui79319ab2012-05-21 12:59:18 -0700828
Ryan Cui5ba7e152012-05-10 14:36:52 -0700829 def __init__(self, *args, **kwargs):
830 # The remote_pass_through argument specifies whether we should directly
831 # pass the argument (with its value) onto the remote trybot.
832 self.pass_through = kwargs.pop('remote_pass_through', False)
Ryan Cui1c13a252012-10-16 15:00:16 -0700833 self.api_version = int(kwargs.pop('api', '0'))
834 commandline.FilteringOption.__init__(self, *args, **kwargs)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700835
836 def take_action(self, action, dest, opt, value, values, parser):
Ryan Cui79319ab2012-05-21 12:59:18 -0700837 if action == 'extend':
Mike Frysingerd6925b52012-07-16 16:11:00 -0400838 # If there is extra spaces between each argument, we get '' which later
839 # code barfs on, so skip those. e.g. We see this with the forms:
840 # cbuildbot -p 'proj:branch ' ...
841 # cbuildbot -p ' proj:branch' ...
842 # cbuildbot -p 'proj:branch proj2:branch' ...
843 lvalue = value.split()
Ryan Cui79319ab2012-05-21 12:59:18 -0700844 values.ensure_value(dest, []).extend(lvalue)
Ryan Cui79319ab2012-05-21 12:59:18 -0700845
Ryan Cui1c13a252012-10-16 15:00:16 -0700846 commandline.FilteringOption.take_action(
847 self, action, dest, opt, value, values, parser)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700848
849
Ryan Cui1c13a252012-10-16 15:00:16 -0700850class CustomParser(commandline.FilteringParser):
Brian Harringb6cf9142012-09-01 20:43:17 -0700851
852 DEFAULT_OPTION_CLASS = CustomOption
853
854 def add_remote_option(self, *args, **kwargs):
855 """For arguments that are passed-through to remote trybot."""
Ryan Cui1c13a252012-10-16 15:00:16 -0700856 return self.add_option(*args, remote_pass_through=True, **kwargs)
Brian Harringb6cf9142012-09-01 20:43:17 -0700857
858
Brian Harring3fec5a82012-03-01 05:57:03 -0800859def _CreateParser():
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700860 """Generate and return the parser with all the options."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800861 # Parse options
862 usage = "usage: %prog [options] buildbot_config"
Brian Harringae0a5322012-09-15 01:46:51 -0700863 parser = CustomParser(usage=usage, caching=FindCacheDir)
Brian Harring3fec5a82012-03-01 05:57:03 -0800864
865 # Main options
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400866 parser.add_option('-l', '--list', action='store_true', dest='list',
867 default=False,
868 help='List the suggested trybot configs to use (see --all)')
Brian Harring3fec5a82012-03-01 05:57:03 -0800869 parser.add_option('-a', '--all', action='store_true', dest='print_all',
870 default=False,
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400871 help='List all of the buildbot configs available w/--list')
872
873 parser.add_option('--local', default=False, action='store_true',
Ryan Cui88b901c2013-06-21 11:35:30 -0700874 help='Specifies that this tryjob should be run locally. '
875 'Implies --debug.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400876 parser.add_option('--remote', default=False, action='store_true',
Ryan Cui88b901c2013-06-21 11:35:30 -0700877 help='Specifies that this tryjob should be run remotely.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400878
Ryan Cuie1e4e662012-05-21 16:39:46 -0700879 parser.add_remote_option('-b', '--branch',
880 help='The manifest branch to test. The branch to '
881 'check the buildroot out to.')
Ryan Cui5ba7e152012-05-10 14:36:52 -0700882 parser.add_option('-r', '--buildroot', dest='buildroot', type='path',
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700883 help='Root directory where source is checked out to, and '
884 'where the build occurs. For external build configs, '
885 "defaults to 'trybot' directory at top level of your "
886 'repo-managed checkout.')
887 parser.add_remote_option('--chrome_rev', default=None, type='string',
888 action='callback', dest='chrome_rev',
889 callback=_CheckChromeRevOption,
890 help=('Revision of Chrome to use, of type [%s]'
891 % '|'.join(constants.VALID_CHROME_REVISIONS)))
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700892 parser.add_remote_option('--profile', default=None, type='string',
893 action='store', dest='profile',
894 help='Name of profile to sub-specify board variant.')
Brian Harring3fec5a82012-03-01 05:57:03 -0800895
Ryan Cuif4f84be2012-07-09 18:50:41 -0700896 #
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400897 # Patch selection options.
898 #
899
900 group = CustomGroup(
901 parser,
902 'Patch Options')
903
904 group.add_remote_option('-g', '--gerrit-patches', action='extend',
905 default=[], type='string',
906 metavar="'Id1 *int_Id2...IdN'",
907 help="Space-separated list of short-form Gerrit "
908 "Change-Id's or change numbers to patch. "
909 "Please prepend '*' to internal Change-Id's")
910 group.add_remote_option('-G', '--rietveld-patches', action='extend',
911 default=[], type='string',
912 metavar="'id1[:subdir1]...idN[:subdirN]'",
913 help='Space-separated list of short-form Rietveld '
914 'issue numbers to patch. If no subdir is '
915 'specified, the src directory is used.')
916 group.add_option('-p', '--local-patches', action='extend', default=[],
917 metavar="'<project1>[:<branch1>]...<projectN>[:<branchN>]'",
918 help='Space-separated list of project branches with '
919 'patches to apply. Projects are specified by name. '
920 'If no branch is specified the current branch of the '
921 'project will be used.')
922
923 parser.add_option_group(group)
924
925 #
926 # Remote trybot options.
927 #
928
929 group = CustomGroup(
930 parser,
931 'Remote Trybot Options (--remote)')
932
933 group.add_remote_option('--hwtest', dest='hwtest', action='store_true',
934 default=False,
935 help='Run the HWTest stage (tests on real hardware)')
936 group.add_option('--remote-description', default=None,
937 help='Attach an optional description to a --remote run '
938 'to make it easier to identify the results when it '
939 'finishes')
940 group.add_option('--slaves', action='extend', default=[],
941 help='Specify specific remote tryslaves to run on (e.g. '
942 'build149-m2); if the bot is busy, it will be queued')
943 group.add_option('--test-tryjob', action='store_true',
944 default=False,
945 help='Submit a tryjob to the test repository. Will not '
946 'show up on the production trybot waterfall.')
947
948 parser.add_option_group(group)
949
950 #
Ryan Cui88b901c2013-06-21 11:35:30 -0700951 # Branch creation options.
952 #
953
954 group = CustomGroup(
955 parser,
956 'Branch Creation Options (used with branch-util)')
957
958 group.add_remote_option('--branch-name',
959 help='The branch to create or delete.')
960 group.add_remote_option('--delete-branch', default=False, action='store_true',
961 help='Delete the branch specified in --branch-name.')
962 group.add_remote_option('--rename-to', type='string',
963 help='Rename a branch to the specified name.')
964 group.add_remote_option('--force-create', default=False, action='store_true',
965 help='Overwrites an existing branch.')
966
967 parser.add_option_group(group)
968
969 #
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400970 # Advanced options.
Ryan Cuif4f84be2012-07-09 18:50:41 -0700971 #
972
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700973 group = CustomGroup(
Brian Harring3fec5a82012-03-01 05:57:03 -0800974 parser,
975 'Advanced Options',
976 'Caution: use these options at your own risk.')
977
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400978 group.add_remote_option('--bootstrap-args', action='append', default=[],
979 help='Args passed directly to the bootstrap re-exec '
980 'to skip verification by the bootstrap code')
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700981 group.add_remote_option('--buildbot', dest='buildbot', action='store_true',
982 default=False, help='This is running on a buildbot')
983 group.add_remote_option('--buildnumber', help='build number', type='int',
984 default=0)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700985 group.add_option('--chrome_root', default=None, type='path',
986 action='callback', callback=_CheckChromeRootOption,
987 dest='chrome_root', help='Local checkout of Chrome to use.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700988 group.add_remote_option('--chrome_version', default=None, type='string',
989 action='callback', dest='chrome_version',
990 callback=_CheckChromeVersionOption,
991 help='Used with SPEC logic to force a particular SVN '
992 'revision of chrome rather than the latest.')
993 group.add_remote_option('--clobber', action='store_true', dest='clobber',
994 default=False,
995 help='Clears an old checkout before syncing')
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400996 group.add_remote_option('--latest-toolchain', action='store_true',
997 default=False,
998 help='Use the latest toolchain.')
Ryan Cui5ba7e152012-05-10 14:36:52 -0700999 parser.add_option('--log_dir', dest='log_dir', type='path',
Brian Harring3fec5a82012-03-01 05:57:03 -08001000 help=('Directory where logs are stored.'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001001 group.add_remote_option('--maxarchives', dest='max_archive_builds',
1002 default=3, type='int',
1003 help="Change the local saved build count limit.")
Ryan Cuibbd3d4b2012-08-17 12:20:37 -07001004 parser.add_remote_option('--manifest-repo-url',
1005 help=('Overrides the default manifest repo url.'))
David James565bc9a2013-04-08 14:54:45 -07001006 group.add_remote_option('--compilecheck', action='store_true', default=False,
1007 help='Only verify compilation and unit tests.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001008 group.add_remote_option('--noarchive', action='store_false', dest='archive',
1009 default=True, help="Don't run archive stage.")
Ryan Cuif7f24692012-05-18 16:35:33 -07001010 group.add_remote_option('--nobootstrap', action='store_false',
1011 dest='bootstrap', default=True,
1012 help="Don't checkout and run from a standalone "
1013 "chromite repo.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001014 group.add_remote_option('--nobuild', action='store_false', dest='build',
1015 default=True,
1016 help="Don't actually build (for cbuildbot dev)")
1017 group.add_remote_option('--noclean', action='store_false', dest='clean',
1018 default=True, help="Don't clean the buildroot")
Ryan Cuif7f24692012-05-18 16:35:33 -07001019 group.add_remote_option('--nocgroups', action='store_false', dest='cgroups',
1020 default=True,
1021 help='Disable cbuildbots usage of cgroups.')
Ryan Cui3ea98e02013-08-07 16:01:48 -07001022 group.add_remote_option('--nochromesdk', action='store_false',
1023 dest='chrome_sdk', default=True,
1024 help="Don't run the ChromeSDK stage which builds "
1025 "Chrome outside of the chroot.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001026 group.add_remote_option('--noprebuilts', action='store_false',
1027 dest='prebuilts', default=True,
1028 help="Don't upload prebuilts.")
Ryan Cui88b901c2013-06-21 11:35:30 -07001029 group.add_remote_option('--nopatch', action='store_false',
1030 dest='postsync_patch', default=True,
1031 help=("Don't run PatchChanges stage. This does not "
1032 "disable patching in of chromite patches "
1033 "during BootstrapStage."))
1034 group.add_remote_option('--noreexec', action='store_false',
1035 dest='postsync_reexec', default=True,
1036 help="Don't reexec into the buildroot after syncing.")
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001037 group.add_remote_option('--nosdk', action='store_true',
1038 default=False,
1039 help='Re-create the SDK from scratch.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001040 group.add_remote_option('--nosync', action='store_false', dest='sync',
1041 default=True, help="Don't sync before building.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001042 group.add_remote_option('--notests', action='store_false', dest='tests',
1043 default=True,
1044 help='Override values from buildconfig and run no '
1045 'tests.')
1046 group.add_remote_option('--nouprev', action='store_false', dest='uprev',
1047 default=True,
1048 help='Override values from buildconfig and never '
1049 'uprev.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001050 group.add_option('--reference-repo', action='store', default=None,
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001051 dest='reference_repo',
1052 help='Reuse git data stored in an existing repo '
1053 'checkout. This can drastically reduce the network '
1054 'time spent setting up the trybot checkout. By '
1055 "default, if this option isn't given but cbuildbot "
1056 'is invoked from a repo checkout, cbuildbot will '
1057 'use the repo root.')
Ryan Cuicedd8a52012-03-22 02:28:35 -07001058 group.add_option('--resume', action='store_true', default=False,
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001059 help='Skip stages already successfully completed.')
1060 group.add_remote_option('--timeout', action='store', type='int', default=0,
1061 help='Specify the maximum amount of time this job '
1062 'can run for, at which point the build will be '
1063 'aborted. If set to zero, then there is no '
1064 'timeout.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001065 group.add_remote_option('--version', dest='force_version', default=None,
1066 help='Used with manifest logic. Forces use of this '
1067 'version rather than create or get latest.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001068
1069 parser.add_option_group(group)
1070
1071 #
1072 # Internal options.
1073 #
1074
1075 group = CustomGroup(
1076 parser,
1077 'Internal ChromeOS Build Team Options',
1078 'Caution: these are for meant for the ChromeOS build team only')
1079
1080 group.add_remote_option('--archive-base', type='gs_path',
1081 help='Base GS URL (gs://<bucket_name>/<path>) to '
1082 'upload archive artifacts to')
Brian Harringab8fb5c2012-07-18 11:28:22 -07001083 group.add_remote_option('--cq-gerrit-query', dest='cq_gerrit_override',
1084 default=None,
1085 help=
1086 "If given, this gerrit query will be used to find what patches to test, "
Brian Harringc5cabfe2012-12-19 01:04:44 -08001087 "rather than the normal 'CommitQueue=1 AND Verified=1 AND CodeReview=2' "
Brian Harringab8fb5c2012-07-18 11:28:22 -07001088 "query it defaults to. Use with care- note additionally this setting "
1089 "only has an effect if the buildbot target is a cq target, and we're "
1090 "in buildbot mode.")
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001091 group.add_option('--pass-through', dest='pass_through_args', action='append',
1092 type='string', default=[])
David Jamesf421c6d2013-04-11 15:37:57 -07001093 group.add_remote_option('--pre-cq', action='store_true', default=False,
1094 help='Mark CLs as tested by the PreCQ on success.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001095 group.add_option('--reexec-api-version', dest='output_api_version',
Ryan Cuif4f84be2012-07-09 18:50:41 -07001096 action='store_true', default=False,
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001097 help='Used for handling forwards/backwards compatibility '
1098 'with --resume and --bootstrap')
1099 group.add_option('--remote-trybot', dest='remote_trybot',
1100 action='store_true', default=False,
1101 help='Indicates this is running on a remote trybot machine')
1102 group.add_remote_option('--remote-patches', action='extend', default=[],
1103 help='Patches uploaded by the trybot client when run '
1104 'using the -p option')
Brian Harringf611e6e2012-07-17 18:47:44 -07001105 # Note the default here needs to be hardcoded to 3; that is the last version
1106 # that lacked this functionality.
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001107 group.add_option('--remote-version', default=3, type=int, action='store',
1108 help='Used for compatibility checks w/tryjobs running in '
1109 'older chromite instances')
1110 group.add_option('--sourceroot', type='path', default=constants.SOURCE_ROOT)
1111 group.add_remote_option('--test-bootstrap', action='store_true',
1112 default=False,
1113 help='Causes cbuildbot to bootstrap itself twice, in '
1114 'the sequence A->B->C: A(unpatched) patches and '
1115 'bootstraps B; B patches and bootstraps C')
1116 group.add_remote_option('--validation_pool', default=None,
1117 help='Path to a pickled validation pool. Intended '
1118 'for use only with the commit queue.')
1119
1120 parser.add_option_group(group)
Ryan Cuif4f84be2012-07-09 18:50:41 -07001121
1122 #
Brian Harring3fec5a82012-03-01 05:57:03 -08001123 # Debug options
Ryan Cuif4f84be2012-07-09 18:50:41 -07001124 #
Brian Harringfec89fe2012-09-23 07:30:54 -07001125 # Temporary hack; in place till --dry-run replaces --debug.
1126 # pylint: disable=W0212
Brian Harring009db502012-10-10 02:21:37 -07001127 group = parser.debug_group
Brian Harringfec89fe2012-09-23 07:30:54 -07001128 debug = [x for x in group.option_list if x._long_opts == ['--debug']][0]
1129 debug.help += " Currently functions as --dry-run in addition."
1130 debug.pass_through = True
Brian Harring3fec5a82012-03-01 05:57:03 -08001131 group.add_option('--dump_config', action='store_true', dest='dump_config',
1132 default=False,
1133 help='Dump out build config options, and exit.')
1134 group.add_option('--notee', action='store_false', dest='tee', default=True,
1135 help="Disable logging and internal tee process. Primarily "
1136 "used for debugging cbuildbot itself.")
Brian Harring3fec5a82012-03-01 05:57:03 -08001137 return parser
1138
1139
Ryan Cui85867972012-02-23 18:21:49 -08001140def _FinishParsing(options, args):
1141 """Perform some parsing tasks that need to take place after optparse.
1142
1143 This function needs to be easily testable! Keep it free of
1144 environment-dependent code. Put more detailed usage validation in
1145 _PostParseCheck().
Brian Harring3fec5a82012-03-01 05:57:03 -08001146
1147 Args:
Matt Tennant759e2352013-09-27 15:14:44 -07001148 options: The options object returned by optparse
1149 args: The args object returned by optparse
Brian Harring3fec5a82012-03-01 05:57:03 -08001150 """
Ryan Cui41023d92012-11-13 19:59:50 -08001151 # Populate options.pass_through_args.
1152 accepted, _ = commandline.FilteringParser.FilterArgs(
1153 options.parsed_args, lambda x: x.opt_inst.pass_through)
1154 options.pass_through_args.extend(accepted)
Brian Harring07039b52012-05-13 17:56:47 -07001155
Brian Harring3fec5a82012-03-01 05:57:03 -08001156 if options.chrome_root:
1157 if options.chrome_rev != constants.CHROME_REV_LOCAL:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001158 cros_build_lib.Die('Chrome rev must be %s if chrome_root is set.' %
1159 constants.CHROME_REV_LOCAL)
David Jamesa0a664e2013-02-13 09:52:01 -08001160 elif options.chrome_rev == constants.CHROME_REV_LOCAL:
1161 cros_build_lib.Die('Chrome root must be set if chrome_rev is %s.' %
1162 constants.CHROME_REV_LOCAL)
Brian Harring3fec5a82012-03-01 05:57:03 -08001163
1164 if options.chrome_version:
1165 if options.chrome_rev != constants.CHROME_REV_SPEC:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001166 cros_build_lib.Die('Chrome rev must be %s if chrome_version is set.' %
1167 constants.CHROME_REV_SPEC)
David Jamesa0a664e2013-02-13 09:52:01 -08001168 elif options.chrome_rev == constants.CHROME_REV_SPEC:
1169 cros_build_lib.Die(
1170 'Chrome rev must not be %s if chrome_version is not set.'
1171 % constants.CHROME_REV_SPEC)
Brian Harring3fec5a82012-03-01 05:57:03 -08001172
David James9e27e662013-02-14 13:42:43 -08001173 patches = bool(options.gerrit_patches or options.local_patches or
1174 options.rietveld_patches)
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001175 if options.remote:
1176 if options.local:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001177 cros_build_lib.Die('Cannot specify both --remote and --local')
Ryan Cui54da0702012-04-19 18:38:08 -07001178
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001179 if not options.buildbot and not patches:
Brian Harring7cc4b932012-11-01 16:58:55 -07001180 if not cros_build_lib.BooleanPrompt(
1181 prompt="No patches were provided; are you sure you want to just "
1182 "run a remote build of ToT?", default=False):
1183 cros_build_lib.Die('Must provide patches when running with --remote.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001184
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001185 # --debug needs to be explicitly passed through for remote invocations.
1186 release_mode_with_patches = (options.buildbot and patches and
1187 '--debug' not in options.pass_through_args)
1188 else:
1189 if len(args) > 1:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001190 cros_build_lib.Die('Multiple configs not supported if not running with '
Brian Harringf1aad832012-07-18 10:46:39 -07001191 '--remote. Got %r', args)
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001192
Ryan Cui79319ab2012-05-21 12:59:18 -07001193 if options.slaves:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001194 cros_build_lib.Die('Cannot use --slaves if not running with --remote.')
Ryan Cui79319ab2012-05-21 12:59:18 -07001195
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001196 release_mode_with_patches = (options.buildbot and patches and
1197 not options.debug)
1198
David James5734ea32012-08-15 20:23:49 -07001199 # When running in release mode, make sure we are running with checked-in code.
1200 # We want checked-in cbuildbot/scripts to prevent errors, and we want to build
1201 # a release image with checked-in code for CrOS packages.
1202 if release_mode_with_patches:
1203 cros_build_lib.Die(
1204 'Cannot provide patches when running with --buildbot!')
1205
Ryan Cuiba41ad32012-03-08 17:15:29 -08001206 if options.buildbot and options.remote_trybot:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001207 cros_build_lib.Die(
1208 '--buildbot and --remote-trybot cannot be used together.')
Ryan Cuiba41ad32012-03-08 17:15:29 -08001209
Ryan Cui85867972012-02-23 18:21:49 -08001210 # Record whether --debug was set explicitly vs. it was inferred.
1211 options.debug_forced = False
1212 if options.debug:
1213 options.debug_forced = True
Ryan Cui88b901c2013-06-21 11:35:30 -07001214 if not options.debug:
Ryan Cui16ca5812012-03-08 20:34:27 -08001215 # We don't set debug by default for
1216 # 1. --buildbot invocations.
1217 # 2. --remote invocations, because it needs to push changes to the tryjob
1218 # repo.
1219 options.debug = not options.buildbot and not options.remote
Brian Harring3fec5a82012-03-01 05:57:03 -08001220
Ryan Cui1c13a252012-10-16 15:00:16 -07001221 # Record the configs targeted.
1222 options.build_targets = args[:]
1223
Ryan Cui88b901c2013-06-21 11:35:30 -07001224 if constants.BRANCH_UTIL_CONFIG in options.build_targets:
Ryan Cui7bd8db62013-08-08 16:29:51 -07001225 if options.remote:
1226 cros_build_lib.Die(
1227 'Running branch-util as a remote tryjob is not yet supported.')
Ryan Cui88b901c2013-06-21 11:35:30 -07001228 if len(options.build_targets) > 1:
1229 cros_build_lib.Die(
1230 'Cannot run branch-util with any other configs.')
1231 if not options.branch_name:
1232 cros_build_lib.Die(
1233 'Must specify --branch-name with the branch-util config.')
1234 if not any([options.force_version, options.delete_branch,
1235 options.rename_to]):
1236 cros_build_lib.Die(
1237 'Must specify --version with the branch-util config, unless '
1238 'running with --delete-branch or --rename-to.')
1239 elif any([options.delete_branch, options.rename_to, options.branch_name]):
1240 cros_build_lib.Die(
1241 'Cannot specify --delete-branch, --rename-to or --branch-name when not '
1242 'running the %s config', constants.BRANCH_UTIL_CONFIG)
1243
Brian Harring3fec5a82012-03-01 05:57:03 -08001244
Brian Harring1d7ba942012-04-24 06:37:18 -07001245# pylint: disable=W0613
Brian Harringae0a5322012-09-15 01:46:51 -07001246def _PostParseCheck(parser, options, args):
Ryan Cui85867972012-02-23 18:21:49 -08001247 """Perform some usage validation after we've parsed the arguments
Brian Harring3fec5a82012-03-01 05:57:03 -08001248
Ryan Cui85867972012-02-23 18:21:49 -08001249 Args:
1250 options/args: The options/args object returned by optparse
1251 """
Ryan Cuie1e4e662012-05-21 16:39:46 -07001252 if not options.branch:
David James97d95872012-11-16 15:09:56 -08001253 options.branch = git.GetChromiteTrackingBranch()
Ryan Cuie1e4e662012-05-21 16:39:46 -07001254
Brian Harringae0a5322012-09-15 01:46:51 -07001255 if not repository.IsARepoRoot(options.sourceroot):
1256 if options.local_patches:
1257 raise Exception('Could not find repo checkout at %s!'
1258 % options.sourceroot)
1259
David Jamesac8c2a72013-02-13 18:44:33 -08001260 # Because the default cache dir depends on other options, FindCacheDir
1261 # always returns None, and we setup the default here.
Brian Harringae0a5322012-09-15 01:46:51 -07001262 if options.cache_dir is None:
1263 # Note, options.sourceroot is set regardless of the path
1264 # actually existing.
David Jamesac8c2a72013-02-13 18:44:33 -08001265 if options.buildroot is not None:
Brian Harringae0a5322012-09-15 01:46:51 -07001266 options.cache_dir = os.path.join(options.buildroot, '.cache')
David Jamesac8c2a72013-02-13 18:44:33 -08001267 elif os.path.exists(options.sourceroot):
1268 options.cache_dir = os.path.join(options.sourceroot, '.cache')
Brian Harringae0a5322012-09-15 01:46:51 -07001269 else:
1270 options.cache_dir = parser.FindCacheDir(parser, options)
1271 options.cache_dir = os.path.abspath(options.cache_dir)
Brian Harring8c1d7b12012-10-04 17:36:32 -07001272 parser.ConfigureCacheDir(options.cache_dir)
Brian Harringae0a5322012-09-15 01:46:51 -07001273
1274 osutils.SafeMakedirs(options.cache_dir)
Ryan Cui5ba7e152012-05-10 14:36:52 -07001275
Brian Harring609dc4e2012-05-07 02:17:44 -07001276 if options.local_patches:
Brian Harring1d7ba942012-04-24 06:37:18 -07001277 options.local_patches = _CheckLocalPatches(
Brian Harring609dc4e2012-05-07 02:17:44 -07001278 options.sourceroot, options.local_patches)
Brian Harring1d7ba942012-04-24 06:37:18 -07001279
1280 default = os.environ.get('CBUILDBOT_DEFAULT_MODE')
1281 if (default and not any([options.local, options.buildbot,
1282 options.remote, options.remote_trybot])):
Brian Harring1b8c4c82012-05-29 23:03:04 -07001283 cros_build_lib.Info("CBUILDBOT_DEFAULT_MODE=%s env var detected, using it."
1284 % default)
Brian Harring1d7ba942012-04-24 06:37:18 -07001285 default = default.lower()
1286 if default == 'local':
1287 options.local = True
1288 elif default == 'remote':
1289 options.remote = True
1290 elif default == 'buildbot':
1291 options.buildbot = True
1292 else:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001293 cros_build_lib.Die("CBUILDBOT_DEFAULT_MODE value %s isn't supported. "
1294 % default)
Ryan Cui85867972012-02-23 18:21:49 -08001295
1296
1297def _ParseCommandLine(parser, argv):
1298 """Completely parse the commandline arguments"""
Brian Harring3fec5a82012-03-01 05:57:03 -08001299 (options, args) = parser.parse_args(argv)
Brian Harring37e559b2012-05-22 20:47:32 -07001300
1301 if options.output_api_version:
Ryan Cui724f1d32012-10-15 18:10:22 -07001302 print constants.REEXEC_API_VERSION
Brian Harring37e559b2012-05-22 20:47:32 -07001303 sys.exit(0)
1304
Ryan Cui54da0702012-04-19 18:38:08 -07001305 if options.list:
1306 _PrintValidConfigs(options.print_all)
1307 sys.exit(0)
1308
Ryan Cui8be16062012-04-24 12:05:26 -07001309 # Strip out null arguments.
1310 # TODO(rcui): Remove when buildbot is fixed
1311 args = [arg for arg in args if arg]
1312 if not args:
1313 parser.error('Invalid usage. Use -h to see usage. Use -l to list '
1314 'supported configs.')
1315
Ryan Cui85867972012-02-23 18:21:49 -08001316 _FinishParsing(options, args)
1317 return options, args
1318
1319
Matt Tennant759e2352013-09-27 15:14:44 -07001320# TODO(build): This function is too damn long.
Ryan Cui85867972012-02-23 18:21:49 -08001321def main(argv):
David James59a0a2b2013-03-22 14:04:44 -07001322 # Turn on strict sudo checks.
1323 cros_build_lib.STRICT_SUDO = True
1324
Ryan Cui85867972012-02-23 18:21:49 -08001325 # Set umask to 022 so files created by buildbot are readable.
1326 os.umask(022)
1327
Ryan Cui85867972012-02-23 18:21:49 -08001328 parser = _CreateParser()
1329 (options, args) = _ParseCommandLine(parser, argv)
Brian Harring3fec5a82012-03-01 05:57:03 -08001330
Brian Harringae0a5322012-09-15 01:46:51 -07001331 _PostParseCheck(parser, options, args)
Brian Harring3fec5a82012-03-01 05:57:03 -08001332
Mike Frysinger8fd67dc2012-12-03 23:51:18 -05001333 cros_build_lib.AssertOutsideChroot()
Zdenek Behan98ec2fb2012-08-31 17:12:18 +02001334
Brian Harring3fec5a82012-03-01 05:57:03 -08001335 if options.remote:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001336 cros_build_lib.logger.setLevel(logging.WARNING)
Ryan Cui16ca5812012-03-08 20:34:27 -08001337
Brian Harring3fec5a82012-03-01 05:57:03 -08001338 # Verify configs are valid.
Dan Shi0bdb7132013-07-30 16:22:12 -07001339 # If hwtest flag is enabled, post a warning that HWTest step may fail if the
1340 # specified board is not a released platform or it is a generic overlay.
Brian Harring3fec5a82012-03-01 05:57:03 -08001341 for bot in args:
Aviv Kesheta96a2a92013-02-05 17:21:51 -08001342 build_config = _GetConfig(bot)
1343 if options.hwtest:
Dan Shi0bdb7132013-07-30 16:22:12 -07001344 cros_build_lib.Warning(
1345 'If %s is not a released platform or it is a generic overlay, '
1346 'the HWTest step will most likely not run; please ask the lab '
1347 'team for help if this is unexpected.' % build_config['boards'])
Brian Harring3fec5a82012-03-01 05:57:03 -08001348
1349 # Verify gerrit patches are valid.
Ryan Cui16ca5812012-03-08 20:34:27 -08001350 print 'Verifying patches...'
Ryan Cuie1e4e662012-05-21 16:39:46 -07001351 patch_pool = AcquirePoolFromOptions(options)
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001352
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001353 # --debug need to be explicitly passed through for remote invocations.
1354 if options.buildbot and '--debug' not in options.pass_through_args:
1355 _ConfirmRemoteBuildbotRun()
1356
Ryan Cui16ca5812012-03-08 20:34:27 -08001357 print 'Submitting tryjob...'
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001358 tryjob = remote_try.RemoteTryJob(options, args, patch_pool.local_patches)
Ryan Cuia25d8eb2012-07-11 14:54:27 -07001359 tryjob.Submit(testjob=options.test_tryjob, dryrun=False)
Ryan Cui16ca5812012-03-08 20:34:27 -08001360 print 'Tryjob submitted!'
1361 print ('Go to %s to view the status of your job.'
Ryan Cui4906e1c2012-04-03 20:09:34 -07001362 % tryjob.GetTrybotWaterfallLink())
Brian Harring3fec5a82012-03-01 05:57:03 -08001363 sys.exit(0)
Matt Tennant759e2352013-09-27 15:14:44 -07001364
Ryan Cui54da0702012-04-19 18:38:08 -07001365 elif (not options.buildbot and not options.remote_trybot
1366 and not options.resume and not options.local):
Ryan Cui88b901c2013-06-21 11:35:30 -07001367 options.local = True
Brian Harring1b8c4c82012-05-29 23:03:04 -07001368 cros_build_lib.Warning(
1369 'Running in LOCAL TRYBOT mode! Use --remote to submit REMOTE '
1370 'tryjobs. Use --local to suppress this message.')
1371 cros_build_lib.Warning(
Ryan Cui51591352012-07-09 15:15:53 -07001372 'In the future, --local will be required to run the local '
Brian Harring1b8c4c82012-05-29 23:03:04 -07001373 'trybot.')
Ryan Cui54da0702012-04-19 18:38:08 -07001374 time.sleep(5)
Brian Harring3fec5a82012-03-01 05:57:03 -08001375
Matt Tennant759e2352013-09-27 15:14:44 -07001376 # Only one config arg is allowed in this mode, which was confirmed earlier.
Ryan Cui8be16062012-04-24 12:05:26 -07001377 bot_id = args[-1]
1378 build_config = _GetConfig(bot_id)
Brian Harring3fec5a82012-03-01 05:57:03 -08001379
1380 if options.reference_repo is None:
Ryan Cui5ba7e152012-05-10 14:36:52 -07001381 repo_path = os.path.join(options.sourceroot, '.repo')
Brian Harring3fec5a82012-03-01 05:57:03 -08001382 # If we're being run from a repo checkout, reuse the repo's git pool to
1383 # cut down on sync time.
1384 if os.path.exists(repo_path):
Ryan Cui5ba7e152012-05-10 14:36:52 -07001385 options.reference_repo = options.sourceroot
Brian Harring3fec5a82012-03-01 05:57:03 -08001386 elif options.reference_repo:
1387 if not os.path.exists(options.reference_repo):
1388 parser.error('Reference path %s does not exist'
1389 % (options.reference_repo,))
1390 elif not os.path.exists(os.path.join(options.reference_repo, '.repo')):
1391 parser.error('Reference path %s does not look to be the base of a '
1392 'repo checkout; no .repo exists in the root.'
1393 % (options.reference_repo,))
Ryan Cuid4a24212012-04-04 18:08:12 -07001394
Brian Harringf11bf682012-05-14 15:53:43 -07001395 if (options.buildbot or options.remote_trybot) and not options.resume:
Brian Harring470f6112012-03-02 11:47:10 -08001396 if not options.cgroups:
Ryan Cuid4a24212012-04-04 18:08:12 -07001397 parser.error('Options --buildbot/--remote-trybot and --nocgroups cannot '
1398 'be used together. Cgroup support is required for '
1399 'buildbot/remote-trybot mode.')
Mike Frysingera78a56e2012-11-20 06:02:30 -05001400 if not cgroups.Cgroup.IsSupported():
Ryan Cuid4a24212012-04-04 18:08:12 -07001401 parser.error('Option --buildbot/--remote-trybot was given, but this '
1402 'system does not support cgroups. Failing.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001403
David Jamesaad5cc72012-10-26 15:03:13 -07001404 missing = osutils.FindMissingBinaries(_BUILDBOT_REQUIRED_BINARIES)
Brian Harring351ce442012-03-09 16:38:14 -08001405 if missing:
Ryan Cuid4a24212012-04-04 18:08:12 -07001406 parser.error("Option --buildbot/--remote-trybot requires the following "
1407 "binaries which couldn't be found in $PATH: %s"
Brian Harring351ce442012-03-09 16:38:14 -08001408 % (', '.join(missing)))
1409
Brian Harring3fec5a82012-03-01 05:57:03 -08001410 if options.reference_repo:
1411 options.reference_repo = os.path.abspath(options.reference_repo)
1412
1413 if options.dump_config:
1414 # This works, but option ordering is bad...
1415 print 'Configuration %s:' % bot_id
1416 pretty_printer = pprint.PrettyPrinter(indent=2)
1417 pretty_printer.pprint(build_config)
1418 sys.exit(0)
1419
1420 if not options.buildroot:
1421 if options.buildbot:
Mike Frysinger6903c762012-12-04 01:57:16 -05001422 parser.error('Please specify a buildroot with the --buildbot option.')
Matt Tennantd55b1f42012-04-13 14:15:01 -07001423
Ryan Cui5ba7e152012-05-10 14:36:52 -07001424 options.buildroot = _DetermineDefaultBuildRoot(options.sourceroot,
1425 build_config['internal'])
Brian Harring470f6112012-03-02 11:47:10 -08001426 # We use a marker file in the buildroot to indicate the user has
1427 # consented to using this directory.
1428 if not os.path.exists(repository.GetTrybotMarkerPath(options.buildroot)):
1429 _ConfirmBuildRoot(options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -08001430
1431 # Sanity check of buildroot- specifically that it's not pointing into the
1432 # midst of an existing repo since git-repo doesn't support nesting.
Brian Harring3fec5a82012-03-01 05:57:03 -08001433 if (not repository.IsARepoRoot(options.buildroot) and
David James13a69c92013-05-09 10:37:42 -07001434 git.FindRepoDir(options.buildroot)):
Brian Harring3fec5a82012-03-01 05:57:03 -08001435 parser.error('Configured buildroot %s points into a repository checkout, '
1436 'rather than the root of it. This is not supported.'
1437 % options.buildroot)
1438
Chris Sosab5ea3b42012-10-25 15:25:20 -07001439 if not options.log_dir:
1440 options.log_dir = os.path.join(options.buildroot, _DEFAULT_LOG_DIR)
1441
Brian Harringd166aaf2012-05-14 18:31:53 -07001442 log_file = None
1443 if options.tee:
Chris Sosab5ea3b42012-10-25 15:25:20 -07001444 log_file = os.path.join(options.log_dir, _BUILDBOT_LOG_FILE)
1445 osutils.SafeMakedirs(options.log_dir)
Brian Harringd166aaf2012-05-14 18:31:53 -07001446 _BackupPreviousLog(log_file)
1447
Brian Harring1b8c4c82012-05-29 23:03:04 -07001448 with cros_build_lib.ContextManagerStack() as stack:
David Jamescebc7272013-07-17 16:45:05 -07001449 # TODO(ferringb): update this once https://gerrit.chromium.org/gerrit/25359
1450 # is landed- it's sensitive to the manifest-versions cache path.
1451 options.preserve_paths = set(['manifest-versions', '.cache',
1452 'manifest-versions-internal'])
1453 if log_file is not None:
1454 # We don't want the critical section to try to clean up the tee process,
1455 # so we run Tee (forked off) outside of it. This prevents a deadlock
1456 # because the Tee process only exits when its pipe is closed, and the
1457 # critical section accidentally holds on to that file handle.
1458 stack.Add(tee.Tee, log_file)
1459 options.preserve_paths.add(_DEFAULT_LOG_DIR)
1460
Brian Harringc2d09d92012-05-13 22:03:15 -07001461 critical_section = stack.Add(cleanup.EnforcedCleanupSection)
1462 stack.Add(sudo.SudoKeepAlive)
Brian Harringd166aaf2012-05-14 18:31:53 -07001463
Brian Harringc2d09d92012-05-13 22:03:15 -07001464 if not options.resume:
Brian Harring2bf55e12012-05-13 21:31:55 -07001465 # If we're in resume mode, use our parents tempdir rather than
1466 # nesting another layer.
David James4bc13702013-03-26 08:08:04 -07001467 stack.Add(osutils.TempDir, prefix='cbuildbot-tmp', set_global=True)
Brian Harringc2d09d92012-05-13 22:03:15 -07001468 logging.debug("Cbuildbot tempdir is %r.", os.environ.get('TMP'))
Brian Harringd166aaf2012-05-14 18:31:53 -07001469
Brian Harringc2d09d92012-05-13 22:03:15 -07001470 if options.cgroups:
1471 stack.Add(cgroups.SimpleContainChildren, 'cbuildbot')
Brian Harringa184efa2012-03-04 11:51:25 -08001472
Brian Harringc2d09d92012-05-13 22:03:15 -07001473 # Mark everything between EnforcedCleanupSection and here as having to
1474 # be rolled back via the contextmanager cleanup handlers. This
1475 # ensures that sudo bits cannot outlive cbuildbot, that anything
1476 # cgroups would kill gets killed, etc.
1477 critical_section.ForkWatchdog()
Brian Harringd166aaf2012-05-14 18:31:53 -07001478
Brian Harringc2d09d92012-05-13 22:03:15 -07001479 if options.timeout > 0:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001480 stack.Add(cros_build_lib.Timeout, options.timeout)
Brian Harringa184efa2012-03-04 11:51:25 -08001481
Brian Harringc2d09d92012-05-13 22:03:15 -07001482 if not options.buildbot:
1483 build_config = cbuildbot_config.OverrideConfigForTrybot(
1484 build_config,
David Jamese8dcfc42013-03-21 19:49:49 -07001485 options)
Brian Harringc2d09d92012-05-13 22:03:15 -07001486
Mike Frysinger6903c762012-12-04 01:57:16 -05001487 if options.buildbot or options.remote_trybot:
1488 _DisableYamaHardLinkChecks()
1489
Brian Harringc2d09d92012-05-13 22:03:15 -07001490 _RunBuildStagesWrapper(options, build_config)