blob: 924000fed98ad31369afff65f91c6c36aa2f906b [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
13import distutils.version
14import glob
Chris Sosa4f6ffaf2012-05-01 17:05:44 -070015import logging
David James58e0c092012-03-04 20:31:12 -080016import multiprocessing
Brian Harring3fec5a82012-03-01 05:57:03 -080017import optparse
18import os
19import pprint
20import sys
Ryan Cui54da0702012-04-19 18:38:08 -070021import time
Brian Harring3fec5a82012-03-01 05:57:03 -080022
23from chromite.buildbot import builderstage as bs
24from chromite.buildbot import cbuildbot_background as background
25from chromite.buildbot import cbuildbot_config
26from chromite.buildbot import cbuildbot_stages as stages
27from chromite.buildbot import cbuildbot_results as results_lib
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
Brian Harring511055e2012-10-10 02:58:59 -070038from chromite.lib import gerrit
Brian Harringaf019fb2012-05-10 15:06:13 -070039from chromite.lib import osutils
Brian Harring511055e2012-10-10 02:58:59 -070040from chromite.lib import patch as cros_patch
Brian Harring3fec5a82012-03-01 05:57:03 -080041from chromite.lib import sudo
42
Ryan Cuiadd49122012-03-21 22:19:58 -070043
Brian Harring1b8c4c82012-05-29 23:03:04 -070044cros_build_lib.STRICT_SUDO = True
Brian Harring3fec5a82012-03-01 05:57:03 -080045
46_DEFAULT_LOG_DIR = 'cbuildbot_logs'
47_BUILDBOT_LOG_FILE = 'cbuildbot.log'
48_DEFAULT_EXT_BUILDROOT = 'trybot'
49_DEFAULT_INT_BUILDROOT = 'trybot-internal'
Brian Harring3fec5a82012-03-01 05:57:03 -080050_DISTRIBUTED_TYPES = [constants.COMMIT_QUEUE_TYPE, constants.PFQ_TYPE,
51 constants.CANARY_TYPE, constants.CHROME_PFQ_TYPE,
52 constants.PALADIN_TYPE]
Brian Harring351ce442012-03-09 16:38:14 -080053_BUILDBOT_REQUIRED_BINARIES = ('pbzip2',)
Brian Harring3fec5a82012-03-01 05:57:03 -080054
55
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070056def _PrintValidConfigs(display_all=False):
Brian Harring3fec5a82012-03-01 05:57:03 -080057 """Print a list of valid buildbot configs.
58
59 Arguments:
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070060 display_all: Print all configs. Otherwise, prints only configs with
61 trybot_list=True.
Brian Harring3fec5a82012-03-01 05:57:03 -080062 """
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070063 def _GetSortKey(config_name):
64 config_dict = cbuildbot_config.config[config_name]
65 return (not config_dict['trybot_list'], config_dict['description'],
66 config_name)
67
Brian Harring3fec5a82012-03-01 05:57:03 -080068 COLUMN_WIDTH = 45
69 print 'config'.ljust(COLUMN_WIDTH), 'description'
70 print '------'.ljust(COLUMN_WIDTH), '-----------'
71 config_names = cbuildbot_config.config.keys()
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070072 config_names.sort(key=_GetSortKey)
Brian Harring3fec5a82012-03-01 05:57:03 -080073 for name in config_names:
Ryan Cui4f6cf7e2012-04-18 16:12:27 -070074 if display_all or cbuildbot_config.config[name]['trybot_list']:
75 desc = cbuildbot_config.config[name].get('description')
76 desc = desc if desc else ''
Brian Harring3fec5a82012-03-01 05:57:03 -080077 print name.ljust(COLUMN_WIDTH), desc
78
79
80def _GetConfig(config_name):
81 """Gets the configuration for the build"""
82 if not cbuildbot_config.config.has_key(config_name):
83 print 'Non-existent configuration %s specified.' % config_name
84 print 'Please specify one of:'
85 _PrintValidConfigs()
86 sys.exit(1)
87
88 result = cbuildbot_config.config[config_name]
89
90 return result
91
92
Ryan Cuie1e4e662012-05-21 16:39:46 -070093def AcquirePoolFromOptions(options):
Ryan Cui16d9e1f2012-05-11 10:50:18 -070094 """Generate patch objects from passed in options.
Brian Harring3fec5a82012-03-01 05:57:03 -080095
96 Args:
Ryan Cui16d9e1f2012-05-11 10:50:18 -070097 options: The options object generated by optparse.
Brian Harring3fec5a82012-03-01 05:57:03 -080098
Ryan Cuif7f24692012-05-18 16:35:33 -070099 Returns:
100 trybot_patch_pool.TrybotPatchPool object.
101
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700102 Raises:
Brian Harring511055e2012-10-10 02:58:59 -0700103 gerrit.GerritException, cros_patch.PatchException
Brian Harring3fec5a82012-03-01 05:57:03 -0800104 """
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700105 gerrit_patches = []
106 local_patches = []
107 remote_patches = []
Brian Harring3fec5a82012-03-01 05:57:03 -0800108
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700109 if options.gerrit_patches:
Brian Harring511055e2012-10-10 02:58:59 -0700110 gerrit_patches = gerrit.GetGerritPatchInfo(
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700111 options.gerrit_patches)
112 for patch in gerrit_patches:
113 if patch.IsAlreadyMerged():
Brian Harring1b8c4c82012-05-29 23:03:04 -0700114 cros_build_lib.Warning('Patch %s has already been merged.' % str(patch))
Brian Harring3fec5a82012-03-01 05:57:03 -0800115
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700116 if options.local_patches:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700117 manifest = cros_build_lib.ManifestCheckout.Cached(options.sourceroot)
Brian Harring609dc4e2012-05-07 02:17:44 -0700118 local_patches = cros_patch.PrepareLocalPatches(manifest,
119 options.local_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800120
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700121 if options.remote_patches:
122 remote_patches = cros_patch.PrepareRemotePatches(
123 options.remote_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800124
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700125 return trybot_patch_pool.TrybotPatchPool(gerrit_patches, local_patches,
126 remote_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800127
128
Brian Harring3fec5a82012-03-01 05:57:03 -0800129class Builder(object):
130 """Parent class for all builder types.
131
132 This class functions as a parent class for various build types. It's intended
133 use is builder_instance.Run().
134
135 Vars:
Brian Harring3fec5a82012-03-01 05:57:03 -0800136 build_config: The configuration dictionary from cbuildbot_config.
137 options: The options provided from optparse in main().
Ryan Cui5616a512012-08-17 13:39:36 -0700138 archive_urls: Where our artifacts for this builder will be archived.
Brian Harring3fec5a82012-03-01 05:57:03 -0800139 release_tag: The associated "chrome os version" of this build.
Brian Harring3fec5a82012-03-01 05:57:03 -0800140 """
141
Ryan Cuie1e4e662012-05-21 16:39:46 -0700142 def __init__(self, options, build_config):
Brian Harring3fec5a82012-03-01 05:57:03 -0800143 """Initializes instance variables. Must be called by all subclasses."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800144 self.build_config = build_config
145 self.options = options
146
147 # TODO, Remove here and in config after bug chromium-os:14649 is fixed.
148 if self.build_config['chromeos_official']:
149 os.environ['CHROMEOS_OFFICIAL'] = '1'
150
David James58e0c092012-03-04 20:31:12 -0800151 self.archive_stages = {}
Brian Harring3fec5a82012-03-01 05:57:03 -0800152 self.archive_urls = {}
153 self.release_tag = None
Brian Harring76d1bf62012-06-01 13:52:48 -0700154 self.patch_pool = trybot_patch_pool.TrybotPatchPool()
Brian Harring3fec5a82012-03-01 05:57:03 -0800155
Ryan Cuie1e4e662012-05-21 16:39:46 -0700156 bs.BuilderStage.SetManifestBranch(self.options.branch)
Ryan Cuif7f24692012-05-18 16:35:33 -0700157
Brian Harring3fec5a82012-03-01 05:57:03 -0800158 def Initialize(self):
159 """Runs through the initialization steps of an actual build."""
Ryan Cuif7f24692012-05-18 16:35:33 -0700160 if self.options.resume:
161 results_lib.LoadCheckpoint(self.options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800162
Brian Harring3fec5a82012-03-01 05:57:03 -0800163 self._RunStage(stages.CleanUpStage)
164
165 def _GetStageInstance(self, stage, *args, **kwargs):
166 """Helper function to get an instance given the args.
167
David James944a48e2012-03-07 12:19:03 -0800168 Useful as almost all stages just take in options and build_config.
Brian Harring3fec5a82012-03-01 05:57:03 -0800169 """
David James944a48e2012-03-07 12:19:03 -0800170 config = kwargs.pop('config', self.build_config)
171 return stage(self.options, config, *args, **kwargs)
Brian Harring3fec5a82012-03-01 05:57:03 -0800172
173 def _SetReleaseTag(self):
174 """Sets the release tag from the manifest_manager.
175
176 Must be run after sync stage as syncing enables us to have a release tag.
177 """
178 # Extract version we have decided to build into self.release_tag.
179 manifest_manager = stages.ManifestVersionedSyncStage.manifest_manager
180 if manifest_manager:
181 self.release_tag = manifest_manager.current_version
182
183 def _RunStage(self, stage, *args, **kwargs):
184 """Wrapper to run a stage."""
185 stage_instance = self._GetStageInstance(stage, *args, **kwargs)
186 return stage_instance.Run()
187
188 def GetSyncInstance(self):
189 """Returns an instance of a SyncStage that should be run.
190
191 Subclasses must override this method.
192 """
193 raise NotImplementedError()
194
195 def RunStages(self):
196 """Subclasses must override this method. Runs the appropriate code."""
197 raise NotImplementedError()
198
Brian Harring3fec5a82012-03-01 05:57:03 -0800199 def _ShouldReExecuteInBuildRoot(self):
200 """Returns True if this build should be re-executed in the buildroot."""
201 abs_buildroot = os.path.abspath(self.options.buildroot)
202 return not os.path.abspath(__file__).startswith(abs_buildroot)
203
204 def _ReExecuteInBuildroot(self, sync_instance):
205 """Reexecutes self in buildroot and returns True if build succeeds.
206
207 This allows the buildbot code to test itself when changes are patched for
208 buildbot-related code. This is a no-op if the buildroot == buildroot
209 of the running chromite checkout.
210
211 Args:
212 sync_instance: Instance of the sync stage that was run to sync.
213
214 Returns:
215 True if the Build succeeded.
216 """
Brian Harring3fec5a82012-03-01 05:57:03 -0800217 if not self.options.resume:
Ryan Cuif7f24692012-05-18 16:35:33 -0700218 results_lib.WriteCheckpoint(self.options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800219
Ryan Cui724f1d32012-10-15 18:10:22 -0700220 _, minor = cros_build_lib.GetTargetChromiteApiVersion(
221 self.options.buildroot)
Brian Harring37e559b2012-05-22 20:47:32 -0700222
Brian Harring3fec5a82012-03-01 05:57:03 -0800223 # Re-write paths to use absolute paths.
224 # Suppress any timeout options given from the commandline in the
225 # invoked cbuildbot; our timeout will enforce it instead.
Brian Harringf11bf682012-05-14 15:53:43 -0700226 args_to_append = ['--resume', '--timeout', '0', '--notee', '--nocgroups',
227 '--buildroot', os.path.abspath(self.options.buildroot)]
Brian Harring3fec5a82012-03-01 05:57:03 -0800228
Brian Harringae0a5322012-09-15 01:46:51 -0700229 if minor >= 2:
230 args_to_append += ['--cache-dir', self.options.cache_dir]
231
Brian Harring3fec5a82012-03-01 05:57:03 -0800232 if self.options.chrome_root:
233 args_to_append += ['--chrome_root',
234 os.path.abspath(self.options.chrome_root)]
235
236 if stages.ManifestVersionedSyncStage.manifest_manager:
237 ver = stages.ManifestVersionedSyncStage.manifest_manager.current_version
238 args_to_append += ['--version', ver]
239
240 if isinstance(sync_instance, stages.CommitQueueSyncStage):
241 vp_file = sync_instance.SaveValidationPool()
242 args_to_append += ['--validation_pool', vp_file]
243
244 # Re-run the command in the buildroot.
245 # Finally, be generous and give the invoked cbuildbot 30s to shutdown
246 # when something occurs. It should exit quicker, but the sigterm may
247 # hit while the system is particularly busy.
Brian Harring1b8c4c82012-05-29 23:03:04 -0700248 return_obj = cros_build_lib.RunCommand(
Ryan Cuif7f24692012-05-18 16:35:33 -0700249 [constants.PATH_TO_CBUILDBOT] + sys.argv[1:] + args_to_append,
Brian Harring3fec5a82012-03-01 05:57:03 -0800250 cwd=self.options.buildroot, error_code_ok=True, kill_timeout=30)
251 return return_obj.returncode == 0
252
Ryan Cuif7f24692012-05-18 16:35:33 -0700253 def _InitializeTrybotPatchPool(self):
254 """Generate patch pool from patches specified on the command line.
255
256 Do this only if we need to patch changes later on.
257 """
258 changes_stage = stages.PatchChangesStage.StageNamePrefix()
259 check_func = results_lib.Results.PreviouslyCompletedRecord
260 if not check_func(changes_stage) or self.options.bootstrap:
Ryan Cuie1e4e662012-05-21 16:39:46 -0700261 self.patch_pool = AcquirePoolFromOptions(self.options)
Ryan Cuif7f24692012-05-18 16:35:33 -0700262
263 def _GetBootstrapStage(self):
264 """Constructs and returns the BootStrapStage object.
265
266 We return None when there are no chromite patches to test, and
267 --test-bootstrap wasn't passed in.
268 """
269 stage = None
270 chromite_pool = self.patch_pool.Filter(project=constants.CHROMITE_PROJECT)
Ryan Cui5616a512012-08-17 13:39:36 -0700271 manifest_pool = self.patch_pool.FilterManifest()
Chris Sosa126103a2012-06-18 09:03:17 -0700272 chromite_branch = cros_build_lib.GetChromiteTrackingBranch()
Ryan Cui5616a512012-08-17 13:39:36 -0700273 if (chromite_pool or manifest_pool or self.options.test_bootstrap
Ryan Cuie1e4e662012-05-21 16:39:46 -0700274 or chromite_branch != self.options.branch):
Ryan Cuif7f24692012-05-18 16:35:33 -0700275 stage = stages.BootstrapStage(self.options, self.build_config,
Ryan Cui5616a512012-08-17 13:39:36 -0700276 chromite_pool, manifest_pool)
Ryan Cuif7f24692012-05-18 16:35:33 -0700277 return stage
278
Brian Harring3fec5a82012-03-01 05:57:03 -0800279 def Run(self):
Ryan Cuif7f24692012-05-18 16:35:33 -0700280 """Main runner for this builder class. Runs build and prints summary.
281
282 Returns:
283 Whether the build succeeded.
284 """
285 self._InitializeTrybotPatchPool()
286
287 if self.options.bootstrap:
288 bootstrap_stage = self._GetBootstrapStage()
289 if bootstrap_stage:
290 # BootstrapStage blocks on re-execution of cbuildbot.
291 bootstrap_stage.Run()
292 return bootstrap_stage.returncode == 0
293
Brian Harring3fec5a82012-03-01 05:57:03 -0800294 print_report = True
David James3d4d3502012-04-09 15:12:06 -0700295 exception_thrown = False
Brian Harring3fec5a82012-03-01 05:57:03 -0800296 success = True
297 try:
298 self.Initialize()
299 sync_instance = self.GetSyncInstance()
300 sync_instance.Run()
301 self._SetReleaseTag()
302
Ryan Cui967f7cc2012-08-17 13:01:12 -0700303 # Filter out patches to manifest, since PatchChangesStage can't handle
304 # them. Manifest patches are patched in the BootstrapStage.
305 non_manifest_patches = self.patch_pool.FilterManifest(negate=True)
306 if non_manifest_patches:
307 self._RunStage(stages.PatchChangesStage, non_manifest_patches)
Brian Harring3fec5a82012-03-01 05:57:03 -0800308
309 if self._ShouldReExecuteInBuildRoot():
310 print_report = False
311 success = self._ReExecuteInBuildroot(sync_instance)
312 else:
313 self.RunStages()
David James7fbf2d42012-07-14 18:23:49 -0700314 except results_lib.StepFailure:
315 # StepFailure exceptions are already recorded in the report, so there
316 # is no need to print these tracebacks twice.
317 exception_thrown = True
318 if not print_report:
319 raise
David James3d4d3502012-04-09 15:12:06 -0700320 except Exception:
321 exception_thrown = True
322 raise
Brian Harring3fec5a82012-03-01 05:57:03 -0800323 finally:
324 if print_report:
Ryan Cuif7f24692012-05-18 16:35:33 -0700325 results_lib.WriteCheckpoint(self.options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800326 print '\n\n\n@@@BUILD_STEP Report@@@\n'
327 results_lib.Results.Report(sys.stdout, self.archive_urls,
328 self.release_tag)
329 success = results_lib.Results.BuildSucceededSoFar()
David James3d4d3502012-04-09 15:12:06 -0700330 if exception_thrown and success:
331 success = False
David Jamesbb20ac82012-07-18 10:59:16 -0700332 cros_build_lib.PrintBuildbotStepWarnings()
333 print """\
David James3d4d3502012-04-09 15:12:06 -0700334Exception thrown, but all stages marked successful. This is an internal error,
335because the stage that threw the exception should be marked as failing."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800336
337 return success
338
339
340class SimpleBuilder(Builder):
341 """Builder that performs basic vetting operations."""
342
343 def GetSyncInstance(self):
344 """Sync to lkgm or TOT as necessary.
345
346 Returns: the instance of the sync stage that was run.
347 """
348 if self.options.lkgm or self.build_config['use_lkgm']:
349 sync_stage = self._GetStageInstance(stages.LKGMSyncStage)
350 else:
351 sync_stage = self._GetStageInstance(stages.SyncStage)
352
353 return sync_stage
354
David James58e0c092012-03-04 20:31:12 -0800355 def _RunBackgroundStagesForBoard(self, board):
356 """Run background board-specific stages for the specified board."""
David James58e0c092012-03-04 20:31:12 -0800357 archive_stage = self.archive_stages[board]
David James944a48e2012-03-07 12:19:03 -0800358 configs = self.build_config['board_specific_configs']
359 config = configs.get(board, self.build_config)
360 stage_list = [[stages.VMTestStage, board, archive_stage],
361 [stages.ChromeTestStage, board, archive_stage],
Mike Frysinger5e20ec42012-09-28 23:39:56 -0400362 [stages.SignerTestStage, board, archive_stage],
David James944a48e2012-03-07 12:19:03 -0800363 [stages.UnitTestStage, board],
Chris Sosa6a5dceb2012-05-14 13:48:56 -0700364 [stages.UploadPrebuiltsStage, board, archive_stage]]
Brian Harring3fec5a82012-03-01 05:57:03 -0800365
David James58e0c092012-03-04 20:31:12 -0800366 # We can not run hw tests without archiving the payloads.
367 if self.options.archive:
David James944a48e2012-03-07 12:19:03 -0800368 for suite in config['hw_tests']:
Peter Mayo85e94372012-08-17 12:42:14 -0400369 stage_list.append([stages.HWTestStage, board, archive_stage, suite])
Chris Sosab50dc932012-03-01 14:00:58 -0800370
Chris Sosa817b1f92012-07-19 15:00:23 -0700371 for suite in config['async_hw_tests']:
372 stage_list.append([stages.ASyncHWTestStage, board, archive_stage,
373 suite])
374
David James944a48e2012-03-07 12:19:03 -0800375 steps = [self._GetStageInstance(*x, config=config).Run for x in stage_list]
376 background.RunParallelSteps(steps + [archive_stage.Run])
Brian Harring3fec5a82012-03-01 05:57:03 -0800377
378 def RunStages(self):
379 """Runs through build process."""
380 self._RunStage(stages.BuildBoardStage)
381
382 # TODO(sosa): Split these out into classes.
Brian Harring3fec5a82012-03-01 05:57:03 -0800383 if self.build_config['build_type'] == constants.CHROOT_BUILDER_TYPE:
Zdenek Behan62a57792012-08-31 15:09:08 +0200384 self._RunStage(stages.SDKPackageStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800385 self._RunStage(stages.SDKTestStage)
386 self._RunStage(stages.UploadPrebuiltsStage,
Chris Sosa6a5dceb2012-05-14 13:48:56 -0700387 constants.CHROOT_BUILDER_BOARD, None)
Brian Harring3fec5a82012-03-01 05:57:03 -0800388 elif self.build_config['build_type'] == constants.REFRESH_PACKAGES_TYPE:
389 self._RunStage(stages.RefreshPackageStatusStage)
390 else:
391 self._RunStage(stages.UprevStage)
Brian Harring3fec5a82012-03-01 05:57:03 -0800392
David James944a48e2012-03-07 12:19:03 -0800393 configs = self.build_config['board_specific_configs']
David James58e0c092012-03-04 20:31:12 -0800394 for board in self.build_config['boards']:
David James944a48e2012-03-07 12:19:03 -0800395 config = configs.get(board, self.build_config)
396 archive_stage = self._GetStageInstance(stages.ArchiveStage, board,
397 config=config)
David James58e0c092012-03-04 20:31:12 -0800398 self.archive_stages[board] = archive_stage
399
David James944a48e2012-03-07 12:19:03 -0800400 # Set up a process pool to run test/archive stages in the background.
401 # This process runs task(board) for each board added to the queue.
David James58e0c092012-03-04 20:31:12 -0800402 queue = multiprocessing.Queue()
403 task = self._RunBackgroundStagesForBoard
404 with background.BackgroundTaskRunner(queue, task):
David James944a48e2012-03-07 12:19:03 -0800405 for board in self.build_config['boards']:
David James58e0c092012-03-04 20:31:12 -0800406 # Run BuildTarget in the foreground.
David James944a48e2012-03-07 12:19:03 -0800407 archive_stage = self.archive_stages[board]
408 config = configs.get(board, self.build_config)
409 self._RunStage(stages.BuildTargetStage, board, archive_stage,
Chris Sosa1a87b3e2012-04-12 13:20:42 -0700410 self.release_tag, config=config)
David James58e0c092012-03-04 20:31:12 -0800411 self.archive_urls[board] = archive_stage.GetDownloadUrl()
412
David James944a48e2012-03-07 12:19:03 -0800413 # Kick off task(board) in the background.
David James58e0c092012-03-04 20:31:12 -0800414 queue.put([board])
415
Brian Harring3fec5a82012-03-01 05:57:03 -0800416
417class DistributedBuilder(SimpleBuilder):
418 """Build class that has special logic to handle distributed builds.
419
420 These builds sync using git/manifest logic in manifest_versions. In general
421 they use a non-distributed builder code for the bulk of the work.
422 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700423 def __init__(self, *args, **kwargs):
Brian Harring3fec5a82012-03-01 05:57:03 -0800424 """Initializes a buildbot builder.
425
426 Extra variables:
427 completion_stage_class: Stage used to complete a build. Set in the Sync
428 stage.
429 """
Ryan Cuif7f24692012-05-18 16:35:33 -0700430 super(DistributedBuilder, self).__init__(*args, **kwargs)
Brian Harring3fec5a82012-03-01 05:57:03 -0800431 self.completion_stage_class = None
432
433 def GetSyncInstance(self):
434 """Syncs the tree using one of the distributed sync logic paths.
435
436 Returns: the instance of the sync stage that was run.
437 """
438 # Determine sync class to use. CQ overrides PFQ bits so should check it
439 # first.
440 if cbuildbot_config.IsCQType(self.build_config['build_type']):
441 sync_stage = self._GetStageInstance(stages.CommitQueueSyncStage)
442 self.completion_stage_class = stages.CommitQueueCompletionStage
443 elif cbuildbot_config.IsPFQType(self.build_config['build_type']):
444 sync_stage = self._GetStageInstance(stages.LKGMCandidateSyncStage)
445 self.completion_stage_class = stages.LKGMCandidateSyncCompletionStage
446 else:
447 sync_stage = self._GetStageInstance(stages.ManifestVersionedSyncStage)
448 self.completion_stage_class = stages.ManifestVersionedSyncCompletionStage
449
450 return sync_stage
451
452 def Publish(self, was_build_successful):
453 """Completes build by publishing any required information."""
454 completion_stage = self._GetStageInstance(self.completion_stage_class,
455 was_build_successful)
456 completion_stage.Run()
457 name = completion_stage.name
458 if not results_lib.Results.WasStageSuccessful(name):
459 should_publish_changes = False
460 else:
461 should_publish_changes = (self.build_config['master'] and
462 was_build_successful)
463
464 if should_publish_changes:
465 self._RunStage(stages.PublishUprevChangesStage)
466
467 def RunStages(self):
468 """Runs simple builder logic and publishes information to overlays."""
469 was_build_successful = False
470 try:
David Jamesf55709e2012-03-13 09:10:15 -0700471 super(DistributedBuilder, self).RunStages()
472 was_build_successful = results_lib.Results.BuildSucceededSoFar()
Brian Harring3fec5a82012-03-01 05:57:03 -0800473 except SystemExit as ex:
474 # If a stage calls sys.exit(0), it's exiting with success, so that means
475 # we should mark ourselves as successful.
476 if ex.code == 0:
477 was_build_successful = True
478 raise
479 finally:
480 self.Publish(was_build_successful)
481
Brian Harring3fec5a82012-03-01 05:57:03 -0800482
483def _ConfirmBuildRoot(buildroot):
484 """Confirm with user the inferred buildroot, and mark it as confirmed."""
485 warning = 'Using default directory %s as buildroot' % buildroot
Brian Harring1b8c4c82012-05-29 23:03:04 -0700486 response = cros_build_lib.YesNoPrompt(
487 default=cros_build_lib.NO, warning=warning, full=True)
488 if response == cros_build_lib.NO:
Brian Harring3fec5a82012-03-01 05:57:03 -0800489 print('Please specify a buildroot with the --buildroot option.')
490 sys.exit(0)
491
492 if not os.path.exists(buildroot):
493 os.mkdir(buildroot)
494
495 repository.CreateTrybotMarker(buildroot)
496
497
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700498def _ConfirmRemoteBuildbotRun():
499 """Confirm user wants to run with --buildbot --remote."""
500 warning = ('You are about to launch a PRODUCTION job! This is *NOT* a '
501 'trybot run! Are you sure?')
Brian Harring1b8c4c82012-05-29 23:03:04 -0700502 response = cros_build_lib.YesNoPrompt(
503 default=cros_build_lib.NO, warning=warning, full=True)
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700504
Brian Harring1b8c4c82012-05-29 23:03:04 -0700505 if response == cros_build_lib.NO:
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700506 print('Please specify --pass-through="--debug".')
507 sys.exit(0)
508
509
Ryan Cui5ba7e152012-05-10 14:36:52 -0700510def _DetermineDefaultBuildRoot(sourceroot, internal_build):
Brian Harring3fec5a82012-03-01 05:57:03 -0800511 """Default buildroot to be under the directory that contains current checkout.
512
513 Arguments:
514 internal_build: Whether the build is an internal build
Ryan Cui5ba7e152012-05-10 14:36:52 -0700515 sourceroot: Use specified sourceroot.
Brian Harring3fec5a82012-03-01 05:57:03 -0800516 """
Ryan Cui5ba7e152012-05-10 14:36:52 -0700517 if not repository.IsARepoRoot(sourceroot):
Brian Harring1b8c4c82012-05-29 23:03:04 -0700518 cros_build_lib.Die(
519 'Could not find root of local checkout at %s. Please specify '
520 'using the --sourceroot option.' % sourceroot)
Brian Harring3fec5a82012-03-01 05:57:03 -0800521
522 # Place trybot buildroot under the directory containing current checkout.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700523 top_level = os.path.dirname(os.path.realpath(sourceroot))
Brian Harring3fec5a82012-03-01 05:57:03 -0800524 if internal_build:
525 buildroot = os.path.join(top_level, _DEFAULT_INT_BUILDROOT)
526 else:
527 buildroot = os.path.join(top_level, _DEFAULT_EXT_BUILDROOT)
528
529 return buildroot
530
531
532def _BackupPreviousLog(log_file, backup_limit=25):
533 """Rename previous log.
534
535 Args:
536 log_file: The absolute path to the previous log.
537 """
538 if os.path.exists(log_file):
539 old_logs = sorted(glob.glob(log_file + '.*'),
540 key=distutils.version.LooseVersion)
541
542 if len(old_logs) >= backup_limit:
543 os.remove(old_logs[0])
544
545 last = 0
546 if old_logs:
547 last = int(old_logs.pop().rpartition('.')[2])
548
549 os.rename(log_file, log_file + '.' + str(last + 1))
550
Ryan Cui5616a512012-08-17 13:39:36 -0700551
David James944a48e2012-03-07 12:19:03 -0800552def _RunBuildStagesWrapper(options, build_config):
Brian Harring3fec5a82012-03-01 05:57:03 -0800553 """Helper function that wraps RunBuildStages()."""
554 def IsDistributedBuilder():
555 """Determines whether the build_config should be a DistributedBuilder."""
556 if not options.buildbot:
557 return False
558 elif build_config['build_type'] in _DISTRIBUTED_TYPES:
559 chrome_rev = build_config['chrome_rev']
560 if options.chrome_rev: chrome_rev = options.chrome_rev
561 # We don't do distributed logic to TOT Chrome PFQ's, nor local
562 # chrome roots (e.g. chrome try bots)
563 if chrome_rev not in [constants.CHROME_REV_TOT,
564 constants.CHROME_REV_LOCAL,
565 constants.CHROME_REV_SPEC]:
566 return True
567
568 return False
569
Brian Harring1b8c4c82012-05-29 23:03:04 -0700570 cros_build_lib.Info("cbuildbot executed with args %s"
571 % ' '.join(map(repr, sys.argv)))
Brian Harring3fec5a82012-03-01 05:57:03 -0800572
Ryan Cuif7f24692012-05-18 16:35:33 -0700573 target = DistributedBuilder if IsDistributedBuilder() else SimpleBuilder
Ryan Cuie1e4e662012-05-21 16:39:46 -0700574 buildbot = target(options, build_config)
Brian Harringd166aaf2012-05-14 18:31:53 -0700575 if not buildbot.Run():
576 sys.exit(1)
Brian Harring3fec5a82012-03-01 05:57:03 -0800577
578
579# Parser related functions
Ryan Cui5ba7e152012-05-10 14:36:52 -0700580def _CheckLocalPatches(sourceroot, local_patches):
Brian Harring3fec5a82012-03-01 05:57:03 -0800581 """Do an early quick check of the passed-in patches.
582
583 If the branch of a project is not specified we append the current branch the
584 project is on.
Ryan Cui5ba7e152012-05-10 14:36:52 -0700585
586 Args:
587 sourceroot: The checkout where patches are coming from.
Brian Harring3fec5a82012-03-01 05:57:03 -0800588 """
Ryan Cuicedd8a52012-03-22 02:28:35 -0700589 verified_patches = []
Brian Harring1b8c4c82012-05-29 23:03:04 -0700590 manifest = cros_build_lib.ManifestCheckout.Cached(sourceroot)
Ryan Cuicedd8a52012-03-22 02:28:35 -0700591 for patch in local_patches:
Brian Harring3fec5a82012-03-01 05:57:03 -0800592 components = patch.split(':')
593 if len(components) > 2:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700594 cros_build_lib.Die(
595 'Specify local patches in project[:branch] format. Got %s' % patch)
Brian Harring3fec5a82012-03-01 05:57:03 -0800596
597 # validate project
598 project = components[0]
Brian Harring3fec5a82012-03-01 05:57:03 -0800599
Brian Harring609dc4e2012-05-07 02:17:44 -0700600 try:
601 project_dir = manifest.GetProjectPath(project, True)
602 except KeyError:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700603 cros_build_lib.Die('Project %s does not exist.' % project)
Brian Harring3fec5a82012-03-01 05:57:03 -0800604
605 # If no branch was specified, we use the project's current branch.
606 if len(components) == 1:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700607 branch = cros_build_lib.GetCurrentBranch(project_dir)
Brian Harring3fec5a82012-03-01 05:57:03 -0800608 if not branch:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700609 cros_build_lib.Die('Project %s is not on a branch!' % project)
Brian Harring3fec5a82012-03-01 05:57:03 -0800610 else:
611 branch = components[1]
Brian Harring1b8c4c82012-05-29 23:03:04 -0700612 if not cros_build_lib.DoesLocalBranchExist(project_dir, branch):
613 cros_build_lib.Die('Project %s does not have branch %s'
614 % (project, branch))
Brian Harring3fec5a82012-03-01 05:57:03 -0800615
Brian Harring609dc4e2012-05-07 02:17:44 -0700616 verified_patches.append('%s:%s' % (project, branch))
Brian Harring3fec5a82012-03-01 05:57:03 -0800617
Ryan Cuicedd8a52012-03-22 02:28:35 -0700618 return verified_patches
Brian Harring3fec5a82012-03-01 05:57:03 -0800619
620
Brian Harring3fec5a82012-03-01 05:57:03 -0800621def _CheckChromeVersionOption(_option, _opt_str, value, parser):
622 """Upgrade other options based on chrome_version being passed."""
623 value = value.strip()
624
625 if parser.values.chrome_rev is None and value:
626 parser.values.chrome_rev = constants.CHROME_REV_SPEC
627
628 parser.values.chrome_version = value
629
630
631def _CheckChromeRootOption(_option, _opt_str, value, parser):
632 """Validate and convert chrome_root to full-path form."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800633 if parser.values.chrome_rev is None:
634 parser.values.chrome_rev = constants.CHROME_REV_LOCAL
635
Ryan Cui5ba7e152012-05-10 14:36:52 -0700636 parser.values.chrome_root = value
Brian Harring3fec5a82012-03-01 05:57:03 -0800637
638
639def _CheckChromeRevOption(_option, _opt_str, value, parser):
640 """Validate the chrome_rev option."""
641 value = value.strip()
642 if value not in constants.VALID_CHROME_REVISIONS:
643 raise optparse.OptionValueError('Invalid chrome rev specified')
644
645 parser.values.chrome_rev = value
646
647
Brian Harringfec89fe2012-09-23 07:30:54 -0700648def _CheckGerritChromeOption(_option, _opt_str, _value, parser):
Ryan Cuif37608e2012-07-10 14:28:48 -0700649 """Validate the chrome_rev option."""
650 if parser.values.chrome_rev is None:
651 parser.values.chrome_rev = constants.CHROME_REV_TOT
652
653 parser.values.gerrit_chrome = True
654
655
Brian Harringae0a5322012-09-15 01:46:51 -0700656def FindCacheDir(parser, options):
657 if constants.SHARED_CACHE_ENVVAR in os.environ:
658 return commandline.OptionParser.FindCacheDir(parser, options)
659 return None
660
661
Ryan Cui5ba7e152012-05-10 14:36:52 -0700662class CustomGroup(optparse.OptionGroup):
663 def add_remote_option(self, *args, **kwargs):
664 """For arguments that are passed-through to remote trybot."""
665 return optparse.OptionGroup.add_option(self, *args,
666 remote_pass_through=True,
667 **kwargs)
668
669
Brian Harringb6cf9142012-09-01 20:43:17 -0700670class CustomOption(commandline.Option):
671 """Subclass Option class to implement pass-through."""
Ryan Cui5ba7e152012-05-10 14:36:52 -0700672
Brian Harringb6cf9142012-09-01 20:43:17 -0700673 ACTIONS = commandline.Option.ACTIONS + ('extend',)
674 STORE_ACTIONS = commandline.Option.STORE_ACTIONS + ('extend',)
675 TYPED_ACTIONS = commandline.Option.TYPED_ACTIONS + ('extend',)
676 ALWAYS_TYPED_ACTIONS = commandline.Option.ALWAYS_TYPED_ACTIONS + ('extend',)
Ryan Cui79319ab2012-05-21 12:59:18 -0700677
Ryan Cui5ba7e152012-05-10 14:36:52 -0700678 def __init__(self, *args, **kwargs):
679 # The remote_pass_through argument specifies whether we should directly
680 # pass the argument (with its value) onto the remote trybot.
681 self.pass_through = kwargs.pop('remote_pass_through', False)
Brian Harringb6cf9142012-09-01 20:43:17 -0700682 commandline.Option.__init__(self, *args, **kwargs)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700683
684 def take_action(self, action, dest, opt, value, values, parser):
Ryan Cui79319ab2012-05-21 12:59:18 -0700685 if action == 'extend':
Mike Frysingerd6925b52012-07-16 16:11:00 -0400686 # If there is extra spaces between each argument, we get '' which later
687 # code barfs on, so skip those. e.g. We see this with the forms:
688 # cbuildbot -p 'proj:branch ' ...
689 # cbuildbot -p ' proj:branch' ...
690 # cbuildbot -p 'proj:branch proj2:branch' ...
691 lvalue = value.split()
Ryan Cui79319ab2012-05-21 12:59:18 -0700692 values.ensure_value(dest, []).extend(lvalue)
693 else:
694 optparse.Option.take_action(self, action, dest, opt, value, values,
695 parser)
696
Ryan Cui5ba7e152012-05-10 14:36:52 -0700697 if self.pass_through:
698 parser.values.pass_through_args.append(opt)
699 if self.nargs and self.nargs > 1:
700 # value is a tuple if nargs > 1
701 string_list = [str(val) for val in list(value)]
702 parser.values.pass_through_args.extend(string_list)
703 elif value:
704 parser.values.pass_through_args.append(str(value))
705
706
Brian Harringb6cf9142012-09-01 20:43:17 -0700707class CustomParser(commandline.OptionParser):
708
709 DEFAULT_OPTION_CLASS = CustomOption
710
711 def add_remote_option(self, *args, **kwargs):
712 """For arguments that are passed-through to remote trybot."""
713 return commandline.OptionParser.add_option(self, *args,
714 remote_pass_through=True,
715 **kwargs)
716
717
Brian Harring3fec5a82012-03-01 05:57:03 -0800718def _CreateParser():
Ryan Cui16d9e1f2012-05-11 10:50:18 -0700719 """Generate and return the parser with all the options."""
Brian Harring3fec5a82012-03-01 05:57:03 -0800720 # Parse options
721 usage = "usage: %prog [options] buildbot_config"
Brian Harringae0a5322012-09-15 01:46:51 -0700722 parser = CustomParser(usage=usage, caching=FindCacheDir)
Brian Harring3fec5a82012-03-01 05:57:03 -0800723
724 # Main options
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700725 # The remote_pass_through parameter to add_option is implemented by the
726 # CustomOption class. See CustomOption for more information.
Brian Harring3fec5a82012-03-01 05:57:03 -0800727 parser.add_option('-a', '--all', action='store_true', dest='print_all',
728 default=False,
729 help=('List all of the buildbot configs available. Use '
730 'with the --list option'))
Ryan Cuie1e4e662012-05-21 16:39:46 -0700731 parser.add_remote_option('-b', '--branch',
732 help='The manifest branch to test. The branch to '
733 'check the buildroot out to.')
Ryan Cui5ba7e152012-05-10 14:36:52 -0700734 parser.add_option('-r', '--buildroot', dest='buildroot', type='path',
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700735 help='Root directory where source is checked out to, and '
736 'where the build occurs. For external build configs, '
737 "defaults to 'trybot' directory at top level of your "
738 'repo-managed checkout.')
739 parser.add_remote_option('--chrome_rev', default=None, type='string',
740 action='callback', dest='chrome_rev',
741 callback=_CheckChromeRevOption,
742 help=('Revision of Chrome to use, of type [%s]'
743 % '|'.join(constants.VALID_CHROME_REVISIONS)))
Ryan Cui79319ab2012-05-21 12:59:18 -0700744 parser.add_remote_option('-g', '--gerrit-patches', action='extend',
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700745 default=[], type='string',
746 metavar="'Id1 *int_Id2...IdN'",
747 help=("Space-separated list of short-form Gerrit "
748 "Change-Id's or change numbers to patch. "
749 "Please prepend '*' to internal Change-Id's"))
Brian Harring3fec5a82012-03-01 05:57:03 -0800750 parser.add_option('-l', '--list', action='store_true', dest='list',
751 default=False,
752 help=('List the suggested trybot configs to use. Use '
753 '--all to list all of the available configs.'))
Ryan Cui54da0702012-04-19 18:38:08 -0700754 parser.add_option('--local', default=False, action='store_true',
755 help=('Specifies that this tryjob should be run locally.'))
Ryan Cui79319ab2012-05-21 12:59:18 -0700756 parser.add_option('-p', '--local-patches', action='extend', default=[],
Brian Harring3fec5a82012-03-01 05:57:03 -0800757 metavar="'<project1>[:<branch1>]...<projectN>[:<branchN>]'",
758 help=('Space-separated list of project branches with '
759 'patches to apply. Projects are specified by name. '
760 'If no branch is specified the current branch of the '
761 'project will be used.'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700762 parser.add_remote_option('--profile', default=None, type='string',
763 action='store', dest='profile',
764 help='Name of profile to sub-specify board variant.')
Brian Harring3fec5a82012-03-01 05:57:03 -0800765 parser.add_option('--remote', default=False, action='store_true',
Brian Harring3fec5a82012-03-01 05:57:03 -0800766 help=('Specifies that this tryjob should be run remotely.'))
Brian Harring219a2b82012-07-18 15:30:12 -0700767 parser.add_option('--remote-description', default=None,
768 help=('Attach an optional description to a --remote run '
769 'to make it easier to identify the results when it '
770 'finishes.'))
Brian Harring3fec5a82012-03-01 05:57:03 -0800771
Ryan Cuif4f84be2012-07-09 18:50:41 -0700772 #
Brian Harring3fec5a82012-03-01 05:57:03 -0800773 # Advanced options
Ryan Cuif4f84be2012-07-09 18:50:41 -0700774 #
775
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700776 group = CustomGroup(
Brian Harring3fec5a82012-03-01 05:57:03 -0800777 parser,
778 'Advanced Options',
779 'Caution: use these options at your own risk.')
780
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700781 group.add_remote_option('--buildbot', dest='buildbot', action='store_true',
782 default=False, help='This is running on a buildbot')
783 group.add_remote_option('--buildnumber', help='build number', type='int',
784 default=0)
Ryan Cui5ba7e152012-05-10 14:36:52 -0700785 group.add_option('--chrome_root', default=None, type='path',
786 action='callback', callback=_CheckChromeRootOption,
787 dest='chrome_root', help='Local checkout of Chrome to use.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700788 group.add_remote_option('--chrome_version', default=None, type='string',
789 action='callback', dest='chrome_version',
790 callback=_CheckChromeVersionOption,
791 help='Used with SPEC logic to force a particular SVN '
792 'revision of chrome rather than the latest.')
793 group.add_remote_option('--clobber', action='store_true', dest='clobber',
794 default=False,
795 help='Clears an old checkout before syncing')
Yu-Ju Hong52134292012-06-28 12:50:42 -0700796 group.add_remote_option('--hwtest', dest='hwtest', action='store_true',
797 default=False,
798 help='This adds HW test for remote trybot')
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700799 group.add_remote_option('--lkgm', action='store_true', dest='lkgm',
800 default=False,
801 help='Sync to last known good manifest blessed by '
802 'PFQ')
Ryan Cui5ba7e152012-05-10 14:36:52 -0700803 parser.add_option('--log_dir', dest='log_dir', type='path',
Brian Harring3fec5a82012-03-01 05:57:03 -0800804 help=('Directory where logs are stored.'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700805 group.add_remote_option('--maxarchives', dest='max_archive_builds',
806 default=3, type='int',
807 help="Change the local saved build count limit.")
Ryan Cuibbd3d4b2012-08-17 12:20:37 -0700808 parser.add_remote_option('--manifest-repo-url',
809 help=('Overrides the default manifest repo url.'))
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700810 group.add_remote_option('--noarchive', action='store_false', dest='archive',
811 default=True, help="Don't run archive stage.")
Ryan Cuif7f24692012-05-18 16:35:33 -0700812 group.add_remote_option('--nobootstrap', action='store_false',
813 dest='bootstrap', default=True,
814 help="Don't checkout and run from a standalone "
815 "chromite repo.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700816 group.add_remote_option('--nobuild', action='store_false', dest='build',
817 default=True,
818 help="Don't actually build (for cbuildbot dev)")
819 group.add_remote_option('--noclean', action='store_false', dest='clean',
820 default=True, help="Don't clean the buildroot")
Ryan Cuif7f24692012-05-18 16:35:33 -0700821 group.add_remote_option('--nocgroups', action='store_false', dest='cgroups',
822 default=True,
823 help='Disable cbuildbots usage of cgroups.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700824 group.add_remote_option('--noprebuilts', action='store_false',
825 dest='prebuilts', default=True,
826 help="Don't upload prebuilts.")
827 group.add_remote_option('--nosync', action='store_false', dest='sync',
828 default=True, help="Don't sync before building.")
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700829 group.add_remote_option('--notests', action='store_false', dest='tests',
830 default=True,
831 help='Override values from buildconfig and run no '
832 'tests.')
833 group.add_remote_option('--nouprev', action='store_false', dest='uprev',
834 default=True,
835 help='Override values from buildconfig and never '
836 'uprev.')
Brian Harring3fec5a82012-03-01 05:57:03 -0800837 group.add_option('--reference-repo', action='store', default=None,
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700838 dest='reference_repo',
839 help='Reuse git data stored in an existing repo '
840 'checkout. This can drastically reduce the network '
841 'time spent setting up the trybot checkout. By '
842 "default, if this option isn't given but cbuildbot "
843 'is invoked from a repo checkout, cbuildbot will '
844 'use the repo root.')
Ryan Cuicedd8a52012-03-22 02:28:35 -0700845 group.add_option('--resume', action='store_true', default=False,
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700846 help='Skip stages already successfully completed.')
847 group.add_remote_option('--timeout', action='store', type='int', default=0,
848 help='Specify the maximum amount of time this job '
849 'can run for, at which point the build will be '
850 'aborted. If set to zero, then there is no '
851 'timeout.')
Ryan Cui39bdbbf2012-02-29 16:15:39 -0800852 group.add_option('--test-tryjob', action='store_true',
853 default=False,
854 help='Submit a tryjob to the test repository. Will not '
855 'show up on the production trybot waterfall.')
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700856 group.add_remote_option('--validation_pool', default=None,
857 help='Path to a pickled validation pool. Intended '
858 'for use only with the commit queue.')
859 group.add_remote_option('--version', dest='force_version', default=None,
860 help='Used with manifest logic. Forces use of this '
861 'version rather than create or get latest.')
Brian Harringab8fb5c2012-07-18 11:28:22 -0700862 group.add_remote_option('--cq-gerrit-query', dest='cq_gerrit_override',
863 default=None,
864 help=
865 "If given, this gerrit query will be used to find what patches to test, "
866 "rather than the normal 'CommitReady=2 AND Verified=1 AND CodeReview=2' "
867 "query it defaults to. Use with care- note additionally this setting "
868 "only has an effect if the buildbot target is a cq target, and we're "
869 "in buildbot mode.")
Brian Harring3fec5a82012-03-01 05:57:03 -0800870
871 parser.add_option_group(group)
872
Ryan Cuif4f84be2012-07-09 18:50:41 -0700873 #
874 # Hidden options.
875 #
876
877 # The base GS URL (gs://<bucket_name>/<path>) to archive artifacts to.
878 parser.add_remote_option('--archive-base', type='gs_path',
879 help=optparse.SUPPRESS_HELP)
880 # bootstrap-args are not verified by the bootstrap code. It gets passed
881 # direcly to the bootstrap re-execution.
882 parser.add_remote_option('--bootstrap-args', action='append',
883 default=[], help=optparse.SUPPRESS_HELP)
Ryan Cuif37608e2012-07-10 14:28:48 -0700884 # Specify to use Gerrit Source for building Chrome. Implies
885 # --chrome_rev=CHROME_REV_TOT.
886 parser.add_option('--gerrit-chrome', action='callback', default=False,
887 callback=_CheckGerritChromeOption, dest='gerrit_chrome',
888 help=optparse.SUPPRESS_HELP)
Ryan Cuif4f84be2012-07-09 18:50:41 -0700889 parser.add_option('--pass-through', dest='pass_through_args', action='append',
890 type='string', default=[], help=optparse.SUPPRESS_HELP)
891 # Used for handling forwards/backwards compatibility for --resume and
892 # --bootstrap.
893 parser.add_option('--reexec-api-version', dest='output_api_version',
894 action='store_true', default=False,
895 help=optparse.SUPPRESS_HELP)
896 # Indicates this is running on a remote trybot machine.
897 parser.add_option('--remote-trybot', dest='remote_trybot',
898 action='store_true', default=False,
899 help=optparse.SUPPRESS_HELP)
900 # Patches uploaded by trybot client when run using the -p option.
901 parser.add_remote_option('--remote-patches', action='extend', default=[],
902 help=optparse.SUPPRESS_HELP)
903 # Specify specific remote tryslaves to run on.
904 parser.add_option('--slaves', action='extend', default=[],
905 help=optparse.SUPPRESS_HELP)
906 parser.add_option('--sourceroot', type='path', default=constants.SOURCE_ROOT,
907 help=optparse.SUPPRESS_HELP)
908 # Causes cbuildbot to bootstrap itself twice, in the sequence A->B->C.
909 # A(unpatched) patches and bootstraps B. B patches and bootstraps C.
910 parser.add_remote_option('--test-bootstrap', action='store_true',
911 default=False, help=optparse.SUPPRESS_HELP)
Brian Harringf611e6e2012-07-17 18:47:44 -0700912 # Note the default here needs to be hardcoded to 3; that is the last version
913 # that lacked this functionality.
914 # This is used so that cbuildbot when processing tryjobs from
915 # older chromite instances, we can use it for handling compatibility.
916 parser.add_option('--remote-version', default=3, type=int, action='store',
917 help=optparse.SUPPRESS_HELP)
Ryan Cuif4f84be2012-07-09 18:50:41 -0700918
919 #
Brian Harring3fec5a82012-03-01 05:57:03 -0800920 # Debug options
Ryan Cuif4f84be2012-07-09 18:50:41 -0700921 #
Brian Harringfec89fe2012-09-23 07:30:54 -0700922 # Temporary hack; in place till --dry-run replaces --debug.
923 # pylint: disable=W0212
Brian Harring009db502012-10-10 02:21:37 -0700924 group = parser.debug_group
Brian Harringfec89fe2012-09-23 07:30:54 -0700925 debug = [x for x in group.option_list if x._long_opts == ['--debug']][0]
926 debug.help += " Currently functions as --dry-run in addition."
927 debug.pass_through = True
Brian Harring3fec5a82012-03-01 05:57:03 -0800928 group.add_option('--dump_config', action='store_true', dest='dump_config',
929 default=False,
930 help='Dump out build config options, and exit.')
931 group.add_option('--notee', action='store_false', dest='tee', default=True,
932 help="Disable logging and internal tee process. Primarily "
933 "used for debugging cbuildbot itself.")
Brian Harring3fec5a82012-03-01 05:57:03 -0800934 return parser
935
936
Ryan Cui85867972012-02-23 18:21:49 -0800937def _FinishParsing(options, args):
938 """Perform some parsing tasks that need to take place after optparse.
939
940 This function needs to be easily testable! Keep it free of
941 environment-dependent code. Put more detailed usage validation in
942 _PostParseCheck().
Brian Harring3fec5a82012-03-01 05:57:03 -0800943
944 Args:
Ryan Cui85867972012-02-23 18:21:49 -0800945 options, args: The options/args object returned by optparse
Brian Harring3fec5a82012-03-01 05:57:03 -0800946 """
Brian Harring07039b52012-05-13 17:56:47 -0700947
Brian Harring3fec5a82012-03-01 05:57:03 -0800948 if options.chrome_root:
949 if options.chrome_rev != constants.CHROME_REV_LOCAL:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700950 cros_build_lib.Die('Chrome rev must be %s if chrome_root is set.' %
951 constants.CHROME_REV_LOCAL)
Brian Harring3fec5a82012-03-01 05:57:03 -0800952 else:
953 if options.chrome_rev == constants.CHROME_REV_LOCAL:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700954 cros_build_lib.Die('Chrome root must be set if chrome_rev is %s.' %
955 constants.CHROME_REV_LOCAL)
Brian Harring3fec5a82012-03-01 05:57:03 -0800956
957 if options.chrome_version:
958 if options.chrome_rev != constants.CHROME_REV_SPEC:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700959 cros_build_lib.Die('Chrome rev must be %s if chrome_version is set.' %
960 constants.CHROME_REV_SPEC)
Brian Harring3fec5a82012-03-01 05:57:03 -0800961 else:
962 if options.chrome_rev == constants.CHROME_REV_SPEC:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700963 cros_build_lib.Die(
964 'Chrome rev must not be %s if chrome_version is not set.'
965 % constants.CHROME_REV_SPEC)
Brian Harring3fec5a82012-03-01 05:57:03 -0800966
Ryan Cuif37608e2012-07-10 14:28:48 -0700967 if options.gerrit_chrome:
968 if options.remote_trybot or options.remote:
969 cros_build_lib.Die('Cannot use --gerrit-chrome with remote trybots!')
970 elif options.chrome_rev != constants.CHROME_REV_TOT:
971 cros_build_lib.Die('Chrome rev must be %s if chrome_root is set.' %
972 constants.CHROME_REV_TOT)
973
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700974 patches = bool(options.gerrit_patches or options.local_patches)
975 if options.remote:
976 if options.local:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700977 cros_build_lib.Die('Cannot specify both --remote and --local')
Ryan Cui54da0702012-04-19 18:38:08 -0700978
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700979 if not options.buildbot and not patches:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700980 cros_build_lib.Die('Must provide patches when running with --remote.')
Brian Harring3fec5a82012-03-01 05:57:03 -0800981
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700982 # --debug needs to be explicitly passed through for remote invocations.
983 release_mode_with_patches = (options.buildbot and patches and
984 '--debug' not in options.pass_through_args)
985 else:
986 if len(args) > 1:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700987 cros_build_lib.Die('Multiple configs not supported if not running with '
Brian Harringf1aad832012-07-18 10:46:39 -0700988 '--remote. Got %r', args)
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700989
Ryan Cui79319ab2012-05-21 12:59:18 -0700990 if options.slaves:
Brian Harring1b8c4c82012-05-29 23:03:04 -0700991 cros_build_lib.Die('Cannot use --slaves if not running with --remote.')
Ryan Cui79319ab2012-05-21 12:59:18 -0700992
Ryan Cuieaa9efd2012-04-25 17:56:45 -0700993 release_mode_with_patches = (options.buildbot and patches and
994 not options.debug)
995
David James5734ea32012-08-15 20:23:49 -0700996 # When running in release mode, make sure we are running with checked-in code.
997 # We want checked-in cbuildbot/scripts to prevent errors, and we want to build
998 # a release image with checked-in code for CrOS packages.
999 if release_mode_with_patches:
1000 cros_build_lib.Die(
1001 'Cannot provide patches when running with --buildbot!')
1002
Ryan Cuiba41ad32012-03-08 17:15:29 -08001003 if options.buildbot and options.remote_trybot:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001004 cros_build_lib.Die(
1005 '--buildbot and --remote-trybot cannot be used together.')
Ryan Cuiba41ad32012-03-08 17:15:29 -08001006
Ryan Cui85867972012-02-23 18:21:49 -08001007 # Record whether --debug was set explicitly vs. it was inferred.
1008 options.debug_forced = False
1009 if options.debug:
1010 options.debug_forced = True
1011 else:
Ryan Cui16ca5812012-03-08 20:34:27 -08001012 # We don't set debug by default for
1013 # 1. --buildbot invocations.
1014 # 2. --remote invocations, because it needs to push changes to the tryjob
1015 # repo.
1016 options.debug = not options.buildbot and not options.remote
Brian Harring3fec5a82012-03-01 05:57:03 -08001017
Brian Harring3fec5a82012-03-01 05:57:03 -08001018
Brian Harring1d7ba942012-04-24 06:37:18 -07001019# pylint: disable=W0613
Brian Harringae0a5322012-09-15 01:46:51 -07001020def _PostParseCheck(parser, options, args):
Ryan Cui85867972012-02-23 18:21:49 -08001021 """Perform some usage validation after we've parsed the arguments
Brian Harring3fec5a82012-03-01 05:57:03 -08001022
Ryan Cui85867972012-02-23 18:21:49 -08001023 Args:
1024 options/args: The options/args object returned by optparse
1025 """
Ryan Cuie1e4e662012-05-21 16:39:46 -07001026 if not options.branch:
Chris Sosa126103a2012-06-18 09:03:17 -07001027 options.branch = cros_build_lib.GetChromiteTrackingBranch()
Ryan Cuie1e4e662012-05-21 16:39:46 -07001028
Brian Harringae0a5322012-09-15 01:46:51 -07001029 if not repository.IsARepoRoot(options.sourceroot):
1030 if options.local_patches:
1031 raise Exception('Could not find repo checkout at %s!'
1032 % options.sourceroot)
1033
1034 # Ensure we have a workable cachedir from this point forward.
1035 if options.cache_dir is None:
1036 # Note, options.sourceroot is set regardless of the path
1037 # actually existing.
1038 if os.path.exists(options.sourceroot):
1039 options.cache_dir = os.path.join(options.sourceroot, '.cache')
1040 elif options.buildroot is not None:
1041 options.cache_dir = os.path.join(options.buildroot, '.cache')
1042 else:
1043 options.cache_dir = parser.FindCacheDir(parser, options)
1044 options.cache_dir = os.path.abspath(options.cache_dir)
Brian Harring8c1d7b12012-10-04 17:36:32 -07001045 parser.ConfigureCacheDir(options.cache_dir)
Brian Harringae0a5322012-09-15 01:46:51 -07001046
1047 osutils.SafeMakedirs(options.cache_dir)
Ryan Cui5ba7e152012-05-10 14:36:52 -07001048
Brian Harring609dc4e2012-05-07 02:17:44 -07001049 if options.local_patches:
Brian Harring1d7ba942012-04-24 06:37:18 -07001050 options.local_patches = _CheckLocalPatches(
Brian Harring609dc4e2012-05-07 02:17:44 -07001051 options.sourceroot, options.local_patches)
Brian Harring1d7ba942012-04-24 06:37:18 -07001052
1053 default = os.environ.get('CBUILDBOT_DEFAULT_MODE')
1054 if (default and not any([options.local, options.buildbot,
1055 options.remote, options.remote_trybot])):
Brian Harring1b8c4c82012-05-29 23:03:04 -07001056 cros_build_lib.Info("CBUILDBOT_DEFAULT_MODE=%s env var detected, using it."
1057 % default)
Brian Harring1d7ba942012-04-24 06:37:18 -07001058 default = default.lower()
1059 if default == 'local':
1060 options.local = True
1061 elif default == 'remote':
1062 options.remote = True
1063 elif default == 'buildbot':
1064 options.buildbot = True
1065 else:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001066 cros_build_lib.Die("CBUILDBOT_DEFAULT_MODE value %s isn't supported. "
1067 % default)
Ryan Cui85867972012-02-23 18:21:49 -08001068
1069
1070def _ParseCommandLine(parser, argv):
1071 """Completely parse the commandline arguments"""
Brian Harring3fec5a82012-03-01 05:57:03 -08001072 (options, args) = parser.parse_args(argv)
Brian Harring37e559b2012-05-22 20:47:32 -07001073
1074 if options.output_api_version:
Ryan Cui724f1d32012-10-15 18:10:22 -07001075 print constants.REEXEC_API_VERSION
Brian Harring37e559b2012-05-22 20:47:32 -07001076 sys.exit(0)
1077
Ryan Cui54da0702012-04-19 18:38:08 -07001078 if options.list:
1079 _PrintValidConfigs(options.print_all)
1080 sys.exit(0)
1081
Ryan Cui8be16062012-04-24 12:05:26 -07001082 # Strip out null arguments.
1083 # TODO(rcui): Remove when buildbot is fixed
1084 args = [arg for arg in args if arg]
1085 if not args:
1086 parser.error('Invalid usage. Use -h to see usage. Use -l to list '
1087 'supported configs.')
1088
Ryan Cui85867972012-02-23 18:21:49 -08001089 _FinishParsing(options, args)
1090 return options, args
1091
1092
1093def main(argv):
1094 # Set umask to 022 so files created by buildbot are readable.
1095 os.umask(022)
1096
Ryan Cui85867972012-02-23 18:21:49 -08001097 parser = _CreateParser()
1098 (options, args) = _ParseCommandLine(parser, argv)
Brian Harring3fec5a82012-03-01 05:57:03 -08001099
Brian Harringae0a5322012-09-15 01:46:51 -07001100 _PostParseCheck(parser, options, args)
Brian Harring3fec5a82012-03-01 05:57:03 -08001101
Zdenek Behan98ec2fb2012-08-31 17:12:18 +02001102 if cros_build_lib.IsInsideChroot():
1103 cros_build_lib.Die('Please run cbuildbot from outside the chroot.')
1104
1105
Brian Harring3fec5a82012-03-01 05:57:03 -08001106 if options.remote:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001107 cros_build_lib.logger.setLevel(logging.WARNING)
Ryan Cui16ca5812012-03-08 20:34:27 -08001108
Brian Harring3fec5a82012-03-01 05:57:03 -08001109 # Verify configs are valid.
1110 for bot in args:
1111 _GetConfig(bot)
1112
1113 # Verify gerrit patches are valid.
Ryan Cui16ca5812012-03-08 20:34:27 -08001114 print 'Verifying patches...'
Ryan Cuie1e4e662012-05-21 16:39:46 -07001115 patch_pool = AcquirePoolFromOptions(options)
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001116
Ryan Cuieaa9efd2012-04-25 17:56:45 -07001117 # --debug need to be explicitly passed through for remote invocations.
1118 if options.buildbot and '--debug' not in options.pass_through_args:
1119 _ConfirmRemoteBuildbotRun()
1120
Ryan Cui16ca5812012-03-08 20:34:27 -08001121 print 'Submitting tryjob...'
Ryan Cui16d9e1f2012-05-11 10:50:18 -07001122 tryjob = remote_try.RemoteTryJob(options, args, patch_pool.local_patches)
Ryan Cuia25d8eb2012-07-11 14:54:27 -07001123 tryjob.Submit(testjob=options.test_tryjob, dryrun=False)
Ryan Cui16ca5812012-03-08 20:34:27 -08001124 print 'Tryjob submitted!'
1125 print ('Go to %s to view the status of your job.'
Ryan Cui4906e1c2012-04-03 20:09:34 -07001126 % tryjob.GetTrybotWaterfallLink())
Brian Harring3fec5a82012-03-01 05:57:03 -08001127 sys.exit(0)
Ryan Cui54da0702012-04-19 18:38:08 -07001128 elif (not options.buildbot and not options.remote_trybot
1129 and not options.resume and not options.local):
Brian Harring1b8c4c82012-05-29 23:03:04 -07001130 cros_build_lib.Warning(
1131 'Running in LOCAL TRYBOT mode! Use --remote to submit REMOTE '
1132 'tryjobs. Use --local to suppress this message.')
1133 cros_build_lib.Warning(
Ryan Cui51591352012-07-09 15:15:53 -07001134 'In the future, --local will be required to run the local '
Brian Harring1b8c4c82012-05-29 23:03:04 -07001135 'trybot.')
Ryan Cui54da0702012-04-19 18:38:08 -07001136 time.sleep(5)
Brian Harring3fec5a82012-03-01 05:57:03 -08001137
Ryan Cui8be16062012-04-24 12:05:26 -07001138 # Only expecting one config
1139 bot_id = args[-1]
1140 build_config = _GetConfig(bot_id)
Brian Harring3fec5a82012-03-01 05:57:03 -08001141
1142 if options.reference_repo is None:
Ryan Cui5ba7e152012-05-10 14:36:52 -07001143 repo_path = os.path.join(options.sourceroot, '.repo')
Brian Harring3fec5a82012-03-01 05:57:03 -08001144 # If we're being run from a repo checkout, reuse the repo's git pool to
1145 # cut down on sync time.
1146 if os.path.exists(repo_path):
Ryan Cui5ba7e152012-05-10 14:36:52 -07001147 options.reference_repo = options.sourceroot
Brian Harring3fec5a82012-03-01 05:57:03 -08001148 elif options.reference_repo:
1149 if not os.path.exists(options.reference_repo):
1150 parser.error('Reference path %s does not exist'
1151 % (options.reference_repo,))
1152 elif not os.path.exists(os.path.join(options.reference_repo, '.repo')):
1153 parser.error('Reference path %s does not look to be the base of a '
1154 'repo checkout; no .repo exists in the root.'
1155 % (options.reference_repo,))
Ryan Cuid4a24212012-04-04 18:08:12 -07001156
Brian Harringf11bf682012-05-14 15:53:43 -07001157 if (options.buildbot or options.remote_trybot) and not options.resume:
Brian Harring470f6112012-03-02 11:47:10 -08001158 if not options.cgroups:
Ryan Cuid4a24212012-04-04 18:08:12 -07001159 parser.error('Options --buildbot/--remote-trybot and --nocgroups cannot '
1160 'be used together. Cgroup support is required for '
1161 'buildbot/remote-trybot mode.')
Brian Harring470f6112012-03-02 11:47:10 -08001162 if not cgroups.Cgroup.CgroupsSupported():
Ryan Cuid4a24212012-04-04 18:08:12 -07001163 parser.error('Option --buildbot/--remote-trybot was given, but this '
1164 'system does not support cgroups. Failing.')
Brian Harring3fec5a82012-03-01 05:57:03 -08001165
David Jamesaad5cc72012-10-26 15:03:13 -07001166 missing = osutils.FindMissingBinaries(_BUILDBOT_REQUIRED_BINARIES)
Brian Harring351ce442012-03-09 16:38:14 -08001167 if missing:
Ryan Cuid4a24212012-04-04 18:08:12 -07001168 parser.error("Option --buildbot/--remote-trybot requires the following "
1169 "binaries which couldn't be found in $PATH: %s"
Brian Harring351ce442012-03-09 16:38:14 -08001170 % (', '.join(missing)))
1171
Brian Harring3fec5a82012-03-01 05:57:03 -08001172 if options.reference_repo:
1173 options.reference_repo = os.path.abspath(options.reference_repo)
1174
1175 if options.dump_config:
1176 # This works, but option ordering is bad...
1177 print 'Configuration %s:' % bot_id
1178 pretty_printer = pprint.PrettyPrinter(indent=2)
1179 pretty_printer.pprint(build_config)
1180 sys.exit(0)
1181
1182 if not options.buildroot:
1183 if options.buildbot:
1184 parser.error('Please specify a buildroot with the --buildroot option.')
Matt Tennantd55b1f42012-04-13 14:15:01 -07001185
Ryan Cui5ba7e152012-05-10 14:36:52 -07001186 options.buildroot = _DetermineDefaultBuildRoot(options.sourceroot,
1187 build_config['internal'])
Brian Harring470f6112012-03-02 11:47:10 -08001188 # We use a marker file in the buildroot to indicate the user has
1189 # consented to using this directory.
1190 if not os.path.exists(repository.GetTrybotMarkerPath(options.buildroot)):
1191 _ConfirmBuildRoot(options.buildroot)
Brian Harring3fec5a82012-03-01 05:57:03 -08001192
1193 # Sanity check of buildroot- specifically that it's not pointing into the
1194 # midst of an existing repo since git-repo doesn't support nesting.
Brian Harring3fec5a82012-03-01 05:57:03 -08001195 if (not repository.IsARepoRoot(options.buildroot) and
David James6b80dc62012-02-29 15:34:40 -08001196 repository.InARepoRepository(options.buildroot)):
Brian Harring3fec5a82012-03-01 05:57:03 -08001197 parser.error('Configured buildroot %s points into a repository checkout, '
1198 'rather than the root of it. This is not supported.'
1199 % options.buildroot)
1200
Chris Sosab5ea3b42012-10-25 15:25:20 -07001201 if not options.log_dir:
1202 options.log_dir = os.path.join(options.buildroot, _DEFAULT_LOG_DIR)
1203
Brian Harringd166aaf2012-05-14 18:31:53 -07001204 log_file = None
1205 if options.tee:
Chris Sosab5ea3b42012-10-25 15:25:20 -07001206 log_file = os.path.join(options.log_dir, _BUILDBOT_LOG_FILE)
1207 osutils.SafeMakedirs(options.log_dir)
Brian Harringd166aaf2012-05-14 18:31:53 -07001208 _BackupPreviousLog(log_file)
1209
Brian Harring1b8c4c82012-05-29 23:03:04 -07001210 with cros_build_lib.ContextManagerStack() as stack:
Brian Harringc2d09d92012-05-13 22:03:15 -07001211 critical_section = stack.Add(cleanup.EnforcedCleanupSection)
1212 stack.Add(sudo.SudoKeepAlive)
Brian Harringd166aaf2012-05-14 18:31:53 -07001213
Brian Harringc2d09d92012-05-13 22:03:15 -07001214 if not options.resume:
Brian Harring2bf55e12012-05-13 21:31:55 -07001215 # If we're in resume mode, use our parents tempdir rather than
1216 # nesting another layer.
Brian Harringc2d09d92012-05-13 22:03:15 -07001217 stack.Add(osutils.TempDirContextManager, 'cbuildbot-tmp')
1218 logging.debug("Cbuildbot tempdir is %r.", os.environ.get('TMP'))
Brian Harringd166aaf2012-05-14 18:31:53 -07001219
Brian Harringead69102012-07-31 15:54:07 -07001220 # TODO(ferringb): update this once https://gerrit.chromium.org/gerrit/25359
1221 # is landed- it's sensitive to the manifest-versions cache path.
Brian Harringae0a5322012-09-15 01:46:51 -07001222 options.preserve_paths = set(['manifest-versions', '.cache',
Brian Harringead69102012-07-31 15:54:07 -07001223 'manifest-versions-internal'])
Brian Harringd166aaf2012-05-14 18:31:53 -07001224 if log_file is not None:
1225 stack.Add(tee.Tee, log_file)
Brian Harring2d8f9ff2012-06-30 15:58:28 -07001226 options.preserve_paths.add(_DEFAULT_LOG_DIR)
Brian Harringd166aaf2012-05-14 18:31:53 -07001227
Brian Harringc2d09d92012-05-13 22:03:15 -07001228 if options.cgroups:
1229 stack.Add(cgroups.SimpleContainChildren, 'cbuildbot')
Brian Harringa184efa2012-03-04 11:51:25 -08001230
Brian Harringc2d09d92012-05-13 22:03:15 -07001231 # Mark everything between EnforcedCleanupSection and here as having to
1232 # be rolled back via the contextmanager cleanup handlers. This
1233 # ensures that sudo bits cannot outlive cbuildbot, that anything
1234 # cgroups would kill gets killed, etc.
1235 critical_section.ForkWatchdog()
Brian Harringd166aaf2012-05-14 18:31:53 -07001236
Brian Harringc2d09d92012-05-13 22:03:15 -07001237 if options.timeout > 0:
Brian Harring1b8c4c82012-05-29 23:03:04 -07001238 stack.Add(cros_build_lib.Timeout, options.timeout)
Brian Harringa184efa2012-03-04 11:51:25 -08001239
Brian Harringc2d09d92012-05-13 22:03:15 -07001240 if not options.buildbot:
1241 build_config = cbuildbot_config.OverrideConfigForTrybot(
1242 build_config,
1243 options.remote_trybot)
1244
1245 _RunBuildStagesWrapper(options, build_config)