blob: 091dbbea58dc5dd7b4177440d874956fc14f1bc6 [file] [log] [blame]
Brian Harring3fec5a82012-03-01 05:57:03 -08001#!/usr/bin/python
2
Mike Frysingerd6925b52012-07-16 16:11:00 -04003# Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
Brian Harring3fec5a82012-03-01 05:57:03 -08004# Use of this source code is governed by a BSD-style license that can be
5# found in the LICENSE file.
6
7"""Main builder code for Chromium OS.
8
9Used by Chromium OS buildbot configuration for all Chromium OS builds including
10full and pre-flight-queue builds.
11"""
12
David James1fddb8f2013-04-25 15:23:07 -070013import collections
Brian Harring3fec5a82012-03-01 05:57:03 -080014import distutils.version
Mike Frysinger6903c762012-12-04 01:57:16 -050015import errno
Brian Harring3fec5a82012-03-01 05:57:03 -080016import glob
Chris Sosa4f6ffaf2012-05-01 17:05:44 -070017import logging
Brian Harring3fec5a82012-03-01 05:57:03 -080018import optparse
19import os
David James5596d0e2014-03-14 06:40:41 -070020import multiprocessing
Aviv Keshetcf9c2722014-02-25 15:15:10 -080021import pickle
Brian Harring3fec5a82012-03-01 05:57:03 -080022import sys
Ryan Cui54da0702012-04-19 18:38:08 -070023import time
David James3541a132013-03-18 13:21:58 -070024import traceback
Brian Harring3fec5a82012-03-01 05:57:03 -080025
Brian Harring3fec5a82012-03-01 05:57:03 -080026from chromite.buildbot import cbuildbot_config
27from chromite.buildbot import cbuildbot_stages as stages
28from chromite.buildbot import cbuildbot_results as results_lib
Matt Tennantefb59522013-10-18 13:49:28 -070029from chromite.buildbot import cbuildbot_run
Brian Harring3fec5a82012-03-01 05:57:03 -080030from chromite.buildbot import constants
Aviv Keshet4e750022014-03-07 16:50:34 -080031from chromite.buildbot import manifest_version
Brian Harring3fec5a82012-03-01 05:57:03 -080032from chromite.buildbot import remote_try
33from chromite.buildbot import repository
34from chromite.buildbot import tee
Ryan Cui16d9e1f2012-05-11 10:50:18 -070035from chromite.buildbot import trybot_patch_pool
Brian Harring3fec5a82012-03-01 05:57:03 -080036
Brian Harringc92a7012012-02-29 10:11:34 -080037from chromite.lib import cgroups
Brian Harringa184efa2012-03-04 11:51:25 -080038from chromite.lib import cleanup
Brian Harringb6cf9142012-09-01 20:43:17 -070039from chromite.lib import commandline
Brian Harring1b8c4c82012-05-29 23:03:04 -070040from chromite.lib import cros_build_lib
David Jamesa0a664e2013-02-13 09:52:01 -080041from chromite.lib import gclient
Brian Harring511055e2012-10-10 02:58:59 -070042from chromite.lib import gerrit
David James97d95872012-11-16 15:09:56 -080043from chromite.lib import git
Brian Harringaf019fb2012-05-10 15:06:13 -070044from chromite.lib import osutils
Brian Harring511055e2012-10-10 02:58:59 -070045from chromite.lib import patch as cros_patch
David James6450a0a2012-12-04 07:59:53 -080046from chromite.lib import parallel
Brian Harring3fec5a82012-03-01 05:57:03 -080047from chromite.lib import sudo
David James3432acd2013-11-27 10:02:18 -080048from chromite.lib import timeout_util
Brian Harring3fec5a82012-03-01 05:57:03 -080049
Aviv Kesheta0159be2013-12-12 13:56:28 -080050import mock
51
Ryan Cuiadd49122012-03-21 22:19:58 -070052
Brian Harring3fec5a82012-03-01 05:57:03 -080053_DEFAULT_LOG_DIR = 'cbuildbot_logs'
54_BUILDBOT_LOG_FILE = 'cbuildbot.log'
55_DEFAULT_EXT_BUILDROOT = 'trybot'
56_DEFAULT_INT_BUILDROOT = 'trybot-internal'
Brian Harring351ce442012-03-09 16:38:14 -080057_BUILDBOT_REQUIRED_BINARIES = ('pbzip2',)
Ryan Cui1c13a252012-10-16 15:00:16 -070058_API_VERSION_ATTR = 'api_version'
Brian Harring3fec5a82012-03-01 05:57:03 -080059
60
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070061def _PrintValidConfigs(display_all=False):
Brian Harring3fec5a82012-03-01 05:57:03 -080062 """Print a list of valid buildbot configs.
63
Mike Frysinger02e1e072013-11-10 22:11:34 -050064 Args:
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070065 display_all: Print all configs. Otherwise, prints only configs with
66 trybot_list=True.
Brian Harring3fec5a82012-03-01 05:57:03 -080067 """
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070068 def _GetSortKey(config_name):
69 config_dict = cbuildbot_config.config[config_name]
70 return (not config_dict['trybot_list'], config_dict['description'],
71 config_name)
72
Brian Harring3fec5a82012-03-01 05:57:03 -080073 COLUMN_WIDTH = 45
Matt Tennant763497d2014-01-17 16:45:54 -080074 print
Brian Harring3fec5a82012-03-01 05:57:03 -080075 print 'config'.ljust(COLUMN_WIDTH), 'description'
76 print '------'.ljust(COLUMN_WIDTH), '-----------'
77 config_names = cbuildbot_config.config.keys()
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070078 config_names.sort(key=_GetSortKey)
Brian Harring3fec5a82012-03-01 05:57:03 -080079 for name in config_names:
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070080 if display_all or cbuildbot_config.config[name]['trybot_list']:
81 desc = cbuildbot_config.config[name].get('description')
82 desc = desc if desc else ''
Brian Harring3fec5a82012-03-01 05:57:03 -080083 print name.ljust(COLUMN_WIDTH), desc
84
Matt Tennant763497d2014-01-17 16:45:54 -080085 print
86
Brian Harring3fec5a82012-03-01 05:57:03 -080087
88def _GetConfig(config_name):
Matt Tennant763497d2014-01-17 16:45:54 -080089 """Gets the configuration for the build if it exists, None otherwise."""
90 if cbuildbot_config.config.has_key(config_name):
91 return cbuildbot_config.config[config_name]
Brian Harring3fec5a82012-03-01 05:57:03 -080092
93
Ryan Cuie1e4e662012-05-21 16:39:46 -070094def AcquirePoolFromOptions(options):
Ryan Cui16d9e1f2012-05-11 10:50:18 -070095 """Generate patch objects from passed in options.
Brian Harring3fec5a82012-03-01 05:57:03 -080096
97 Args:
Ryan Cui16d9e1f2012-05-11 10:50:18 -070098 options: The options object generated by optparse.
Brian Harring3fec5a82012-03-01 05:57:03 -080099
Ryan Cuif7f24692012-05-18 16:35:33 -0700100 Returns:
101 trybot_patch_pool.TrybotPatchPool object.
102
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700103 Raises:
Brian Harring511055e2012-10-10 02:58:59 -0700104 gerrit.GerritException, cros_patch.PatchException
Brian Harring3fec5a82012-03-01 05:57:03 -0800105 """
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700106 gerrit_patches = []
107 local_patches = []
108 remote_patches = []
Brian Harring3fec5a82012-03-01 05:57:03 -0800109
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700110 if options.gerrit_patches:
Brian Harring511055e2012-10-10 02:58:59 -0700111 gerrit_patches = gerrit.GetGerritPatchInfo(
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700112 options.gerrit_patches)
113 for patch in gerrit_patches:
114 if patch.IsAlreadyMerged():
Brian Harring1b8c4c82012-05-29 23:03:04 -0700115 cros_build_lib.Warning('Patch %s has already been merged.' % str(patch))
Brian Harring3fec5a82012-03-01 05:57:03 -0800116
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700117 if options.local_patches:
David James97d95872012-11-16 15:09:56 -0800118 manifest = git.ManifestCheckout.Cached(options.sourceroot)
Brian Harring609dc4e2012-05-07 02:17:44 -0700119 local_patches = cros_patch.PrepareLocalPatches(manifest,
120 options.local_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800121
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700122 if options.remote_patches:
123 remote_patches = cros_patch.PrepareRemotePatches(
124 options.remote_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800125
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700126 return trybot_patch_pool.TrybotPatchPool(gerrit_patches, local_patches,
127 remote_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800128
129
Brian Harring3fec5a82012-03-01 05:57:03 -0800130class Builder(object):
131 """Parent class for all builder types.
132
Matt Tennant759e2352013-09-27 15:14:44 -0700133 This class functions as an abstract parent class for various build types.
134 Its intended use is builder_instance.Run().
Brian Harring3fec5a82012-03-01 05:57:03 -0800135
Matt Tennant3f351552014-01-03 14:28:00 -0800136 Attributes:
137 _run: The BuilderRun object for this run.
138 archive_stages: Dict of BuildConfig keys to ArchiveStage values.
139 patch_pool: TrybotPatchPool.
Brian Harring3fec5a82012-03-01 05:57:03 -0800140 """
141
Matt Tennantefb59522013-10-18 13:49:28 -0700142 def __init__(self, builder_run):
Brian Harring3fec5a82012-03-01 05:57:03 -0800143 """Initializes instance variables. Must be called by all subclasses."""
Matt Tennantefb59522013-10-18 13:49:28 -0700144 self._run = builder_run
Brian Harring3fec5a82012-03-01 05:57:03 -0800145
Matt Tennantefb59522013-10-18 13:49:28 -0700146 if self._run.config.chromeos_official:
Brian Harring3fec5a82012-03-01 05:57:03 -0800147 os.environ['CHROMEOS_OFFICIAL'] = '1'
148
David James58e0c092012-03-04 20:31:12 -0800149 self.archive_stages = {}
Brian Harring76d1bf62012-06-01 13:52:48 -0700150 self.patch_pool = trybot_patch_pool.TrybotPatchPool()
David James5596d0e2014-03-14 06:40:41 -0700151 self._build_image_lock = multiprocessing.Lock()
Brian Harring3fec5a82012-03-01 05:57:03 -0800152
153 def Initialize(self):
154 """Runs through the initialization steps of an actual build."""
Matt Tennantefb59522013-10-18 13:49:28 -0700155 if self._run.options.resume:
156 results_lib.LoadCheckpoint(self._run.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800157
Brian Harring3fec5a82012-03-01 05:57:03 -0800158 self._RunStage(stages.CleanUpStage)
159
160 def _GetStageInstance(self, stage, *args, **kwargs):
Matt Tennant759e2352013-09-27 15:14:44 -0700161 """Helper function to get a stage instance given the args.
Brian Harring3fec5a82012-03-01 05:57:03 -0800162
Matt Tennantefb59522013-10-18 13:49:28 -0700163 Useful as almost all stages just take in builder_run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800164 """
Matt Tennantefb59522013-10-18 13:49:28 -0700165 # Normally the default BuilderRun (self._run) is used, but it can
166 # be overridden with "builder_run" kwargs (e.g. for child configs).
167 builder_run = kwargs.pop('builder_run', self._run)
168 return stage(builder_run, *args, **kwargs)
Brian Harring3fec5a82012-03-01 05:57:03 -0800169
170 def _SetReleaseTag(self):
Matt Tennant9c1c8492014-02-27 13:09:07 -0800171 """Sets run.attrs.release_tag from the manifest manager used in sync.
Brian Harring3fec5a82012-03-01 05:57:03 -0800172
Matt Tennantf4980ee2014-01-29 09:21:27 -0800173 Must be run after sync stage as syncing enables us to have a release tag,
174 and must be run before any usage of attrs.release_tag.
Matt Tennantefb59522013-10-18 13:49:28 -0700175
176 TODO(mtennant): Find a bottleneck place in syncing that can set this
Matt Tennantf4980ee2014-01-29 09:21:27 -0800177 directly. Be careful, as there are several kinds of syncing stages, and
178 sync stages have been known to abort with sys.exit calls.
Brian Harring3fec5a82012-03-01 05:57:03 -0800179 """
Matt Tennantefb59522013-10-18 13:49:28 -0700180 manifest_manager = getattr(self._run.attrs, 'manifest_manager', None)
Brian Harring3fec5a82012-03-01 05:57:03 -0800181 if manifest_manager:
Matt Tennantefb59522013-10-18 13:49:28 -0700182 self._run.attrs.release_tag = manifest_manager.current_version
Matt Tennant3f351552014-01-03 14:28:00 -0800183 else:
184 self._run.attrs.release_tag = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800185
Matt Tennanta42a5742014-02-09 13:42:12 -0800186 cros_build_lib.Debug('Saved release_tag value for run: %r',
187 self._run.attrs.release_tag)
188
Brian Harring3fec5a82012-03-01 05:57:03 -0800189 def _RunStage(self, stage, *args, **kwargs):
Matt Tennant759e2352013-09-27 15:14:44 -0700190 """Wrapper to run a stage.
191
192 Args:
193 stage: A BuilderStage class.
194 args: args to pass to stage constructor.
195 kwargs: kwargs to pass to stage constructor.
Mike Frysinger1a736a82013-12-12 01:50:59 -0500196
Matt Tennant759e2352013-09-27 15:14:44 -0700197 Returns:
Matt Tennant759e2352013-09-27 15:14:44 -0700198 Whatever the stage's Run method returns.
199 """
Brian Harring3fec5a82012-03-01 05:57:03 -0800200 stage_instance = self._GetStageInstance(stage, *args, **kwargs)
201 return stage_instance.Run()
202
Matt Tennantf4980ee2014-01-29 09:21:27 -0800203 def _RunSyncStage(self, sync_instance):
204 """Run given |sync_instance| stage and be sure attrs.release_tag set."""
205 try:
206 sync_instance.Run()
207 finally:
208 self._SetReleaseTag()
209
Brian Harring3fec5a82012-03-01 05:57:03 -0800210 def GetSyncInstance(self):
211 """Returns an instance of a SyncStage that should be run.
212
213 Subclasses must override this method.
214 """
215 raise NotImplementedError()
216
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400217 def GetCompletionInstance(self):
Aviv Keshetf2746152013-11-26 10:42:46 -0800218 """Returns the MasterSlaveSyncCompletionStage for this build.
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400219
220 Subclasses may override this method.
221
Mike Frysinger02e1e072013-11-10 22:11:34 -0500222 Returns:
223 None
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400224 """
225 return None
226
Brian Harring3fec5a82012-03-01 05:57:03 -0800227 def RunStages(self):
228 """Subclasses must override this method. Runs the appropriate code."""
229 raise NotImplementedError()
230
Brian Harring3fec5a82012-03-01 05:57:03 -0800231 def _ReExecuteInBuildroot(self, sync_instance):
232 """Reexecutes self in buildroot and returns True if build succeeds.
233
234 This allows the buildbot code to test itself when changes are patched for
235 buildbot-related code. This is a no-op if the buildroot == buildroot
236 of the running chromite checkout.
237
238 Args:
Matt Tennant85348852014-01-10 15:16:02 -0800239 sync_instance: Instance of the sync stage that was run to sync.
Brian Harring3fec5a82012-03-01 05:57:03 -0800240
241 Returns:
242 True if the Build succeeded.
243 """
Matt Tennantefb59522013-10-18 13:49:28 -0700244 if not self._run.options.resume:
245 results_lib.WriteCheckpoint(self._run.options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800246
Ryan Cui1c13a252012-10-16 15:00:16 -0700247 args = stages.BootstrapStage.FilterArgsForTargetCbuildbot(
Matt Tennantefb59522013-10-18 13:49:28 -0700248 self._run.options.buildroot, constants.PATH_TO_CBUILDBOT,
249 self._run.options)
Brian Harring37e559b2012-05-22 20:47:32 -0700250
David James2333c182013-02-13 16:16:15 -0800251 # Specify a buildroot explicitly (just in case, for local trybot).
Brian Harring3fec5a82012-03-01 05:57:03 -0800252 # Suppress any timeout options given from the commandline in the
253 # invoked cbuildbot; our timeout will enforce it instead.
Ryan Cui1c13a252012-10-16 15:00:16 -0700254 args += ['--resume', '--timeout', '0', '--notee', '--nocgroups',
Matt Tennantefb59522013-10-18 13:49:28 -0700255 '--buildroot', os.path.abspath(self._run.options.buildroot)]
Brian Harringae0a5322012-09-15 01:46:51 -0700256
Matt Tennantefb59522013-10-18 13:49:28 -0700257 if hasattr(self._run.attrs, 'manifest_manager'):
258 # TODO(mtennant): Is this the same as self._run.attrs.release_tag?
259 ver = self._run.attrs.manifest_manager.current_version
Ryan Cui1c13a252012-10-16 15:00:16 -0700260 args += ['--version', ver]
Brian Harring3fec5a82012-03-01 05:57:03 -0800261
David Jamesf421c6d2013-04-11 15:37:57 -0700262 pool = getattr(sync_instance, 'pool', None)
263 if pool:
Matt Tennantefb59522013-10-18 13:49:28 -0700264 filename = os.path.join(self._run.options.buildroot,
265 'validation_pool.dump')
David Jamesf421c6d2013-04-11 15:37:57 -0700266 pool.Save(filename)
267 args += ['--validation_pool', filename]
Brian Harring3fec5a82012-03-01 05:57:03 -0800268
David Jamesac8c2a72013-02-13 18:44:33 -0800269 # Reset the cache dir so that the child will calculate it automatically.
Matt Tennantefb59522013-10-18 13:49:28 -0700270 if not self._run.options.cache_dir_specified:
David Jamesac8c2a72013-02-13 18:44:33 -0800271 commandline.BaseParser.ConfigureCacheDir(None)
272
Brian Harring3fec5a82012-03-01 05:57:03 -0800273 # Re-run the command in the buildroot.
274 # Finally, be generous and give the invoked cbuildbot 30s to shutdown
275 # when something occurs. It should exit quicker, but the sigterm may
276 # hit while the system is particularly busy.
Brian Harring1b8c4c82012-05-29 23:03:04 -0700277 return_obj = cros_build_lib.RunCommand(
Matt Tennantefb59522013-10-18 13:49:28 -0700278 args, cwd=self._run.options.buildroot, error_code_ok=True,
279 kill_timeout=30)
Brian Harring3fec5a82012-03-01 05:57:03 -0800280 return return_obj.returncode == 0
281
Ryan Cuif7f24692012-05-18 16:35:33 -0700282 def _InitializeTrybotPatchPool(self):
283 """Generate patch pool from patches specified on the command line.
284
285 Do this only if we need to patch changes later on.
286 """
287 changes_stage = stages.PatchChangesStage.StageNamePrefix()
288 check_func = results_lib.Results.PreviouslyCompletedRecord
Matt Tennantefb59522013-10-18 13:49:28 -0700289 if not check_func(changes_stage) or self._run.options.bootstrap:
290 self.patch_pool = AcquirePoolFromOptions(self._run.options)
Ryan Cuif7f24692012-05-18 16:35:33 -0700291
292 def _GetBootstrapStage(self):
293 """Constructs and returns the BootStrapStage object.
294
295 We return None when there are no chromite patches to test, and
296 --test-bootstrap wasn't passed in.
297 """
298 stage = None
299 chromite_pool = self.patch_pool.Filter(project=constants.CHROMITE_PROJECT)
Ryan Cui5616a512012-08-17 13:39:36 -0700300 manifest_pool = self.patch_pool.FilterManifest()
David James97d95872012-11-16 15:09:56 -0800301 chromite_branch = git.GetChromiteTrackingBranch()
Matt Tennantefb59522013-10-18 13:49:28 -0700302 if (chromite_pool or manifest_pool or
303 self._run.options.test_bootstrap or
304 chromite_branch != self._run.options.branch):
305 stage = stages.BootstrapStage(self._run, chromite_pool,
306 manifest_pool)
Ryan Cuif7f24692012-05-18 16:35:33 -0700307 return stage
308
Brian Harring3fec5a82012-03-01 05:57:03 -0800309 def Run(self):
Ryan Cuif7f24692012-05-18 16:35:33 -0700310 """Main runner for this builder class. Runs build and prints summary.
311
312 Returns:
313 Whether the build succeeded.
314 """
315 self._InitializeTrybotPatchPool()
316
Matt Tennantefb59522013-10-18 13:49:28 -0700317 if self._run.options.bootstrap:
Ryan Cuif7f24692012-05-18 16:35:33 -0700318 bootstrap_stage = self._GetBootstrapStage()
319 if bootstrap_stage:
320 # BootstrapStage blocks on re-execution of cbuildbot.
321 bootstrap_stage.Run()
322 return bootstrap_stage.returncode == 0
323
Brian Harring3fec5a82012-03-01 05:57:03 -0800324 print_report = True
David James3d4d3502012-04-09 15:12:06 -0700325 exception_thrown = False
Brian Harring3fec5a82012-03-01 05:57:03 -0800326 success = True
David James9ebb2a42013-08-13 20:29:57 -0700327 sync_instance = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800328 try:
329 self.Initialize()
330 sync_instance = self.GetSyncInstance()
Matt Tennantf4980ee2014-01-29 09:21:27 -0800331 self._RunSyncStage(sync_instance)
Brian Harring3fec5a82012-03-01 05:57:03 -0800332
Matt Tennantefb59522013-10-18 13:49:28 -0700333 if self._run.ShouldPatchAfterSync():
Ryan Cui88b901c2013-06-21 11:35:30 -0700334 # Filter out patches to manifest, since PatchChangesStage can't handle
335 # them. Manifest patches are patched in the BootstrapStage.
336 non_manifest_patches = self.patch_pool.FilterManifest(negate=True)
337 if non_manifest_patches:
338 self._RunStage(stages.PatchChangesStage, non_manifest_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800339
Matt Tennantefb59522013-10-18 13:49:28 -0700340 if self._run.ShouldReexecAfterSync():
Brian Harring3fec5a82012-03-01 05:57:03 -0800341 print_report = False
342 success = self._ReExecuteInBuildroot(sync_instance)
343 else:
344 self.RunStages()
Matt Tennant759e2352013-09-27 15:14:44 -0700345
David James3541a132013-03-18 13:21:58 -0700346 except Exception as ex:
347 # If the build is marked as successful, but threw exceptions, that's a
348 # problem.
David James7fbf2d42012-07-14 18:23:49 -0700349 exception_thrown = True
David James3541a132013-03-18 13:21:58 -0700350 if results_lib.Results.BuildSucceededSoFar():
351 traceback.print_exc(file=sys.stdout)
David James7fbf2d42012-07-14 18:23:49 -0700352 raise
Matt Tennant759e2352013-09-27 15:14:44 -0700353
David James3541a132013-03-18 13:21:58 -0700354 if not (print_report and isinstance(ex, results_lib.StepFailure)):
355 raise
Matt Tennant759e2352013-09-27 15:14:44 -0700356
Brian Harring3fec5a82012-03-01 05:57:03 -0800357 finally:
358 if print_report:
Matt Tennantefb59522013-10-18 13:49:28 -0700359 results_lib.WriteCheckpoint(self._run.options.buildroot)
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400360 completion_instance = self.GetCompletionInstance()
Matt Tennant066d9322014-01-28 10:37:48 -0800361 self._RunStage(stages.ReportStage, sync_instance, completion_instance)
Brian Harring3fec5a82012-03-01 05:57:03 -0800362 success = results_lib.Results.BuildSucceededSoFar()
David James3d4d3502012-04-09 15:12:06 -0700363 if exception_thrown and success:
364 success = False
David Jamesbb20ac82012-07-18 10:59:16 -0700365 cros_build_lib.PrintBuildbotStepWarnings()
366 print """\
David James3d4d3502012-04-09 15:12:06 -0700367Exception thrown, but all stages marked successful. This is an internal error,
368because the stage that threw the exception should be marked as failing."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800369
370 return success
371
372
David James1fddb8f2013-04-25 15:23:07 -0700373BoardConfig = collections.namedtuple('BoardConfig', ['board', 'name'])
374
375
Brian Harring3fec5a82012-03-01 05:57:03 -0800376class SimpleBuilder(Builder):
377 """Builder that performs basic vetting operations."""
378
379 def GetSyncInstance(self):
380 """Sync to lkgm or TOT as necessary.
381
Mike Frysinger02e1e072013-11-10 22:11:34 -0500382 Returns:
383 The instance of the sync stage to run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800384 """
Matt Tennantefb59522013-10-18 13:49:28 -0700385 if self._run.options.force_version:
Ryan Cui88b901c2013-06-21 11:35:30 -0700386 sync_stage = self._GetStageInstance(stages.ManifestVersionedSyncStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700387 elif self._run.config.use_lkgm:
Brian Harring3fec5a82012-03-01 05:57:03 -0800388 sync_stage = self._GetStageInstance(stages.LKGMSyncStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700389 elif self._run.config.use_chrome_lkgm:
Chris Sosa52a81b62012-11-14 06:12:54 -0800390 sync_stage = self._GetStageInstance(stages.ChromeLKGMSyncStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800391 else:
392 sync_stage = self._GetStageInstance(stages.SyncStage)
393
394 return sync_stage
395
David James4f2d8302013-03-19 06:35:58 -0700396 @staticmethod
397 def _RunParallelStages(stage_objs):
Matt Tennant759e2352013-09-27 15:14:44 -0700398 """Run the specified stages in parallel.
399
400 Args:
401 stage_objs: BuilderStage objects.
402 """
David James4f2d8302013-03-19 06:35:58 -0700403 steps = [stage.Run for stage in stage_objs]
404 try:
405 parallel.RunParallelSteps(steps)
Matt Tennant0940c382014-01-21 20:43:55 -0800406
David James4f2d8302013-03-19 06:35:58 -0700407 except BaseException as ex:
408 # If a stage threw an exception, it might not have correctly reported
409 # results (e.g. because it was killed before it could report the
410 # results.) In this case, attribute the exception to any stages that
411 # didn't report back correctly (if any).
412 for stage in stage_objs:
David James6b704242013-10-18 14:51:37 -0700413 for name in stage.GetStageNames():
414 if not results_lib.Results.StageHasResults(name):
415 results_lib.Results.Record(name, ex, str(ex))
Matt Tennant759e2352013-09-27 15:14:44 -0700416
David James4f2d8302013-03-19 06:35:58 -0700417 raise
418
David James5596d0e2014-03-14 06:40:41 -0700419 def _RunBackgroundStagesForBoard(self, builder_run, board):
Matt Tennant759e2352013-09-27 15:14:44 -0700420 """Run background board-specific stages for the specified board.
421
422 Args:
Matt Tennantefb59522013-10-18 13:49:28 -0700423 builder_run: BuilderRun object for these background stages.
Matt Tennant759e2352013-09-27 15:14:44 -0700424 board: Board name.
Matt Tennant759e2352013-09-27 15:14:44 -0700425 """
Matt Tennantefb59522013-10-18 13:49:28 -0700426 config = builder_run.config
Matt Tennant066d9322014-01-28 10:37:48 -0800427
428 # TODO(mtennant): This is the last usage of self.archive_stages. We can
429 # kill it once we migrate its uses to BuilderRun so that none of the
430 # stages below need it as an argument.
Matt Tennantefb59522013-10-18 13:49:28 -0700431 archive_stage = self.archive_stages[BoardConfig(board, config.name)]
432 if config.pgo_generate:
Ahmad Sharifa2db40a2013-07-22 13:51:52 -0400433 self._RunParallelStages([archive_stage])
David James1fddb8f2013-04-25 15:23:07 -0700434 return
Matt Tennant759e2352013-09-27 15:14:44 -0700435
David James5596d0e2014-03-14 06:40:41 -0700436 # signer_results can't complete without push_image.
437 assert not config.signer_results or config.push_image
438
439 # paygen can't complete without signer_results.
440 assert not config.paygen or config.signer_results
441
442 if config.build_packages_in_background:
David James565bc9a2013-04-08 14:54:45 -0700443 self._RunStage(stages.BuildPackagesStage, board, archive_stage,
Matt Tennantefb59522013-10-18 13:49:28 -0700444 builder_run=builder_run)
David James5596d0e2014-03-14 06:40:41 -0700445
446 if builder_run.config.compilecheck or builder_run.options.compilecheck:
Matt Tennantefb59522013-10-18 13:49:28 -0700447 self._RunStage(stages.UnitTestStage, board,
448 builder_run=builder_run)
David James565bc9a2013-04-08 14:54:45 -0700449 return
Matt Tennant759e2352013-09-27 15:14:44 -0700450
David James5596d0e2014-03-14 06:40:41 -0700451 # Build the image first before doing anything else.
452 # TODO(davidjames): Remove this lock once http://crbug.com/352994 is fixed.
453 with self._build_image_lock:
454 self._RunStage(stages.BuildImageStage, board, archive_stage=archive_stage,
455 builder_run=builder_run, pgo_use=config.pgo_use)
Don Garrett82c0ae82014-02-03 18:25:11 -0800456
Mike Frysinger31ac04f2013-11-10 21:07:48 -0500457 # While this stage list is run in parallel, the order here dictates the
458 # order that things will be shown in the log. So group things together
459 # that make sense when read in order. Also keep in mind that, since we
460 # gather output manually, early slow stages will prevent any output from
461 # later stages showing up until it finishes.
Ryan Cui3ea98e02013-08-07 16:01:48 -0700462 stage_list = []
Matt Tennantefb59522013-10-18 13:49:28 -0700463 if builder_run.options.chrome_sdk and config.chrome_sdk:
Ryan Cui3ea98e02013-08-07 16:01:48 -0700464 stage_list.append([stages.ChromeSDKStage, board, archive_stage])
David James6b704242013-10-18 14:51:37 -0700465 stage_list += [
Matt Tennant06460b72014-02-10 18:00:13 -0800466 [stages.RetryStage, 1, stages.VMTestStage, board],
David James6b704242013-10-18 14:51:37 -0700467 [stages.SignerTestStage, board, archive_stage],
Don Garrett7604d6a2014-01-15 14:45:39 -0800468 [stages.SignerResultsStage, board, archive_stage],
Don Garrett82c0ae82014-02-03 18:25:11 -0800469 [stages.PaygenStage, board, archive_stage],
David James6b704242013-10-18 14:51:37 -0700470 [stages.UnitTestStage, board],
471 [stages.UploadPrebuiltsStage, board, archive_stage],
Mike Frysinger31ac04f2013-11-10 21:07:48 -0500472 [stages.DevInstallerPrebuiltsStage, board, archive_stage],
Matt Tennant06460b72014-02-10 18:00:13 -0800473 [stages.DebugSymbolsStage, board],
Aviv Keshete2d40ef2014-03-17 16:04:11 -0700474 [stages.CPEExportStage, board],
David James6b704242013-10-18 14:51:37 -0700475 ]
Brian Harring3fec5a82012-03-01 05:57:03 -0800476
David James58e0c092012-03-04 20:31:12 -0800477 # We can not run hw tests without archiving the payloads.
Matt Tennantefb59522013-10-18 13:49:28 -0700478 if builder_run.options.archive:
479 for suite_config in config.hw_tests:
Chris Sosaba250522013-03-27 18:57:34 -0700480 if suite_config.async:
481 stage_list.append([stages.ASyncHWTestStage, board, archive_stage,
482 suite_config])
483 elif suite_config.suite == constants.HWTEST_AU_SUITE:
484 stage_list.append([stages.AUTestStage, board, archive_stage,
485 suite_config])
Aviv Keshet23efd042013-10-01 13:59:08 -0700486 elif suite_config.suite == constants.HWTEST_QAV_SUITE:
487 stage_list.append([stages.QATestStage, board,
488 archive_stage, suite_config])
Chris Sosa077df812013-01-25 17:05:28 -0800489 else:
Chris Sosaba250522013-03-27 18:57:34 -0700490 stage_list.append([stages.HWTestStage, board, archive_stage,
491 suite_config])
Chris Sosa817b1f92012-07-19 15:00:23 -0700492
Matt Tennantefb59522013-10-18 13:49:28 -0700493 stage_objs = [self._GetStageInstance(*x, builder_run=builder_run)
494 for x in stage_list]
David James4f2d8302013-03-19 06:35:58 -0700495 self._RunParallelStages(stage_objs + [archive_stage])
Brian Harring3fec5a82012-03-01 05:57:03 -0800496
David James3b4bacf2014-02-19 17:25:15 -0800497 def _RunSetupBoard(self):
498 """Run the SetupBoard stage for all child configs and boards."""
499 for builder_run in self._run.GetUngroupedBuilderRuns():
500 for board in builder_run.config.boards:
501 self._RunStage(stages.SetupBoardStage, board, builder_run=builder_run)
502
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400503 def _RunChrootBuilderTypeBuild(self):
504 """Runs through stages of a CHROOT_BUILDER_TYPE build."""
505 self._RunStage(stages.UprevStage, boards=[], enter_chroot=False)
506 self._RunStage(stages.InitSDKStage)
David James3b4bacf2014-02-19 17:25:15 -0800507 self._RunStage(stages.SetupBoardStage, constants.CHROOT_BUILDER_BOARD)
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400508 self._RunStage(stages.SyncChromeStage)
509 self._RunStage(stages.PatchChromeStage)
510 self._RunStage(stages.SDKPackageStage)
511 self._RunStage(stages.SDKTestStage)
512 self._RunStage(stages.UploadPrebuiltsStage,
513 constants.CHROOT_BUILDER_BOARD, None)
514
515 def _RunRefreshPackagesTypeBuild(self):
516 """Runs through the stages of a REFRESH_PACKAGES_TYPE build."""
517 self._RunStage(stages.InitSDKStage)
David James3b4bacf2014-02-19 17:25:15 -0800518 self._RunSetupBoard()
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400519 self._RunStage(stages.RefreshPackageStatusStage)
520
Matt Tennante8179042013-10-01 15:47:32 -0700521 def _RunMasterPaladinBuild(self):
522 """Runs through the stages of the paladin (commit queue) master build."""
523 self._RunStage(stages.InitSDKStage)
524 self._RunStage(stages.UprevStage)
Matt Tennant9c1c8492014-02-27 13:09:07 -0800525 # The CQ (paladin) master will not actually run the SyncChrome stage, but
526 # we want the logic that gets triggered when SyncChrome stage is skipped.
527 self._RunStage(stages.SyncChromeStage)
Matt Tennante8179042013-10-01 15:47:32 -0700528 self._RunStage(stages.MasterUploadPrebuiltsStage)
529
Don Garrett4bb21682014-03-03 16:16:23 -0800530 def _RunPayloadsBuild(self):
531 """Run the PaygenStage once for each board."""
532 def _RunStageWrapper(board):
533 self._RunStage(stages.PaygenStage, board=board,
534 channels=self._run.options.channels, archive_stage=None)
535
536 with parallel.BackgroundTaskRunner(_RunStageWrapper) as queue:
537 for board in self._run.config.boards:
538 queue.put([board])
539
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400540 def _RunDefaultTypeBuild(self):
541 """Runs through the stages of a non-special-type build."""
542 self._RunStage(stages.InitSDKStage)
543 self._RunStage(stages.UprevStage)
David James3b4bacf2014-02-19 17:25:15 -0800544 self._RunSetupBoard()
Matt Tennant85348852014-01-10 15:16:02 -0800545 self._RunStage(stages.SyncChromeStage)
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400546 self._RunStage(stages.PatchChromeStage)
547
Matt Tennantefb59522013-10-18 13:49:28 -0700548 # Prepare stages to run in background. If child_configs exist then
549 # run each of those here, otherwise use default config.
Matt Tennant950c6cb2014-01-10 16:45:03 -0800550 builder_runs = self._run.GetUngroupedBuilderRuns()
Matt Tennantefb59522013-10-18 13:49:28 -0700551
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400552 tasks = []
Matt Tennantefb59522013-10-18 13:49:28 -0700553 for builder_run in builder_runs:
Matt Tennanta42a5742014-02-09 13:42:12 -0800554 # Prepare a local archive directory for each "run".
555 builder_run.GetArchive().SetupArchivePath()
556
Matt Tennantefb59522013-10-18 13:49:28 -0700557 for board in builder_run.config.boards:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400558 archive_stage = self._GetStageInstance(
Matt Tennantefb59522013-10-18 13:49:28 -0700559 stages.ArchiveStage, board, builder_run=builder_run,
Matt Tennant85348852014-01-10 15:16:02 -0800560 chrome_version=self._run.attrs.chrome_version)
Matt Tennantefb59522013-10-18 13:49:28 -0700561 board_config = BoardConfig(board, builder_run.config.name)
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400562 self.archive_stages[board_config] = archive_stage
Matt Tennantefb59522013-10-18 13:49:28 -0700563 tasks.append((builder_run, board, archive_stage))
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400564
565 # Set up a process pool to run test/archive stages in the background.
David Jamesed8349b2014-03-01 11:27:04 -0800566 # This process runs task(board) for each board added to the queue.
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400567 task_runner = self._RunBackgroundStagesForBoard
568 with parallel.BackgroundTaskRunner(task_runner) as queue:
Matt Tennantefb59522013-10-18 13:49:28 -0700569 for builder_run, board, archive_stage in tasks:
David James5596d0e2014-03-14 06:40:41 -0700570 if not builder_run.config.build_packages_in_background:
571 # Run BuildPackages in the foreground, generating or using PGO data
572 # if requested.
David Jamesed8349b2014-03-01 11:27:04 -0800573 kwargs = {'archive_stage': archive_stage, 'builder_run': builder_run}
574 if builder_run.config.pgo_generate:
575 kwargs['pgo_generate'] = True
576 elif builder_run.config.pgo_use:
577 kwargs['pgo_use'] = True
578
579 self._RunStage(stages.BuildPackagesStage, board, **kwargs)
David Jamesed8349b2014-03-01 11:27:04 -0800580
581 if builder_run.config.pgo_generate:
David James5596d0e2014-03-14 06:40:41 -0700582 # Generate the PGO data before allowing any other tasks to run.
583 self._RunStage(stages.BuildImageStage, board, **kwargs)
David Jamesed8349b2014-03-01 11:27:04 -0800584 suite = cbuildbot_config.PGORecordTest()
585 self._RunStage(stages.HWTestStage, board, archive_stage, suite,
586 builder_run=builder_run)
587
588 # Kick off our background stages.
David James5596d0e2014-03-14 06:40:41 -0700589 queue.put([builder_run, board])
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400590
Brian Harring3fec5a82012-03-01 05:57:03 -0800591 def RunStages(self):
592 """Runs through build process."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800593 # TODO(sosa): Split these out into classes.
Matt Tennantefb59522013-10-18 13:49:28 -0700594 if self._run.config.build_type == constants.PRE_CQ_LAUNCHER_TYPE:
David James816a5942013-04-11 22:59:32 -0700595 self._RunStage(stages.PreCQLauncherStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700596 elif self._run.config.build_type == constants.CREATE_BRANCH_TYPE:
Ryan Cui88b901c2013-06-21 11:35:30 -0700597 self._RunStage(stages.BranchUtilStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700598 elif self._run.config.build_type == constants.CHROOT_BUILDER_TYPE:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400599 self._RunChrootBuilderTypeBuild()
Matt Tennantefb59522013-10-18 13:49:28 -0700600 elif self._run.config.build_type == constants.REFRESH_PACKAGES_TYPE:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400601 self._RunRefreshPackagesTypeBuild()
Matt Tennante8179042013-10-01 15:47:32 -0700602 elif (self._run.config.build_type == constants.PALADIN_TYPE and
603 self._run.config.master):
604 self._RunMasterPaladinBuild()
Don Garrett4bb21682014-03-03 16:16:23 -0800605 elif self._run.config.build_type == constants.PAYLOADS_TYPE:
606 self._RunPayloadsBuild()
Brian Harring3fec5a82012-03-01 05:57:03 -0800607 else:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400608 self._RunDefaultTypeBuild()
David James58e0c092012-03-04 20:31:12 -0800609
Brian Harring3fec5a82012-03-01 05:57:03 -0800610
611class DistributedBuilder(SimpleBuilder):
612 """Build class that has special logic to handle distributed builds.
613
614 These builds sync using git/manifest logic in manifest_versions. In general
615 they use a non-distributed builder code for the bulk of the work.
616 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700617 def __init__(self, *args, **kwargs):
Brian Harring3fec5a82012-03-01 05:57:03 -0800618 """Initializes a buildbot builder.
619
620 Extra variables:
621 completion_stage_class: Stage used to complete a build. Set in the Sync
622 stage.
623 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700624 super(DistributedBuilder, self).__init__(*args, **kwargs)
Brian Harring3fec5a82012-03-01 05:57:03 -0800625 self.completion_stage_class = None
David Jamesf421c6d2013-04-11 15:37:57 -0700626 self.sync_stage = None
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400627 self._completion_stage = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800628
629 def GetSyncInstance(self):
630 """Syncs the tree using one of the distributed sync logic paths.
631
Mike Frysinger02e1e072013-11-10 22:11:34 -0500632 Returns:
633 The instance of the sync stage to run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800634 """
635 # Determine sync class to use. CQ overrides PFQ bits so should check it
636 # first.
Matt Tennantefb59522013-10-18 13:49:28 -0700637 if self._run.config.pre_cq or self._run.options.pre_cq:
David Jamesf421c6d2013-04-11 15:37:57 -0700638 sync_stage = self._GetStageInstance(stages.PreCQSyncStage,
639 self.patch_pool.gerrit_patches)
640 self.completion_stage_class = stages.PreCQCompletionStage
641 self.patch_pool.gerrit_patches = []
Matt Tennantefb59522013-10-18 13:49:28 -0700642 elif cbuildbot_config.IsCQType(self._run.config.build_type):
643 if self._run.config.do_not_apply_cq_patches:
Aviv Keshet00bc9512013-11-25 14:58:47 -0800644 sync_stage = self._GetStageInstance(stages.MasterSlaveSyncStage)
645 else:
646 sync_stage = self._GetStageInstance(stages.CommitQueueSyncStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800647 self.completion_stage_class = stages.CommitQueueCompletionStage
Matt Tennantefb59522013-10-18 13:49:28 -0700648 elif cbuildbot_config.IsPFQType(self._run.config.build_type):
Aviv Keshetf2746152013-11-26 10:42:46 -0800649 sync_stage = self._GetStageInstance(stages.MasterSlaveSyncStage)
650 self.completion_stage_class = stages.MasterSlaveSyncCompletionStage
Brian Harring3fec5a82012-03-01 05:57:03 -0800651 else:
652 sync_stage = self._GetStageInstance(stages.ManifestVersionedSyncStage)
653 self.completion_stage_class = stages.ManifestVersionedSyncCompletionStage
654
David Jamesf421c6d2013-04-11 15:37:57 -0700655 self.sync_stage = sync_stage
656 return self.sync_stage
Brian Harring3fec5a82012-03-01 05:57:03 -0800657
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400658 def GetCompletionInstance(self):
659 """Returns the completion_stage_class instance that was used for this build.
660
Mike Frysinger1a736a82013-12-12 01:50:59 -0500661 Returns:
662 None if the completion_stage instance was not yet created (this
663 occurs during Publish).
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400664 """
665 return self._completion_stage
666
Brian Harring3fec5a82012-03-01 05:57:03 -0800667 def Publish(self, was_build_successful):
668 """Completes build by publishing any required information."""
669 completion_stage = self._GetStageInstance(self.completion_stage_class,
David Jamesf421c6d2013-04-11 15:37:57 -0700670 self.sync_stage,
Brian Harring3fec5a82012-03-01 05:57:03 -0800671 was_build_successful)
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400672 self._completion_stage = completion_stage
David James11fd7e82013-10-23 20:02:16 -0700673 completion_successful = False
674 try:
675 completion_stage.Run()
676 completion_successful = True
677 finally:
678 if not completion_successful:
679 was_build_successful = False
Matt Tennantefb59522013-10-18 13:49:28 -0700680 if self._run.config.push_overlays:
David James11fd7e82013-10-23 20:02:16 -0700681 self._RunStage(stages.PublishUprevChangesStage, was_build_successful)
Brian Harring3fec5a82012-03-01 05:57:03 -0800682
683 def RunStages(self):
684 """Runs simple builder logic and publishes information to overlays."""
685 was_build_successful = False
David James843ed252013-09-11 16:18:10 -0700686 try:
687 super(DistributedBuilder, self).RunStages()
688 was_build_successful = results_lib.Results.BuildSucceededSoFar()
689 except SystemExit as ex:
690 # If a stage calls sys.exit(0), it's exiting with success, so that means
691 # we should mark ourselves as successful.
692 if ex.code == 0:
693 was_build_successful = True
694 raise
695 finally:
696 self.Publish(was_build_successful)
Brian Harring3fec5a82012-03-01 05:57:03 -0800697
Brian Harring3fec5a82012-03-01 05:57:03 -0800698
699def _ConfirmBuildRoot(buildroot):
700 """Confirm with user the inferred buildroot, and mark it as confirmed."""
Brian Harring521e7242012-11-01 16:57:42 -0700701 cros_build_lib.Warning('Using default directory %s as buildroot', buildroot)
702 if not cros_build_lib.BooleanPrompt(default=False):
703 print('Please specify a different buildroot via the --buildroot option.')
Brian Harring3fec5a82012-03-01 05:57:03 -0800704 sys.exit(0)
705
706 if not os.path.exists(buildroot):
707 os.mkdir(buildroot)
708
709 repository.CreateTrybotMarker(buildroot)
710
711
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700712def _ConfirmRemoteBuildbotRun():
713 """Confirm user wants to run with --buildbot --remote."""
Brian Harring521e7242012-11-01 16:57:42 -0700714 cros_build_lib.Warning(
715 'You are about to launch a PRODUCTION job! This is *NOT* a '
716 'trybot run! Are you sure?')
717 if not cros_build_lib.BooleanPrompt(default=False):
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700718 print('Please specify --pass-through="--debug".')
719 sys.exit(0)
720
721
Ryan Cui5ba7e152012-05-10 14:36:52 -0700722def _DetermineDefaultBuildRoot(sourceroot, internal_build):
Brian Harring3fec5a82012-03-01 05:57:03 -0800723 """Default buildroot to be under the directory that contains current checkout.
724
Mike Frysinger02e1e072013-11-10 22:11:34 -0500725 Args:
Brian Harring3fec5a82012-03-01 05:57:03 -0800726 internal_build: Whether the build is an internal build
Ryan Cui5ba7e152012-05-10 14:36:52 -0700727 sourceroot: Use specified sourceroot.
Brian Harring3fec5a82012-03-01 05:57:03 -0800728 """
Ryan Cui5ba7e152012-05-10 14:36:52 -0700729 if not repository.IsARepoRoot(sourceroot):
Brian Harring1b8c4c82012-05-29 23:03:04 -0700730 cros_build_lib.Die(
731 'Could not find root of local checkout at %s. Please specify '
732 'using the --sourceroot option.' % sourceroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800733
734 # Place trybot buildroot under the directory containing current checkout.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700735 top_level = os.path.dirname(os.path.realpath(sourceroot))
Brian Harring3fec5a82012-03-01 05:57:03 -0800736 if internal_build:
737 buildroot = os.path.join(top_level, _DEFAULT_INT_BUILDROOT)
738 else:
739 buildroot = os.path.join(top_level, _DEFAULT_EXT_BUILDROOT)
740
741 return buildroot
742
743
Mike Frysinger6903c762012-12-04 01:57:16 -0500744def _DisableYamaHardLinkChecks():
745 """Disable Yama kernel hardlink security checks.
746
747 The security module disables hardlinking to files you do not have
748 write access to which causes some of our build scripts problems.
749 Disable it so we don't have to worry about it.
750 """
751 PROC_PATH = '/proc/sys/kernel/yama/protected_nonaccess_hardlinks'
752 SYSCTL_PATH = PROC_PATH[len('/proc/sys/'):].replace('/', '.')
753
754 # Yama not available in this system -- nothing to do.
755 if not os.path.exists(PROC_PATH):
756 return
757
758 # Already disabled -- nothing to do.
759 if osutils.ReadFile(PROC_PATH).strip() == '0':
760 return
761
762 # Create a hardlink in a tempdir and see if we get back EPERM.
David James4bc13702013-03-26 08:08:04 -0700763 with osutils.TempDir() as tempdir:
Mike Frysinger6903c762012-12-04 01:57:16 -0500764 try:
765 os.link('/bin/sh', os.path.join(tempdir, 'sh'))
766 except OSError as e:
767 if e.errno == errno.EPERM:
768 cros_build_lib.Warning('Disabling Yama hardlink security')
769 cros_build_lib.SudoRunCommand(['sysctl', '%s=0' % SYSCTL_PATH])
770
771
Brian Harring3fec5a82012-03-01 05:57:03 -0800772def _BackupPreviousLog(log_file, backup_limit=25):
773 """Rename previous log.
774
775 Args:
776 log_file: The absolute path to the previous log.
Aviv Keshet9e4236b2013-12-13 13:07:50 -0800777 backup_limit: Maximum number of old logs to keep.
Brian Harring3fec5a82012-03-01 05:57:03 -0800778 """
779 if os.path.exists(log_file):
780 old_logs = sorted(glob.glob(log_file + '.*'),
781 key=distutils.version.LooseVersion)
782
783 if len(old_logs) >= backup_limit:
784 os.remove(old_logs[0])
785
786 last = 0
787 if old_logs:
788 last = int(old_logs.pop().rpartition('.')[2])
789
790 os.rename(log_file, log_file + '.' + str(last + 1))
791
Ryan Cui5616a512012-08-17 13:39:36 -0700792
Gaurav Shah298aa372014-01-31 09:27:24 -0800793def _IsDistributedBuilder(options, chrome_rev, build_config):
794 """Determines whether the builder should be a DistributedBuilder.
795
796 Args:
797 options: options passed on the commandline.
798 chrome_rev: Chrome revision to build.
799 build_config: Builder configuration dictionary.
800
801 Returns:
802 True if the builder should be a distributed_builder
803 """
804 if build_config['pre_cq'] or options.pre_cq:
805 return True
806 elif not options.buildbot:
807 return False
808 elif chrome_rev in (constants.CHROME_REV_TOT,
809 constants.CHROME_REV_LOCAL,
810 constants.CHROME_REV_SPEC):
811 # We don't do distributed logic to TOT Chrome PFQ's, nor local
812 # chrome roots (e.g. chrome try bots)
813 # TODO(davidjames): Update any builders that rely on this logic to use
814 # manifest_version=False instead.
815 return False
816 elif build_config['manifest_version']:
817 return True
818
819 return False
820
821
David James944a48e2012-03-07 12:19:03 -0800822def _RunBuildStagesWrapper(options, build_config):
Brian Harring3fec5a82012-03-01 05:57:03 -0800823 """Helper function that wraps RunBuildStages()."""
Matt Tennant7feda352013-12-20 14:03:40 -0800824 cros_build_lib.Info('cbuildbot was executed with args %s' %
825 cros_build_lib.CmdToStr(sys.argv))
Brian Harring3fec5a82012-03-01 05:57:03 -0800826
David Jamesa0a664e2013-02-13 09:52:01 -0800827 chrome_rev = build_config['chrome_rev']
828 if options.chrome_rev:
829 chrome_rev = options.chrome_rev
830 if chrome_rev == constants.CHROME_REV_TOT:
831 # Build the TOT Chrome revision.
832 svn_url = gclient.GetBaseURLs()[0]
833 options.chrome_version = gclient.GetTipOfTrunkSvnRevision(svn_url)
834 options.chrome_rev = constants.CHROME_REV_SPEC
835
David James4a404a52013-02-19 13:07:59 -0800836 # If it's likely we'll need to build Chrome, fetch the source.
Mike Frysingerf4d9ab82013-03-05 19:38:05 -0500837 if build_config['sync_chrome'] is None:
838 options.managed_chrome = (chrome_rev != constants.CHROME_REV_LOCAL and
839 (not build_config['usepkg_build_packages'] or chrome_rev or
David James3cce4642013-05-10 17:50:23 -0700840 build_config['profile'] or options.rietveld_patches))
Mike Frysingerf4d9ab82013-03-05 19:38:05 -0500841 else:
842 options.managed_chrome = build_config['sync_chrome']
David James2333c182013-02-13 16:16:15 -0800843
844 if options.managed_chrome:
845 # Tell Chrome to fetch the source locally.
Matt Tennant628ffdd2013-11-27 14:44:39 -0800846 internal = constants.USE_CHROME_INTERNAL in build_config['useflags']
David James2333c182013-02-13 16:16:15 -0800847 chrome_src = 'chrome-src-internal' if internal else 'chrome-src'
848 options.chrome_root = os.path.join(options.cache_dir, 'distfiles', 'target',
849 chrome_src)
David James9e27e662013-02-14 13:42:43 -0800850 elif options.rietveld_patches:
David James4a404a52013-02-19 13:07:59 -0800851 cros_build_lib.Die('This builder does not support Rietveld patches.')
David James2333c182013-02-13 16:16:15 -0800852
Matt Tennant95a42ad2013-12-27 15:38:36 -0800853 # We are done munging options values, so freeze options object now to avoid
854 # further abuse of it.
855 # TODO(mtennant): one by one identify each options value override and see if
856 # it can be handled another way. Try to push this freeze closer and closer
857 # to the start of the script (e.g. in or after _PostParseCheck).
858 options.Freeze()
859
Matt Tennant0940c382014-01-21 20:43:55 -0800860 with parallel.Manager() as manager:
861 builder_run = cbuildbot_run.BuilderRun(options, build_config, manager)
862 if _IsDistributedBuilder(options, chrome_rev, build_config):
863 builder_cls = DistributedBuilder
864 else:
865 builder_cls = SimpleBuilder
866 builder = builder_cls(builder_run)
867 if not builder.Run():
868 sys.exit(1)
Brian Harring3fec5a82012-03-01 05:57:03 -0800869
870
871# Parser related functions
Ryan Cui5ba7e152012-05-10 14:36:52 -0700872def _CheckLocalPatches(sourceroot, local_patches):
Brian Harring3fec5a82012-03-01 05:57:03 -0800873 """Do an early quick check of the passed-in patches.
874
875 If the branch of a project is not specified we append the current branch the
876 project is on.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700877
David Jamese3b06062013-11-09 18:52:02 -0800878 TODO(davidjames): The project:branch format isn't unique, so this means that
879 we can't differentiate what directory the user intended to apply patches to.
880 We should references by directory instead.
881
Ryan Cui5ba7e152012-05-10 14:36:52 -0700882 Args:
883 sourceroot: The checkout where patches are coming from.
Aviv Keshet9e4236b2013-12-13 13:07:50 -0800884 local_patches: List of patches to check in project:branch format.
David Jamese3b06062013-11-09 18:52:02 -0800885
886 Returns:
887 A list of patches that have been verified, in project:branch format.
Brian Harring3fec5a82012-03-01 05:57:03 -0800888 """
Ryan Cuicedd8a52012-03-22 02:28:35 -0700889 verified_patches = []
David James97d95872012-11-16 15:09:56 -0800890 manifest = git.ManifestCheckout.Cached(sourceroot)
Ryan Cuicedd8a52012-03-22 02:28:35 -0700891 for patch in local_patches:
David Jamese3b06062013-11-09 18:52:02 -0800892 project, _, branch = patch.partition(':')
893
Gaurav Shah7afb0562013-12-26 15:05:39 -0800894 checkouts = manifest.FindCheckouts(project, only_patchable=True)
David Jamese3b06062013-11-09 18:52:02 -0800895 if not checkouts:
896 cros_build_lib.Die('Project %s does not exist.' % (project,))
897 if len(checkouts) > 1:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700898 cros_build_lib.Die(
David Jamese3b06062013-11-09 18:52:02 -0800899 'We do not yet support local patching for projects that are checked '
900 'out to multiple directories. Try uploading your patch to gerrit '
901 'and referencing it via the -g option instead.'
902 )
Brian Harring3fec5a82012-03-01 05:57:03 -0800903
David Jamese3b06062013-11-09 18:52:02 -0800904 ok = False
905 for checkout in checkouts:
906 project_dir = checkout.GetPath(absolute=True)
Brian Harring3fec5a82012-03-01 05:57:03 -0800907
David Jamese3b06062013-11-09 18:52:02 -0800908 # If no branch was specified, we use the project's current branch.
Brian Harring3fec5a82012-03-01 05:57:03 -0800909 if not branch:
David Jamese3b06062013-11-09 18:52:02 -0800910 local_branch = git.GetCurrentBranch(project_dir)
911 else:
912 local_branch = branch
Brian Harring3fec5a82012-03-01 05:57:03 -0800913
David Jamese3b06062013-11-09 18:52:02 -0800914 if local_branch and git.DoesLocalBranchExist(project_dir, local_branch):
915 verified_patches.append('%s:%s' % (project, local_branch))
916 ok = True
917
918 if not ok:
919 if branch:
920 cros_build_lib.Die('Project %s does not have branch %s'
921 % (project, branch))
922 else:
923 cros_build_lib.Die('Project %s is not on a branch!' % (project,))
Brian Harring3fec5a82012-03-01 05:57:03 -0800924
Ryan Cuicedd8a52012-03-22 02:28:35 -0700925 return verified_patches
Brian Harring3fec5a82012-03-01 05:57:03 -0800926
927
Brian Harring3fec5a82012-03-01 05:57:03 -0800928def _CheckChromeVersionOption(_option, _opt_str, value, parser):
929 """Upgrade other options based on chrome_version being passed."""
930 value = value.strip()
931
932 if parser.values.chrome_rev is None and value:
933 parser.values.chrome_rev = constants.CHROME_REV_SPEC
934
935 parser.values.chrome_version = value
936
937
938def _CheckChromeRootOption(_option, _opt_str, value, parser):
939 """Validate and convert chrome_root to full-path form."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800940 if parser.values.chrome_rev is None:
941 parser.values.chrome_rev = constants.CHROME_REV_LOCAL
942
Ryan Cui5ba7e152012-05-10 14:36:52 -0700943 parser.values.chrome_root = value
Brian Harring3fec5a82012-03-01 05:57:03 -0800944
945
946def _CheckChromeRevOption(_option, _opt_str, value, parser):
947 """Validate the chrome_rev option."""
948 value = value.strip()
949 if value not in constants.VALID_CHROME_REVISIONS:
950 raise optparse.OptionValueError('Invalid chrome rev specified')
951
952 parser.values.chrome_rev = value
953
954
David Jamesac8c2a72013-02-13 18:44:33 -0800955def FindCacheDir(_parser, _options):
Brian Harringae0a5322012-09-15 01:46:51 -0700956 return None
957
958
Ryan Cui5ba7e152012-05-10 14:36:52 -0700959class CustomGroup(optparse.OptionGroup):
Aviv Keshet9e4236b2013-12-13 13:07:50 -0800960 """Custom option group which supports arguments passed-through to trybot."""
Ryan Cui5ba7e152012-05-10 14:36:52 -0700961 def add_remote_option(self, *args, **kwargs):
962 """For arguments that are passed-through to remote trybot."""
963 return optparse.OptionGroup.add_option(self, *args,
964 remote_pass_through=True,
965 **kwargs)
966
967
Ryan Cui1c13a252012-10-16 15:00:16 -0700968class CustomOption(commandline.FilteringOption):
969 """Subclass FilteringOption class to implement pass-through and api."""
Ryan Cui5ba7e152012-05-10 14:36:52 -0700970
Ryan Cui1c13a252012-10-16 15:00:16 -0700971 ACTIONS = commandline.FilteringOption.ACTIONS + ('extend',)
972 STORE_ACTIONS = commandline.FilteringOption.STORE_ACTIONS + ('extend',)
973 TYPED_ACTIONS = commandline.FilteringOption.TYPED_ACTIONS + ('extend',)
974 ALWAYS_TYPED_ACTIONS = (commandline.FilteringOption.ALWAYS_TYPED_ACTIONS +
975 ('extend',))
Ryan Cui79319ab2012-05-21 12:59:18 -0700976
Ryan Cui5ba7e152012-05-10 14:36:52 -0700977 def __init__(self, *args, **kwargs):
978 # The remote_pass_through argument specifies whether we should directly
979 # pass the argument (with its value) onto the remote trybot.
980 self.pass_through = kwargs.pop('remote_pass_through', False)
Ryan Cui1c13a252012-10-16 15:00:16 -0700981 self.api_version = int(kwargs.pop('api', '0'))
982 commandline.FilteringOption.__init__(self, *args, **kwargs)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700983
984 def take_action(self, action, dest, opt, value, values, parser):
Ryan Cui79319ab2012-05-21 12:59:18 -0700985 if action == 'extend':
Mike Frysingerd6925b52012-07-16 16:11:00 -0400986 # If there is extra spaces between each argument, we get '' which later
987 # code barfs on, so skip those. e.g. We see this with the forms:
988 # cbuildbot -p 'proj:branch ' ...
989 # cbuildbot -p ' proj:branch' ...
990 # cbuildbot -p 'proj:branch proj2:branch' ...
991 lvalue = value.split()
Ryan Cui79319ab2012-05-21 12:59:18 -0700992 values.ensure_value(dest, []).extend(lvalue)
Ryan Cui79319ab2012-05-21 12:59:18 -0700993
Ryan Cui1c13a252012-10-16 15:00:16 -0700994 commandline.FilteringOption.take_action(
995 self, action, dest, opt, value, values, parser)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700996
997
Ryan Cui1c13a252012-10-16 15:00:16 -0700998class CustomParser(commandline.FilteringParser):
Aviv Keshet9e4236b2013-12-13 13:07:50 -0800999 """Custom option parser which supports arguments passed-trhough to trybot"""
Matt Tennante8179042013-10-01 15:47:32 -07001000
Brian Harringb6cf9142012-09-01 20:43:17 -07001001 DEFAULT_OPTION_CLASS = CustomOption
1002
1003 def add_remote_option(self, *args, **kwargs):
1004 """For arguments that are passed-through to remote trybot."""
Ryan Cui1c13a252012-10-16 15:00:16 -07001005 return self.add_option(*args, remote_pass_through=True, **kwargs)
Brian Harringb6cf9142012-09-01 20:43:17 -07001006
1007
Brian Harring3fec5a82012-03-01 05:57:03 -08001008def _CreateParser():
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001009 """Generate and return the parser with all the options."""
Brian Harring3fec5a82012-03-01 05:57:03 -08001010 # Parse options
Matt Tennant763497d2014-01-17 16:45:54 -08001011 usage = "usage: %prog [options] buildbot_config [buildbot_config ...]"
Brian Harringae0a5322012-09-15 01:46:51 -07001012 parser = CustomParser(usage=usage, caching=FindCacheDir)
Brian Harring3fec5a82012-03-01 05:57:03 -08001013
1014 # Main options
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001015 parser.add_option('-l', '--list', action='store_true', dest='list',
1016 default=False,
1017 help='List the suggested trybot configs to use (see --all)')
Brian Harring3fec5a82012-03-01 05:57:03 -08001018 parser.add_option('-a', '--all', action='store_true', dest='print_all',
1019 default=False,
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001020 help='List all of the buildbot configs available w/--list')
1021
1022 parser.add_option('--local', default=False, action='store_true',
Ryan Cui88b901c2013-06-21 11:35:30 -07001023 help='Specifies that this tryjob should be run locally. '
1024 'Implies --debug.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001025 parser.add_option('--remote', default=False, action='store_true',
Ryan Cui88b901c2013-06-21 11:35:30 -07001026 help='Specifies that this tryjob should be run remotely.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001027
Ryan Cuie1e4e662012-05-21 16:39:46 -07001028 parser.add_remote_option('-b', '--branch',
1029 help='The manifest branch to test. The branch to '
1030 'check the buildroot out to.')
Ryan Cui5ba7e152012-05-10 14:36:52 -07001031 parser.add_option('-r', '--buildroot', dest='buildroot', type='path',
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001032 help='Root directory where source is checked out to, and '
1033 'where the build occurs. For external build configs, '
1034 "defaults to 'trybot' directory at top level of your "
1035 'repo-managed checkout.')
1036 parser.add_remote_option('--chrome_rev', default=None, type='string',
1037 action='callback', dest='chrome_rev',
1038 callback=_CheckChromeRevOption,
1039 help=('Revision of Chrome to use, of type [%s]'
1040 % '|'.join(constants.VALID_CHROME_REVISIONS)))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001041 parser.add_remote_option('--profile', default=None, type='string',
1042 action='store', dest='profile',
1043 help='Name of profile to sub-specify board variant.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001044
Ryan Cuif4f84be2012-07-09 18:50:41 -07001045 #
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001046 # Patch selection options.
1047 #
1048
1049 group = CustomGroup(
1050 parser,
1051 'Patch Options')
1052
1053 group.add_remote_option('-g', '--gerrit-patches', action='extend',
1054 default=[], type='string',
1055 metavar="'Id1 *int_Id2...IdN'",
1056 help="Space-separated list of short-form Gerrit "
1057 "Change-Id's or change numbers to patch. "
1058 "Please prepend '*' to internal Change-Id's")
1059 group.add_remote_option('-G', '--rietveld-patches', action='extend',
1060 default=[], type='string',
1061 metavar="'id1[:subdir1]...idN[:subdirN]'",
1062 help='Space-separated list of short-form Rietveld '
1063 'issue numbers to patch. If no subdir is '
1064 'specified, the src directory is used.')
1065 group.add_option('-p', '--local-patches', action='extend', default=[],
1066 metavar="'<project1>[:<branch1>]...<projectN>[:<branchN>]'",
1067 help='Space-separated list of project branches with '
1068 'patches to apply. Projects are specified by name. '
1069 'If no branch is specified the current branch of the '
1070 'project will be used.')
1071
1072 parser.add_option_group(group)
1073
1074 #
1075 # Remote trybot options.
1076 #
1077
1078 group = CustomGroup(
1079 parser,
1080 'Remote Trybot Options (--remote)')
1081
1082 group.add_remote_option('--hwtest', dest='hwtest', action='store_true',
1083 default=False,
1084 help='Run the HWTest stage (tests on real hardware)')
1085 group.add_option('--remote-description', default=None,
1086 help='Attach an optional description to a --remote run '
1087 'to make it easier to identify the results when it '
1088 'finishes')
1089 group.add_option('--slaves', action='extend', default=[],
1090 help='Specify specific remote tryslaves to run on (e.g. '
1091 'build149-m2); if the bot is busy, it will be queued')
Don Garrett4bb21682014-03-03 16:16:23 -08001092 group.add_remote_option('--channel', dest='channels', action='extend',
1093 default=[],
1094 help='Specify a channel for a payloads trybot. Can be'
1095 'specified multiple times. No valid for '
1096 'non-payloads configs.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001097 group.add_option('--test-tryjob', action='store_true',
1098 default=False,
1099 help='Submit a tryjob to the test repository. Will not '
1100 'show up on the production trybot waterfall.')
1101
1102 parser.add_option_group(group)
1103
1104 #
Ryan Cui88b901c2013-06-21 11:35:30 -07001105 # Branch creation options.
1106 #
1107
1108 group = CustomGroup(
1109 parser,
1110 'Branch Creation Options (used with branch-util)')
1111
1112 group.add_remote_option('--branch-name',
1113 help='The branch to create or delete.')
1114 group.add_remote_option('--delete-branch', default=False, action='store_true',
1115 help='Delete the branch specified in --branch-name.')
1116 group.add_remote_option('--rename-to', type='string',
1117 help='Rename a branch to the specified name.')
1118 group.add_remote_option('--force-create', default=False, action='store_true',
1119 help='Overwrites an existing branch.')
1120
1121 parser.add_option_group(group)
1122
1123 #
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001124 # Advanced options.
Ryan Cuif4f84be2012-07-09 18:50:41 -07001125 #
1126
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001127 group = CustomGroup(
Brian Harring3fec5a82012-03-01 05:57:03 -08001128 parser,
1129 'Advanced Options',
1130 'Caution: use these options at your own risk.')
1131
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001132 group.add_remote_option('--bootstrap-args', action='append', default=[],
1133 help='Args passed directly to the bootstrap re-exec '
1134 'to skip verification by the bootstrap code')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001135 group.add_remote_option('--buildbot', dest='buildbot', action='store_true',
1136 default=False, help='This is running on a buildbot')
1137 group.add_remote_option('--buildnumber', help='build number', type='int',
1138 default=0)
Ryan Cui5ba7e152012-05-10 14:36:52 -07001139 group.add_option('--chrome_root', default=None, type='path',
1140 action='callback', callback=_CheckChromeRootOption,
1141 dest='chrome_root', help='Local checkout of Chrome to use.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001142 group.add_remote_option('--chrome_version', default=None, type='string',
1143 action='callback', dest='chrome_version',
1144 callback=_CheckChromeVersionOption,
1145 help='Used with SPEC logic to force a particular SVN '
1146 'revision of chrome rather than the latest.')
1147 group.add_remote_option('--clobber', action='store_true', dest='clobber',
1148 default=False,
1149 help='Clears an old checkout before syncing')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001150 group.add_remote_option('--latest-toolchain', action='store_true',
1151 default=False,
1152 help='Use the latest toolchain.')
Ryan Cui5ba7e152012-05-10 14:36:52 -07001153 parser.add_option('--log_dir', dest='log_dir', type='path',
Brian Harring3fec5a82012-03-01 05:57:03 -08001154 help=('Directory where logs are stored.'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001155 group.add_remote_option('--maxarchives', dest='max_archive_builds',
1156 default=3, type='int',
1157 help="Change the local saved build count limit.")
Ryan Cuibbd3d4b2012-08-17 12:20:37 -07001158 parser.add_remote_option('--manifest-repo-url',
1159 help=('Overrides the default manifest repo url.'))
David James565bc9a2013-04-08 14:54:45 -07001160 group.add_remote_option('--compilecheck', action='store_true', default=False,
1161 help='Only verify compilation and unit tests.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001162 group.add_remote_option('--noarchive', action='store_false', dest='archive',
1163 default=True, help="Don't run archive stage.")
Ryan Cuif7f24692012-05-18 16:35:33 -07001164 group.add_remote_option('--nobootstrap', action='store_false',
1165 dest='bootstrap', default=True,
1166 help="Don't checkout and run from a standalone "
1167 "chromite repo.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001168 group.add_remote_option('--nobuild', action='store_false', dest='build',
1169 default=True,
1170 help="Don't actually build (for cbuildbot dev)")
1171 group.add_remote_option('--noclean', action='store_false', dest='clean',
1172 default=True, help="Don't clean the buildroot")
Ryan Cuif7f24692012-05-18 16:35:33 -07001173 group.add_remote_option('--nocgroups', action='store_false', dest='cgroups',
1174 default=True,
1175 help='Disable cbuildbots usage of cgroups.')
Ryan Cui3ea98e02013-08-07 16:01:48 -07001176 group.add_remote_option('--nochromesdk', action='store_false',
1177 dest='chrome_sdk', default=True,
1178 help="Don't run the ChromeSDK stage which builds "
1179 "Chrome outside of the chroot.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001180 group.add_remote_option('--noprebuilts', action='store_false',
1181 dest='prebuilts', default=True,
1182 help="Don't upload prebuilts.")
Ryan Cui88b901c2013-06-21 11:35:30 -07001183 group.add_remote_option('--nopatch', action='store_false',
1184 dest='postsync_patch', default=True,
1185 help=("Don't run PatchChanges stage. This does not "
1186 "disable patching in of chromite patches "
1187 "during BootstrapStage."))
Don Garrett82c0ae82014-02-03 18:25:11 -08001188 group.add_remote_option('--nopaygen', action='store_false',
1189 dest='paygen', default=True,
1190 help="Don't generate payloads.")
Ryan Cui88b901c2013-06-21 11:35:30 -07001191 group.add_remote_option('--noreexec', action='store_false',
1192 dest='postsync_reexec', default=True,
1193 help="Don't reexec into the buildroot after syncing.")
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001194 group.add_remote_option('--nosdk', action='store_true',
1195 default=False,
1196 help='Re-create the SDK from scratch.')
Don Garrett7604d6a2014-01-15 14:45:39 -08001197 group.add_remote_option('--nosigner-results', action='store_false',
1198 dest='signer_results', default=True,
1199 help="Don't display signing results.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001200 group.add_remote_option('--nosync', action='store_false', dest='sync',
1201 default=True, help="Don't sync before building.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001202 group.add_remote_option('--notests', action='store_false', dest='tests',
1203 default=True,
1204 help='Override values from buildconfig and run no '
1205 'tests.')
1206 group.add_remote_option('--nouprev', action='store_false', dest='uprev',
1207 default=True,
1208 help='Override values from buildconfig and never '
1209 'uprev.')
David Jamesdac7a912013-11-18 11:14:44 -08001210 group.add_option('--reference-repo', action='store', default=None,
1211 dest='reference_repo',
1212 help='Reuse git data stored in an existing repo '
1213 'checkout. This can drastically reduce the network '
1214 'time spent setting up the trybot checkout. By '
1215 "default, if this option isn't given but cbuildbot "
1216 'is invoked from a repo checkout, cbuildbot will '
1217 'use the repo root.')
Ryan Cuicedd8a52012-03-22 02:28:35 -07001218 group.add_option('--resume', action='store_true', default=False,
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001219 help='Skip stages already successfully completed.')
1220 group.add_remote_option('--timeout', action='store', type='int', default=0,
1221 help='Specify the maximum amount of time this job '
1222 'can run for, at which point the build will be '
1223 'aborted. If set to zero, then there is no '
1224 'timeout.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001225 group.add_remote_option('--version', dest='force_version', default=None,
1226 help='Used with manifest logic. Forces use of this '
Aviv Keshetc2c123d2013-10-14 18:06:12 -04001227 'version rather than create or get latest. '
1228 'Examples: 4815.0.0-rc1, 4815.1.2')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001229
1230 parser.add_option_group(group)
1231
1232 #
1233 # Internal options.
1234 #
1235
1236 group = CustomGroup(
1237 parser,
Mike Frysinger34db8692013-11-11 14:54:08 -05001238 'Internal Chromium OS Build Team Options',
1239 'Caution: these are for meant for the Chromium OS build team only')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001240
1241 group.add_remote_option('--archive-base', type='gs_path',
1242 help='Base GS URL (gs://<bucket_name>/<path>) to '
1243 'upload archive artifacts to')
Brian Harringab8fb5c2012-07-18 11:28:22 -07001244 group.add_remote_option('--cq-gerrit-query', dest='cq_gerrit_override',
1245 default=None,
1246 help=
1247 "If given, this gerrit query will be used to find what patches to test, "
Aviv Keshetefd6bbf2013-12-12 13:36:57 -08001248 "rather than the normal 'CommitQueue>=1 AND Verified=1 AND CodeReview=2' "
Brian Harringab8fb5c2012-07-18 11:28:22 -07001249 "query it defaults to. Use with care- note additionally this setting "
1250 "only has an effect if the buildbot target is a cq target, and we're "
1251 "in buildbot mode.")
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001252 group.add_option('--pass-through', dest='pass_through_args', action='append',
1253 type='string', default=[])
David Jamesf421c6d2013-04-11 15:37:57 -07001254 group.add_remote_option('--pre-cq', action='store_true', default=False,
1255 help='Mark CLs as tested by the PreCQ on success.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001256 group.add_option('--reexec-api-version', dest='output_api_version',
Ryan Cuif4f84be2012-07-09 18:50:41 -07001257 action='store_true', default=False,
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001258 help='Used for handling forwards/backwards compatibility '
1259 'with --resume and --bootstrap')
1260 group.add_option('--remote-trybot', dest='remote_trybot',
1261 action='store_true', default=False,
1262 help='Indicates this is running on a remote trybot machine')
1263 group.add_remote_option('--remote-patches', action='extend', default=[],
1264 help='Patches uploaded by the trybot client when run '
1265 'using the -p option')
Brian Harringf611e6e2012-07-17 18:47:44 -07001266 # Note the default here needs to be hardcoded to 3; that is the last version
1267 # that lacked this functionality.
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001268 group.add_option('--remote-version', default=3, type=int, action='store',
1269 help='Used for compatibility checks w/tryjobs running in '
1270 'older chromite instances')
1271 group.add_option('--sourceroot', type='path', default=constants.SOURCE_ROOT)
1272 group.add_remote_option('--test-bootstrap', action='store_true',
1273 default=False,
1274 help='Causes cbuildbot to bootstrap itself twice, in '
1275 'the sequence A->B->C: A(unpatched) patches and '
1276 'bootstraps B; B patches and bootstraps C')
1277 group.add_remote_option('--validation_pool', default=None,
1278 help='Path to a pickled validation pool. Intended '
1279 'for use only with the commit queue.')
Aviv Kesheta0159be2013-12-12 13:56:28 -08001280 group.add_remote_option('--mock-tree-status', dest='mock_tree_status',
1281 default=None, action='store',
1282 help='Override the tree status value that would be '
1283 'returned from the the actual tree. Example '
1284 'values: open, closed, throttled. When used '
1285 'in conjunction with --debug, the tree status '
1286 'will not be ignored as it usually is in a '
1287 '--debug run.')
Aviv Keshetcf9c2722014-02-25 15:15:10 -08001288 group.add_remote_option('--mock-slave-status', dest='mock_slave_status',
1289 default=None, action='store',
1290 metavar='MOCK_SLAVE_STATUS_PICKLE_FILE',
1291 help='Override the result of the _FetchSlaveStatuses '
1292 'method of MasterSlaveSyncCompletionStage, by '
1293 'specifying a file with a pickle of the result '
1294 'to be returned.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001295
1296 parser.add_option_group(group)
Ryan Cuif4f84be2012-07-09 18:50:41 -07001297
1298 #
Brian Harring3fec5a82012-03-01 05:57:03 -08001299 # Debug options
Ryan Cuif4f84be2012-07-09 18:50:41 -07001300 #
Brian Harringfec89fe2012-09-23 07:30:54 -07001301 # Temporary hack; in place till --dry-run replaces --debug.
1302 # pylint: disable=W0212
Brian Harring009db502012-10-10 02:21:37 -07001303 group = parser.debug_group
Brian Harringfec89fe2012-09-23 07:30:54 -07001304 debug = [x for x in group.option_list if x._long_opts == ['--debug']][0]
1305 debug.help += " Currently functions as --dry-run in addition."
1306 debug.pass_through = True
Brian Harring3fec5a82012-03-01 05:57:03 -08001307 group.add_option('--notee', action='store_false', dest='tee', default=True,
1308 help="Disable logging and internal tee process. Primarily "
1309 "used for debugging cbuildbot itself.")
Brian Harring3fec5a82012-03-01 05:57:03 -08001310 return parser
1311
1312
Ryan Cui85867972012-02-23 18:21:49 -08001313def _FinishParsing(options, args):
1314 """Perform some parsing tasks that need to take place after optparse.
1315
1316 This function needs to be easily testable! Keep it free of
1317 environment-dependent code. Put more detailed usage validation in
1318 _PostParseCheck().
Brian Harring3fec5a82012-03-01 05:57:03 -08001319
1320 Args:
Matt Tennant759e2352013-09-27 15:14:44 -07001321 options: The options object returned by optparse
1322 args: The args object returned by optparse
Brian Harring3fec5a82012-03-01 05:57:03 -08001323 """
Ryan Cui41023d92012-11-13 19:59:50 -08001324 # Populate options.pass_through_args.
1325 accepted, _ = commandline.FilteringParser.FilterArgs(
1326 options.parsed_args, lambda x: x.opt_inst.pass_through)
1327 options.pass_through_args.extend(accepted)
Brian Harring07039b52012-05-13 17:56:47 -07001328
Brian Harring3fec5a82012-03-01 05:57:03 -08001329 if options.chrome_root:
1330 if options.chrome_rev != constants.CHROME_REV_LOCAL:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001331 cros_build_lib.Die('Chrome rev must be %s if chrome_root is set.' %
1332 constants.CHROME_REV_LOCAL)
David Jamesa0a664e2013-02-13 09:52:01 -08001333 elif options.chrome_rev == constants.CHROME_REV_LOCAL:
1334 cros_build_lib.Die('Chrome root must be set if chrome_rev is %s.' %
1335 constants.CHROME_REV_LOCAL)
Brian Harring3fec5a82012-03-01 05:57:03 -08001336
1337 if options.chrome_version:
1338 if options.chrome_rev != constants.CHROME_REV_SPEC:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001339 cros_build_lib.Die('Chrome rev must be %s if chrome_version is set.' %
1340 constants.CHROME_REV_SPEC)
David Jamesa0a664e2013-02-13 09:52:01 -08001341 elif options.chrome_rev == constants.CHROME_REV_SPEC:
1342 cros_build_lib.Die(
1343 'Chrome rev must not be %s if chrome_version is not set.'
1344 % constants.CHROME_REV_SPEC)
Brian Harring3fec5a82012-03-01 05:57:03 -08001345
David James9e27e662013-02-14 13:42:43 -08001346 patches = bool(options.gerrit_patches or options.local_patches or
1347 options.rietveld_patches)
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001348 if options.remote:
1349 if options.local:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001350 cros_build_lib.Die('Cannot specify both --remote and --local')
Ryan Cui54da0702012-04-19 18:38:08 -07001351
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001352 if not options.buildbot and not patches:
Gaurav Shahed0399e2014-02-03 13:36:22 -08001353 prompt = ('No patches were provided; are you sure you want to just '
1354 'run a remote build of %s?' % (
1355 options.branch if options.branch else 'ToT'))
1356 if not cros_build_lib.BooleanPrompt(prompt=prompt, default=False):
Brian Harring7cc4b932012-11-01 16:58:55 -07001357 cros_build_lib.Die('Must provide patches when running with --remote.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001358
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001359 # --debug needs to be explicitly passed through for remote invocations.
1360 release_mode_with_patches = (options.buildbot and patches and
1361 '--debug' not in options.pass_through_args)
1362 else:
1363 if len(args) > 1:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001364 cros_build_lib.Die('Multiple configs not supported if not running with '
Brian Harringf1aad832012-07-18 10:46:39 -07001365 '--remote. Got %r', args)
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001366
Ryan Cui79319ab2012-05-21 12:59:18 -07001367 if options.slaves:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001368 cros_build_lib.Die('Cannot use --slaves if not running with --remote.')
Ryan Cui79319ab2012-05-21 12:59:18 -07001369
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001370 release_mode_with_patches = (options.buildbot and patches and
1371 not options.debug)
1372
David James5734ea32012-08-15 20:23:49 -07001373 # When running in release mode, make sure we are running with checked-in code.
1374 # We want checked-in cbuildbot/scripts to prevent errors, and we want to build
1375 # a release image with checked-in code for CrOS packages.
1376 if release_mode_with_patches:
1377 cros_build_lib.Die(
1378 'Cannot provide patches when running with --buildbot!')
1379
Ryan Cuiba41ad32012-03-08 17:15:29 -08001380 if options.buildbot and options.remote_trybot:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001381 cros_build_lib.Die(
1382 '--buildbot and --remote-trybot cannot be used together.')
Ryan Cuiba41ad32012-03-08 17:15:29 -08001383
Ryan Cui85867972012-02-23 18:21:49 -08001384 # Record whether --debug was set explicitly vs. it was inferred.
1385 options.debug_forced = False
1386 if options.debug:
1387 options.debug_forced = True
Ryan Cui88b901c2013-06-21 11:35:30 -07001388 if not options.debug:
Ryan Cui16ca5812012-03-08 20:34:27 -08001389 # We don't set debug by default for
1390 # 1. --buildbot invocations.
1391 # 2. --remote invocations, because it needs to push changes to the tryjob
1392 # repo.
1393 options.debug = not options.buildbot and not options.remote
Brian Harring3fec5a82012-03-01 05:57:03 -08001394
Ryan Cui1c13a252012-10-16 15:00:16 -07001395 # Record the configs targeted.
1396 options.build_targets = args[:]
1397
Ryan Cui88b901c2013-06-21 11:35:30 -07001398 if constants.BRANCH_UTIL_CONFIG in options.build_targets:
Ryan Cui7bd8db62013-08-08 16:29:51 -07001399 if options.remote:
1400 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001401 'Running %s as a remote tryjob is not yet supported.',
1402 constants.BRANCH_UTIL_CONFIG)
Ryan Cui88b901c2013-06-21 11:35:30 -07001403 if len(options.build_targets) > 1:
1404 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001405 'Cannot run %s with any other configs.',
1406 constants.BRANCH_UTIL_CONFIG)
Ryan Cui88b901c2013-06-21 11:35:30 -07001407 if not options.branch_name:
1408 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001409 'Must specify --branch-name with the %s config.',
1410 constants.BRANCH_UTIL_CONFIG)
1411 if options.branch and options.branch != options.branch_name:
Ryan Cui88b901c2013-06-21 11:35:30 -07001412 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001413 'If --branch is specified with the %s config, it must'
1414 ' have the same value as --branch-name.',
1415 constants.BRANCH_UTIL_CONFIG)
1416
1417 exclusive_opts = {'--version': options.force_version,
1418 '--delete-branch': options.delete_branch,
1419 '--rename-to': options.rename_to,
1420 }
1421 if 1 != sum(1 for x in exclusive_opts.values() if x):
1422 cros_build_lib.Die('When using the %s config, you must'
1423 ' specifiy one and only one of the following'
1424 ' options: %s.', constants.BRANCH_UTIL_CONFIG,
1425 ', '.join(exclusive_opts.keys()))
1426
1427 # When deleting or renaming a branch, the --branch and --nobootstrap
1428 # options are implied.
1429 if options.delete_branch or options.rename_to:
1430 if not options.branch:
1431 cros_build_lib.Info('Automatically enabling sync to branch %s'
1432 ' for this %s flow.', options.branch_name,
1433 constants.BRANCH_UTIL_CONFIG)
1434 options.branch = options.branch_name
1435 if options.bootstrap:
1436 cros_build_lib.Info('Automatically disabling bootstrap step for'
1437 ' this %s flow.', constants.BRANCH_UTIL_CONFIG)
1438 options.bootstrap = False
1439
Ryan Cui88b901c2013-06-21 11:35:30 -07001440 elif any([options.delete_branch, options.rename_to, options.branch_name]):
1441 cros_build_lib.Die(
1442 'Cannot specify --delete-branch, --rename-to or --branch-name when not '
1443 'running the %s config', constants.BRANCH_UTIL_CONFIG)
1444
Brian Harring3fec5a82012-03-01 05:57:03 -08001445
Brian Harring1d7ba942012-04-24 06:37:18 -07001446# pylint: disable=W0613
Brian Harringae0a5322012-09-15 01:46:51 -07001447def _PostParseCheck(parser, options, args):
Ryan Cui85867972012-02-23 18:21:49 -08001448 """Perform some usage validation after we've parsed the arguments
Brian Harring3fec5a82012-03-01 05:57:03 -08001449
Ryan Cui85867972012-02-23 18:21:49 -08001450 Args:
Aviv Keshet9e4236b2013-12-13 13:07:50 -08001451 parser: Option parser that was used to parse arguments.
1452 options: The options returned by optparse.
1453 args: The args returned by optparse.
Ryan Cui85867972012-02-23 18:21:49 -08001454 """
Ryan Cuie1e4e662012-05-21 16:39:46 -07001455 if not options.branch:
David James97d95872012-11-16 15:09:56 -08001456 options.branch = git.GetChromiteTrackingBranch()
Ryan Cuie1e4e662012-05-21 16:39:46 -07001457
Brian Harringae0a5322012-09-15 01:46:51 -07001458 if not repository.IsARepoRoot(options.sourceroot):
1459 if options.local_patches:
1460 raise Exception('Could not find repo checkout at %s!'
1461 % options.sourceroot)
1462
David Jamesac8c2a72013-02-13 18:44:33 -08001463 # Because the default cache dir depends on other options, FindCacheDir
1464 # always returns None, and we setup the default here.
Brian Harringae0a5322012-09-15 01:46:51 -07001465 if options.cache_dir is None:
1466 # Note, options.sourceroot is set regardless of the path
1467 # actually existing.
David Jamesac8c2a72013-02-13 18:44:33 -08001468 if options.buildroot is not None:
Brian Harringae0a5322012-09-15 01:46:51 -07001469 options.cache_dir = os.path.join(options.buildroot, '.cache')
David Jamesac8c2a72013-02-13 18:44:33 -08001470 elif os.path.exists(options.sourceroot):
1471 options.cache_dir = os.path.join(options.sourceroot, '.cache')
Brian Harringae0a5322012-09-15 01:46:51 -07001472 else:
1473 options.cache_dir = parser.FindCacheDir(parser, options)
1474 options.cache_dir = os.path.abspath(options.cache_dir)
Brian Harring8c1d7b12012-10-04 17:36:32 -07001475 parser.ConfigureCacheDir(options.cache_dir)
Brian Harringae0a5322012-09-15 01:46:51 -07001476
Yu-Ju Hong2c066762013-10-28 14:05:08 -07001477 osutils.SafeMakedirsNonRoot(options.cache_dir)
Ryan Cui5ba7e152012-05-10 14:36:52 -07001478
Brian Harring609dc4e2012-05-07 02:17:44 -07001479 if options.local_patches:
Brian Harring1d7ba942012-04-24 06:37:18 -07001480 options.local_patches = _CheckLocalPatches(
Brian Harring609dc4e2012-05-07 02:17:44 -07001481 options.sourceroot, options.local_patches)
Brian Harring1d7ba942012-04-24 06:37:18 -07001482
1483 default = os.environ.get('CBUILDBOT_DEFAULT_MODE')
1484 if (default and not any([options.local, options.buildbot,
1485 options.remote, options.remote_trybot])):
Brian Harring1b8c4c82012-05-29 23:03:04 -07001486 cros_build_lib.Info("CBUILDBOT_DEFAULT_MODE=%s env var detected, using it."
1487 % default)
Brian Harring1d7ba942012-04-24 06:37:18 -07001488 default = default.lower()
1489 if default == 'local':
1490 options.local = True
1491 elif default == 'remote':
1492 options.remote = True
1493 elif default == 'buildbot':
1494 options.buildbot = True
1495 else:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001496 cros_build_lib.Die("CBUILDBOT_DEFAULT_MODE value %s isn't supported. "
1497 % default)
Ryan Cui85867972012-02-23 18:21:49 -08001498
Matt Tennant763497d2014-01-17 16:45:54 -08001499 # Ensure that all args are legitimate config targets.
1500 invalid_target = False
1501 for arg in args:
Matt Tennant2c192032014-01-16 13:49:28 -08001502 build_config = _GetConfig(arg)
Don Garrett4bb21682014-03-03 16:16:23 -08001503
Matt Tennant2c192032014-01-16 13:49:28 -08001504 if not build_config:
Matt Tennant763497d2014-01-17 16:45:54 -08001505 cros_build_lib.Error('No such configuraton target: "%s".', arg)
1506 invalid_target = True
Don Garrett4bb21682014-03-03 16:16:23 -08001507 continue
1508
1509 if options.channels and build_config.build_type != constants.PAYLOADS_TYPE:
1510 cros_build_lib.Die('--channel must only be used with a payload config,'
1511 ' not target (%s).' % arg)
Matt Tennant763497d2014-01-17 16:45:54 -08001512
Matt Tennant2c192032014-01-16 13:49:28 -08001513 # The --version option is not compatible with an external target unless the
1514 # --buildbot option is specified. More correctly, only "paladin versions"
1515 # will work with external targets, and those are only used with --buildbot.
1516 # If --buildbot is specified, then user should know what they are doing and
1517 # only specify a version that will work. See crbug.com/311648.
Don Garrett4bb21682014-03-03 16:16:23 -08001518 if (options.force_version and
1519 not (options.buildbot or build_config.internal)):
1520 cros_build_lib.Die('Cannot specify --version without --buildbot for an'
1521 ' external target (%s).' % arg)
Matt Tennant2c192032014-01-16 13:49:28 -08001522
Matt Tennant763497d2014-01-17 16:45:54 -08001523 if invalid_target:
1524 print 'Please specify one of:'
1525 _PrintValidConfigs()
1526 cros_build_lib.Die('One or more invalid configuration targets specified.')
1527
Ryan Cui85867972012-02-23 18:21:49 -08001528
1529def _ParseCommandLine(parser, argv):
1530 """Completely parse the commandline arguments"""
Brian Harring3fec5a82012-03-01 05:57:03 -08001531 (options, args) = parser.parse_args(argv)
Brian Harring37e559b2012-05-22 20:47:32 -07001532
Matt Tennant763497d2014-01-17 16:45:54 -08001533 # Strip out null arguments.
1534 # TODO(rcui): Remove when buildbot is fixed
1535 args = [arg for arg in args if arg]
1536
1537 # A couple options, like --list, trigger a quick exit.
Brian Harring37e559b2012-05-22 20:47:32 -07001538 if options.output_api_version:
Ryan Cui724f1d32012-10-15 18:10:22 -07001539 print constants.REEXEC_API_VERSION
Brian Harring37e559b2012-05-22 20:47:32 -07001540 sys.exit(0)
1541
Ryan Cui54da0702012-04-19 18:38:08 -07001542 if options.list:
Matt Tennant763497d2014-01-17 16:45:54 -08001543 if args:
1544 cros_build_lib.Die('No arguments expected with the --list options.')
Ryan Cui54da0702012-04-19 18:38:08 -07001545 _PrintValidConfigs(options.print_all)
1546 sys.exit(0)
1547
Ryan Cui8be16062012-04-24 12:05:26 -07001548 if not args:
Matt Tennant763497d2014-01-17 16:45:54 -08001549 parser.error('Invalid usage: no configuration targets provided.'
1550 'Use -h to see usage. Use -l to list supported configs.')
Ryan Cui8be16062012-04-24 12:05:26 -07001551
Ryan Cui85867972012-02-23 18:21:49 -08001552 _FinishParsing(options, args)
1553 return options, args
1554
1555
Matt Tennant759e2352013-09-27 15:14:44 -07001556# TODO(build): This function is too damn long.
Ryan Cui85867972012-02-23 18:21:49 -08001557def main(argv):
David James59a0a2b2013-03-22 14:04:44 -07001558 # Turn on strict sudo checks.
1559 cros_build_lib.STRICT_SUDO = True
1560
Ryan Cui85867972012-02-23 18:21:49 -08001561 # Set umask to 022 so files created by buildbot are readable.
Mike Frysinger60ec1012013-10-21 00:11:10 -04001562 os.umask(0o22)
Ryan Cui85867972012-02-23 18:21:49 -08001563
Ryan Cui85867972012-02-23 18:21:49 -08001564 parser = _CreateParser()
1565 (options, args) = _ParseCommandLine(parser, argv)
Brian Harring3fec5a82012-03-01 05:57:03 -08001566
Brian Harringae0a5322012-09-15 01:46:51 -07001567 _PostParseCheck(parser, options, args)
Brian Harring3fec5a82012-03-01 05:57:03 -08001568
Mike Frysinger8fd67dc2012-12-03 23:51:18 -05001569 cros_build_lib.AssertOutsideChroot()
Zdenek Behan98ec2fb2012-08-31 17:12:18 +02001570
Brian Harring3fec5a82012-03-01 05:57:03 -08001571 if options.remote:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001572 cros_build_lib.logger.setLevel(logging.WARNING)
Ryan Cui16ca5812012-03-08 20:34:27 -08001573
Brian Harring3fec5a82012-03-01 05:57:03 -08001574 # Verify configs are valid.
Dan Shi0bdb7132013-07-30 16:22:12 -07001575 # If hwtest flag is enabled, post a warning that HWTest step may fail if the
1576 # specified board is not a released platform or it is a generic overlay.
Brian Harring3fec5a82012-03-01 05:57:03 -08001577 for bot in args:
Aviv Kesheta96a2a92013-02-05 17:21:51 -08001578 build_config = _GetConfig(bot)
1579 if options.hwtest:
Dan Shi0bdb7132013-07-30 16:22:12 -07001580 cros_build_lib.Warning(
1581 'If %s is not a released platform or it is a generic overlay, '
1582 'the HWTest step will most likely not run; please ask the lab '
1583 'team for help if this is unexpected.' % build_config['boards'])
Brian Harring3fec5a82012-03-01 05:57:03 -08001584
1585 # Verify gerrit patches are valid.
Ryan Cui16ca5812012-03-08 20:34:27 -08001586 print 'Verifying patches...'
Ryan Cuie1e4e662012-05-21 16:39:46 -07001587 patch_pool = AcquirePoolFromOptions(options)
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001588
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001589 # --debug need to be explicitly passed through for remote invocations.
1590 if options.buildbot and '--debug' not in options.pass_through_args:
1591 _ConfirmRemoteBuildbotRun()
1592
Ryan Cui16ca5812012-03-08 20:34:27 -08001593 print 'Submitting tryjob...'
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001594 tryjob = remote_try.RemoteTryJob(options, args, patch_pool.local_patches)
Ryan Cuia25d8eb2012-07-11 14:54:27 -07001595 tryjob.Submit(testjob=options.test_tryjob, dryrun=False)
Ryan Cui16ca5812012-03-08 20:34:27 -08001596 print 'Tryjob submitted!'
1597 print ('Go to %s to view the status of your job.'
Ryan Cui4906e1c2012-04-03 20:09:34 -07001598 % tryjob.GetTrybotWaterfallLink())
Brian Harring3fec5a82012-03-01 05:57:03 -08001599 sys.exit(0)
Matt Tennant759e2352013-09-27 15:14:44 -07001600
Ryan Cui54da0702012-04-19 18:38:08 -07001601 elif (not options.buildbot and not options.remote_trybot
1602 and not options.resume and not options.local):
Ryan Cui88b901c2013-06-21 11:35:30 -07001603 options.local = True
Brian Harring1b8c4c82012-05-29 23:03:04 -07001604 cros_build_lib.Warning(
1605 'Running in LOCAL TRYBOT mode! Use --remote to submit REMOTE '
1606 'tryjobs. Use --local to suppress this message.')
1607 cros_build_lib.Warning(
Ryan Cui51591352012-07-09 15:15:53 -07001608 'In the future, --local will be required to run the local '
Brian Harring1b8c4c82012-05-29 23:03:04 -07001609 'trybot.')
Ryan Cui54da0702012-04-19 18:38:08 -07001610 time.sleep(5)
Brian Harring3fec5a82012-03-01 05:57:03 -08001611
Matt Tennant759e2352013-09-27 15:14:44 -07001612 # Only one config arg is allowed in this mode, which was confirmed earlier.
Ryan Cui8be16062012-04-24 12:05:26 -07001613 bot_id = args[-1]
1614 build_config = _GetConfig(bot_id)
Brian Harring3fec5a82012-03-01 05:57:03 -08001615
David Jamesdac7a912013-11-18 11:14:44 -08001616 if options.reference_repo is None:
1617 repo_path = os.path.join(options.sourceroot, '.repo')
1618 # If we're being run from a repo checkout, reuse the repo's git pool to
1619 # cut down on sync time.
1620 if os.path.exists(repo_path):
1621 options.reference_repo = options.sourceroot
1622 elif options.reference_repo:
1623 if not os.path.exists(options.reference_repo):
1624 parser.error('Reference path %s does not exist'
1625 % (options.reference_repo,))
1626 elif not os.path.exists(os.path.join(options.reference_repo, '.repo')):
1627 parser.error('Reference path %s does not look to be the base of a '
1628 'repo checkout; no .repo exists in the root.'
1629 % (options.reference_repo,))
1630
Brian Harringf11bf682012-05-14 15:53:43 -07001631 if (options.buildbot or options.remote_trybot) and not options.resume:
Brian Harring470f6112012-03-02 11:47:10 -08001632 if not options.cgroups:
Ryan Cuid4a24212012-04-04 18:08:12 -07001633 parser.error('Options --buildbot/--remote-trybot and --nocgroups cannot '
1634 'be used together. Cgroup support is required for '
1635 'buildbot/remote-trybot mode.')
Mike Frysingera78a56e2012-11-20 06:02:30 -05001636 if not cgroups.Cgroup.IsSupported():
Ryan Cuid4a24212012-04-04 18:08:12 -07001637 parser.error('Option --buildbot/--remote-trybot was given, but this '
1638 'system does not support cgroups. Failing.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001639
David Jamesaad5cc72012-10-26 15:03:13 -07001640 missing = osutils.FindMissingBinaries(_BUILDBOT_REQUIRED_BINARIES)
Brian Harring351ce442012-03-09 16:38:14 -08001641 if missing:
Ryan Cuid4a24212012-04-04 18:08:12 -07001642 parser.error("Option --buildbot/--remote-trybot requires the following "
1643 "binaries which couldn't be found in $PATH: %s"
Brian Harring351ce442012-03-09 16:38:14 -08001644 % (', '.join(missing)))
1645
David Jamesdac7a912013-11-18 11:14:44 -08001646 if options.reference_repo:
1647 options.reference_repo = os.path.abspath(options.reference_repo)
1648
Brian Harring3fec5a82012-03-01 05:57:03 -08001649 if not options.buildroot:
1650 if options.buildbot:
Mike Frysinger6903c762012-12-04 01:57:16 -05001651 parser.error('Please specify a buildroot with the --buildbot option.')
Matt Tennantd55b1f42012-04-13 14:15:01 -07001652
Ryan Cui5ba7e152012-05-10 14:36:52 -07001653 options.buildroot = _DetermineDefaultBuildRoot(options.sourceroot,
1654 build_config['internal'])
Brian Harring470f6112012-03-02 11:47:10 -08001655 # We use a marker file in the buildroot to indicate the user has
1656 # consented to using this directory.
1657 if not os.path.exists(repository.GetTrybotMarkerPath(options.buildroot)):
1658 _ConfirmBuildRoot(options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -08001659
1660 # Sanity check of buildroot- specifically that it's not pointing into the
1661 # midst of an existing repo since git-repo doesn't support nesting.
Brian Harring3fec5a82012-03-01 05:57:03 -08001662 if (not repository.IsARepoRoot(options.buildroot) and
David James13a69c92013-05-09 10:37:42 -07001663 git.FindRepoDir(options.buildroot)):
Brian Harring3fec5a82012-03-01 05:57:03 -08001664 parser.error('Configured buildroot %s points into a repository checkout, '
1665 'rather than the root of it. This is not supported.'
1666 % options.buildroot)
1667
Chris Sosab5ea3b42012-10-25 15:25:20 -07001668 if not options.log_dir:
1669 options.log_dir = os.path.join(options.buildroot, _DEFAULT_LOG_DIR)
1670
Brian Harringd166aaf2012-05-14 18:31:53 -07001671 log_file = None
1672 if options.tee:
Chris Sosab5ea3b42012-10-25 15:25:20 -07001673 log_file = os.path.join(options.log_dir, _BUILDBOT_LOG_FILE)
1674 osutils.SafeMakedirs(options.log_dir)
Brian Harringd166aaf2012-05-14 18:31:53 -07001675 _BackupPreviousLog(log_file)
1676
Brian Harring1b8c4c82012-05-29 23:03:04 -07001677 with cros_build_lib.ContextManagerStack() as stack:
Aaron Gable881fccb2013-09-27 18:35:24 -07001678 # TODO(ferringb): update this once
1679 # https://chromium-review.googlesource.com/25359
David Jamescebc7272013-07-17 16:45:05 -07001680 # is landed- it's sensitive to the manifest-versions cache path.
1681 options.preserve_paths = set(['manifest-versions', '.cache',
1682 'manifest-versions-internal'])
1683 if log_file is not None:
1684 # We don't want the critical section to try to clean up the tee process,
1685 # so we run Tee (forked off) outside of it. This prevents a deadlock
1686 # because the Tee process only exits when its pipe is closed, and the
1687 # critical section accidentally holds on to that file handle.
1688 stack.Add(tee.Tee, log_file)
1689 options.preserve_paths.add(_DEFAULT_LOG_DIR)
1690
Brian Harringc2d09d92012-05-13 22:03:15 -07001691 critical_section = stack.Add(cleanup.EnforcedCleanupSection)
1692 stack.Add(sudo.SudoKeepAlive)
Brian Harringd166aaf2012-05-14 18:31:53 -07001693
Brian Harringc2d09d92012-05-13 22:03:15 -07001694 if not options.resume:
Brian Harring2bf55e12012-05-13 21:31:55 -07001695 # If we're in resume mode, use our parents tempdir rather than
1696 # nesting another layer.
David James4bc13702013-03-26 08:08:04 -07001697 stack.Add(osutils.TempDir, prefix='cbuildbot-tmp', set_global=True)
Brian Harringc2d09d92012-05-13 22:03:15 -07001698 logging.debug("Cbuildbot tempdir is %r.", os.environ.get('TMP'))
Brian Harringd166aaf2012-05-14 18:31:53 -07001699
Brian Harringc2d09d92012-05-13 22:03:15 -07001700 if options.cgroups:
1701 stack.Add(cgroups.SimpleContainChildren, 'cbuildbot')
Brian Harringa184efa2012-03-04 11:51:25 -08001702
Brian Harringc2d09d92012-05-13 22:03:15 -07001703 # Mark everything between EnforcedCleanupSection and here as having to
1704 # be rolled back via the contextmanager cleanup handlers. This
1705 # ensures that sudo bits cannot outlive cbuildbot, that anything
1706 # cgroups would kill gets killed, etc.
David Jamesfb3aac92013-10-16 13:26:52 -07001707 stack.Add(critical_section.ForkWatchdog)
Brian Harringd166aaf2012-05-14 18:31:53 -07001708
Brian Harringc2d09d92012-05-13 22:03:15 -07001709 if options.timeout > 0:
David James3432acd2013-11-27 10:02:18 -08001710 stack.Add(timeout_util.FatalTimeout, options.timeout)
Brian Harringa184efa2012-03-04 11:51:25 -08001711
Brian Harringc2d09d92012-05-13 22:03:15 -07001712 if not options.buildbot:
1713 build_config = cbuildbot_config.OverrideConfigForTrybot(
Don Garrett4bb21682014-03-03 16:16:23 -08001714 build_config, options)
Brian Harringc2d09d92012-05-13 22:03:15 -07001715
Mike Frysinger6903c762012-12-04 01:57:16 -05001716 if options.buildbot or options.remote_trybot:
1717 _DisableYamaHardLinkChecks()
1718
Aviv Kesheta0159be2013-12-12 13:56:28 -08001719 if options.mock_tree_status is not None:
1720 stack.Add(mock.patch.object, timeout_util, '_GetStatus',
1721 return_value=options.mock_tree_status)
1722
Aviv Keshetcf9c2722014-02-25 15:15:10 -08001723 if options.mock_slave_status is not None:
1724 with open(options.mock_slave_status, 'r') as f:
Aviv Keshet4e750022014-03-07 16:50:34 -08001725 mock_statuses = pickle.load(f)
1726 for key, value in mock_statuses.iteritems():
1727 mock_statuses[key] = manifest_version.BuilderStatus(**value)
Aviv Keshetcf9c2722014-02-25 15:15:10 -08001728 stack.Add(mock.patch.object, stages.MasterSlaveSyncCompletionStage,
Aviv Keshet4e750022014-03-07 16:50:34 -08001729 '_FetchSlaveStatuses', return_value=mock_statuses)
Aviv Keshetcf9c2722014-02-25 15:15:10 -08001730
Brian Harringc2d09d92012-05-13 22:03:15 -07001731 _RunBuildStagesWrapper(options, build_config)