Prompt for a reason when restarting a master, include that reason in the CL description.

infra/tools/restart/restart.py

 # Copyright 2015 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 import collections
 import contextlib
 import datetime
 import dateutil.tz
 import distutils.util
 import json
@@ skipping 73 matching lines @@
   parser.add_argument(
       'masters', type=str, nargs='+',
       help='Master(s) to restart. "master." prefix can be omitted.')
   parser.add_argument(
       '-m', '--minutes-in-future', default=15, type=int,
       help='how many minutes in the future to schedule the restart. '
            'use 0 for "now." default %(default)d')
   parser.add_argument(
       '--eod', action='store_true',
       help='schedules restart for 6:30PM Google Standard Time.')
-  parser.add_argument('-b', '--bug', default=None, type=str,
-                      help='Bug containing master restart request.')
+  parser.add_argument(
+      '-b', '--bug', default=None, type=str,
+      help='Bug containing master restart request.')
   parser.add_argument(
       '-r', '--reviewer', action='append', type=str,
       help=('Reviewer (ldap or ldap@google.com) to TBR the CL to. '
             'If not specified, chooses a random reviewer from OWNERS file'))
   parser.add_argument(
       '-f', '--force', action='store_true',
       help='don\'t ask for confirmation, just commit')
   parser.add_argument(
       '-n', '--no-commit', action='store_true',
       help='update the file, but refrain from performing the actual commit')
   parser.add_argument(
       '-s', '--desired-state', default='running',
       choices=buildbot_state.STATES['desired_buildbot_state'],
       help='which desired state to put the buildbot master in '
            '(default %(default)s)')
+  parser.add_argument(
+      '-e', '--reason', type=str, default='',
+      help='reason for restarting the master')
 
 
 def get_restart_spec(name, restart_time):
   def _trim_prefix(v, prefix):
     if v.startswith(prefix):
       return v[len(prefix):]
     return v
   name = _trim_prefix(name, 'master.')
 
   def _get_restart_config(name, seen):
@@ skipping 60 matching lines @@
       _, domain = r.split('@', 1)
       if domain != 'google.com':
         other.append(r)
       else:
         google.append(r)
     else:
       google.append('%s@google.com' % r)
   return google, other
 
 def commit(
-    target, specs, reviewers, bug, force, no_commit, desired_state):
+    target, specs, reviewers, bug, force, no_commit, desired_state, reason):
   """Commits the local CL via the CQ."""
   if desired_state == 'running':
     action = 'Restarting'
   else:
     action = desired_state.title() + 'ing'
 
-  desc = '%s master(s) %s\n' % (
-      action, ', '.join([s.name for s in specs]))
+  desc = '%(action)s master%(plural)s %(names)s\n\n%(reason)s\n' % {
+      'action': action,
+      'plural': 's' if len(specs) > 1 else '',
+      'names': ', '.join([s.name for s in specs]),
+      'reason': reason,
+  }
   if bug:
     desc += '\nBUG=%s' % bug
   tbr_whom = 'an owner'
   if reviewers:
     google, other = autocomplete_and_partition(reviewers)
     if other:
       print
       print 'Error: not @google.com email(s) for reviewers found:'
       print '  %s' % ('\n  '.join(other))
       print 'Hint: save your fingertips - use just ldap: -r <ldap>'
@@ skipping 55 matching lines @@
   if not reviewers:
     upload_cmd.append('--tbr-owners')
   if not no_commit:
     upload_cmd.append('-c')
   else:
     LOGGER.info('CQ bit not set, please commit manually. (--no-commit)')
   subprocess.check_call(upload_cmd, cwd=target)
 
 
 def run(masters, restart_time, reviewers, bug, force, no_commit,
-        desired_state):
+        desired_state, reason):
   """Restart all the masters in the list of masters.
 
   Schedules the restart for restart_time.
 
   Args:
     masters - a list(str) of masters to restart
     restart_time - a datetime in UTC of when to restart them. If None, restart
                    at a predefined "end of day".
     reviewers - a list(str) of reviewers for the CL (may be empty)
     bug - an integer bug number to include in the review or None
     force - a bool which causes commit not to prompt if true
     no_commit - doesn't set the CQ bit on upload
     desired_state - nominally 'running', picks which desired_state
                     to put the buildbot in
+    reason - a short message saying why the master is being restarted
   """
   masters = [get_restart_spec(m, restart_time) for m in sorted(set(masters))]
 
+  reason = reason.strip()
+  if not reason:
+    reason = raw_input('Please provide a reason for this restart: ').strip()
+    if not reason:
+      print 'No reason provided, exiting'
+      return 0
+
   # Step 1: Acquire a clean master state checkout.
   # This repo is too small to consider caching.
   with get_master_state_checkout() as master_state_dir:
     master_state_json = os.path.join(
         master_state_dir, 'desired_master_state.json')
 
     # Step 2: make modifications to the master state json.
     LOGGER.info('Reading %s' % master_state_json)
     with open(master_state_json, 'r') as f:
       desired_master_state = json.load(f)
@@ skipping 21 matching lines @@
       entries += 1
 
     LOGGER.info('Writing back to JSON file, %d new entries' % (entries,))
     desired_state_parser.write_master_state(
         desired_master_state, master_state_json,
         prune_only_masters=set(m.desired_state_name for m in masters))
 
     # Step 3: Send the patch to Rietveld and commit it via the CQ.
     LOGGER.info('Committing back into repository')
     commit(master_state_dir, masters, reviewers, bug, force, no_commit,
-           desired_state)
+           desired_state, reason)