Make git-cl work with OWNERS files in a non .git/hooks/pre-cl-* world

git_cl/git_cl.py

 #!/usr/bin/python
 # git-cl -- a git-command for integrating reviews on Rietveld
 # Copyright (C) 2008 Evan Martin <martine@danga.com>
 
 import errno
 import logging
 import optparse
 import os
 import re
+import StringIO
 import subprocess
 import sys
 import tempfile
 import textwrap
 import upload
 import urlparse
 import urllib2
 
 try:
   import readline
@@ skipping 39 matching lines @@
   if redirect_stdout:
     stdout = subprocess.PIPE
   else:
     stdout = None
   if swallow_stderr:
     stderr = subprocess.PIPE
   else:
     stderr = None
   proc = Popen(cmd, stdout=stdout, stderr=stderr, **kwargs)
   output = proc.communicate()[0]
+
   if not error_ok and proc.returncode != 0:
     DieWithError('Command "%s" failed.\n' % (' '.join(cmd)) +
                  (error_message or output or ''))
   return output
 
 
 def RunGit(args, **kwargs):
   cmd = ['git'] + args
   return RunCommand(cmd, **kwargs)
 
@@ skipping 394 matching lines @@
 
   SetProperty(settings.GetCCList(), 'CC list', 'cc')
   SetProperty(settings.GetTreeStatusUrl(error_ok=True), 'Tree status URL',
               'tree-status-url')
   SetProperty(settings.GetViewVCUrl(), 'ViewVC URL', 'viewvc-url')
 
   # TODO: configure a default branch to diff against, rather than this
   # svn-based hackery.
 
 
+class HookResults(object):
+  """Contains the parsed output of the presubmit hooks."""
+  def __init__(self, output_from_hooks=None):
+    self.reviewers = []
+    self.output = None
+    self._ParseOutputFromHooks(output_from_hooks)
+
+  def _ParseOutputFromHooks(self, output_from_hooks):
+    if not output_from_hooks:
+      return
+    lines = []
+    reviewers = []
+    reviewer_regexp = re.compile('ADD: R=(.+)')

[M-A Ruel, 2011/03/11 18:00:06]

I wonder if instead it could be a more generic implementation:
The presubmit check could return the new description.
This way BUG=, TEST= and others could be added by the presubmit check instead of
git-cl/gcl.

[Dirk Pranke, 2011/03/11 21:06:31]

Yeah, that would probably be a nice enhancement. However, I think it would be
better to find a way that wasn't parsing text to begin with. Depends on how we
cross process boundaries, I suppose.

+    for l in output_from_hooks.splitlines():
+      m = reviewer_regexp.match(l)
+      if m:
+        reviewers.extend(m.group(1).split(','))
+      else:
+        lines.append(l)
+    self.output = '\n'.join(lines)
+    self.reviewers = ','.join(reviewers)
+
+
+class ChangeDescription(object):
+  """Contains a parsed form of the change description."""
+  def __init__(self, subject, log_desc, reviewers):
+    self.subject = subject
+    self.log_desc = log_desc
+    self.reviewers = reviewers
+    self.description = self.log_desc
+
+  def Update(self):
+    initial_text = """# Enter a description of the change.
+# This will displayed on the codereview site.
+# The first line will also be used as the subject of the review.
+"""
+    initial_text += self.description
+    if 'R=' not in self.description and self.reviewers:
+      initial_text += '\nR=' + self.reviewers
+    if 'BUG=' not in self.description:
+      initial_text += '\nBUG='
+    if 'TEST=' not in self.description:
+      initial_text += '\nTEST='
+    self._ParseDescription(UserEditedLog(initial_text))
+
+  def _ParseDescription(self, description):
+    if not description:
+      self.description = description
+      return
+
+    parsed_lines = []
+    reviewers_regexp = re.compile('\s*R=(.+)')
+    reviewers = ''
+    subject = ''
+    for l in description.splitlines():
+      if not subject:
+        subject = l
+      matched_reviewers = reviewers_regexp.match(l)
+      if matched_reviewers:
+        reviewers = matched_reviewers.group(1)
+      parsed_lines.append(l)
+
+    self.description = '\n'.join(parsed_lines) + '\n'
+    self.subject = subject
+    self.reviewers = reviewers
+
+  def IsEmpty(self):
+    return not self.description
+
+
 def FindCodereviewSettingsFile(filename='codereview.settings'):
   """Finds the given file starting in the cwd and going up.
 
   Only looks up to the top of the repository unless an
   'inherit-review-settings-ok' file exists in the root of the repository.
   """
   inherit_ok_file = 'inherit-review-settings-ok'
   cwd = os.getcwd()
   root = os.path.abspath(RunGit(['rev-parse', '--show-cdup']).strip())
   if os.path.isfile(os.path.join(root, inherit_ok_file)):
@@ skipping 171 matching lines @@
 
 
 def ConvertToInteger(inputval):
   """Convert a string to integer, but returns either an int or None."""
   try:
     return int(inputval)
   except (TypeError, ValueError):
     return None
 
 
-def RunHook(committing, upstream_branch):
+def RunHook(committing, upstream_branch, rietveld_server, tbr=False):
   import presubmit_support
   import scm
   import watchlists
 
   root = RunCommand(['git', 'rev-parse', '--show-cdup']).strip()
   if not root:
     root = "."
   absroot = os.path.abspath(root)
   if not root:
     raise Exception("Could not get root directory.")
@@ skipping 17 matching lines @@
                                        issue, patchset)
 
   # Apply watchlists on upload.
   if not committing:
     watchlist = watchlists.Watchlists(change.RepositoryRoot())
     files = [f.LocalPath() for f in change.AffectedFiles()]
     watchers = watchlist.GetWatchersForPaths(files)
     RunCommand(['git', 'config', '--replace-all',
                'rietveld.extracc', ','.join(watchers)])
 
-  return presubmit_support.DoPresubmitChecks(change, committing,
-      verbose=None, output_stream=sys.stdout, input_stream=sys.stdin,
-      default_presubmit=None, may_prompt=None)
+  output = StringIO.StringIO()
+  res = presubmit_support.DoPresubmitChecks(change, committing,
+      verbose=None, output_stream=output, input_stream=sys.stdin,
+      default_presubmit=None, may_prompt=None, tbr=tbr,
+      host_url=cl.GetRietveldServer())
+  if not res:

[M-A Ruel, 2011/03/11 21:21:55]

What about PresubmitNotifyResult?

[Dirk Pranke, 2011/03/11 21:39:18]

Good catch. It would get printed in some but not all other cases,  and having
the logic scattered around is a bad thing. Will fix.

+    print output.getvalue()
+    sys.exit(1)
+  return HookResults(output.getvalue())
 
 
 def CMDpresubmit(parser, args):
   """run presubmit tests on the current changelist"""
   parser.add_option('--upload', action='store_true',
                     help='Run upload hook instead of the push/dcommit hook')
   (options, args) = parser.parse_args(args)
 
   # Make sure index is up-to-date before running diff-index.
   RunGit(['update-index', '--refresh', '-q'], error_ok=True)
   if RunGit(['diff-index', 'HEAD']):
     # TODO(maruel): Is this really necessary?
     print 'Cannot presubmit with a dirty tree.  You must commit locally first.'
     return 1
 
+  cl = Changelist()
   if args:
     base_branch = args[0]
   else:
     # Default to diffing against the "upstream" branch.
-    base_branch = Changelist().GetUpstreamBranch()
+    base_branch = cl.GetUpstreamBranch()
 
   if options.upload:
     print '*** Presubmit checks for UPLOAD would report: ***'
-    return RunHook(committing=False, upstream_branch=base_branch)
+    return RunHook(committing=False, upstream_branch=base_branch,
+                   rietveld_server=cl.GetRietveldServer(), tbr=False).output
   else:
     print '*** Presubmit checks for DCOMMIT would report: ***'
-    return RunHook(committing=True, upstream_branch=base_branch)
+    return RunHook(committing=True, upstream_branch=base_branch,
+                   rietveld_server=cl.GetRietveldServer, tbr=False).output
 
 
 @usage('[args to "git diff"]')
 def CMDupload(parser, args):
   """upload the current changelist to codereview"""
   parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
                     help='bypass upload presubmit hook')
   parser.add_option('-m', dest='message', help='message for patch')
   parser.add_option('-r', '--reviewers',
                     help='reviewer email addresses')
@@ skipping 18 matching lines @@
 
   cl = Changelist()
   if args:
     base_branch = args[0]
   else:
     # Default to diffing against the "upstream" branch.
     base_branch = cl.GetUpstreamBranch()
     args = [base_branch + "..."]
 
   if not options.bypass_hooks:
-    RunHook(committing=False, upstream_branch=base_branch)
+    hook_results = RunHook(committing=False, upstream_branch=base_branch,
+                           rietveld_server=cl.GetRietveldServer(), tbr=False)
+  else:
+    hook_results = HookResults()
+
+  if not options.reviewers and hook_results.reviewers:
+    options.reviewers = hook_results.reviewers
 
   # --no-ext-diff is broken in some versions of Git, so try to work around
   # this by overriding the environment (but there is still a problem if the
   # git config key "diff.external" is used).
   env = os.environ.copy()
   if 'GIT_EXTERNAL_DIFF' in env:
     del env['GIT_EXTERNAL_DIFF']
   subprocess.call(['git', 'diff', '--no-ext-diff', '--stat', '-M'] + args,
                   env=env)
 
   upload_args = ['--assume_yes']  # Don't ask about untracked files.
   upload_args.extend(['--server', cl.GetRietveldServer()])
-  if options.reviewers:
-    upload_args.extend(['--reviewers', options.reviewers])
   if options.emulate_svn_auto_props:
     upload_args.append('--emulate_svn_auto_props')
   if options.send_mail:
     if not options.reviewers:
       DieWithError("Must specify reviewers to send email.")
     upload_args.append('--send_mail')
   if options.from_logs and not options.message:
     print 'Must set message for subject line if using desc_from_logs'
     return 1
 
   change_desc = None
 
   if cl.GetIssue():
     if options.message:
       upload_args.extend(['--message', options.message])
     upload_args.extend(['--issue', cl.GetIssue()])
     print ("This branch is associated with issue %s. "
            "Adding patch to that issue." % cl.GetIssue())
   else:
     log_desc = CreateDescriptionFromLog(args)
-    if options.from_logs:
-      # Uses logs as description and message as subject.
-      subject = options.message
-      change_desc = subject + '\n\n' + log_desc
-    else:
-      initial_text = """# Enter a description of the change.
-# This will displayed on the codereview site.
-# The first line will also be used as the subject of the review.
-"""
-      if 'BUG=' not in log_desc:
-        log_desc += '\nBUG='
-      if 'TEST=' not in log_desc:
-        log_desc += '\nTEST='
-      change_desc = UserEditedLog(initial_text + log_desc)
-      subject = ''
-      if change_desc:
-        subject = change_desc.splitlines()[0]
-    if not change_desc:
+    change_desc = ChangeDescription(options.message, log_desc,
+                                    options.reviewers)
+    if not options.from_logs:
+      change_desc.Update()
+
+    if change_desc.IsEmpty():
       print "Description is empty; aborting."
       return 1
-    upload_args.extend(['--message', subject])
-    upload_args.extend(['--description', change_desc])
+
+    upload_args.extend(['--message', change_desc.subject])
+    upload_args.extend(['--description', change_desc.description])
+    if change_desc.reviewers:
+      upload_args.extend(['--reviewers', change_desc.reviewers])
     cc = ','.join(filter(None, (settings.GetCCList(), options.cc)))
     if cc:
       upload_args.extend(['--cc', cc])
 
   # Include the upstream repo's URL in the change -- this is useful for
   # projects that have their source spread across multiple repos.
   remote_url = None
   if settings.GetIsGitSvn():
     # URL is dependent on the current directory.
     data = RunGit(['svn', 'info'], cwd=settings.GetRoot())
@@ skipping 11 matching lines @@
   try:
     issue, patchset = upload.RealMain(['upload'] + upload_args + args)
   except:
     # If we got an exception after the user typed a description for their
     # change, back up the description before re-raising.
     if change_desc:
       backup_path = os.path.expanduser(DESCRIPTION_BACKUP_FILE)
       print '\nGot exception while uploading -- saving description to %s\n' \
           % backup_path
       backup_file = open(backup_path, 'w')
-      backup_file.write(change_desc)
+      backup_file.write(change_desc.description)
       backup_file.close()
     raise
 
   if not cl.GetIssue():
     cl.SetIssue(issue)
   cl.SetPatchset(patchset)
   return 0
 
 
 def SendUpstream(parser, args, cmd):
@@ skipping 47 matching lines @@
     svn_head = RunGit(['log', '--grep=^git-svn-id:', '-1',
                        '--pretty=format:%H'])
     extra_commits = RunGit(['rev-list', '^' + svn_head, base_branch])
     if extra_commits:
       print ('This branch has %d additional commits not upstreamed yet.'
              % len(extra_commits.splitlines()))
       print ('Upstream "%s" or rebase this branch on top of the upstream trunk '
              'before attempting to %s.' % (base_branch, cmd))
       return 1
 
-  if not options.force and not options.bypass_hooks:
-    RunHook(committing=False, upstream_branch=base_branch)
+  if not options.bypass_hooks:
+    hook_results = RunHook(committing=True, upstream_branch=base_branch,
+                   rietveld_server=cl.GetRietveldServer(), tbr=options.tbr)
+    print hook_results.output
 
     if cmd == 'dcommit':
       # Check the tree status if the tree status URL is set.
       status = GetTreeStatus()
       if 'closed' == status:
         print ('The tree is closed.  Please wait for it to reopen. Use '
                '"git cl dcommit -f" to commit on a closed tree.')
         return 1
       elif 'unknown' == status:
         print ('Unable to determine tree status.  Please verify manually and '
@@ skipping 19 matching lines @@
 
     description += "\n\nReview URL: %s" % cl.GetIssueURL()
   else:
     if not description:
       # Submitting TBR.  See if there's already a description in Rietveld, else
       # create a template description. Eitherway, give the user a chance to edit
       # it to fill in the TBR= field.
       if cl.GetIssue():
         description = cl.GetDescription()
 
+      # TODO(dpranke): Update to use ChangeDescription object.
       if not description:
         description = """# Enter a description of the change.
 # This will be used as the change log for the commit.
 
 """
         description += CreateDescriptionFromLog(args)
 
       description = UserEditedLog(description + '\nTBR=')
 
     if not description:
@@ skipping 321 matching lines @@
             ('AppEngine is misbehaving and returned HTTP %d, again. Keep faith '
              'and retry or visit go/isgaeup.\n%s') % (e.code, str(e)))
 
   # Not a known command. Default to help.
   GenUsage(parser, 'help')
   return CMDhelp(parser, argv)
 
 
 if __name__ == '__main__':
   sys.exit(main(sys.argv[1:]))