repopick: initial commit
Change-Id: Ie42c11d335da07f6d164a0fcb887011e5fd6dcf4
repopick: add -b shortcut option
* useful for people like me who want to pick into temp branch so
that the picks survive a repo sync
* shortcut to "--start-branch auto --abandon-first --ignore-missing"
Change-Id: Ia4d4309d27e46a15ff4b74525668d974f4251dcb
repopick: handle additional error cases around subprocesses
* gracefully error if the project path cannot be found
* poll() was not a reliable determination of EOF on my
Darwin-Python 2.7 system.
Change-Id: I203c2a75820f8acc079a5c9751d1c04daf6f3a16
repopick: allow running from a subdir of ANDROID_BUILD_TOP
Change-Id: I6dfcd5dfe700174ed87dc8627b23519c62b4cb27
envsetup: hmm repopick
Change-Id: I483cb36721f31dbf1f67e46cbe8a306b2a9e2c15
Conflicts:
envsetup.sh
diff --git a/tools/repopick.py b/tools/repopick.py
new file mode 100755
index 0000000..ea7227e
--- /dev/null
+++ b/tools/repopick.py
@@ -0,0 +1,250 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2013 The CyanogenMod Project
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+#
+# Run repopick.py -h for a description of this utility.
+#
+
+from __future__ import print_function
+
+import sys
+import json
+import os
+import subprocess
+import re
+import argparse
+import textwrap
+
+try:
+ # For python3
+ import urllib.request
+except ImportError:
+ # For python2
+ import imp
+ import urllib2
+ urllib = imp.new_module('urllib')
+ urllib.request = urllib2
+
+# Parse the command line
+parser = argparse.ArgumentParser(formatter_class=argparse.RawDescriptionHelpFormatter, description=textwrap.dedent('''\
+ repopick.py is a utility to simplify the process of cherry picking
+ patches from CyanogenMod's Gerrit instance.
+
+ Given a list of change numbers, repopick will cd into the project path
+ and cherry pick the latest patch available.
+
+ With the --start-branch argument, the user can specify that a branch
+ should be created before cherry picking. This is useful for
+ cherry-picking many patches into a common branch which can be easily
+ abandoned later (good for testing other's changes.)
+
+ The --abandon-first argument, when used in conjuction with the
+ --start-branch option, will cause repopick to abandon the specified
+ branch in all repos first before performing any cherry picks.'''))
+parser.add_argument('change_number', nargs='+', help='change number to cherry pick')
+parser.add_argument('-i', '--ignore-missing', action='store_true', help='do not error out if a patch applies to a missing directory')
+parser.add_argument('-s', '--start-branch', nargs=1, help='start the specified branch before cherry picking')
+parser.add_argument('-a', '--abandon-first', action='store_true', help='before cherry picking, abandon the branch specified in --start-branch')
+parser.add_argument('-b', '--auto-branch', action='store_true', help='shortcut to "--start-branch auto --abandon-first --ignore-missing"')
+parser.add_argument('-q', '--quiet', action='store_true', help='print as little as possible')
+parser.add_argument('-v', '--verbose', action='store_true', help='print extra information to aid in debug')
+args = parser.parse_args()
+if args.start_branch == None and args.abandon_first:
+ parser.error('if --abandon-first is set, you must also give the branch name with --start-branch')
+if args.auto_branch:
+ args.abandon_first = True
+ args.ignore_missing = True
+ if not args.start_branch:
+ args.start_branch = ['auto']
+if args.quiet and args.verbose:
+ parser.error('--quiet and --verbose cannot be specified together')
+
+# Helper function to determine whether a path is an executable file
+def is_exe(fpath):
+ return os.path.isfile(fpath) and os.access(fpath, os.X_OK)
+
+# Implementation of Unix 'which' in Python
+#
+# From: http://stackoverflow.com/questions/377017/test-if-executable-exists-in-python
+def which(program):
+ fpath, fname = os.path.split(program)
+ if fpath:
+ if is_exe(program):
+ return program
+ else:
+ for path in os.environ["PATH"].split(os.pathsep):
+ path = path.strip('"')
+ exe_file = os.path.join(path, program)
+ if is_exe(exe_file):
+ return exe_file
+
+ return None
+
+# Simple wrapper for os.system() that:
+# - exits on error
+# - prints out the command if --verbose
+# - suppresses all output if --quiet
+def execute_cmd(cmd):
+ if args.verbose:
+ print('Executing: %s' % cmd)
+ if args.quiet:
+ cmd = cmd.replace(' && ', ' &> /dev/null && ')
+ cmd = cmd + " &> /dev/null"
+ if os.system(cmd):
+ if not args.verbose:
+ print('\nCommand that failed:\n%s' % cmd)
+ sys.exit(1)
+
+# Verifies whether pathA is a subdirectory (or the same) as pathB
+def is_pathA_subdir_of_pathB(pathA, pathB):
+ pathA = os.path.realpath(pathA) + '/'
+ pathB = os.path.realpath(pathB) + '/'
+ return(pathB == pathA[:len(pathB)])
+
+# Find the necessary bins - repo
+repo_bin = which('repo')
+if repo_bin == None:
+ repo_bin = os.path.join(os.environ["HOME"], 'repo')
+ if not is_exe(repo_bin):
+ sys.stderr.write('ERROR: Could not find the repo program in either $PATH or $HOME/bin\n')
+ sys.exit(1)
+
+# Find the necessary bins - git
+git_bin = which('git')
+if not is_exe(git_bin):
+ sys.stderr.write('ERROR: Could not find the git program in $PATH\n')
+ sys.exit(1)
+
+# Change current directory to the top of the tree
+if 'ANDROID_BUILD_TOP' in os.environ:
+ top = os.environ['ANDROID_BUILD_TOP']
+ if not is_pathA_subdir_of_pathB(os.getcwd(), top):
+ sys.stderr.write('ERROR: You must run this tool from within $ANDROID_BUILD_TOP!\n')
+ sys.exit(1)
+ os.chdir(os.environ['ANDROID_BUILD_TOP'])
+
+# Sanity check that we are being run from the top level of the tree
+if not os.path.isdir('.repo'):
+ sys.stderr.write('ERROR: No .repo directory found. Please run this from the top of your tree.\n')
+ sys.exit(1)
+
+# If --abandon-first is given, abandon the branch before starting
+if args.abandon_first:
+ # Determine if the branch already exists; skip the abandon if it does not
+ plist = subprocess.Popen([repo_bin,"info"], stdout=subprocess.PIPE)
+ needs_abandon = False
+ while(True):
+ pline = plist.stdout.readline().rstrip()
+ if not pline:
+ break
+ matchObj = re.match(r'Local Branches.*\[(.*)\]', pline.decode())
+ if matchObj:
+ local_branches = re.split('\s*,\s*', matchObj.group(1))
+ if any(args.start_branch[0] in s for s in local_branches):
+ needs_abandon = True
+ break
+
+ if needs_abandon:
+ # Perform the abandon only if the branch already exists
+ if not args.quiet:
+ print('Abandoning branch: %s' % args.start_branch[0])
+ cmd = '%s abandon %s' % (repo_bin, args.start_branch[0])
+ execute_cmd(cmd)
+ if not args.quiet:
+ print('')
+
+# Iterate through the requested change numbers
+for change in args.change_number:
+ if not args.quiet:
+ print('Applying change number %s ...' % change)
+
+ # Fetch information about the change from Gerrit's REST API
+ #
+ # gerrit returns two lines, a magic string and then valid JSON:
+ # )]}'
+ # [ ... valid JSON ... ]
+ url = 'http://review.cyanogenmod.org/changes/?q=%s&o=CURRENT_REVISION&o=CURRENT_COMMIT&pp=0' % change
+ if args.verbose:
+ print('Fetching from: %s\n' % url)
+ f = urllib.request.urlopen(url)
+ d = f.read().decode()
+
+ # Parse the result
+ if args.verbose:
+ print('Result from request:\n' + d)
+ d = d.split('\n')[1]
+ d = re.sub(r'\[(.*)\]', r'\1', d)
+ data = json.loads(d)
+
+ # Extract information from the JSON response
+ project_name = data['project']
+ change_number = data['_number']
+ current_revision = data['revisions'][data['current_revision']]
+ patch_number = current_revision['_number']
+ fetch_url = current_revision['fetch']['http']['url']
+ fetch_ref = current_revision['fetch']['http']['ref']
+ author_name = current_revision['commit']['author']['name']
+ author_email = current_revision['commit']['author']['email']
+ author_date = current_revision['commit']['author']['date']
+ committer_name = current_revision['commit']['committer']['name']
+ committer_email = current_revision['commit']['committer']['email']
+ committer_date = current_revision['commit']['committer']['date']
+ subject = current_revision['commit']['subject']
+
+ # Get the list of projects that repo knows about
+ # - convert the project name to a project path
+ plist = subprocess.Popen([repo_bin,"list"], stdout=subprocess.PIPE)
+ while(True):
+ pline = plist.stdout.readline().rstrip()
+ if not pline:
+ break
+ ppaths = re.split('\s*:\s*', pline.decode())
+ if ppaths[1] == project_name:
+ project_path = ppaths[0]
+ break
+ if 'project_path' not in locals():
+ sys.stderr.write('ERROR: Could not determine the project path for project %s\n' % project_name)
+ sys.exit(1)
+
+ # Check that the project path exists
+ if not os.path.isdir(project_path):
+ if args.ignore_missing:
+ print('WARNING: Skipping %d since there is no project directory: %s\n' % (change_number, project_path))
+ continue;
+ else:
+ sys.stderr.write('ERROR: For %d, there is no project directory: %s\n' % (change_number, project_path))
+ sys.exit(1)
+
+ # If --start-branch is given, create the branch (more than once per path is okay; repo ignores gracefully)
+ if args.start_branch:
+ cmd = '%s start %s %s' % (repo_bin, args.start_branch[0], project_path)
+ execute_cmd(cmd)
+
+ # Print out some useful info
+ if not args.quiet:
+ print('--> Subject: "%s"' % subject)
+ print('--> Project path: %s' % project_path)
+ print('--> Change number: %d (Patch Set %d)' % (change_number, patch_number))
+ print('--> Author: %s <%s> %s' % (author_name, author_email, author_date))
+ print('--> Committer: %s <%s> %s' % (committer_name, committer_email, committer_date))
+
+ # Perform the cherry-pick
+ cmd = 'cd %s && git fetch %s %s && git cherry-pick FETCH_HEAD' % (project_path, fetch_url, fetch_ref)
+ execute_cmd(cmd)
+ if not args.quiet:
+ print('')
+