autoroller: Always roll and improve description

tools/autoroller/roll_chromium_revision.py

 #!/usr/bin/env python
 # Copyright (c) 2015 The WebRTC project authors. All Rights Reserved.
 #
 # Use of this source code is governed by a BSD-style license
 # that can be found in the LICENSE file in the root of the source
 # tree. An additional intellectual property rights grant can be found
 # in the file PATENTS.  All contributing project authors may
 # be found in the AUTHORS file in the root of the source tree.
 
 """Script to roll chromium_revision in the WebRTC DEPS file."""
 
 import argparse
 import base64
 import collections
 import logging
 import os
 import re
 import subprocess
 import sys
 import urllib
 
 
 CHROMIUM_LKGR_URL = 'https://chromium-status.appspot.com/lkgr'
 CHROMIUM_SRC_URL = 'https://chromium.googlesource.com/chromium/src'
 CHROMIUM_COMMIT_TEMPLATE = CHROMIUM_SRC_URL + '/+/%s'
+CHROMIUM_LOG_TEMPLATE = CHROMIUM_SRC_URL + '/+log/%s'
 CHROMIUM_FILE_TEMPLATE = CHROMIUM_SRC_URL + '/+/%s/%s'
 
 COMMIT_POSITION_RE = re.compile('^Cr-Commit-Position: .*#([0-9]+).*$')
 CLANG_REVISION_RE = re.compile(r'^CLANG_REVISION=(\d+)$')
 ROLL_BRANCH_NAME = 'roll_chromium_revision'
 
 SCRIPT_DIR = os.path.dirname(os.path.abspath(__file__))
 CHECKOUT_ROOT_DIR = os.path.realpath(os.path.join(SCRIPT_DIR, os.pardir,
                                                   os.pardir))
 sys.path.append(CHECKOUT_ROOT_DIR)
 import setup_links
 
 sys.path.append(os.path.join(CHECKOUT_ROOT_DIR, 'tools'))
 import find_depot_tools
 find_depot_tools.add_depot_tools_to_path()
 from gclient import GClientKeywords
 
 CLANG_UPDATE_SCRIPT_URL_PATH = 'tools/clang/scripts/update.sh'
 CLANG_UPDATE_SCRIPT_LOCAL_PATH = os.path.join('tools', 'clang', 'scripts',
                                               'update.sh')
 
 DepsEntry = collections.namedtuple('DepsEntry', 'path url revision')
-ChangedDep = collections.namedtuple('ChangedDep', 'path current_rev new_rev')
+ChangedDep = collections.namedtuple('ChangedDep',
+                                    'path url current_rev new_rev')
 
 
 def ParseDepsDict(deps_content):
   local_scope = {}
   var = GClientKeywords.VarImpl({}, local_scope)
   global_scope = {
     'File': GClientKeywords.FileImpl,
     'From': GClientKeywords.FromImpl,
     'Var': var.Lookup,
     'deps_os': {},
@@ skipping 154 matching lines @@
   for deps_dir in all_deps_dirs:
     # All deps have 'src' prepended to the path in the Chromium DEPS file.
     dir_path = 'src/%s' % deps_dir
 
     for entry in GetMatchingDepsEntries(current_entries, dir_path):
       new_matching_entries = GetMatchingDepsEntries(new_entries, entry.path)
       assert len(new_matching_entries) <= 1, (
           'Should never find more than one entry matching %s in %s, found %d' %
           (entry.path, new_entries, len(new_matching_entries)))
       if not new_matching_entries:
-        result.append(ChangedDep(entry.path, entry.revision, 'None'))
+        result.append(ChangedDep(entry.path, entry.url, entry.revision, 'None'))
       elif entry != new_matching_entries[0]:
-        result.append(ChangedDep(entry.path, entry.revision,
+        result.append(ChangedDep(entry.path, entry.url, entry.revision,
                                  new_matching_entries[0].revision))
   return result
 
 
 def CalculateChangedClang(new_cr_rev):
   def GetClangRev(lines):
     for line in lines:
       match = CLANG_REVISION_RE.match(line)
       if match:
         return match.group(1)
     return None
 
   chromium_src_path = os.path.join(CHECKOUT_ROOT_DIR, 'chromium', 'src',
                                    CLANG_UPDATE_SCRIPT_LOCAL_PATH)
   with open(chromium_src_path, 'rb') as f:
     current_lines = f.readlines()
   current_rev = GetClangRev(current_lines)
 
   new_clang_update_sh = ReadRemoteCrFile(CLANG_UPDATE_SCRIPT_URL_PATH,
                                          new_cr_rev).splitlines()
   new_rev = GetClangRev(new_clang_update_sh)
-  return ChangedDep(CLANG_UPDATE_SCRIPT_LOCAL_PATH, current_rev, new_rev)
+  return ChangedDep(CLANG_UPDATE_SCRIPT_LOCAL_PATH, None, current_rev, new_rev)
 
 
-def GenerateCommitMessage(current_cr_rev, new_cr_rev, changed_deps_list,
-                          clang_change):
+def GenerateCommitMessage(current_cr_rev, new_cr_rev, current_git_number,
+                          new_git_number, changed_deps_list, clang_change):
   current_cr_rev = current_cr_rev[0:7]
   new_cr_rev = new_cr_rev[0:7]
   rev_interval = '%s..%s' % (current_cr_rev, new_cr_rev)
-
-  current_git_number = ParseCommitPosition(ReadRemoteCrCommit(current_cr_rev))
-  new_git_number = ParseCommitPosition(ReadRemoteCrCommit(new_cr_rev))
   git_number_interval = '%s:%s' % (current_git_number, new_git_number)
 
-  commit_msg = ['Roll chromium_revision %s (%s)' % (rev_interval,
+  commit_msg = ['Roll chromium_revision %s (%s)\n' % (rev_interval,
                                                     git_number_interval)]
-
+  commit_msg.append('Change log: %s' % (CHROMIUM_LOG_TEMPLATE % rev_interval))
+  commit_msg.append('Full diff: %s\n' % (CHROMIUM_COMMIT_TEMPLATE %
+                                         rev_interval))
   if changed_deps_list:
-    commit_msg.append('\nRelevant changes:')
+    commit_msg.append('Changed dependencies:')
 
     for c in changed_deps_list:
-      commit_msg.append('* %s: %s..%s' % (c.path, c.current_rev[0:7],
-                                          c.new_rev[0:7]))
-
+      commit_msg.append('* %s: %s/+log/%s..%s' % (c.path, c.url,
+                                                  c.current_rev[0:7],
+                                                  c.new_rev[0:7]))
     change_url = CHROMIUM_FILE_TEMPLATE % (rev_interval, 'DEPS')
-    commit_msg.append('Details: %s' % change_url)
+    commit_msg.append('DEPS diff: %s\n' % change_url)
+  else:
+    commit_msg.append('No dependencies changed.')
 
   if clang_change.current_rev != clang_change.new_rev:
-    commit_msg.append('\nClang version changed %s:%s' %
+    commit_msg.append('Clang version changed %s:%s' %
                       (clang_change.current_rev, clang_change.new_rev))
     change_url = CHROMIUM_FILE_TEMPLATE % (rev_interval,
                                            CLANG_UPDATE_SCRIPT_URL_PATH)
     commit_msg.append('Details: %s' % change_url)
   else:
-    commit_msg.append('\nClang version was not updated in this roll.')
+    commit_msg.append('No update to Clang.')
   return '\n'.join(commit_msg)
 
 
 def UpdateDeps(deps_filename, old_cr_revision, new_cr_revision):
   """Update the DEPS file with the new revision."""
   with open(deps_filename, 'rb') as deps_file:
     deps_content = deps_file.read()
   deps_content = deps_content.replace(old_cr_revision, new_cr_revision)
   with open(deps_filename, 'wb') as deps_file:
     deps_file.write(deps_content)
@@ skipping 60 matching lines @@
   p = argparse.ArgumentParser()
   p.add_argument('--clean', action='store_true', default=False,
                  help='Removes any previous local roll branch.')
   p.add_argument('-r', '--revision',
                  help=('Chromium Git revision to roll to. Defaults to the '
                        'Chromium LKGR revision if omitted.'))
   p.add_argument('--dry-run', action='store_true', default=False,
                  help=('Calculate changes and modify DEPS, but don\'t create '
                        'any local branch, commit, upload CL or send any '
                        'tryjobs.'))
+  p.add_argument('--allow-reverse', action='store_true', default=False,
+                 help=('Allow rolling back in time (disabled by default but '
+                       'may be useful to be able do to manually).'))
   p.add_argument('-s', '--skip-try', action='store_true', default=False,
                  help='Do everything except sending tryjobs.')
   p.add_argument('-v', '--verbose', action='store_true', default=False,
                  help='Be extra verbose in printing of log messages.')
   opts = p.parse_args()
 
   if opts.verbose:
     logging.basicConfig(level=logging.DEBUG)
   else:
     logging.basicConfig(level=logging.INFO)
 
   if not _IsTreeClean():
     logging.error('Please clean your local checkout first.')
     return 1
 
   if opts.clean:
     _RemovePreviousRollBranch(opts.dry_run)
 
   _EnsureUpdatedMasterBranch(opts.dry_run)
 
-  if not opts.revision:
+  new_cr_rev = opts.revision
+  if not new_cr_rev:
     lkgr_contents = ReadUrlContent(CHROMIUM_LKGR_URL)
     logging.info('No revision specified. Using LKGR: %s', lkgr_contents[0])
-    opts.revision = lkgr_contents[0]
+    new_cr_rev = lkgr_contents[0]
 
   deps_filename = os.path.join(CHECKOUT_ROOT_DIR, 'DEPS')
   local_deps = ParseLocalDepsFile(deps_filename)
   current_cr_rev = local_deps['vars']['chromium_revision']
 
+  current_git_number = ParseCommitPosition(ReadRemoteCrCommit(current_cr_rev))

[phoglund, 2015/10/02 06:53:42]

Nit: current_git_pos or current_commit_pos? That introduces less concepts than
if we're talking about both git numbers and git commit positions.

[kjellander_webrtc, 2015/10/02 07:10:36]

Good idea, I incorporated it in PS#3.

+  new_git_number = ParseCommitPosition(ReadRemoteCrCommit(new_cr_rev))

[phoglund, 2015/10/02 06:53:42]

Ditto

[kjellander_webrtc, 2015/10/02 07:10:36]

Done.

+
   current_cr_deps = ParseRemoteCrDepsFile(current_cr_rev)
-  new_cr_deps = ParseRemoteCrDepsFile(opts.revision)
+  new_cr_deps = ParseRemoteCrDepsFile(new_cr_rev)
 
-  changed_deps = sorted(CalculateChangedDeps(current_cr_deps, new_cr_deps))
-  clang_change = CalculateChangedClang(opts.revision)
-  if changed_deps or clang_change:
-    commit_msg = GenerateCommitMessage(current_cr_rev, opts.revision,
+  if new_git_number > current_git_number or opts.allow_reverse:
+    changed_deps = sorted(CalculateChangedDeps(current_cr_deps, new_cr_deps))
+    clang_change = CalculateChangedClang(new_cr_rev)
+    commit_msg = GenerateCommitMessage(current_cr_rev, new_cr_rev,
+                                       current_git_number, new_git_number,
                                        changed_deps, clang_change)
     logging.debug('Commit message:\n%s', commit_msg)
   else:
-    logging.info('No deps changes detected when rolling from %s to %s. '
-                 'Aborting without action.', current_cr_rev, opts.revision)
+    logging.info('Currently pinned chromium_revision: %s (#%s) is newer than '
+                 '%s (#%s). To roll to older revisions, you must pass the '
+                 '--allow-reverse flag.\n'
+                 'Aborting without action.', current_cr_rev, current_git_number,
+                 new_cr_rev, new_git_number)
     return 0
 
   _CreateRollBranch(opts.dry_run)
-  UpdateDeps(deps_filename, current_cr_rev, opts.revision)
+  UpdateDeps(deps_filename, current_cr_rev, new_cr_rev)
   _LocalCommit(commit_msg, opts.dry_run)
   _UploadCL(opts.dry_run)
   _LaunchTrybots(opts.dry_run, opts.skip_try)
   return 0
 
 
 if __name__ == '__main__':
   sys.exit(main())