add changes to presubmit needed for OWNERS support

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 subprocess
@@ skipping 35 matching lines @@
     return subprocess.Popen(cmd, **kwargs)
   except OSError, e:
     if e.errno == errno.EAGAIN and sys.platform == 'cygwin':
       DieWithError(
           'Visit '
           'http://code.google.com/p/chromium/wiki/CygwinDllRemappingFailure to '
           'learn how to fix this error; you need to rebase your cygwin dlls')
     raise
 
 
 def RunCommand(cmd, error_ok=False, error_message=None,

[M-A Ruel, 2011/03/08 19:58:32]

I want to merge this code into gclient_utils.CheckCallAndFilter() eventually.
For now it could be sufficient.

[Dirk Pranke, 2011/03/08 22:26:03]

I agree that would be good. I can look at doing that in a separate patch if you
like.

-               redirect_stdout=True, swallow_stderr=False, **kwargs):
+               redirect_stdout=True, swallow_stderr=False,
+               tee_filter=None, **kwargs):
   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 tee_filter:
+    output = ''
+    while True:
+      line = proc.stdout.readline()
+      if line == '' and proc.poll() != None:
+        break
+    if not tee_filter(line):
+      print line
+    output += line + '\n'
+  else:
+    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):
+  """First stab at a framework for letting hooks alter what happens next.

[M-A Ruel, 2011/03/08 19:58:32]

Can you define what it is instead?

Same for ChangeDescription

[Dirk Pranke, 2011/03/08 22:26:03]

Will do.

+  For now, all they can do is suggest reviewers."""
+  def __init__(self, output_from_hooks=None):
+    self.reviewers = []
+    self.output = None
+    self._ParseOutputFromHooks(output_from_hooks)
+
+  def print_output(self):
+    if self.output:
+      print '\n'.join(self.output)
+
+  def _ParseOutputFromHooks(self, output_from_hooks):
+    if not output_from_hooks:
+      return
+    lines = []
+    reviewer_regexp = re.compile('ADD: R=(.+)')
+    for l in output_from_hooks.split('\n'):

[M-A Ruel, 2011/03/08 19:58:32]

splitlines()

[Dirk Pranke, 2011/03/08 22:26:03]

I wasn't sure if this was a builtin on strings, and the docs I looked at lied to
me. Will change.

+      m = reviewer_regexp.match(l)
+      if m:
+        self.reviewers = m.group(1)

[M-A Ruel, 2011/03/08 19:58:32]

What about multiple R= lines?

[Dirk Pranke, 2011/03/08 22:26:03]

Obviously, this version doesn't support that. I'm not sure how common that is in
practice, but there doesn't seem to be any downside and it's trivial to add, so
I will add it.

+      else:
+        lines.append(l)
+    self.output = '\n'.join(lines)
+
+
+class ChangeDescription(object):
+  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 174 matching lines @@
   fileobj.close()
   os.remove(filename)
   stripcomment_re = re.compile(r'^#.*$', re.MULTILINE)
   return stripcomment_re.sub('', text).strip()
 
 
 def RunHook(hook, upstream_branch, error_ok=False):
   """Run a given hook if it exists. By default, we fail on errors."""
   hook = '%s/%s' % (settings.GetRoot(), hook)
   if not os.path.exists(hook):
-    return
-  return RunCommand([hook, upstream_branch], error_ok=error_ok,
-                    redirect_stdout=False)
+    return HookResults()
+
+  output = RunCommand([hook, upstream_branch], error_ok=error_ok,
+                      redirect_stdout=True,
+                      tee_filter=lambda l: l.startswith('ADD:'))
+  return HookResults(output)
 
 
 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
 
   if args:
     base_branch = args[0]
   else:
     # Default to diffing against the "upstream" branch.
     base_branch = Changelist().GetUpstreamBranch()
 
   if options.upload:
     print '*** Presubmit checks for UPLOAD would report: ***'
     return not RunHook(PREUPLOAD_HOOK, upstream_branch=base_branch,
-        error_ok=True)
+        error_ok=True).output
   else:
     print '*** Presubmit checks for DCOMMIT would report: ***'
     return not RunHook(PREDCOMMIT_HOOK, upstream_branch=base_branch,
-        error_ok=True)
+        error_ok=True).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(PREUPLOAD_HOOK, upstream_branch=base_branch, error_ok=False)
+    hook_results = RunHook(PREUPLOAD_HOOK, upstream_branch=base_branch,
+                           error_ok=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 88 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 326 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:]))