blob: 616fb6036d36c1e626413839e3f056bfb0e3694e [file] [log] [blame]
#!/usr/bin/env python
# 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.
"""Rolls DEPS controlled dependency.
Works only with git checkout and git dependencies. Currently this
script will always roll to the tip of to origin/master.
import argparse
import collections
import gclient_eval
import os
import re
import subprocess
import sys
NEED_SHELL = sys.platform.startswith('win')
GCLIENT_PATH = os.path.join(
os.path.dirname(os.path.abspath(__file__)), '')
# Commit subject that will be considered a roll. In the format generated by the
# git log used, so it's "<year>-<month>-<day> <author> <subject>"
_ROLL_SUBJECT = re.compile(
# Date
r'^\d\d\d\d-\d\d-\d\d '
# Author
r'[^ ]+ '
# Subject
# Generated by
r'Roll [^ ]+ [a-f0-9]+\.\.[a-f0-9]+ \(\d+ commits\)'
# Generated by
r'Roll recipe dependencies \(trivial\)\.'
class Error(Exception):
class AlreadyRolledError(Error):
def check_output(*args, **kwargs):
"""subprocess.check_output() passing shell=True on Windows for git."""
kwargs.setdefault('shell', NEED_SHELL)
return subprocess.check_output(*args, **kwargs)
def check_call(*args, **kwargs):
"""subprocess.check_call() passing shell=True on Windows for git."""
kwargs.setdefault('shell', NEED_SHELL)
subprocess.check_call(*args, **kwargs)
def is_pristine(root, merge_base='origin/master'):
"""Returns True if a git checkout is pristine."""
cmd = ['git', 'diff', '--ignore-submodules', merge_base]
return not (check_output(cmd, cwd=root).strip() or
check_output(cmd + ['--cached'], cwd=root).strip())
def get_log_url(upstream_url, head, master):
"""Returns an URL to read logs via a Web UI if applicable."""
if re.match(r'https://[^/]*\.googlesource\.com/', upstream_url):
# gitiles
return '%s/+log/%s..%s' % (upstream_url, head[:12], master[:12])
if upstream_url.startswith(''):
upstream_url = upstream_url.rstrip('/')
if upstream_url.endswith('.git'):
upstream_url = upstream_url[:-len('.git')]
return '%s/compare/%s...%s' % (upstream_url, head[:12], master[:12])
return None
def should_show_log(upstream_url):
"""Returns True if a short log should be included in the tree."""
# Skip logs for very active projects.
if upstream_url.endswith('/v8/v8.git'):
return False
if 'webrtc' in upstream_url:
return False
return True
def gclient(args):
"""Executes gclient with the given args and returns the stdout."""
return check_output([sys.executable, GCLIENT_PATH] + args).strip()
def generate_commit_message(
full_dir, dependency, head, roll_to, no_log, log_limit):
"""Creates the commit message for this specific roll."""
commit_range = '%s..%s' % (head[:9], roll_to[:9])
upstream_url = check_output(
['git', 'config', 'remote.origin.url'], cwd=full_dir).strip()
log_url = get_log_url(upstream_url, head, roll_to)
cmd = ['git', 'log', commit_range, '--date=short', '--no-merges']
logs = check_output(
cmd + ['--format=%ad %ae %s'], # Args with '=' are automatically quoted.
logs = re.sub(r'(?m)^(\d\d\d\d-\d\d-\d\d [^@]+)@[^ ]+( .*)$', r'\1\2', logs)
lines = logs.splitlines()
cleaned_lines = [l for l in lines if not _ROLL_SUBJECT.match(l)]
logs = '\n'.join(cleaned_lines) + '\n'
nb_commits = len(lines)
rolls = nb_commits - len(cleaned_lines)
header = 'Roll %s/ %s (%d commit%s%s)\n\n' % (
's' if nb_commits > 1 else '',
('; %s trivial rolls' % rolls) if rolls else '')
log_section = ''
if log_url:
log_section = log_url + '\n\n'
log_section += '$ %s ' % ' '.join(cmd)
log_section += '--format=\'%ad %ae %s\'\n'
# It is important that --no-log continues to work, as it is used by
# internal -> external rollers. Please do not remove or break it.
if not no_log and should_show_log(upstream_url):
if len(cleaned_lines) > log_limit:
# Keep the first N/2 log entries and last N/2 entries.
lines = logs.splitlines(True)
lines = lines[:log_limit/2] + ['(...)\n'] + lines[-log_limit/2:]
logs = ''.join(lines)
log_section += logs
return header + log_section
def calculate_roll(full_dir, dependency, roll_to):
"""Calculates the roll for a dependency by processing gclient_dict, and
fetching the dependency via git.
head = gclient(['getdep', '-r', dependency])
if not head:
raise Error('%s is unpinned.' % dependency)
check_call(['git', 'fetch', 'origin', '--quiet'], cwd=full_dir)
roll_to = check_output(['git', 'rev-parse', roll_to], cwd=full_dir).strip()
return head, roll_to
def gen_commit_msg(logs, cmdline, reviewers, bug):
"""Returns the final commit message."""
commit_msg = ''
if len(logs) > 1:
commit_msg = 'Rolling %d dependencies\n\n' % len(logs)
commit_msg += '\n\n'.join(logs)
commit_msg += '\nCreated with:\n ' + cmdline + '\n'
commit_msg += 'R=%s\n' % ','.join(reviewers) if reviewers else ''
commit_msg += '\nBug: %s\n' % bug if bug else ''
return commit_msg
def finalize(commit_msg, current_dir, rolls):
"""Commits changes to the DEPS file, then uploads a CL."""
print('Commit message:')
print('\n'.join(' ' + i for i in commit_msg.splitlines()))
check_call(['git', 'add', 'DEPS'], cwd=current_dir)
check_call(['git', 'commit', '--quiet', '-m', commit_msg], cwd=current_dir)
# Pull the dependency to the right revision. This is surprising to users
# otherwise.
for _head, roll_to, full_dir in sorted(rolls.itervalues()):
check_call(['git', 'checkout', '--quiet', roll_to], cwd=full_dir)
def main():
parser = argparse.ArgumentParser(description=__doc__)
'--ignore-dirty-tree', action='store_true',
help='Roll anyways, even if there is a diff.')
'-r', '--reviewer',
help='To specify multiple reviewers, use comma separated list, e.g. '
'-r joe,jane,john. Defaults to')
parser.add_argument('-b', '--bug', help='Associate a bug number to the roll')
# It is important that --no-log continues to work, as it is used by
# internal -> external rollers. Please do not remove or break it.
'--no-log', action='store_true',
help='Do not include the short log in the commit message')
'--log-limit', type=int, default=100,
help='Trim log after N commits (default: %(default)s)')
'--roll-to', default='origin/master',
help='Specify the new commit to roll to (default: %(default)s)')
'--key', action='append', default=[],
help='Regex(es) for dependency in DEPS file')
parser.add_argument('dep_path', nargs='+', help='Path(s) to dependency')
args = parser.parse_args()
if len(args.dep_path) > 1:
if args.roll_to != 'origin/master':
'Can\'t use multiple paths to roll simultaneously and --roll-to')
if args.key:
'Can\'t use multiple paths to roll simultaneously and --key')
reviewers = None
if args.reviewer:
reviewers = args.reviewer.split(',')
for i, r in enumerate(reviewers):
if not '@' in r:
reviewers[i] = r + ''
gclient_root = gclient(['root'])
current_dir = os.getcwd()
dependencies = sorted(d.rstrip('/').rstrip('\\') for d in args.dep_path)
cmdline = 'roll-dep ' + ' '.join(dependencies) + ''.join(
' --key ' + k for k in args.key)
if not args.ignore_dirty_tree and not is_pristine(current_dir):
raise Error(
'Ensure %s is clean first (no non-merged commits).' % current_dir)
# First gather all the information without modifying anything, except for a
# git fetch.
rolls = {}
for dependency in dependencies:
full_dir = os.path.normpath(os.path.join(gclient_root, dependency))
if not os.path.isdir(full_dir):
print('Dependency %s not found at %s' % (dependency, full_dir))
full_dir = os.path.normpath(os.path.join(current_dir, dependency))
print('Will look for relative dependency at %s' % full_dir)
if not os.path.isdir(full_dir):
raise Error('Directory not found: %s (%s)' % (dependency, full_dir))
head, roll_to = calculate_roll(full_dir, dependency, args.roll_to)
if roll_to == head:
if len(dependencies) == 1:
raise AlreadyRolledError('No revision to roll!')
print('%s: Already at latest commit %s' % (dependency, roll_to))
'%s: Rolling from %s to %s' % (dependency, head[:10], roll_to[:10]))
rolls[dependency] = (head, roll_to, full_dir)
logs = []
setdep_args = []
for dependency, (head, roll_to, full_dir) in sorted(rolls.iteritems()):
log = generate_commit_message(
full_dir, dependency, head, roll_to, args.no_log, args.log_limit)
setdep_args.extend(['-r', '{}@{}'.format(dependency, roll_to)])
gclient(['setdep'] + setdep_args)
commit_msg = gen_commit_msg(logs, cmdline, reviewers, args.bug)
finalize(commit_msg, current_dir, rolls)
except Error as e:
sys.stderr.write('error: %s\n' % e)
return 2 if isinstance(e, AlreadyRolledError) else 1
if not reviewers:
print('You forgot to pass -r, make sure to insert a line')
print('to the commit description before emailing.')
print(' git cl upload --send-mail')
return 0
if __name__ == '__main__':