blob: 8540095838e44cea5bbac7809faecbb370417dbe [file] [log] [blame]
Mike Frysingerd6925b52012-07-16 16:11:00 -04001# Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
Brian Harring3fec5a82012-03-01 05:57:03 -08002# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4
5"""Main builder code for Chromium OS.
6
7Used by Chromium OS buildbot configuration for all Chromium OS builds including
8full and pre-flight-queue builds.
9"""
10
Mike Frysinger383367e2014-09-16 15:06:17 -040011from __future__ import print_function
12
David James1fddb8f2013-04-25 15:23:07 -070013import collections
Brian Harring3fec5a82012-03-01 05:57:03 -080014import distutils.version
15import glob
Aviv Keshet669eb5e2014-06-23 08:53:01 -070016import json
Chris Sosa4f6ffaf2012-05-01 17:05:44 -070017import logging
Luis Lozanoe0505bd2013-11-08 17:45:48 -080018import multiprocessing
Brian Harring3fec5a82012-03-01 05:57:03 -080019import optparse
20import os
Aviv Keshetcf9c2722014-02-25 15:15:10 -080021import pickle
Brian Harring3fec5a82012-03-01 05:57:03 -080022import sys
Aviv Keshet669eb5e2014-06-23 08:53:01 -070023import tempfile
David James3541a132013-03-18 13:21:58 -070024import traceback
Brian Harring3fec5a82012-03-01 05:57:03 -080025
Luis Lozanoe0505bd2013-11-08 17:45:48 -080026from chromite.cbuildbot import afdo
Don Garrett88b8d782014-05-13 17:30:55 -070027from chromite.cbuildbot import cbuildbot_config
Don Garrett88b8d782014-05-13 17:30:55 -070028from chromite.cbuildbot import cbuildbot_run
29from chromite.cbuildbot import constants
Luis Lozanoe0505bd2013-11-08 17:45:48 -080030from chromite.cbuildbot import failures_lib
Don Garrett88b8d782014-05-13 17:30:55 -070031from chromite.cbuildbot import manifest_version
32from chromite.cbuildbot import remote_try
33from chromite.cbuildbot import repository
Luis Lozanoe0505bd2013-11-08 17:45:48 -080034from chromite.cbuildbot import results_lib
Don Garrett88b8d782014-05-13 17:30:55 -070035from chromite.cbuildbot import tee
36from chromite.cbuildbot import trybot_patch_pool
Luis Lozanoe0505bd2013-11-08 17:45:48 -080037from chromite.cbuildbot.stages import afdo_stages
Don Garrett88b8d782014-05-13 17:30:55 -070038from chromite.cbuildbot.stages import artifact_stages
39from chromite.cbuildbot.stages import branch_stages
40from chromite.cbuildbot.stages import build_stages
41from chromite.cbuildbot.stages import chrome_stages
42from chromite.cbuildbot.stages import completion_stages
43from chromite.cbuildbot.stages import generic_stages
44from chromite.cbuildbot.stages import release_stages
45from chromite.cbuildbot.stages import report_stages
46from chromite.cbuildbot.stages import sdk_stages
47from chromite.cbuildbot.stages import sync_stages
48from chromite.cbuildbot.stages import test_stages
Yu-Ju Hongd0fda382014-05-09 15:28:24 -070049
Brian Harring3fec5a82012-03-01 05:57:03 -080050
Aviv Keshet2982af52014-08-13 16:07:57 -070051from chromite.lib import cidb
Brian Harringc92a7012012-02-29 10:11:34 -080052from chromite.lib import cgroups
Brian Harringa184efa2012-03-04 11:51:25 -080053from chromite.lib import cleanup
Brian Harringb6cf9142012-09-01 20:43:17 -070054from chromite.lib import commandline
Brian Harring1b8c4c82012-05-29 23:03:04 -070055from chromite.lib import cros_build_lib
Brian Harring511055e2012-10-10 02:58:59 -070056from chromite.lib import gerrit
David James97d95872012-11-16 15:09:56 -080057from chromite.lib import git
Stefan Zagerd49d9ff2014-08-15 21:33:37 -070058from chromite.lib import gob_util
Brian Harringaf019fb2012-05-10 15:06:13 -070059from chromite.lib import osutils
Brian Harring511055e2012-10-10 02:58:59 -070060from chromite.lib import patch as cros_patch
David James6450a0a2012-12-04 07:59:53 -080061from chromite.lib import parallel
Don Garrettb4318362014-10-03 15:49:36 -070062from chromite.lib import retry_stats
Brian Harring3fec5a82012-03-01 05:57:03 -080063from chromite.lib import sudo
David James3432acd2013-11-27 10:02:18 -080064from chromite.lib import timeout_util
Brian Harring3fec5a82012-03-01 05:57:03 -080065
Aviv Kesheta0159be2013-12-12 13:56:28 -080066import mock
67
Ryan Cuiadd49122012-03-21 22:19:58 -070068
Brian Harring3fec5a82012-03-01 05:57:03 -080069_DEFAULT_LOG_DIR = 'cbuildbot_logs'
70_BUILDBOT_LOG_FILE = 'cbuildbot.log'
71_DEFAULT_EXT_BUILDROOT = 'trybot'
72_DEFAULT_INT_BUILDROOT = 'trybot-internal'
Brian Harring351ce442012-03-09 16:38:14 -080073_BUILDBOT_REQUIRED_BINARIES = ('pbzip2',)
Ryan Cui1c13a252012-10-16 15:00:16 -070074_API_VERSION_ATTR = 'api_version'
Brian Harring3fec5a82012-03-01 05:57:03 -080075
76
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070077def _PrintValidConfigs(display_all=False):
Brian Harring3fec5a82012-03-01 05:57:03 -080078 """Print a list of valid buildbot configs.
79
Mike Frysinger02e1e072013-11-10 22:11:34 -050080 Args:
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070081 display_all: Print all configs. Otherwise, prints only configs with
82 trybot_list=True.
Brian Harring3fec5a82012-03-01 05:57:03 -080083 """
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070084 def _GetSortKey(config_name):
85 config_dict = cbuildbot_config.config[config_name]
86 return (not config_dict['trybot_list'], config_dict['description'],
87 config_name)
88
Brian Harring3fec5a82012-03-01 05:57:03 -080089 COLUMN_WIDTH = 45
Mike Frysinger383367e2014-09-16 15:06:17 -040090 print()
91 print('config'.ljust(COLUMN_WIDTH), 'description')
92 print('------'.ljust(COLUMN_WIDTH), '-----------')
Brian Harring3fec5a82012-03-01 05:57:03 -080093 config_names = cbuildbot_config.config.keys()
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070094 config_names.sort(key=_GetSortKey)
Brian Harring3fec5a82012-03-01 05:57:03 -080095 for name in config_names:
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070096 if display_all or cbuildbot_config.config[name]['trybot_list']:
97 desc = cbuildbot_config.config[name].get('description')
98 desc = desc if desc else ''
Mike Frysinger383367e2014-09-16 15:06:17 -040099 print(name.ljust(COLUMN_WIDTH), desc)
Brian Harring3fec5a82012-03-01 05:57:03 -0800100
Mike Frysinger383367e2014-09-16 15:06:17 -0400101 print()
Matt Tennant763497d2014-01-17 16:45:54 -0800102
Brian Harring3fec5a82012-03-01 05:57:03 -0800103
104def _GetConfig(config_name):
Matt Tennant763497d2014-01-17 16:45:54 -0800105 """Gets the configuration for the build if it exists, None otherwise."""
106 if cbuildbot_config.config.has_key(config_name):
107 return cbuildbot_config.config[config_name]
Brian Harring3fec5a82012-03-01 05:57:03 -0800108
109
Ryan Cuie1e4e662012-05-21 16:39:46 -0700110def AcquirePoolFromOptions(options):
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700111 """Generate patch objects from passed in options.
Brian Harring3fec5a82012-03-01 05:57:03 -0800112
113 Args:
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700114 options: The options object generated by optparse.
Brian Harring3fec5a82012-03-01 05:57:03 -0800115
Ryan Cuif7f24692012-05-18 16:35:33 -0700116 Returns:
117 trybot_patch_pool.TrybotPatchPool object.
118
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700119 Raises:
Brian Harring511055e2012-10-10 02:58:59 -0700120 gerrit.GerritException, cros_patch.PatchException
Brian Harring3fec5a82012-03-01 05:57:03 -0800121 """
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700122 gerrit_patches = []
123 local_patches = []
124 remote_patches = []
Brian Harring3fec5a82012-03-01 05:57:03 -0800125
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700126 if options.gerrit_patches:
Brian Harring511055e2012-10-10 02:58:59 -0700127 gerrit_patches = gerrit.GetGerritPatchInfo(
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700128 options.gerrit_patches)
129 for patch in gerrit_patches:
130 if patch.IsAlreadyMerged():
Brian Harring1b8c4c82012-05-29 23:03:04 -0700131 cros_build_lib.Warning('Patch %s has already been merged.' % str(patch))
Brian Harring3fec5a82012-03-01 05:57:03 -0800132
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700133 if options.local_patches:
David James97d95872012-11-16 15:09:56 -0800134 manifest = git.ManifestCheckout.Cached(options.sourceroot)
Brian Harring609dc4e2012-05-07 02:17:44 -0700135 local_patches = cros_patch.PrepareLocalPatches(manifest,
136 options.local_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800137
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700138 if options.remote_patches:
139 remote_patches = cros_patch.PrepareRemotePatches(
140 options.remote_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800141
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700142 return trybot_patch_pool.TrybotPatchPool(gerrit_patches, local_patches,
143 remote_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800144
145
Brian Harring3fec5a82012-03-01 05:57:03 -0800146class Builder(object):
147 """Parent class for all builder types.
148
Matt Tennant759e2352013-09-27 15:14:44 -0700149 This class functions as an abstract parent class for various build types.
150 Its intended use is builder_instance.Run().
Brian Harring3fec5a82012-03-01 05:57:03 -0800151
Matt Tennant3f351552014-01-03 14:28:00 -0800152 Attributes:
153 _run: The BuilderRun object for this run.
154 archive_stages: Dict of BuildConfig keys to ArchiveStage values.
155 patch_pool: TrybotPatchPool.
Brian Harring3fec5a82012-03-01 05:57:03 -0800156 """
157
Matt Tennantefb59522013-10-18 13:49:28 -0700158 def __init__(self, builder_run):
Brian Harring3fec5a82012-03-01 05:57:03 -0800159 """Initializes instance variables. Must be called by all subclasses."""
Matt Tennantefb59522013-10-18 13:49:28 -0700160 self._run = builder_run
Brian Harring3fec5a82012-03-01 05:57:03 -0800161
Matt Tennantefb59522013-10-18 13:49:28 -0700162 if self._run.config.chromeos_official:
Brian Harring3fec5a82012-03-01 05:57:03 -0800163 os.environ['CHROMEOS_OFFICIAL'] = '1'
164
David James58e0c092012-03-04 20:31:12 -0800165 self.archive_stages = {}
Brian Harring76d1bf62012-06-01 13:52:48 -0700166 self.patch_pool = trybot_patch_pool.TrybotPatchPool()
David James5596d0e2014-03-14 06:40:41 -0700167 self._build_image_lock = multiprocessing.Lock()
Brian Harring3fec5a82012-03-01 05:57:03 -0800168
169 def Initialize(self):
170 """Runs through the initialization steps of an actual build."""
Matt Tennantefb59522013-10-18 13:49:28 -0700171 if self._run.options.resume:
172 results_lib.LoadCheckpoint(self._run.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800173
Aviv Keshet2982af52014-08-13 16:07:57 -0700174 self._RunStage(report_stages.BuildStartStage)
175
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700176 self._RunStage(build_stages.CleanUpStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800177
178 def _GetStageInstance(self, stage, *args, **kwargs):
Matt Tennant759e2352013-09-27 15:14:44 -0700179 """Helper function to get a stage instance given the args.
Brian Harring3fec5a82012-03-01 05:57:03 -0800180
Matt Tennantefb59522013-10-18 13:49:28 -0700181 Useful as almost all stages just take in builder_run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800182 """
Matt Tennantefb59522013-10-18 13:49:28 -0700183 # Normally the default BuilderRun (self._run) is used, but it can
184 # be overridden with "builder_run" kwargs (e.g. for child configs).
185 builder_run = kwargs.pop('builder_run', self._run)
186 return stage(builder_run, *args, **kwargs)
Brian Harring3fec5a82012-03-01 05:57:03 -0800187
188 def _SetReleaseTag(self):
Matt Tennant9c1c8492014-02-27 13:09:07 -0800189 """Sets run.attrs.release_tag from the manifest manager used in sync.
Brian Harring3fec5a82012-03-01 05:57:03 -0800190
Matt Tennantf4980ee2014-01-29 09:21:27 -0800191 Must be run after sync stage as syncing enables us to have a release tag,
192 and must be run before any usage of attrs.release_tag.
Matt Tennantefb59522013-10-18 13:49:28 -0700193
194 TODO(mtennant): Find a bottleneck place in syncing that can set this
Matt Tennantf4980ee2014-01-29 09:21:27 -0800195 directly. Be careful, as there are several kinds of syncing stages, and
196 sync stages have been known to abort with sys.exit calls.
Brian Harring3fec5a82012-03-01 05:57:03 -0800197 """
Matt Tennantefb59522013-10-18 13:49:28 -0700198 manifest_manager = getattr(self._run.attrs, 'manifest_manager', None)
Brian Harring3fec5a82012-03-01 05:57:03 -0800199 if manifest_manager:
Matt Tennantefb59522013-10-18 13:49:28 -0700200 self._run.attrs.release_tag = manifest_manager.current_version
Matt Tennant3f351552014-01-03 14:28:00 -0800201 else:
202 self._run.attrs.release_tag = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800203
Matt Tennanta42a5742014-02-09 13:42:12 -0800204 cros_build_lib.Debug('Saved release_tag value for run: %r',
205 self._run.attrs.release_tag)
206
Brian Harring3fec5a82012-03-01 05:57:03 -0800207 def _RunStage(self, stage, *args, **kwargs):
Matt Tennant759e2352013-09-27 15:14:44 -0700208 """Wrapper to run a stage.
209
210 Args:
211 stage: A BuilderStage class.
212 args: args to pass to stage constructor.
213 kwargs: kwargs to pass to stage constructor.
Mike Frysinger1a736a82013-12-12 01:50:59 -0500214
Matt Tennant759e2352013-09-27 15:14:44 -0700215 Returns:
Matt Tennant759e2352013-09-27 15:14:44 -0700216 Whatever the stage's Run method returns.
217 """
Brian Harring3fec5a82012-03-01 05:57:03 -0800218 stage_instance = self._GetStageInstance(stage, *args, **kwargs)
219 return stage_instance.Run()
220
David Jamese1c8ab62014-03-27 12:30:58 -0700221 @staticmethod
222 def _RunParallelStages(stage_objs):
223 """Run the specified stages in parallel.
224
225 Args:
226 stage_objs: BuilderStage objects.
227 """
228 steps = [stage.Run for stage in stage_objs]
229 try:
230 parallel.RunParallelSteps(steps)
231
232 except BaseException as ex:
233 # If a stage threw an exception, it might not have correctly reported
234 # results (e.g. because it was killed before it could report the
235 # results.) In this case, attribute the exception to any stages that
236 # didn't report back correctly (if any).
237 for stage in stage_objs:
238 for name in stage.GetStageNames():
239 if not results_lib.Results.StageHasResults(name):
240 results_lib.Results.Record(name, ex, str(ex))
241
242 raise
243
Matt Tennantf4980ee2014-01-29 09:21:27 -0800244 def _RunSyncStage(self, sync_instance):
245 """Run given |sync_instance| stage and be sure attrs.release_tag set."""
246 try:
247 sync_instance.Run()
248 finally:
249 self._SetReleaseTag()
250
Brian Harring3fec5a82012-03-01 05:57:03 -0800251 def GetSyncInstance(self):
252 """Returns an instance of a SyncStage that should be run.
253
254 Subclasses must override this method.
255 """
256 raise NotImplementedError()
257
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400258 def GetCompletionInstance(self):
Aviv Keshetf2746152013-11-26 10:42:46 -0800259 """Returns the MasterSlaveSyncCompletionStage for this build.
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400260
261 Subclasses may override this method.
262
Mike Frysinger02e1e072013-11-10 22:11:34 -0500263 Returns:
264 None
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400265 """
266 return None
267
Brian Harring3fec5a82012-03-01 05:57:03 -0800268 def RunStages(self):
269 """Subclasses must override this method. Runs the appropriate code."""
270 raise NotImplementedError()
271
Brian Harring3fec5a82012-03-01 05:57:03 -0800272 def _ReExecuteInBuildroot(self, sync_instance):
273 """Reexecutes self in buildroot and returns True if build succeeds.
274
275 This allows the buildbot code to test itself when changes are patched for
276 buildbot-related code. This is a no-op if the buildroot == buildroot
277 of the running chromite checkout.
278
279 Args:
Matt Tennant85348852014-01-10 15:16:02 -0800280 sync_instance: Instance of the sync stage that was run to sync.
Brian Harring3fec5a82012-03-01 05:57:03 -0800281
282 Returns:
283 True if the Build succeeded.
284 """
Matt Tennantefb59522013-10-18 13:49:28 -0700285 if not self._run.options.resume:
286 results_lib.WriteCheckpoint(self._run.options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800287
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700288 args = sync_stages.BootstrapStage.FilterArgsForTargetCbuildbot(
Matt Tennantefb59522013-10-18 13:49:28 -0700289 self._run.options.buildroot, constants.PATH_TO_CBUILDBOT,
290 self._run.options)
Brian Harring37e559b2012-05-22 20:47:32 -0700291
David James2333c182013-02-13 16:16:15 -0800292 # Specify a buildroot explicitly (just in case, for local trybot).
Brian Harring3fec5a82012-03-01 05:57:03 -0800293 # Suppress any timeout options given from the commandline in the
294 # invoked cbuildbot; our timeout will enforce it instead.
Ryan Cui1c13a252012-10-16 15:00:16 -0700295 args += ['--resume', '--timeout', '0', '--notee', '--nocgroups',
Matt Tennantefb59522013-10-18 13:49:28 -0700296 '--buildroot', os.path.abspath(self._run.options.buildroot)]
Brian Harringae0a5322012-09-15 01:46:51 -0700297
Matt Tennantefb59522013-10-18 13:49:28 -0700298 if hasattr(self._run.attrs, 'manifest_manager'):
299 # TODO(mtennant): Is this the same as self._run.attrs.release_tag?
300 ver = self._run.attrs.manifest_manager.current_version
Ryan Cui1c13a252012-10-16 15:00:16 -0700301 args += ['--version', ver]
Brian Harring3fec5a82012-03-01 05:57:03 -0800302
David Jamesf421c6d2013-04-11 15:37:57 -0700303 pool = getattr(sync_instance, 'pool', None)
304 if pool:
Matt Tennantefb59522013-10-18 13:49:28 -0700305 filename = os.path.join(self._run.options.buildroot,
306 'validation_pool.dump')
David Jamesf421c6d2013-04-11 15:37:57 -0700307 pool.Save(filename)
308 args += ['--validation_pool', filename]
Brian Harring3fec5a82012-03-01 05:57:03 -0800309
David Jamesac8c2a72013-02-13 18:44:33 -0800310 # Reset the cache dir so that the child will calculate it automatically.
Matt Tennantefb59522013-10-18 13:49:28 -0700311 if not self._run.options.cache_dir_specified:
David Jamesac8c2a72013-02-13 18:44:33 -0800312 commandline.BaseParser.ConfigureCacheDir(None)
313
Aviv Keshet669eb5e2014-06-23 08:53:01 -0700314 with tempfile.NamedTemporaryFile(prefix='metadata') as metadata_file:
315 metadata_file.write(self._run.attrs.metadata.GetJSON())
316 metadata_file.flush()
317 args += ['--metadata_dump', metadata_file.name]
318
319 # Re-run the command in the buildroot.
320 # Finally, be generous and give the invoked cbuildbot 30s to shutdown
321 # when something occurs. It should exit quicker, but the sigterm may
322 # hit while the system is particularly busy.
323 return_obj = cros_build_lib.RunCommand(
324 args, cwd=self._run.options.buildroot, error_code_ok=True,
325 kill_timeout=30)
326 return return_obj.returncode == 0
Brian Harring3fec5a82012-03-01 05:57:03 -0800327
Ryan Cuif7f24692012-05-18 16:35:33 -0700328 def _InitializeTrybotPatchPool(self):
329 """Generate patch pool from patches specified on the command line.
330
331 Do this only if we need to patch changes later on.
332 """
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700333 changes_stage = sync_stages.PatchChangesStage.StageNamePrefix()
Ryan Cuif7f24692012-05-18 16:35:33 -0700334 check_func = results_lib.Results.PreviouslyCompletedRecord
Matt Tennantefb59522013-10-18 13:49:28 -0700335 if not check_func(changes_stage) or self._run.options.bootstrap:
336 self.patch_pool = AcquirePoolFromOptions(self._run.options)
Ryan Cuif7f24692012-05-18 16:35:33 -0700337
338 def _GetBootstrapStage(self):
339 """Constructs and returns the BootStrapStage object.
340
341 We return None when there are no chromite patches to test, and
342 --test-bootstrap wasn't passed in.
343 """
344 stage = None
345 chromite_pool = self.patch_pool.Filter(project=constants.CHROMITE_PROJECT)
Gabe Blackc17aa8e2014-05-15 22:13:06 -0700346 if self._run.config.internal:
347 manifest_pool = self.patch_pool.FilterIntManifest()
348 else:
349 manifest_pool = self.patch_pool.FilterExtManifest()
David James97d95872012-11-16 15:09:56 -0800350 chromite_branch = git.GetChromiteTrackingBranch()
Matt Tennantefb59522013-10-18 13:49:28 -0700351 if (chromite_pool or manifest_pool or
352 self._run.options.test_bootstrap or
353 chromite_branch != self._run.options.branch):
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700354 stage = sync_stages.BootstrapStage(self._run, chromite_pool,
355 manifest_pool)
Ryan Cuif7f24692012-05-18 16:35:33 -0700356 return stage
357
Brian Harring3fec5a82012-03-01 05:57:03 -0800358 def Run(self):
Ryan Cuif7f24692012-05-18 16:35:33 -0700359 """Main runner for this builder class. Runs build and prints summary.
360
361 Returns:
362 Whether the build succeeded.
363 """
364 self._InitializeTrybotPatchPool()
365
Matt Tennantefb59522013-10-18 13:49:28 -0700366 if self._run.options.bootstrap:
Ryan Cuif7f24692012-05-18 16:35:33 -0700367 bootstrap_stage = self._GetBootstrapStage()
368 if bootstrap_stage:
369 # BootstrapStage blocks on re-execution of cbuildbot.
370 bootstrap_stage.Run()
371 return bootstrap_stage.returncode == 0
372
Brian Harring3fec5a82012-03-01 05:57:03 -0800373 print_report = True
David James3d4d3502012-04-09 15:12:06 -0700374 exception_thrown = False
Brian Harring3fec5a82012-03-01 05:57:03 -0800375 success = True
David James9ebb2a42013-08-13 20:29:57 -0700376 sync_instance = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800377 try:
378 self.Initialize()
379 sync_instance = self.GetSyncInstance()
Matt Tennantf4980ee2014-01-29 09:21:27 -0800380 self._RunSyncStage(sync_instance)
Brian Harring3fec5a82012-03-01 05:57:03 -0800381
Matt Tennantefb59522013-10-18 13:49:28 -0700382 if self._run.ShouldPatchAfterSync():
Ryan Cui88b901c2013-06-21 11:35:30 -0700383 # Filter out patches to manifest, since PatchChangesStage can't handle
384 # them. Manifest patches are patched in the BootstrapStage.
385 non_manifest_patches = self.patch_pool.FilterManifest(negate=True)
386 if non_manifest_patches:
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700387 self._RunStage(sync_stages.PatchChangesStage, non_manifest_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800388
Matt Tennantefb59522013-10-18 13:49:28 -0700389 if self._run.ShouldReexecAfterSync():
Brian Harring3fec5a82012-03-01 05:57:03 -0800390 print_report = False
391 success = self._ReExecuteInBuildroot(sync_instance)
392 else:
Aviv Keshet2982af52014-08-13 16:07:57 -0700393 self._RunStage(report_stages.BuildReexecutionFinishedStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800394 self.RunStages()
Matt Tennant759e2352013-09-27 15:14:44 -0700395
David James3541a132013-03-18 13:21:58 -0700396 except Exception as ex:
David James7fbf2d42012-07-14 18:23:49 -0700397 exception_thrown = True
David James3541a132013-03-18 13:21:58 -0700398 if results_lib.Results.BuildSucceededSoFar():
Yu-Ju Hongc7c53722014-06-18 09:00:14 -0700399 # If the build is marked as successful, but threw exceptions, that's a
400 # problem. Print the traceback for debugging.
401 if isinstance(ex, failures_lib.CompoundFailure):
Mike Frysinger383367e2014-09-16 15:06:17 -0400402 print(str(ex))
Yu-Ju Hongc7c53722014-06-18 09:00:14 -0700403
David James3541a132013-03-18 13:21:58 -0700404 traceback.print_exc(file=sys.stdout)
David James7fbf2d42012-07-14 18:23:49 -0700405 raise
Matt Tennant759e2352013-09-27 15:14:44 -0700406
Yu-Ju Hongc54d3342014-05-14 12:42:06 -0700407 if not (print_report and isinstance(ex, failures_lib.StepFailure)):
Yu-Ju Hongc7c53722014-06-18 09:00:14 -0700408 # If the failed build threw a non-StepFailure exception, we
409 # should raise it.
David James3541a132013-03-18 13:21:58 -0700410 raise
Matt Tennant759e2352013-09-27 15:14:44 -0700411
Brian Harring3fec5a82012-03-01 05:57:03 -0800412 finally:
413 if print_report:
Matt Tennantefb59522013-10-18 13:49:28 -0700414 results_lib.WriteCheckpoint(self._run.options.buildroot)
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400415 completion_instance = self.GetCompletionInstance()
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700416 self._RunStage(report_stages.ReportStage, sync_instance,
417 completion_instance)
Brian Harring3fec5a82012-03-01 05:57:03 -0800418 success = results_lib.Results.BuildSucceededSoFar()
David James3d4d3502012-04-09 15:12:06 -0700419 if exception_thrown and success:
420 success = False
David Jamesbb20ac82012-07-18 10:59:16 -0700421 cros_build_lib.PrintBuildbotStepWarnings()
Mike Frysinger383367e2014-09-16 15:06:17 -0400422 print("""\
David James3d4d3502012-04-09 15:12:06 -0700423Exception thrown, but all stages marked successful. This is an internal error,
Mike Frysinger383367e2014-09-16 15:06:17 -0400424because the stage that threw the exception should be marked as failing.""")
Brian Harring3fec5a82012-03-01 05:57:03 -0800425
426 return success
427
428
David James1fddb8f2013-04-25 15:23:07 -0700429BoardConfig = collections.namedtuple('BoardConfig', ['board', 'name'])
430
431
Brian Harring3fec5a82012-03-01 05:57:03 -0800432class SimpleBuilder(Builder):
433 """Builder that performs basic vetting operations."""
434
435 def GetSyncInstance(self):
436 """Sync to lkgm or TOT as necessary.
437
Mike Frysinger02e1e072013-11-10 22:11:34 -0500438 Returns:
439 The instance of the sync stage to run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800440 """
Matt Tennantefb59522013-10-18 13:49:28 -0700441 if self._run.options.force_version:
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700442 sync_stage = self._GetStageInstance(
443 sync_stages.ManifestVersionedSyncStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700444 elif self._run.config.use_lkgm:
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700445 sync_stage = self._GetStageInstance(sync_stages.LKGMSyncStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700446 elif self._run.config.use_chrome_lkgm:
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700447 sync_stage = self._GetStageInstance(chrome_stages.ChromeLKGMSyncStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800448 else:
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700449 sync_stage = self._GetStageInstance(sync_stages.SyncStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800450
451 return sync_stage
452
David Jamese1c8ab62014-03-27 12:30:58 -0700453 def _RunHWTests(self, builder_run, board):
454 """Run hwtest-related stages for the specified board.
Matt Tennant759e2352013-09-27 15:14:44 -0700455
456 Args:
David Jamese1c8ab62014-03-27 12:30:58 -0700457 builder_run: BuilderRun object for these background stages.
458 board: Board name.
Matt Tennant759e2352013-09-27 15:14:44 -0700459 """
David Jamese1c8ab62014-03-27 12:30:58 -0700460 # Upload HWTest artifacts first.
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700461 self._RunStage(artifact_stages.UploadTestArtifactsStage, board,
David Jamese1c8ab62014-03-27 12:30:58 -0700462 builder_run=builder_run)
Matt Tennant0940c382014-01-21 20:43:55 -0800463
J. Richard Barnette7ddc5102014-07-24 16:40:40 -0700464 parallel_stages = []
Matt Tennant759e2352013-09-27 15:14:44 -0700465
J. Richard Barnette7ddc5102014-07-24 16:40:40 -0700466 # We can not run hw tests without archiving the payloads.
467 if builder_run.options.archive:
468 for suite_config in builder_run.config.hw_tests:
469 stage_class = None
470 if suite_config.async:
471 stage_class = test_stages.ASyncHWTestStage
472 elif suite_config.suite == constants.HWTEST_AU_SUITE:
473 stage_class = test_stages.AUTestStage
J. Richard Barnette7ddc5102014-07-24 16:40:40 -0700474 else:
475 stage_class = test_stages.HWTestStage
J. Richard Barnette7ddc5102014-07-24 16:40:40 -0700476 if suite_config.blocking:
J. Richard Barnettefd67d4b2014-07-29 14:21:36 -0700477 self._RunStage(stage_class, board, suite_config,
478 builder_run=builder_run)
J. Richard Barnette7ddc5102014-07-24 16:40:40 -0700479 else:
J. Richard Barnettefd67d4b2014-07-29 14:21:36 -0700480 new_stage = self._GetStageInstance(stage_class, board,
481 suite_config,
482 builder_run=builder_run)
J. Richard Barnette7ddc5102014-07-24 16:40:40 -0700483 parallel_stages.append(new_stage)
484
485 self._RunParallelStages(parallel_stages)
David James4f2d8302013-03-19 06:35:58 -0700486
David Jamesb9e48a22014-07-15 21:26:02 -0700487 def _RunBackgroundStagesForBoardAndMarkAsSuccessful(self, builder_run, board):
488 """Run background board-specific stages for the specified board.
489
490 After finishing the build, mark it as successful.
491
492 Args:
493 builder_run: BuilderRun object for these background stages.
494 board: Board name.
495 """
496 self._RunBackgroundStagesForBoard(builder_run, board)
497 board_runattrs = builder_run.GetBoardRunAttrs(board)
498 board_runattrs.SetParallel('success', True)
499
David James5596d0e2014-03-14 06:40:41 -0700500 def _RunBackgroundStagesForBoard(self, builder_run, board):
Matt Tennant759e2352013-09-27 15:14:44 -0700501 """Run background board-specific stages for the specified board.
502
David Jamesb9e48a22014-07-15 21:26:02 -0700503 Used by _RunBackgroundStagesForBoardAndMarkAsSuccessful. Callers should use
504 that method instead.
505
Matt Tennant759e2352013-09-27 15:14:44 -0700506 Args:
Matt Tennantefb59522013-10-18 13:49:28 -0700507 builder_run: BuilderRun object for these background stages.
Matt Tennant759e2352013-09-27 15:14:44 -0700508 board: Board name.
Matt Tennant759e2352013-09-27 15:14:44 -0700509 """
Matt Tennantefb59522013-10-18 13:49:28 -0700510 config = builder_run.config
Matt Tennant066d9322014-01-28 10:37:48 -0800511
512 # TODO(mtennant): This is the last usage of self.archive_stages. We can
513 # kill it once we migrate its uses to BuilderRun so that none of the
514 # stages below need it as an argument.
Matt Tennantefb59522013-10-18 13:49:28 -0700515 archive_stage = self.archive_stages[BoardConfig(board, config.name)]
Luis Lozanoe0505bd2013-11-08 17:45:48 -0800516 if config.afdo_generate_min:
Ahmad Sharifa2db40a2013-07-22 13:51:52 -0400517 self._RunParallelStages([archive_stage])
David James1fddb8f2013-04-25 15:23:07 -0700518 return
Matt Tennant759e2352013-09-27 15:14:44 -0700519
Don Garrett655acb52014-05-21 17:10:06 -0700520 # paygen can't complete without push_image.
521 assert not config.paygen or config.push_image
David James5596d0e2014-03-14 06:40:41 -0700522
523 if config.build_packages_in_background:
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700524 self._RunStage(build_stages.BuildPackagesStage, board,
Gabe Black472b25e2014-08-18 19:48:47 -0700525 update_metadata=True, builder_run=builder_run,
526 afdo_use=config.afdo_use)
David James5596d0e2014-03-14 06:40:41 -0700527
528 if builder_run.config.compilecheck or builder_run.options.compilecheck:
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700529 self._RunStage(test_stages.UnitTestStage, board,
Matt Tennantefb59522013-10-18 13:49:28 -0700530 builder_run=builder_run)
David James565bc9a2013-04-08 14:54:45 -0700531 return
Matt Tennant759e2352013-09-27 15:14:44 -0700532
David James5596d0e2014-03-14 06:40:41 -0700533 # Build the image first before doing anything else.
534 # TODO(davidjames): Remove this lock once http://crbug.com/352994 is fixed.
535 with self._build_image_lock:
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700536 self._RunStage(build_stages.BuildImageStage, board,
Luis Lozanoe0505bd2013-11-08 17:45:48 -0800537 builder_run=builder_run, afdo_use=config.afdo_use)
Don Garrett82c0ae82014-02-03 18:25:11 -0800538
Mike Frysinger31ac04f2013-11-10 21:07:48 -0500539 # While this stage list is run in parallel, the order here dictates the
540 # order that things will be shown in the log. So group things together
541 # that make sense when read in order. Also keep in mind that, since we
542 # gather output manually, early slow stages will prevent any output from
543 # later stages showing up until it finishes.
Ryan Cui3ea98e02013-08-07 16:01:48 -0700544 stage_list = []
Matt Tennantefb59522013-10-18 13:49:28 -0700545 if builder_run.options.chrome_sdk and config.chrome_sdk:
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700546 stage_list.append([chrome_stages.ChromeSDKStage, board])
David James064e7e02014-04-23 17:06:16 -0700547
548 if config.vm_test_runs > 1:
549 # Run the VMTests multiple times to see if they fail.
550 stage_list += [
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700551 [generic_stages.RepeatStage, config.vm_test_runs,
552 test_stages.VMTestStage, board]]
David James064e7e02014-04-23 17:06:16 -0700553 else:
554 # Give the VMTests one retry attempt in case failures are flaky.
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700555 stage_list += [[generic_stages.RetryStage, 1, test_stages.VMTestStage,
556 board]]
David James064e7e02014-04-23 17:06:16 -0700557
Luis Lozanoe0505bd2013-11-08 17:45:48 -0800558 if config.afdo_generate:
559 stage_list += [[afdo_stages.AFDODataGenerateStage, board]]
560
David James6b704242013-10-18 14:51:37 -0700561 stage_list += [
Don Garrettbe60b892014-05-20 17:11:45 -0700562 [release_stages.SignerTestStage, board, archive_stage],
Yu-Ju Hong251646c2014-08-18 15:42:45 -0700563 [release_stages.PaygenStage, board, archive_stage],
Nam T. Nguyenf3816362014-06-13 09:26:27 -0700564 [test_stages.ImageTestStage, board],
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700565 [test_stages.UnitTestStage, board],
566 [artifact_stages.UploadPrebuiltsStage, board],
567 [artifact_stages.DevInstallerPrebuiltsStage, board],
568 [artifact_stages.DebugSymbolsStage, board],
569 [artifact_stages.CPEExportStage, board],
David James6b704242013-10-18 14:51:37 -0700570 ]
Brian Harring3fec5a82012-03-01 05:57:03 -0800571
Matt Tennantefb59522013-10-18 13:49:28 -0700572 stage_objs = [self._GetStageInstance(*x, builder_run=builder_run)
573 for x in stage_list]
David Jamese1c8ab62014-03-27 12:30:58 -0700574
575 parallel.RunParallelSteps([
576 lambda: self._RunParallelStages(stage_objs + [archive_stage]),
577 lambda: self._RunHWTests(builder_run, board),
578 ])
Brian Harring3fec5a82012-03-01 05:57:03 -0800579
David James3b4bacf2014-02-19 17:25:15 -0800580 def _RunSetupBoard(self):
581 """Run the SetupBoard stage for all child configs and boards."""
582 for builder_run in self._run.GetUngroupedBuilderRuns():
583 for board in builder_run.config.boards:
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700584 self._RunStage(build_stages.SetupBoardStage, board,
585 builder_run=builder_run)
David James3b4bacf2014-02-19 17:25:15 -0800586
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400587 def _RunChrootBuilderTypeBuild(self):
588 """Runs through stages of a CHROOT_BUILDER_TYPE build."""
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700589 self._RunStage(build_stages.UprevStage, boards=[], enter_chroot=False)
590 self._RunStage(build_stages.InitSDKStage)
591 self._RunStage(build_stages.SetupBoardStage, constants.CHROOT_BUILDER_BOARD)
592 self._RunStage(chrome_stages.SyncChromeStage)
593 self._RunStage(chrome_stages.PatchChromeStage)
594 self._RunStage(sdk_stages.SDKPackageStage)
595 self._RunStage(sdk_stages.SDKTestStage)
596 self._RunStage(artifact_stages.UploadPrebuiltsStage,
597 constants.CHROOT_BUILDER_BOARD)
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400598
599 def _RunRefreshPackagesTypeBuild(self):
600 """Runs through the stages of a REFRESH_PACKAGES_TYPE build."""
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700601 self._RunStage(build_stages.InitSDKStage)
David James3b4bacf2014-02-19 17:25:15 -0800602 self._RunSetupBoard()
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700603 self._RunStage(report_stages.RefreshPackageStatusStage)
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400604
Yu-Ju Hongcbdb0612014-07-25 16:20:48 -0700605 def _RunMasterPaladinOrChromePFQBuild(self):
606 """Runs through the stages of the paladin or chrome PFQ master build."""
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700607 self._RunStage(build_stages.InitSDKStage)
608 self._RunStage(build_stages.UprevStage)
Yu-Ju Hongcbdb0612014-07-25 16:20:48 -0700609 # The CQ/Chrome PFQ master will not actually run the SyncChrome stage, but
Matt Tennant9c1c8492014-02-27 13:09:07 -0800610 # we want the logic that gets triggered when SyncChrome stage is skipped.
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700611 self._RunStage(chrome_stages.SyncChromeStage)
612 self._RunStage(artifact_stages.MasterUploadPrebuiltsStage)
Matt Tennante8179042013-10-01 15:47:32 -0700613
Don Garrett4bb21682014-03-03 16:16:23 -0800614 def _RunPayloadsBuild(self):
615 """Run the PaygenStage once for each board."""
616 def _RunStageWrapper(board):
Don Garrettbe60b892014-05-20 17:11:45 -0700617 self._RunStage(release_stages.PaygenStage, board=board,
Don Garrett4bb21682014-03-03 16:16:23 -0800618 channels=self._run.options.channels, archive_stage=None)
619
620 with parallel.BackgroundTaskRunner(_RunStageWrapper) as queue:
621 for board in self._run.config.boards:
622 queue.put([board])
623
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400624 def _RunDefaultTypeBuild(self):
625 """Runs through the stages of a non-special-type build."""
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700626 self._RunStage(build_stages.InitSDKStage)
627 self._RunStage(build_stages.UprevStage)
David James3b4bacf2014-02-19 17:25:15 -0800628 self._RunSetupBoard()
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700629 self._RunStage(chrome_stages.SyncChromeStage)
630 self._RunStage(chrome_stages.PatchChromeStage)
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400631
Matt Tennantefb59522013-10-18 13:49:28 -0700632 # Prepare stages to run in background. If child_configs exist then
633 # run each of those here, otherwise use default config.
Matt Tennant950c6cb2014-01-10 16:45:03 -0800634 builder_runs = self._run.GetUngroupedBuilderRuns()
Matt Tennantefb59522013-10-18 13:49:28 -0700635
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400636 tasks = []
Matt Tennantefb59522013-10-18 13:49:28 -0700637 for builder_run in builder_runs:
Matt Tennanta42a5742014-02-09 13:42:12 -0800638 # Prepare a local archive directory for each "run".
639 builder_run.GetArchive().SetupArchivePath()
640
Matt Tennantefb59522013-10-18 13:49:28 -0700641 for board in builder_run.config.boards:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400642 archive_stage = self._GetStageInstance(
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700643 artifact_stages.ArchiveStage, board, builder_run=builder_run,
Matt Tennant85348852014-01-10 15:16:02 -0800644 chrome_version=self._run.attrs.chrome_version)
Matt Tennantefb59522013-10-18 13:49:28 -0700645 board_config = BoardConfig(board, builder_run.config.name)
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400646 self.archive_stages[board_config] = archive_stage
David James8281b6e2014-03-27 11:46:56 -0700647 tasks.append((builder_run, board))
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400648
649 # Set up a process pool to run test/archive stages in the background.
David Jamesed8349b2014-03-01 11:27:04 -0800650 # This process runs task(board) for each board added to the queue.
David Jamesb9e48a22014-07-15 21:26:02 -0700651 task_runner = self._RunBackgroundStagesForBoardAndMarkAsSuccessful
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400652 with parallel.BackgroundTaskRunner(task_runner) as queue:
David James8281b6e2014-03-27 11:46:56 -0700653 for builder_run, board in tasks:
David James5596d0e2014-03-14 06:40:41 -0700654 if not builder_run.config.build_packages_in_background:
Luis Lozanoe0505bd2013-11-08 17:45:48 -0800655 # Run BuildPackages in the foreground, generating or using AFDO data
David James5596d0e2014-03-14 06:40:41 -0700656 # if requested.
David James8281b6e2014-03-27 11:46:56 -0700657 kwargs = {'builder_run': builder_run}
Luis Lozanoe0505bd2013-11-08 17:45:48 -0800658 if builder_run.config.afdo_generate_min:
659 kwargs['afdo_generate_min'] = True
660 elif builder_run.config.afdo_use:
661 kwargs['afdo_use'] = True
David Jamesed8349b2014-03-01 11:27:04 -0800662
Gabe Black472b25e2014-08-18 19:48:47 -0700663 self._RunStage(build_stages.BuildPackagesStage, board,
664 update_metadata=True, **kwargs)
David Jamesed8349b2014-03-01 11:27:04 -0800665
Luis Lozanoe0505bd2013-11-08 17:45:48 -0800666 if (builder_run.config.afdo_generate_min and
667 afdo.CanGenerateAFDOData(board)):
668 # Generate the AFDO data before allowing any other tasks to run.
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700669 self._RunStage(build_stages.BuildImageStage, board, **kwargs)
670 self._RunStage(artifact_stages.UploadTestArtifactsStage, board,
Luis Lozanoe0505bd2013-11-08 17:45:48 -0800671 builder_run=builder_run,
672 suffix='[afdo_generate_min]')
673 suite = cbuildbot_config.AFDORecordTest()
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700674 self._RunStage(test_stages.HWTestStage, board, suite,
David Jamesed8349b2014-03-01 11:27:04 -0800675 builder_run=builder_run)
Luis Lozanoe0505bd2013-11-08 17:45:48 -0800676 self._RunStage(afdo_stages.AFDODataGenerateStage, board,
677 builder_run=builder_run)
678
679 if (builder_run.config.afdo_generate_min and
680 builder_run.config.afdo_update_ebuild):
681 self._RunStage(afdo_stages.AFDOUpdateEbuildStage,
682 builder_run=builder_run)
David Jamesed8349b2014-03-01 11:27:04 -0800683
684 # Kick off our background stages.
David James5596d0e2014-03-14 06:40:41 -0700685 queue.put([builder_run, board])
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400686
Brian Harring3fec5a82012-03-01 05:57:03 -0800687 def RunStages(self):
688 """Runs through build process."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800689 # TODO(sosa): Split these out into classes.
Matt Tennantefb59522013-10-18 13:49:28 -0700690 if self._run.config.build_type == constants.PRE_CQ_LAUNCHER_TYPE:
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700691 self._RunStage(sync_stages.PreCQLauncherStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700692 elif self._run.config.build_type == constants.CREATE_BRANCH_TYPE:
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700693 self._RunStage(branch_stages.BranchUtilStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700694 elif self._run.config.build_type == constants.CHROOT_BUILDER_TYPE:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400695 self._RunChrootBuilderTypeBuild()
Matt Tennantefb59522013-10-18 13:49:28 -0700696 elif self._run.config.build_type == constants.REFRESH_PACKAGES_TYPE:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400697 self._RunRefreshPackagesTypeBuild()
Yu-Ju Hongcbdb0612014-07-25 16:20:48 -0700698 elif ((self._run.config.build_type == constants.PALADIN_TYPE or
699 self._run.config.build_type == constants.CHROME_PFQ_TYPE) and
Matt Tennante8179042013-10-01 15:47:32 -0700700 self._run.config.master):
Yu-Ju Hongcbdb0612014-07-25 16:20:48 -0700701 self._RunMasterPaladinOrChromePFQBuild()
Don Garrett4bb21682014-03-03 16:16:23 -0800702 elif self._run.config.build_type == constants.PAYLOADS_TYPE:
703 self._RunPayloadsBuild()
Brian Harring3fec5a82012-03-01 05:57:03 -0800704 else:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400705 self._RunDefaultTypeBuild()
David James58e0c092012-03-04 20:31:12 -0800706
Brian Harring3fec5a82012-03-01 05:57:03 -0800707
708class DistributedBuilder(SimpleBuilder):
709 """Build class that has special logic to handle distributed builds.
710
711 These builds sync using git/manifest logic in manifest_versions. In general
712 they use a non-distributed builder code for the bulk of the work.
713 """
David Jameseecba232014-06-11 11:35:11 -0700714
Ryan Cuif7f24692012-05-18 16:35:33 -0700715 def __init__(self, *args, **kwargs):
Brian Harring3fec5a82012-03-01 05:57:03 -0800716 """Initializes a buildbot builder.
717
718 Extra variables:
719 completion_stage_class: Stage used to complete a build. Set in the Sync
720 stage.
721 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700722 super(DistributedBuilder, self).__init__(*args, **kwargs)
Brian Harring3fec5a82012-03-01 05:57:03 -0800723 self.completion_stage_class = None
David Jamesf421c6d2013-04-11 15:37:57 -0700724 self.sync_stage = None
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400725 self._completion_stage = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800726
727 def GetSyncInstance(self):
728 """Syncs the tree using one of the distributed sync logic paths.
729
Mike Frysinger02e1e072013-11-10 22:11:34 -0500730 Returns:
731 The instance of the sync stage to run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800732 """
733 # Determine sync class to use. CQ overrides PFQ bits so should check it
734 # first.
Matt Tennantefb59522013-10-18 13:49:28 -0700735 if self._run.config.pre_cq or self._run.options.pre_cq:
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700736 sync_stage = self._GetStageInstance(sync_stages.PreCQSyncStage,
David Jamesf421c6d2013-04-11 15:37:57 -0700737 self.patch_pool.gerrit_patches)
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700738 self.completion_stage_class = completion_stages.PreCQCompletionStage
David Jamesf421c6d2013-04-11 15:37:57 -0700739 self.patch_pool.gerrit_patches = []
Matt Tennantefb59522013-10-18 13:49:28 -0700740 elif cbuildbot_config.IsCQType(self._run.config.build_type):
741 if self._run.config.do_not_apply_cq_patches:
Yu-Ju Hong78a41072014-07-30 16:55:36 -0700742 sync_stage = self._GetStageInstance(
743 sync_stages.MasterSlaveLKGMSyncStage)
Aviv Keshet00bc9512013-11-25 14:58:47 -0800744 else:
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700745 sync_stage = self._GetStageInstance(sync_stages.CommitQueueSyncStage)
746 self.completion_stage_class = completion_stages.CommitQueueCompletionStage
Matt Tennantefb59522013-10-18 13:49:28 -0700747 elif cbuildbot_config.IsPFQType(self._run.config.build_type):
Yu-Ju Hong78a41072014-07-30 16:55:36 -0700748 sync_stage = self._GetStageInstance(sync_stages.MasterSlaveLKGMSyncStage)
749 self.completion_stage_class = (
750 completion_stages.MasterSlaveSyncCompletionStage)
751 elif cbuildbot_config.IsCanaryType(self._run.config.build_type):
752 sync_stage = self._GetStageInstance(
753 sync_stages.ManifestVersionedSyncStage)
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700754 self.completion_stage_class = (
Yu-Ju Hong065807f2014-08-07 12:18:38 -0700755 completion_stages.CanaryCompletionStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800756 else:
Yu-Ju Hongd0fda382014-05-09 15:28:24 -0700757 sync_stage = self._GetStageInstance(
758 sync_stages.ManifestVersionedSyncStage)
759 self.completion_stage_class = (
760 completion_stages.ManifestVersionedSyncCompletionStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800761
David Jamesf421c6d2013-04-11 15:37:57 -0700762 self.sync_stage = sync_stage
763 return self.sync_stage
Brian Harring3fec5a82012-03-01 05:57:03 -0800764
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400765 def GetCompletionInstance(self):
766 """Returns the completion_stage_class instance that was used for this build.
767
Mike Frysinger1a736a82013-12-12 01:50:59 -0500768 Returns:
769 None if the completion_stage instance was not yet created (this
770 occurs during Publish).
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400771 """
772 return self._completion_stage
773
David James0825d5d2014-08-07 19:53:45 -0700774 def Publish(self, was_build_successful, build_finished):
775 """Completes build by publishing any required information.
776
777 Args:
778 was_build_successful: Whether the build succeeded.
779 build_finished: Whether the build completed. A build can be successful
780 without completing if it exits early with sys.exit(0).
781 """
Brian Harring3fec5a82012-03-01 05:57:03 -0800782 completion_stage = self._GetStageInstance(self.completion_stage_class,
David Jamesf421c6d2013-04-11 15:37:57 -0700783 self.sync_stage,
Brian Harring3fec5a82012-03-01 05:57:03 -0800784 was_build_successful)
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400785 self._completion_stage = completion_stage
David James11fd7e82013-10-23 20:02:16 -0700786 completion_successful = False
787 try:
788 completion_stage.Run()
789 completion_successful = True
Luis Lozanoe0505bd2013-11-08 17:45:48 -0800790 if (self._run.config.afdo_update_ebuild and
791 not self._run.config.afdo_generate_min):
792 self._RunStage(afdo_stages.AFDOUpdateEbuildStage)
David James11fd7e82013-10-23 20:02:16 -0700793 finally:
Matt Tennantefb59522013-10-18 13:49:28 -0700794 if self._run.config.push_overlays:
David James0825d5d2014-08-07 19:53:45 -0700795 publish = (was_build_successful and completion_successful and
796 build_finished)
797 self._RunStage(completion_stages.PublishUprevChangesStage, publish)
Brian Harring3fec5a82012-03-01 05:57:03 -0800798
799 def RunStages(self):
800 """Runs simple builder logic and publishes information to overlays."""
801 was_build_successful = False
David James0825d5d2014-08-07 19:53:45 -0700802 build_finished = False
David James843ed252013-09-11 16:18:10 -0700803 try:
804 super(DistributedBuilder, self).RunStages()
805 was_build_successful = results_lib.Results.BuildSucceededSoFar()
David James0825d5d2014-08-07 19:53:45 -0700806 build_finished = True
David James843ed252013-09-11 16:18:10 -0700807 except SystemExit as ex:
808 # If a stage calls sys.exit(0), it's exiting with success, so that means
809 # we should mark ourselves as successful.
David James0825d5d2014-08-07 19:53:45 -0700810 cros_build_lib.Info('Detected sys.exit(%s)', ex.code)
David James843ed252013-09-11 16:18:10 -0700811 if ex.code == 0:
812 was_build_successful = True
813 raise
814 finally:
David James0825d5d2014-08-07 19:53:45 -0700815 self.Publish(was_build_successful, build_finished)
Brian Harring3fec5a82012-03-01 05:57:03 -0800816
Brian Harring3fec5a82012-03-01 05:57:03 -0800817
818def _ConfirmBuildRoot(buildroot):
819 """Confirm with user the inferred buildroot, and mark it as confirmed."""
Brian Harring521e7242012-11-01 16:57:42 -0700820 cros_build_lib.Warning('Using default directory %s as buildroot', buildroot)
821 if not cros_build_lib.BooleanPrompt(default=False):
822 print('Please specify a different buildroot via the --buildroot option.')
Brian Harring3fec5a82012-03-01 05:57:03 -0800823 sys.exit(0)
824
825 if not os.path.exists(buildroot):
826 os.mkdir(buildroot)
827
828 repository.CreateTrybotMarker(buildroot)
829
830
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700831def _ConfirmRemoteBuildbotRun():
832 """Confirm user wants to run with --buildbot --remote."""
Brian Harring521e7242012-11-01 16:57:42 -0700833 cros_build_lib.Warning(
David Jameseecba232014-06-11 11:35:11 -0700834 'You are about to launch a PRODUCTION job! This is *NOT* a '
835 'trybot run! Are you sure?')
Brian Harring521e7242012-11-01 16:57:42 -0700836 if not cros_build_lib.BooleanPrompt(default=False):
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700837 print('Please specify --pass-through="--debug".')
838 sys.exit(0)
839
840
Ryan Cui5ba7e152012-05-10 14:36:52 -0700841def _DetermineDefaultBuildRoot(sourceroot, internal_build):
Brian Harring3fec5a82012-03-01 05:57:03 -0800842 """Default buildroot to be under the directory that contains current checkout.
843
Mike Frysinger02e1e072013-11-10 22:11:34 -0500844 Args:
Brian Harring3fec5a82012-03-01 05:57:03 -0800845 internal_build: Whether the build is an internal build
Ryan Cui5ba7e152012-05-10 14:36:52 -0700846 sourceroot: Use specified sourceroot.
Brian Harring3fec5a82012-03-01 05:57:03 -0800847 """
Ryan Cui5ba7e152012-05-10 14:36:52 -0700848 if not repository.IsARepoRoot(sourceroot):
Brian Harring1b8c4c82012-05-29 23:03:04 -0700849 cros_build_lib.Die(
850 'Could not find root of local checkout at %s. Please specify '
851 'using the --sourceroot option.' % sourceroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800852
853 # Place trybot buildroot under the directory containing current checkout.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700854 top_level = os.path.dirname(os.path.realpath(sourceroot))
Brian Harring3fec5a82012-03-01 05:57:03 -0800855 if internal_build:
856 buildroot = os.path.join(top_level, _DEFAULT_INT_BUILDROOT)
857 else:
858 buildroot = os.path.join(top_level, _DEFAULT_EXT_BUILDROOT)
859
860 return buildroot
861
862
863def _BackupPreviousLog(log_file, backup_limit=25):
864 """Rename previous log.
865
866 Args:
867 log_file: The absolute path to the previous log.
Aviv Keshet9e4236b2013-12-13 13:07:50 -0800868 backup_limit: Maximum number of old logs to keep.
Brian Harring3fec5a82012-03-01 05:57:03 -0800869 """
870 if os.path.exists(log_file):
871 old_logs = sorted(glob.glob(log_file + '.*'),
872 key=distutils.version.LooseVersion)
873
874 if len(old_logs) >= backup_limit:
875 os.remove(old_logs[0])
876
877 last = 0
878 if old_logs:
879 last = int(old_logs.pop().rpartition('.')[2])
880
881 os.rename(log_file, log_file + '.' + str(last + 1))
882
Ryan Cui5616a512012-08-17 13:39:36 -0700883
Gaurav Shah298aa372014-01-31 09:27:24 -0800884def _IsDistributedBuilder(options, chrome_rev, build_config):
885 """Determines whether the builder should be a DistributedBuilder.
886
887 Args:
888 options: options passed on the commandline.
889 chrome_rev: Chrome revision to build.
890 build_config: Builder configuration dictionary.
891
892 Returns:
893 True if the builder should be a distributed_builder
894 """
895 if build_config['pre_cq'] or options.pre_cq:
896 return True
897 elif not options.buildbot:
898 return False
899 elif chrome_rev in (constants.CHROME_REV_TOT,
900 constants.CHROME_REV_LOCAL,
901 constants.CHROME_REV_SPEC):
902 # We don't do distributed logic to TOT Chrome PFQ's, nor local
903 # chrome roots (e.g. chrome try bots)
904 # TODO(davidjames): Update any builders that rely on this logic to use
905 # manifest_version=False instead.
906 return False
907 elif build_config['manifest_version']:
908 return True
909
910 return False
911
912
David James944a48e2012-03-07 12:19:03 -0800913def _RunBuildStagesWrapper(options, build_config):
Brian Harring3fec5a82012-03-01 05:57:03 -0800914 """Helper function that wraps RunBuildStages()."""
Matt Tennant7feda352013-12-20 14:03:40 -0800915 cros_build_lib.Info('cbuildbot was executed with args %s' %
916 cros_build_lib.CmdToStr(sys.argv))
Brian Harring3fec5a82012-03-01 05:57:03 -0800917
David Jamesa0a664e2013-02-13 09:52:01 -0800918 chrome_rev = build_config['chrome_rev']
919 if options.chrome_rev:
920 chrome_rev = options.chrome_rev
921 if chrome_rev == constants.CHROME_REV_TOT:
Stefan Zagerd49d9ff2014-08-15 21:33:37 -0700922 options.chrome_version = gob_util.GetTipOfTrunkRevision(
923 constants.CHROMIUM_GOB_URL)
David Jamesa0a664e2013-02-13 09:52:01 -0800924 options.chrome_rev = constants.CHROME_REV_SPEC
925
David James4a404a52013-02-19 13:07:59 -0800926 # If it's likely we'll need to build Chrome, fetch the source.
Mike Frysingerf4d9ab82013-03-05 19:38:05 -0500927 if build_config['sync_chrome'] is None:
David Jameseecba232014-06-11 11:35:11 -0700928 options.managed_chrome = (
929 chrome_rev != constants.CHROME_REV_LOCAL and
Mike Frysingerf4d9ab82013-03-05 19:38:05 -0500930 (not build_config['usepkg_build_packages'] or chrome_rev or
David James3cce4642013-05-10 17:50:23 -0700931 build_config['profile'] or options.rietveld_patches))
Mike Frysingerf4d9ab82013-03-05 19:38:05 -0500932 else:
933 options.managed_chrome = build_config['sync_chrome']
David James2333c182013-02-13 16:16:15 -0800934
935 if options.managed_chrome:
936 # Tell Chrome to fetch the source locally.
Matt Tennant628ffdd2013-11-27 14:44:39 -0800937 internal = constants.USE_CHROME_INTERNAL in build_config['useflags']
David James2333c182013-02-13 16:16:15 -0800938 chrome_src = 'chrome-src-internal' if internal else 'chrome-src'
939 options.chrome_root = os.path.join(options.cache_dir, 'distfiles', 'target',
940 chrome_src)
David James9e27e662013-02-14 13:42:43 -0800941 elif options.rietveld_patches:
David James4a404a52013-02-19 13:07:59 -0800942 cros_build_lib.Die('This builder does not support Rietveld patches.')
David James2333c182013-02-13 16:16:15 -0800943
Aviv Keshet669eb5e2014-06-23 08:53:01 -0700944 metadata_dump_dict = {}
945 if options.metadata_dump:
946 with open(options.metadata_dump, 'r') as metadata_file:
947 metadata_dump_dict = json.loads(metadata_file.read())
948
Matt Tennant95a42ad2013-12-27 15:38:36 -0800949 # We are done munging options values, so freeze options object now to avoid
950 # further abuse of it.
951 # TODO(mtennant): one by one identify each options value override and see if
952 # it can be handled another way. Try to push this freeze closer and closer
953 # to the start of the script (e.g. in or after _PostParseCheck).
954 options.Freeze()
955
Matt Tennant0940c382014-01-21 20:43:55 -0800956 with parallel.Manager() as manager:
957 builder_run = cbuildbot_run.BuilderRun(options, build_config, manager)
Aviv Keshet669eb5e2014-06-23 08:53:01 -0700958 if metadata_dump_dict:
959 builder_run.attrs.metadata.UpdateWithDict(metadata_dump_dict)
Matt Tennant0940c382014-01-21 20:43:55 -0800960 if _IsDistributedBuilder(options, chrome_rev, build_config):
961 builder_cls = DistributedBuilder
962 else:
963 builder_cls = SimpleBuilder
964 builder = builder_cls(builder_run)
965 if not builder.Run():
966 sys.exit(1)
Brian Harring3fec5a82012-03-01 05:57:03 -0800967
968
969# Parser related functions
Ryan Cui5ba7e152012-05-10 14:36:52 -0700970def _CheckLocalPatches(sourceroot, local_patches):
Brian Harring3fec5a82012-03-01 05:57:03 -0800971 """Do an early quick check of the passed-in patches.
972
973 If the branch of a project is not specified we append the current branch the
974 project is on.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700975
David Jamese3b06062013-11-09 18:52:02 -0800976 TODO(davidjames): The project:branch format isn't unique, so this means that
977 we can't differentiate what directory the user intended to apply patches to.
978 We should references by directory instead.
979
Ryan Cui5ba7e152012-05-10 14:36:52 -0700980 Args:
981 sourceroot: The checkout where patches are coming from.
Aviv Keshet9e4236b2013-12-13 13:07:50 -0800982 local_patches: List of patches to check in project:branch format.
David Jamese3b06062013-11-09 18:52:02 -0800983
984 Returns:
985 A list of patches that have been verified, in project:branch format.
Brian Harring3fec5a82012-03-01 05:57:03 -0800986 """
Ryan Cuicedd8a52012-03-22 02:28:35 -0700987 verified_patches = []
David James97d95872012-11-16 15:09:56 -0800988 manifest = git.ManifestCheckout.Cached(sourceroot)
Ryan Cuicedd8a52012-03-22 02:28:35 -0700989 for patch in local_patches:
David Jamese3b06062013-11-09 18:52:02 -0800990 project, _, branch = patch.partition(':')
991
Gaurav Shah7afb0562013-12-26 15:05:39 -0800992 checkouts = manifest.FindCheckouts(project, only_patchable=True)
David Jamese3b06062013-11-09 18:52:02 -0800993 if not checkouts:
994 cros_build_lib.Die('Project %s does not exist.' % (project,))
995 if len(checkouts) > 1:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700996 cros_build_lib.Die(
David Jamese3b06062013-11-09 18:52:02 -0800997 'We do not yet support local patching for projects that are checked '
998 'out to multiple directories. Try uploading your patch to gerrit '
999 'and referencing it via the -g option instead.'
1000 )
Brian Harring3fec5a82012-03-01 05:57:03 -08001001
David Jamese3b06062013-11-09 18:52:02 -08001002 ok = False
1003 for checkout in checkouts:
1004 project_dir = checkout.GetPath(absolute=True)
Brian Harring3fec5a82012-03-01 05:57:03 -08001005
David Jamese3b06062013-11-09 18:52:02 -08001006 # If no branch was specified, we use the project's current branch.
Brian Harring3fec5a82012-03-01 05:57:03 -08001007 if not branch:
David Jamese3b06062013-11-09 18:52:02 -08001008 local_branch = git.GetCurrentBranch(project_dir)
1009 else:
1010 local_branch = branch
Brian Harring3fec5a82012-03-01 05:57:03 -08001011
David Jamesf1a07612014-04-28 17:48:52 -07001012 if local_branch and git.DoesCommitExistInRepo(project_dir, local_branch):
David Jamese3b06062013-11-09 18:52:02 -08001013 verified_patches.append('%s:%s' % (project, local_branch))
1014 ok = True
1015
1016 if not ok:
1017 if branch:
1018 cros_build_lib.Die('Project %s does not have branch %s'
David Jameseecba232014-06-11 11:35:11 -07001019 % (project, branch))
David Jamese3b06062013-11-09 18:52:02 -08001020 else:
1021 cros_build_lib.Die('Project %s is not on a branch!' % (project,))
Brian Harring3fec5a82012-03-01 05:57:03 -08001022
Ryan Cuicedd8a52012-03-22 02:28:35 -07001023 return verified_patches
Brian Harring3fec5a82012-03-01 05:57:03 -08001024
1025
Brian Harring3fec5a82012-03-01 05:57:03 -08001026def _CheckChromeVersionOption(_option, _opt_str, value, parser):
1027 """Upgrade other options based on chrome_version being passed."""
1028 value = value.strip()
1029
1030 if parser.values.chrome_rev is None and value:
1031 parser.values.chrome_rev = constants.CHROME_REV_SPEC
1032
1033 parser.values.chrome_version = value
1034
1035
1036def _CheckChromeRootOption(_option, _opt_str, value, parser):
1037 """Validate and convert chrome_root to full-path form."""
Brian Harring3fec5a82012-03-01 05:57:03 -08001038 if parser.values.chrome_rev is None:
1039 parser.values.chrome_rev = constants.CHROME_REV_LOCAL
1040
Ryan Cui5ba7e152012-05-10 14:36:52 -07001041 parser.values.chrome_root = value
Brian Harring3fec5a82012-03-01 05:57:03 -08001042
1043
1044def _CheckChromeRevOption(_option, _opt_str, value, parser):
1045 """Validate the chrome_rev option."""
1046 value = value.strip()
1047 if value not in constants.VALID_CHROME_REVISIONS:
1048 raise optparse.OptionValueError('Invalid chrome rev specified')
1049
1050 parser.values.chrome_rev = value
1051
1052
David Jamesac8c2a72013-02-13 18:44:33 -08001053def FindCacheDir(_parser, _options):
Brian Harringae0a5322012-09-15 01:46:51 -07001054 return None
1055
1056
Ryan Cui5ba7e152012-05-10 14:36:52 -07001057class CustomGroup(optparse.OptionGroup):
Aviv Keshet9e4236b2013-12-13 13:07:50 -08001058 """Custom option group which supports arguments passed-through to trybot."""
David Jameseecba232014-06-11 11:35:11 -07001059
Ryan Cui5ba7e152012-05-10 14:36:52 -07001060 def add_remote_option(self, *args, **kwargs):
1061 """For arguments that are passed-through to remote trybot."""
1062 return optparse.OptionGroup.add_option(self, *args,
1063 remote_pass_through=True,
1064 **kwargs)
1065
1066
Ryan Cui1c13a252012-10-16 15:00:16 -07001067class CustomOption(commandline.FilteringOption):
1068 """Subclass FilteringOption class to implement pass-through and api."""
Ryan Cui5ba7e152012-05-10 14:36:52 -07001069
Ryan Cui1c13a252012-10-16 15:00:16 -07001070 ACTIONS = commandline.FilteringOption.ACTIONS + ('extend',)
1071 STORE_ACTIONS = commandline.FilteringOption.STORE_ACTIONS + ('extend',)
1072 TYPED_ACTIONS = commandline.FilteringOption.TYPED_ACTIONS + ('extend',)
1073 ALWAYS_TYPED_ACTIONS = (commandline.FilteringOption.ALWAYS_TYPED_ACTIONS +
1074 ('extend',))
Ryan Cui79319ab2012-05-21 12:59:18 -07001075
Ryan Cui5ba7e152012-05-10 14:36:52 -07001076 def __init__(self, *args, **kwargs):
1077 # The remote_pass_through argument specifies whether we should directly
1078 # pass the argument (with its value) onto the remote trybot.
1079 self.pass_through = kwargs.pop('remote_pass_through', False)
Ryan Cui1c13a252012-10-16 15:00:16 -07001080 self.api_version = int(kwargs.pop('api', '0'))
1081 commandline.FilteringOption.__init__(self, *args, **kwargs)
Ryan Cui5ba7e152012-05-10 14:36:52 -07001082
1083 def take_action(self, action, dest, opt, value, values, parser):
Ryan Cui79319ab2012-05-21 12:59:18 -07001084 if action == 'extend':
Mike Frysingerd6925b52012-07-16 16:11:00 -04001085 # If there is extra spaces between each argument, we get '' which later
1086 # code barfs on, so skip those. e.g. We see this with the forms:
1087 # cbuildbot -p 'proj:branch ' ...
1088 # cbuildbot -p ' proj:branch' ...
1089 # cbuildbot -p 'proj:branch proj2:branch' ...
1090 lvalue = value.split()
Ryan Cui79319ab2012-05-21 12:59:18 -07001091 values.ensure_value(dest, []).extend(lvalue)
Ryan Cui79319ab2012-05-21 12:59:18 -07001092
Ryan Cui1c13a252012-10-16 15:00:16 -07001093 commandline.FilteringOption.take_action(
1094 self, action, dest, opt, value, values, parser)
Ryan Cui5ba7e152012-05-10 14:36:52 -07001095
1096
Ryan Cui1c13a252012-10-16 15:00:16 -07001097class CustomParser(commandline.FilteringParser):
Aviv Keshet9e4236b2013-12-13 13:07:50 -08001098 """Custom option parser which supports arguments passed-trhough to trybot"""
Matt Tennante8179042013-10-01 15:47:32 -07001099
Brian Harringb6cf9142012-09-01 20:43:17 -07001100 DEFAULT_OPTION_CLASS = CustomOption
1101
1102 def add_remote_option(self, *args, **kwargs):
1103 """For arguments that are passed-through to remote trybot."""
Ryan Cui1c13a252012-10-16 15:00:16 -07001104 return self.add_option(*args, remote_pass_through=True, **kwargs)
Brian Harringb6cf9142012-09-01 20:43:17 -07001105
1106
Brian Harring3fec5a82012-03-01 05:57:03 -08001107def _CreateParser():
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001108 """Generate and return the parser with all the options."""
Brian Harring3fec5a82012-03-01 05:57:03 -08001109 # Parse options
David Jameseecba232014-06-11 11:35:11 -07001110 usage = 'usage: %prog [options] buildbot_config [buildbot_config ...]'
Brian Harringae0a5322012-09-15 01:46:51 -07001111 parser = CustomParser(usage=usage, caching=FindCacheDir)
Brian Harring3fec5a82012-03-01 05:57:03 -08001112
1113 # Main options
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001114 parser.add_option('-l', '--list', action='store_true', dest='list',
1115 default=False,
1116 help='List the suggested trybot configs to use (see --all)')
Brian Harring3fec5a82012-03-01 05:57:03 -08001117 parser.add_option('-a', '--all', action='store_true', dest='print_all',
1118 default=False,
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001119 help='List all of the buildbot configs available w/--list')
1120
1121 parser.add_option('--local', default=False, action='store_true',
David Jameseecba232014-06-11 11:35:11 -07001122 help=('Specifies that this tryjob should be run locally. '
1123 'Implies --debug.'))
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001124 parser.add_option('--remote', default=False, action='store_true',
Ryan Cui88b901c2013-06-21 11:35:30 -07001125 help='Specifies that this tryjob should be run remotely.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001126
Ryan Cuie1e4e662012-05-21 16:39:46 -07001127 parser.add_remote_option('-b', '--branch',
David Jameseecba232014-06-11 11:35:11 -07001128 help=('The manifest branch to test. The branch to '
1129 'check the buildroot out to.'))
Ryan Cui5ba7e152012-05-10 14:36:52 -07001130 parser.add_option('-r', '--buildroot', dest='buildroot', type='path',
David Jameseecba232014-06-11 11:35:11 -07001131 help=('Root directory where source is checked out to, and '
1132 'where the build occurs. For external build configs, '
1133 "defaults to 'trybot' directory at top level of your "
1134 'repo-managed checkout.'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001135 parser.add_remote_option('--chrome_rev', default=None, type='string',
1136 action='callback', dest='chrome_rev',
1137 callback=_CheckChromeRevOption,
1138 help=('Revision of Chrome to use, of type [%s]'
1139 % '|'.join(constants.VALID_CHROME_REVISIONS)))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001140 parser.add_remote_option('--profile', default=None, type='string',
1141 action='store', dest='profile',
1142 help='Name of profile to sub-specify board variant.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001143
Ryan Cuif4f84be2012-07-09 18:50:41 -07001144 #
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001145 # Patch selection options.
1146 #
1147
1148 group = CustomGroup(
1149 parser,
1150 'Patch Options')
1151
1152 group.add_remote_option('-g', '--gerrit-patches', action='extend',
1153 default=[], type='string',
1154 metavar="'Id1 *int_Id2...IdN'",
David Jameseecba232014-06-11 11:35:11 -07001155 help=('Space-separated list of short-form Gerrit '
1156 "Change-Id's or change numbers to patch. "
1157 "Please prepend '*' to internal Change-Id's"))
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001158 group.add_remote_option('-G', '--rietveld-patches', action='extend',
1159 default=[], type='string',
1160 metavar="'id1[:subdir1]...idN[:subdirN]'",
David Jameseecba232014-06-11 11:35:11 -07001161 help=('Space-separated list of short-form Rietveld '
1162 'issue numbers to patch. If no subdir is '
1163 'specified, the src directory is used.'))
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001164 group.add_option('-p', '--local-patches', action='extend', default=[],
1165 metavar="'<project1>[:<branch1>]...<projectN>[:<branchN>]'",
David Jameseecba232014-06-11 11:35:11 -07001166 help=('Space-separated list of project branches with '
1167 'patches to apply. Projects are specified by name. '
1168 'If no branch is specified the current branch of the '
1169 'project will be used.'))
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001170
1171 parser.add_option_group(group)
1172
1173 #
1174 # Remote trybot options.
1175 #
1176
1177 group = CustomGroup(
1178 parser,
1179 'Remote Trybot Options (--remote)')
1180
1181 group.add_remote_option('--hwtest', dest='hwtest', action='store_true',
David Jameseecba232014-06-11 11:35:11 -07001182 default=False,
1183 help='Run the HWTest stage (tests on real hardware)')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001184 group.add_option('--remote-description', default=None,
David Jameseecba232014-06-11 11:35:11 -07001185 help=('Attach an optional description to a --remote run '
1186 'to make it easier to identify the results when it '
1187 'finishes'))
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001188 group.add_option('--slaves', action='extend', default=[],
David Jameseecba232014-06-11 11:35:11 -07001189 help=('Specify specific remote tryslaves to run on (e.g. '
1190 'build149-m2); if the bot is busy, it will be queued'))
Don Garrett4bb21682014-03-03 16:16:23 -08001191 group.add_remote_option('--channel', dest='channels', action='extend',
1192 default=[],
David Jameseecba232014-06-11 11:35:11 -07001193 help=('Specify a channel for a payloads trybot. Can '
1194 'be specified multiple times. No valid for '
1195 'non-payloads configs.'))
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001196 group.add_option('--test-tryjob', action='store_true',
1197 default=False,
David Jameseecba232014-06-11 11:35:11 -07001198 help=('Submit a tryjob to the test repository. Will not '
1199 'show up on the production trybot waterfall.'))
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001200
1201 parser.add_option_group(group)
1202
1203 #
Ryan Cui88b901c2013-06-21 11:35:30 -07001204 # Branch creation options.
1205 #
1206
1207 group = CustomGroup(
1208 parser,
1209 'Branch Creation Options (used with branch-util)')
1210
1211 group.add_remote_option('--branch-name',
1212 help='The branch to create or delete.')
1213 group.add_remote_option('--delete-branch', default=False, action='store_true',
1214 help='Delete the branch specified in --branch-name.')
1215 group.add_remote_option('--rename-to', type='string',
1216 help='Rename a branch to the specified name.')
1217 group.add_remote_option('--force-create', default=False, action='store_true',
1218 help='Overwrites an existing branch.')
1219
1220 parser.add_option_group(group)
1221
1222 #
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001223 # Advanced options.
Ryan Cuif4f84be2012-07-09 18:50:41 -07001224 #
1225
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001226 group = CustomGroup(
Brian Harring3fec5a82012-03-01 05:57:03 -08001227 parser,
1228 'Advanced Options',
1229 'Caution: use these options at your own risk.')
1230
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001231 group.add_remote_option('--bootstrap-args', action='append', default=[],
David Jameseecba232014-06-11 11:35:11 -07001232 help=('Args passed directly to the bootstrap re-exec '
1233 'to skip verification by the bootstrap code'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001234 group.add_remote_option('--buildbot', dest='buildbot', action='store_true',
1235 default=False, help='This is running on a buildbot')
1236 group.add_remote_option('--buildnumber', help='build number', type='int',
1237 default=0)
Ryan Cui5ba7e152012-05-10 14:36:52 -07001238 group.add_option('--chrome_root', default=None, type='path',
1239 action='callback', callback=_CheckChromeRootOption,
1240 dest='chrome_root', help='Local checkout of Chrome to use.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001241 group.add_remote_option('--chrome_version', default=None, type='string',
1242 action='callback', dest='chrome_version',
1243 callback=_CheckChromeVersionOption,
David Jameseecba232014-06-11 11:35:11 -07001244 help=('Used with SPEC logic to force a particular '
Stefan Zagerd49d9ff2014-08-15 21:33:37 -07001245 'git revision of chrome rather than the '
David Jameseecba232014-06-11 11:35:11 -07001246 'latest.'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001247 group.add_remote_option('--clobber', action='store_true', dest='clobber',
1248 default=False,
1249 help='Clears an old checkout before syncing')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001250 group.add_remote_option('--latest-toolchain', action='store_true',
1251 default=False,
1252 help='Use the latest toolchain.')
Ryan Cui5ba7e152012-05-10 14:36:52 -07001253 parser.add_option('--log_dir', dest='log_dir', type='path',
Brian Harring3fec5a82012-03-01 05:57:03 -08001254 help=('Directory where logs are stored.'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001255 group.add_remote_option('--maxarchives', dest='max_archive_builds',
1256 default=3, type='int',
David Jameseecba232014-06-11 11:35:11 -07001257 help='Change the local saved build count limit.')
Ryan Cuibbd3d4b2012-08-17 12:20:37 -07001258 parser.add_remote_option('--manifest-repo-url',
1259 help=('Overrides the default manifest repo url.'))
David James565bc9a2013-04-08 14:54:45 -07001260 group.add_remote_option('--compilecheck', action='store_true', default=False,
1261 help='Only verify compilation and unit tests.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001262 group.add_remote_option('--noarchive', action='store_false', dest='archive',
1263 default=True, help="Don't run archive stage.")
Ryan Cuif7f24692012-05-18 16:35:33 -07001264 group.add_remote_option('--nobootstrap', action='store_false',
1265 dest='bootstrap', default=True,
David Jameseecba232014-06-11 11:35:11 -07001266 help=("Don't checkout and run from a standalone "
1267 'chromite repo.'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001268 group.add_remote_option('--nobuild', action='store_false', dest='build',
1269 default=True,
1270 help="Don't actually build (for cbuildbot dev)")
1271 group.add_remote_option('--noclean', action='store_false', dest='clean',
1272 default=True, help="Don't clean the buildroot")
Ryan Cuif7f24692012-05-18 16:35:33 -07001273 group.add_remote_option('--nocgroups', action='store_false', dest='cgroups',
1274 default=True,
1275 help='Disable cbuildbots usage of cgroups.')
Ryan Cui3ea98e02013-08-07 16:01:48 -07001276 group.add_remote_option('--nochromesdk', action='store_false',
1277 dest='chrome_sdk', default=True,
David Jameseecba232014-06-11 11:35:11 -07001278 help=("Don't run the ChromeSDK stage which builds "
1279 'Chrome outside of the chroot.'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001280 group.add_remote_option('--noprebuilts', action='store_false',
1281 dest='prebuilts', default=True,
1282 help="Don't upload prebuilts.")
Ryan Cui88b901c2013-06-21 11:35:30 -07001283 group.add_remote_option('--nopatch', action='store_false',
1284 dest='postsync_patch', default=True,
1285 help=("Don't run PatchChanges stage. This does not "
David Jameseecba232014-06-11 11:35:11 -07001286 'disable patching in of chromite patches '
1287 'during BootstrapStage.'))
Don Garrett82c0ae82014-02-03 18:25:11 -08001288 group.add_remote_option('--nopaygen', action='store_false',
1289 dest='paygen', default=True,
1290 help="Don't generate payloads.")
Ryan Cui88b901c2013-06-21 11:35:30 -07001291 group.add_remote_option('--noreexec', action='store_false',
1292 dest='postsync_reexec', default=True,
1293 help="Don't reexec into the buildroot after syncing.")
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001294 group.add_remote_option('--nosdk', action='store_true',
1295 default=False,
1296 help='Re-create the SDK from scratch.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001297 group.add_remote_option('--nosync', action='store_false', dest='sync',
1298 default=True, help="Don't sync before building.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001299 group.add_remote_option('--notests', action='store_false', dest='tests',
1300 default=True,
David Jameseecba232014-06-11 11:35:11 -07001301 help=('Override values from buildconfig and run no '
1302 'tests.'))
Nam T. Nguyenc93f1342014-07-11 14:40:54 -07001303 group.add_remote_option('--noimagetests', action='store_false',
1304 dest='image_test', default=True,
1305 help=('Override values from buildconfig and run no '
1306 'image tests.'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001307 group.add_remote_option('--nouprev', action='store_false', dest='uprev',
1308 default=True,
David Jameseecba232014-06-11 11:35:11 -07001309 help=('Override values from buildconfig and never '
1310 'uprev.'))
David Jamesdac7a912013-11-18 11:14:44 -08001311 group.add_option('--reference-repo', action='store', default=None,
1312 dest='reference_repo',
David Jameseecba232014-06-11 11:35:11 -07001313 help=('Reuse git data stored in an existing repo '
1314 'checkout. This can drastically reduce the network '
1315 'time spent setting up the trybot checkout. By '
1316 "default, if this option isn't given but cbuildbot "
1317 'is invoked from a repo checkout, cbuildbot will '
1318 'use the repo root.'))
Ryan Cuicedd8a52012-03-22 02:28:35 -07001319 group.add_option('--resume', action='store_true', default=False,
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001320 help='Skip stages already successfully completed.')
1321 group.add_remote_option('--timeout', action='store', type='int', default=0,
David Jameseecba232014-06-11 11:35:11 -07001322 help=('Specify the maximum amount of time this job '
1323 'can run for, at which point the build will be '
1324 'aborted. If set to zero, then there is no '
1325 'timeout.'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001326 group.add_remote_option('--version', dest='force_version', default=None,
David Jameseecba232014-06-11 11:35:11 -07001327 help=('Used with manifest logic. Forces use of this '
1328 'version rather than create or get latest. '
1329 'Examples: 4815.0.0-rc1, 4815.1.2'))
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001330
1331 parser.add_option_group(group)
1332
1333 #
1334 # Internal options.
1335 #
1336
1337 group = CustomGroup(
1338 parser,
Mike Frysinger34db8692013-11-11 14:54:08 -05001339 'Internal Chromium OS Build Team Options',
1340 'Caution: these are for meant for the Chromium OS build team only')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001341
1342 group.add_remote_option('--archive-base', type='gs_path',
David Jameseecba232014-06-11 11:35:11 -07001343 help=('Base GS URL (gs://<bucket_name>/<path>) to '
1344 'upload archive artifacts to'))
1345 group.add_remote_option(
1346 '--cq-gerrit-query', dest='cq_gerrit_override', default=None,
1347 help=('If given, this gerrit query will be used to find what patches to '
1348 "test, rather than the normal 'CommitQueue>=1 AND Verified=1 AND "
1349 "CodeReview=2' query it defaults to. Use with care- note "
1350 'additionally this setting only has an effect if the buildbot '
1351 "target is a cq target, and we're in buildbot mode."))
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001352 group.add_option('--pass-through', dest='pass_through_args', action='append',
1353 type='string', default=[])
David Jamesf421c6d2013-04-11 15:37:57 -07001354 group.add_remote_option('--pre-cq', action='store_true', default=False,
1355 help='Mark CLs as tested by the PreCQ on success.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001356 group.add_option('--reexec-api-version', dest='output_api_version',
Ryan Cuif4f84be2012-07-09 18:50:41 -07001357 action='store_true', default=False,
David Jameseecba232014-06-11 11:35:11 -07001358 help=('Used for handling forwards/backwards compatibility '
1359 'with --resume and --bootstrap'))
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001360 group.add_option('--remote-trybot', dest='remote_trybot',
1361 action='store_true', default=False,
1362 help='Indicates this is running on a remote trybot machine')
1363 group.add_remote_option('--remote-patches', action='extend', default=[],
David Jameseecba232014-06-11 11:35:11 -07001364 help=('Patches uploaded by the trybot client when '
1365 'run using the -p option'))
Brian Harringf611e6e2012-07-17 18:47:44 -07001366 # Note the default here needs to be hardcoded to 3; that is the last version
1367 # that lacked this functionality.
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001368 group.add_option('--remote-version', default=3, type=int, action='store',
David Jameseecba232014-06-11 11:35:11 -07001369 help=('Used for compatibility checks w/tryjobs running in '
1370 'older chromite instances'))
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001371 group.add_option('--sourceroot', type='path', default=constants.SOURCE_ROOT)
1372 group.add_remote_option('--test-bootstrap', action='store_true',
1373 default=False,
David Jameseecba232014-06-11 11:35:11 -07001374 help=('Causes cbuildbot to bootstrap itself twice, '
1375 'in the sequence A->B->C: A(unpatched) patches '
1376 'and bootstraps B; B patches and bootstraps C'))
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001377 group.add_remote_option('--validation_pool', default=None,
David Jameseecba232014-06-11 11:35:11 -07001378 help=('Path to a pickled validation pool. Intended '
1379 'for use only with the commit queue.'))
Aviv Keshet007a24a2014-06-23 08:10:55 -07001380 group.add_remote_option('--metadata_dump', default=None,
Aviv Keshet669eb5e2014-06-23 08:53:01 -07001381 help=('Path to a json dumped metadata file. This '
1382 'will be used as the initial metadata.'))
Aviv Keshetacf4cfb2014-07-30 12:31:22 -07001383 group.add_remote_option('--master-build-id', default=None, type=int,
1384 api=constants.REEXEC_API_MASTER_BUILD_ID,
1385 help=('cidb build id of the master build to this '
1386 'slave build.'))
Aviv Kesheta0159be2013-12-12 13:56:28 -08001387 group.add_remote_option('--mock-tree-status', dest='mock_tree_status',
1388 default=None, action='store',
David Jameseecba232014-06-11 11:35:11 -07001389 help=('Override the tree status value that would be '
1390 'returned from the the actual tree. Example '
1391 'values: open, closed, throttled. When used '
1392 'in conjunction with --debug, the tree status '
1393 'will not be ignored as it usually is in a '
1394 '--debug run.'))
1395 group.add_remote_option(
1396 '--mock-slave-status', dest='mock_slave_status', default=None,
1397 action='store', metavar='MOCK_SLAVE_STATUS_PICKLE_FILE',
1398 help=('Override the result of the _FetchSlaveStatuses method of '
1399 'MasterSlaveSyncCompletionStage, by specifying a file with a '
1400 'pickle of the result to be returned.'))
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001401
1402 parser.add_option_group(group)
Ryan Cuif4f84be2012-07-09 18:50:41 -07001403
1404 #
Brian Harring3fec5a82012-03-01 05:57:03 -08001405 # Debug options
Ryan Cuif4f84be2012-07-09 18:50:41 -07001406 #
Brian Harringfec89fe2012-09-23 07:30:54 -07001407 # Temporary hack; in place till --dry-run replaces --debug.
1408 # pylint: disable=W0212
Brian Harring009db502012-10-10 02:21:37 -07001409 group = parser.debug_group
Brian Harringfec89fe2012-09-23 07:30:54 -07001410 debug = [x for x in group.option_list if x._long_opts == ['--debug']][0]
David Jameseecba232014-06-11 11:35:11 -07001411 debug.help += ' Currently functions as --dry-run in addition.'
Brian Harringfec89fe2012-09-23 07:30:54 -07001412 debug.pass_through = True
Brian Harring3fec5a82012-03-01 05:57:03 -08001413 group.add_option('--notee', action='store_false', dest='tee', default=True,
David Jameseecba232014-06-11 11:35:11 -07001414 help=('Disable logging and internal tee process. Primarily '
1415 'used for debugging cbuildbot itself.'))
Brian Harring3fec5a82012-03-01 05:57:03 -08001416 return parser
1417
1418
Ryan Cui85867972012-02-23 18:21:49 -08001419def _FinishParsing(options, args):
1420 """Perform some parsing tasks that need to take place after optparse.
1421
1422 This function needs to be easily testable! Keep it free of
1423 environment-dependent code. Put more detailed usage validation in
1424 _PostParseCheck().
Brian Harring3fec5a82012-03-01 05:57:03 -08001425
1426 Args:
Matt Tennant759e2352013-09-27 15:14:44 -07001427 options: The options object returned by optparse
1428 args: The args object returned by optparse
Brian Harring3fec5a82012-03-01 05:57:03 -08001429 """
Ryan Cui41023d92012-11-13 19:59:50 -08001430 # Populate options.pass_through_args.
1431 accepted, _ = commandline.FilteringParser.FilterArgs(
1432 options.parsed_args, lambda x: x.opt_inst.pass_through)
1433 options.pass_through_args.extend(accepted)
Brian Harring07039b52012-05-13 17:56:47 -07001434
Brian Harring3fec5a82012-03-01 05:57:03 -08001435 if options.chrome_root:
1436 if options.chrome_rev != constants.CHROME_REV_LOCAL:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001437 cros_build_lib.Die('Chrome rev must be %s if chrome_root is set.' %
1438 constants.CHROME_REV_LOCAL)
David Jamesa0a664e2013-02-13 09:52:01 -08001439 elif options.chrome_rev == constants.CHROME_REV_LOCAL:
1440 cros_build_lib.Die('Chrome root must be set if chrome_rev is %s.' %
1441 constants.CHROME_REV_LOCAL)
Brian Harring3fec5a82012-03-01 05:57:03 -08001442
1443 if options.chrome_version:
1444 if options.chrome_rev != constants.CHROME_REV_SPEC:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001445 cros_build_lib.Die('Chrome rev must be %s if chrome_version is set.' %
1446 constants.CHROME_REV_SPEC)
David Jamesa0a664e2013-02-13 09:52:01 -08001447 elif options.chrome_rev == constants.CHROME_REV_SPEC:
1448 cros_build_lib.Die(
1449 'Chrome rev must not be %s if chrome_version is not set.'
1450 % constants.CHROME_REV_SPEC)
Brian Harring3fec5a82012-03-01 05:57:03 -08001451
David James9e27e662013-02-14 13:42:43 -08001452 patches = bool(options.gerrit_patches or options.local_patches or
1453 options.rietveld_patches)
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001454 if options.remote:
1455 if options.local:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001456 cros_build_lib.Die('Cannot specify both --remote and --local')
Ryan Cui54da0702012-04-19 18:38:08 -07001457
Don Garrett5af1d262014-05-16 15:49:37 -07001458 # options.channels is a convenient way to detect payloads builds.
1459 if not options.buildbot and not options.channels and not patches:
Gaurav Shahed0399e2014-02-03 13:36:22 -08001460 prompt = ('No patches were provided; are you sure you want to just '
1461 'run a remote build of %s?' % (
1462 options.branch if options.branch else 'ToT'))
1463 if not cros_build_lib.BooleanPrompt(prompt=prompt, default=False):
Brian Harring7cc4b932012-11-01 16:58:55 -07001464 cros_build_lib.Die('Must provide patches when running with --remote.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001465
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001466 # --debug needs to be explicitly passed through for remote invocations.
1467 release_mode_with_patches = (options.buildbot and patches and
1468 '--debug' not in options.pass_through_args)
1469 else:
1470 if len(args) > 1:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001471 cros_build_lib.Die('Multiple configs not supported if not running with '
Brian Harringf1aad832012-07-18 10:46:39 -07001472 '--remote. Got %r', args)
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001473
Ryan Cui79319ab2012-05-21 12:59:18 -07001474 if options.slaves:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001475 cros_build_lib.Die('Cannot use --slaves if not running with --remote.')
Ryan Cui79319ab2012-05-21 12:59:18 -07001476
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001477 release_mode_with_patches = (options.buildbot and patches and
1478 not options.debug)
1479
David James5734ea32012-08-15 20:23:49 -07001480 # When running in release mode, make sure we are running with checked-in code.
1481 # We want checked-in cbuildbot/scripts to prevent errors, and we want to build
1482 # a release image with checked-in code for CrOS packages.
1483 if release_mode_with_patches:
1484 cros_build_lib.Die(
1485 'Cannot provide patches when running with --buildbot!')
1486
Ryan Cuiba41ad32012-03-08 17:15:29 -08001487 if options.buildbot and options.remote_trybot:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001488 cros_build_lib.Die(
1489 '--buildbot and --remote-trybot cannot be used together.')
Ryan Cuiba41ad32012-03-08 17:15:29 -08001490
Ryan Cui85867972012-02-23 18:21:49 -08001491 # Record whether --debug was set explicitly vs. it was inferred.
1492 options.debug_forced = False
1493 if options.debug:
1494 options.debug_forced = True
Ryan Cui88b901c2013-06-21 11:35:30 -07001495 if not options.debug:
Ryan Cui16ca5812012-03-08 20:34:27 -08001496 # We don't set debug by default for
1497 # 1. --buildbot invocations.
1498 # 2. --remote invocations, because it needs to push changes to the tryjob
1499 # repo.
1500 options.debug = not options.buildbot and not options.remote
Brian Harring3fec5a82012-03-01 05:57:03 -08001501
Ryan Cui1c13a252012-10-16 15:00:16 -07001502 # Record the configs targeted.
1503 options.build_targets = args[:]
1504
Ryan Cui88b901c2013-06-21 11:35:30 -07001505 if constants.BRANCH_UTIL_CONFIG in options.build_targets:
Ryan Cui7bd8db62013-08-08 16:29:51 -07001506 if options.remote:
1507 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001508 'Running %s as a remote tryjob is not yet supported.',
1509 constants.BRANCH_UTIL_CONFIG)
Ryan Cui88b901c2013-06-21 11:35:30 -07001510 if len(options.build_targets) > 1:
1511 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001512 'Cannot run %s with any other configs.',
1513 constants.BRANCH_UTIL_CONFIG)
Ryan Cui88b901c2013-06-21 11:35:30 -07001514 if not options.branch_name:
1515 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001516 'Must specify --branch-name with the %s config.',
1517 constants.BRANCH_UTIL_CONFIG)
1518 if options.branch and options.branch != options.branch_name:
Ryan Cui88b901c2013-06-21 11:35:30 -07001519 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001520 'If --branch is specified with the %s config, it must'
1521 ' have the same value as --branch-name.',
1522 constants.BRANCH_UTIL_CONFIG)
1523
1524 exclusive_opts = {'--version': options.force_version,
1525 '--delete-branch': options.delete_branch,
David Jameseecba232014-06-11 11:35:11 -07001526 '--rename-to': options.rename_to}
Matt Tennanta130ea32013-12-19 09:38:39 -08001527 if 1 != sum(1 for x in exclusive_opts.values() if x):
1528 cros_build_lib.Die('When using the %s config, you must'
1529 ' specifiy one and only one of the following'
1530 ' options: %s.', constants.BRANCH_UTIL_CONFIG,
1531 ', '.join(exclusive_opts.keys()))
1532
1533 # When deleting or renaming a branch, the --branch and --nobootstrap
1534 # options are implied.
1535 if options.delete_branch or options.rename_to:
1536 if not options.branch:
1537 cros_build_lib.Info('Automatically enabling sync to branch %s'
1538 ' for this %s flow.', options.branch_name,
1539 constants.BRANCH_UTIL_CONFIG)
1540 options.branch = options.branch_name
1541 if options.bootstrap:
1542 cros_build_lib.Info('Automatically disabling bootstrap step for'
1543 ' this %s flow.', constants.BRANCH_UTIL_CONFIG)
1544 options.bootstrap = False
1545
Ryan Cui88b901c2013-06-21 11:35:30 -07001546 elif any([options.delete_branch, options.rename_to, options.branch_name]):
1547 cros_build_lib.Die(
1548 'Cannot specify --delete-branch, --rename-to or --branch-name when not '
1549 'running the %s config', constants.BRANCH_UTIL_CONFIG)
1550
Brian Harring3fec5a82012-03-01 05:57:03 -08001551
Brian Harring1d7ba942012-04-24 06:37:18 -07001552# pylint: disable=W0613
Brian Harringae0a5322012-09-15 01:46:51 -07001553def _PostParseCheck(parser, options, args):
Ryan Cui85867972012-02-23 18:21:49 -08001554 """Perform some usage validation after we've parsed the arguments
Brian Harring3fec5a82012-03-01 05:57:03 -08001555
Ryan Cui85867972012-02-23 18:21:49 -08001556 Args:
Aviv Keshet9e4236b2013-12-13 13:07:50 -08001557 parser: Option parser that was used to parse arguments.
1558 options: The options returned by optparse.
1559 args: The args returned by optparse.
Ryan Cui85867972012-02-23 18:21:49 -08001560 """
Ryan Cuie1e4e662012-05-21 16:39:46 -07001561 if not options.branch:
David James97d95872012-11-16 15:09:56 -08001562 options.branch = git.GetChromiteTrackingBranch()
Ryan Cuie1e4e662012-05-21 16:39:46 -07001563
Brian Harringae0a5322012-09-15 01:46:51 -07001564 if not repository.IsARepoRoot(options.sourceroot):
1565 if options.local_patches:
1566 raise Exception('Could not find repo checkout at %s!'
1567 % options.sourceroot)
1568
David Jamesac8c2a72013-02-13 18:44:33 -08001569 # Because the default cache dir depends on other options, FindCacheDir
1570 # always returns None, and we setup the default here.
Brian Harringae0a5322012-09-15 01:46:51 -07001571 if options.cache_dir is None:
1572 # Note, options.sourceroot is set regardless of the path
1573 # actually existing.
David Jamesac8c2a72013-02-13 18:44:33 -08001574 if options.buildroot is not None:
Brian Harringae0a5322012-09-15 01:46:51 -07001575 options.cache_dir = os.path.join(options.buildroot, '.cache')
David Jamesac8c2a72013-02-13 18:44:33 -08001576 elif os.path.exists(options.sourceroot):
1577 options.cache_dir = os.path.join(options.sourceroot, '.cache')
Brian Harringae0a5322012-09-15 01:46:51 -07001578 else:
1579 options.cache_dir = parser.FindCacheDir(parser, options)
1580 options.cache_dir = os.path.abspath(options.cache_dir)
Brian Harring8c1d7b12012-10-04 17:36:32 -07001581 parser.ConfigureCacheDir(options.cache_dir)
Brian Harringae0a5322012-09-15 01:46:51 -07001582
Yu-Ju Hong2c066762013-10-28 14:05:08 -07001583 osutils.SafeMakedirsNonRoot(options.cache_dir)
Ryan Cui5ba7e152012-05-10 14:36:52 -07001584
Brian Harring609dc4e2012-05-07 02:17:44 -07001585 if options.local_patches:
Brian Harring1d7ba942012-04-24 06:37:18 -07001586 options.local_patches = _CheckLocalPatches(
Brian Harring609dc4e2012-05-07 02:17:44 -07001587 options.sourceroot, options.local_patches)
Brian Harring1d7ba942012-04-24 06:37:18 -07001588
1589 default = os.environ.get('CBUILDBOT_DEFAULT_MODE')
1590 if (default and not any([options.local, options.buildbot,
1591 options.remote, options.remote_trybot])):
David Jameseecba232014-06-11 11:35:11 -07001592 cros_build_lib.Info('CBUILDBOT_DEFAULT_MODE=%s env var detected, using it.'
Brian Harring1b8c4c82012-05-29 23:03:04 -07001593 % default)
Brian Harring1d7ba942012-04-24 06:37:18 -07001594 default = default.lower()
1595 if default == 'local':
1596 options.local = True
1597 elif default == 'remote':
1598 options.remote = True
1599 elif default == 'buildbot':
1600 options.buildbot = True
1601 else:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001602 cros_build_lib.Die("CBUILDBOT_DEFAULT_MODE value %s isn't supported. "
1603 % default)
Ryan Cui85867972012-02-23 18:21:49 -08001604
Matt Tennant763497d2014-01-17 16:45:54 -08001605 # Ensure that all args are legitimate config targets.
Chris Sosa55cdc942014-04-16 13:08:37 -07001606 invalid_targets = []
Matt Tennant763497d2014-01-17 16:45:54 -08001607 for arg in args:
Matt Tennant2c192032014-01-16 13:49:28 -08001608 build_config = _GetConfig(arg)
Don Garrett4bb21682014-03-03 16:16:23 -08001609
Matt Tennant2c192032014-01-16 13:49:28 -08001610 if not build_config:
Chris Sosa55cdc942014-04-16 13:08:37 -07001611 invalid_targets.append(arg)
Matt Tennant763497d2014-01-17 16:45:54 -08001612 cros_build_lib.Error('No such configuraton target: "%s".', arg)
Don Garrett4bb21682014-03-03 16:16:23 -08001613 continue
1614
Don Garrett5af1d262014-05-16 15:49:37 -07001615 is_payloads_build = build_config.build_type == constants.PAYLOADS_TYPE
1616
1617 if options.channels and not is_payloads_build:
Don Garrett4bb21682014-03-03 16:16:23 -08001618 cros_build_lib.Die('--channel must only be used with a payload config,'
1619 ' not target (%s).' % arg)
Matt Tennant763497d2014-01-17 16:45:54 -08001620
Don Garrett5af1d262014-05-16 15:49:37 -07001621 if not options.channels and is_payloads_build:
1622 cros_build_lib.Die('payload configs (%s) require --channel to do anything'
1623 ' useful.' % arg)
1624
Matt Tennant2c192032014-01-16 13:49:28 -08001625 # The --version option is not compatible with an external target unless the
1626 # --buildbot option is specified. More correctly, only "paladin versions"
1627 # will work with external targets, and those are only used with --buildbot.
1628 # If --buildbot is specified, then user should know what they are doing and
1629 # only specify a version that will work. See crbug.com/311648.
Don Garrett4bb21682014-03-03 16:16:23 -08001630 if (options.force_version and
1631 not (options.buildbot or build_config.internal)):
1632 cros_build_lib.Die('Cannot specify --version without --buildbot for an'
1633 ' external target (%s).' % arg)
Matt Tennant2c192032014-01-16 13:49:28 -08001634
Chris Sosa55cdc942014-04-16 13:08:37 -07001635 if invalid_targets:
1636 cros_build_lib.Die('One or more invalid configuration targets specified. '
1637 'You can check the available configs by running '
1638 '`cbuildbot --list --all`')
Matt Tennant763497d2014-01-17 16:45:54 -08001639
Ryan Cui85867972012-02-23 18:21:49 -08001640
1641def _ParseCommandLine(parser, argv):
1642 """Completely parse the commandline arguments"""
Brian Harring3fec5a82012-03-01 05:57:03 -08001643 (options, args) = parser.parse_args(argv)
Brian Harring37e559b2012-05-22 20:47:32 -07001644
Matt Tennant763497d2014-01-17 16:45:54 -08001645 # Strip out null arguments.
1646 # TODO(rcui): Remove when buildbot is fixed
1647 args = [arg for arg in args if arg]
1648
1649 # A couple options, like --list, trigger a quick exit.
Brian Harring37e559b2012-05-22 20:47:32 -07001650 if options.output_api_version:
Mike Frysinger383367e2014-09-16 15:06:17 -04001651 print(constants.REEXEC_API_VERSION)
Brian Harring37e559b2012-05-22 20:47:32 -07001652 sys.exit(0)
1653
Ryan Cui54da0702012-04-19 18:38:08 -07001654 if options.list:
Matt Tennant763497d2014-01-17 16:45:54 -08001655 if args:
1656 cros_build_lib.Die('No arguments expected with the --list options.')
Ryan Cui54da0702012-04-19 18:38:08 -07001657 _PrintValidConfigs(options.print_all)
1658 sys.exit(0)
1659
Ryan Cui8be16062012-04-24 12:05:26 -07001660 if not args:
Matt Tennant763497d2014-01-17 16:45:54 -08001661 parser.error('Invalid usage: no configuration targets provided.'
1662 'Use -h to see usage. Use -l to list supported configs.')
Ryan Cui8be16062012-04-24 12:05:26 -07001663
Ryan Cui85867972012-02-23 18:21:49 -08001664 _FinishParsing(options, args)
1665 return options, args
1666
1667
Aviv Keshet64133022014-08-25 15:50:52 -07001668def _SetupCidb(options, build_config):
Aviv Keshet2982af52014-08-13 16:07:57 -07001669 """Set up CIDB the appropriate Setup call.
1670
1671 Args:
1672 options: Command line options structure.
Aviv Keshet64133022014-08-25 15:50:52 -07001673 build_config: Config object for this build.
Aviv Keshet2982af52014-08-13 16:07:57 -07001674 """
Aviv Keshet62d1a0e2014-08-22 21:16:13 -07001675 # TODO(akeshet): This is a temporary workaround to make sure that the cidb
1676 # is not used on waterfalls that the db schema does not support (in particular
1677 # the chromeos.chrome waterfall).
Aviv Keshet64133022014-08-25 15:50:52 -07001678 # See crbug.com/406940
Aviv Keshet62d1a0e2014-08-22 21:16:13 -07001679 waterfall = os.environ.get('BUILDBOT_MASTERNAME', '')
Aviv Keshet3e1efcd2014-09-23 12:05:54 -07001680 if not waterfall in constants.CIDB_KNOWN_WATERFALLS:
Aviv Keshet62d1a0e2014-08-22 21:16:13 -07001681 cidb.CIDBConnectionFactory.SetupNoCidb()
1682 return
1683
Aviv Keshet64133022014-08-25 15:50:52 -07001684 # TODO(akeshet): Clean up this code once we have better defined flags to
1685 # specify on-or-off waterfall and on-or-off production runs of cbuildbot.
1686 # See crbug.com/331417
1687
1688 # --buildbot runs should use the production database, unless the --debug flag
1689 # is also present in which case they should use the debug database.
1690 if options.buildbot:
1691 if options.debug:
1692 cidb.CIDBConnectionFactory.SetupDebugCidb()
1693 return
1694 else:
1695 cidb.CIDBConnectionFactory.SetupProdCidb()
1696 return
1697
1698 # --remote-trybot runs should use the debug database. With the exception of
1699 # pre-cq builds, which should use the production database.
1700 if options.remote_trybot:
1701 if build_config['pre_cq']:
1702 cidb.CIDBConnectionFactory.SetupProdCidb()
1703 return
1704 else:
1705 cidb.CIDBConnectionFactory.SetupDebugCidb()
1706 return
1707
1708 # If neither --buildbot nor --remote-trybot flag was used, don't use the
1709 # database.
1710 cidb.CIDBConnectionFactory.SetupNoCidb()
Aviv Keshet2982af52014-08-13 16:07:57 -07001711
1712
Matt Tennant759e2352013-09-27 15:14:44 -07001713# TODO(build): This function is too damn long.
Ryan Cui85867972012-02-23 18:21:49 -08001714def main(argv):
David James59a0a2b2013-03-22 14:04:44 -07001715 # Turn on strict sudo checks.
1716 cros_build_lib.STRICT_SUDO = True
1717
Ryan Cui85867972012-02-23 18:21:49 -08001718 # Set umask to 022 so files created by buildbot are readable.
Mike Frysinger60ec1012013-10-21 00:11:10 -04001719 os.umask(0o22)
Ryan Cui85867972012-02-23 18:21:49 -08001720
Ryan Cui85867972012-02-23 18:21:49 -08001721 parser = _CreateParser()
1722 (options, args) = _ParseCommandLine(parser, argv)
Brian Harring3fec5a82012-03-01 05:57:03 -08001723
Brian Harringae0a5322012-09-15 01:46:51 -07001724 _PostParseCheck(parser, options, args)
Brian Harring3fec5a82012-03-01 05:57:03 -08001725
Mike Frysinger8fd67dc2012-12-03 23:51:18 -05001726 cros_build_lib.AssertOutsideChroot()
Zdenek Behan98ec2fb2012-08-31 17:12:18 +02001727
Brian Harring3fec5a82012-03-01 05:57:03 -08001728 if options.remote:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001729 cros_build_lib.logger.setLevel(logging.WARNING)
Ryan Cui16ca5812012-03-08 20:34:27 -08001730
Brian Harring3fec5a82012-03-01 05:57:03 -08001731 # Verify configs are valid.
Dan Shi0bdb7132013-07-30 16:22:12 -07001732 # If hwtest flag is enabled, post a warning that HWTest step may fail if the
1733 # specified board is not a released platform or it is a generic overlay.
Brian Harring3fec5a82012-03-01 05:57:03 -08001734 for bot in args:
Aviv Kesheta96a2a92013-02-05 17:21:51 -08001735 build_config = _GetConfig(bot)
1736 if options.hwtest:
Dan Shi0bdb7132013-07-30 16:22:12 -07001737 cros_build_lib.Warning(
1738 'If %s is not a released platform or it is a generic overlay, '
1739 'the HWTest step will most likely not run; please ask the lab '
1740 'team for help if this is unexpected.' % build_config['boards'])
Brian Harring3fec5a82012-03-01 05:57:03 -08001741
1742 # Verify gerrit patches are valid.
Mike Frysinger383367e2014-09-16 15:06:17 -04001743 print('Verifying patches...')
Ryan Cuie1e4e662012-05-21 16:39:46 -07001744 patch_pool = AcquirePoolFromOptions(options)
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001745
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001746 # --debug need to be explicitly passed through for remote invocations.
1747 if options.buildbot and '--debug' not in options.pass_through_args:
1748 _ConfirmRemoteBuildbotRun()
1749
Mike Frysinger383367e2014-09-16 15:06:17 -04001750 print('Submitting tryjob...')
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001751 tryjob = remote_try.RemoteTryJob(options, args, patch_pool.local_patches)
Ryan Cuia25d8eb2012-07-11 14:54:27 -07001752 tryjob.Submit(testjob=options.test_tryjob, dryrun=False)
Mike Frysinger383367e2014-09-16 15:06:17 -04001753 print('Tryjob submitted!')
1754 print(('Go to %s to view the status of your job.'
1755 % tryjob.GetTrybotWaterfallLink()))
Brian Harring3fec5a82012-03-01 05:57:03 -08001756 sys.exit(0)
Matt Tennant759e2352013-09-27 15:14:44 -07001757
Ryan Cui54da0702012-04-19 18:38:08 -07001758 elif (not options.buildbot and not options.remote_trybot
1759 and not options.resume and not options.local):
Mike Frysinger5672a2a2014-05-31 22:29:57 -04001760 cros_build_lib.Die('Please use --remote or --local to run trybots')
Brian Harring3fec5a82012-03-01 05:57:03 -08001761
Matt Tennant759e2352013-09-27 15:14:44 -07001762 # Only one config arg is allowed in this mode, which was confirmed earlier.
Ryan Cui8be16062012-04-24 12:05:26 -07001763 bot_id = args[-1]
1764 build_config = _GetConfig(bot_id)
Brian Harring3fec5a82012-03-01 05:57:03 -08001765
Don Garrettbbd7b552014-05-16 13:15:21 -07001766 # TODO: Re-enable this block when reference_repo support handles this
1767 # properly. (see chromium:330775)
1768 # if options.reference_repo is None:
1769 # repo_path = os.path.join(options.sourceroot, '.repo')
1770 # # If we're being run from a repo checkout, reuse the repo's git pool to
1771 # # cut down on sync time.
1772 # if os.path.exists(repo_path):
1773 # options.reference_repo = options.sourceroot
1774
1775 if options.reference_repo:
David Jamesdac7a912013-11-18 11:14:44 -08001776 if not os.path.exists(options.reference_repo):
1777 parser.error('Reference path %s does not exist'
1778 % (options.reference_repo,))
1779 elif not os.path.exists(os.path.join(options.reference_repo, '.repo')):
1780 parser.error('Reference path %s does not look to be the base of a '
1781 'repo checkout; no .repo exists in the root.'
1782 % (options.reference_repo,))
1783
Brian Harringf11bf682012-05-14 15:53:43 -07001784 if (options.buildbot or options.remote_trybot) and not options.resume:
Brian Harring470f6112012-03-02 11:47:10 -08001785 if not options.cgroups:
Ryan Cuid4a24212012-04-04 18:08:12 -07001786 parser.error('Options --buildbot/--remote-trybot and --nocgroups cannot '
1787 'be used together. Cgroup support is required for '
1788 'buildbot/remote-trybot mode.')
Mike Frysingera78a56e2012-11-20 06:02:30 -05001789 if not cgroups.Cgroup.IsSupported():
Ryan Cuid4a24212012-04-04 18:08:12 -07001790 parser.error('Option --buildbot/--remote-trybot was given, but this '
1791 'system does not support cgroups. Failing.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001792
David Jamesaad5cc72012-10-26 15:03:13 -07001793 missing = osutils.FindMissingBinaries(_BUILDBOT_REQUIRED_BINARIES)
Brian Harring351ce442012-03-09 16:38:14 -08001794 if missing:
David Jameseecba232014-06-11 11:35:11 -07001795 parser.error('Option --buildbot/--remote-trybot requires the following '
Ryan Cuid4a24212012-04-04 18:08:12 -07001796 "binaries which couldn't be found in $PATH: %s"
Brian Harring351ce442012-03-09 16:38:14 -08001797 % (', '.join(missing)))
1798
David Jamesdac7a912013-11-18 11:14:44 -08001799 if options.reference_repo:
1800 options.reference_repo = os.path.abspath(options.reference_repo)
1801
Brian Harring3fec5a82012-03-01 05:57:03 -08001802 if not options.buildroot:
1803 if options.buildbot:
Mike Frysinger6903c762012-12-04 01:57:16 -05001804 parser.error('Please specify a buildroot with the --buildbot option.')
Matt Tennantd55b1f42012-04-13 14:15:01 -07001805
Ryan Cui5ba7e152012-05-10 14:36:52 -07001806 options.buildroot = _DetermineDefaultBuildRoot(options.sourceroot,
1807 build_config['internal'])
Brian Harring470f6112012-03-02 11:47:10 -08001808 # We use a marker file in the buildroot to indicate the user has
1809 # consented to using this directory.
1810 if not os.path.exists(repository.GetTrybotMarkerPath(options.buildroot)):
1811 _ConfirmBuildRoot(options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -08001812
1813 # Sanity check of buildroot- specifically that it's not pointing into the
1814 # midst of an existing repo since git-repo doesn't support nesting.
Brian Harring3fec5a82012-03-01 05:57:03 -08001815 if (not repository.IsARepoRoot(options.buildroot) and
David James13a69c92013-05-09 10:37:42 -07001816 git.FindRepoDir(options.buildroot)):
Brian Harring3fec5a82012-03-01 05:57:03 -08001817 parser.error('Configured buildroot %s points into a repository checkout, '
1818 'rather than the root of it. This is not supported.'
1819 % options.buildroot)
1820
Chris Sosab5ea3b42012-10-25 15:25:20 -07001821 if not options.log_dir:
1822 options.log_dir = os.path.join(options.buildroot, _DEFAULT_LOG_DIR)
1823
Brian Harringd166aaf2012-05-14 18:31:53 -07001824 log_file = None
1825 if options.tee:
Chris Sosab5ea3b42012-10-25 15:25:20 -07001826 log_file = os.path.join(options.log_dir, _BUILDBOT_LOG_FILE)
1827 osutils.SafeMakedirs(options.log_dir)
Brian Harringd166aaf2012-05-14 18:31:53 -07001828 _BackupPreviousLog(log_file)
1829
Brian Harring1b8c4c82012-05-29 23:03:04 -07001830 with cros_build_lib.ContextManagerStack() as stack:
Aaron Gable881fccb2013-09-27 18:35:24 -07001831 # TODO(ferringb): update this once
1832 # https://chromium-review.googlesource.com/25359
David Jamescebc7272013-07-17 16:45:05 -07001833 # is landed- it's sensitive to the manifest-versions cache path.
1834 options.preserve_paths = set(['manifest-versions', '.cache',
1835 'manifest-versions-internal'])
1836 if log_file is not None:
1837 # We don't want the critical section to try to clean up the tee process,
1838 # so we run Tee (forked off) outside of it. This prevents a deadlock
1839 # because the Tee process only exits when its pipe is closed, and the
1840 # critical section accidentally holds on to that file handle.
1841 stack.Add(tee.Tee, log_file)
1842 options.preserve_paths.add(_DEFAULT_LOG_DIR)
1843
Brian Harringc2d09d92012-05-13 22:03:15 -07001844 critical_section = stack.Add(cleanup.EnforcedCleanupSection)
1845 stack.Add(sudo.SudoKeepAlive)
Brian Harringd166aaf2012-05-14 18:31:53 -07001846
Brian Harringc2d09d92012-05-13 22:03:15 -07001847 if not options.resume:
Brian Harring2bf55e12012-05-13 21:31:55 -07001848 # If we're in resume mode, use our parents tempdir rather than
1849 # nesting another layer.
David James4bc13702013-03-26 08:08:04 -07001850 stack.Add(osutils.TempDir, prefix='cbuildbot-tmp', set_global=True)
David Jameseecba232014-06-11 11:35:11 -07001851 logging.debug('Cbuildbot tempdir is %r.', os.environ.get('TMP'))
Brian Harringd166aaf2012-05-14 18:31:53 -07001852
Brian Harringc2d09d92012-05-13 22:03:15 -07001853 if options.cgroups:
1854 stack.Add(cgroups.SimpleContainChildren, 'cbuildbot')
Brian Harringa184efa2012-03-04 11:51:25 -08001855
Brian Harringc2d09d92012-05-13 22:03:15 -07001856 # Mark everything between EnforcedCleanupSection and here as having to
1857 # be rolled back via the contextmanager cleanup handlers. This
1858 # ensures that sudo bits cannot outlive cbuildbot, that anything
1859 # cgroups would kill gets killed, etc.
David Jamesfb3aac92013-10-16 13:26:52 -07001860 stack.Add(critical_section.ForkWatchdog)
Brian Harringd166aaf2012-05-14 18:31:53 -07001861
Brian Harringc2d09d92012-05-13 22:03:15 -07001862 if options.timeout > 0:
David James3432acd2013-11-27 10:02:18 -08001863 stack.Add(timeout_util.FatalTimeout, options.timeout)
Brian Harringa184efa2012-03-04 11:51:25 -08001864
Brian Harringc2d09d92012-05-13 22:03:15 -07001865 if not options.buildbot:
1866 build_config = cbuildbot_config.OverrideConfigForTrybot(
Don Garrett4bb21682014-03-03 16:16:23 -08001867 build_config, options)
Brian Harringc2d09d92012-05-13 22:03:15 -07001868
Aviv Kesheta0159be2013-12-12 13:56:28 -08001869 if options.mock_tree_status is not None:
1870 stack.Add(mock.patch.object, timeout_util, '_GetStatus',
1871 return_value=options.mock_tree_status)
1872
Aviv Keshetcf9c2722014-02-25 15:15:10 -08001873 if options.mock_slave_status is not None:
1874 with open(options.mock_slave_status, 'r') as f:
Aviv Keshet4e750022014-03-07 16:50:34 -08001875 mock_statuses = pickle.load(f)
1876 for key, value in mock_statuses.iteritems():
1877 mock_statuses[key] = manifest_version.BuilderStatus(**value)
Yu-Ju Hongd0fda382014-05-09 15:28:24 -07001878 stack.Add(mock.patch.object,
1879 completion_stages.MasterSlaveSyncCompletionStage,
1880 '_FetchSlaveStatuses',
1881 return_value=mock_statuses)
Aviv Keshetcf9c2722014-02-25 15:15:10 -08001882
Aviv Keshet64133022014-08-25 15:50:52 -07001883 _SetupCidb(options, build_config)
Don Garrettb4318362014-10-03 15:49:36 -07001884 retry_stats.SetupStats()
Aviv Keshet2982af52014-08-13 16:07:57 -07001885
Brian Harringc2d09d92012-05-13 22:03:15 -07001886 _RunBuildStagesWrapper(options, build_config)