blob: 025d6c72a488cd9e9c7ebb3463d919ffb6a7e691 [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
15import glob
Chris Sosa4f6ffaf2012-05-01 17:05:44 -070016import logging
Brian Harring3fec5a82012-03-01 05:57:03 -080017import optparse
18import os
David James5596d0e2014-03-14 06:40:41 -070019import multiprocessing
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
Aviv Keshet4e750022014-03-07 16:50:34 -080030from chromite.buildbot import manifest_version
Brian Harring3fec5a82012-03-01 05:57:03 -080031from chromite.buildbot import remote_try
32from chromite.buildbot import repository
33from chromite.buildbot import tee
Ryan Cui16d9e1f2012-05-11 10:50:18 -070034from chromite.buildbot import trybot_patch_pool
Brian Harring3fec5a82012-03-01 05:57:03 -080035
Brian Harringc92a7012012-02-29 10:11:34 -080036from chromite.lib import cgroups
Brian Harringa184efa2012-03-04 11:51:25 -080037from chromite.lib import cleanup
Brian Harringb6cf9142012-09-01 20:43:17 -070038from chromite.lib import commandline
Brian Harring1b8c4c82012-05-29 23:03:04 -070039from chromite.lib import cros_build_lib
David Jamesa0a664e2013-02-13 09:52:01 -080040from chromite.lib import gclient
Brian Harring511055e2012-10-10 02:58:59 -070041from chromite.lib import gerrit
David James97d95872012-11-16 15:09:56 -080042from chromite.lib import git
Brian Harringaf019fb2012-05-10 15:06:13 -070043from chromite.lib import osutils
Brian Harring511055e2012-10-10 02:58:59 -070044from chromite.lib import patch as cros_patch
David James6450a0a2012-12-04 07:59:53 -080045from chromite.lib import parallel
Brian Harring3fec5a82012-03-01 05:57:03 -080046from chromite.lib import sudo
David James3432acd2013-11-27 10:02:18 -080047from chromite.lib import timeout_util
Brian Harring3fec5a82012-03-01 05:57:03 -080048
Aviv Kesheta0159be2013-12-12 13:56:28 -080049import mock
50
Ryan Cuiadd49122012-03-21 22:19:58 -070051
Brian Harring3fec5a82012-03-01 05:57:03 -080052_DEFAULT_LOG_DIR = 'cbuildbot_logs'
53_BUILDBOT_LOG_FILE = 'cbuildbot.log'
54_DEFAULT_EXT_BUILDROOT = 'trybot'
55_DEFAULT_INT_BUILDROOT = 'trybot-internal'
Brian Harring351ce442012-03-09 16:38:14 -080056_BUILDBOT_REQUIRED_BINARIES = ('pbzip2',)
Ryan Cui1c13a252012-10-16 15:00:16 -070057_API_VERSION_ATTR = 'api_version'
Brian Harring3fec5a82012-03-01 05:57:03 -080058
59
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070060def _PrintValidConfigs(display_all=False):
Brian Harring3fec5a82012-03-01 05:57:03 -080061 """Print a list of valid buildbot configs.
62
Mike Frysinger02e1e072013-11-10 22:11:34 -050063 Args:
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070064 display_all: Print all configs. Otherwise, prints only configs with
65 trybot_list=True.
Brian Harring3fec5a82012-03-01 05:57:03 -080066 """
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070067 def _GetSortKey(config_name):
68 config_dict = cbuildbot_config.config[config_name]
69 return (not config_dict['trybot_list'], config_dict['description'],
70 config_name)
71
Brian Harring3fec5a82012-03-01 05:57:03 -080072 COLUMN_WIDTH = 45
Matt Tennant763497d2014-01-17 16:45:54 -080073 print
Brian Harring3fec5a82012-03-01 05:57:03 -080074 print 'config'.ljust(COLUMN_WIDTH), 'description'
75 print '------'.ljust(COLUMN_WIDTH), '-----------'
76 config_names = cbuildbot_config.config.keys()
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070077 config_names.sort(key=_GetSortKey)
Brian Harring3fec5a82012-03-01 05:57:03 -080078 for name in config_names:
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070079 if display_all or cbuildbot_config.config[name]['trybot_list']:
80 desc = cbuildbot_config.config[name].get('description')
81 desc = desc if desc else ''
Brian Harring3fec5a82012-03-01 05:57:03 -080082 print name.ljust(COLUMN_WIDTH), desc
83
Matt Tennant763497d2014-01-17 16:45:54 -080084 print
85
Brian Harring3fec5a82012-03-01 05:57:03 -080086
87def _GetConfig(config_name):
Matt Tennant763497d2014-01-17 16:45:54 -080088 """Gets the configuration for the build if it exists, None otherwise."""
89 if cbuildbot_config.config.has_key(config_name):
90 return cbuildbot_config.config[config_name]
Brian Harring3fec5a82012-03-01 05:57:03 -080091
92
Ryan Cuie1e4e662012-05-21 16:39:46 -070093def AcquirePoolFromOptions(options):
Ryan Cui16d9e1f2012-05-11 10:50:18 -070094 """Generate patch objects from passed in options.
Brian Harring3fec5a82012-03-01 05:57:03 -080095
96 Args:
Ryan Cui16d9e1f2012-05-11 10:50:18 -070097 options: The options object generated by optparse.
Brian Harring3fec5a82012-03-01 05:57:03 -080098
Ryan Cuif7f24692012-05-18 16:35:33 -070099 Returns:
100 trybot_patch_pool.TrybotPatchPool object.
101
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700102 Raises:
Brian Harring511055e2012-10-10 02:58:59 -0700103 gerrit.GerritException, cros_patch.PatchException
Brian Harring3fec5a82012-03-01 05:57:03 -0800104 """
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700105 gerrit_patches = []
106 local_patches = []
107 remote_patches = []
Brian Harring3fec5a82012-03-01 05:57:03 -0800108
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700109 if options.gerrit_patches:
Brian Harring511055e2012-10-10 02:58:59 -0700110 gerrit_patches = gerrit.GetGerritPatchInfo(
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700111 options.gerrit_patches)
112 for patch in gerrit_patches:
113 if patch.IsAlreadyMerged():
Brian Harring1b8c4c82012-05-29 23:03:04 -0700114 cros_build_lib.Warning('Patch %s has already been merged.' % str(patch))
Brian Harring3fec5a82012-03-01 05:57:03 -0800115
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700116 if options.local_patches:
David James97d95872012-11-16 15:09:56 -0800117 manifest = git.ManifestCheckout.Cached(options.sourceroot)
Brian Harring609dc4e2012-05-07 02:17:44 -0700118 local_patches = cros_patch.PrepareLocalPatches(manifest,
119 options.local_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800120
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700121 if options.remote_patches:
122 remote_patches = cros_patch.PrepareRemotePatches(
123 options.remote_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800124
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700125 return trybot_patch_pool.TrybotPatchPool(gerrit_patches, local_patches,
126 remote_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800127
128
Brian Harring3fec5a82012-03-01 05:57:03 -0800129class Builder(object):
130 """Parent class for all builder types.
131
Matt Tennant759e2352013-09-27 15:14:44 -0700132 This class functions as an abstract parent class for various build types.
133 Its intended use is builder_instance.Run().
Brian Harring3fec5a82012-03-01 05:57:03 -0800134
Matt Tennant3f351552014-01-03 14:28:00 -0800135 Attributes:
136 _run: The BuilderRun object for this run.
137 archive_stages: Dict of BuildConfig keys to ArchiveStage values.
138 patch_pool: TrybotPatchPool.
Brian Harring3fec5a82012-03-01 05:57:03 -0800139 """
140
Matt Tennantefb59522013-10-18 13:49:28 -0700141 def __init__(self, builder_run):
Brian Harring3fec5a82012-03-01 05:57:03 -0800142 """Initializes instance variables. Must be called by all subclasses."""
Matt Tennantefb59522013-10-18 13:49:28 -0700143 self._run = builder_run
Brian Harring3fec5a82012-03-01 05:57:03 -0800144
Matt Tennantefb59522013-10-18 13:49:28 -0700145 if self._run.config.chromeos_official:
Brian Harring3fec5a82012-03-01 05:57:03 -0800146 os.environ['CHROMEOS_OFFICIAL'] = '1'
147
David James58e0c092012-03-04 20:31:12 -0800148 self.archive_stages = {}
Brian Harring76d1bf62012-06-01 13:52:48 -0700149 self.patch_pool = trybot_patch_pool.TrybotPatchPool()
David James5596d0e2014-03-14 06:40:41 -0700150 self._build_image_lock = multiprocessing.Lock()
Brian Harring3fec5a82012-03-01 05:57:03 -0800151
152 def Initialize(self):
153 """Runs through the initialization steps of an actual build."""
Matt Tennantefb59522013-10-18 13:49:28 -0700154 if self._run.options.resume:
155 results_lib.LoadCheckpoint(self._run.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800156
Brian Harring3fec5a82012-03-01 05:57:03 -0800157 self._RunStage(stages.CleanUpStage)
158
159 def _GetStageInstance(self, stage, *args, **kwargs):
Matt Tennant759e2352013-09-27 15:14:44 -0700160 """Helper function to get a stage instance given the args.
Brian Harring3fec5a82012-03-01 05:57:03 -0800161
Matt Tennantefb59522013-10-18 13:49:28 -0700162 Useful as almost all stages just take in builder_run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800163 """
Matt Tennantefb59522013-10-18 13:49:28 -0700164 # Normally the default BuilderRun (self._run) is used, but it can
165 # be overridden with "builder_run" kwargs (e.g. for child configs).
166 builder_run = kwargs.pop('builder_run', self._run)
167 return stage(builder_run, *args, **kwargs)
Brian Harring3fec5a82012-03-01 05:57:03 -0800168
169 def _SetReleaseTag(self):
Matt Tennant9c1c8492014-02-27 13:09:07 -0800170 """Sets run.attrs.release_tag from the manifest manager used in sync.
Brian Harring3fec5a82012-03-01 05:57:03 -0800171
Matt Tennantf4980ee2014-01-29 09:21:27 -0800172 Must be run after sync stage as syncing enables us to have a release tag,
173 and must be run before any usage of attrs.release_tag.
Matt Tennantefb59522013-10-18 13:49:28 -0700174
175 TODO(mtennant): Find a bottleneck place in syncing that can set this
Matt Tennantf4980ee2014-01-29 09:21:27 -0800176 directly. Be careful, as there are several kinds of syncing stages, and
177 sync stages have been known to abort with sys.exit calls.
Brian Harring3fec5a82012-03-01 05:57:03 -0800178 """
Matt Tennantefb59522013-10-18 13:49:28 -0700179 manifest_manager = getattr(self._run.attrs, 'manifest_manager', None)
Brian Harring3fec5a82012-03-01 05:57:03 -0800180 if manifest_manager:
Matt Tennantefb59522013-10-18 13:49:28 -0700181 self._run.attrs.release_tag = manifest_manager.current_version
Matt Tennant3f351552014-01-03 14:28:00 -0800182 else:
183 self._run.attrs.release_tag = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800184
Matt Tennanta42a5742014-02-09 13:42:12 -0800185 cros_build_lib.Debug('Saved release_tag value for run: %r',
186 self._run.attrs.release_tag)
187
Brian Harring3fec5a82012-03-01 05:57:03 -0800188 def _RunStage(self, stage, *args, **kwargs):
Matt Tennant759e2352013-09-27 15:14:44 -0700189 """Wrapper to run a stage.
190
191 Args:
192 stage: A BuilderStage class.
193 args: args to pass to stage constructor.
194 kwargs: kwargs to pass to stage constructor.
Mike Frysinger1a736a82013-12-12 01:50:59 -0500195
Matt Tennant759e2352013-09-27 15:14:44 -0700196 Returns:
Matt Tennant759e2352013-09-27 15:14:44 -0700197 Whatever the stage's Run method returns.
198 """
Brian Harring3fec5a82012-03-01 05:57:03 -0800199 stage_instance = self._GetStageInstance(stage, *args, **kwargs)
200 return stage_instance.Run()
201
David Jamese1c8ab62014-03-27 12:30:58 -0700202 @staticmethod
203 def _RunParallelStages(stage_objs):
204 """Run the specified stages in parallel.
205
206 Args:
207 stage_objs: BuilderStage objects.
208 """
209 steps = [stage.Run for stage in stage_objs]
210 try:
211 parallel.RunParallelSteps(steps)
212
213 except BaseException as ex:
214 # If a stage threw an exception, it might not have correctly reported
215 # results (e.g. because it was killed before it could report the
216 # results.) In this case, attribute the exception to any stages that
217 # didn't report back correctly (if any).
218 for stage in stage_objs:
219 for name in stage.GetStageNames():
220 if not results_lib.Results.StageHasResults(name):
221 results_lib.Results.Record(name, ex, str(ex))
222
223 raise
224
Matt Tennantf4980ee2014-01-29 09:21:27 -0800225 def _RunSyncStage(self, sync_instance):
226 """Run given |sync_instance| stage and be sure attrs.release_tag set."""
227 try:
228 sync_instance.Run()
229 finally:
230 self._SetReleaseTag()
231
Brian Harring3fec5a82012-03-01 05:57:03 -0800232 def GetSyncInstance(self):
233 """Returns an instance of a SyncStage that should be run.
234
235 Subclasses must override this method.
236 """
237 raise NotImplementedError()
238
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400239 def GetCompletionInstance(self):
Aviv Keshetf2746152013-11-26 10:42:46 -0800240 """Returns the MasterSlaveSyncCompletionStage for this build.
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400241
242 Subclasses may override this method.
243
Mike Frysinger02e1e072013-11-10 22:11:34 -0500244 Returns:
245 None
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400246 """
247 return None
248
Brian Harring3fec5a82012-03-01 05:57:03 -0800249 def RunStages(self):
250 """Subclasses must override this method. Runs the appropriate code."""
251 raise NotImplementedError()
252
Brian Harring3fec5a82012-03-01 05:57:03 -0800253 def _ReExecuteInBuildroot(self, sync_instance):
254 """Reexecutes self in buildroot and returns True if build succeeds.
255
256 This allows the buildbot code to test itself when changes are patched for
257 buildbot-related code. This is a no-op if the buildroot == buildroot
258 of the running chromite checkout.
259
260 Args:
Matt Tennant85348852014-01-10 15:16:02 -0800261 sync_instance: Instance of the sync stage that was run to sync.
Brian Harring3fec5a82012-03-01 05:57:03 -0800262
263 Returns:
264 True if the Build succeeded.
265 """
Matt Tennantefb59522013-10-18 13:49:28 -0700266 if not self._run.options.resume:
267 results_lib.WriteCheckpoint(self._run.options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800268
Ryan Cui1c13a252012-10-16 15:00:16 -0700269 args = stages.BootstrapStage.FilterArgsForTargetCbuildbot(
Matt Tennantefb59522013-10-18 13:49:28 -0700270 self._run.options.buildroot, constants.PATH_TO_CBUILDBOT,
271 self._run.options)
Brian Harring37e559b2012-05-22 20:47:32 -0700272
David James2333c182013-02-13 16:16:15 -0800273 # Specify a buildroot explicitly (just in case, for local trybot).
Brian Harring3fec5a82012-03-01 05:57:03 -0800274 # Suppress any timeout options given from the commandline in the
275 # invoked cbuildbot; our timeout will enforce it instead.
Ryan Cui1c13a252012-10-16 15:00:16 -0700276 args += ['--resume', '--timeout', '0', '--notee', '--nocgroups',
Matt Tennantefb59522013-10-18 13:49:28 -0700277 '--buildroot', os.path.abspath(self._run.options.buildroot)]
Brian Harringae0a5322012-09-15 01:46:51 -0700278
Matt Tennantefb59522013-10-18 13:49:28 -0700279 if hasattr(self._run.attrs, 'manifest_manager'):
280 # TODO(mtennant): Is this the same as self._run.attrs.release_tag?
281 ver = self._run.attrs.manifest_manager.current_version
Ryan Cui1c13a252012-10-16 15:00:16 -0700282 args += ['--version', ver]
Brian Harring3fec5a82012-03-01 05:57:03 -0800283
David Jamesf421c6d2013-04-11 15:37:57 -0700284 pool = getattr(sync_instance, 'pool', None)
285 if pool:
Matt Tennantefb59522013-10-18 13:49:28 -0700286 filename = os.path.join(self._run.options.buildroot,
287 'validation_pool.dump')
David Jamesf421c6d2013-04-11 15:37:57 -0700288 pool.Save(filename)
289 args += ['--validation_pool', filename]
Brian Harring3fec5a82012-03-01 05:57:03 -0800290
David Jamesac8c2a72013-02-13 18:44:33 -0800291 # Reset the cache dir so that the child will calculate it automatically.
Matt Tennantefb59522013-10-18 13:49:28 -0700292 if not self._run.options.cache_dir_specified:
David Jamesac8c2a72013-02-13 18:44:33 -0800293 commandline.BaseParser.ConfigureCacheDir(None)
294
Brian Harring3fec5a82012-03-01 05:57:03 -0800295 # Re-run the command in the buildroot.
296 # Finally, be generous and give the invoked cbuildbot 30s to shutdown
297 # when something occurs. It should exit quicker, but the sigterm may
298 # hit while the system is particularly busy.
Brian Harring1b8c4c82012-05-29 23:03:04 -0700299 return_obj = cros_build_lib.RunCommand(
Matt Tennantefb59522013-10-18 13:49:28 -0700300 args, cwd=self._run.options.buildroot, error_code_ok=True,
301 kill_timeout=30)
Brian Harring3fec5a82012-03-01 05:57:03 -0800302 return return_obj.returncode == 0
303
Ryan Cuif7f24692012-05-18 16:35:33 -0700304 def _InitializeTrybotPatchPool(self):
305 """Generate patch pool from patches specified on the command line.
306
307 Do this only if we need to patch changes later on.
308 """
309 changes_stage = stages.PatchChangesStage.StageNamePrefix()
310 check_func = results_lib.Results.PreviouslyCompletedRecord
Matt Tennantefb59522013-10-18 13:49:28 -0700311 if not check_func(changes_stage) or self._run.options.bootstrap:
312 self.patch_pool = AcquirePoolFromOptions(self._run.options)
Ryan Cuif7f24692012-05-18 16:35:33 -0700313
314 def _GetBootstrapStage(self):
315 """Constructs and returns the BootStrapStage object.
316
317 We return None when there are no chromite patches to test, and
318 --test-bootstrap wasn't passed in.
319 """
320 stage = None
321 chromite_pool = self.patch_pool.Filter(project=constants.CHROMITE_PROJECT)
Ryan Cui5616a512012-08-17 13:39:36 -0700322 manifest_pool = self.patch_pool.FilterManifest()
David James97d95872012-11-16 15:09:56 -0800323 chromite_branch = git.GetChromiteTrackingBranch()
Matt Tennantefb59522013-10-18 13:49:28 -0700324 if (chromite_pool or manifest_pool or
325 self._run.options.test_bootstrap or
326 chromite_branch != self._run.options.branch):
327 stage = stages.BootstrapStage(self._run, chromite_pool,
328 manifest_pool)
Ryan Cuif7f24692012-05-18 16:35:33 -0700329 return stage
330
Brian Harring3fec5a82012-03-01 05:57:03 -0800331 def Run(self):
Ryan Cuif7f24692012-05-18 16:35:33 -0700332 """Main runner for this builder class. Runs build and prints summary.
333
334 Returns:
335 Whether the build succeeded.
336 """
337 self._InitializeTrybotPatchPool()
338
Matt Tennantefb59522013-10-18 13:49:28 -0700339 if self._run.options.bootstrap:
Ryan Cuif7f24692012-05-18 16:35:33 -0700340 bootstrap_stage = self._GetBootstrapStage()
341 if bootstrap_stage:
342 # BootstrapStage blocks on re-execution of cbuildbot.
343 bootstrap_stage.Run()
344 return bootstrap_stage.returncode == 0
345
Brian Harring3fec5a82012-03-01 05:57:03 -0800346 print_report = True
David James3d4d3502012-04-09 15:12:06 -0700347 exception_thrown = False
Brian Harring3fec5a82012-03-01 05:57:03 -0800348 success = True
David James9ebb2a42013-08-13 20:29:57 -0700349 sync_instance = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800350 try:
351 self.Initialize()
352 sync_instance = self.GetSyncInstance()
Matt Tennantf4980ee2014-01-29 09:21:27 -0800353 self._RunSyncStage(sync_instance)
Brian Harring3fec5a82012-03-01 05:57:03 -0800354
Matt Tennantefb59522013-10-18 13:49:28 -0700355 if self._run.ShouldPatchAfterSync():
Ryan Cui88b901c2013-06-21 11:35:30 -0700356 # Filter out patches to manifest, since PatchChangesStage can't handle
357 # them. Manifest patches are patched in the BootstrapStage.
358 non_manifest_patches = self.patch_pool.FilterManifest(negate=True)
359 if non_manifest_patches:
360 self._RunStage(stages.PatchChangesStage, non_manifest_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800361
Matt Tennantefb59522013-10-18 13:49:28 -0700362 if self._run.ShouldReexecAfterSync():
Brian Harring3fec5a82012-03-01 05:57:03 -0800363 print_report = False
364 success = self._ReExecuteInBuildroot(sync_instance)
365 else:
Aviv Keshet304601d2014-04-17 14:31:43 -0700366 self._RunStage(stages.ReportBuildStartStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800367 self.RunStages()
Matt Tennant759e2352013-09-27 15:14:44 -0700368
David James3541a132013-03-18 13:21:58 -0700369 except Exception as ex:
370 # If the build is marked as successful, but threw exceptions, that's a
371 # problem.
David James7fbf2d42012-07-14 18:23:49 -0700372 exception_thrown = True
David James3541a132013-03-18 13:21:58 -0700373 if results_lib.Results.BuildSucceededSoFar():
374 traceback.print_exc(file=sys.stdout)
David James7fbf2d42012-07-14 18:23:49 -0700375 raise
Matt Tennant759e2352013-09-27 15:14:44 -0700376
David James3541a132013-03-18 13:21:58 -0700377 if not (print_report and isinstance(ex, results_lib.StepFailure)):
378 raise
Matt Tennant759e2352013-09-27 15:14:44 -0700379
Brian Harring3fec5a82012-03-01 05:57:03 -0800380 finally:
381 if print_report:
Matt Tennantefb59522013-10-18 13:49:28 -0700382 results_lib.WriteCheckpoint(self._run.options.buildroot)
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400383 completion_instance = self.GetCompletionInstance()
Matt Tennant066d9322014-01-28 10:37:48 -0800384 self._RunStage(stages.ReportStage, sync_instance, completion_instance)
Brian Harring3fec5a82012-03-01 05:57:03 -0800385 success = results_lib.Results.BuildSucceededSoFar()
David James3d4d3502012-04-09 15:12:06 -0700386 if exception_thrown and success:
387 success = False
David Jamesbb20ac82012-07-18 10:59:16 -0700388 cros_build_lib.PrintBuildbotStepWarnings()
389 print """\
David James3d4d3502012-04-09 15:12:06 -0700390Exception thrown, but all stages marked successful. This is an internal error,
391because the stage that threw the exception should be marked as failing."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800392
393 return success
394
395
David James1fddb8f2013-04-25 15:23:07 -0700396BoardConfig = collections.namedtuple('BoardConfig', ['board', 'name'])
397
398
Brian Harring3fec5a82012-03-01 05:57:03 -0800399class SimpleBuilder(Builder):
400 """Builder that performs basic vetting operations."""
401
402 def GetSyncInstance(self):
403 """Sync to lkgm or TOT as necessary.
404
Mike Frysinger02e1e072013-11-10 22:11:34 -0500405 Returns:
406 The instance of the sync stage to run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800407 """
Matt Tennantefb59522013-10-18 13:49:28 -0700408 if self._run.options.force_version:
Ryan Cui88b901c2013-06-21 11:35:30 -0700409 sync_stage = self._GetStageInstance(stages.ManifestVersionedSyncStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700410 elif self._run.config.use_lkgm:
Brian Harring3fec5a82012-03-01 05:57:03 -0800411 sync_stage = self._GetStageInstance(stages.LKGMSyncStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700412 elif self._run.config.use_chrome_lkgm:
Chris Sosa52a81b62012-11-14 06:12:54 -0800413 sync_stage = self._GetStageInstance(stages.ChromeLKGMSyncStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800414 else:
415 sync_stage = self._GetStageInstance(stages.SyncStage)
416
417 return sync_stage
418
David Jamese1c8ab62014-03-27 12:30:58 -0700419 def _RunHWTests(self, builder_run, board):
420 """Run hwtest-related stages for the specified board.
Matt Tennant759e2352013-09-27 15:14:44 -0700421
422 Args:
David Jamese1c8ab62014-03-27 12:30:58 -0700423 builder_run: BuilderRun object for these background stages.
424 board: Board name.
Matt Tennant759e2352013-09-27 15:14:44 -0700425 """
David Jamese1c8ab62014-03-27 12:30:58 -0700426 # Upload HWTest artifacts first.
427 self._RunStage(stages.UploadTestArtifactsStage, board,
428 builder_run=builder_run)
Matt Tennant0940c382014-01-21 20:43:55 -0800429
David Jamese1c8ab62014-03-27 12:30:58 -0700430 # We can not run hw tests without archiving the payloads.
431 stage_list = []
432 config = builder_run.config
433 if builder_run.options.archive:
434 for suite_config in config.hw_tests:
435 if suite_config.async:
436 stage_list.append([stages.ASyncHWTestStage, board, suite_config])
437 elif suite_config.suite == constants.HWTEST_AU_SUITE:
438 stage_list.append([stages.AUTestStage, board, suite_config])
439 elif suite_config.suite == constants.HWTEST_QAV_SUITE:
440 stage_list.append([stages.QATestStage, board, suite_config])
441 else:
442 stage_list.append([stages.HWTestStage, board, suite_config])
Matt Tennant759e2352013-09-27 15:14:44 -0700443
David Jamese1c8ab62014-03-27 12:30:58 -0700444 stage_objs = [self._GetStageInstance(*x, builder_run=builder_run)
445 for x in stage_list]
446 self._RunParallelStages(stage_objs)
David James4f2d8302013-03-19 06:35:58 -0700447
David James5596d0e2014-03-14 06:40:41 -0700448 def _RunBackgroundStagesForBoard(self, builder_run, board):
Matt Tennant759e2352013-09-27 15:14:44 -0700449 """Run background board-specific stages for the specified board.
450
451 Args:
Matt Tennantefb59522013-10-18 13:49:28 -0700452 builder_run: BuilderRun object for these background stages.
Matt Tennant759e2352013-09-27 15:14:44 -0700453 board: Board name.
Matt Tennant759e2352013-09-27 15:14:44 -0700454 """
Matt Tennantefb59522013-10-18 13:49:28 -0700455 config = builder_run.config
Matt Tennant066d9322014-01-28 10:37:48 -0800456
457 # TODO(mtennant): This is the last usage of self.archive_stages. We can
458 # kill it once we migrate its uses to BuilderRun so that none of the
459 # stages below need it as an argument.
Matt Tennantefb59522013-10-18 13:49:28 -0700460 archive_stage = self.archive_stages[BoardConfig(board, config.name)]
461 if config.pgo_generate:
Ahmad Sharifa2db40a2013-07-22 13:51:52 -0400462 self._RunParallelStages([archive_stage])
David James1fddb8f2013-04-25 15:23:07 -0700463 return
Matt Tennant759e2352013-09-27 15:14:44 -0700464
David James5596d0e2014-03-14 06:40:41 -0700465 # signer_results can't complete without push_image.
466 assert not config.signer_results or config.push_image
467
468 # paygen can't complete without signer_results.
469 assert not config.paygen or config.signer_results
470
471 if config.build_packages_in_background:
David James8281b6e2014-03-27 11:46:56 -0700472 self._RunStage(stages.BuildPackagesStage, board, builder_run=builder_run)
David James5596d0e2014-03-14 06:40:41 -0700473
474 if builder_run.config.compilecheck or builder_run.options.compilecheck:
Matt Tennantefb59522013-10-18 13:49:28 -0700475 self._RunStage(stages.UnitTestStage, board,
476 builder_run=builder_run)
David James565bc9a2013-04-08 14:54:45 -0700477 return
Matt Tennant759e2352013-09-27 15:14:44 -0700478
David James5596d0e2014-03-14 06:40:41 -0700479 # Build the image first before doing anything else.
480 # TODO(davidjames): Remove this lock once http://crbug.com/352994 is fixed.
481 with self._build_image_lock:
David James8281b6e2014-03-27 11:46:56 -0700482 self._RunStage(stages.BuildImageStage, board, builder_run=builder_run,
483 pgo_use=config.pgo_use)
Don Garrett82c0ae82014-02-03 18:25:11 -0800484
Mike Frysinger31ac04f2013-11-10 21:07:48 -0500485 # While this stage list is run in parallel, the order here dictates the
486 # order that things will be shown in the log. So group things together
487 # that make sense when read in order. Also keep in mind that, since we
488 # gather output manually, early slow stages will prevent any output from
489 # later stages showing up until it finishes.
Ryan Cui3ea98e02013-08-07 16:01:48 -0700490 stage_list = []
Matt Tennantefb59522013-10-18 13:49:28 -0700491 if builder_run.options.chrome_sdk and config.chrome_sdk:
David James8281b6e2014-03-27 11:46:56 -0700492 stage_list.append([stages.ChromeSDKStage, board])
David James6b704242013-10-18 14:51:37 -0700493 stage_list += [
Matt Tennant06460b72014-02-10 18:00:13 -0800494 [stages.RetryStage, 1, stages.VMTestStage, board],
David James6b704242013-10-18 14:51:37 -0700495 [stages.SignerTestStage, board, archive_stage],
Don Garrett7604d6a2014-01-15 14:45:39 -0800496 [stages.SignerResultsStage, board, archive_stage],
Don Garrett82c0ae82014-02-03 18:25:11 -0800497 [stages.PaygenStage, board, archive_stage],
David James6b704242013-10-18 14:51:37 -0700498 [stages.UnitTestStage, board],
David James8281b6e2014-03-27 11:46:56 -0700499 [stages.UploadPrebuiltsStage, board],
500 [stages.DevInstallerPrebuiltsStage, board],
Matt Tennant06460b72014-02-10 18:00:13 -0800501 [stages.DebugSymbolsStage, board],
Aviv Keshete2d40ef2014-03-17 16:04:11 -0700502 [stages.CPEExportStage, board],
David James6b704242013-10-18 14:51:37 -0700503 ]
Brian Harring3fec5a82012-03-01 05:57:03 -0800504
Matt Tennantefb59522013-10-18 13:49:28 -0700505 stage_objs = [self._GetStageInstance(*x, builder_run=builder_run)
506 for x in stage_list]
David Jamese1c8ab62014-03-27 12:30:58 -0700507
508 parallel.RunParallelSteps([
509 lambda: self._RunParallelStages(stage_objs + [archive_stage]),
510 lambda: self._RunHWTests(builder_run, board),
511 ])
Brian Harring3fec5a82012-03-01 05:57:03 -0800512
David James3b4bacf2014-02-19 17:25:15 -0800513 def _RunSetupBoard(self):
514 """Run the SetupBoard stage for all child configs and boards."""
515 for builder_run in self._run.GetUngroupedBuilderRuns():
516 for board in builder_run.config.boards:
517 self._RunStage(stages.SetupBoardStage, board, builder_run=builder_run)
518
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400519 def _RunChrootBuilderTypeBuild(self):
520 """Runs through stages of a CHROOT_BUILDER_TYPE build."""
521 self._RunStage(stages.UprevStage, boards=[], enter_chroot=False)
522 self._RunStage(stages.InitSDKStage)
David James3b4bacf2014-02-19 17:25:15 -0800523 self._RunStage(stages.SetupBoardStage, constants.CHROOT_BUILDER_BOARD)
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400524 self._RunStage(stages.SyncChromeStage)
525 self._RunStage(stages.PatchChromeStage)
526 self._RunStage(stages.SDKPackageStage)
527 self._RunStage(stages.SDKTestStage)
Yu-Ju Hongab843362014-04-03 16:23:50 -0700528 self._RunStage(stages.UploadPrebuiltsStage, constants.CHROOT_BUILDER_BOARD)
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400529
530 def _RunRefreshPackagesTypeBuild(self):
531 """Runs through the stages of a REFRESH_PACKAGES_TYPE build."""
532 self._RunStage(stages.InitSDKStage)
David James3b4bacf2014-02-19 17:25:15 -0800533 self._RunSetupBoard()
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400534 self._RunStage(stages.RefreshPackageStatusStage)
535
Matt Tennante8179042013-10-01 15:47:32 -0700536 def _RunMasterPaladinBuild(self):
537 """Runs through the stages of the paladin (commit queue) master build."""
538 self._RunStage(stages.InitSDKStage)
539 self._RunStage(stages.UprevStage)
Matt Tennant9c1c8492014-02-27 13:09:07 -0800540 # The CQ (paladin) master will not actually run the SyncChrome stage, but
541 # we want the logic that gets triggered when SyncChrome stage is skipped.
542 self._RunStage(stages.SyncChromeStage)
Matt Tennante8179042013-10-01 15:47:32 -0700543 self._RunStage(stages.MasterUploadPrebuiltsStage)
544
Don Garrett4bb21682014-03-03 16:16:23 -0800545 def _RunPayloadsBuild(self):
546 """Run the PaygenStage once for each board."""
547 def _RunStageWrapper(board):
548 self._RunStage(stages.PaygenStage, board=board,
549 channels=self._run.options.channels, archive_stage=None)
550
551 with parallel.BackgroundTaskRunner(_RunStageWrapper) as queue:
552 for board in self._run.config.boards:
553 queue.put([board])
554
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400555 def _RunDefaultTypeBuild(self):
556 """Runs through the stages of a non-special-type build."""
557 self._RunStage(stages.InitSDKStage)
558 self._RunStage(stages.UprevStage)
David James3b4bacf2014-02-19 17:25:15 -0800559 self._RunSetupBoard()
Matt Tennant85348852014-01-10 15:16:02 -0800560 self._RunStage(stages.SyncChromeStage)
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400561 self._RunStage(stages.PatchChromeStage)
562
Matt Tennantefb59522013-10-18 13:49:28 -0700563 # Prepare stages to run in background. If child_configs exist then
564 # run each of those here, otherwise use default config.
Matt Tennant950c6cb2014-01-10 16:45:03 -0800565 builder_runs = self._run.GetUngroupedBuilderRuns()
Matt Tennantefb59522013-10-18 13:49:28 -0700566
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400567 tasks = []
Matt Tennantefb59522013-10-18 13:49:28 -0700568 for builder_run in builder_runs:
Matt Tennanta42a5742014-02-09 13:42:12 -0800569 # Prepare a local archive directory for each "run".
570 builder_run.GetArchive().SetupArchivePath()
571
Matt Tennantefb59522013-10-18 13:49:28 -0700572 for board in builder_run.config.boards:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400573 archive_stage = self._GetStageInstance(
Matt Tennantefb59522013-10-18 13:49:28 -0700574 stages.ArchiveStage, board, builder_run=builder_run,
Matt Tennant85348852014-01-10 15:16:02 -0800575 chrome_version=self._run.attrs.chrome_version)
Matt Tennantefb59522013-10-18 13:49:28 -0700576 board_config = BoardConfig(board, builder_run.config.name)
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400577 self.archive_stages[board_config] = archive_stage
David James8281b6e2014-03-27 11:46:56 -0700578 tasks.append((builder_run, board))
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400579
580 # Set up a process pool to run test/archive stages in the background.
David Jamesed8349b2014-03-01 11:27:04 -0800581 # This process runs task(board) for each board added to the queue.
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400582 task_runner = self._RunBackgroundStagesForBoard
583 with parallel.BackgroundTaskRunner(task_runner) as queue:
David James8281b6e2014-03-27 11:46:56 -0700584 for builder_run, board in tasks:
David James5596d0e2014-03-14 06:40:41 -0700585 if not builder_run.config.build_packages_in_background:
586 # Run BuildPackages in the foreground, generating or using PGO data
587 # if requested.
David James8281b6e2014-03-27 11:46:56 -0700588 kwargs = {'builder_run': builder_run}
David Jamesed8349b2014-03-01 11:27:04 -0800589 if builder_run.config.pgo_generate:
590 kwargs['pgo_generate'] = True
591 elif builder_run.config.pgo_use:
592 kwargs['pgo_use'] = True
593
594 self._RunStage(stages.BuildPackagesStage, board, **kwargs)
David Jamesed8349b2014-03-01 11:27:04 -0800595
596 if builder_run.config.pgo_generate:
David James5596d0e2014-03-14 06:40:41 -0700597 # Generate the PGO data before allowing any other tasks to run.
598 self._RunStage(stages.BuildImageStage, board, **kwargs)
David Jamese1c8ab62014-03-27 12:30:58 -0700599 self._RunStage(stages.UploadTestArtifactsStage, board,
600 builder_run=builder_run, suffix='[pgo_generate]')
David Jamesed8349b2014-03-01 11:27:04 -0800601 suite = cbuildbot_config.PGORecordTest()
David James8281b6e2014-03-27 11:46:56 -0700602 self._RunStage(stages.HWTestStage, board, suite,
David Jamesed8349b2014-03-01 11:27:04 -0800603 builder_run=builder_run)
604
605 # Kick off our background stages.
David James5596d0e2014-03-14 06:40:41 -0700606 queue.put([builder_run, board])
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400607
Brian Harring3fec5a82012-03-01 05:57:03 -0800608 def RunStages(self):
609 """Runs through build process."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800610 # TODO(sosa): Split these out into classes.
Matt Tennantefb59522013-10-18 13:49:28 -0700611 if self._run.config.build_type == constants.PRE_CQ_LAUNCHER_TYPE:
David James816a5942013-04-11 22:59:32 -0700612 self._RunStage(stages.PreCQLauncherStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700613 elif self._run.config.build_type == constants.CREATE_BRANCH_TYPE:
Ryan Cui88b901c2013-06-21 11:35:30 -0700614 self._RunStage(stages.BranchUtilStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700615 elif self._run.config.build_type == constants.CHROOT_BUILDER_TYPE:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400616 self._RunChrootBuilderTypeBuild()
Matt Tennantefb59522013-10-18 13:49:28 -0700617 elif self._run.config.build_type == constants.REFRESH_PACKAGES_TYPE:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400618 self._RunRefreshPackagesTypeBuild()
Matt Tennante8179042013-10-01 15:47:32 -0700619 elif (self._run.config.build_type == constants.PALADIN_TYPE and
620 self._run.config.master):
621 self._RunMasterPaladinBuild()
Don Garrett4bb21682014-03-03 16:16:23 -0800622 elif self._run.config.build_type == constants.PAYLOADS_TYPE:
623 self._RunPayloadsBuild()
Brian Harring3fec5a82012-03-01 05:57:03 -0800624 else:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400625 self._RunDefaultTypeBuild()
David James58e0c092012-03-04 20:31:12 -0800626
Brian Harring3fec5a82012-03-01 05:57:03 -0800627
628class DistributedBuilder(SimpleBuilder):
629 """Build class that has special logic to handle distributed builds.
630
631 These builds sync using git/manifest logic in manifest_versions. In general
632 they use a non-distributed builder code for the bulk of the work.
633 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700634 def __init__(self, *args, **kwargs):
Brian Harring3fec5a82012-03-01 05:57:03 -0800635 """Initializes a buildbot builder.
636
637 Extra variables:
638 completion_stage_class: Stage used to complete a build. Set in the Sync
639 stage.
640 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700641 super(DistributedBuilder, self).__init__(*args, **kwargs)
Brian Harring3fec5a82012-03-01 05:57:03 -0800642 self.completion_stage_class = None
David Jamesf421c6d2013-04-11 15:37:57 -0700643 self.sync_stage = None
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400644 self._completion_stage = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800645
646 def GetSyncInstance(self):
647 """Syncs the tree using one of the distributed sync logic paths.
648
Mike Frysinger02e1e072013-11-10 22:11:34 -0500649 Returns:
650 The instance of the sync stage to run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800651 """
652 # Determine sync class to use. CQ overrides PFQ bits so should check it
653 # first.
Matt Tennantefb59522013-10-18 13:49:28 -0700654 if self._run.config.pre_cq or self._run.options.pre_cq:
David Jamesf421c6d2013-04-11 15:37:57 -0700655 sync_stage = self._GetStageInstance(stages.PreCQSyncStage,
656 self.patch_pool.gerrit_patches)
657 self.completion_stage_class = stages.PreCQCompletionStage
658 self.patch_pool.gerrit_patches = []
Matt Tennantefb59522013-10-18 13:49:28 -0700659 elif cbuildbot_config.IsCQType(self._run.config.build_type):
660 if self._run.config.do_not_apply_cq_patches:
Aviv Keshet00bc9512013-11-25 14:58:47 -0800661 sync_stage = self._GetStageInstance(stages.MasterSlaveSyncStage)
662 else:
663 sync_stage = self._GetStageInstance(stages.CommitQueueSyncStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800664 self.completion_stage_class = stages.CommitQueueCompletionStage
Matt Tennantefb59522013-10-18 13:49:28 -0700665 elif cbuildbot_config.IsPFQType(self._run.config.build_type):
Aviv Keshetf2746152013-11-26 10:42:46 -0800666 sync_stage = self._GetStageInstance(stages.MasterSlaveSyncStage)
667 self.completion_stage_class = stages.MasterSlaveSyncCompletionStage
Brian Harring3fec5a82012-03-01 05:57:03 -0800668 else:
669 sync_stage = self._GetStageInstance(stages.ManifestVersionedSyncStage)
670 self.completion_stage_class = stages.ManifestVersionedSyncCompletionStage
671
David Jamesf421c6d2013-04-11 15:37:57 -0700672 self.sync_stage = sync_stage
673 return self.sync_stage
Brian Harring3fec5a82012-03-01 05:57:03 -0800674
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400675 def GetCompletionInstance(self):
676 """Returns the completion_stage_class instance that was used for this build.
677
Mike Frysinger1a736a82013-12-12 01:50:59 -0500678 Returns:
679 None if the completion_stage instance was not yet created (this
680 occurs during Publish).
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400681 """
682 return self._completion_stage
683
Brian Harring3fec5a82012-03-01 05:57:03 -0800684 def Publish(self, was_build_successful):
685 """Completes build by publishing any required information."""
686 completion_stage = self._GetStageInstance(self.completion_stage_class,
David Jamesf421c6d2013-04-11 15:37:57 -0700687 self.sync_stage,
Brian Harring3fec5a82012-03-01 05:57:03 -0800688 was_build_successful)
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400689 self._completion_stage = completion_stage
David James11fd7e82013-10-23 20:02:16 -0700690 completion_successful = False
691 try:
692 completion_stage.Run()
693 completion_successful = True
694 finally:
695 if not completion_successful:
696 was_build_successful = False
Matt Tennantefb59522013-10-18 13:49:28 -0700697 if self._run.config.push_overlays:
David James11fd7e82013-10-23 20:02:16 -0700698 self._RunStage(stages.PublishUprevChangesStage, was_build_successful)
Brian Harring3fec5a82012-03-01 05:57:03 -0800699
700 def RunStages(self):
701 """Runs simple builder logic and publishes information to overlays."""
702 was_build_successful = False
David James843ed252013-09-11 16:18:10 -0700703 try:
704 super(DistributedBuilder, self).RunStages()
705 was_build_successful = results_lib.Results.BuildSucceededSoFar()
706 except SystemExit as ex:
707 # If a stage calls sys.exit(0), it's exiting with success, so that means
708 # we should mark ourselves as successful.
709 if ex.code == 0:
710 was_build_successful = True
711 raise
712 finally:
713 self.Publish(was_build_successful)
Brian Harring3fec5a82012-03-01 05:57:03 -0800714
Brian Harring3fec5a82012-03-01 05:57:03 -0800715
716def _ConfirmBuildRoot(buildroot):
717 """Confirm with user the inferred buildroot, and mark it as confirmed."""
Brian Harring521e7242012-11-01 16:57:42 -0700718 cros_build_lib.Warning('Using default directory %s as buildroot', buildroot)
719 if not cros_build_lib.BooleanPrompt(default=False):
720 print('Please specify a different buildroot via the --buildroot option.')
Brian Harring3fec5a82012-03-01 05:57:03 -0800721 sys.exit(0)
722
723 if not os.path.exists(buildroot):
724 os.mkdir(buildroot)
725
726 repository.CreateTrybotMarker(buildroot)
727
728
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700729def _ConfirmRemoteBuildbotRun():
730 """Confirm user wants to run with --buildbot --remote."""
Brian Harring521e7242012-11-01 16:57:42 -0700731 cros_build_lib.Warning(
732 'You are about to launch a PRODUCTION job! This is *NOT* a '
733 'trybot run! Are you sure?')
734 if not cros_build_lib.BooleanPrompt(default=False):
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700735 print('Please specify --pass-through="--debug".')
736 sys.exit(0)
737
738
Ryan Cui5ba7e152012-05-10 14:36:52 -0700739def _DetermineDefaultBuildRoot(sourceroot, internal_build):
Brian Harring3fec5a82012-03-01 05:57:03 -0800740 """Default buildroot to be under the directory that contains current checkout.
741
Mike Frysinger02e1e072013-11-10 22:11:34 -0500742 Args:
Brian Harring3fec5a82012-03-01 05:57:03 -0800743 internal_build: Whether the build is an internal build
Ryan Cui5ba7e152012-05-10 14:36:52 -0700744 sourceroot: Use specified sourceroot.
Brian Harring3fec5a82012-03-01 05:57:03 -0800745 """
Ryan Cui5ba7e152012-05-10 14:36:52 -0700746 if not repository.IsARepoRoot(sourceroot):
Brian Harring1b8c4c82012-05-29 23:03:04 -0700747 cros_build_lib.Die(
748 'Could not find root of local checkout at %s. Please specify '
749 'using the --sourceroot option.' % sourceroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800750
751 # Place trybot buildroot under the directory containing current checkout.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700752 top_level = os.path.dirname(os.path.realpath(sourceroot))
Brian Harring3fec5a82012-03-01 05:57:03 -0800753 if internal_build:
754 buildroot = os.path.join(top_level, _DEFAULT_INT_BUILDROOT)
755 else:
756 buildroot = os.path.join(top_level, _DEFAULT_EXT_BUILDROOT)
757
758 return buildroot
759
760
761def _BackupPreviousLog(log_file, backup_limit=25):
762 """Rename previous log.
763
764 Args:
765 log_file: The absolute path to the previous log.
Aviv Keshet9e4236b2013-12-13 13:07:50 -0800766 backup_limit: Maximum number of old logs to keep.
Brian Harring3fec5a82012-03-01 05:57:03 -0800767 """
768 if os.path.exists(log_file):
769 old_logs = sorted(glob.glob(log_file + '.*'),
770 key=distutils.version.LooseVersion)
771
772 if len(old_logs) >= backup_limit:
773 os.remove(old_logs[0])
774
775 last = 0
776 if old_logs:
777 last = int(old_logs.pop().rpartition('.')[2])
778
779 os.rename(log_file, log_file + '.' + str(last + 1))
780
Ryan Cui5616a512012-08-17 13:39:36 -0700781
Gaurav Shah298aa372014-01-31 09:27:24 -0800782def _IsDistributedBuilder(options, chrome_rev, build_config):
783 """Determines whether the builder should be a DistributedBuilder.
784
785 Args:
786 options: options passed on the commandline.
787 chrome_rev: Chrome revision to build.
788 build_config: Builder configuration dictionary.
789
790 Returns:
791 True if the builder should be a distributed_builder
792 """
793 if build_config['pre_cq'] or options.pre_cq:
794 return True
795 elif not options.buildbot:
796 return False
797 elif chrome_rev in (constants.CHROME_REV_TOT,
798 constants.CHROME_REV_LOCAL,
799 constants.CHROME_REV_SPEC):
800 # We don't do distributed logic to TOT Chrome PFQ's, nor local
801 # chrome roots (e.g. chrome try bots)
802 # TODO(davidjames): Update any builders that rely on this logic to use
803 # manifest_version=False instead.
804 return False
805 elif build_config['manifest_version']:
806 return True
807
808 return False
809
810
David James944a48e2012-03-07 12:19:03 -0800811def _RunBuildStagesWrapper(options, build_config):
Brian Harring3fec5a82012-03-01 05:57:03 -0800812 """Helper function that wraps RunBuildStages()."""
Matt Tennant7feda352013-12-20 14:03:40 -0800813 cros_build_lib.Info('cbuildbot was executed with args %s' %
814 cros_build_lib.CmdToStr(sys.argv))
Brian Harring3fec5a82012-03-01 05:57:03 -0800815
David Jamesa0a664e2013-02-13 09:52:01 -0800816 chrome_rev = build_config['chrome_rev']
817 if options.chrome_rev:
818 chrome_rev = options.chrome_rev
819 if chrome_rev == constants.CHROME_REV_TOT:
820 # Build the TOT Chrome revision.
821 svn_url = gclient.GetBaseURLs()[0]
822 options.chrome_version = gclient.GetTipOfTrunkSvnRevision(svn_url)
823 options.chrome_rev = constants.CHROME_REV_SPEC
824
David James4a404a52013-02-19 13:07:59 -0800825 # If it's likely we'll need to build Chrome, fetch the source.
Mike Frysingerf4d9ab82013-03-05 19:38:05 -0500826 if build_config['sync_chrome'] is None:
827 options.managed_chrome = (chrome_rev != constants.CHROME_REV_LOCAL and
828 (not build_config['usepkg_build_packages'] or chrome_rev or
David James3cce4642013-05-10 17:50:23 -0700829 build_config['profile'] or options.rietveld_patches))
Mike Frysingerf4d9ab82013-03-05 19:38:05 -0500830 else:
831 options.managed_chrome = build_config['sync_chrome']
David James2333c182013-02-13 16:16:15 -0800832
833 if options.managed_chrome:
834 # Tell Chrome to fetch the source locally.
Matt Tennant628ffdd2013-11-27 14:44:39 -0800835 internal = constants.USE_CHROME_INTERNAL in build_config['useflags']
David James2333c182013-02-13 16:16:15 -0800836 chrome_src = 'chrome-src-internal' if internal else 'chrome-src'
837 options.chrome_root = os.path.join(options.cache_dir, 'distfiles', 'target',
838 chrome_src)
David James9e27e662013-02-14 13:42:43 -0800839 elif options.rietveld_patches:
David James4a404a52013-02-19 13:07:59 -0800840 cros_build_lib.Die('This builder does not support Rietveld patches.')
David James2333c182013-02-13 16:16:15 -0800841
Matt Tennant95a42ad2013-12-27 15:38:36 -0800842 # We are done munging options values, so freeze options object now to avoid
843 # further abuse of it.
844 # TODO(mtennant): one by one identify each options value override and see if
845 # it can be handled another way. Try to push this freeze closer and closer
846 # to the start of the script (e.g. in or after _PostParseCheck).
847 options.Freeze()
848
Matt Tennant0940c382014-01-21 20:43:55 -0800849 with parallel.Manager() as manager:
850 builder_run = cbuildbot_run.BuilderRun(options, build_config, manager)
851 if _IsDistributedBuilder(options, chrome_rev, build_config):
852 builder_cls = DistributedBuilder
853 else:
854 builder_cls = SimpleBuilder
855 builder = builder_cls(builder_run)
856 if not builder.Run():
857 sys.exit(1)
Brian Harring3fec5a82012-03-01 05:57:03 -0800858
859
860# Parser related functions
Ryan Cui5ba7e152012-05-10 14:36:52 -0700861def _CheckLocalPatches(sourceroot, local_patches):
Brian Harring3fec5a82012-03-01 05:57:03 -0800862 """Do an early quick check of the passed-in patches.
863
864 If the branch of a project is not specified we append the current branch the
865 project is on.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700866
David Jamese3b06062013-11-09 18:52:02 -0800867 TODO(davidjames): The project:branch format isn't unique, so this means that
868 we can't differentiate what directory the user intended to apply patches to.
869 We should references by directory instead.
870
Ryan Cui5ba7e152012-05-10 14:36:52 -0700871 Args:
872 sourceroot: The checkout where patches are coming from.
Aviv Keshet9e4236b2013-12-13 13:07:50 -0800873 local_patches: List of patches to check in project:branch format.
David Jamese3b06062013-11-09 18:52:02 -0800874
875 Returns:
876 A list of patches that have been verified, in project:branch format.
Brian Harring3fec5a82012-03-01 05:57:03 -0800877 """
Ryan Cuicedd8a52012-03-22 02:28:35 -0700878 verified_patches = []
David James97d95872012-11-16 15:09:56 -0800879 manifest = git.ManifestCheckout.Cached(sourceroot)
Ryan Cuicedd8a52012-03-22 02:28:35 -0700880 for patch in local_patches:
David Jamese3b06062013-11-09 18:52:02 -0800881 project, _, branch = patch.partition(':')
882
Gaurav Shah7afb0562013-12-26 15:05:39 -0800883 checkouts = manifest.FindCheckouts(project, only_patchable=True)
David Jamese3b06062013-11-09 18:52:02 -0800884 if not checkouts:
885 cros_build_lib.Die('Project %s does not exist.' % (project,))
886 if len(checkouts) > 1:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700887 cros_build_lib.Die(
David Jamese3b06062013-11-09 18:52:02 -0800888 'We do not yet support local patching for projects that are checked '
889 'out to multiple directories. Try uploading your patch to gerrit '
890 'and referencing it via the -g option instead.'
891 )
Brian Harring3fec5a82012-03-01 05:57:03 -0800892
David Jamese3b06062013-11-09 18:52:02 -0800893 ok = False
894 for checkout in checkouts:
895 project_dir = checkout.GetPath(absolute=True)
Brian Harring3fec5a82012-03-01 05:57:03 -0800896
David Jamese3b06062013-11-09 18:52:02 -0800897 # If no branch was specified, we use the project's current branch.
Brian Harring3fec5a82012-03-01 05:57:03 -0800898 if not branch:
David Jamese3b06062013-11-09 18:52:02 -0800899 local_branch = git.GetCurrentBranch(project_dir)
900 else:
901 local_branch = branch
Brian Harring3fec5a82012-03-01 05:57:03 -0800902
David Jamese3b06062013-11-09 18:52:02 -0800903 if local_branch and git.DoesLocalBranchExist(project_dir, local_branch):
904 verified_patches.append('%s:%s' % (project, local_branch))
905 ok = True
906
907 if not ok:
908 if branch:
909 cros_build_lib.Die('Project %s does not have branch %s'
910 % (project, branch))
911 else:
912 cros_build_lib.Die('Project %s is not on a branch!' % (project,))
Brian Harring3fec5a82012-03-01 05:57:03 -0800913
Ryan Cuicedd8a52012-03-22 02:28:35 -0700914 return verified_patches
Brian Harring3fec5a82012-03-01 05:57:03 -0800915
916
Brian Harring3fec5a82012-03-01 05:57:03 -0800917def _CheckChromeVersionOption(_option, _opt_str, value, parser):
918 """Upgrade other options based on chrome_version being passed."""
919 value = value.strip()
920
921 if parser.values.chrome_rev is None and value:
922 parser.values.chrome_rev = constants.CHROME_REV_SPEC
923
924 parser.values.chrome_version = value
925
926
927def _CheckChromeRootOption(_option, _opt_str, value, parser):
928 """Validate and convert chrome_root to full-path form."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800929 if parser.values.chrome_rev is None:
930 parser.values.chrome_rev = constants.CHROME_REV_LOCAL
931
Ryan Cui5ba7e152012-05-10 14:36:52 -0700932 parser.values.chrome_root = value
Brian Harring3fec5a82012-03-01 05:57:03 -0800933
934
935def _CheckChromeRevOption(_option, _opt_str, value, parser):
936 """Validate the chrome_rev option."""
937 value = value.strip()
938 if value not in constants.VALID_CHROME_REVISIONS:
939 raise optparse.OptionValueError('Invalid chrome rev specified')
940
941 parser.values.chrome_rev = value
942
943
David Jamesac8c2a72013-02-13 18:44:33 -0800944def FindCacheDir(_parser, _options):
Brian Harringae0a5322012-09-15 01:46:51 -0700945 return None
946
947
Ryan Cui5ba7e152012-05-10 14:36:52 -0700948class CustomGroup(optparse.OptionGroup):
Aviv Keshet9e4236b2013-12-13 13:07:50 -0800949 """Custom option group which supports arguments passed-through to trybot."""
Ryan Cui5ba7e152012-05-10 14:36:52 -0700950 def add_remote_option(self, *args, **kwargs):
951 """For arguments that are passed-through to remote trybot."""
952 return optparse.OptionGroup.add_option(self, *args,
953 remote_pass_through=True,
954 **kwargs)
955
956
Ryan Cui1c13a252012-10-16 15:00:16 -0700957class CustomOption(commandline.FilteringOption):
958 """Subclass FilteringOption class to implement pass-through and api."""
Ryan Cui5ba7e152012-05-10 14:36:52 -0700959
Ryan Cui1c13a252012-10-16 15:00:16 -0700960 ACTIONS = commandline.FilteringOption.ACTIONS + ('extend',)
961 STORE_ACTIONS = commandline.FilteringOption.STORE_ACTIONS + ('extend',)
962 TYPED_ACTIONS = commandline.FilteringOption.TYPED_ACTIONS + ('extend',)
963 ALWAYS_TYPED_ACTIONS = (commandline.FilteringOption.ALWAYS_TYPED_ACTIONS +
964 ('extend',))
Ryan Cui79319ab2012-05-21 12:59:18 -0700965
Ryan Cui5ba7e152012-05-10 14:36:52 -0700966 def __init__(self, *args, **kwargs):
967 # The remote_pass_through argument specifies whether we should directly
968 # pass the argument (with its value) onto the remote trybot.
969 self.pass_through = kwargs.pop('remote_pass_through', False)
Ryan Cui1c13a252012-10-16 15:00:16 -0700970 self.api_version = int(kwargs.pop('api', '0'))
971 commandline.FilteringOption.__init__(self, *args, **kwargs)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700972
973 def take_action(self, action, dest, opt, value, values, parser):
Ryan Cui79319ab2012-05-21 12:59:18 -0700974 if action == 'extend':
Mike Frysingerd6925b52012-07-16 16:11:00 -0400975 # If there is extra spaces between each argument, we get '' which later
976 # code barfs on, so skip those. e.g. We see this with the forms:
977 # cbuildbot -p 'proj:branch ' ...
978 # cbuildbot -p ' proj:branch' ...
979 # cbuildbot -p 'proj:branch proj2:branch' ...
980 lvalue = value.split()
Ryan Cui79319ab2012-05-21 12:59:18 -0700981 values.ensure_value(dest, []).extend(lvalue)
Ryan Cui79319ab2012-05-21 12:59:18 -0700982
Ryan Cui1c13a252012-10-16 15:00:16 -0700983 commandline.FilteringOption.take_action(
984 self, action, dest, opt, value, values, parser)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700985
986
Ryan Cui1c13a252012-10-16 15:00:16 -0700987class CustomParser(commandline.FilteringParser):
Aviv Keshet9e4236b2013-12-13 13:07:50 -0800988 """Custom option parser which supports arguments passed-trhough to trybot"""
Matt Tennante8179042013-10-01 15:47:32 -0700989
Brian Harringb6cf9142012-09-01 20:43:17 -0700990 DEFAULT_OPTION_CLASS = CustomOption
991
992 def add_remote_option(self, *args, **kwargs):
993 """For arguments that are passed-through to remote trybot."""
Ryan Cui1c13a252012-10-16 15:00:16 -0700994 return self.add_option(*args, remote_pass_through=True, **kwargs)
Brian Harringb6cf9142012-09-01 20:43:17 -0700995
996
Brian Harring3fec5a82012-03-01 05:57:03 -0800997def _CreateParser():
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700998 """Generate and return the parser with all the options."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800999 # Parse options
Matt Tennant763497d2014-01-17 16:45:54 -08001000 usage = "usage: %prog [options] buildbot_config [buildbot_config ...]"
Brian Harringae0a5322012-09-15 01:46:51 -07001001 parser = CustomParser(usage=usage, caching=FindCacheDir)
Brian Harring3fec5a82012-03-01 05:57:03 -08001002
1003 # Main options
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001004 parser.add_option('-l', '--list', action='store_true', dest='list',
1005 default=False,
1006 help='List the suggested trybot configs to use (see --all)')
Brian Harring3fec5a82012-03-01 05:57:03 -08001007 parser.add_option('-a', '--all', action='store_true', dest='print_all',
1008 default=False,
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001009 help='List all of the buildbot configs available w/--list')
1010
1011 parser.add_option('--local', default=False, action='store_true',
Ryan Cui88b901c2013-06-21 11:35:30 -07001012 help='Specifies that this tryjob should be run locally. '
1013 'Implies --debug.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001014 parser.add_option('--remote', default=False, action='store_true',
Ryan Cui88b901c2013-06-21 11:35:30 -07001015 help='Specifies that this tryjob should be run remotely.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001016
Ryan Cuie1e4e662012-05-21 16:39:46 -07001017 parser.add_remote_option('-b', '--branch',
1018 help='The manifest branch to test. The branch to '
1019 'check the buildroot out to.')
Ryan Cui5ba7e152012-05-10 14:36:52 -07001020 parser.add_option('-r', '--buildroot', dest='buildroot', type='path',
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001021 help='Root directory where source is checked out to, and '
1022 'where the build occurs. For external build configs, '
1023 "defaults to 'trybot' directory at top level of your "
1024 'repo-managed checkout.')
1025 parser.add_remote_option('--chrome_rev', default=None, type='string',
1026 action='callback', dest='chrome_rev',
1027 callback=_CheckChromeRevOption,
1028 help=('Revision of Chrome to use, of type [%s]'
1029 % '|'.join(constants.VALID_CHROME_REVISIONS)))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001030 parser.add_remote_option('--profile', default=None, type='string',
1031 action='store', dest='profile',
1032 help='Name of profile to sub-specify board variant.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001033
Ryan Cuif4f84be2012-07-09 18:50:41 -07001034 #
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001035 # Patch selection options.
1036 #
1037
1038 group = CustomGroup(
1039 parser,
1040 'Patch Options')
1041
1042 group.add_remote_option('-g', '--gerrit-patches', action='extend',
1043 default=[], type='string',
1044 metavar="'Id1 *int_Id2...IdN'",
1045 help="Space-separated list of short-form Gerrit "
1046 "Change-Id's or change numbers to patch. "
1047 "Please prepend '*' to internal Change-Id's")
1048 group.add_remote_option('-G', '--rietveld-patches', action='extend',
1049 default=[], type='string',
1050 metavar="'id1[:subdir1]...idN[:subdirN]'",
1051 help='Space-separated list of short-form Rietveld '
1052 'issue numbers to patch. If no subdir is '
1053 'specified, the src directory is used.')
1054 group.add_option('-p', '--local-patches', action='extend', default=[],
1055 metavar="'<project1>[:<branch1>]...<projectN>[:<branchN>]'",
1056 help='Space-separated list of project branches with '
1057 'patches to apply. Projects are specified by name. '
1058 'If no branch is specified the current branch of the '
1059 'project will be used.')
1060
1061 parser.add_option_group(group)
1062
1063 #
1064 # Remote trybot options.
1065 #
1066
1067 group = CustomGroup(
1068 parser,
1069 'Remote Trybot Options (--remote)')
1070
1071 group.add_remote_option('--hwtest', dest='hwtest', action='store_true',
1072 default=False,
1073 help='Run the HWTest stage (tests on real hardware)')
1074 group.add_option('--remote-description', default=None,
1075 help='Attach an optional description to a --remote run '
1076 'to make it easier to identify the results when it '
1077 'finishes')
1078 group.add_option('--slaves', action='extend', default=[],
1079 help='Specify specific remote tryslaves to run on (e.g. '
1080 'build149-m2); if the bot is busy, it will be queued')
Don Garrett4bb21682014-03-03 16:16:23 -08001081 group.add_remote_option('--channel', dest='channels', action='extend',
1082 default=[],
1083 help='Specify a channel for a payloads trybot. Can be'
1084 'specified multiple times. No valid for '
1085 'non-payloads configs.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001086 group.add_option('--test-tryjob', action='store_true',
1087 default=False,
1088 help='Submit a tryjob to the test repository. Will not '
1089 'show up on the production trybot waterfall.')
1090
1091 parser.add_option_group(group)
1092
1093 #
Ryan Cui88b901c2013-06-21 11:35:30 -07001094 # Branch creation options.
1095 #
1096
1097 group = CustomGroup(
1098 parser,
1099 'Branch Creation Options (used with branch-util)')
1100
1101 group.add_remote_option('--branch-name',
1102 help='The branch to create or delete.')
1103 group.add_remote_option('--delete-branch', default=False, action='store_true',
1104 help='Delete the branch specified in --branch-name.')
1105 group.add_remote_option('--rename-to', type='string',
1106 help='Rename a branch to the specified name.')
1107 group.add_remote_option('--force-create', default=False, action='store_true',
1108 help='Overwrites an existing branch.')
1109
1110 parser.add_option_group(group)
1111
1112 #
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001113 # Advanced options.
Ryan Cuif4f84be2012-07-09 18:50:41 -07001114 #
1115
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001116 group = CustomGroup(
Brian Harring3fec5a82012-03-01 05:57:03 -08001117 parser,
1118 'Advanced Options',
1119 'Caution: use these options at your own risk.')
1120
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001121 group.add_remote_option('--bootstrap-args', action='append', default=[],
1122 help='Args passed directly to the bootstrap re-exec '
1123 'to skip verification by the bootstrap code')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001124 group.add_remote_option('--buildbot', dest='buildbot', action='store_true',
1125 default=False, help='This is running on a buildbot')
1126 group.add_remote_option('--buildnumber', help='build number', type='int',
1127 default=0)
Ryan Cui5ba7e152012-05-10 14:36:52 -07001128 group.add_option('--chrome_root', default=None, type='path',
1129 action='callback', callback=_CheckChromeRootOption,
1130 dest='chrome_root', help='Local checkout of Chrome to use.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001131 group.add_remote_option('--chrome_version', default=None, type='string',
1132 action='callback', dest='chrome_version',
1133 callback=_CheckChromeVersionOption,
1134 help='Used with SPEC logic to force a particular SVN '
1135 'revision of chrome rather than the latest.')
1136 group.add_remote_option('--clobber', action='store_true', dest='clobber',
1137 default=False,
1138 help='Clears an old checkout before syncing')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001139 group.add_remote_option('--latest-toolchain', action='store_true',
1140 default=False,
1141 help='Use the latest toolchain.')
Ryan Cui5ba7e152012-05-10 14:36:52 -07001142 parser.add_option('--log_dir', dest='log_dir', type='path',
Brian Harring3fec5a82012-03-01 05:57:03 -08001143 help=('Directory where logs are stored.'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001144 group.add_remote_option('--maxarchives', dest='max_archive_builds',
1145 default=3, type='int',
1146 help="Change the local saved build count limit.")
Ryan Cuibbd3d4b2012-08-17 12:20:37 -07001147 parser.add_remote_option('--manifest-repo-url',
1148 help=('Overrides the default manifest repo url.'))
David James565bc9a2013-04-08 14:54:45 -07001149 group.add_remote_option('--compilecheck', action='store_true', default=False,
1150 help='Only verify compilation and unit tests.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001151 group.add_remote_option('--noarchive', action='store_false', dest='archive',
1152 default=True, help="Don't run archive stage.")
Ryan Cuif7f24692012-05-18 16:35:33 -07001153 group.add_remote_option('--nobootstrap', action='store_false',
1154 dest='bootstrap', default=True,
1155 help="Don't checkout and run from a standalone "
1156 "chromite repo.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001157 group.add_remote_option('--nobuild', action='store_false', dest='build',
1158 default=True,
1159 help="Don't actually build (for cbuildbot dev)")
1160 group.add_remote_option('--noclean', action='store_false', dest='clean',
1161 default=True, help="Don't clean the buildroot")
Ryan Cuif7f24692012-05-18 16:35:33 -07001162 group.add_remote_option('--nocgroups', action='store_false', dest='cgroups',
1163 default=True,
1164 help='Disable cbuildbots usage of cgroups.')
Ryan Cui3ea98e02013-08-07 16:01:48 -07001165 group.add_remote_option('--nochromesdk', action='store_false',
1166 dest='chrome_sdk', default=True,
1167 help="Don't run the ChromeSDK stage which builds "
1168 "Chrome outside of the chroot.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001169 group.add_remote_option('--noprebuilts', action='store_false',
1170 dest='prebuilts', default=True,
1171 help="Don't upload prebuilts.")
Ryan Cui88b901c2013-06-21 11:35:30 -07001172 group.add_remote_option('--nopatch', action='store_false',
1173 dest='postsync_patch', default=True,
1174 help=("Don't run PatchChanges stage. This does not "
1175 "disable patching in of chromite patches "
1176 "during BootstrapStage."))
Don Garrett82c0ae82014-02-03 18:25:11 -08001177 group.add_remote_option('--nopaygen', action='store_false',
1178 dest='paygen', default=True,
1179 help="Don't generate payloads.")
Ryan Cui88b901c2013-06-21 11:35:30 -07001180 group.add_remote_option('--noreexec', action='store_false',
1181 dest='postsync_reexec', default=True,
1182 help="Don't reexec into the buildroot after syncing.")
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001183 group.add_remote_option('--nosdk', action='store_true',
1184 default=False,
1185 help='Re-create the SDK from scratch.')
Don Garrett7604d6a2014-01-15 14:45:39 -08001186 group.add_remote_option('--nosigner-results', action='store_false',
1187 dest='signer_results', default=True,
1188 help="Don't display signing results.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001189 group.add_remote_option('--nosync', action='store_false', dest='sync',
1190 default=True, help="Don't sync before building.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001191 group.add_remote_option('--notests', action='store_false', dest='tests',
1192 default=True,
1193 help='Override values from buildconfig and run no '
1194 'tests.')
1195 group.add_remote_option('--nouprev', action='store_false', dest='uprev',
1196 default=True,
1197 help='Override values from buildconfig and never '
1198 'uprev.')
David Jamesdac7a912013-11-18 11:14:44 -08001199 group.add_option('--reference-repo', action='store', default=None,
1200 dest='reference_repo',
1201 help='Reuse git data stored in an existing repo '
1202 'checkout. This can drastically reduce the network '
1203 'time spent setting up the trybot checkout. By '
1204 "default, if this option isn't given but cbuildbot "
1205 'is invoked from a repo checkout, cbuildbot will '
1206 'use the repo root.')
Ryan Cuicedd8a52012-03-22 02:28:35 -07001207 group.add_option('--resume', action='store_true', default=False,
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001208 help='Skip stages already successfully completed.')
1209 group.add_remote_option('--timeout', action='store', type='int', default=0,
1210 help='Specify the maximum amount of time this job '
1211 'can run for, at which point the build will be '
1212 'aborted. If set to zero, then there is no '
1213 'timeout.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001214 group.add_remote_option('--version', dest='force_version', default=None,
1215 help='Used with manifest logic. Forces use of this '
Aviv Keshetc2c123d2013-10-14 18:06:12 -04001216 'version rather than create or get latest. '
1217 'Examples: 4815.0.0-rc1, 4815.1.2')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001218
1219 parser.add_option_group(group)
1220
1221 #
1222 # Internal options.
1223 #
1224
1225 group = CustomGroup(
1226 parser,
Mike Frysinger34db8692013-11-11 14:54:08 -05001227 'Internal Chromium OS Build Team Options',
1228 'Caution: these are for meant for the Chromium OS build team only')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001229
1230 group.add_remote_option('--archive-base', type='gs_path',
1231 help='Base GS URL (gs://<bucket_name>/<path>) to '
1232 'upload archive artifacts to')
Brian Harringab8fb5c2012-07-18 11:28:22 -07001233 group.add_remote_option('--cq-gerrit-query', dest='cq_gerrit_override',
1234 default=None,
1235 help=
1236 "If given, this gerrit query will be used to find what patches to test, "
Aviv Keshetefd6bbf2013-12-12 13:36:57 -08001237 "rather than the normal 'CommitQueue>=1 AND Verified=1 AND CodeReview=2' "
Brian Harringab8fb5c2012-07-18 11:28:22 -07001238 "query it defaults to. Use with care- note additionally this setting "
1239 "only has an effect if the buildbot target is a cq target, and we're "
1240 "in buildbot mode.")
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001241 group.add_option('--pass-through', dest='pass_through_args', action='append',
1242 type='string', default=[])
David Jamesf421c6d2013-04-11 15:37:57 -07001243 group.add_remote_option('--pre-cq', action='store_true', default=False,
1244 help='Mark CLs as tested by the PreCQ on success.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001245 group.add_option('--reexec-api-version', dest='output_api_version',
Ryan Cuif4f84be2012-07-09 18:50:41 -07001246 action='store_true', default=False,
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001247 help='Used for handling forwards/backwards compatibility '
1248 'with --resume and --bootstrap')
1249 group.add_option('--remote-trybot', dest='remote_trybot',
1250 action='store_true', default=False,
1251 help='Indicates this is running on a remote trybot machine')
1252 group.add_remote_option('--remote-patches', action='extend', default=[],
1253 help='Patches uploaded by the trybot client when run '
1254 'using the -p option')
Brian Harringf611e6e2012-07-17 18:47:44 -07001255 # Note the default here needs to be hardcoded to 3; that is the last version
1256 # that lacked this functionality.
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001257 group.add_option('--remote-version', default=3, type=int, action='store',
1258 help='Used for compatibility checks w/tryjobs running in '
1259 'older chromite instances')
1260 group.add_option('--sourceroot', type='path', default=constants.SOURCE_ROOT)
1261 group.add_remote_option('--test-bootstrap', action='store_true',
1262 default=False,
1263 help='Causes cbuildbot to bootstrap itself twice, in '
1264 'the sequence A->B->C: A(unpatched) patches and '
1265 'bootstraps B; B patches and bootstraps C')
1266 group.add_remote_option('--validation_pool', default=None,
1267 help='Path to a pickled validation pool. Intended '
1268 'for use only with the commit queue.')
Aviv Kesheta0159be2013-12-12 13:56:28 -08001269 group.add_remote_option('--mock-tree-status', dest='mock_tree_status',
1270 default=None, action='store',
1271 help='Override the tree status value that would be '
1272 'returned from the the actual tree. Example '
1273 'values: open, closed, throttled. When used '
1274 'in conjunction with --debug, the tree status '
1275 'will not be ignored as it usually is in a '
1276 '--debug run.')
Aviv Keshetcf9c2722014-02-25 15:15:10 -08001277 group.add_remote_option('--mock-slave-status', dest='mock_slave_status',
1278 default=None, action='store',
1279 metavar='MOCK_SLAVE_STATUS_PICKLE_FILE',
1280 help='Override the result of the _FetchSlaveStatuses '
1281 'method of MasterSlaveSyncCompletionStage, by '
1282 'specifying a file with a pickle of the result '
1283 'to be returned.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001284
1285 parser.add_option_group(group)
Ryan Cuif4f84be2012-07-09 18:50:41 -07001286
1287 #
Brian Harring3fec5a82012-03-01 05:57:03 -08001288 # Debug options
Ryan Cuif4f84be2012-07-09 18:50:41 -07001289 #
Brian Harringfec89fe2012-09-23 07:30:54 -07001290 # Temporary hack; in place till --dry-run replaces --debug.
1291 # pylint: disable=W0212
Brian Harring009db502012-10-10 02:21:37 -07001292 group = parser.debug_group
Brian Harringfec89fe2012-09-23 07:30:54 -07001293 debug = [x for x in group.option_list if x._long_opts == ['--debug']][0]
1294 debug.help += " Currently functions as --dry-run in addition."
1295 debug.pass_through = True
Brian Harring3fec5a82012-03-01 05:57:03 -08001296 group.add_option('--notee', action='store_false', dest='tee', default=True,
1297 help="Disable logging and internal tee process. Primarily "
1298 "used for debugging cbuildbot itself.")
Brian Harring3fec5a82012-03-01 05:57:03 -08001299 return parser
1300
1301
Ryan Cui85867972012-02-23 18:21:49 -08001302def _FinishParsing(options, args):
1303 """Perform some parsing tasks that need to take place after optparse.
1304
1305 This function needs to be easily testable! Keep it free of
1306 environment-dependent code. Put more detailed usage validation in
1307 _PostParseCheck().
Brian Harring3fec5a82012-03-01 05:57:03 -08001308
1309 Args:
Matt Tennant759e2352013-09-27 15:14:44 -07001310 options: The options object returned by optparse
1311 args: The args object returned by optparse
Brian Harring3fec5a82012-03-01 05:57:03 -08001312 """
Ryan Cui41023d92012-11-13 19:59:50 -08001313 # Populate options.pass_through_args.
1314 accepted, _ = commandline.FilteringParser.FilterArgs(
1315 options.parsed_args, lambda x: x.opt_inst.pass_through)
1316 options.pass_through_args.extend(accepted)
Brian Harring07039b52012-05-13 17:56:47 -07001317
Brian Harring3fec5a82012-03-01 05:57:03 -08001318 if options.chrome_root:
1319 if options.chrome_rev != constants.CHROME_REV_LOCAL:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001320 cros_build_lib.Die('Chrome rev must be %s if chrome_root is set.' %
1321 constants.CHROME_REV_LOCAL)
David Jamesa0a664e2013-02-13 09:52:01 -08001322 elif options.chrome_rev == constants.CHROME_REV_LOCAL:
1323 cros_build_lib.Die('Chrome root must be set if chrome_rev is %s.' %
1324 constants.CHROME_REV_LOCAL)
Brian Harring3fec5a82012-03-01 05:57:03 -08001325
1326 if options.chrome_version:
1327 if options.chrome_rev != constants.CHROME_REV_SPEC:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001328 cros_build_lib.Die('Chrome rev must be %s if chrome_version is set.' %
1329 constants.CHROME_REV_SPEC)
David Jamesa0a664e2013-02-13 09:52:01 -08001330 elif options.chrome_rev == constants.CHROME_REV_SPEC:
1331 cros_build_lib.Die(
1332 'Chrome rev must not be %s if chrome_version is not set.'
1333 % constants.CHROME_REV_SPEC)
Brian Harring3fec5a82012-03-01 05:57:03 -08001334
David James9e27e662013-02-14 13:42:43 -08001335 patches = bool(options.gerrit_patches or options.local_patches or
1336 options.rietveld_patches)
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001337 if options.remote:
1338 if options.local:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001339 cros_build_lib.Die('Cannot specify both --remote and --local')
Ryan Cui54da0702012-04-19 18:38:08 -07001340
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001341 if not options.buildbot and not patches:
Gaurav Shahed0399e2014-02-03 13:36:22 -08001342 prompt = ('No patches were provided; are you sure you want to just '
1343 'run a remote build of %s?' % (
1344 options.branch if options.branch else 'ToT'))
1345 if not cros_build_lib.BooleanPrompt(prompt=prompt, default=False):
Brian Harring7cc4b932012-11-01 16:58:55 -07001346 cros_build_lib.Die('Must provide patches when running with --remote.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001347
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001348 # --debug needs to be explicitly passed through for remote invocations.
1349 release_mode_with_patches = (options.buildbot and patches and
1350 '--debug' not in options.pass_through_args)
1351 else:
1352 if len(args) > 1:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001353 cros_build_lib.Die('Multiple configs not supported if not running with '
Brian Harringf1aad832012-07-18 10:46:39 -07001354 '--remote. Got %r', args)
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001355
Ryan Cui79319ab2012-05-21 12:59:18 -07001356 if options.slaves:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001357 cros_build_lib.Die('Cannot use --slaves if not running with --remote.')
Ryan Cui79319ab2012-05-21 12:59:18 -07001358
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001359 release_mode_with_patches = (options.buildbot and patches and
1360 not options.debug)
1361
David James5734ea32012-08-15 20:23:49 -07001362 # When running in release mode, make sure we are running with checked-in code.
1363 # We want checked-in cbuildbot/scripts to prevent errors, and we want to build
1364 # a release image with checked-in code for CrOS packages.
1365 if release_mode_with_patches:
1366 cros_build_lib.Die(
1367 'Cannot provide patches when running with --buildbot!')
1368
Ryan Cuiba41ad32012-03-08 17:15:29 -08001369 if options.buildbot and options.remote_trybot:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001370 cros_build_lib.Die(
1371 '--buildbot and --remote-trybot cannot be used together.')
Ryan Cuiba41ad32012-03-08 17:15:29 -08001372
Ryan Cui85867972012-02-23 18:21:49 -08001373 # Record whether --debug was set explicitly vs. it was inferred.
1374 options.debug_forced = False
1375 if options.debug:
1376 options.debug_forced = True
Ryan Cui88b901c2013-06-21 11:35:30 -07001377 if not options.debug:
Ryan Cui16ca5812012-03-08 20:34:27 -08001378 # We don't set debug by default for
1379 # 1. --buildbot invocations.
1380 # 2. --remote invocations, because it needs to push changes to the tryjob
1381 # repo.
1382 options.debug = not options.buildbot and not options.remote
Brian Harring3fec5a82012-03-01 05:57:03 -08001383
Ryan Cui1c13a252012-10-16 15:00:16 -07001384 # Record the configs targeted.
1385 options.build_targets = args[:]
1386
Ryan Cui88b901c2013-06-21 11:35:30 -07001387 if constants.BRANCH_UTIL_CONFIG in options.build_targets:
Ryan Cui7bd8db62013-08-08 16:29:51 -07001388 if options.remote:
1389 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001390 'Running %s as a remote tryjob is not yet supported.',
1391 constants.BRANCH_UTIL_CONFIG)
Ryan Cui88b901c2013-06-21 11:35:30 -07001392 if len(options.build_targets) > 1:
1393 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001394 'Cannot run %s with any other configs.',
1395 constants.BRANCH_UTIL_CONFIG)
Ryan Cui88b901c2013-06-21 11:35:30 -07001396 if not options.branch_name:
1397 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001398 'Must specify --branch-name with the %s config.',
1399 constants.BRANCH_UTIL_CONFIG)
1400 if options.branch and options.branch != options.branch_name:
Ryan Cui88b901c2013-06-21 11:35:30 -07001401 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001402 'If --branch is specified with the %s config, it must'
1403 ' have the same value as --branch-name.',
1404 constants.BRANCH_UTIL_CONFIG)
1405
1406 exclusive_opts = {'--version': options.force_version,
1407 '--delete-branch': options.delete_branch,
1408 '--rename-to': options.rename_to,
1409 }
1410 if 1 != sum(1 for x in exclusive_opts.values() if x):
1411 cros_build_lib.Die('When using the %s config, you must'
1412 ' specifiy one and only one of the following'
1413 ' options: %s.', constants.BRANCH_UTIL_CONFIG,
1414 ', '.join(exclusive_opts.keys()))
1415
1416 # When deleting or renaming a branch, the --branch and --nobootstrap
1417 # options are implied.
1418 if options.delete_branch or options.rename_to:
1419 if not options.branch:
1420 cros_build_lib.Info('Automatically enabling sync to branch %s'
1421 ' for this %s flow.', options.branch_name,
1422 constants.BRANCH_UTIL_CONFIG)
1423 options.branch = options.branch_name
1424 if options.bootstrap:
1425 cros_build_lib.Info('Automatically disabling bootstrap step for'
1426 ' this %s flow.', constants.BRANCH_UTIL_CONFIG)
1427 options.bootstrap = False
1428
Ryan Cui88b901c2013-06-21 11:35:30 -07001429 elif any([options.delete_branch, options.rename_to, options.branch_name]):
1430 cros_build_lib.Die(
1431 'Cannot specify --delete-branch, --rename-to or --branch-name when not '
1432 'running the %s config', constants.BRANCH_UTIL_CONFIG)
1433
Brian Harring3fec5a82012-03-01 05:57:03 -08001434
Brian Harring1d7ba942012-04-24 06:37:18 -07001435# pylint: disable=W0613
Brian Harringae0a5322012-09-15 01:46:51 -07001436def _PostParseCheck(parser, options, args):
Ryan Cui85867972012-02-23 18:21:49 -08001437 """Perform some usage validation after we've parsed the arguments
Brian Harring3fec5a82012-03-01 05:57:03 -08001438
Ryan Cui85867972012-02-23 18:21:49 -08001439 Args:
Aviv Keshet9e4236b2013-12-13 13:07:50 -08001440 parser: Option parser that was used to parse arguments.
1441 options: The options returned by optparse.
1442 args: The args returned by optparse.
Ryan Cui85867972012-02-23 18:21:49 -08001443 """
Ryan Cuie1e4e662012-05-21 16:39:46 -07001444 if not options.branch:
David James97d95872012-11-16 15:09:56 -08001445 options.branch = git.GetChromiteTrackingBranch()
Ryan Cuie1e4e662012-05-21 16:39:46 -07001446
Brian Harringae0a5322012-09-15 01:46:51 -07001447 if not repository.IsARepoRoot(options.sourceroot):
1448 if options.local_patches:
1449 raise Exception('Could not find repo checkout at %s!'
1450 % options.sourceroot)
1451
David Jamesac8c2a72013-02-13 18:44:33 -08001452 # Because the default cache dir depends on other options, FindCacheDir
1453 # always returns None, and we setup the default here.
Brian Harringae0a5322012-09-15 01:46:51 -07001454 if options.cache_dir is None:
1455 # Note, options.sourceroot is set regardless of the path
1456 # actually existing.
David Jamesac8c2a72013-02-13 18:44:33 -08001457 if options.buildroot is not None:
Brian Harringae0a5322012-09-15 01:46:51 -07001458 options.cache_dir = os.path.join(options.buildroot, '.cache')
David Jamesac8c2a72013-02-13 18:44:33 -08001459 elif os.path.exists(options.sourceroot):
1460 options.cache_dir = os.path.join(options.sourceroot, '.cache')
Brian Harringae0a5322012-09-15 01:46:51 -07001461 else:
1462 options.cache_dir = parser.FindCacheDir(parser, options)
1463 options.cache_dir = os.path.abspath(options.cache_dir)
Brian Harring8c1d7b12012-10-04 17:36:32 -07001464 parser.ConfigureCacheDir(options.cache_dir)
Brian Harringae0a5322012-09-15 01:46:51 -07001465
Yu-Ju Hong2c066762013-10-28 14:05:08 -07001466 osutils.SafeMakedirsNonRoot(options.cache_dir)
Ryan Cui5ba7e152012-05-10 14:36:52 -07001467
Brian Harring609dc4e2012-05-07 02:17:44 -07001468 if options.local_patches:
Brian Harring1d7ba942012-04-24 06:37:18 -07001469 options.local_patches = _CheckLocalPatches(
Brian Harring609dc4e2012-05-07 02:17:44 -07001470 options.sourceroot, options.local_patches)
Brian Harring1d7ba942012-04-24 06:37:18 -07001471
1472 default = os.environ.get('CBUILDBOT_DEFAULT_MODE')
1473 if (default and not any([options.local, options.buildbot,
1474 options.remote, options.remote_trybot])):
Brian Harring1b8c4c82012-05-29 23:03:04 -07001475 cros_build_lib.Info("CBUILDBOT_DEFAULT_MODE=%s env var detected, using it."
1476 % default)
Brian Harring1d7ba942012-04-24 06:37:18 -07001477 default = default.lower()
1478 if default == 'local':
1479 options.local = True
1480 elif default == 'remote':
1481 options.remote = True
1482 elif default == 'buildbot':
1483 options.buildbot = True
1484 else:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001485 cros_build_lib.Die("CBUILDBOT_DEFAULT_MODE value %s isn't supported. "
1486 % default)
Ryan Cui85867972012-02-23 18:21:49 -08001487
Matt Tennant763497d2014-01-17 16:45:54 -08001488 # Ensure that all args are legitimate config targets.
Chris Sosa55cdc942014-04-16 13:08:37 -07001489 invalid_targets = []
Matt Tennant763497d2014-01-17 16:45:54 -08001490 for arg in args:
Matt Tennant2c192032014-01-16 13:49:28 -08001491 build_config = _GetConfig(arg)
Don Garrett4bb21682014-03-03 16:16:23 -08001492
Matt Tennant2c192032014-01-16 13:49:28 -08001493 if not build_config:
Chris Sosa55cdc942014-04-16 13:08:37 -07001494 invalid_targets.append(arg)
Matt Tennant763497d2014-01-17 16:45:54 -08001495 cros_build_lib.Error('No such configuraton target: "%s".', arg)
Don Garrett4bb21682014-03-03 16:16:23 -08001496 continue
1497
1498 if options.channels and build_config.build_type != constants.PAYLOADS_TYPE:
1499 cros_build_lib.Die('--channel must only be used with a payload config,'
1500 ' not target (%s).' % arg)
Matt Tennant763497d2014-01-17 16:45:54 -08001501
Matt Tennant2c192032014-01-16 13:49:28 -08001502 # The --version option is not compatible with an external target unless the
1503 # --buildbot option is specified. More correctly, only "paladin versions"
1504 # will work with external targets, and those are only used with --buildbot.
1505 # If --buildbot is specified, then user should know what they are doing and
1506 # only specify a version that will work. See crbug.com/311648.
Don Garrett4bb21682014-03-03 16:16:23 -08001507 if (options.force_version and
1508 not (options.buildbot or build_config.internal)):
1509 cros_build_lib.Die('Cannot specify --version without --buildbot for an'
1510 ' external target (%s).' % arg)
Matt Tennant2c192032014-01-16 13:49:28 -08001511
Chris Sosa55cdc942014-04-16 13:08:37 -07001512 if invalid_targets:
1513 cros_build_lib.Die('One or more invalid configuration targets specified. '
1514 'You can check the available configs by running '
1515 '`cbuildbot --list --all`')
Matt Tennant763497d2014-01-17 16:45:54 -08001516
Ryan Cui85867972012-02-23 18:21:49 -08001517
1518def _ParseCommandLine(parser, argv):
1519 """Completely parse the commandline arguments"""
Brian Harring3fec5a82012-03-01 05:57:03 -08001520 (options, args) = parser.parse_args(argv)
Brian Harring37e559b2012-05-22 20:47:32 -07001521
Matt Tennant763497d2014-01-17 16:45:54 -08001522 # Strip out null arguments.
1523 # TODO(rcui): Remove when buildbot is fixed
1524 args = [arg for arg in args if arg]
1525
1526 # A couple options, like --list, trigger a quick exit.
Brian Harring37e559b2012-05-22 20:47:32 -07001527 if options.output_api_version:
Ryan Cui724f1d32012-10-15 18:10:22 -07001528 print constants.REEXEC_API_VERSION
Brian Harring37e559b2012-05-22 20:47:32 -07001529 sys.exit(0)
1530
Ryan Cui54da0702012-04-19 18:38:08 -07001531 if options.list:
Matt Tennant763497d2014-01-17 16:45:54 -08001532 if args:
1533 cros_build_lib.Die('No arguments expected with the --list options.')
Ryan Cui54da0702012-04-19 18:38:08 -07001534 _PrintValidConfigs(options.print_all)
1535 sys.exit(0)
1536
Ryan Cui8be16062012-04-24 12:05:26 -07001537 if not args:
Matt Tennant763497d2014-01-17 16:45:54 -08001538 parser.error('Invalid usage: no configuration targets provided.'
1539 'Use -h to see usage. Use -l to list supported configs.')
Ryan Cui8be16062012-04-24 12:05:26 -07001540
Ryan Cui85867972012-02-23 18:21:49 -08001541 _FinishParsing(options, args)
1542 return options, args
1543
1544
Matt Tennant759e2352013-09-27 15:14:44 -07001545# TODO(build): This function is too damn long.
Ryan Cui85867972012-02-23 18:21:49 -08001546def main(argv):
David James59a0a2b2013-03-22 14:04:44 -07001547 # Turn on strict sudo checks.
1548 cros_build_lib.STRICT_SUDO = True
1549
Ryan Cui85867972012-02-23 18:21:49 -08001550 # Set umask to 022 so files created by buildbot are readable.
Mike Frysinger60ec1012013-10-21 00:11:10 -04001551 os.umask(0o22)
Ryan Cui85867972012-02-23 18:21:49 -08001552
Ryan Cui85867972012-02-23 18:21:49 -08001553 parser = _CreateParser()
1554 (options, args) = _ParseCommandLine(parser, argv)
Brian Harring3fec5a82012-03-01 05:57:03 -08001555
Brian Harringae0a5322012-09-15 01:46:51 -07001556 _PostParseCheck(parser, options, args)
Brian Harring3fec5a82012-03-01 05:57:03 -08001557
Mike Frysinger8fd67dc2012-12-03 23:51:18 -05001558 cros_build_lib.AssertOutsideChroot()
Zdenek Behan98ec2fb2012-08-31 17:12:18 +02001559
Brian Harring3fec5a82012-03-01 05:57:03 -08001560 if options.remote:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001561 cros_build_lib.logger.setLevel(logging.WARNING)
Ryan Cui16ca5812012-03-08 20:34:27 -08001562
Brian Harring3fec5a82012-03-01 05:57:03 -08001563 # Verify configs are valid.
Dan Shi0bdb7132013-07-30 16:22:12 -07001564 # If hwtest flag is enabled, post a warning that HWTest step may fail if the
1565 # specified board is not a released platform or it is a generic overlay.
Brian Harring3fec5a82012-03-01 05:57:03 -08001566 for bot in args:
Aviv Kesheta96a2a92013-02-05 17:21:51 -08001567 build_config = _GetConfig(bot)
1568 if options.hwtest:
Dan Shi0bdb7132013-07-30 16:22:12 -07001569 cros_build_lib.Warning(
1570 'If %s is not a released platform or it is a generic overlay, '
1571 'the HWTest step will most likely not run; please ask the lab '
1572 'team for help if this is unexpected.' % build_config['boards'])
Brian Harring3fec5a82012-03-01 05:57:03 -08001573
1574 # Verify gerrit patches are valid.
Ryan Cui16ca5812012-03-08 20:34:27 -08001575 print 'Verifying patches...'
Ryan Cuie1e4e662012-05-21 16:39:46 -07001576 patch_pool = AcquirePoolFromOptions(options)
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001577
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001578 # --debug need to be explicitly passed through for remote invocations.
1579 if options.buildbot and '--debug' not in options.pass_through_args:
1580 _ConfirmRemoteBuildbotRun()
1581
Ryan Cui16ca5812012-03-08 20:34:27 -08001582 print 'Submitting tryjob...'
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001583 tryjob = remote_try.RemoteTryJob(options, args, patch_pool.local_patches)
Ryan Cuia25d8eb2012-07-11 14:54:27 -07001584 tryjob.Submit(testjob=options.test_tryjob, dryrun=False)
Ryan Cui16ca5812012-03-08 20:34:27 -08001585 print 'Tryjob submitted!'
1586 print ('Go to %s to view the status of your job.'
Ryan Cui4906e1c2012-04-03 20:09:34 -07001587 % tryjob.GetTrybotWaterfallLink())
Brian Harring3fec5a82012-03-01 05:57:03 -08001588 sys.exit(0)
Matt Tennant759e2352013-09-27 15:14:44 -07001589
Ryan Cui54da0702012-04-19 18:38:08 -07001590 elif (not options.buildbot and not options.remote_trybot
1591 and not options.resume and not options.local):
Ryan Cui88b901c2013-06-21 11:35:30 -07001592 options.local = True
Brian Harring1b8c4c82012-05-29 23:03:04 -07001593 cros_build_lib.Warning(
1594 'Running in LOCAL TRYBOT mode! Use --remote to submit REMOTE '
1595 'tryjobs. Use --local to suppress this message.')
1596 cros_build_lib.Warning(
Ryan Cui51591352012-07-09 15:15:53 -07001597 'In the future, --local will be required to run the local '
Brian Harring1b8c4c82012-05-29 23:03:04 -07001598 'trybot.')
Ryan Cui54da0702012-04-19 18:38:08 -07001599 time.sleep(5)
Brian Harring3fec5a82012-03-01 05:57:03 -08001600
Matt Tennant759e2352013-09-27 15:14:44 -07001601 # Only one config arg is allowed in this mode, which was confirmed earlier.
Ryan Cui8be16062012-04-24 12:05:26 -07001602 bot_id = args[-1]
1603 build_config = _GetConfig(bot_id)
Brian Harring3fec5a82012-03-01 05:57:03 -08001604
David Jamesdac7a912013-11-18 11:14:44 -08001605 if options.reference_repo is None:
1606 repo_path = os.path.join(options.sourceroot, '.repo')
1607 # If we're being run from a repo checkout, reuse the repo's git pool to
1608 # cut down on sync time.
1609 if os.path.exists(repo_path):
1610 options.reference_repo = options.sourceroot
1611 elif options.reference_repo:
1612 if not os.path.exists(options.reference_repo):
1613 parser.error('Reference path %s does not exist'
1614 % (options.reference_repo,))
1615 elif not os.path.exists(os.path.join(options.reference_repo, '.repo')):
1616 parser.error('Reference path %s does not look to be the base of a '
1617 'repo checkout; no .repo exists in the root.'
1618 % (options.reference_repo,))
1619
Brian Harringf11bf682012-05-14 15:53:43 -07001620 if (options.buildbot or options.remote_trybot) and not options.resume:
Brian Harring470f6112012-03-02 11:47:10 -08001621 if not options.cgroups:
Ryan Cuid4a24212012-04-04 18:08:12 -07001622 parser.error('Options --buildbot/--remote-trybot and --nocgroups cannot '
1623 'be used together. Cgroup support is required for '
1624 'buildbot/remote-trybot mode.')
Mike Frysingera78a56e2012-11-20 06:02:30 -05001625 if not cgroups.Cgroup.IsSupported():
Ryan Cuid4a24212012-04-04 18:08:12 -07001626 parser.error('Option --buildbot/--remote-trybot was given, but this '
1627 'system does not support cgroups. Failing.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001628
David Jamesaad5cc72012-10-26 15:03:13 -07001629 missing = osutils.FindMissingBinaries(_BUILDBOT_REQUIRED_BINARIES)
Brian Harring351ce442012-03-09 16:38:14 -08001630 if missing:
Ryan Cuid4a24212012-04-04 18:08:12 -07001631 parser.error("Option --buildbot/--remote-trybot requires the following "
1632 "binaries which couldn't be found in $PATH: %s"
Brian Harring351ce442012-03-09 16:38:14 -08001633 % (', '.join(missing)))
1634
David Jamesdac7a912013-11-18 11:14:44 -08001635 if options.reference_repo:
1636 options.reference_repo = os.path.abspath(options.reference_repo)
1637
Brian Harring3fec5a82012-03-01 05:57:03 -08001638 if not options.buildroot:
1639 if options.buildbot:
Mike Frysinger6903c762012-12-04 01:57:16 -05001640 parser.error('Please specify a buildroot with the --buildbot option.')
Matt Tennantd55b1f42012-04-13 14:15:01 -07001641
Ryan Cui5ba7e152012-05-10 14:36:52 -07001642 options.buildroot = _DetermineDefaultBuildRoot(options.sourceroot,
1643 build_config['internal'])
Brian Harring470f6112012-03-02 11:47:10 -08001644 # We use a marker file in the buildroot to indicate the user has
1645 # consented to using this directory.
1646 if not os.path.exists(repository.GetTrybotMarkerPath(options.buildroot)):
1647 _ConfirmBuildRoot(options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -08001648
1649 # Sanity check of buildroot- specifically that it's not pointing into the
1650 # midst of an existing repo since git-repo doesn't support nesting.
Brian Harring3fec5a82012-03-01 05:57:03 -08001651 if (not repository.IsARepoRoot(options.buildroot) and
David James13a69c92013-05-09 10:37:42 -07001652 git.FindRepoDir(options.buildroot)):
Brian Harring3fec5a82012-03-01 05:57:03 -08001653 parser.error('Configured buildroot %s points into a repository checkout, '
1654 'rather than the root of it. This is not supported.'
1655 % options.buildroot)
1656
Chris Sosab5ea3b42012-10-25 15:25:20 -07001657 if not options.log_dir:
1658 options.log_dir = os.path.join(options.buildroot, _DEFAULT_LOG_DIR)
1659
Brian Harringd166aaf2012-05-14 18:31:53 -07001660 log_file = None
1661 if options.tee:
Chris Sosab5ea3b42012-10-25 15:25:20 -07001662 log_file = os.path.join(options.log_dir, _BUILDBOT_LOG_FILE)
1663 osutils.SafeMakedirs(options.log_dir)
Brian Harringd166aaf2012-05-14 18:31:53 -07001664 _BackupPreviousLog(log_file)
1665
Brian Harring1b8c4c82012-05-29 23:03:04 -07001666 with cros_build_lib.ContextManagerStack() as stack:
Aaron Gable881fccb2013-09-27 18:35:24 -07001667 # TODO(ferringb): update this once
1668 # https://chromium-review.googlesource.com/25359
David Jamescebc7272013-07-17 16:45:05 -07001669 # is landed- it's sensitive to the manifest-versions cache path.
1670 options.preserve_paths = set(['manifest-versions', '.cache',
1671 'manifest-versions-internal'])
1672 if log_file is not None:
1673 # We don't want the critical section to try to clean up the tee process,
1674 # so we run Tee (forked off) outside of it. This prevents a deadlock
1675 # because the Tee process only exits when its pipe is closed, and the
1676 # critical section accidentally holds on to that file handle.
1677 stack.Add(tee.Tee, log_file)
1678 options.preserve_paths.add(_DEFAULT_LOG_DIR)
1679
Brian Harringc2d09d92012-05-13 22:03:15 -07001680 critical_section = stack.Add(cleanup.EnforcedCleanupSection)
1681 stack.Add(sudo.SudoKeepAlive)
Brian Harringd166aaf2012-05-14 18:31:53 -07001682
Brian Harringc2d09d92012-05-13 22:03:15 -07001683 if not options.resume:
Brian Harring2bf55e12012-05-13 21:31:55 -07001684 # If we're in resume mode, use our parents tempdir rather than
1685 # nesting another layer.
David James4bc13702013-03-26 08:08:04 -07001686 stack.Add(osutils.TempDir, prefix='cbuildbot-tmp', set_global=True)
Brian Harringc2d09d92012-05-13 22:03:15 -07001687 logging.debug("Cbuildbot tempdir is %r.", os.environ.get('TMP'))
Brian Harringd166aaf2012-05-14 18:31:53 -07001688
Brian Harringc2d09d92012-05-13 22:03:15 -07001689 if options.cgroups:
1690 stack.Add(cgroups.SimpleContainChildren, 'cbuildbot')
Brian Harringa184efa2012-03-04 11:51:25 -08001691
Brian Harringc2d09d92012-05-13 22:03:15 -07001692 # Mark everything between EnforcedCleanupSection and here as having to
1693 # be rolled back via the contextmanager cleanup handlers. This
1694 # ensures that sudo bits cannot outlive cbuildbot, that anything
1695 # cgroups would kill gets killed, etc.
David Jamesfb3aac92013-10-16 13:26:52 -07001696 stack.Add(critical_section.ForkWatchdog)
Brian Harringd166aaf2012-05-14 18:31:53 -07001697
Brian Harringc2d09d92012-05-13 22:03:15 -07001698 if options.timeout > 0:
David James3432acd2013-11-27 10:02:18 -08001699 stack.Add(timeout_util.FatalTimeout, options.timeout)
Brian Harringa184efa2012-03-04 11:51:25 -08001700
Brian Harringc2d09d92012-05-13 22:03:15 -07001701 if not options.buildbot:
1702 build_config = cbuildbot_config.OverrideConfigForTrybot(
Don Garrett4bb21682014-03-03 16:16:23 -08001703 build_config, options)
Brian Harringc2d09d92012-05-13 22:03:15 -07001704
Aviv Kesheta0159be2013-12-12 13:56:28 -08001705 if options.mock_tree_status is not None:
1706 stack.Add(mock.patch.object, timeout_util, '_GetStatus',
1707 return_value=options.mock_tree_status)
1708
Aviv Keshetcf9c2722014-02-25 15:15:10 -08001709 if options.mock_slave_status is not None:
1710 with open(options.mock_slave_status, 'r') as f:
Aviv Keshet4e750022014-03-07 16:50:34 -08001711 mock_statuses = pickle.load(f)
1712 for key, value in mock_statuses.iteritems():
1713 mock_statuses[key] = manifest_version.BuilderStatus(**value)
Aviv Keshetcf9c2722014-02-25 15:15:10 -08001714 stack.Add(mock.patch.object, stages.MasterSlaveSyncCompletionStage,
Aviv Keshet4e750022014-03-07 16:50:34 -08001715 '_FetchSlaveStatuses', return_value=mock_statuses)
Aviv Keshetcf9c2722014-02-25 15:15:10 -08001716
Brian Harringc2d09d92012-05-13 22:03:15 -07001717 _RunBuildStagesWrapper(options, build_config)