blob: ee4fba4c66785c0a9fe744bc2bbf6ea298491b96 [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
Brian Harring3fec5a82012-03-01 05:57:03 -080020import sys
Ryan Cui54da0702012-04-19 18:38:08 -070021import time
David James3541a132013-03-18 13:21:58 -070022import traceback
Brian Harring3fec5a82012-03-01 05:57:03 -080023
Brian Harring3fec5a82012-03-01 05:57:03 -080024from chromite.buildbot import cbuildbot_config
25from chromite.buildbot import cbuildbot_stages as stages
26from chromite.buildbot import cbuildbot_results as results_lib
Matt Tennantefb59522013-10-18 13:49:28 -070027from chromite.buildbot import cbuildbot_run
Brian Harring3fec5a82012-03-01 05:57:03 -080028from chromite.buildbot import constants
Brian Harring3fec5a82012-03-01 05:57:03 -080029from chromite.buildbot import remote_try
30from chromite.buildbot import repository
31from chromite.buildbot import tee
Ryan Cui16d9e1f2012-05-11 10:50:18 -070032from chromite.buildbot import trybot_patch_pool
Brian Harring3fec5a82012-03-01 05:57:03 -080033
Brian Harringc92a7012012-02-29 10:11:34 -080034from chromite.lib import cgroups
Brian Harringa184efa2012-03-04 11:51:25 -080035from chromite.lib import cleanup
Brian Harringb6cf9142012-09-01 20:43:17 -070036from chromite.lib import commandline
Brian Harring1b8c4c82012-05-29 23:03:04 -070037from chromite.lib import cros_build_lib
David Jamesa0a664e2013-02-13 09:52:01 -080038from chromite.lib import gclient
Brian Harring511055e2012-10-10 02:58:59 -070039from chromite.lib import gerrit
David James97d95872012-11-16 15:09:56 -080040from chromite.lib import git
Brian Harringaf019fb2012-05-10 15:06:13 -070041from chromite.lib import osutils
Brian Harring511055e2012-10-10 02:58:59 -070042from chromite.lib import patch as cros_patch
David James6450a0a2012-12-04 07:59:53 -080043from chromite.lib import parallel
Brian Harring3fec5a82012-03-01 05:57:03 -080044from chromite.lib import sudo
David James3432acd2013-11-27 10:02:18 -080045from chromite.lib import timeout_util
Brian Harring3fec5a82012-03-01 05:57:03 -080046
Aviv Kesheta0159be2013-12-12 13:56:28 -080047import mock
48
Ryan Cuiadd49122012-03-21 22:19:58 -070049
Brian Harring3fec5a82012-03-01 05:57:03 -080050_DEFAULT_LOG_DIR = 'cbuildbot_logs'
51_BUILDBOT_LOG_FILE = 'cbuildbot.log'
52_DEFAULT_EXT_BUILDROOT = 'trybot'
53_DEFAULT_INT_BUILDROOT = 'trybot-internal'
Brian Harring351ce442012-03-09 16:38:14 -080054_BUILDBOT_REQUIRED_BINARIES = ('pbzip2',)
Ryan Cui1c13a252012-10-16 15:00:16 -070055_API_VERSION_ATTR = 'api_version'
Brian Harring3fec5a82012-03-01 05:57:03 -080056
57
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070058def _PrintValidConfigs(display_all=False):
Brian Harring3fec5a82012-03-01 05:57:03 -080059 """Print a list of valid buildbot configs.
60
Mike Frysinger02e1e072013-11-10 22:11:34 -050061 Args:
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070062 display_all: Print all configs. Otherwise, prints only configs with
63 trybot_list=True.
Brian Harring3fec5a82012-03-01 05:57:03 -080064 """
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070065 def _GetSortKey(config_name):
66 config_dict = cbuildbot_config.config[config_name]
67 return (not config_dict['trybot_list'], config_dict['description'],
68 config_name)
69
Brian Harring3fec5a82012-03-01 05:57:03 -080070 COLUMN_WIDTH = 45
Matt Tennant763497d2014-01-17 16:45:54 -080071 print
Brian Harring3fec5a82012-03-01 05:57:03 -080072 print 'config'.ljust(COLUMN_WIDTH), 'description'
73 print '------'.ljust(COLUMN_WIDTH), '-----------'
74 config_names = cbuildbot_config.config.keys()
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070075 config_names.sort(key=_GetSortKey)
Brian Harring3fec5a82012-03-01 05:57:03 -080076 for name in config_names:
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070077 if display_all or cbuildbot_config.config[name]['trybot_list']:
78 desc = cbuildbot_config.config[name].get('description')
79 desc = desc if desc else ''
Brian Harring3fec5a82012-03-01 05:57:03 -080080 print name.ljust(COLUMN_WIDTH), desc
81
Matt Tennant763497d2014-01-17 16:45:54 -080082 print
83
Brian Harring3fec5a82012-03-01 05:57:03 -080084
85def _GetConfig(config_name):
Matt Tennant763497d2014-01-17 16:45:54 -080086 """Gets the configuration for the build if it exists, None otherwise."""
87 if cbuildbot_config.config.has_key(config_name):
88 return cbuildbot_config.config[config_name]
Brian Harring3fec5a82012-03-01 05:57:03 -080089
90
Ryan Cuie1e4e662012-05-21 16:39:46 -070091def AcquirePoolFromOptions(options):
Ryan Cui16d9e1f2012-05-11 10:50:18 -070092 """Generate patch objects from passed in options.
Brian Harring3fec5a82012-03-01 05:57:03 -080093
94 Args:
Ryan Cui16d9e1f2012-05-11 10:50:18 -070095 options: The options object generated by optparse.
Brian Harring3fec5a82012-03-01 05:57:03 -080096
Ryan Cuif7f24692012-05-18 16:35:33 -070097 Returns:
98 trybot_patch_pool.TrybotPatchPool object.
99
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700100 Raises:
Brian Harring511055e2012-10-10 02:58:59 -0700101 gerrit.GerritException, cros_patch.PatchException
Brian Harring3fec5a82012-03-01 05:57:03 -0800102 """
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700103 gerrit_patches = []
104 local_patches = []
105 remote_patches = []
Brian Harring3fec5a82012-03-01 05:57:03 -0800106
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700107 if options.gerrit_patches:
Brian Harring511055e2012-10-10 02:58:59 -0700108 gerrit_patches = gerrit.GetGerritPatchInfo(
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700109 options.gerrit_patches)
110 for patch in gerrit_patches:
111 if patch.IsAlreadyMerged():
Brian Harring1b8c4c82012-05-29 23:03:04 -0700112 cros_build_lib.Warning('Patch %s has already been merged.' % str(patch))
Brian Harring3fec5a82012-03-01 05:57:03 -0800113
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700114 if options.local_patches:
David James97d95872012-11-16 15:09:56 -0800115 manifest = git.ManifestCheckout.Cached(options.sourceroot)
Brian Harring609dc4e2012-05-07 02:17:44 -0700116 local_patches = cros_patch.PrepareLocalPatches(manifest,
117 options.local_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800118
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700119 if options.remote_patches:
120 remote_patches = cros_patch.PrepareRemotePatches(
121 options.remote_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800122
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700123 return trybot_patch_pool.TrybotPatchPool(gerrit_patches, local_patches,
124 remote_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800125
126
Brian Harring3fec5a82012-03-01 05:57:03 -0800127class Builder(object):
128 """Parent class for all builder types.
129
Matt Tennant759e2352013-09-27 15:14:44 -0700130 This class functions as an abstract parent class for various build types.
131 Its intended use is builder_instance.Run().
Brian Harring3fec5a82012-03-01 05:57:03 -0800132
Matt Tennant3f351552014-01-03 14:28:00 -0800133 Attributes:
134 _run: The BuilderRun object for this run.
135 archive_stages: Dict of BuildConfig keys to ArchiveStage values.
136 patch_pool: TrybotPatchPool.
Brian Harring3fec5a82012-03-01 05:57:03 -0800137 """
138
Matt Tennantefb59522013-10-18 13:49:28 -0700139 def __init__(self, builder_run):
Brian Harring3fec5a82012-03-01 05:57:03 -0800140 """Initializes instance variables. Must be called by all subclasses."""
Matt Tennantefb59522013-10-18 13:49:28 -0700141 self._run = builder_run
Brian Harring3fec5a82012-03-01 05:57:03 -0800142
Matt Tennantefb59522013-10-18 13:49:28 -0700143 if self._run.config.chromeos_official:
Brian Harring3fec5a82012-03-01 05:57:03 -0800144 os.environ['CHROMEOS_OFFICIAL'] = '1'
145
David James58e0c092012-03-04 20:31:12 -0800146 self.archive_stages = {}
Brian Harring76d1bf62012-06-01 13:52:48 -0700147 self.patch_pool = trybot_patch_pool.TrybotPatchPool()
Brian Harring3fec5a82012-03-01 05:57:03 -0800148
149 def Initialize(self):
150 """Runs through the initialization steps of an actual build."""
Matt Tennantefb59522013-10-18 13:49:28 -0700151 if self._run.options.resume:
152 results_lib.LoadCheckpoint(self._run.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800153
Brian Harring3fec5a82012-03-01 05:57:03 -0800154 self._RunStage(stages.CleanUpStage)
155
156 def _GetStageInstance(self, stage, *args, **kwargs):
Matt Tennant759e2352013-09-27 15:14:44 -0700157 """Helper function to get a stage instance given the args.
Brian Harring3fec5a82012-03-01 05:57:03 -0800158
Matt Tennantefb59522013-10-18 13:49:28 -0700159 Useful as almost all stages just take in builder_run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800160 """
Matt Tennantefb59522013-10-18 13:49:28 -0700161 # Normally the default BuilderRun (self._run) is used, but it can
162 # be overridden with "builder_run" kwargs (e.g. for child configs).
163 builder_run = kwargs.pop('builder_run', self._run)
164 return stage(builder_run, *args, **kwargs)
Brian Harring3fec5a82012-03-01 05:57:03 -0800165
166 def _SetReleaseTag(self):
Matt Tennantefb59522013-10-18 13:49:28 -0700167 """Sets the release tag from the manifest manager.
Brian Harring3fec5a82012-03-01 05:57:03 -0800168
Matt Tennantf4980ee2014-01-29 09:21:27 -0800169 Must be run after sync stage as syncing enables us to have a release tag,
170 and must be run before any usage of attrs.release_tag.
Matt Tennantefb59522013-10-18 13:49:28 -0700171
172 TODO(mtennant): Find a bottleneck place in syncing that can set this
Matt Tennantf4980ee2014-01-29 09:21:27 -0800173 directly. Be careful, as there are several kinds of syncing stages, and
174 sync stages have been known to abort with sys.exit calls.
Brian Harring3fec5a82012-03-01 05:57:03 -0800175 """
Matt Tennantefb59522013-10-18 13:49:28 -0700176 manifest_manager = getattr(self._run.attrs, 'manifest_manager', None)
Brian Harring3fec5a82012-03-01 05:57:03 -0800177 if manifest_manager:
Matt Tennantefb59522013-10-18 13:49:28 -0700178 self._run.attrs.release_tag = manifest_manager.current_version
Matt Tennant3f351552014-01-03 14:28:00 -0800179 else:
180 self._run.attrs.release_tag = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800181
Matt Tennanta42a5742014-02-09 13:42:12 -0800182 cros_build_lib.Debug('Saved release_tag value for run: %r',
183 self._run.attrs.release_tag)
184
Brian Harring3fec5a82012-03-01 05:57:03 -0800185 def _RunStage(self, stage, *args, **kwargs):
Matt Tennant759e2352013-09-27 15:14:44 -0700186 """Wrapper to run a stage.
187
188 Args:
189 stage: A BuilderStage class.
190 args: args to pass to stage constructor.
191 kwargs: kwargs to pass to stage constructor.
Mike Frysinger1a736a82013-12-12 01:50:59 -0500192
Matt Tennant759e2352013-09-27 15:14:44 -0700193 Returns:
Matt Tennant759e2352013-09-27 15:14:44 -0700194 Whatever the stage's Run method returns.
195 """
Brian Harring3fec5a82012-03-01 05:57:03 -0800196 stage_instance = self._GetStageInstance(stage, *args, **kwargs)
197 return stage_instance.Run()
198
Matt Tennantf4980ee2014-01-29 09:21:27 -0800199 def _RunSyncStage(self, sync_instance):
200 """Run given |sync_instance| stage and be sure attrs.release_tag set."""
201 try:
202 sync_instance.Run()
203 finally:
204 self._SetReleaseTag()
205
Brian Harring3fec5a82012-03-01 05:57:03 -0800206 def GetSyncInstance(self):
207 """Returns an instance of a SyncStage that should be run.
208
209 Subclasses must override this method.
210 """
211 raise NotImplementedError()
212
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400213 def GetCompletionInstance(self):
Aviv Keshetf2746152013-11-26 10:42:46 -0800214 """Returns the MasterSlaveSyncCompletionStage for this build.
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400215
216 Subclasses may override this method.
217
Mike Frysinger02e1e072013-11-10 22:11:34 -0500218 Returns:
219 None
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400220 """
221 return None
222
Brian Harring3fec5a82012-03-01 05:57:03 -0800223 def RunStages(self):
224 """Subclasses must override this method. Runs the appropriate code."""
225 raise NotImplementedError()
226
Brian Harring3fec5a82012-03-01 05:57:03 -0800227 def _ReExecuteInBuildroot(self, sync_instance):
228 """Reexecutes self in buildroot and returns True if build succeeds.
229
230 This allows the buildbot code to test itself when changes are patched for
231 buildbot-related code. This is a no-op if the buildroot == buildroot
232 of the running chromite checkout.
233
234 Args:
Matt Tennant85348852014-01-10 15:16:02 -0800235 sync_instance: Instance of the sync stage that was run to sync.
Brian Harring3fec5a82012-03-01 05:57:03 -0800236
237 Returns:
238 True if the Build succeeded.
239 """
Matt Tennantefb59522013-10-18 13:49:28 -0700240 if not self._run.options.resume:
241 results_lib.WriteCheckpoint(self._run.options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800242
Ryan Cui1c13a252012-10-16 15:00:16 -0700243 args = stages.BootstrapStage.FilterArgsForTargetCbuildbot(
Matt Tennantefb59522013-10-18 13:49:28 -0700244 self._run.options.buildroot, constants.PATH_TO_CBUILDBOT,
245 self._run.options)
Brian Harring37e559b2012-05-22 20:47:32 -0700246
David James2333c182013-02-13 16:16:15 -0800247 # Specify a buildroot explicitly (just in case, for local trybot).
Brian Harring3fec5a82012-03-01 05:57:03 -0800248 # Suppress any timeout options given from the commandline in the
249 # invoked cbuildbot; our timeout will enforce it instead.
Ryan Cui1c13a252012-10-16 15:00:16 -0700250 args += ['--resume', '--timeout', '0', '--notee', '--nocgroups',
Matt Tennantefb59522013-10-18 13:49:28 -0700251 '--buildroot', os.path.abspath(self._run.options.buildroot)]
Brian Harringae0a5322012-09-15 01:46:51 -0700252
Matt Tennantefb59522013-10-18 13:49:28 -0700253 if hasattr(self._run.attrs, 'manifest_manager'):
254 # TODO(mtennant): Is this the same as self._run.attrs.release_tag?
255 ver = self._run.attrs.manifest_manager.current_version
Ryan Cui1c13a252012-10-16 15:00:16 -0700256 args += ['--version', ver]
Brian Harring3fec5a82012-03-01 05:57:03 -0800257
David Jamesf421c6d2013-04-11 15:37:57 -0700258 pool = getattr(sync_instance, 'pool', None)
259 if pool:
Matt Tennantefb59522013-10-18 13:49:28 -0700260 filename = os.path.join(self._run.options.buildroot,
261 'validation_pool.dump')
David Jamesf421c6d2013-04-11 15:37:57 -0700262 pool.Save(filename)
263 args += ['--validation_pool', filename]
Brian Harring3fec5a82012-03-01 05:57:03 -0800264
David Jamesac8c2a72013-02-13 18:44:33 -0800265 # Reset the cache dir so that the child will calculate it automatically.
Matt Tennantefb59522013-10-18 13:49:28 -0700266 if not self._run.options.cache_dir_specified:
David Jamesac8c2a72013-02-13 18:44:33 -0800267 commandline.BaseParser.ConfigureCacheDir(None)
268
Brian Harring3fec5a82012-03-01 05:57:03 -0800269 # Re-run the command in the buildroot.
270 # Finally, be generous and give the invoked cbuildbot 30s to shutdown
271 # when something occurs. It should exit quicker, but the sigterm may
272 # hit while the system is particularly busy.
Brian Harring1b8c4c82012-05-29 23:03:04 -0700273 return_obj = cros_build_lib.RunCommand(
Matt Tennantefb59522013-10-18 13:49:28 -0700274 args, cwd=self._run.options.buildroot, error_code_ok=True,
275 kill_timeout=30)
Brian Harring3fec5a82012-03-01 05:57:03 -0800276 return return_obj.returncode == 0
277
Ryan Cuif7f24692012-05-18 16:35:33 -0700278 def _InitializeTrybotPatchPool(self):
279 """Generate patch pool from patches specified on the command line.
280
281 Do this only if we need to patch changes later on.
282 """
283 changes_stage = stages.PatchChangesStage.StageNamePrefix()
284 check_func = results_lib.Results.PreviouslyCompletedRecord
Matt Tennantefb59522013-10-18 13:49:28 -0700285 if not check_func(changes_stage) or self._run.options.bootstrap:
286 self.patch_pool = AcquirePoolFromOptions(self._run.options)
Ryan Cuif7f24692012-05-18 16:35:33 -0700287
288 def _GetBootstrapStage(self):
289 """Constructs and returns the BootStrapStage object.
290
291 We return None when there are no chromite patches to test, and
292 --test-bootstrap wasn't passed in.
293 """
294 stage = None
295 chromite_pool = self.patch_pool.Filter(project=constants.CHROMITE_PROJECT)
Ryan Cui5616a512012-08-17 13:39:36 -0700296 manifest_pool = self.patch_pool.FilterManifest()
David James97d95872012-11-16 15:09:56 -0800297 chromite_branch = git.GetChromiteTrackingBranch()
Matt Tennantefb59522013-10-18 13:49:28 -0700298 if (chromite_pool or manifest_pool or
299 self._run.options.test_bootstrap or
300 chromite_branch != self._run.options.branch):
301 stage = stages.BootstrapStage(self._run, chromite_pool,
302 manifest_pool)
Ryan Cuif7f24692012-05-18 16:35:33 -0700303 return stage
304
Brian Harring3fec5a82012-03-01 05:57:03 -0800305 def Run(self):
Ryan Cuif7f24692012-05-18 16:35:33 -0700306 """Main runner for this builder class. Runs build and prints summary.
307
308 Returns:
309 Whether the build succeeded.
310 """
311 self._InitializeTrybotPatchPool()
312
Matt Tennantefb59522013-10-18 13:49:28 -0700313 if self._run.options.bootstrap:
Ryan Cuif7f24692012-05-18 16:35:33 -0700314 bootstrap_stage = self._GetBootstrapStage()
315 if bootstrap_stage:
316 # BootstrapStage blocks on re-execution of cbuildbot.
317 bootstrap_stage.Run()
318 return bootstrap_stage.returncode == 0
319
Brian Harring3fec5a82012-03-01 05:57:03 -0800320 print_report = True
David James3d4d3502012-04-09 15:12:06 -0700321 exception_thrown = False
Brian Harring3fec5a82012-03-01 05:57:03 -0800322 success = True
David James9ebb2a42013-08-13 20:29:57 -0700323 sync_instance = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800324 try:
325 self.Initialize()
326 sync_instance = self.GetSyncInstance()
Matt Tennantf4980ee2014-01-29 09:21:27 -0800327 self._RunSyncStage(sync_instance)
Brian Harring3fec5a82012-03-01 05:57:03 -0800328
Matt Tennantefb59522013-10-18 13:49:28 -0700329 if self._run.ShouldPatchAfterSync():
Ryan Cui88b901c2013-06-21 11:35:30 -0700330 # Filter out patches to manifest, since PatchChangesStage can't handle
331 # them. Manifest patches are patched in the BootstrapStage.
332 non_manifest_patches = self.patch_pool.FilterManifest(negate=True)
333 if non_manifest_patches:
334 self._RunStage(stages.PatchChangesStage, non_manifest_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800335
Matt Tennantefb59522013-10-18 13:49:28 -0700336 if self._run.ShouldReexecAfterSync():
Brian Harring3fec5a82012-03-01 05:57:03 -0800337 print_report = False
338 success = self._ReExecuteInBuildroot(sync_instance)
339 else:
340 self.RunStages()
Matt Tennant759e2352013-09-27 15:14:44 -0700341
David James3541a132013-03-18 13:21:58 -0700342 except Exception as ex:
343 # If the build is marked as successful, but threw exceptions, that's a
344 # problem.
David James7fbf2d42012-07-14 18:23:49 -0700345 exception_thrown = True
David James3541a132013-03-18 13:21:58 -0700346 if results_lib.Results.BuildSucceededSoFar():
347 traceback.print_exc(file=sys.stdout)
David James7fbf2d42012-07-14 18:23:49 -0700348 raise
Matt Tennant759e2352013-09-27 15:14:44 -0700349
David James3541a132013-03-18 13:21:58 -0700350 if not (print_report and isinstance(ex, results_lib.StepFailure)):
351 raise
Matt Tennant759e2352013-09-27 15:14:44 -0700352
Brian Harring3fec5a82012-03-01 05:57:03 -0800353 finally:
354 if print_report:
Matt Tennantefb59522013-10-18 13:49:28 -0700355 results_lib.WriteCheckpoint(self._run.options.buildroot)
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400356 completion_instance = self.GetCompletionInstance()
Matt Tennant066d9322014-01-28 10:37:48 -0800357 self._RunStage(stages.ReportStage, sync_instance, completion_instance)
Brian Harring3fec5a82012-03-01 05:57:03 -0800358 success = results_lib.Results.BuildSucceededSoFar()
David James3d4d3502012-04-09 15:12:06 -0700359 if exception_thrown and success:
360 success = False
David Jamesbb20ac82012-07-18 10:59:16 -0700361 cros_build_lib.PrintBuildbotStepWarnings()
362 print """\
David James3d4d3502012-04-09 15:12:06 -0700363Exception thrown, but all stages marked successful. This is an internal error,
364because the stage that threw the exception should be marked as failing."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800365
366 return success
367
368
David James1fddb8f2013-04-25 15:23:07 -0700369BoardConfig = collections.namedtuple('BoardConfig', ['board', 'name'])
370
371
Brian Harring3fec5a82012-03-01 05:57:03 -0800372class SimpleBuilder(Builder):
373 """Builder that performs basic vetting operations."""
374
375 def GetSyncInstance(self):
376 """Sync to lkgm or TOT as necessary.
377
Mike Frysinger02e1e072013-11-10 22:11:34 -0500378 Returns:
379 The instance of the sync stage to run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800380 """
Matt Tennantefb59522013-10-18 13:49:28 -0700381 if self._run.options.force_version:
Ryan Cui88b901c2013-06-21 11:35:30 -0700382 sync_stage = self._GetStageInstance(stages.ManifestVersionedSyncStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700383 elif self._run.config.use_lkgm:
Brian Harring3fec5a82012-03-01 05:57:03 -0800384 sync_stage = self._GetStageInstance(stages.LKGMSyncStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700385 elif self._run.config.use_chrome_lkgm:
Chris Sosa52a81b62012-11-14 06:12:54 -0800386 sync_stage = self._GetStageInstance(stages.ChromeLKGMSyncStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800387 else:
388 sync_stage = self._GetStageInstance(stages.SyncStage)
389
390 return sync_stage
391
David James4f2d8302013-03-19 06:35:58 -0700392 @staticmethod
393 def _RunParallelStages(stage_objs):
Matt Tennant759e2352013-09-27 15:14:44 -0700394 """Run the specified stages in parallel.
395
396 Args:
397 stage_objs: BuilderStage objects.
398 """
David James4f2d8302013-03-19 06:35:58 -0700399 steps = [stage.Run for stage in stage_objs]
400 try:
401 parallel.RunParallelSteps(steps)
402 except BaseException as ex:
403 # If a stage threw an exception, it might not have correctly reported
404 # results (e.g. because it was killed before it could report the
405 # results.) In this case, attribute the exception to any stages that
406 # didn't report back correctly (if any).
407 for stage in stage_objs:
David James6b704242013-10-18 14:51:37 -0700408 for name in stage.GetStageNames():
409 if not results_lib.Results.StageHasResults(name):
410 results_lib.Results.Record(name, ex, str(ex))
Matt Tennant759e2352013-09-27 15:14:44 -0700411
David James4f2d8302013-03-19 06:35:58 -0700412 raise
413
Matt Tennantefb59522013-10-18 13:49:28 -0700414 def _RunBackgroundStagesForBoard(self, builder_run, board, compilecheck):
Matt Tennant759e2352013-09-27 15:14:44 -0700415 """Run background board-specific stages for the specified board.
416
417 Args:
Matt Tennantefb59522013-10-18 13:49:28 -0700418 builder_run: BuilderRun object for these background stages.
Matt Tennant759e2352013-09-27 15:14:44 -0700419 board: Board name.
420 compilecheck: Boolean. If True, run only the compile steps.
421 """
Matt Tennantefb59522013-10-18 13:49:28 -0700422 config = builder_run.config
Matt Tennant066d9322014-01-28 10:37:48 -0800423
424 # TODO(mtennant): This is the last usage of self.archive_stages. We can
425 # kill it once we migrate its uses to BuilderRun so that none of the
426 # stages below need it as an argument.
Matt Tennantefb59522013-10-18 13:49:28 -0700427 archive_stage = self.archive_stages[BoardConfig(board, config.name)]
428 if config.pgo_generate:
Ahmad Sharifa2db40a2013-07-22 13:51:52 -0400429 self._RunParallelStages([archive_stage])
David James1fddb8f2013-04-25 15:23:07 -0700430 return
Matt Tennant759e2352013-09-27 15:14:44 -0700431
David James565bc9a2013-04-08 14:54:45 -0700432 if compilecheck:
433 self._RunStage(stages.BuildPackagesStage, board, archive_stage,
Matt Tennantefb59522013-10-18 13:49:28 -0700434 builder_run=builder_run)
435 self._RunStage(stages.UnitTestStage, board,
436 builder_run=builder_run)
David James565bc9a2013-04-08 14:54:45 -0700437 return
Matt Tennant759e2352013-09-27 15:14:44 -0700438
Don Garrett82c0ae82014-02-03 18:25:11 -0800439 # signer_results can't complete without push_image.
440 assert not config['signer_results'] or config['push_image']
441
442 # paygen can't complete without signer_results.
443 assert not config['paygen'] or config['signer_results']
444
Mike Frysinger31ac04f2013-11-10 21:07:48 -0500445 # While this stage list is run in parallel, the order here dictates the
446 # order that things will be shown in the log. So group things together
447 # that make sense when read in order. Also keep in mind that, since we
448 # gather output manually, early slow stages will prevent any output from
449 # later stages showing up until it finishes.
Ryan Cui3ea98e02013-08-07 16:01:48 -0700450 stage_list = []
Matt Tennantefb59522013-10-18 13:49:28 -0700451 if builder_run.options.chrome_sdk and config.chrome_sdk:
Ryan Cui3ea98e02013-08-07 16:01:48 -0700452 stage_list.append([stages.ChromeSDKStage, board, archive_stage])
David James6b704242013-10-18 14:51:37 -0700453 stage_list += [
454 [stages.RetryStage, 1, stages.VMTestStage, board, archive_stage],
455 [stages.SignerTestStage, board, archive_stage],
Don Garrett7604d6a2014-01-15 14:45:39 -0800456 [stages.SignerResultsStage, board, archive_stage],
Don Garrett82c0ae82014-02-03 18:25:11 -0800457 [stages.PaygenStage, board, archive_stage],
David James6b704242013-10-18 14:51:37 -0700458 [stages.UnitTestStage, board],
459 [stages.UploadPrebuiltsStage, board, archive_stage],
Mike Frysinger31ac04f2013-11-10 21:07:48 -0500460 [stages.DevInstallerPrebuiltsStage, board, archive_stage],
461 [stages.DebugSymbolsStage, board, archive_stage],
David James6b704242013-10-18 14:51:37 -0700462 ]
Brian Harring3fec5a82012-03-01 05:57:03 -0800463
David James58e0c092012-03-04 20:31:12 -0800464 # We can not run hw tests without archiving the payloads.
Matt Tennantefb59522013-10-18 13:49:28 -0700465 if builder_run.options.archive:
466 for suite_config in config.hw_tests:
Chris Sosaba250522013-03-27 18:57:34 -0700467 if suite_config.async:
468 stage_list.append([stages.ASyncHWTestStage, board, archive_stage,
469 suite_config])
470 elif suite_config.suite == constants.HWTEST_AU_SUITE:
471 stage_list.append([stages.AUTestStage, board, archive_stage,
472 suite_config])
Aviv Keshet23efd042013-10-01 13:59:08 -0700473 elif suite_config.suite == constants.HWTEST_QAV_SUITE:
474 stage_list.append([stages.QATestStage, board,
475 archive_stage, suite_config])
Chris Sosa077df812013-01-25 17:05:28 -0800476 else:
Chris Sosaba250522013-03-27 18:57:34 -0700477 stage_list.append([stages.HWTestStage, board, archive_stage,
478 suite_config])
Chris Sosa817b1f92012-07-19 15:00:23 -0700479
Matt Tennantefb59522013-10-18 13:49:28 -0700480 stage_objs = [self._GetStageInstance(*x, builder_run=builder_run)
481 for x in stage_list]
David James4f2d8302013-03-19 06:35:58 -0700482 self._RunParallelStages(stage_objs + [archive_stage])
Brian Harring3fec5a82012-03-01 05:57:03 -0800483
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400484 def _RunChrootBuilderTypeBuild(self):
485 """Runs through stages of a CHROOT_BUILDER_TYPE build."""
486 self._RunStage(stages.UprevStage, boards=[], enter_chroot=False)
487 self._RunStage(stages.InitSDKStage)
488 self._RunStage(stages.SetupBoardStage, [constants.CHROOT_BUILDER_BOARD])
489 self._RunStage(stages.SyncChromeStage)
490 self._RunStage(stages.PatchChromeStage)
491 self._RunStage(stages.SDKPackageStage)
492 self._RunStage(stages.SDKTestStage)
493 self._RunStage(stages.UploadPrebuiltsStage,
494 constants.CHROOT_BUILDER_BOARD, None)
495
496 def _RunRefreshPackagesTypeBuild(self):
497 """Runs through the stages of a REFRESH_PACKAGES_TYPE build."""
498 self._RunStage(stages.InitSDKStage)
499 self._RunStage(stages.SetupBoardStage)
500 self._RunStage(stages.RefreshPackageStatusStage)
501
Matt Tennante8179042013-10-01 15:47:32 -0700502 def _RunMasterPaladinBuild(self):
503 """Runs through the stages of the paladin (commit queue) master build."""
504 self._RunStage(stages.InitSDKStage)
505 self._RunStage(stages.UprevStage)
506 self._RunStage(stages.MasterUploadPrebuiltsStage)
507
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400508 def _RunDefaultTypeBuild(self):
509 """Runs through the stages of a non-special-type build."""
510 self._RunStage(stages.InitSDKStage)
511 self._RunStage(stages.UprevStage)
512 self._RunStage(stages.SetupBoardStage)
Matt Tennant85348852014-01-10 15:16:02 -0800513 self._RunStage(stages.SyncChromeStage)
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400514 self._RunStage(stages.PatchChromeStage)
515
Matt Tennantefb59522013-10-18 13:49:28 -0700516 # Prepare stages to run in background. If child_configs exist then
517 # run each of those here, otherwise use default config.
Matt Tennant950c6cb2014-01-10 16:45:03 -0800518 builder_runs = self._run.GetUngroupedBuilderRuns()
Matt Tennantefb59522013-10-18 13:49:28 -0700519
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400520 tasks = []
Matt Tennantefb59522013-10-18 13:49:28 -0700521 for builder_run in builder_runs:
Matt Tennanta42a5742014-02-09 13:42:12 -0800522 # Prepare a local archive directory for each "run".
523 builder_run.GetArchive().SetupArchivePath()
524
Matt Tennantefb59522013-10-18 13:49:28 -0700525 for board in builder_run.config.boards:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400526 archive_stage = self._GetStageInstance(
Matt Tennantefb59522013-10-18 13:49:28 -0700527 stages.ArchiveStage, board, builder_run=builder_run,
Matt Tennant85348852014-01-10 15:16:02 -0800528 chrome_version=self._run.attrs.chrome_version)
Matt Tennantefb59522013-10-18 13:49:28 -0700529 board_config = BoardConfig(board, builder_run.config.name)
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400530 self.archive_stages[board_config] = archive_stage
Matt Tennantefb59522013-10-18 13:49:28 -0700531 tasks.append((builder_run, board, archive_stage))
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400532
David James45cd7c82014-02-05 14:53:43 -0800533 # Run BuildPackages and BuildImage in sequence.
534 for builder_run, board, archive_stage in tasks:
535 compilecheck = (builder_run.config.compilecheck or
536 builder_run.options.compilecheck)
537 if not compilecheck:
538 # Run BuildPackages and BuildImage in the foreground, generating
539 # or using PGO data if requested.
540 kwargs = {'archive_stage': archive_stage, 'builder_run': builder_run}
541 if builder_run.config.pgo_generate:
542 kwargs['pgo_generate'] = True
543 elif builder_run.config.pgo_use:
544 kwargs['pgo_use'] = True
545
546 self._RunStage(stages.BuildPackagesStage, board, **kwargs)
547 self._RunStage(stages.BuildImageStage, board, **kwargs)
548
549 if builder_run.config.pgo_generate:
550 suite = cbuildbot_config.PGORecordTest()
551 self._RunStage(stages.HWTestStage, board, archive_stage, suite,
552 builder_run=builder_run)
553
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400554 # Set up a process pool to run test/archive stages in the background.
David James45cd7c82014-02-05 14:53:43 -0800555 # This process runs the task_runner for each board added to the queue.
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400556 task_runner = self._RunBackgroundStagesForBoard
557 with parallel.BackgroundTaskRunner(task_runner) as queue:
Matt Tennantefb59522013-10-18 13:49:28 -0700558 for builder_run, board, archive_stage in tasks:
559 compilecheck = (builder_run.config.compilecheck or
560 builder_run.options.compilecheck)
Matt Tennantefb59522013-10-18 13:49:28 -0700561 queue.put([builder_run, board, compilecheck])
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400562
Brian Harring3fec5a82012-03-01 05:57:03 -0800563 def RunStages(self):
564 """Runs through build process."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800565 # TODO(sosa): Split these out into classes.
Matt Tennantefb59522013-10-18 13:49:28 -0700566 if self._run.config.build_type == constants.PRE_CQ_LAUNCHER_TYPE:
David James816a5942013-04-11 22:59:32 -0700567 self._RunStage(stages.PreCQLauncherStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700568 elif self._run.config.build_type == constants.CREATE_BRANCH_TYPE:
Ryan Cui88b901c2013-06-21 11:35:30 -0700569 self._RunStage(stages.BranchUtilStage)
Matt Tennantefb59522013-10-18 13:49:28 -0700570 elif self._run.config.build_type == constants.CHROOT_BUILDER_TYPE:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400571 self._RunChrootBuilderTypeBuild()
Matt Tennantefb59522013-10-18 13:49:28 -0700572 elif self._run.config.build_type == constants.REFRESH_PACKAGES_TYPE:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400573 self._RunRefreshPackagesTypeBuild()
Matt Tennante8179042013-10-01 15:47:32 -0700574 elif (self._run.config.build_type == constants.PALADIN_TYPE and
575 self._run.config.master):
576 self._RunMasterPaladinBuild()
Brian Harring3fec5a82012-03-01 05:57:03 -0800577 else:
Aviv Keshet7dc300f2013-10-11 12:57:49 -0400578 self._RunDefaultTypeBuild()
David James58e0c092012-03-04 20:31:12 -0800579
Brian Harring3fec5a82012-03-01 05:57:03 -0800580
581class DistributedBuilder(SimpleBuilder):
582 """Build class that has special logic to handle distributed builds.
583
584 These builds sync using git/manifest logic in manifest_versions. In general
585 they use a non-distributed builder code for the bulk of the work.
586 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700587 def __init__(self, *args, **kwargs):
Brian Harring3fec5a82012-03-01 05:57:03 -0800588 """Initializes a buildbot builder.
589
590 Extra variables:
591 completion_stage_class: Stage used to complete a build. Set in the Sync
592 stage.
593 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700594 super(DistributedBuilder, self).__init__(*args, **kwargs)
Brian Harring3fec5a82012-03-01 05:57:03 -0800595 self.completion_stage_class = None
David Jamesf421c6d2013-04-11 15:37:57 -0700596 self.sync_stage = None
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400597 self._completion_stage = None
Brian Harring3fec5a82012-03-01 05:57:03 -0800598
599 def GetSyncInstance(self):
600 """Syncs the tree using one of the distributed sync logic paths.
601
Mike Frysinger02e1e072013-11-10 22:11:34 -0500602 Returns:
603 The instance of the sync stage to run.
Brian Harring3fec5a82012-03-01 05:57:03 -0800604 """
605 # Determine sync class to use. CQ overrides PFQ bits so should check it
606 # first.
Matt Tennantefb59522013-10-18 13:49:28 -0700607 if self._run.config.pre_cq or self._run.options.pre_cq:
David Jamesf421c6d2013-04-11 15:37:57 -0700608 sync_stage = self._GetStageInstance(stages.PreCQSyncStage,
609 self.patch_pool.gerrit_patches)
610 self.completion_stage_class = stages.PreCQCompletionStage
611 self.patch_pool.gerrit_patches = []
Matt Tennantefb59522013-10-18 13:49:28 -0700612 elif cbuildbot_config.IsCQType(self._run.config.build_type):
613 if self._run.config.do_not_apply_cq_patches:
Aviv Keshet00bc9512013-11-25 14:58:47 -0800614 sync_stage = self._GetStageInstance(stages.MasterSlaveSyncStage)
615 else:
616 sync_stage = self._GetStageInstance(stages.CommitQueueSyncStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800617 self.completion_stage_class = stages.CommitQueueCompletionStage
Matt Tennantefb59522013-10-18 13:49:28 -0700618 elif cbuildbot_config.IsPFQType(self._run.config.build_type):
Aviv Keshetf2746152013-11-26 10:42:46 -0800619 sync_stage = self._GetStageInstance(stages.MasterSlaveSyncStage)
620 self.completion_stage_class = stages.MasterSlaveSyncCompletionStage
Brian Harring3fec5a82012-03-01 05:57:03 -0800621 else:
622 sync_stage = self._GetStageInstance(stages.ManifestVersionedSyncStage)
623 self.completion_stage_class = stages.ManifestVersionedSyncCompletionStage
624
David Jamesf421c6d2013-04-11 15:37:57 -0700625 self.sync_stage = sync_stage
626 return self.sync_stage
Brian Harring3fec5a82012-03-01 05:57:03 -0800627
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400628 def GetCompletionInstance(self):
629 """Returns the completion_stage_class instance that was used for this build.
630
Mike Frysinger1a736a82013-12-12 01:50:59 -0500631 Returns:
632 None if the completion_stage instance was not yet created (this
633 occurs during Publish).
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400634 """
635 return self._completion_stage
636
Brian Harring3fec5a82012-03-01 05:57:03 -0800637 def Publish(self, was_build_successful):
638 """Completes build by publishing any required information."""
639 completion_stage = self._GetStageInstance(self.completion_stage_class,
David Jamesf421c6d2013-04-11 15:37:57 -0700640 self.sync_stage,
Brian Harring3fec5a82012-03-01 05:57:03 -0800641 was_build_successful)
Aviv Keshet5c39b6a2013-10-07 15:44:54 -0400642 self._completion_stage = completion_stage
David James11fd7e82013-10-23 20:02:16 -0700643 completion_successful = False
644 try:
645 completion_stage.Run()
646 completion_successful = True
647 finally:
648 if not completion_successful:
649 was_build_successful = False
Matt Tennantefb59522013-10-18 13:49:28 -0700650 if self._run.config.push_overlays:
David James11fd7e82013-10-23 20:02:16 -0700651 self._RunStage(stages.PublishUprevChangesStage, was_build_successful)
Brian Harring3fec5a82012-03-01 05:57:03 -0800652
653 def RunStages(self):
654 """Runs simple builder logic and publishes information to overlays."""
655 was_build_successful = False
David James843ed252013-09-11 16:18:10 -0700656 try:
657 super(DistributedBuilder, self).RunStages()
658 was_build_successful = results_lib.Results.BuildSucceededSoFar()
659 except SystemExit as ex:
660 # If a stage calls sys.exit(0), it's exiting with success, so that means
661 # we should mark ourselves as successful.
662 if ex.code == 0:
663 was_build_successful = True
664 raise
665 finally:
666 self.Publish(was_build_successful)
Brian Harring3fec5a82012-03-01 05:57:03 -0800667
Brian Harring3fec5a82012-03-01 05:57:03 -0800668
669def _ConfirmBuildRoot(buildroot):
670 """Confirm with user the inferred buildroot, and mark it as confirmed."""
Brian Harring521e7242012-11-01 16:57:42 -0700671 cros_build_lib.Warning('Using default directory %s as buildroot', buildroot)
672 if not cros_build_lib.BooleanPrompt(default=False):
673 print('Please specify a different buildroot via the --buildroot option.')
Brian Harring3fec5a82012-03-01 05:57:03 -0800674 sys.exit(0)
675
676 if not os.path.exists(buildroot):
677 os.mkdir(buildroot)
678
679 repository.CreateTrybotMarker(buildroot)
680
681
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700682def _ConfirmRemoteBuildbotRun():
683 """Confirm user wants to run with --buildbot --remote."""
Brian Harring521e7242012-11-01 16:57:42 -0700684 cros_build_lib.Warning(
685 'You are about to launch a PRODUCTION job! This is *NOT* a '
686 'trybot run! Are you sure?')
687 if not cros_build_lib.BooleanPrompt(default=False):
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700688 print('Please specify --pass-through="--debug".')
689 sys.exit(0)
690
691
Ryan Cui5ba7e152012-05-10 14:36:52 -0700692def _DetermineDefaultBuildRoot(sourceroot, internal_build):
Brian Harring3fec5a82012-03-01 05:57:03 -0800693 """Default buildroot to be under the directory that contains current checkout.
694
Mike Frysinger02e1e072013-11-10 22:11:34 -0500695 Args:
Brian Harring3fec5a82012-03-01 05:57:03 -0800696 internal_build: Whether the build is an internal build
Ryan Cui5ba7e152012-05-10 14:36:52 -0700697 sourceroot: Use specified sourceroot.
Brian Harring3fec5a82012-03-01 05:57:03 -0800698 """
Ryan Cui5ba7e152012-05-10 14:36:52 -0700699 if not repository.IsARepoRoot(sourceroot):
Brian Harring1b8c4c82012-05-29 23:03:04 -0700700 cros_build_lib.Die(
701 'Could not find root of local checkout at %s. Please specify '
702 'using the --sourceroot option.' % sourceroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800703
704 # Place trybot buildroot under the directory containing current checkout.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700705 top_level = os.path.dirname(os.path.realpath(sourceroot))
Brian Harring3fec5a82012-03-01 05:57:03 -0800706 if internal_build:
707 buildroot = os.path.join(top_level, _DEFAULT_INT_BUILDROOT)
708 else:
709 buildroot = os.path.join(top_level, _DEFAULT_EXT_BUILDROOT)
710
711 return buildroot
712
713
Mike Frysinger6903c762012-12-04 01:57:16 -0500714def _DisableYamaHardLinkChecks():
715 """Disable Yama kernel hardlink security checks.
716
717 The security module disables hardlinking to files you do not have
718 write access to which causes some of our build scripts problems.
719 Disable it so we don't have to worry about it.
720 """
721 PROC_PATH = '/proc/sys/kernel/yama/protected_nonaccess_hardlinks'
722 SYSCTL_PATH = PROC_PATH[len('/proc/sys/'):].replace('/', '.')
723
724 # Yama not available in this system -- nothing to do.
725 if not os.path.exists(PROC_PATH):
726 return
727
728 # Already disabled -- nothing to do.
729 if osutils.ReadFile(PROC_PATH).strip() == '0':
730 return
731
732 # Create a hardlink in a tempdir and see if we get back EPERM.
David James4bc13702013-03-26 08:08:04 -0700733 with osutils.TempDir() as tempdir:
Mike Frysinger6903c762012-12-04 01:57:16 -0500734 try:
735 os.link('/bin/sh', os.path.join(tempdir, 'sh'))
736 except OSError as e:
737 if e.errno == errno.EPERM:
738 cros_build_lib.Warning('Disabling Yama hardlink security')
739 cros_build_lib.SudoRunCommand(['sysctl', '%s=0' % SYSCTL_PATH])
740
741
Brian Harring3fec5a82012-03-01 05:57:03 -0800742def _BackupPreviousLog(log_file, backup_limit=25):
743 """Rename previous log.
744
745 Args:
746 log_file: The absolute path to the previous log.
Aviv Keshet9e4236b2013-12-13 13:07:50 -0800747 backup_limit: Maximum number of old logs to keep.
Brian Harring3fec5a82012-03-01 05:57:03 -0800748 """
749 if os.path.exists(log_file):
750 old_logs = sorted(glob.glob(log_file + '.*'),
751 key=distutils.version.LooseVersion)
752
753 if len(old_logs) >= backup_limit:
754 os.remove(old_logs[0])
755
756 last = 0
757 if old_logs:
758 last = int(old_logs.pop().rpartition('.')[2])
759
760 os.rename(log_file, log_file + '.' + str(last + 1))
761
Ryan Cui5616a512012-08-17 13:39:36 -0700762
Gaurav Shah298aa372014-01-31 09:27:24 -0800763def _IsDistributedBuilder(options, chrome_rev, build_config):
764 """Determines whether the builder should be a DistributedBuilder.
765
766 Args:
767 options: options passed on the commandline.
768 chrome_rev: Chrome revision to build.
769 build_config: Builder configuration dictionary.
770
771 Returns:
772 True if the builder should be a distributed_builder
773 """
774 if build_config['pre_cq'] or options.pre_cq:
775 return True
776 elif not options.buildbot:
777 return False
778 elif chrome_rev in (constants.CHROME_REV_TOT,
779 constants.CHROME_REV_LOCAL,
780 constants.CHROME_REV_SPEC):
781 # We don't do distributed logic to TOT Chrome PFQ's, nor local
782 # chrome roots (e.g. chrome try bots)
783 # TODO(davidjames): Update any builders that rely on this logic to use
784 # manifest_version=False instead.
785 return False
786 elif build_config['manifest_version']:
787 return True
788
789 return False
790
791
David James944a48e2012-03-07 12:19:03 -0800792def _RunBuildStagesWrapper(options, build_config):
Brian Harring3fec5a82012-03-01 05:57:03 -0800793 """Helper function that wraps RunBuildStages()."""
Matt Tennant7feda352013-12-20 14:03:40 -0800794 cros_build_lib.Info('cbuildbot was executed with args %s' %
795 cros_build_lib.CmdToStr(sys.argv))
Brian Harring3fec5a82012-03-01 05:57:03 -0800796
David Jamesa0a664e2013-02-13 09:52:01 -0800797 chrome_rev = build_config['chrome_rev']
798 if options.chrome_rev:
799 chrome_rev = options.chrome_rev
800 if chrome_rev == constants.CHROME_REV_TOT:
801 # Build the TOT Chrome revision.
802 svn_url = gclient.GetBaseURLs()[0]
803 options.chrome_version = gclient.GetTipOfTrunkSvnRevision(svn_url)
804 options.chrome_rev = constants.CHROME_REV_SPEC
805
David James4a404a52013-02-19 13:07:59 -0800806 # If it's likely we'll need to build Chrome, fetch the source.
Mike Frysingerf4d9ab82013-03-05 19:38:05 -0500807 if build_config['sync_chrome'] is None:
808 options.managed_chrome = (chrome_rev != constants.CHROME_REV_LOCAL and
809 (not build_config['usepkg_build_packages'] or chrome_rev or
David James3cce4642013-05-10 17:50:23 -0700810 build_config['profile'] or options.rietveld_patches))
Mike Frysingerf4d9ab82013-03-05 19:38:05 -0500811 else:
812 options.managed_chrome = build_config['sync_chrome']
David James2333c182013-02-13 16:16:15 -0800813
814 if options.managed_chrome:
815 # Tell Chrome to fetch the source locally.
Matt Tennant628ffdd2013-11-27 14:44:39 -0800816 internal = constants.USE_CHROME_INTERNAL in build_config['useflags']
David James2333c182013-02-13 16:16:15 -0800817 chrome_src = 'chrome-src-internal' if internal else 'chrome-src'
818 options.chrome_root = os.path.join(options.cache_dir, 'distfiles', 'target',
819 chrome_src)
David James9e27e662013-02-14 13:42:43 -0800820 elif options.rietveld_patches:
David James4a404a52013-02-19 13:07:59 -0800821 cros_build_lib.Die('This builder does not support Rietveld patches.')
David James2333c182013-02-13 16:16:15 -0800822
Matt Tennant95a42ad2013-12-27 15:38:36 -0800823 # We are done munging options values, so freeze options object now to avoid
824 # further abuse of it.
825 # TODO(mtennant): one by one identify each options value override and see if
826 # it can be handled another way. Try to push this freeze closer and closer
827 # to the start of the script (e.g. in or after _PostParseCheck).
828 options.Freeze()
829
Matt Tennantefb59522013-10-18 13:49:28 -0700830 builder_run = cbuildbot_run.BuilderRun(options, build_config)
Gaurav Shah298aa372014-01-31 09:27:24 -0800831 if _IsDistributedBuilder(options, chrome_rev, build_config):
832 builder_cls = DistributedBuilder
833 else:
834 builder_cls = SimpleBuilder
Matt Tennantefb59522013-10-18 13:49:28 -0700835 builder = builder_cls(builder_run)
836 if not builder.Run():
Brian Harringd166aaf2012-05-14 18:31:53 -0700837 sys.exit(1)
Brian Harring3fec5a82012-03-01 05:57:03 -0800838
839
840# Parser related functions
Ryan Cui5ba7e152012-05-10 14:36:52 -0700841def _CheckLocalPatches(sourceroot, local_patches):
Brian Harring3fec5a82012-03-01 05:57:03 -0800842 """Do an early quick check of the passed-in patches.
843
844 If the branch of a project is not specified we append the current branch the
845 project is on.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700846
David Jamese3b06062013-11-09 18:52:02 -0800847 TODO(davidjames): The project:branch format isn't unique, so this means that
848 we can't differentiate what directory the user intended to apply patches to.
849 We should references by directory instead.
850
Ryan Cui5ba7e152012-05-10 14:36:52 -0700851 Args:
852 sourceroot: The checkout where patches are coming from.
Aviv Keshet9e4236b2013-12-13 13:07:50 -0800853 local_patches: List of patches to check in project:branch format.
David Jamese3b06062013-11-09 18:52:02 -0800854
855 Returns:
856 A list of patches that have been verified, in project:branch format.
Brian Harring3fec5a82012-03-01 05:57:03 -0800857 """
Ryan Cuicedd8a52012-03-22 02:28:35 -0700858 verified_patches = []
David James97d95872012-11-16 15:09:56 -0800859 manifest = git.ManifestCheckout.Cached(sourceroot)
Ryan Cuicedd8a52012-03-22 02:28:35 -0700860 for patch in local_patches:
David Jamese3b06062013-11-09 18:52:02 -0800861 project, _, branch = patch.partition(':')
862
Gaurav Shah7afb0562013-12-26 15:05:39 -0800863 checkouts = manifest.FindCheckouts(project, only_patchable=True)
David Jamese3b06062013-11-09 18:52:02 -0800864 if not checkouts:
865 cros_build_lib.Die('Project %s does not exist.' % (project,))
866 if len(checkouts) > 1:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700867 cros_build_lib.Die(
David Jamese3b06062013-11-09 18:52:02 -0800868 'We do not yet support local patching for projects that are checked '
869 'out to multiple directories. Try uploading your patch to gerrit '
870 'and referencing it via the -g option instead.'
871 )
Brian Harring3fec5a82012-03-01 05:57:03 -0800872
David Jamese3b06062013-11-09 18:52:02 -0800873 ok = False
874 for checkout in checkouts:
875 project_dir = checkout.GetPath(absolute=True)
Brian Harring3fec5a82012-03-01 05:57:03 -0800876
David Jamese3b06062013-11-09 18:52:02 -0800877 # If no branch was specified, we use the project's current branch.
Brian Harring3fec5a82012-03-01 05:57:03 -0800878 if not branch:
David Jamese3b06062013-11-09 18:52:02 -0800879 local_branch = git.GetCurrentBranch(project_dir)
880 else:
881 local_branch = branch
Brian Harring3fec5a82012-03-01 05:57:03 -0800882
David Jamese3b06062013-11-09 18:52:02 -0800883 if local_branch and git.DoesLocalBranchExist(project_dir, local_branch):
884 verified_patches.append('%s:%s' % (project, local_branch))
885 ok = True
886
887 if not ok:
888 if branch:
889 cros_build_lib.Die('Project %s does not have branch %s'
890 % (project, branch))
891 else:
892 cros_build_lib.Die('Project %s is not on a branch!' % (project,))
Brian Harring3fec5a82012-03-01 05:57:03 -0800893
Ryan Cuicedd8a52012-03-22 02:28:35 -0700894 return verified_patches
Brian Harring3fec5a82012-03-01 05:57:03 -0800895
896
Brian Harring3fec5a82012-03-01 05:57:03 -0800897def _CheckChromeVersionOption(_option, _opt_str, value, parser):
898 """Upgrade other options based on chrome_version being passed."""
899 value = value.strip()
900
901 if parser.values.chrome_rev is None and value:
902 parser.values.chrome_rev = constants.CHROME_REV_SPEC
903
904 parser.values.chrome_version = value
905
906
907def _CheckChromeRootOption(_option, _opt_str, value, parser):
908 """Validate and convert chrome_root to full-path form."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800909 if parser.values.chrome_rev is None:
910 parser.values.chrome_rev = constants.CHROME_REV_LOCAL
911
Ryan Cui5ba7e152012-05-10 14:36:52 -0700912 parser.values.chrome_root = value
Brian Harring3fec5a82012-03-01 05:57:03 -0800913
914
915def _CheckChromeRevOption(_option, _opt_str, value, parser):
916 """Validate the chrome_rev option."""
917 value = value.strip()
918 if value not in constants.VALID_CHROME_REVISIONS:
919 raise optparse.OptionValueError('Invalid chrome rev specified')
920
921 parser.values.chrome_rev = value
922
923
David Jamesac8c2a72013-02-13 18:44:33 -0800924def FindCacheDir(_parser, _options):
Brian Harringae0a5322012-09-15 01:46:51 -0700925 return None
926
927
Ryan Cui5ba7e152012-05-10 14:36:52 -0700928class CustomGroup(optparse.OptionGroup):
Aviv Keshet9e4236b2013-12-13 13:07:50 -0800929 """Custom option group which supports arguments passed-through to trybot."""
Ryan Cui5ba7e152012-05-10 14:36:52 -0700930 def add_remote_option(self, *args, **kwargs):
931 """For arguments that are passed-through to remote trybot."""
932 return optparse.OptionGroup.add_option(self, *args,
933 remote_pass_through=True,
934 **kwargs)
935
936
Ryan Cui1c13a252012-10-16 15:00:16 -0700937class CustomOption(commandline.FilteringOption):
938 """Subclass FilteringOption class to implement pass-through and api."""
Ryan Cui5ba7e152012-05-10 14:36:52 -0700939
Ryan Cui1c13a252012-10-16 15:00:16 -0700940 ACTIONS = commandline.FilteringOption.ACTIONS + ('extend',)
941 STORE_ACTIONS = commandline.FilteringOption.STORE_ACTIONS + ('extend',)
942 TYPED_ACTIONS = commandline.FilteringOption.TYPED_ACTIONS + ('extend',)
943 ALWAYS_TYPED_ACTIONS = (commandline.FilteringOption.ALWAYS_TYPED_ACTIONS +
944 ('extend',))
Ryan Cui79319ab2012-05-21 12:59:18 -0700945
Ryan Cui5ba7e152012-05-10 14:36:52 -0700946 def __init__(self, *args, **kwargs):
947 # The remote_pass_through argument specifies whether we should directly
948 # pass the argument (with its value) onto the remote trybot.
949 self.pass_through = kwargs.pop('remote_pass_through', False)
Ryan Cui1c13a252012-10-16 15:00:16 -0700950 self.api_version = int(kwargs.pop('api', '0'))
951 commandline.FilteringOption.__init__(self, *args, **kwargs)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700952
953 def take_action(self, action, dest, opt, value, values, parser):
Ryan Cui79319ab2012-05-21 12:59:18 -0700954 if action == 'extend':
Mike Frysingerd6925b52012-07-16 16:11:00 -0400955 # If there is extra spaces between each argument, we get '' which later
956 # code barfs on, so skip those. e.g. We see this with the forms:
957 # cbuildbot -p 'proj:branch ' ...
958 # cbuildbot -p ' proj:branch' ...
959 # cbuildbot -p 'proj:branch proj2:branch' ...
960 lvalue = value.split()
Ryan Cui79319ab2012-05-21 12:59:18 -0700961 values.ensure_value(dest, []).extend(lvalue)
Ryan Cui79319ab2012-05-21 12:59:18 -0700962
Ryan Cui1c13a252012-10-16 15:00:16 -0700963 commandline.FilteringOption.take_action(
964 self, action, dest, opt, value, values, parser)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700965
966
Ryan Cui1c13a252012-10-16 15:00:16 -0700967class CustomParser(commandline.FilteringParser):
Aviv Keshet9e4236b2013-12-13 13:07:50 -0800968 """Custom option parser which supports arguments passed-trhough to trybot"""
Matt Tennante8179042013-10-01 15:47:32 -0700969
Brian Harringb6cf9142012-09-01 20:43:17 -0700970 DEFAULT_OPTION_CLASS = CustomOption
971
972 def add_remote_option(self, *args, **kwargs):
973 """For arguments that are passed-through to remote trybot."""
Ryan Cui1c13a252012-10-16 15:00:16 -0700974 return self.add_option(*args, remote_pass_through=True, **kwargs)
Brian Harringb6cf9142012-09-01 20:43:17 -0700975
976
Brian Harring3fec5a82012-03-01 05:57:03 -0800977def _CreateParser():
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700978 """Generate and return the parser with all the options."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800979 # Parse options
Matt Tennant763497d2014-01-17 16:45:54 -0800980 usage = "usage: %prog [options] buildbot_config [buildbot_config ...]"
Brian Harringae0a5322012-09-15 01:46:51 -0700981 parser = CustomParser(usage=usage, caching=FindCacheDir)
Brian Harring3fec5a82012-03-01 05:57:03 -0800982
983 # Main options
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400984 parser.add_option('-l', '--list', action='store_true', dest='list',
985 default=False,
986 help='List the suggested trybot configs to use (see --all)')
Brian Harring3fec5a82012-03-01 05:57:03 -0800987 parser.add_option('-a', '--all', action='store_true', dest='print_all',
988 default=False,
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400989 help='List all of the buildbot configs available w/--list')
990
991 parser.add_option('--local', default=False, action='store_true',
Ryan Cui88b901c2013-06-21 11:35:30 -0700992 help='Specifies that this tryjob should be run locally. '
993 'Implies --debug.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400994 parser.add_option('--remote', default=False, action='store_true',
Ryan Cui88b901c2013-06-21 11:35:30 -0700995 help='Specifies that this tryjob should be run remotely.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -0400996
Ryan Cuie1e4e662012-05-21 16:39:46 -0700997 parser.add_remote_option('-b', '--branch',
998 help='The manifest branch to test. The branch to '
999 'check the buildroot out to.')
Ryan Cui5ba7e152012-05-10 14:36:52 -07001000 parser.add_option('-r', '--buildroot', dest='buildroot', type='path',
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001001 help='Root directory where source is checked out to, and '
1002 'where the build occurs. For external build configs, '
1003 "defaults to 'trybot' directory at top level of your "
1004 'repo-managed checkout.')
1005 parser.add_remote_option('--chrome_rev', default=None, type='string',
1006 action='callback', dest='chrome_rev',
1007 callback=_CheckChromeRevOption,
1008 help=('Revision of Chrome to use, of type [%s]'
1009 % '|'.join(constants.VALID_CHROME_REVISIONS)))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001010 parser.add_remote_option('--profile', default=None, type='string',
1011 action='store', dest='profile',
1012 help='Name of profile to sub-specify board variant.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001013
Ryan Cuif4f84be2012-07-09 18:50:41 -07001014 #
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001015 # Patch selection options.
1016 #
1017
1018 group = CustomGroup(
1019 parser,
1020 'Patch Options')
1021
1022 group.add_remote_option('-g', '--gerrit-patches', action='extend',
1023 default=[], type='string',
1024 metavar="'Id1 *int_Id2...IdN'",
1025 help="Space-separated list of short-form Gerrit "
1026 "Change-Id's or change numbers to patch. "
1027 "Please prepend '*' to internal Change-Id's")
1028 group.add_remote_option('-G', '--rietveld-patches', action='extend',
1029 default=[], type='string',
1030 metavar="'id1[:subdir1]...idN[:subdirN]'",
1031 help='Space-separated list of short-form Rietveld '
1032 'issue numbers to patch. If no subdir is '
1033 'specified, the src directory is used.')
1034 group.add_option('-p', '--local-patches', action='extend', default=[],
1035 metavar="'<project1>[:<branch1>]...<projectN>[:<branchN>]'",
1036 help='Space-separated list of project branches with '
1037 'patches to apply. Projects are specified by name. '
1038 'If no branch is specified the current branch of the '
1039 'project will be used.')
1040
1041 parser.add_option_group(group)
1042
1043 #
1044 # Remote trybot options.
1045 #
1046
1047 group = CustomGroup(
1048 parser,
1049 'Remote Trybot Options (--remote)')
1050
1051 group.add_remote_option('--hwtest', dest='hwtest', action='store_true',
1052 default=False,
1053 help='Run the HWTest stage (tests on real hardware)')
1054 group.add_option('--remote-description', default=None,
1055 help='Attach an optional description to a --remote run '
1056 'to make it easier to identify the results when it '
1057 'finishes')
1058 group.add_option('--slaves', action='extend', default=[],
1059 help='Specify specific remote tryslaves to run on (e.g. '
1060 'build149-m2); if the bot is busy, it will be queued')
1061 group.add_option('--test-tryjob', action='store_true',
1062 default=False,
1063 help='Submit a tryjob to the test repository. Will not '
1064 'show up on the production trybot waterfall.')
1065
1066 parser.add_option_group(group)
1067
1068 #
Ryan Cui88b901c2013-06-21 11:35:30 -07001069 # Branch creation options.
1070 #
1071
1072 group = CustomGroup(
1073 parser,
1074 'Branch Creation Options (used with branch-util)')
1075
1076 group.add_remote_option('--branch-name',
1077 help='The branch to create or delete.')
1078 group.add_remote_option('--delete-branch', default=False, action='store_true',
1079 help='Delete the branch specified in --branch-name.')
1080 group.add_remote_option('--rename-to', type='string',
1081 help='Rename a branch to the specified name.')
1082 group.add_remote_option('--force-create', default=False, action='store_true',
1083 help='Overwrites an existing branch.')
1084
1085 parser.add_option_group(group)
1086
1087 #
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001088 # Advanced options.
Ryan Cuif4f84be2012-07-09 18:50:41 -07001089 #
1090
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001091 group = CustomGroup(
Brian Harring3fec5a82012-03-01 05:57:03 -08001092 parser,
1093 'Advanced Options',
1094 'Caution: use these options at your own risk.')
1095
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001096 group.add_remote_option('--bootstrap-args', action='append', default=[],
1097 help='Args passed directly to the bootstrap re-exec '
1098 'to skip verification by the bootstrap code')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001099 group.add_remote_option('--buildbot', dest='buildbot', action='store_true',
1100 default=False, help='This is running on a buildbot')
1101 group.add_remote_option('--buildnumber', help='build number', type='int',
1102 default=0)
Ryan Cui5ba7e152012-05-10 14:36:52 -07001103 group.add_option('--chrome_root', default=None, type='path',
1104 action='callback', callback=_CheckChromeRootOption,
1105 dest='chrome_root', help='Local checkout of Chrome to use.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001106 group.add_remote_option('--chrome_version', default=None, type='string',
1107 action='callback', dest='chrome_version',
1108 callback=_CheckChromeVersionOption,
1109 help='Used with SPEC logic to force a particular SVN '
1110 'revision of chrome rather than the latest.')
1111 group.add_remote_option('--clobber', action='store_true', dest='clobber',
1112 default=False,
1113 help='Clears an old checkout before syncing')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001114 group.add_remote_option('--latest-toolchain', action='store_true',
1115 default=False,
1116 help='Use the latest toolchain.')
Ryan Cui5ba7e152012-05-10 14:36:52 -07001117 parser.add_option('--log_dir', dest='log_dir', type='path',
Brian Harring3fec5a82012-03-01 05:57:03 -08001118 help=('Directory where logs are stored.'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001119 group.add_remote_option('--maxarchives', dest='max_archive_builds',
1120 default=3, type='int',
1121 help="Change the local saved build count limit.")
Ryan Cuibbd3d4b2012-08-17 12:20:37 -07001122 parser.add_remote_option('--manifest-repo-url',
1123 help=('Overrides the default manifest repo url.'))
David James565bc9a2013-04-08 14:54:45 -07001124 group.add_remote_option('--compilecheck', action='store_true', default=False,
1125 help='Only verify compilation and unit tests.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001126 group.add_remote_option('--noarchive', action='store_false', dest='archive',
1127 default=True, help="Don't run archive stage.")
Ryan Cuif7f24692012-05-18 16:35:33 -07001128 group.add_remote_option('--nobootstrap', action='store_false',
1129 dest='bootstrap', default=True,
1130 help="Don't checkout and run from a standalone "
1131 "chromite repo.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001132 group.add_remote_option('--nobuild', action='store_false', dest='build',
1133 default=True,
1134 help="Don't actually build (for cbuildbot dev)")
1135 group.add_remote_option('--noclean', action='store_false', dest='clean',
1136 default=True, help="Don't clean the buildroot")
Ryan Cuif7f24692012-05-18 16:35:33 -07001137 group.add_remote_option('--nocgroups', action='store_false', dest='cgroups',
1138 default=True,
1139 help='Disable cbuildbots usage of cgroups.')
Ryan Cui3ea98e02013-08-07 16:01:48 -07001140 group.add_remote_option('--nochromesdk', action='store_false',
1141 dest='chrome_sdk', default=True,
1142 help="Don't run the ChromeSDK stage which builds "
1143 "Chrome outside of the chroot.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001144 group.add_remote_option('--noprebuilts', action='store_false',
1145 dest='prebuilts', default=True,
1146 help="Don't upload prebuilts.")
Ryan Cui88b901c2013-06-21 11:35:30 -07001147 group.add_remote_option('--nopatch', action='store_false',
1148 dest='postsync_patch', default=True,
1149 help=("Don't run PatchChanges stage. This does not "
1150 "disable patching in of chromite patches "
1151 "during BootstrapStage."))
Don Garrett82c0ae82014-02-03 18:25:11 -08001152 group.add_remote_option('--nopaygen', action='store_false',
1153 dest='paygen', default=True,
1154 help="Don't generate payloads.")
Ryan Cui88b901c2013-06-21 11:35:30 -07001155 group.add_remote_option('--noreexec', action='store_false',
1156 dest='postsync_reexec', default=True,
1157 help="Don't reexec into the buildroot after syncing.")
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001158 group.add_remote_option('--nosdk', action='store_true',
1159 default=False,
1160 help='Re-create the SDK from scratch.')
Don Garrett7604d6a2014-01-15 14:45:39 -08001161 group.add_remote_option('--nosigner-results', action='store_false',
1162 dest='signer_results', default=True,
1163 help="Don't display signing results.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001164 group.add_remote_option('--nosync', action='store_false', dest='sync',
1165 default=True, help="Don't sync before building.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001166 group.add_remote_option('--notests', action='store_false', dest='tests',
1167 default=True,
1168 help='Override values from buildconfig and run no '
1169 'tests.')
1170 group.add_remote_option('--nouprev', action='store_false', dest='uprev',
1171 default=True,
1172 help='Override values from buildconfig and never '
1173 'uprev.')
David Jamesdac7a912013-11-18 11:14:44 -08001174 group.add_option('--reference-repo', action='store', default=None,
1175 dest='reference_repo',
1176 help='Reuse git data stored in an existing repo '
1177 'checkout. This can drastically reduce the network '
1178 'time spent setting up the trybot checkout. By '
1179 "default, if this option isn't given but cbuildbot "
1180 'is invoked from a repo checkout, cbuildbot will '
1181 'use the repo root.')
Ryan Cuicedd8a52012-03-22 02:28:35 -07001182 group.add_option('--resume', action='store_true', default=False,
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001183 help='Skip stages already successfully completed.')
1184 group.add_remote_option('--timeout', action='store', type='int', default=0,
1185 help='Specify the maximum amount of time this job '
1186 'can run for, at which point the build will be '
1187 'aborted. If set to zero, then there is no '
1188 'timeout.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001189 group.add_remote_option('--version', dest='force_version', default=None,
1190 help='Used with manifest logic. Forces use of this '
Aviv Keshetc2c123d2013-10-14 18:06:12 -04001191 'version rather than create or get latest. '
1192 'Examples: 4815.0.0-rc1, 4815.1.2')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001193
1194 parser.add_option_group(group)
1195
1196 #
1197 # Internal options.
1198 #
1199
1200 group = CustomGroup(
1201 parser,
Mike Frysinger34db8692013-11-11 14:54:08 -05001202 'Internal Chromium OS Build Team Options',
1203 'Caution: these are for meant for the Chromium OS build team only')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001204
1205 group.add_remote_option('--archive-base', type='gs_path',
1206 help='Base GS URL (gs://<bucket_name>/<path>) to '
1207 'upload archive artifacts to')
Brian Harringab8fb5c2012-07-18 11:28:22 -07001208 group.add_remote_option('--cq-gerrit-query', dest='cq_gerrit_override',
1209 default=None,
1210 help=
1211 "If given, this gerrit query will be used to find what patches to test, "
Aviv Keshetefd6bbf2013-12-12 13:36:57 -08001212 "rather than the normal 'CommitQueue>=1 AND Verified=1 AND CodeReview=2' "
Brian Harringab8fb5c2012-07-18 11:28:22 -07001213 "query it defaults to. Use with care- note additionally this setting "
1214 "only has an effect if the buildbot target is a cq target, and we're "
1215 "in buildbot mode.")
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001216 group.add_option('--pass-through', dest='pass_through_args', action='append',
1217 type='string', default=[])
David Jamesf421c6d2013-04-11 15:37:57 -07001218 group.add_remote_option('--pre-cq', action='store_true', default=False,
1219 help='Mark CLs as tested by the PreCQ on success.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001220 group.add_option('--reexec-api-version', dest='output_api_version',
Ryan Cuif4f84be2012-07-09 18:50:41 -07001221 action='store_true', default=False,
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001222 help='Used for handling forwards/backwards compatibility '
1223 'with --resume and --bootstrap')
1224 group.add_option('--remote-trybot', dest='remote_trybot',
1225 action='store_true', default=False,
1226 help='Indicates this is running on a remote trybot machine')
1227 group.add_remote_option('--remote-patches', action='extend', default=[],
1228 help='Patches uploaded by the trybot client when run '
1229 'using the -p option')
Brian Harringf611e6e2012-07-17 18:47:44 -07001230 # Note the default here needs to be hardcoded to 3; that is the last version
1231 # that lacked this functionality.
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001232 group.add_option('--remote-version', default=3, type=int, action='store',
1233 help='Used for compatibility checks w/tryjobs running in '
1234 'older chromite instances')
1235 group.add_option('--sourceroot', type='path', default=constants.SOURCE_ROOT)
1236 group.add_remote_option('--test-bootstrap', action='store_true',
1237 default=False,
1238 help='Causes cbuildbot to bootstrap itself twice, in '
1239 'the sequence A->B->C: A(unpatched) patches and '
1240 'bootstraps B; B patches and bootstraps C')
1241 group.add_remote_option('--validation_pool', default=None,
1242 help='Path to a pickled validation pool. Intended '
1243 'for use only with the commit queue.')
Aviv Kesheta0159be2013-12-12 13:56:28 -08001244 group.add_remote_option('--mock-tree-status', dest='mock_tree_status',
1245 default=None, action='store',
1246 help='Override the tree status value that would be '
1247 'returned from the the actual tree. Example '
1248 'values: open, closed, throttled. When used '
1249 'in conjunction with --debug, the tree status '
1250 'will not be ignored as it usually is in a '
1251 '--debug run.')
Mike Frysinger81af6ef2013-04-03 02:24:09 -04001252
1253 parser.add_option_group(group)
Ryan Cuif4f84be2012-07-09 18:50:41 -07001254
1255 #
Brian Harring3fec5a82012-03-01 05:57:03 -08001256 # Debug options
Ryan Cuif4f84be2012-07-09 18:50:41 -07001257 #
Brian Harringfec89fe2012-09-23 07:30:54 -07001258 # Temporary hack; in place till --dry-run replaces --debug.
1259 # pylint: disable=W0212
Brian Harring009db502012-10-10 02:21:37 -07001260 group = parser.debug_group
Brian Harringfec89fe2012-09-23 07:30:54 -07001261 debug = [x for x in group.option_list if x._long_opts == ['--debug']][0]
1262 debug.help += " Currently functions as --dry-run in addition."
1263 debug.pass_through = True
Brian Harring3fec5a82012-03-01 05:57:03 -08001264 group.add_option('--notee', action='store_false', dest='tee', default=True,
1265 help="Disable logging and internal tee process. Primarily "
1266 "used for debugging cbuildbot itself.")
Brian Harring3fec5a82012-03-01 05:57:03 -08001267 return parser
1268
1269
Ryan Cui85867972012-02-23 18:21:49 -08001270def _FinishParsing(options, args):
1271 """Perform some parsing tasks that need to take place after optparse.
1272
1273 This function needs to be easily testable! Keep it free of
1274 environment-dependent code. Put more detailed usage validation in
1275 _PostParseCheck().
Brian Harring3fec5a82012-03-01 05:57:03 -08001276
1277 Args:
Matt Tennant759e2352013-09-27 15:14:44 -07001278 options: The options object returned by optparse
1279 args: The args object returned by optparse
Brian Harring3fec5a82012-03-01 05:57:03 -08001280 """
Ryan Cui41023d92012-11-13 19:59:50 -08001281 # Populate options.pass_through_args.
1282 accepted, _ = commandline.FilteringParser.FilterArgs(
1283 options.parsed_args, lambda x: x.opt_inst.pass_through)
1284 options.pass_through_args.extend(accepted)
Brian Harring07039b52012-05-13 17:56:47 -07001285
Brian Harring3fec5a82012-03-01 05:57:03 -08001286 if options.chrome_root:
1287 if options.chrome_rev != constants.CHROME_REV_LOCAL:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001288 cros_build_lib.Die('Chrome rev must be %s if chrome_root is set.' %
1289 constants.CHROME_REV_LOCAL)
David Jamesa0a664e2013-02-13 09:52:01 -08001290 elif options.chrome_rev == constants.CHROME_REV_LOCAL:
1291 cros_build_lib.Die('Chrome root must be set if chrome_rev is %s.' %
1292 constants.CHROME_REV_LOCAL)
Brian Harring3fec5a82012-03-01 05:57:03 -08001293
1294 if options.chrome_version:
1295 if options.chrome_rev != constants.CHROME_REV_SPEC:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001296 cros_build_lib.Die('Chrome rev must be %s if chrome_version is set.' %
1297 constants.CHROME_REV_SPEC)
David Jamesa0a664e2013-02-13 09:52:01 -08001298 elif options.chrome_rev == constants.CHROME_REV_SPEC:
1299 cros_build_lib.Die(
1300 'Chrome rev must not be %s if chrome_version is not set.'
1301 % constants.CHROME_REV_SPEC)
Brian Harring3fec5a82012-03-01 05:57:03 -08001302
David James9e27e662013-02-14 13:42:43 -08001303 patches = bool(options.gerrit_patches or options.local_patches or
1304 options.rietveld_patches)
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001305 if options.remote:
1306 if options.local:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001307 cros_build_lib.Die('Cannot specify both --remote and --local')
Ryan Cui54da0702012-04-19 18:38:08 -07001308
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001309 if not options.buildbot and not patches:
Gaurav Shahed0399e2014-02-03 13:36:22 -08001310 prompt = ('No patches were provided; are you sure you want to just '
1311 'run a remote build of %s?' % (
1312 options.branch if options.branch else 'ToT'))
1313 if not cros_build_lib.BooleanPrompt(prompt=prompt, default=False):
Brian Harring7cc4b932012-11-01 16:58:55 -07001314 cros_build_lib.Die('Must provide patches when running with --remote.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001315
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001316 # --debug needs to be explicitly passed through for remote invocations.
1317 release_mode_with_patches = (options.buildbot and patches and
1318 '--debug' not in options.pass_through_args)
1319 else:
1320 if len(args) > 1:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001321 cros_build_lib.Die('Multiple configs not supported if not running with '
Brian Harringf1aad832012-07-18 10:46:39 -07001322 '--remote. Got %r', args)
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001323
Ryan Cui79319ab2012-05-21 12:59:18 -07001324 if options.slaves:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001325 cros_build_lib.Die('Cannot use --slaves if not running with --remote.')
Ryan Cui79319ab2012-05-21 12:59:18 -07001326
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001327 release_mode_with_patches = (options.buildbot and patches and
1328 not options.debug)
1329
David James5734ea32012-08-15 20:23:49 -07001330 # When running in release mode, make sure we are running with checked-in code.
1331 # We want checked-in cbuildbot/scripts to prevent errors, and we want to build
1332 # a release image with checked-in code for CrOS packages.
1333 if release_mode_with_patches:
1334 cros_build_lib.Die(
1335 'Cannot provide patches when running with --buildbot!')
1336
Ryan Cuiba41ad32012-03-08 17:15:29 -08001337 if options.buildbot and options.remote_trybot:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001338 cros_build_lib.Die(
1339 '--buildbot and --remote-trybot cannot be used together.')
Ryan Cuiba41ad32012-03-08 17:15:29 -08001340
Ryan Cui85867972012-02-23 18:21:49 -08001341 # Record whether --debug was set explicitly vs. it was inferred.
1342 options.debug_forced = False
1343 if options.debug:
1344 options.debug_forced = True
Ryan Cui88b901c2013-06-21 11:35:30 -07001345 if not options.debug:
Ryan Cui16ca5812012-03-08 20:34:27 -08001346 # We don't set debug by default for
1347 # 1. --buildbot invocations.
1348 # 2. --remote invocations, because it needs to push changes to the tryjob
1349 # repo.
1350 options.debug = not options.buildbot and not options.remote
Brian Harring3fec5a82012-03-01 05:57:03 -08001351
Ryan Cui1c13a252012-10-16 15:00:16 -07001352 # Record the configs targeted.
1353 options.build_targets = args[:]
1354
Ryan Cui88b901c2013-06-21 11:35:30 -07001355 if constants.BRANCH_UTIL_CONFIG in options.build_targets:
Ryan Cui7bd8db62013-08-08 16:29:51 -07001356 if options.remote:
1357 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001358 'Running %s as a remote tryjob is not yet supported.',
1359 constants.BRANCH_UTIL_CONFIG)
Ryan Cui88b901c2013-06-21 11:35:30 -07001360 if len(options.build_targets) > 1:
1361 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001362 'Cannot run %s with any other configs.',
1363 constants.BRANCH_UTIL_CONFIG)
Ryan Cui88b901c2013-06-21 11:35:30 -07001364 if not options.branch_name:
1365 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001366 'Must specify --branch-name with the %s config.',
1367 constants.BRANCH_UTIL_CONFIG)
1368 if options.branch and options.branch != options.branch_name:
Ryan Cui88b901c2013-06-21 11:35:30 -07001369 cros_build_lib.Die(
Matt Tennanta130ea32013-12-19 09:38:39 -08001370 'If --branch is specified with the %s config, it must'
1371 ' have the same value as --branch-name.',
1372 constants.BRANCH_UTIL_CONFIG)
1373
1374 exclusive_opts = {'--version': options.force_version,
1375 '--delete-branch': options.delete_branch,
1376 '--rename-to': options.rename_to,
1377 }
1378 if 1 != sum(1 for x in exclusive_opts.values() if x):
1379 cros_build_lib.Die('When using the %s config, you must'
1380 ' specifiy one and only one of the following'
1381 ' options: %s.', constants.BRANCH_UTIL_CONFIG,
1382 ', '.join(exclusive_opts.keys()))
1383
1384 # When deleting or renaming a branch, the --branch and --nobootstrap
1385 # options are implied.
1386 if options.delete_branch or options.rename_to:
1387 if not options.branch:
1388 cros_build_lib.Info('Automatically enabling sync to branch %s'
1389 ' for this %s flow.', options.branch_name,
1390 constants.BRANCH_UTIL_CONFIG)
1391 options.branch = options.branch_name
1392 if options.bootstrap:
1393 cros_build_lib.Info('Automatically disabling bootstrap step for'
1394 ' this %s flow.', constants.BRANCH_UTIL_CONFIG)
1395 options.bootstrap = False
1396
Ryan Cui88b901c2013-06-21 11:35:30 -07001397 elif any([options.delete_branch, options.rename_to, options.branch_name]):
1398 cros_build_lib.Die(
1399 'Cannot specify --delete-branch, --rename-to or --branch-name when not '
1400 'running the %s config', constants.BRANCH_UTIL_CONFIG)
1401
Brian Harring3fec5a82012-03-01 05:57:03 -08001402
Brian Harring1d7ba942012-04-24 06:37:18 -07001403# pylint: disable=W0613
Brian Harringae0a5322012-09-15 01:46:51 -07001404def _PostParseCheck(parser, options, args):
Ryan Cui85867972012-02-23 18:21:49 -08001405 """Perform some usage validation after we've parsed the arguments
Brian Harring3fec5a82012-03-01 05:57:03 -08001406
Ryan Cui85867972012-02-23 18:21:49 -08001407 Args:
Aviv Keshet9e4236b2013-12-13 13:07:50 -08001408 parser: Option parser that was used to parse arguments.
1409 options: The options returned by optparse.
1410 args: The args returned by optparse.
Ryan Cui85867972012-02-23 18:21:49 -08001411 """
Ryan Cuie1e4e662012-05-21 16:39:46 -07001412 if not options.branch:
David James97d95872012-11-16 15:09:56 -08001413 options.branch = git.GetChromiteTrackingBranch()
Ryan Cuie1e4e662012-05-21 16:39:46 -07001414
Brian Harringae0a5322012-09-15 01:46:51 -07001415 if not repository.IsARepoRoot(options.sourceroot):
1416 if options.local_patches:
1417 raise Exception('Could not find repo checkout at %s!'
1418 % options.sourceroot)
1419
David Jamesac8c2a72013-02-13 18:44:33 -08001420 # Because the default cache dir depends on other options, FindCacheDir
1421 # always returns None, and we setup the default here.
Brian Harringae0a5322012-09-15 01:46:51 -07001422 if options.cache_dir is None:
1423 # Note, options.sourceroot is set regardless of the path
1424 # actually existing.
David Jamesac8c2a72013-02-13 18:44:33 -08001425 if options.buildroot is not None:
Brian Harringae0a5322012-09-15 01:46:51 -07001426 options.cache_dir = os.path.join(options.buildroot, '.cache')
David Jamesac8c2a72013-02-13 18:44:33 -08001427 elif os.path.exists(options.sourceroot):
1428 options.cache_dir = os.path.join(options.sourceroot, '.cache')
Brian Harringae0a5322012-09-15 01:46:51 -07001429 else:
1430 options.cache_dir = parser.FindCacheDir(parser, options)
1431 options.cache_dir = os.path.abspath(options.cache_dir)
Brian Harring8c1d7b12012-10-04 17:36:32 -07001432 parser.ConfigureCacheDir(options.cache_dir)
Brian Harringae0a5322012-09-15 01:46:51 -07001433
Yu-Ju Hong2c066762013-10-28 14:05:08 -07001434 osutils.SafeMakedirsNonRoot(options.cache_dir)
Ryan Cui5ba7e152012-05-10 14:36:52 -07001435
Brian Harring609dc4e2012-05-07 02:17:44 -07001436 if options.local_patches:
Brian Harring1d7ba942012-04-24 06:37:18 -07001437 options.local_patches = _CheckLocalPatches(
Brian Harring609dc4e2012-05-07 02:17:44 -07001438 options.sourceroot, options.local_patches)
Brian Harring1d7ba942012-04-24 06:37:18 -07001439
1440 default = os.environ.get('CBUILDBOT_DEFAULT_MODE')
1441 if (default and not any([options.local, options.buildbot,
1442 options.remote, options.remote_trybot])):
Brian Harring1b8c4c82012-05-29 23:03:04 -07001443 cros_build_lib.Info("CBUILDBOT_DEFAULT_MODE=%s env var detected, using it."
1444 % default)
Brian Harring1d7ba942012-04-24 06:37:18 -07001445 default = default.lower()
1446 if default == 'local':
1447 options.local = True
1448 elif default == 'remote':
1449 options.remote = True
1450 elif default == 'buildbot':
1451 options.buildbot = True
1452 else:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001453 cros_build_lib.Die("CBUILDBOT_DEFAULT_MODE value %s isn't supported. "
1454 % default)
Ryan Cui85867972012-02-23 18:21:49 -08001455
Matt Tennant763497d2014-01-17 16:45:54 -08001456 # Ensure that all args are legitimate config targets.
1457 invalid_target = False
1458 for arg in args:
Matt Tennant2c192032014-01-16 13:49:28 -08001459 build_config = _GetConfig(arg)
1460 if not build_config:
Matt Tennant763497d2014-01-17 16:45:54 -08001461 cros_build_lib.Error('No such configuraton target: "%s".', arg)
1462 invalid_target = True
1463
Matt Tennant2c192032014-01-16 13:49:28 -08001464 # The --version option is not compatible with an external target unless the
1465 # --buildbot option is specified. More correctly, only "paladin versions"
1466 # will work with external targets, and those are only used with --buildbot.
1467 # If --buildbot is specified, then user should know what they are doing and
1468 # only specify a version that will work. See crbug.com/311648.
1469 elif options.force_version and not options.buildbot:
1470 if not build_config.internal:
1471 cros_build_lib.Die('Cannot specify --version without --buildbot for an'
1472 ' external target (%s).' % arg)
1473
Matt Tennant763497d2014-01-17 16:45:54 -08001474 if invalid_target:
1475 print 'Please specify one of:'
1476 _PrintValidConfigs()
1477 cros_build_lib.Die('One or more invalid configuration targets specified.')
1478
Ryan Cui85867972012-02-23 18:21:49 -08001479
1480def _ParseCommandLine(parser, argv):
1481 """Completely parse the commandline arguments"""
Brian Harring3fec5a82012-03-01 05:57:03 -08001482 (options, args) = parser.parse_args(argv)
Brian Harring37e559b2012-05-22 20:47:32 -07001483
Matt Tennant763497d2014-01-17 16:45:54 -08001484 # Strip out null arguments.
1485 # TODO(rcui): Remove when buildbot is fixed
1486 args = [arg for arg in args if arg]
1487
1488 # A couple options, like --list, trigger a quick exit.
Brian Harring37e559b2012-05-22 20:47:32 -07001489 if options.output_api_version:
Ryan Cui724f1d32012-10-15 18:10:22 -07001490 print constants.REEXEC_API_VERSION
Brian Harring37e559b2012-05-22 20:47:32 -07001491 sys.exit(0)
1492
Ryan Cui54da0702012-04-19 18:38:08 -07001493 if options.list:
Matt Tennant763497d2014-01-17 16:45:54 -08001494 if args:
1495 cros_build_lib.Die('No arguments expected with the --list options.')
Ryan Cui54da0702012-04-19 18:38:08 -07001496 _PrintValidConfigs(options.print_all)
1497 sys.exit(0)
1498
Ryan Cui8be16062012-04-24 12:05:26 -07001499 if not args:
Matt Tennant763497d2014-01-17 16:45:54 -08001500 parser.error('Invalid usage: no configuration targets provided.'
1501 'Use -h to see usage. Use -l to list supported configs.')
Ryan Cui8be16062012-04-24 12:05:26 -07001502
Ryan Cui85867972012-02-23 18:21:49 -08001503 _FinishParsing(options, args)
1504 return options, args
1505
1506
Matt Tennant759e2352013-09-27 15:14:44 -07001507# TODO(build): This function is too damn long.
Ryan Cui85867972012-02-23 18:21:49 -08001508def main(argv):
David James59a0a2b2013-03-22 14:04:44 -07001509 # Turn on strict sudo checks.
1510 cros_build_lib.STRICT_SUDO = True
1511
Ryan Cui85867972012-02-23 18:21:49 -08001512 # Set umask to 022 so files created by buildbot are readable.
Mike Frysinger60ec1012013-10-21 00:11:10 -04001513 os.umask(0o22)
Ryan Cui85867972012-02-23 18:21:49 -08001514
Ryan Cui85867972012-02-23 18:21:49 -08001515 parser = _CreateParser()
1516 (options, args) = _ParseCommandLine(parser, argv)
Brian Harring3fec5a82012-03-01 05:57:03 -08001517
Brian Harringae0a5322012-09-15 01:46:51 -07001518 _PostParseCheck(parser, options, args)
Brian Harring3fec5a82012-03-01 05:57:03 -08001519
Mike Frysinger8fd67dc2012-12-03 23:51:18 -05001520 cros_build_lib.AssertOutsideChroot()
Zdenek Behan98ec2fb2012-08-31 17:12:18 +02001521
Brian Harring3fec5a82012-03-01 05:57:03 -08001522 if options.remote:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001523 cros_build_lib.logger.setLevel(logging.WARNING)
Ryan Cui16ca5812012-03-08 20:34:27 -08001524
Brian Harring3fec5a82012-03-01 05:57:03 -08001525 # Verify configs are valid.
Dan Shi0bdb7132013-07-30 16:22:12 -07001526 # If hwtest flag is enabled, post a warning that HWTest step may fail if the
1527 # specified board is not a released platform or it is a generic overlay.
Brian Harring3fec5a82012-03-01 05:57:03 -08001528 for bot in args:
Aviv Kesheta96a2a92013-02-05 17:21:51 -08001529 build_config = _GetConfig(bot)
1530 if options.hwtest:
Dan Shi0bdb7132013-07-30 16:22:12 -07001531 cros_build_lib.Warning(
1532 'If %s is not a released platform or it is a generic overlay, '
1533 'the HWTest step will most likely not run; please ask the lab '
1534 'team for help if this is unexpected.' % build_config['boards'])
Brian Harring3fec5a82012-03-01 05:57:03 -08001535
1536 # Verify gerrit patches are valid.
Ryan Cui16ca5812012-03-08 20:34:27 -08001537 print 'Verifying patches...'
Ryan Cuie1e4e662012-05-21 16:39:46 -07001538 patch_pool = AcquirePoolFromOptions(options)
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001539
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001540 # --debug need to be explicitly passed through for remote invocations.
1541 if options.buildbot and '--debug' not in options.pass_through_args:
1542 _ConfirmRemoteBuildbotRun()
1543
Ryan Cui16ca5812012-03-08 20:34:27 -08001544 print 'Submitting tryjob...'
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001545 tryjob = remote_try.RemoteTryJob(options, args, patch_pool.local_patches)
Ryan Cuia25d8eb2012-07-11 14:54:27 -07001546 tryjob.Submit(testjob=options.test_tryjob, dryrun=False)
Ryan Cui16ca5812012-03-08 20:34:27 -08001547 print 'Tryjob submitted!'
1548 print ('Go to %s to view the status of your job.'
Ryan Cui4906e1c2012-04-03 20:09:34 -07001549 % tryjob.GetTrybotWaterfallLink())
Brian Harring3fec5a82012-03-01 05:57:03 -08001550 sys.exit(0)
Matt Tennant759e2352013-09-27 15:14:44 -07001551
Ryan Cui54da0702012-04-19 18:38:08 -07001552 elif (not options.buildbot and not options.remote_trybot
1553 and not options.resume and not options.local):
Ryan Cui88b901c2013-06-21 11:35:30 -07001554 options.local = True
Brian Harring1b8c4c82012-05-29 23:03:04 -07001555 cros_build_lib.Warning(
1556 'Running in LOCAL TRYBOT mode! Use --remote to submit REMOTE '
1557 'tryjobs. Use --local to suppress this message.')
1558 cros_build_lib.Warning(
Ryan Cui51591352012-07-09 15:15:53 -07001559 'In the future, --local will be required to run the local '
Brian Harring1b8c4c82012-05-29 23:03:04 -07001560 'trybot.')
Ryan Cui54da0702012-04-19 18:38:08 -07001561 time.sleep(5)
Brian Harring3fec5a82012-03-01 05:57:03 -08001562
Matt Tennant759e2352013-09-27 15:14:44 -07001563 # Only one config arg is allowed in this mode, which was confirmed earlier.
Ryan Cui8be16062012-04-24 12:05:26 -07001564 bot_id = args[-1]
1565 build_config = _GetConfig(bot_id)
Brian Harring3fec5a82012-03-01 05:57:03 -08001566
David Jamesdac7a912013-11-18 11:14:44 -08001567 if options.reference_repo is None:
1568 repo_path = os.path.join(options.sourceroot, '.repo')
1569 # If we're being run from a repo checkout, reuse the repo's git pool to
1570 # cut down on sync time.
1571 if os.path.exists(repo_path):
1572 options.reference_repo = options.sourceroot
1573 elif options.reference_repo:
1574 if not os.path.exists(options.reference_repo):
1575 parser.error('Reference path %s does not exist'
1576 % (options.reference_repo,))
1577 elif not os.path.exists(os.path.join(options.reference_repo, '.repo')):
1578 parser.error('Reference path %s does not look to be the base of a '
1579 'repo checkout; no .repo exists in the root.'
1580 % (options.reference_repo,))
1581
Brian Harringf11bf682012-05-14 15:53:43 -07001582 if (options.buildbot or options.remote_trybot) and not options.resume:
Brian Harring470f6112012-03-02 11:47:10 -08001583 if not options.cgroups:
Ryan Cuid4a24212012-04-04 18:08:12 -07001584 parser.error('Options --buildbot/--remote-trybot and --nocgroups cannot '
1585 'be used together. Cgroup support is required for '
1586 'buildbot/remote-trybot mode.')
Mike Frysingera78a56e2012-11-20 06:02:30 -05001587 if not cgroups.Cgroup.IsSupported():
Ryan Cuid4a24212012-04-04 18:08:12 -07001588 parser.error('Option --buildbot/--remote-trybot was given, but this '
1589 'system does not support cgroups. Failing.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001590
David Jamesaad5cc72012-10-26 15:03:13 -07001591 missing = osutils.FindMissingBinaries(_BUILDBOT_REQUIRED_BINARIES)
Brian Harring351ce442012-03-09 16:38:14 -08001592 if missing:
Ryan Cuid4a24212012-04-04 18:08:12 -07001593 parser.error("Option --buildbot/--remote-trybot requires the following "
1594 "binaries which couldn't be found in $PATH: %s"
Brian Harring351ce442012-03-09 16:38:14 -08001595 % (', '.join(missing)))
1596
David Jamesdac7a912013-11-18 11:14:44 -08001597 if options.reference_repo:
1598 options.reference_repo = os.path.abspath(options.reference_repo)
1599
Brian Harring3fec5a82012-03-01 05:57:03 -08001600 if not options.buildroot:
1601 if options.buildbot:
Mike Frysinger6903c762012-12-04 01:57:16 -05001602 parser.error('Please specify a buildroot with the --buildbot option.')
Matt Tennantd55b1f42012-04-13 14:15:01 -07001603
Ryan Cui5ba7e152012-05-10 14:36:52 -07001604 options.buildroot = _DetermineDefaultBuildRoot(options.sourceroot,
1605 build_config['internal'])
Brian Harring470f6112012-03-02 11:47:10 -08001606 # We use a marker file in the buildroot to indicate the user has
1607 # consented to using this directory.
1608 if not os.path.exists(repository.GetTrybotMarkerPath(options.buildroot)):
1609 _ConfirmBuildRoot(options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -08001610
1611 # Sanity check of buildroot- specifically that it's not pointing into the
1612 # midst of an existing repo since git-repo doesn't support nesting.
Brian Harring3fec5a82012-03-01 05:57:03 -08001613 if (not repository.IsARepoRoot(options.buildroot) and
David James13a69c92013-05-09 10:37:42 -07001614 git.FindRepoDir(options.buildroot)):
Brian Harring3fec5a82012-03-01 05:57:03 -08001615 parser.error('Configured buildroot %s points into a repository checkout, '
1616 'rather than the root of it. This is not supported.'
1617 % options.buildroot)
1618
Chris Sosab5ea3b42012-10-25 15:25:20 -07001619 if not options.log_dir:
1620 options.log_dir = os.path.join(options.buildroot, _DEFAULT_LOG_DIR)
1621
Brian Harringd166aaf2012-05-14 18:31:53 -07001622 log_file = None
1623 if options.tee:
Chris Sosab5ea3b42012-10-25 15:25:20 -07001624 log_file = os.path.join(options.log_dir, _BUILDBOT_LOG_FILE)
1625 osutils.SafeMakedirs(options.log_dir)
Brian Harringd166aaf2012-05-14 18:31:53 -07001626 _BackupPreviousLog(log_file)
1627
Brian Harring1b8c4c82012-05-29 23:03:04 -07001628 with cros_build_lib.ContextManagerStack() as stack:
Aaron Gable881fccb2013-09-27 18:35:24 -07001629 # TODO(ferringb): update this once
1630 # https://chromium-review.googlesource.com/25359
David Jamescebc7272013-07-17 16:45:05 -07001631 # is landed- it's sensitive to the manifest-versions cache path.
1632 options.preserve_paths = set(['manifest-versions', '.cache',
1633 'manifest-versions-internal'])
1634 if log_file is not None:
1635 # We don't want the critical section to try to clean up the tee process,
1636 # so we run Tee (forked off) outside of it. This prevents a deadlock
1637 # because the Tee process only exits when its pipe is closed, and the
1638 # critical section accidentally holds on to that file handle.
1639 stack.Add(tee.Tee, log_file)
1640 options.preserve_paths.add(_DEFAULT_LOG_DIR)
1641
Brian Harringc2d09d92012-05-13 22:03:15 -07001642 critical_section = stack.Add(cleanup.EnforcedCleanupSection)
1643 stack.Add(sudo.SudoKeepAlive)
Brian Harringd166aaf2012-05-14 18:31:53 -07001644
Brian Harringc2d09d92012-05-13 22:03:15 -07001645 if not options.resume:
Brian Harring2bf55e12012-05-13 21:31:55 -07001646 # If we're in resume mode, use our parents tempdir rather than
1647 # nesting another layer.
David James4bc13702013-03-26 08:08:04 -07001648 stack.Add(osutils.TempDir, prefix='cbuildbot-tmp', set_global=True)
Brian Harringc2d09d92012-05-13 22:03:15 -07001649 logging.debug("Cbuildbot tempdir is %r.", os.environ.get('TMP'))
Brian Harringd166aaf2012-05-14 18:31:53 -07001650
Brian Harringc2d09d92012-05-13 22:03:15 -07001651 if options.cgroups:
1652 stack.Add(cgroups.SimpleContainChildren, 'cbuildbot')
Brian Harringa184efa2012-03-04 11:51:25 -08001653
Brian Harringc2d09d92012-05-13 22:03:15 -07001654 # Mark everything between EnforcedCleanupSection and here as having to
1655 # be rolled back via the contextmanager cleanup handlers. This
1656 # ensures that sudo bits cannot outlive cbuildbot, that anything
1657 # cgroups would kill gets killed, etc.
David Jamesfb3aac92013-10-16 13:26:52 -07001658 stack.Add(critical_section.ForkWatchdog)
Brian Harringd166aaf2012-05-14 18:31:53 -07001659
Brian Harringc2d09d92012-05-13 22:03:15 -07001660 if options.timeout > 0:
David James3432acd2013-11-27 10:02:18 -08001661 stack.Add(timeout_util.FatalTimeout, options.timeout)
Brian Harringa184efa2012-03-04 11:51:25 -08001662
Brian Harringc2d09d92012-05-13 22:03:15 -07001663 if not options.buildbot:
1664 build_config = cbuildbot_config.OverrideConfigForTrybot(
1665 build_config,
David Jamese8dcfc42013-03-21 19:49:49 -07001666 options)
Brian Harringc2d09d92012-05-13 22:03:15 -07001667
Mike Frysinger6903c762012-12-04 01:57:16 -05001668 if options.buildbot or options.remote_trybot:
1669 _DisableYamaHardLinkChecks()
1670
Aviv Kesheta0159be2013-12-12 13:56:28 -08001671 if options.mock_tree_status is not None:
1672 stack.Add(mock.patch.object, timeout_util, '_GetStatus',
1673 return_value=options.mock_tree_status)
1674
Brian Harringc2d09d92012-05-13 22:03:15 -07001675 _RunBuildStagesWrapper(options, build_config)