Implement git cl upload -b BUG --bug=BUG.

git_cl.py

 #!/usr/bin/env python
 # Copyright (c) 2012 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.
 
 # Copyright (C) 2008 Evan Martin <martine@danga.com>
 
 """A git-command for integrating reviews on Rietveld and Gerrit."""
 
 from __future__ import print_function
@@ skipping 1898 matching lines @@
       if options.title is not None:
         upload_args.extend(['--title', options.title])
       message = (options.title or options.message or
                  CreateDescriptionFromLog(args))
       change_desc = ChangeDescription(message)
       if options.reviewers or options.tbr_owners:
         change_desc.update_reviewers(options.reviewers,
                                      options.tbr_owners,
                                      change)
       if not options.force:
-        change_desc.prompt()
+        change_desc.prompt(bug=options.bug)
 
       if not change_desc.description:
         print('Description is empty; aborting.')
         return 1
 
       upload_args.extend(['--message', change_desc.description])
       if change_desc.get_reviewers():
         upload_args.append('--reviewers=%s' % ','.join(
             change_desc.get_reviewers()))
       if options.send_mail:
@@ skipping 528 matching lines @@
               'WARNING: issue %s has Change-Id footer(s):\n'
               '  %s\n'
               'but issue has Change-Id %s, according to Gerrit.\n'
               'Please, check the proposed correction to the description, '
               'and edit it if necessary but keep the "Change-Id: %s" footer\n'
               % (self.GetIssue(), '\n  '.join(footer_change_ids), change_id,
                  change_id))
           ask_for_data('Press enter to edit now, Ctrl+C to abort')
           if not options.force:
             change_desc = ChangeDescription(message)
-            change_desc.prompt()
+            change_desc.prompt(bug=options.bug)
             message = change_desc.description
             if not message:
               DieWithError("Description is empty. Aborting...")
           # Continue the while loop.
         # Sanity check of this code - we should end up with proper message
         # footer.
         assert [change_id] == git_footers.get_footer_change_id(message)
         change_desc = ChangeDescription(message)
       else:
         change_desc = ChangeDescription(
             options.message or CreateDescriptionFromLog(args))
         if not options.force:
-          change_desc.prompt()
+          change_desc.prompt(bug=options.bug)
         if not change_desc.description:
           DieWithError("Description is empty. Aborting...")
         message = change_desc.description
         change_ids = git_footers.get_footer_change_id(message)
         if len(change_ids) > 1:
           DieWithError('too many Change-Id footers, at most 1 allowed.')
         if not change_ids:
           # Generate the Change-Id automatically.
           message = git_footers.add_footer_change_id(
               message, GenerateGerritChangeId(message))
@@ skipping 161 matching lines @@
 def _process_codereview_select_options(parser, options):
   if options.gerrit and options.rietveld:
     parser.error('Options --gerrit and --rietveld are mutually exclusive')
   options.forced_codereview = None
   if options.gerrit:
     options.forced_codereview = 'gerrit'
   elif options.rietveld:
     options.forced_codereview = 'rietveld'
 
 
+def _get_bug_line_values(default_project, bugs):
+  """Given default_project and comma separated list of bugs, yields bug line
+  values.
+
+  Each bug can be either:
+    * a number, which is combined with default_project
+    * string, which is left as is.
+
+  This function may produce more than one line, because bugdroid expects one
+  project per line.
+
+  >>> list(_get_bug_line_values('v8', '123,chromium:789'))
+      ['v8:123', 'chromium:789']
+  """
+  default_bugs = []
+  others = []
+  for bug in bugs.split(','):
+    bug = bug.strip()
+    if bug:
+      try:
+        default_bugs.append(int(bug))
+      except ValueError:
+        others.append(bug)
+
+  if default_bugs:
+    default_bugs = ','.join(map(str, default_bugs))
+    if default_project:
+      yield '%s:%s' % (default_project, default_bugs)
+    else:
+      yield default_bugs
+  for other in sorted(others):
+    # Don't bother finding common prefixes, CLs with >2 bugs are very very rare.

[Sergiy Byelozyorov, 2016/07/01 15:37:01]

+1 for writing this comment

+    yield other
+
+
 class ChangeDescription(object):
   """Contains a parsed form of the change description."""
   R_LINE = r'^[ \t]*(TBR|R)[ \t]*=[ \t]*(.*?)[ \t]*$'
   BUG_LINE = r'^[ \t]*(BUG)[ \t]*=[ \t]*(.*?)[ \t]*$'
 
   def __init__(self, description):
     self._description_lines = (description or '').strip().splitlines()
 
   @property               # www.logilab.org/ticket/89786
   def description(self):  # pylint: disable=E0202
@@ skipping 55 matching lines @@
       if new_tbr_line:
         self._description_lines.insert(line_loc, new_tbr_line)
       if new_r_line:
         self._description_lines.insert(line_loc, new_r_line)
     else:
       if new_r_line:
         self.append_footer(new_r_line)
       if new_tbr_line:
         self.append_footer(new_tbr_line)
 
-  def prompt(self):
+  def prompt(self, bug=None):
     """Asks the user to update the description."""
     self.set_description([
       '# Enter a description of the change.',
       '# This will be displayed on the codereview site.',
       '# The first line will also be used as the subject of the review.',
       '#--------------------This line is 72 characters long'
       '--------------------',
     ] + self._description_lines)
 
     regexp = re.compile(self.BUG_LINE)
     if not any((regexp.match(line) for line in self._description_lines)):
-      self.append_footer('BUG=%s' % settings.GetBugPrefix())
+      prefix = settings.GetBugPrefix()
+      values = list(_get_bug_line_values(prefix, bug or '')) or [prefix]
+      for value in values:
+        # TODO(tandrii): change this to 'Bug: xxx' to be a proper Gerrit footer.
+        self.append_footer('BUG=%s' % value)
+
     content = gclient_utils.RunEditor(self.description, True,
                                       git_editor=settings.GetGitEditor())
     if not content:
       DieWithError('Running editor failed')
     lines = content.splitlines()
 
     # Strip off comments.
     clean_lines = [line.rstrip() for line in lines if not line.startswith('#')]
     if not clean_lines:
       DieWithError('No CL description, aborting')
@@ skipping 957 matching lines @@
   Can also set the above globally by using the --global flag.
   """
   parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
                     help='bypass upload presubmit hook')
   parser.add_option('--bypass-watchlists', action='store_true',
                     dest='bypass_watchlists',
                     help='bypass watchlists auto CC-ing reviewers')
   parser.add_option('-f', action='store_true', dest='force',
                     help="force yes to questions (don't prompt)")
   parser.add_option('-m', dest='message', help='message for patchset')
+  parser.add_option('-b', '--bug',
+                    help='pre-populate the bug number(s) for this issue. '
+                         'If several, separate with commas')
   parser.add_option('--message-file', dest='message_file',
                     help='file which contains message for patchset')
   parser.add_option('-t', dest='title',
                     help='title for patchset (Rietveld only)')
   parser.add_option('-r', '--reviewers',
                     action='append', default=[],
                     help='reviewer email addresses')
   parser.add_option('--cc',
                     action='append', default=[],
                     help='cc email addresses')
@@ skipping 1340 matching lines @@
 if __name__ == '__main__':
   # These affect sys.stdout so do it outside of main() to simplify mocks in
   # unit testing.
   fix_encoding.fix_encoding()
   setup_color.init()
   try:
     sys.exit(main(sys.argv[1:]))
   except KeyboardInterrupt:
     sys.stderr.write('interrupted\n')
     sys.exit(1)