blob: 75292b5ea0e092536ebf30c0b5222b58ff35dc4f [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
Aviv Keshetcf9c2722014-02-25 15:15:10 -080020import pickle
Brian Harring3fec5a82012-03-01 05:57:03 -080021import 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
Brian Harring3fec5a82012-03-01 05:57:03 -080025from chromite.buildbot import cbuildbot_config
26from chromite.buildbot import cbuildbot_stages as stages
27from chromite.buildbot import cbuildbot_results as results_lib
Matt Tennantefb59522013-10-18 13:49:28 -070028from chromite.buildbot import cbuildbot_run
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
David James3432acd2013-11-27 10:02:18 -080046from chromite.lib import timeout_util
Brian Harring3fec5a82012-03-01 05:57:03 -080047
Aviv Kesheta0159be2013-12-12 13:56:28 -080048import mock
49
Ryan Cuiadd49122012-03-21 22:19:58 -070050
Brian Harring3fec5a82012-03-01 05:57:03 -080051_DEFAULT_LOG_DIR = 'cbuildbot_logs'
52_BUILDBOT_LOG_FILE = 'cbuildbot.log'
53_DEFAULT_EXT_BUILDROOT = 'trybot'
54_DEFAULT_INT_BUILDROOT = 'trybot-internal'
Brian Harring351ce442012-03-09 16:38:14 -080055_BUILDBOT_REQUIRED_BINARIES = ('pbzip2',)
Ryan Cui1c13a252012-10-16 15:00:16 -070056_API_VERSION_ATTR = 'api_version'
Brian Harring3fec5a82012-03-01 05:57:03 -080057
58
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070059def _PrintValidConfigs(display_all=False):
Brian Harring3fec5a82012-03-01 05:57:03 -080060 """Print a list of valid buildbot configs.
61
Mike Frysinger02e1e072013-11-10 22:11:34 -050062 Args:
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070063 display_all: Print all configs. Otherwise, prints only configs with
64 trybot_list=True.
Brian Harring3fec5a82012-03-01 05:57:03 -080065 """
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070066 def _GetSortKey(config_name):
67 config_dict = cbuildbot_config.config[config_name]
68 return (not config_dict['trybot_list'], config_dict['description'],
69 config_name)
70
Brian Harring3fec5a82012-03-01 05:57:03 -080071 COLUMN_WIDTH = 45
Matt Tennant763497d2014-01-17 16:45:54 -080072 print
Brian Harring3fec5a82012-03-01 05:57:03 -080073 print 'config'.ljust(COLUMN_WIDTH), 'description'
74 print '------'.ljust(COLUMN_WIDTH), '-----------'
75 config_names = cbuildbot_config.config.keys()
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070076 config_names.sort(key=_GetSortKey)
Brian Harring3fec5a82012-03-01 05:57:03 -080077 for name in config_names:
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070078 if display_all or cbuildbot_config.config[name]['trybot_list']:
79 desc = cbuildbot_config.config[name].get('description')
80 desc = desc if desc else ''
Brian Harring3fec5a82012-03-01 05:57:03 -080081 print name.ljust(COLUMN_WIDTH), desc
82
Matt Tennant763497d2014-01-17 16:45:54 -080083 print
84
Brian Harring3fec5a82012-03-01 05:57:03 -080085
86def _GetConfig(config_name):
Matt Tennant763497d2014-01-17 16:45:54 -080087 """Gets the configuration for the build if it exists, None otherwise."""
88 if cbuildbot_config.config.has_key(config_name):
89 return cbuildbot_config.config[config_name]
Brian Harring3fec5a82012-03-01 05:57:03 -080090
91
Ryan Cuie1e4e662012-05-21 16:39:46 -070092def AcquirePoolFromOptions(options):
Ryan Cui16d9e1f2012-05-11 10:50:18 -070093 """Generate patch objects from passed in options.
Brian Harring3fec5a82012-03-01 05:57:03 -080094
95 Args:
Ryan Cui16d9e1f2012-05-11 10:50:18 -070096 options: The options object generated by optparse.
Brian Harring3fec5a82012-03-01 05:57:03 -080097
Ryan Cuif7f24692012-05-18 16:35:33 -070098 Returns:
99 trybot_patch_pool.TrybotPatchPool object.
100
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700101 Raises:
Brian Harring511055e2012-10-10 02:58:59 -0700102 gerrit.GerritException, cros_patch.PatchException
Brian Harring3fec5a82012-03-01 05:57:03 -0800103 """
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700104 gerrit_patches = []
105 local_patches = []
106 remote_patches = []
Brian Harring3fec5a82012-03-01 05:57:03 -0800107
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700108 if options.gerrit_patches:
Brian Harring511055e2012-10-10 02:58:59 -0700109 gerrit_patches = gerrit.GetGerritPatchInfo(
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700110 options.gerrit_patches)
111 for patch in gerrit_patches:
112 if patch.IsAlreadyMerged():
Brian Harring1b8c4c82012-05-29 23:03:04 -0700113 cros_build_lib.Warning('Patch %s has already been merged.' % str(patch))
Brian Harring3fec5a82012-03-01 05:57:03 -0800114
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700115 if options.local_patches:
David James97d95872012-11-16 15:09:56 -0800116 manifest = git.ManifestCheckout.Cached(options.sourceroot)
Brian Harring609dc4e2012-05-07 02:17:44 -0700117 local_patches = cros_patch.PrepareLocalPatches(manifest,
118 options.local_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800119
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700120 if options.remote_patches:
121 remote_patches = cros_patch.PrepareRemotePatches(
122 options.remote_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800123
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700124 return trybot_patch_pool.TrybotPatchPool(gerrit_patches, local_patches,
125 remote_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800126
127
Brian Harring3fec5a82012-03-01 05:57:03 -0800128class Builder(object):
129 """Parent class for all builder types.
130
Matt Tennant759e2352013-09-27 15:14:44 -0700131 This class functions as an abstract parent class for various build types.
132 Its intended use is builder_instance.Run().
Brian Harring3fec5a82012-03-01 05:57:03 -0800133
Matt Tennant3f351552014-01-03 14:28:00 -0800134 Attributes:
135 _run: The BuilderRun object for this run.
136 archive_stages: Dict of BuildConfig keys to ArchiveStage values.
137 patch_pool: TrybotPatchPool.
Brian Harring3fec5a82012-03-01 05:57:03 -0800138 """
139
Matt Tennantefb59522013-10-18 13:49:28 -0700140 def __init__(self, builder_run):
Brian Harring3fec5a82012-03-01 05:57:03 -0800141 """Initializes instance variables. Must be called by all subclasses."""
Matt Tennantefb59522013-10-18 13:49:28 -0700142 self._run = builder_run
Brian Harring3fec5a82012-03-01 05:57:03 -0800143
Matt Tennantefb59522013-10-18 13:49:28 -0700144 if self._run.config.chromeos_official:
Brian Harring3fec5a82012-03-01 05:57:03 -0800145 os.environ['CHROMEOS_OFFICIAL'] = '1'
146
David James58e0c092012-03-04 20:31:12 -0800147 self.archive_stages = {}
Brian Harring76d1bf62012-06-01 13:52:48 -0700148 self.patch_pool = trybot_patch_pool.TrybotPatchPool()
Brian Harring3fec5a82012-03-01 05:57:03 -0800149
150 def Initialize(self):
151 """Runs through the initialization steps of an actual build."""
Matt Tennantefb59522013-10-18 13:49:28 -0700152 if self._run.options.resume:
153 results_lib.LoadCheckpoint(self._run.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800154
Brian Harring3fec5a82012-03-01 05:57:03 -0800155 self._RunStage(stages.CleanUpStage)
156
157 def _GetStageInstance(self, stage, *args, **kwargs):
Matt Tennant759e2352013-09-27 15:14:44 -0700158 """Helper function to get a stage instance given the args.
Brian Harring3fec5a82012-03-01 05:57:03 -0800159
Matt Tennantefb59522013-10-18 13:49:28 -0700160 Useful as almost all stages just take in builder_run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800161 """
Matt Tennantefb59522013-10-18 13:49:28 -0700162 # Normally the default BuilderRun (self._run) is used, but it can
163 # be overridden with "builder_run" kwargs (e.g. for child configs).
164 builder_run = kwargs.pop('builder_run', self._run)
165 return stage(builder_run, *args, **kwargs)
Brian Harring3fec5a82012-03-01 05:57:03 -0800166
167 def _SetReleaseTag(self):
Matt Tennant9c1c8492014-02-27 13:09:07 -0800168 """Sets run.attrs.release_tag from the manifest manager used in sync.
Brian Harring3fec5a82012-03-01 05:57:03 -0800169
Matt Tennantf4980ee2014-01-29 09:21:27 -0800170 Must be run after sync stage as syncing enables us to have a release tag,
171 and must be run before any usage of attrs.release_tag.
Matt Tennantefb59522013-10-18 13:49:28 -0700172
173 TODO(mtennant): Find a bottleneck place in syncing that can set this
Matt Tennantf4980ee2014-01-29 09:21:27 -0800174 directly. Be careful, as there are several kinds of syncing stages, and
175 sync stages have been known to abort with sys.exit calls.
Brian Harring3fec5a82012-03-01 05:57:03 -0800176 """
Matt Tennantefb59522013-10-18 13:49:28 -0700177 manifest_manager = getattr(self._run.attrs, 'manifest_manager', None)
Brian Harring3fec5a82012-03-01 05:57:03 -0800178 if manifest_manager:
Matt Tennantefb59522013-10-18 13:49:28 -0700179 self._run.attrs.release_tag = manifest_manager.current_version
Matt Tennant3f351552014-01-03 14:28:00 -0800180 else:
181 self._run.attrs.release_tag = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800182
Matt Tennanta42a5742014-02-09 13:42:12 -0800183 cros_build_lib.Debug('Saved release_tag value for run: %r',
184 self._run.attrs.release_tag)
185
Brian Harring3fec5a82012-03-01 05:57:03 -0800186 def _RunStage(self, stage, *args, **kwargs):
Matt Tennant759e2352013-09-27 15:14:44 -0700187 """Wrapper to run a stage.
188
189 Args:
190 stage: A BuilderStage class.
191 args: args to pass to stage constructor.
192 kwargs: kwargs to pass to stage constructor.
Mike Frysinger1a736a82013-12-12 01:50:59 -0500193
Matt Tennant759e2352013-09-27 15:14:44 -0700194 Returns:
Matt Tennant759e2352013-09-27 15:14:44 -0700195 Whatever the stage's Run method returns.
196 """
Brian Harring3fec5a82012-03-01 05:57:03 -0800197 stage_instance = self._GetStageInstance(stage, *args, **kwargs)
198 return stage_instance.Run()
199
Matt Tennantf4980ee2014-01-29 09:21:27 -0800200 def _RunSyncStage(self, sync_instance):
201 """Run given |sync_instance| stage and be sure attrs.release_tag set."""
202 try:
203 sync_instance.Run()
204 finally:
205 self._SetReleaseTag()
206
Brian Harring3fec5a82012-03-01 05:57:03 -0800207 def GetSyncInstance(self):
208 """Returns an instance of a SyncStage that should be run.
209
210 Subclasses must override this method.
211 """
212 raise NotImplementedError()
213
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400214 def GetCompletionInstance(self):
Aviv Keshetf2746152013-11-26 10:42:46 -0800215 """Returns the MasterSlaveSyncCompletionStage for this build.
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400216
217 Subclasses may override this method.
218
Mike Frysinger02e1e072013-11-10 22:11:34 -0500219 Returns:
220 None
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400221 """
222 return None
223
Brian Harring3fec5a82012-03-01 05:57:03 -0800224 def RunStages(self):
225 """Subclasses must override this method. Runs the appropriate code."""
226 raise NotImplementedError()
227
Brian Harring3fec5a82012-03-01 05:57:03 -0800228 def _ReExecuteInBuildroot(self, sync_instance):
229 """Reexecutes self in buildroot and returns True if build succeeds.
230
231 This allows the buildbot code to test itself when changes are patched for
232 buildbot-related code. This is a no-op if the buildroot == buildroot
233 of the running chromite checkout.
234
235 Args:
Matt Tennant85348852014-01-10 15:16:02 -0800236 sync_instance: Instance of the sync stage that was run to sync.
Brian Harring3fec5a82012-03-01 05:57:03 -0800237
238 Returns:
239 True if the Build succeeded.
240 """
Matt Tennantefb59522013-10-18 13:49:28 -0700241 if not self._run.options.resume:
242 results_lib.WriteCheckpoint(self._run.options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800243
Ryan Cui1c13a252012-10-16 15:00:16 -0700244 args = stages.BootstrapStage.FilterArgsForTargetCbuildbot(
Matt Tennantefb59522013-10-18 13:49:28 -0700245 self._run.options.buildroot, constants.PATH_TO_CBUILDBOT,
246 self._run.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',
Matt Tennantefb59522013-10-18 13:49:28 -0700252 '--buildroot', os.path.abspath(self._run.options.buildroot)]
Brian Harringae0a5322012-09-15 01:46:51 -0700253
Matt Tennantefb59522013-10-18 13:49:28 -0700254 if hasattr(self._run.attrs, 'manifest_manager'):
255 # TODO(mtennant): Is this the same as self._run.attrs.release_tag?
256 ver = self._run.attrs.manifest_manager.current_version
Ryan Cui1c13a252012-10-16 15:00:16 -0700257 args += ['--version', ver]
Brian Harring3fec5a82012-03-01 05:57:03 -0800258
David Jamesf421c6d2013-04-11 15:37:57 -0700259 pool = getattr(sync_instance, 'pool', None)
260 if pool:
Matt Tennantefb59522013-10-18 13:49:28 -0700261 filename = os.path.join(self._run.options.buildroot,
262 'validation_pool.dump')
David Jamesf421c6d2013-04-11 15:37:57 -0700263 pool.Save(filename)
264 args += ['--validation_pool', filename]
Brian Harring3fec5a82012-03-01 05:57:03 -0800265
David Jamesac8c2a72013-02-13 18:44:33 -0800266 # Reset the cache dir so that the child will calculate it automatically.
Matt Tennantefb59522013-10-18 13:49:28 -0700267 if not self._run.options.cache_dir_specified:
David Jamesac8c2a72013-02-13 18:44:33 -0800268 commandline.BaseParser.ConfigureCacheDir(None)
269
Brian Harring3fec5a82012-03-01 05:57:03 -0800270 # Re-run the command in the buildroot.
271 # Finally, be generous and give the invoked cbuildbot 30s to shutdown
272 # when something occurs. It should exit quicker, but the sigterm may
273 # hit while the system is particularly busy.
Brian Harring1b8c4c82012-05-29 23:03:04 -0700274 return_obj = cros_build_lib.RunCommand(
Matt Tennantefb59522013-10-18 13:49:28 -0700275 args, cwd=self._run.options.buildroot, error_code_ok=True,
276 kill_timeout=30)
Brian Harring3fec5a82012-03-01 05:57:03 -0800277 return return_obj.returncode == 0
278
Ryan Cuif7f24692012-05-18 16:35:33 -0700279 def _InitializeTrybotPatchPool(self):
280 """Generate patch pool from patches specified on the command line.
281
282 Do this only if we need to patch changes later on.
283 """
284 changes_stage = stages.PatchChangesStage.StageNamePrefix()
285 check_func = results_lib.Results.PreviouslyCompletedRecord
Matt Tennantefb59522013-10-18 13:49:28 -0700286 if not check_func(changes_stage) or self._run.options.bootstrap:
287 self.patch_pool = AcquirePoolFromOptions(self._run.options)
Ryan Cuif7f24692012-05-18 16:35:33 -0700288
289 def _GetBootstrapStage(self):
290 """Constructs and returns the BootStrapStage object.
291
292 We return None when there are no chromite patches to test, and
293 --test-bootstrap wasn't passed in.
294 """
295 stage = None
296 chromite_pool = self.patch_pool.Filter(project=constants.CHROMITE_PROJECT)
Ryan Cui5616a512012-08-17 13:39:36 -0700297 manifest_pool = self.patch_pool.FilterManifest()
David James97d95872012-11-16 15:09:56 -0800298 chromite_branch = git.GetChromiteTrackingBranch()
Matt Tennantefb59522013-10-18 13:49:28 -0700299 if (chromite_pool or manifest_pool or
300 self._run.options.test_bootstrap or
301 chromite_branch != self._run.options.branch):
302 stage = stages.BootstrapStage(self._run, chromite_pool,
303 manifest_pool)
Ryan Cuif7f24692012-05-18 16:35:33 -0700304 return stage
305
Brian Harring3fec5a82012-03-01 05:57:03 -0800306 def Run(self):
Ryan Cuif7f24692012-05-18 16:35:33 -0700307 """Main runner for this builder class. Runs build and prints summary.
308
309 Returns:
310 Whether the build succeeded.
311 """
312 self._InitializeTrybotPatchPool()
313
Matt Tennantefb59522013-10-18 13:49:28 -0700314 if self._run.options.bootstrap:
Ryan Cuif7f24692012-05-18 16:35:33 -0700315 bootstrap_stage = self._GetBootstrapStage()
316 if bootstrap_stage:
317 # BootstrapStage blocks on re-execution of cbuildbot.
318 bootstrap_stage.Run()
319 return bootstrap_stage.returncode == 0
320
Brian Harring3fec5a82012-03-01 05:57:03 -0800321 print_report = True
David James3d4d3502012-04-09 15:12:06 -0700322 exception_thrown = False
Brian Harring3fec5a82012-03-01 05:57:03 -0800323 success = True
David James9ebb2a42013-08-13 20:29:57 -0700324 sync_instance = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800325 try:
326 self.Initialize()
327 sync_instance = self.GetSyncInstance()
Matt Tennantf4980ee2014-01-29 09:21:27 -0800328 self._RunSyncStage(sync_instance)
Brian Harring3fec5a82012-03-01 05:57:03 -0800329
Matt Tennantefb59522013-10-18 13:49:28 -0700330 if self._run.ShouldPatchAfterSync():
Ryan Cui88b901c2013-06-21 11:35:30 -0700331 # Filter out patches to manifest, since PatchChangesStage can't handle
332 # them. Manifest patches are patched in the BootstrapStage.
333 non_manifest_patches = self.patch_pool.FilterManifest(negate=True)
334 if non_manifest_patches:
335 self._RunStage(stages.PatchChangesStage, non_manifest_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800336
Matt Tennantefb59522013-10-18 13:49:28 -0700337 if self._run.ShouldReexecAfterSync():
Brian Harring3fec5a82012-03-01 05:57:03 -0800338 print_report = False
339 success = self._ReExecuteInBuildroot(sync_instance)
340 else:
341 self.RunStages()
Matt Tennant759e2352013-09-27 15:14:44 -0700342
David James3541a132013-03-18 13:21:58 -0700343 except Exception as ex:
344 # If the build is marked as successful, but threw exceptions, that's a
345 # problem.
David James7fbf2d42012-07-14 18:23:49 -0700346 exception_thrown = True
David James3541a132013-03-18 13:21:58 -0700347 if results_lib.Results.BuildSucceededSoFar():
348 traceback.print_exc(file=sys.stdout)
David James7fbf2d42012-07-14 18:23:49 -0700349 raise
Matt Tennant759e2352013-09-27 15:14:44 -0700350
David James3541a132013-03-18 13:21:58 -0700351 if not (print_report and isinstance(ex, results_lib.StepFailure)):
352 raise
Matt Tennant759e2352013-09-27 15:14:44 -0700353
Brian Harring3fec5a82012-03-01 05:57:03 -0800354 finally:
355 if print_report:
Matt Tennantefb59522013-10-18 13:49:28 -0700356 results_lib.WriteCheckpoint(self._run.options.buildroot)
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400357 completion_instance = self.GetCompletionInstance()
Matt Tennant066d9322014-01-28 10:37:48 -0800358 self._RunStage(stages.ReportStage, sync_instance, completion_instance)
Brian Harring3fec5a82012-03-01 05:57:03 -0800359 success = results_lib.Results.BuildSucceededSoFar()
David James3d4d3502012-04-09 15:12:06 -0700360 if exception_thrown and success:
361 success = False
David Jamesbb20ac82012-07-18 10:59:16 -0700362 cros_build_lib.PrintBuildbotStepWarnings()
363 print """\
David James3d4d3502012-04-09 15:12:06 -0700364Exception thrown, but all stages marked successful. This is an internal error,
365because the stage that threw the exception should be marked as failing."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800366
367 return success
368
369
David James1fddb8f2013-04-25 15:23:07 -0700370BoardConfig = collections.namedtuple('BoardConfig', ['board', 'name'])
371
372
Brian Harring3fec5a82012-03-01 05:57:03 -0800373class SimpleBuilder(Builder):
374 """Builder that performs basic vetting operations."""
375
376 def GetSyncInstance(self):
377 """Sync to lkgm or TOT as necessary.
378
Mike Frysinger02e1e072013-11-10 22:11:34 -0500379 Returns:
380 The instance of the sync stage to run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800381 """
Matt Tennantefb59522013-10-18 13:49:28 -0700382 if self._run.options.force_version:
Ryan Cui88b901c2013-06-21 11:35:30 -0700383 sync_stage = self._GetStageInstance(stages.ManifestVersionedSyncStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700384 elif self._run.config.use_lkgm:
Brian Harring3fec5a82012-03-01 05:57:03 -0800385 sync_stage = self._GetStageInstance(stages.LKGMSyncStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700386 elif self._run.config.use_chrome_lkgm:
Chris Sosa52a81b62012-11-14 06:12:54 -0800387 sync_stage = self._GetStageInstance(stages.ChromeLKGMSyncStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800388 else:
389 sync_stage = self._GetStageInstance(stages.SyncStage)
390
391 return sync_stage
392
David James4f2d8302013-03-19 06:35:58 -0700393 @staticmethod
394 def _RunParallelStages(stage_objs):
Matt Tennant759e2352013-09-27 15:14:44 -0700395 """Run the specified stages in parallel.
396
397 Args:
398 stage_objs: BuilderStage objects.
399 """
David James4f2d8302013-03-19 06:35:58 -0700400 steps = [stage.Run for stage in stage_objs]
401 try:
402 parallel.RunParallelSteps(steps)
Matt Tennant0940c382014-01-21 20:43:55 -0800403
David James4f2d8302013-03-19 06:35:58 -0700404 except BaseException as ex:
405 # If a stage threw an exception, it might not have correctly reported
406 # results (e.g. because it was killed before it could report the
407 # results.) In this case, attribute the exception to any stages that
408 # didn't report back correctly (if any).
409 for stage in stage_objs:
David James6b704242013-10-18 14:51:37 -0700410 for name in stage.GetStageNames():
411 if not results_lib.Results.StageHasResults(name):
412 results_lib.Results.Record(name, ex, str(ex))
Matt Tennant759e2352013-09-27 15:14:44 -0700413
David James4f2d8302013-03-19 06:35:58 -0700414 raise
415
Matt Tennantefb59522013-10-18 13:49:28 -0700416 def _RunBackgroundStagesForBoard(self, builder_run, board, compilecheck):
Matt Tennant759e2352013-09-27 15:14:44 -0700417 """Run background board-specific stages for the specified board.
418
419 Args:
Matt Tennantefb59522013-10-18 13:49:28 -0700420 builder_run: BuilderRun object for these background stages.
Matt Tennant759e2352013-09-27 15:14:44 -0700421 board: Board name.
422 compilecheck: Boolean. If True, run only the compile steps.
423 """
Matt Tennantefb59522013-10-18 13:49:28 -0700424 config = builder_run.config
Matt Tennant066d9322014-01-28 10:37:48 -0800425
426 # TODO(mtennant): This is the last usage of self.archive_stages. We can
427 # kill it once we migrate its uses to BuilderRun so that none of the
428 # stages below need it as an argument.
Matt Tennantefb59522013-10-18 13:49:28 -0700429 archive_stage = self.archive_stages[BoardConfig(board, config.name)]
430 if config.pgo_generate:
Ahmad Sharifa2db40a2013-07-22 13:51:52 -0400431 self._RunParallelStages([archive_stage])
David James1fddb8f2013-04-25 15:23:07 -0700432 return
Matt Tennant759e2352013-09-27 15:14:44 -0700433
David James565bc9a2013-04-08 14:54:45 -0700434 if compilecheck:
435 self._RunStage(stages.BuildPackagesStage, board, archive_stage,
Matt Tennantefb59522013-10-18 13:49:28 -0700436 builder_run=builder_run)
437 self._RunStage(stages.UnitTestStage, board,
438 builder_run=builder_run)
David James565bc9a2013-04-08 14:54:45 -0700439 return
Matt Tennant759e2352013-09-27 15:14:44 -0700440
Don Garrett82c0ae82014-02-03 18:25:11 -0800441 # signer_results can't complete without push_image.
442 assert not config['signer_results'] or config['push_image']
443
444 # paygen can't complete without signer_results.
445 assert not config['paygen'] or config['signer_results']
446
Mike Frysinger31ac04f2013-11-10 21:07:48 -0500447 # While this stage list is run in parallel, the order here dictates the
448 # order that things will be shown in the log. So group things together
449 # that make sense when read in order. Also keep in mind that, since we
450 # gather output manually, early slow stages will prevent any output from
451 # later stages showing up until it finishes.
Ryan Cui3ea98e02013-08-07 16:01:48 -0700452 stage_list = []
Matt Tennantefb59522013-10-18 13:49:28 -0700453 if builder_run.options.chrome_sdk and config.chrome_sdk:
Ryan Cui3ea98e02013-08-07 16:01:48 -0700454 stage_list.append([stages.ChromeSDKStage, board, archive_stage])
David James6b704242013-10-18 14:51:37 -0700455 stage_list += [
Matt Tennant06460b72014-02-10 18:00:13 -0800456 [stages.RetryStage, 1, stages.VMTestStage, board],
David James6b704242013-10-18 14:51:37 -0700457 [stages.SignerTestStage, board, archive_stage],
Don Garrett7604d6a2014-01-15 14:45:39 -0800458 [stages.SignerResultsStage, board, archive_stage],
Don Garrett82c0ae82014-02-03 18:25:11 -0800459 [stages.PaygenStage, board, archive_stage],
David James6b704242013-10-18 14:51:37 -0700460 [stages.UnitTestStage, board],
461 [stages.UploadPrebuiltsStage, board, archive_stage],
Mike Frysinger31ac04f2013-11-10 21:07:48 -0500462 [stages.DevInstallerPrebuiltsStage, board, archive_stage],
Matt Tennant06460b72014-02-10 18:00:13 -0800463 [stages.DebugSymbolsStage, board],
David James6b704242013-10-18 14:51:37 -0700464 ]
Brian Harring3fec5a82012-03-01 05:57:03 -0800465
David James58e0c092012-03-04 20:31:12 -0800466 # We can not run hw tests without archiving the payloads.
Matt Tennantefb59522013-10-18 13:49:28 -0700467 if builder_run.options.archive:
468 for suite_config in config.hw_tests:
Chris Sosaba250522013-03-27 18:57:34 -0700469 if suite_config.async:
470 stage_list.append([stages.ASyncHWTestStage, board, archive_stage,
471 suite_config])
472 elif suite_config.suite == constants.HWTEST_AU_SUITE:
473 stage_list.append([stages.AUTestStage, board, archive_stage,
474 suite_config])
Aviv Keshet23efd042013-10-01 13:59:08 -0700475 elif suite_config.suite == constants.HWTEST_QAV_SUITE:
476 stage_list.append([stages.QATestStage, board,
477 archive_stage, suite_config])
Chris Sosa077df812013-01-25 17:05:28 -0800478 else:
Chris Sosaba250522013-03-27 18:57:34 -0700479 stage_list.append([stages.HWTestStage, board, archive_stage,
480 suite_config])
Chris Sosa817b1f92012-07-19 15:00:23 -0700481
Matt Tennantefb59522013-10-18 13:49:28 -0700482 stage_objs = [self._GetStageInstance(*x, builder_run=builder_run)
483 for x in stage_list]
David James4f2d8302013-03-19 06:35:58 -0700484 self._RunParallelStages(stage_objs + [archive_stage])
Brian Harring3fec5a82012-03-01 05:57:03 -0800485
David James3b4bacf2014-02-19 17:25:15 -0800486 def _RunSetupBoard(self):
487 """Run the SetupBoard stage for all child configs and boards."""
488 for builder_run in self._run.GetUngroupedBuilderRuns():
489 for board in builder_run.config.boards:
490 self._RunStage(stages.SetupBoardStage, board, builder_run=builder_run)
491
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400492 def _RunChrootBuilderTypeBuild(self):
493 """Runs through stages of a CHROOT_BUILDER_TYPE build."""
494 self._RunStage(stages.UprevStage, boards=[], enter_chroot=False)
495 self._RunStage(stages.InitSDKStage)
David James3b4bacf2014-02-19 17:25:15 -0800496 self._RunStage(stages.SetupBoardStage, constants.CHROOT_BUILDER_BOARD)
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400497 self._RunStage(stages.SyncChromeStage)
498 self._RunStage(stages.PatchChromeStage)
499 self._RunStage(stages.SDKPackageStage)
500 self._RunStage(stages.SDKTestStage)
501 self._RunStage(stages.UploadPrebuiltsStage,
502 constants.CHROOT_BUILDER_BOARD, None)
503
504 def _RunRefreshPackagesTypeBuild(self):
505 """Runs through the stages of a REFRESH_PACKAGES_TYPE build."""
506 self._RunStage(stages.InitSDKStage)
David James3b4bacf2014-02-19 17:25:15 -0800507 self._RunSetupBoard()
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400508 self._RunStage(stages.RefreshPackageStatusStage)
509
Matt Tennante8179042013-10-01 15:47:32 -0700510 def _RunMasterPaladinBuild(self):
511 """Runs through the stages of the paladin (commit queue) master build."""
512 self._RunStage(stages.InitSDKStage)
513 self._RunStage(stages.UprevStage)
Matt Tennant9c1c8492014-02-27 13:09:07 -0800514 # The CQ (paladin) master will not actually run the SyncChrome stage, but
515 # we want the logic that gets triggered when SyncChrome stage is skipped.
516 self._RunStage(stages.SyncChromeStage)
Matt Tennante8179042013-10-01 15:47:32 -0700517 self._RunStage(stages.MasterUploadPrebuiltsStage)
518
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400519 def _RunDefaultTypeBuild(self):
520 """Runs through the stages of a non-special-type build."""
521 self._RunStage(stages.InitSDKStage)
522 self._RunStage(stages.UprevStage)
David James3b4bacf2014-02-19 17:25:15 -0800523 self._RunSetupBoard()
Matt Tennant85348852014-01-10 15:16:02 -0800524 self._RunStage(stages.SyncChromeStage)
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400525 self._RunStage(stages.PatchChromeStage)
526
Matt Tennantefb59522013-10-18 13:49:28 -0700527 # Prepare stages to run in background. If child_configs exist then
528 # run each of those here, otherwise use default config.
Matt Tennant950c6cb2014-01-10 16:45:03 -0800529 builder_runs = self._run.GetUngroupedBuilderRuns()
Matt Tennantefb59522013-10-18 13:49:28 -0700530
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400531 tasks = []
Matt Tennantefb59522013-10-18 13:49:28 -0700532 for builder_run in builder_runs:
Matt Tennanta42a5742014-02-09 13:42:12 -0800533 # Prepare a local archive directory for each "run".
534 builder_run.GetArchive().SetupArchivePath()
535
Matt Tennantefb59522013-10-18 13:49:28 -0700536 for board in builder_run.config.boards:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400537 archive_stage = self._GetStageInstance(
Matt Tennantefb59522013-10-18 13:49:28 -0700538 stages.ArchiveStage, board, builder_run=builder_run,
Matt Tennant85348852014-01-10 15:16:02 -0800539 chrome_version=self._run.attrs.chrome_version)
Matt Tennantefb59522013-10-18 13:49:28 -0700540 board_config = BoardConfig(board, builder_run.config.name)
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400541 self.archive_stages[board_config] = archive_stage
Matt Tennantefb59522013-10-18 13:49:28 -0700542 tasks.append((builder_run, board, archive_stage))
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400543
David James45cd7c82014-02-05 14:53:43 -0800544 # Run BuildPackages and BuildImage in sequence.
545 for builder_run, board, archive_stage in tasks:
546 compilecheck = (builder_run.config.compilecheck or
547 builder_run.options.compilecheck)
548 if not compilecheck:
549 # Run BuildPackages and BuildImage in the foreground, generating
550 # or using PGO data if requested.
551 kwargs = {'archive_stage': archive_stage, 'builder_run': builder_run}
552 if builder_run.config.pgo_generate:
553 kwargs['pgo_generate'] = True
554 elif builder_run.config.pgo_use:
555 kwargs['pgo_use'] = True
556
557 self._RunStage(stages.BuildPackagesStage, board, **kwargs)
558 self._RunStage(stages.BuildImageStage, board, **kwargs)
559
560 if builder_run.config.pgo_generate:
561 suite = cbuildbot_config.PGORecordTest()
562 self._RunStage(stages.HWTestStage, board, archive_stage, suite,
563 builder_run=builder_run)
564
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400565 # Set up a process pool to run test/archive stages in the background.
David James45cd7c82014-02-05 14:53:43 -0800566 # This process runs the task_runner for each board added to the queue.
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400567 task_runner = self._RunBackgroundStagesForBoard
568 with parallel.BackgroundTaskRunner(task_runner) as queue:
Matt Tennantefb59522013-10-18 13:49:28 -0700569 for builder_run, board, archive_stage in tasks:
570 compilecheck = (builder_run.config.compilecheck or
571 builder_run.options.compilecheck)
Matt Tennantefb59522013-10-18 13:49:28 -0700572 queue.put([builder_run, board, compilecheck])
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400573
Brian Harring3fec5a82012-03-01 05:57:03 -0800574 def RunStages(self):
575 """Runs through build process."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800576 # TODO(sosa): Split these out into classes.
Matt Tennantefb59522013-10-18 13:49:28 -0700577 if self._run.config.build_type == constants.PRE_CQ_LAUNCHER_TYPE:
David James816a5942013-04-11 22:59:32 -0700578 self._RunStage(stages.PreCQLauncherStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700579 elif self._run.config.build_type == constants.CREATE_BRANCH_TYPE:
Ryan Cui88b901c2013-06-21 11:35:30 -0700580 self._RunStage(stages.BranchUtilStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700581 elif self._run.config.build_type == constants.CHROOT_BUILDER_TYPE:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400582 self._RunChrootBuilderTypeBuild()
Matt Tennantefb59522013-10-18 13:49:28 -0700583 elif self._run.config.build_type == constants.REFRESH_PACKAGES_TYPE:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400584 self._RunRefreshPackagesTypeBuild()
Matt Tennante8179042013-10-01 15:47:32 -0700585 elif (self._run.config.build_type == constants.PALADIN_TYPE and
586 self._run.config.master):
587 self._RunMasterPaladinBuild()
Brian Harring3fec5a82012-03-01 05:57:03 -0800588 else:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400589 self._RunDefaultTypeBuild()
David James58e0c092012-03-04 20:31:12 -0800590
Brian Harring3fec5a82012-03-01 05:57:03 -0800591
592class DistributedBuilder(SimpleBuilder):
593 """Build class that has special logic to handle distributed builds.
594
595 These builds sync using git/manifest logic in manifest_versions. In general
596 they use a non-distributed builder code for the bulk of the work.
597 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700598 def __init__(self, *args, **kwargs):
Brian Harring3fec5a82012-03-01 05:57:03 -0800599 """Initializes a buildbot builder.
600
601 Extra variables:
602 completion_stage_class: Stage used to complete a build. Set in the Sync
603 stage.
604 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700605 super(DistributedBuilder, self).__init__(*args, **kwargs)
Brian Harring3fec5a82012-03-01 05:57:03 -0800606 self.completion_stage_class = None
David Jamesf421c6d2013-04-11 15:37:57 -0700607 self.sync_stage = None
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400608 self._completion_stage = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800609
610 def GetSyncInstance(self):
611 """Syncs the tree using one of the distributed sync logic paths.
612
Mike Frysinger02e1e072013-11-10 22:11:34 -0500613 Returns:
614 The instance of the sync stage to run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800615 """
616 # Determine sync class to use. CQ overrides PFQ bits so should check it
617 # first.
Matt Tennantefb59522013-10-18 13:49:28 -0700618 if self._run.config.pre_cq or self._run.options.pre_cq:
David Jamesf421c6d2013-04-11 15:37:57 -0700619 sync_stage = self._GetStageInstance(stages.PreCQSyncStage,
620 self.patch_pool.gerrit_patches)
621 self.completion_stage_class = stages.PreCQCompletionStage
622 self.patch_pool.gerrit_patches = []
Matt Tennantefb59522013-10-18 13:49:28 -0700623 elif cbuildbot_config.IsCQType(self._run.config.build_type):
624 if self._run.config.do_not_apply_cq_patches:
Aviv Keshet00bc9512013-11-25 14:58:47 -0800625 sync_stage = self._GetStageInstance(stages.MasterSlaveSyncStage)
626 else:
627 sync_stage = self._GetStageInstance(stages.CommitQueueSyncStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800628 self.completion_stage_class = stages.CommitQueueCompletionStage
Matt Tennantefb59522013-10-18 13:49:28 -0700629 elif cbuildbot_config.IsPFQType(self._run.config.build_type):
Aviv Keshetf2746152013-11-26 10:42:46 -0800630 sync_stage = self._GetStageInstance(stages.MasterSlaveSyncStage)
631 self.completion_stage_class = stages.MasterSlaveSyncCompletionStage
Brian Harring3fec5a82012-03-01 05:57:03 -0800632 else:
633 sync_stage = self._GetStageInstance(stages.ManifestVersionedSyncStage)
634 self.completion_stage_class = stages.ManifestVersionedSyncCompletionStage
635
David Jamesf421c6d2013-04-11 15:37:57 -0700636 self.sync_stage = sync_stage
637 return self.sync_stage
Brian Harring3fec5a82012-03-01 05:57:03 -0800638
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400639 def GetCompletionInstance(self):
640 """Returns the completion_stage_class instance that was used for this build.
641
Mike Frysinger1a736a82013-12-12 01:50:59 -0500642 Returns:
643 None if the completion_stage instance was not yet created (this
644 occurs during Publish).
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400645 """
646 return self._completion_stage
647
Brian Harring3fec5a82012-03-01 05:57:03 -0800648 def Publish(self, was_build_successful):
649 """Completes build by publishing any required information."""
650 completion_stage = self._GetStageInstance(self.completion_stage_class,
David Jamesf421c6d2013-04-11 15:37:57 -0700651 self.sync_stage,
Brian Harring3fec5a82012-03-01 05:57:03 -0800652 was_build_successful)
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400653 self._completion_stage = completion_stage
David James11fd7e82013-10-23 20:02:16 -0700654 completion_successful = False
655 try:
656 completion_stage.Run()
657 completion_successful = True
658 finally:
659 if not completion_successful:
660 was_build_successful = False
Matt Tennantefb59522013-10-18 13:49:28 -0700661 if self._run.config.push_overlays:
David James11fd7e82013-10-23 20:02:16 -0700662 self._RunStage(stages.PublishUprevChangesStage, was_build_successful)
Brian Harring3fec5a82012-03-01 05:57:03 -0800663
664 def RunStages(self):
665 """Runs simple builder logic and publishes information to overlays."""
666 was_build_successful = False
David James843ed252013-09-11 16:18:10 -0700667 try:
668 super(DistributedBuilder, self).RunStages()
669 was_build_successful = results_lib.Results.BuildSucceededSoFar()
670 except SystemExit as ex:
671 # If a stage calls sys.exit(0), it's exiting with success, so that means
672 # we should mark ourselves as successful.
673 if ex.code == 0:
674 was_build_successful = True
675 raise
676 finally:
677 self.Publish(was_build_successful)
Brian Harring3fec5a82012-03-01 05:57:03 -0800678
Brian Harring3fec5a82012-03-01 05:57:03 -0800679
680def _ConfirmBuildRoot(buildroot):
681 """Confirm with user the inferred buildroot, and mark it as confirmed."""
Brian Harring521e7242012-11-01 16:57:42 -0700682 cros_build_lib.Warning('Using default directory %s as buildroot', buildroot)
683 if not cros_build_lib.BooleanPrompt(default=False):
684 print('Please specify a different buildroot via the --buildroot option.')
Brian Harring3fec5a82012-03-01 05:57:03 -0800685 sys.exit(0)
686
687 if not os.path.exists(buildroot):
688 os.mkdir(buildroot)
689
690 repository.CreateTrybotMarker(buildroot)
691
692
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700693def _ConfirmRemoteBuildbotRun():
694 """Confirm user wants to run with --buildbot --remote."""
Brian Harring521e7242012-11-01 16:57:42 -0700695 cros_build_lib.Warning(
696 'You are about to launch a PRODUCTION job! This is *NOT* a '
697 'trybot run! Are you sure?')
698 if not cros_build_lib.BooleanPrompt(default=False):
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700699 print('Please specify --pass-through="--debug".')
700 sys.exit(0)
701
702
Ryan Cui5ba7e152012-05-10 14:36:52 -0700703def _DetermineDefaultBuildRoot(sourceroot, internal_build):
Brian Harring3fec5a82012-03-01 05:57:03 -0800704 """Default buildroot to be under the directory that contains current checkout.
705
Mike Frysinger02e1e072013-11-10 22:11:34 -0500706 Args:
Brian Harring3fec5a82012-03-01 05:57:03 -0800707 internal_build: Whether the build is an internal build
Ryan Cui5ba7e152012-05-10 14:36:52 -0700708 sourceroot: Use specified sourceroot.
Brian Harring3fec5a82012-03-01 05:57:03 -0800709 """
Ryan Cui5ba7e152012-05-10 14:36:52 -0700710 if not repository.IsARepoRoot(sourceroot):
Brian Harring1b8c4c82012-05-29 23:03:04 -0700711 cros_build_lib.Die(
712 'Could not find root of local checkout at %s. Please specify '
713 'using the --sourceroot option.' % sourceroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800714
715 # Place trybot buildroot under the directory containing current checkout.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700716 top_level = os.path.dirname(os.path.realpath(sourceroot))
Brian Harring3fec5a82012-03-01 05:57:03 -0800717 if internal_build:
718 buildroot = os.path.join(top_level, _DEFAULT_INT_BUILDROOT)
719 else:
720 buildroot = os.path.join(top_level, _DEFAULT_EXT_BUILDROOT)
721
722 return buildroot
723
724
Mike Frysinger6903c762012-12-04 01:57:16 -0500725def _DisableYamaHardLinkChecks():
726 """Disable Yama kernel hardlink security checks.
727
728 The security module disables hardlinking to files you do not have
729 write access to which causes some of our build scripts problems.
730 Disable it so we don't have to worry about it.
731 """
732 PROC_PATH = '/proc/sys/kernel/yama/protected_nonaccess_hardlinks'
733 SYSCTL_PATH = PROC_PATH[len('/proc/sys/'):].replace('/', '.')
734
735 # Yama not available in this system -- nothing to do.
736 if not os.path.exists(PROC_PATH):
737 return
738
739 # Already disabled -- nothing to do.
740 if osutils.ReadFile(PROC_PATH).strip() == '0':
741 return
742
743 # Create a hardlink in a tempdir and see if we get back EPERM.
David James4bc13702013-03-26 08:08:04 -0700744 with osutils.TempDir() as tempdir:
Mike Frysinger6903c762012-12-04 01:57:16 -0500745 try:
746 os.link('/bin/sh', os.path.join(tempdir, 'sh'))
747 except OSError as e:
748 if e.errno == errno.EPERM:
749 cros_build_lib.Warning('Disabling Yama hardlink security')
750 cros_build_lib.SudoRunCommand(['sysctl', '%s=0' % SYSCTL_PATH])
751
752
Brian Harring3fec5a82012-03-01 05:57:03 -0800753def _BackupPreviousLog(log_file, backup_limit=25):
754 """Rename previous log.
755
756 Args:
757 log_file: The absolute path to the previous log.
Aviv Keshet9e4236b2013-12-13 13:07:50 -0800758 backup_limit: Maximum number of old logs to keep.
Brian Harring3fec5a82012-03-01 05:57:03 -0800759 """
760 if os.path.exists(log_file):
761 old_logs = sorted(glob.glob(log_file + '.*'),
762 key=distutils.version.LooseVersion)
763
764 if len(old_logs) >= backup_limit:
765 os.remove(old_logs[0])
766
767 last = 0
768 if old_logs:
769 last = int(old_logs.pop().rpartition('.')[2])
770
771 os.rename(log_file, log_file + '.' + str(last + 1))
772
Ryan Cui5616a512012-08-17 13:39:36 -0700773
Gaurav Shah298aa372014-01-31 09:27:24 -0800774def _IsDistributedBuilder(options, chrome_rev, build_config):
775 """Determines whether the builder should be a DistributedBuilder.
776
777 Args:
778 options: options passed on the commandline.
779 chrome_rev: Chrome revision to build.
780 build_config: Builder configuration dictionary.
781
782 Returns:
783 True if the builder should be a distributed_builder
784 """
785 if build_config['pre_cq'] or options.pre_cq:
786 return True
787 elif not options.buildbot:
788 return False
789 elif chrome_rev in (constants.CHROME_REV_TOT,
790 constants.CHROME_REV_LOCAL,
791 constants.CHROME_REV_SPEC):
792 # We don't do distributed logic to TOT Chrome PFQ's, nor local
793 # chrome roots (e.g. chrome try bots)
794 # TODO(davidjames): Update any builders that rely on this logic to use
795 # manifest_version=False instead.
796 return False
797 elif build_config['manifest_version']:
798 return True
799
800 return False
801
802
David James944a48e2012-03-07 12:19:03 -0800803def _RunBuildStagesWrapper(options, build_config):
Brian Harring3fec5a82012-03-01 05:57:03 -0800804 """Helper function that wraps RunBuildStages()."""
Matt Tennant7feda352013-12-20 14:03:40 -0800805 cros_build_lib.Info('cbuildbot was executed with args %s' %
806 cros_build_lib.CmdToStr(sys.argv))
Brian Harring3fec5a82012-03-01 05:57:03 -0800807
David Jamesa0a664e2013-02-13 09:52:01 -0800808 chrome_rev = build_config['chrome_rev']
809 if options.chrome_rev:
810 chrome_rev = options.chrome_rev
811 if chrome_rev == constants.CHROME_REV_TOT:
812 # Build the TOT Chrome revision.
813 svn_url = gclient.GetBaseURLs()[0]
814 options.chrome_version = gclient.GetTipOfTrunkSvnRevision(svn_url)
815 options.chrome_rev = constants.CHROME_REV_SPEC
816
David James4a404a52013-02-19 13:07:59 -0800817 # If it's likely we'll need to build Chrome, fetch the source.
Mike Frysingerf4d9ab82013-03-05 19:38:05 -0500818 if build_config['sync_chrome'] is None:
819 options.managed_chrome = (chrome_rev != constants.CHROME_REV_LOCAL and
820 (not build_config['usepkg_build_packages'] or chrome_rev or
David James3cce4642013-05-10 17:50:23 -0700821 build_config['profile'] or options.rietveld_patches))
Mike Frysingerf4d9ab82013-03-05 19:38:05 -0500822 else:
823 options.managed_chrome = build_config['sync_chrome']
David James2333c182013-02-13 16:16:15 -0800824
825 if options.managed_chrome:
826 # Tell Chrome to fetch the source locally.
Matt Tennant628ffdd2013-11-27 14:44:39 -0800827 internal = constants.USE_CHROME_INTERNAL in build_config['useflags']
David James2333c182013-02-13 16:16:15 -0800828 chrome_src = 'chrome-src-internal' if internal else 'chrome-src'
829 options.chrome_root = os.path.join(options.cache_dir, 'distfiles', 'target',
830 chrome_src)
David James9e27e662013-02-14 13:42:43 -0800831 elif options.rietveld_patches:
David James4a404a52013-02-19 13:07:59 -0800832 cros_build_lib.Die('This builder does not support Rietveld patches.')
David James2333c182013-02-13 16:16:15 -0800833
Matt Tennant95a42ad2013-12-27 15:38:36 -0800834 # We are done munging options values, so freeze options object now to avoid
835 # further abuse of it.
836 # TODO(mtennant): one by one identify each options value override and see if
837 # it can be handled another way. Try to push this freeze closer and closer
838 # to the start of the script (e.g. in or after _PostParseCheck).
839 options.Freeze()
840
Matt Tennant0940c382014-01-21 20:43:55 -0800841 with parallel.Manager() as manager:
842 builder_run = cbuildbot_run.BuilderRun(options, build_config, manager)
843 if _IsDistributedBuilder(options, chrome_rev, build_config):
844 builder_cls = DistributedBuilder
845 else:
846 builder_cls = SimpleBuilder
847 builder = builder_cls(builder_run)
848 if not builder.Run():
849 sys.exit(1)
Brian Harring3fec5a82012-03-01 05:57:03 -0800850
851
852# Parser related functions
Ryan Cui5ba7e152012-05-10 14:36:52 -0700853def _CheckLocalPatches(sourceroot, local_patches):
Brian Harring3fec5a82012-03-01 05:57:03 -0800854 """Do an early quick check of the passed-in patches.
855
856 If the branch of a project is not specified we append the current branch the
857 project is on.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700858
David Jamese3b06062013-11-09 18:52:02 -0800859 TODO(davidjames): The project:branch format isn't unique, so this means that
860 we can't differentiate what directory the user intended to apply patches to.
861 We should references by directory instead.
862
Ryan Cui5ba7e152012-05-10 14:36:52 -0700863 Args:
864 sourceroot: The checkout where patches are coming from.
Aviv Keshet9e4236b2013-12-13 13:07:50 -0800865 local_patches: List of patches to check in project:branch format.
David Jamese3b06062013-11-09 18:52:02 -0800866
867 Returns:
868 A list of patches that have been verified, in project:branch format.
Brian Harring3fec5a82012-03-01 05:57:03 -0800869 """
Ryan Cuicedd8a52012-03-22 02:28:35 -0700870 verified_patches = []
David James97d95872012-11-16 15:09:56 -0800871 manifest = git.ManifestCheckout.Cached(sourceroot)
Ryan Cuicedd8a52012-03-22 02:28:35 -0700872 for patch in local_patches:
David Jamese3b06062013-11-09 18:52:02 -0800873 project, _, branch = patch.partition(':')
874
Gaurav Shah7afb0562013-12-26 15:05:39 -0800875 checkouts = manifest.FindCheckouts(project, only_patchable=True)
David Jamese3b06062013-11-09 18:52:02 -0800876 if not checkouts:
877 cros_build_lib.Die('Project %s does not exist.' % (project,))
878 if len(checkouts) > 1:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700879 cros_build_lib.Die(
David Jamese3b06062013-11-09 18:52:02 -0800880 'We do not yet support local patching for projects that are checked '
881 'out to multiple directories. Try uploading your patch to gerrit '
882 'and referencing it via the -g option instead.'
883 )
Brian Harring3fec5a82012-03-01 05:57:03 -0800884
David Jamese3b06062013-11-09 18:52:02 -0800885 ok = False
886 for checkout in checkouts:
887 project_dir = checkout.GetPath(absolute=True)
Brian Harring3fec5a82012-03-01 05:57:03 -0800888
David Jamese3b06062013-11-09 18:52:02 -0800889 # If no branch was specified, we use the project's current branch.
Brian Harring3fec5a82012-03-01 05:57:03 -0800890 if not branch:
David Jamese3b06062013-11-09 18:52:02 -0800891 local_branch = git.GetCurrentBranch(project_dir)
892 else:
893 local_branch = branch
Brian Harring3fec5a82012-03-01 05:57:03 -0800894
David Jamese3b06062013-11-09 18:52:02 -0800895 if local_branch and git.DoesLocalBranchExist(project_dir, local_branch):
896 verified_patches.append('%s:%s' % (project, local_branch))
897 ok = True
898
899 if not ok:
900 if branch:
901 cros_build_lib.Die('Project %s does not have branch %s'
902 % (project, branch))
903 else:
904 cros_build_lib.Die('Project %s is not on a branch!' % (project,))
Brian Harring3fec5a82012-03-01 05:57:03 -0800905
Ryan Cuicedd8a52012-03-22 02:28:35 -0700906 return verified_patches
Brian Harring3fec5a82012-03-01 05:57:03 -0800907
908
Brian Harring3fec5a82012-03-01 05:57:03 -0800909def _CheckChromeVersionOption(_option, _opt_str, value, parser):
910 """Upgrade other options based on chrome_version being passed."""
911 value = value.strip()
912
913 if parser.values.chrome_rev is None and value:
914 parser.values.chrome_rev = constants.CHROME_REV_SPEC
915
916 parser.values.chrome_version = value
917
918
919def _CheckChromeRootOption(_option, _opt_str, value, parser):
920 """Validate and convert chrome_root to full-path form."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800921 if parser.values.chrome_rev is None:
922 parser.values.chrome_rev = constants.CHROME_REV_LOCAL
923
Ryan Cui5ba7e152012-05-10 14:36:52 -0700924 parser.values.chrome_root = value
Brian Harring3fec5a82012-03-01 05:57:03 -0800925
926
927def _CheckChromeRevOption(_option, _opt_str, value, parser):
928 """Validate the chrome_rev option."""
929 value = value.strip()
930 if value not in constants.VALID_CHROME_REVISIONS:
931 raise optparse.OptionValueError('Invalid chrome rev specified')
932
933 parser.values.chrome_rev = value
934
935
David Jamesac8c2a72013-02-13 18:44:33 -0800936def FindCacheDir(_parser, _options):
Brian Harringae0a5322012-09-15 01:46:51 -0700937 return None
938
939
Ryan Cui5ba7e152012-05-10 14:36:52 -0700940class CustomGroup(optparse.OptionGroup):
Aviv Keshet9e4236b2013-12-13 13:07:50 -0800941 """Custom option group which supports arguments passed-through to trybot."""
Ryan Cui5ba7e152012-05-10 14:36:52 -0700942 def add_remote_option(self, *args, **kwargs):
943 """For arguments that are passed-through to remote trybot."""
944 return optparse.OptionGroup.add_option(self, *args,
945 remote_pass_through=True,
946 **kwargs)
947
948
Ryan Cui1c13a252012-10-16 15:00:16 -0700949class CustomOption(commandline.FilteringOption):
950 """Subclass FilteringOption class to implement pass-through and api."""
Ryan Cui5ba7e152012-05-10 14:36:52 -0700951
Ryan Cui1c13a252012-10-16 15:00:16 -0700952 ACTIONS = commandline.FilteringOption.ACTIONS + ('extend',)
953 STORE_ACTIONS = commandline.FilteringOption.STORE_ACTIONS + ('extend',)
954 TYPED_ACTIONS = commandline.FilteringOption.TYPED_ACTIONS + ('extend',)
955 ALWAYS_TYPED_ACTIONS = (commandline.FilteringOption.ALWAYS_TYPED_ACTIONS +
956 ('extend',))
Ryan Cui79319ab2012-05-21 12:59:18 -0700957
Ryan Cui5ba7e152012-05-10 14:36:52 -0700958 def __init__(self, *args, **kwargs):
959 # The remote_pass_through argument specifies whether we should directly
960 # pass the argument (with its value) onto the remote trybot.
961 self.pass_through = kwargs.pop('remote_pass_through', False)
Ryan Cui1c13a252012-10-16 15:00:16 -0700962 self.api_version = int(kwargs.pop('api', '0'))
963 commandline.FilteringOption.__init__(self, *args, **kwargs)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700964
965 def take_action(self, action, dest, opt, value, values, parser):
Ryan Cui79319ab2012-05-21 12:59:18 -0700966 if action == 'extend':
Mike Frysingerd6925b52012-07-16 16:11:00 -0400967 # If there is extra spaces between each argument, we get '' which later
968 # code barfs on, so skip those. e.g. We see this with the forms:
969 # cbuildbot -p 'proj:branch ' ...
970 # cbuildbot -p ' proj:branch' ...
971 # cbuildbot -p 'proj:branch proj2:branch' ...
972 lvalue = value.split()
Ryan Cui79319ab2012-05-21 12:59:18 -0700973 values.ensure_value(dest, []).extend(lvalue)
Ryan Cui79319ab2012-05-21 12:59:18 -0700974
Ryan Cui1c13a252012-10-16 15:00:16 -0700975 commandline.FilteringOption.take_action(
976 self, action, dest, opt, value, values, parser)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700977
978
Ryan Cui1c13a252012-10-16 15:00:16 -0700979class CustomParser(commandline.FilteringParser):
Aviv Keshet9e4236b2013-12-13 13:07:50 -0800980 """Custom option parser which supports arguments passed-trhough to trybot"""
Matt Tennante8179042013-10-01 15:47:32 -0700981
Brian Harringb6cf9142012-09-01 20:43:17 -0700982 DEFAULT_OPTION_CLASS = CustomOption
983
984 def add_remote_option(self, *args, **kwargs):
985 """For arguments that are passed-through to remote trybot."""
Ryan Cui1c13a252012-10-16 15:00:16 -0700986 return self.add_option(*args, remote_pass_through=True, **kwargs)
Brian Harringb6cf9142012-09-01 20:43:17 -0700987
988
Brian Harring3fec5a82012-03-01 05:57:03 -0800989def _CreateParser():
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700990 """Generate and return the parser with all the options."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800991 # Parse options
Matt Tennant763497d2014-01-17 16:45:54 -0800992 usage = "usage: %prog [options] buildbot_config [buildbot_config ...]"
Brian Harringae0a5322012-09-15 01:46:51 -0700993 parser = CustomParser(usage=usage, caching=FindCacheDir)
Brian Harring3fec5a82012-03-01 05:57:03 -0800994
995 # Main options
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400996 parser.add_option('-l', '--list', action='store_true', dest='list',
997 default=False,
998 help='List the suggested trybot configs to use (see --all)')
Brian Harring3fec5a82012-03-01 05:57:03 -0800999 parser.add_option('-a', '--all', action='store_true', dest='print_all',
1000 default=False,
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001001 help='List all of the buildbot configs available w/--list')
1002
1003 parser.add_option('--local', default=False, action='store_true',
Ryan Cui88b901c2013-06-21 11:35:30 -07001004 help='Specifies that this tryjob should be run locally. '
1005 'Implies --debug.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001006 parser.add_option('--remote', default=False, action='store_true',
Ryan Cui88b901c2013-06-21 11:35:30 -07001007 help='Specifies that this tryjob should be run remotely.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001008
Ryan Cuie1e4e662012-05-21 16:39:46 -07001009 parser.add_remote_option('-b', '--branch',
1010 help='The manifest branch to test. The branch to '
1011 'check the buildroot out to.')
Ryan Cui5ba7e152012-05-10 14:36:52 -07001012 parser.add_option('-r', '--buildroot', dest='buildroot', type='path',
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001013 help='Root directory where source is checked out to, and '
1014 'where the build occurs. For external build configs, '
1015 "defaults to 'trybot' directory at top level of your "
1016 'repo-managed checkout.')
1017 parser.add_remote_option('--chrome_rev', default=None, type='string',
1018 action='callback', dest='chrome_rev',
1019 callback=_CheckChromeRevOption,
1020 help=('Revision of Chrome to use, of type [%s]'
1021 % '|'.join(constants.VALID_CHROME_REVISIONS)))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001022 parser.add_remote_option('--profile', default=None, type='string',
1023 action='store', dest='profile',
1024 help='Name of profile to sub-specify board variant.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001025
Ryan Cuif4f84be2012-07-09 18:50:41 -07001026 #
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001027 # Patch selection options.
1028 #
1029
1030 group = CustomGroup(
1031 parser,
1032 'Patch Options')
1033
1034 group.add_remote_option('-g', '--gerrit-patches', action='extend',
1035 default=[], type='string',
1036 metavar="'Id1 *int_Id2...IdN'",
1037 help="Space-separated list of short-form Gerrit "
1038 "Change-Id's or change numbers to patch. "
1039 "Please prepend '*' to internal Change-Id's")
1040 group.add_remote_option('-G', '--rietveld-patches', action='extend',
1041 default=[], type='string',
1042 metavar="'id1[:subdir1]...idN[:subdirN]'",
1043 help='Space-separated list of short-form Rietveld '
1044 'issue numbers to patch. If no subdir is '
1045 'specified, the src directory is used.')
1046 group.add_option('-p', '--local-patches', action='extend', default=[],
1047 metavar="'<project1>[:<branch1>]...<projectN>[:<branchN>]'",
1048 help='Space-separated list of project branches with '
1049 'patches to apply. Projects are specified by name. '
1050 'If no branch is specified the current branch of the '
1051 'project will be used.')
1052
1053 parser.add_option_group(group)
1054
1055 #
1056 # Remote trybot options.
1057 #
1058
1059 group = CustomGroup(
1060 parser,
1061 'Remote Trybot Options (--remote)')
1062
1063 group.add_remote_option('--hwtest', dest='hwtest', action='store_true',
1064 default=False,
1065 help='Run the HWTest stage (tests on real hardware)')
1066 group.add_option('--remote-description', default=None,
1067 help='Attach an optional description to a --remote run '
1068 'to make it easier to identify the results when it '
1069 'finishes')
1070 group.add_option('--slaves', action='extend', default=[],
1071 help='Specify specific remote tryslaves to run on (e.g. '
1072 'build149-m2); if the bot is busy, it will be queued')
1073 group.add_option('--test-tryjob', action='store_true',
1074 default=False,
1075 help='Submit a tryjob to the test repository. Will not '
1076 'show up on the production trybot waterfall.')
1077
1078 parser.add_option_group(group)
1079
1080 #
Ryan Cui88b901c2013-06-21 11:35:30 -07001081 # Branch creation options.
1082 #
1083
1084 group = CustomGroup(
1085 parser,
1086 'Branch Creation Options (used with branch-util)')
1087
1088 group.add_remote_option('--branch-name',
1089 help='The branch to create or delete.')
1090 group.add_remote_option('--delete-branch', default=False, action='store_true',
1091 help='Delete the branch specified in --branch-name.')
1092 group.add_remote_option('--rename-to', type='string',
1093 help='Rename a branch to the specified name.')
1094 group.add_remote_option('--force-create', default=False, action='store_true',
1095 help='Overwrites an existing branch.')
1096
1097 parser.add_option_group(group)
1098
1099 #
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001100 # Advanced options.
Ryan Cuif4f84be2012-07-09 18:50:41 -07001101 #
1102
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001103 group = CustomGroup(
Brian Harring3fec5a82012-03-01 05:57:03 -08001104 parser,
1105 'Advanced Options',
1106 'Caution: use these options at your own risk.')
1107
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001108 group.add_remote_option('--bootstrap-args', action='append', default=[],
1109 help='Args passed directly to the bootstrap re-exec '
1110 'to skip verification by the bootstrap code')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001111 group.add_remote_option('--buildbot', dest='buildbot', action='store_true',
1112 default=False, help='This is running on a buildbot')
1113 group.add_remote_option('--buildnumber', help='build number', type='int',
1114 default=0)
Ryan Cui5ba7e152012-05-10 14:36:52 -07001115 group.add_option('--chrome_root', default=None, type='path',
1116 action='callback', callback=_CheckChromeRootOption,
1117 dest='chrome_root', help='Local checkout of Chrome to use.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001118 group.add_remote_option('--chrome_version', default=None, type='string',
1119 action='callback', dest='chrome_version',
1120 callback=_CheckChromeVersionOption,
1121 help='Used with SPEC logic to force a particular SVN '
1122 'revision of chrome rather than the latest.')
1123 group.add_remote_option('--clobber', action='store_true', dest='clobber',
1124 default=False,
1125 help='Clears an old checkout before syncing')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001126 group.add_remote_option('--latest-toolchain', action='store_true',
1127 default=False,
1128 help='Use the latest toolchain.')
Ryan Cui5ba7e152012-05-10 14:36:52 -07001129 parser.add_option('--log_dir', dest='log_dir', type='path',
Brian Harring3fec5a82012-03-01 05:57:03 -08001130 help=('Directory where logs are stored.'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001131 group.add_remote_option('--maxarchives', dest='max_archive_builds',
1132 default=3, type='int',
1133 help="Change the local saved build count limit.")
Ryan Cuibbd3d4b2012-08-17 12:20:37 -07001134 parser.add_remote_option('--manifest-repo-url',
1135 help=('Overrides the default manifest repo url.'))
David James565bc9a2013-04-08 14:54:45 -07001136 group.add_remote_option('--compilecheck', action='store_true', default=False,
1137 help='Only verify compilation and unit tests.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001138 group.add_remote_option('--noarchive', action='store_false', dest='archive',
1139 default=True, help="Don't run archive stage.")
Ryan Cuif7f24692012-05-18 16:35:33 -07001140 group.add_remote_option('--nobootstrap', action='store_false',
1141 dest='bootstrap', default=True,
1142 help="Don't checkout and run from a standalone "
1143 "chromite repo.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001144 group.add_remote_option('--nobuild', action='store_false', dest='build',
1145 default=True,
1146 help="Don't actually build (for cbuildbot dev)")
1147 group.add_remote_option('--noclean', action='store_false', dest='clean',
1148 default=True, help="Don't clean the buildroot")
Ryan Cuif7f24692012-05-18 16:35:33 -07001149 group.add_remote_option('--nocgroups', action='store_false', dest='cgroups',
1150 default=True,
1151 help='Disable cbuildbots usage of cgroups.')
Ryan Cui3ea98e02013-08-07 16:01:48 -07001152 group.add_remote_option('--nochromesdk', action='store_false',
1153 dest='chrome_sdk', default=True,
1154 help="Don't run the ChromeSDK stage which builds "
1155 "Chrome outside of the chroot.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001156 group.add_remote_option('--noprebuilts', action='store_false',
1157 dest='prebuilts', default=True,
1158 help="Don't upload prebuilts.")
Ryan Cui88b901c2013-06-21 11:35:30 -07001159 group.add_remote_option('--nopatch', action='store_false',
1160 dest='postsync_patch', default=True,
1161 help=("Don't run PatchChanges stage. This does not "
1162 "disable patching in of chromite patches "
1163 "during BootstrapStage."))
Don Garrett82c0ae82014-02-03 18:25:11 -08001164 group.add_remote_option('--nopaygen', action='store_false',
1165 dest='paygen', default=True,
1166 help="Don't generate payloads.")
Ryan Cui88b901c2013-06-21 11:35:30 -07001167 group.add_remote_option('--noreexec', action='store_false',
1168 dest='postsync_reexec', default=True,
1169 help="Don't reexec into the buildroot after syncing.")
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001170 group.add_remote_option('--nosdk', action='store_true',
1171 default=False,
1172 help='Re-create the SDK from scratch.')
Don Garrett7604d6a2014-01-15 14:45:39 -08001173 group.add_remote_option('--nosigner-results', action='store_false',
1174 dest='signer_results', default=True,
1175 help="Don't display signing results.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001176 group.add_remote_option('--nosync', action='store_false', dest='sync',
1177 default=True, help="Don't sync before building.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001178 group.add_remote_option('--notests', action='store_false', dest='tests',
1179 default=True,
1180 help='Override values from buildconfig and run no '
1181 'tests.')
1182 group.add_remote_option('--nouprev', action='store_false', dest='uprev',
1183 default=True,
1184 help='Override values from buildconfig and never '
1185 'uprev.')
David Jamesdac7a912013-11-18 11:14:44 -08001186 group.add_option('--reference-repo', action='store', default=None,
1187 dest='reference_repo',
1188 help='Reuse git data stored in an existing repo '
1189 'checkout. This can drastically reduce the network '
1190 'time spent setting up the trybot checkout. By '
1191 "default, if this option isn't given but cbuildbot "
1192 'is invoked from a repo checkout, cbuildbot will '
1193 'use the repo root.')
Ryan Cuicedd8a52012-03-22 02:28:35 -07001194 group.add_option('--resume', action='store_true', default=False,
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001195 help='Skip stages already successfully completed.')
1196 group.add_remote_option('--timeout', action='store', type='int', default=0,
1197 help='Specify the maximum amount of time this job '
1198 'can run for, at which point the build will be '
1199 'aborted. If set to zero, then there is no '
1200 'timeout.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001201 group.add_remote_option('--version', dest='force_version', default=None,
1202 help='Used with manifest logic. Forces use of this '
Aviv Keshetc2c123d2013-10-14 18:06:12 -04001203 'version rather than create or get latest. '
1204 'Examples: 4815.0.0-rc1, 4815.1.2')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001205
1206 parser.add_option_group(group)
1207
1208 #
1209 # Internal options.
1210 #
1211
1212 group = CustomGroup(
1213 parser,
Mike Frysinger34db8692013-11-11 14:54:08 -05001214 'Internal Chromium OS Build Team Options',
1215 'Caution: these are for meant for the Chromium OS build team only')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001216
1217 group.add_remote_option('--archive-base', type='gs_path',
1218 help='Base GS URL (gs://<bucket_name>/<path>) to '
1219 'upload archive artifacts to')
Brian Harringab8fb5c2012-07-18 11:28:22 -07001220 group.add_remote_option('--cq-gerrit-query', dest='cq_gerrit_override',
1221 default=None,
1222 help=
1223 "If given, this gerrit query will be used to find what patches to test, "
Aviv Keshetefd6bbf2013-12-12 13:36:57 -08001224 "rather than the normal 'CommitQueue>=1 AND Verified=1 AND CodeReview=2' "
Brian Harringab8fb5c2012-07-18 11:28:22 -07001225 "query it defaults to. Use with care- note additionally this setting "
1226 "only has an effect if the buildbot target is a cq target, and we're "
1227 "in buildbot mode.")
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001228 group.add_option('--pass-through', dest='pass_through_args', action='append',
1229 type='string', default=[])
David Jamesf421c6d2013-04-11 15:37:57 -07001230 group.add_remote_option('--pre-cq', action='store_true', default=False,
1231 help='Mark CLs as tested by the PreCQ on success.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001232 group.add_option('--reexec-api-version', dest='output_api_version',
Ryan Cuif4f84be2012-07-09 18:50:41 -07001233 action='store_true', default=False,
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001234 help='Used for handling forwards/backwards compatibility '
1235 'with --resume and --bootstrap')
1236 group.add_option('--remote-trybot', dest='remote_trybot',
1237 action='store_true', default=False,
1238 help='Indicates this is running on a remote trybot machine')
1239 group.add_remote_option('--remote-patches', action='extend', default=[],
1240 help='Patches uploaded by the trybot client when run '
1241 'using the -p option')
Brian Harringf611e6e2012-07-17 18:47:44 -07001242 # Note the default here needs to be hardcoded to 3; that is the last version
1243 # that lacked this functionality.
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001244 group.add_option('--remote-version', default=3, type=int, action='store',
1245 help='Used for compatibility checks w/tryjobs running in '
1246 'older chromite instances')
1247 group.add_option('--sourceroot', type='path', default=constants.SOURCE_ROOT)
1248 group.add_remote_option('--test-bootstrap', action='store_true',
1249 default=False,
1250 help='Causes cbuildbot to bootstrap itself twice, in '
1251 'the sequence A->B->C: A(unpatched) patches and '
1252 'bootstraps B; B patches and bootstraps C')
1253 group.add_remote_option('--validation_pool', default=None,
1254 help='Path to a pickled validation pool. Intended '
1255 'for use only with the commit queue.')
Aviv Kesheta0159be2013-12-12 13:56:28 -08001256 group.add_remote_option('--mock-tree-status', dest='mock_tree_status',
1257 default=None, action='store',
1258 help='Override the tree status value that would be '
1259 'returned from the the actual tree. Example '
1260 'values: open, closed, throttled. When used '
1261 'in conjunction with --debug, the tree status '
1262 'will not be ignored as it usually is in a '
1263 '--debug run.')
Aviv Keshetcf9c2722014-02-25 15:15:10 -08001264 group.add_remote_option('--mock-slave-status', dest='mock_slave_status',
1265 default=None, action='store',
1266 metavar='MOCK_SLAVE_STATUS_PICKLE_FILE',
1267 help='Override the result of the _FetchSlaveStatuses '
1268 'method of MasterSlaveSyncCompletionStage, by '
1269 'specifying a file with a pickle of the result '
1270 'to be returned.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001271
1272 parser.add_option_group(group)
Ryan Cuif4f84be2012-07-09 18:50:41 -07001273
1274 #
Brian Harring3fec5a82012-03-01 05:57:03 -08001275 # Debug options
Ryan Cuif4f84be2012-07-09 18:50:41 -07001276 #
Brian Harringfec89fe2012-09-23 07:30:54 -07001277 # Temporary hack; in place till --dry-run replaces --debug.
1278 # pylint: disable=W0212
Brian Harring009db502012-10-10 02:21:37 -07001279 group = parser.debug_group
Brian Harringfec89fe2012-09-23 07:30:54 -07001280 debug = [x for x in group.option_list if x._long_opts == ['--debug']][0]
1281 debug.help += " Currently functions as --dry-run in addition."
1282 debug.pass_through = True
Brian Harring3fec5a82012-03-01 05:57:03 -08001283 group.add_option('--notee', action='store_false', dest='tee', default=True,
1284 help="Disable logging and internal tee process. Primarily "
1285 "used for debugging cbuildbot itself.")
Brian Harring3fec5a82012-03-01 05:57:03 -08001286 return parser
1287
1288
Ryan Cui85867972012-02-23 18:21:49 -08001289def _FinishParsing(options, args):
1290 """Perform some parsing tasks that need to take place after optparse.
1291
1292 This function needs to be easily testable! Keep it free of
1293 environment-dependent code. Put more detailed usage validation in
1294 _PostParseCheck().
Brian Harring3fec5a82012-03-01 05:57:03 -08001295
1296 Args:
Matt Tennant759e2352013-09-27 15:14:44 -07001297 options: The options object returned by optparse
1298 args: The args object returned by optparse
Brian Harring3fec5a82012-03-01 05:57:03 -08001299 """
Ryan Cui41023d92012-11-13 19:59:50 -08001300 # Populate options.pass_through_args.
1301 accepted, _ = commandline.FilteringParser.FilterArgs(
1302 options.parsed_args, lambda x: x.opt_inst.pass_through)
1303 options.pass_through_args.extend(accepted)
Brian Harring07039b52012-05-13 17:56:47 -07001304
Brian Harring3fec5a82012-03-01 05:57:03 -08001305 if options.chrome_root:
1306 if options.chrome_rev != constants.CHROME_REV_LOCAL:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001307 cros_build_lib.Die('Chrome rev must be %s if chrome_root is set.' %
1308 constants.CHROME_REV_LOCAL)
David Jamesa0a664e2013-02-13 09:52:01 -08001309 elif options.chrome_rev == constants.CHROME_REV_LOCAL:
1310 cros_build_lib.Die('Chrome root must be set if chrome_rev is %s.' %
1311 constants.CHROME_REV_LOCAL)
Brian Harring3fec5a82012-03-01 05:57:03 -08001312
1313 if options.chrome_version:
1314 if options.chrome_rev != constants.CHROME_REV_SPEC:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001315 cros_build_lib.Die('Chrome rev must be %s if chrome_version is set.' %
1316 constants.CHROME_REV_SPEC)
David Jamesa0a664e2013-02-13 09:52:01 -08001317 elif options.chrome_rev == constants.CHROME_REV_SPEC:
1318 cros_build_lib.Die(
1319 'Chrome rev must not be %s if chrome_version is not set.'
1320 % constants.CHROME_REV_SPEC)
Brian Harring3fec5a82012-03-01 05:57:03 -08001321
David James9e27e662013-02-14 13:42:43 -08001322 patches = bool(options.gerrit_patches or options.local_patches or
1323 options.rietveld_patches)
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001324 if options.remote:
1325 if options.local:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001326 cros_build_lib.Die('Cannot specify both --remote and --local')
Ryan Cui54da0702012-04-19 18:38:08 -07001327
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001328 if not options.buildbot and not patches:
Gaurav Shahed0399e2014-02-03 13:36:22 -08001329 prompt = ('No patches were provided; are you sure you want to just '
1330 'run a remote build of %s?' % (
1331 options.branch if options.branch else 'ToT'))
1332 if not cros_build_lib.BooleanPrompt(prompt=prompt, default=False):
Brian Harring7cc4b932012-11-01 16:58:55 -07001333 cros_build_lib.Die('Must provide patches when running with --remote.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001334
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001335 # --debug needs to be explicitly passed through for remote invocations.
1336 release_mode_with_patches = (options.buildbot and patches and
1337 '--debug' not in options.pass_through_args)
1338 else:
1339 if len(args) > 1:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001340 cros_build_lib.Die('Multiple configs not supported if not running with '
Brian Harringf1aad832012-07-18 10:46:39 -07001341 '--remote. Got %r', args)
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001342
Ryan Cui79319ab2012-05-21 12:59:18 -07001343 if options.slaves:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001344 cros_build_lib.Die('Cannot use --slaves if not running with --remote.')
Ryan Cui79319ab2012-05-21 12:59:18 -07001345
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001346 release_mode_with_patches = (options.buildbot and patches and
1347 not options.debug)
1348
David James5734ea32012-08-15 20:23:49 -07001349 # When running in release mode, make sure we are running with checked-in code.
1350 # We want checked-in cbuildbot/scripts to prevent errors, and we want to build
1351 # a release image with checked-in code for CrOS packages.
1352 if release_mode_with_patches:
1353 cros_build_lib.Die(
1354 'Cannot provide patches when running with --buildbot!')
1355
Ryan Cuiba41ad32012-03-08 17:15:29 -08001356 if options.buildbot and options.remote_trybot:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001357 cros_build_lib.Die(
1358 '--buildbot and --remote-trybot cannot be used together.')
Ryan Cuiba41ad32012-03-08 17:15:29 -08001359
Ryan Cui85867972012-02-23 18:21:49 -08001360 # Record whether --debug was set explicitly vs. it was inferred.
1361 options.debug_forced = False
1362 if options.debug:
1363 options.debug_forced = True
Ryan Cui88b901c2013-06-21 11:35:30 -07001364 if not options.debug:
Ryan Cui16ca5812012-03-08 20:34:27 -08001365 # We don't set debug by default for
1366 # 1. --buildbot invocations.
1367 # 2. --remote invocations, because it needs to push changes to the tryjob
1368 # repo.
1369 options.debug = not options.buildbot and not options.remote
Brian Harring3fec5a82012-03-01 05:57:03 -08001370
Ryan Cui1c13a252012-10-16 15:00:16 -07001371 # Record the configs targeted.
1372 options.build_targets = args[:]
1373
Ryan Cui88b901c2013-06-21 11:35:30 -07001374 if constants.BRANCH_UTIL_CONFIG in options.build_targets:
Ryan Cui7bd8db62013-08-08 16:29:51 -07001375 if options.remote:
1376 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001377 'Running %s as a remote tryjob is not yet supported.',
1378 constants.BRANCH_UTIL_CONFIG)
Ryan Cui88b901c2013-06-21 11:35:30 -07001379 if len(options.build_targets) > 1:
1380 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001381 'Cannot run %s with any other configs.',
1382 constants.BRANCH_UTIL_CONFIG)
Ryan Cui88b901c2013-06-21 11:35:30 -07001383 if not options.branch_name:
1384 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001385 'Must specify --branch-name with the %s config.',
1386 constants.BRANCH_UTIL_CONFIG)
1387 if options.branch and options.branch != options.branch_name:
Ryan Cui88b901c2013-06-21 11:35:30 -07001388 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001389 'If --branch is specified with the %s config, it must'
1390 ' have the same value as --branch-name.',
1391 constants.BRANCH_UTIL_CONFIG)
1392
1393 exclusive_opts = {'--version': options.force_version,
1394 '--delete-branch': options.delete_branch,
1395 '--rename-to': options.rename_to,
1396 }
1397 if 1 != sum(1 for x in exclusive_opts.values() if x):
1398 cros_build_lib.Die('When using the %s config, you must'
1399 ' specifiy one and only one of the following'
1400 ' options: %s.', constants.BRANCH_UTIL_CONFIG,
1401 ', '.join(exclusive_opts.keys()))
1402
1403 # When deleting or renaming a branch, the --branch and --nobootstrap
1404 # options are implied.
1405 if options.delete_branch or options.rename_to:
1406 if not options.branch:
1407 cros_build_lib.Info('Automatically enabling sync to branch %s'
1408 ' for this %s flow.', options.branch_name,
1409 constants.BRANCH_UTIL_CONFIG)
1410 options.branch = options.branch_name
1411 if options.bootstrap:
1412 cros_build_lib.Info('Automatically disabling bootstrap step for'
1413 ' this %s flow.', constants.BRANCH_UTIL_CONFIG)
1414 options.bootstrap = False
1415
Ryan Cui88b901c2013-06-21 11:35:30 -07001416 elif any([options.delete_branch, options.rename_to, options.branch_name]):
1417 cros_build_lib.Die(
1418 'Cannot specify --delete-branch, --rename-to or --branch-name when not '
1419 'running the %s config', constants.BRANCH_UTIL_CONFIG)
1420
Brian Harring3fec5a82012-03-01 05:57:03 -08001421
Brian Harring1d7ba942012-04-24 06:37:18 -07001422# pylint: disable=W0613
Brian Harringae0a5322012-09-15 01:46:51 -07001423def _PostParseCheck(parser, options, args):
Ryan Cui85867972012-02-23 18:21:49 -08001424 """Perform some usage validation after we've parsed the arguments
Brian Harring3fec5a82012-03-01 05:57:03 -08001425
Ryan Cui85867972012-02-23 18:21:49 -08001426 Args:
Aviv Keshet9e4236b2013-12-13 13:07:50 -08001427 parser: Option parser that was used to parse arguments.
1428 options: The options returned by optparse.
1429 args: The args returned by optparse.
Ryan Cui85867972012-02-23 18:21:49 -08001430 """
Ryan Cuie1e4e662012-05-21 16:39:46 -07001431 if not options.branch:
David James97d95872012-11-16 15:09:56 -08001432 options.branch = git.GetChromiteTrackingBranch()
Ryan Cuie1e4e662012-05-21 16:39:46 -07001433
Brian Harringae0a5322012-09-15 01:46:51 -07001434 if not repository.IsARepoRoot(options.sourceroot):
1435 if options.local_patches:
1436 raise Exception('Could not find repo checkout at %s!'
1437 % options.sourceroot)
1438
David Jamesac8c2a72013-02-13 18:44:33 -08001439 # Because the default cache dir depends on other options, FindCacheDir
1440 # always returns None, and we setup the default here.
Brian Harringae0a5322012-09-15 01:46:51 -07001441 if options.cache_dir is None:
1442 # Note, options.sourceroot is set regardless of the path
1443 # actually existing.
David Jamesac8c2a72013-02-13 18:44:33 -08001444 if options.buildroot is not None:
Brian Harringae0a5322012-09-15 01:46:51 -07001445 options.cache_dir = os.path.join(options.buildroot, '.cache')
David Jamesac8c2a72013-02-13 18:44:33 -08001446 elif os.path.exists(options.sourceroot):
1447 options.cache_dir = os.path.join(options.sourceroot, '.cache')
Brian Harringae0a5322012-09-15 01:46:51 -07001448 else:
1449 options.cache_dir = parser.FindCacheDir(parser, options)
1450 options.cache_dir = os.path.abspath(options.cache_dir)
Brian Harring8c1d7b12012-10-04 17:36:32 -07001451 parser.ConfigureCacheDir(options.cache_dir)
Brian Harringae0a5322012-09-15 01:46:51 -07001452
Yu-Ju Hong2c066762013-10-28 14:05:08 -07001453 osutils.SafeMakedirsNonRoot(options.cache_dir)
Ryan Cui5ba7e152012-05-10 14:36:52 -07001454
Brian Harring609dc4e2012-05-07 02:17:44 -07001455 if options.local_patches:
Brian Harring1d7ba942012-04-24 06:37:18 -07001456 options.local_patches = _CheckLocalPatches(
Brian Harring609dc4e2012-05-07 02:17:44 -07001457 options.sourceroot, options.local_patches)
Brian Harring1d7ba942012-04-24 06:37:18 -07001458
1459 default = os.environ.get('CBUILDBOT_DEFAULT_MODE')
1460 if (default and not any([options.local, options.buildbot,
1461 options.remote, options.remote_trybot])):
Brian Harring1b8c4c82012-05-29 23:03:04 -07001462 cros_build_lib.Info("CBUILDBOT_DEFAULT_MODE=%s env var detected, using it."
1463 % default)
Brian Harring1d7ba942012-04-24 06:37:18 -07001464 default = default.lower()
1465 if default == 'local':
1466 options.local = True
1467 elif default == 'remote':
1468 options.remote = True
1469 elif default == 'buildbot':
1470 options.buildbot = True
1471 else:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001472 cros_build_lib.Die("CBUILDBOT_DEFAULT_MODE value %s isn't supported. "
1473 % default)
Ryan Cui85867972012-02-23 18:21:49 -08001474
Matt Tennant763497d2014-01-17 16:45:54 -08001475 # Ensure that all args are legitimate config targets.
1476 invalid_target = False
1477 for arg in args:
Matt Tennant2c192032014-01-16 13:49:28 -08001478 build_config = _GetConfig(arg)
1479 if not build_config:
Matt Tennant763497d2014-01-17 16:45:54 -08001480 cros_build_lib.Error('No such configuraton target: "%s".', arg)
1481 invalid_target = True
1482
Matt Tennant2c192032014-01-16 13:49:28 -08001483 # The --version option is not compatible with an external target unless the
1484 # --buildbot option is specified. More correctly, only "paladin versions"
1485 # will work with external targets, and those are only used with --buildbot.
1486 # If --buildbot is specified, then user should know what they are doing and
1487 # only specify a version that will work. See crbug.com/311648.
1488 elif options.force_version and not options.buildbot:
1489 if not build_config.internal:
1490 cros_build_lib.Die('Cannot specify --version without --buildbot for an'
1491 ' external target (%s).' % arg)
1492
Matt Tennant763497d2014-01-17 16:45:54 -08001493 if invalid_target:
1494 print 'Please specify one of:'
1495 _PrintValidConfigs()
1496 cros_build_lib.Die('One or more invalid configuration targets specified.')
1497
Ryan Cui85867972012-02-23 18:21:49 -08001498
1499def _ParseCommandLine(parser, argv):
1500 """Completely parse the commandline arguments"""
Brian Harring3fec5a82012-03-01 05:57:03 -08001501 (options, args) = parser.parse_args(argv)
Brian Harring37e559b2012-05-22 20:47:32 -07001502
Matt Tennant763497d2014-01-17 16:45:54 -08001503 # Strip out null arguments.
1504 # TODO(rcui): Remove when buildbot is fixed
1505 args = [arg for arg in args if arg]
1506
1507 # A couple options, like --list, trigger a quick exit.
Brian Harring37e559b2012-05-22 20:47:32 -07001508 if options.output_api_version:
Ryan Cui724f1d32012-10-15 18:10:22 -07001509 print constants.REEXEC_API_VERSION
Brian Harring37e559b2012-05-22 20:47:32 -07001510 sys.exit(0)
1511
Ryan Cui54da0702012-04-19 18:38:08 -07001512 if options.list:
Matt Tennant763497d2014-01-17 16:45:54 -08001513 if args:
1514 cros_build_lib.Die('No arguments expected with the --list options.')
Ryan Cui54da0702012-04-19 18:38:08 -07001515 _PrintValidConfigs(options.print_all)
1516 sys.exit(0)
1517
Ryan Cui8be16062012-04-24 12:05:26 -07001518 if not args:
Matt Tennant763497d2014-01-17 16:45:54 -08001519 parser.error('Invalid usage: no configuration targets provided.'
1520 'Use -h to see usage. Use -l to list supported configs.')
Ryan Cui8be16062012-04-24 12:05:26 -07001521
Ryan Cui85867972012-02-23 18:21:49 -08001522 _FinishParsing(options, args)
1523 return options, args
1524
1525
Matt Tennant759e2352013-09-27 15:14:44 -07001526# TODO(build): This function is too damn long.
Ryan Cui85867972012-02-23 18:21:49 -08001527def main(argv):
David James59a0a2b2013-03-22 14:04:44 -07001528 # Turn on strict sudo checks.
1529 cros_build_lib.STRICT_SUDO = True
1530
Ryan Cui85867972012-02-23 18:21:49 -08001531 # Set umask to 022 so files created by buildbot are readable.
Mike Frysinger60ec1012013-10-21 00:11:10 -04001532 os.umask(0o22)
Ryan Cui85867972012-02-23 18:21:49 -08001533
Ryan Cui85867972012-02-23 18:21:49 -08001534 parser = _CreateParser()
1535 (options, args) = _ParseCommandLine(parser, argv)
Brian Harring3fec5a82012-03-01 05:57:03 -08001536
Brian Harringae0a5322012-09-15 01:46:51 -07001537 _PostParseCheck(parser, options, args)
Brian Harring3fec5a82012-03-01 05:57:03 -08001538
Mike Frysinger8fd67dc2012-12-03 23:51:18 -05001539 cros_build_lib.AssertOutsideChroot()
Zdenek Behan98ec2fb2012-08-31 17:12:18 +02001540
Brian Harring3fec5a82012-03-01 05:57:03 -08001541 if options.remote:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001542 cros_build_lib.logger.setLevel(logging.WARNING)
Ryan Cui16ca5812012-03-08 20:34:27 -08001543
Brian Harring3fec5a82012-03-01 05:57:03 -08001544 # Verify configs are valid.
Dan Shi0bdb7132013-07-30 16:22:12 -07001545 # If hwtest flag is enabled, post a warning that HWTest step may fail if the
1546 # specified board is not a released platform or it is a generic overlay.
Brian Harring3fec5a82012-03-01 05:57:03 -08001547 for bot in args:
Aviv Kesheta96a2a92013-02-05 17:21:51 -08001548 build_config = _GetConfig(bot)
1549 if options.hwtest:
Dan Shi0bdb7132013-07-30 16:22:12 -07001550 cros_build_lib.Warning(
1551 'If %s is not a released platform or it is a generic overlay, '
1552 'the HWTest step will most likely not run; please ask the lab '
1553 'team for help if this is unexpected.' % build_config['boards'])
Brian Harring3fec5a82012-03-01 05:57:03 -08001554
1555 # Verify gerrit patches are valid.
Ryan Cui16ca5812012-03-08 20:34:27 -08001556 print 'Verifying patches...'
Ryan Cuie1e4e662012-05-21 16:39:46 -07001557 patch_pool = AcquirePoolFromOptions(options)
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001558
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001559 # --debug need to be explicitly passed through for remote invocations.
1560 if options.buildbot and '--debug' not in options.pass_through_args:
1561 _ConfirmRemoteBuildbotRun()
1562
Ryan Cui16ca5812012-03-08 20:34:27 -08001563 print 'Submitting tryjob...'
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001564 tryjob = remote_try.RemoteTryJob(options, args, patch_pool.local_patches)
Ryan Cuia25d8eb2012-07-11 14:54:27 -07001565 tryjob.Submit(testjob=options.test_tryjob, dryrun=False)
Ryan Cui16ca5812012-03-08 20:34:27 -08001566 print 'Tryjob submitted!'
1567 print ('Go to %s to view the status of your job.'
Ryan Cui4906e1c2012-04-03 20:09:34 -07001568 % tryjob.GetTrybotWaterfallLink())
Brian Harring3fec5a82012-03-01 05:57:03 -08001569 sys.exit(0)
Matt Tennant759e2352013-09-27 15:14:44 -07001570
Ryan Cui54da0702012-04-19 18:38:08 -07001571 elif (not options.buildbot and not options.remote_trybot
1572 and not options.resume and not options.local):
Ryan Cui88b901c2013-06-21 11:35:30 -07001573 options.local = True
Brian Harring1b8c4c82012-05-29 23:03:04 -07001574 cros_build_lib.Warning(
1575 'Running in LOCAL TRYBOT mode! Use --remote to submit REMOTE '
1576 'tryjobs. Use --local to suppress this message.')
1577 cros_build_lib.Warning(
Ryan Cui51591352012-07-09 15:15:53 -07001578 'In the future, --local will be required to run the local '
Brian Harring1b8c4c82012-05-29 23:03:04 -07001579 'trybot.')
Ryan Cui54da0702012-04-19 18:38:08 -07001580 time.sleep(5)
Brian Harring3fec5a82012-03-01 05:57:03 -08001581
Matt Tennant759e2352013-09-27 15:14:44 -07001582 # Only one config arg is allowed in this mode, which was confirmed earlier.
Ryan Cui8be16062012-04-24 12:05:26 -07001583 bot_id = args[-1]
1584 build_config = _GetConfig(bot_id)
Brian Harring3fec5a82012-03-01 05:57:03 -08001585
David Jamesdac7a912013-11-18 11:14:44 -08001586 if options.reference_repo is None:
1587 repo_path = os.path.join(options.sourceroot, '.repo')
1588 # If we're being run from a repo checkout, reuse the repo's git pool to
1589 # cut down on sync time.
1590 if os.path.exists(repo_path):
1591 options.reference_repo = options.sourceroot
1592 elif options.reference_repo:
1593 if not os.path.exists(options.reference_repo):
1594 parser.error('Reference path %s does not exist'
1595 % (options.reference_repo,))
1596 elif not os.path.exists(os.path.join(options.reference_repo, '.repo')):
1597 parser.error('Reference path %s does not look to be the base of a '
1598 'repo checkout; no .repo exists in the root.'
1599 % (options.reference_repo,))
1600
Brian Harringf11bf682012-05-14 15:53:43 -07001601 if (options.buildbot or options.remote_trybot) and not options.resume:
Brian Harring470f6112012-03-02 11:47:10 -08001602 if not options.cgroups:
Ryan Cuid4a24212012-04-04 18:08:12 -07001603 parser.error('Options --buildbot/--remote-trybot and --nocgroups cannot '
1604 'be used together. Cgroup support is required for '
1605 'buildbot/remote-trybot mode.')
Mike Frysingera78a56e2012-11-20 06:02:30 -05001606 if not cgroups.Cgroup.IsSupported():
Ryan Cuid4a24212012-04-04 18:08:12 -07001607 parser.error('Option --buildbot/--remote-trybot was given, but this '
1608 'system does not support cgroups. Failing.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001609
David Jamesaad5cc72012-10-26 15:03:13 -07001610 missing = osutils.FindMissingBinaries(_BUILDBOT_REQUIRED_BINARIES)
Brian Harring351ce442012-03-09 16:38:14 -08001611 if missing:
Ryan Cuid4a24212012-04-04 18:08:12 -07001612 parser.error("Option --buildbot/--remote-trybot requires the following "
1613 "binaries which couldn't be found in $PATH: %s"
Brian Harring351ce442012-03-09 16:38:14 -08001614 % (', '.join(missing)))
1615
David Jamesdac7a912013-11-18 11:14:44 -08001616 if options.reference_repo:
1617 options.reference_repo = os.path.abspath(options.reference_repo)
1618
Brian Harring3fec5a82012-03-01 05:57:03 -08001619 if not options.buildroot:
1620 if options.buildbot:
Mike Frysinger6903c762012-12-04 01:57:16 -05001621 parser.error('Please specify a buildroot with the --buildbot option.')
Matt Tennantd55b1f42012-04-13 14:15:01 -07001622
Ryan Cui5ba7e152012-05-10 14:36:52 -07001623 options.buildroot = _DetermineDefaultBuildRoot(options.sourceroot,
1624 build_config['internal'])
Brian Harring470f6112012-03-02 11:47:10 -08001625 # We use a marker file in the buildroot to indicate the user has
1626 # consented to using this directory.
1627 if not os.path.exists(repository.GetTrybotMarkerPath(options.buildroot)):
1628 _ConfirmBuildRoot(options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -08001629
1630 # Sanity check of buildroot- specifically that it's not pointing into the
1631 # midst of an existing repo since git-repo doesn't support nesting.
Brian Harring3fec5a82012-03-01 05:57:03 -08001632 if (not repository.IsARepoRoot(options.buildroot) and
David James13a69c92013-05-09 10:37:42 -07001633 git.FindRepoDir(options.buildroot)):
Brian Harring3fec5a82012-03-01 05:57:03 -08001634 parser.error('Configured buildroot %s points into a repository checkout, '
1635 'rather than the root of it. This is not supported.'
1636 % options.buildroot)
1637
Chris Sosab5ea3b42012-10-25 15:25:20 -07001638 if not options.log_dir:
1639 options.log_dir = os.path.join(options.buildroot, _DEFAULT_LOG_DIR)
1640
Brian Harringd166aaf2012-05-14 18:31:53 -07001641 log_file = None
1642 if options.tee:
Chris Sosab5ea3b42012-10-25 15:25:20 -07001643 log_file = os.path.join(options.log_dir, _BUILDBOT_LOG_FILE)
1644 osutils.SafeMakedirs(options.log_dir)
Brian Harringd166aaf2012-05-14 18:31:53 -07001645 _BackupPreviousLog(log_file)
1646
Brian Harring1b8c4c82012-05-29 23:03:04 -07001647 with cros_build_lib.ContextManagerStack() as stack:
Aaron Gable881fccb2013-09-27 18:35:24 -07001648 # TODO(ferringb): update this once
1649 # https://chromium-review.googlesource.com/25359
David Jamescebc7272013-07-17 16:45:05 -07001650 # is landed- it's sensitive to the manifest-versions cache path.
1651 options.preserve_paths = set(['manifest-versions', '.cache',
1652 'manifest-versions-internal'])
1653 if log_file is not None:
1654 # We don't want the critical section to try to clean up the tee process,
1655 # so we run Tee (forked off) outside of it. This prevents a deadlock
1656 # because the Tee process only exits when its pipe is closed, and the
1657 # critical section accidentally holds on to that file handle.
1658 stack.Add(tee.Tee, log_file)
1659 options.preserve_paths.add(_DEFAULT_LOG_DIR)
1660
Brian Harringc2d09d92012-05-13 22:03:15 -07001661 critical_section = stack.Add(cleanup.EnforcedCleanupSection)
1662 stack.Add(sudo.SudoKeepAlive)
Brian Harringd166aaf2012-05-14 18:31:53 -07001663
Brian Harringc2d09d92012-05-13 22:03:15 -07001664 if not options.resume:
Brian Harring2bf55e12012-05-13 21:31:55 -07001665 # If we're in resume mode, use our parents tempdir rather than
1666 # nesting another layer.
David James4bc13702013-03-26 08:08:04 -07001667 stack.Add(osutils.TempDir, prefix='cbuildbot-tmp', set_global=True)
Brian Harringc2d09d92012-05-13 22:03:15 -07001668 logging.debug("Cbuildbot tempdir is %r.", os.environ.get('TMP'))
Brian Harringd166aaf2012-05-14 18:31:53 -07001669
Brian Harringc2d09d92012-05-13 22:03:15 -07001670 if options.cgroups:
1671 stack.Add(cgroups.SimpleContainChildren, 'cbuildbot')
Brian Harringa184efa2012-03-04 11:51:25 -08001672
Brian Harringc2d09d92012-05-13 22:03:15 -07001673 # Mark everything between EnforcedCleanupSection and here as having to
1674 # be rolled back via the contextmanager cleanup handlers. This
1675 # ensures that sudo bits cannot outlive cbuildbot, that anything
1676 # cgroups would kill gets killed, etc.
David Jamesfb3aac92013-10-16 13:26:52 -07001677 stack.Add(critical_section.ForkWatchdog)
Brian Harringd166aaf2012-05-14 18:31:53 -07001678
Brian Harringc2d09d92012-05-13 22:03:15 -07001679 if options.timeout > 0:
David James3432acd2013-11-27 10:02:18 -08001680 stack.Add(timeout_util.FatalTimeout, options.timeout)
Brian Harringa184efa2012-03-04 11:51:25 -08001681
Brian Harringc2d09d92012-05-13 22:03:15 -07001682 if not options.buildbot:
1683 build_config = cbuildbot_config.OverrideConfigForTrybot(
1684 build_config,
David Jamese8dcfc42013-03-21 19:49:49 -07001685 options)
Brian Harringc2d09d92012-05-13 22:03:15 -07001686
Mike Frysinger6903c762012-12-04 01:57:16 -05001687 if options.buildbot or options.remote_trybot:
1688 _DisableYamaHardLinkChecks()
1689
Aviv Kesheta0159be2013-12-12 13:56:28 -08001690 if options.mock_tree_status is not None:
1691 stack.Add(mock.patch.object, timeout_util, '_GetStatus',
1692 return_value=options.mock_tree_status)
1693
Aviv Keshetcf9c2722014-02-25 15:15:10 -08001694 if options.mock_slave_status is not None:
1695 with open(options.mock_slave_status, 'r') as f:
1696 mock_status = pickle.load(f)
1697 stack.Add(mock.patch.object, stages.MasterSlaveSyncCompletionStage,
1698 '_FetchSlaveStatuses', return_value=mock_status)
1699
Brian Harringc2d09d92012-05-13 22:03:15 -07001700 _RunBuildStagesWrapper(options, build_config)