Merge branch 'stable-2.6'

* stable-2.6:
  TrivialRebase: Correctly handle empty patch-id
  TrivialRebase: Support alternative ssh executable
  TrivialRebase: Add server argument
  TrivialRebase: Make private key argument optional
  TrivialRebase: Pipe subprocesses directly
  TrivialRebase: Skip unsupported categories
  TrivialRebase: Raise exception on error
  TrivialRebase: Refactor as a class
  Read initial ack for scp
This commit is contained in:
Shawn Pearce
2013-04-11 17:56:26 -07:00
2 changed files with 177 additions and 163 deletions

View File

@@ -38,187 +38,200 @@ import argparse
import json import json
import re import re
import subprocess import subprocess
import sys
class CheckCallError(OSError): class TrivialRebase:
"""CheckCall() returned non-0.""" def __init__(self):
def __init__(self, command, cwd, retcode, stdout, stderr=None): usage = "%(prog)s <required options> [--server-port=PORT]"
OSError.__init__(self, command, cwd, retcode, stdout, stderr) parser = argparse.ArgumentParser(usage=usage)
self.command = command parser.add_argument("--change-url", dest="changeUrl", help="Change URL")
self.cwd = cwd parser.add_argument("--project", help="Project path in Gerrit")
self.retcode = retcode parser.add_argument("--commit", help="Git commit-ish for this patchset")
self.stdout = stdout parser.add_argument("--patchset", type=int, help="The patchset number")
self.stderr = stderr parser.add_argument("--private-key-path", dest="private_key_path",
help="Full path to Gerrit SSH daemon's private host key")
parser.add_argument("--server", default='localhost',
help="Gerrit SSH server [default: %(default)s]")
parser.add_argument("--server-port", dest="port", default='29418',
help="Port to connect to Gerrit's SSH daemon "
"[default: %(default)s]")
parser.add_argument("--ssh", default="ssh", help="SSH executable")
parser.add_argument("--ssh-port-flag", dest="ssh_port_flag", default="-p", help="SSH port flag")
def CheckCall(command, cwd=None): args = parser.parse_known_args()[0]
"""Like subprocess.check_call() but returns stdout. if None in [args.changeUrl, args.project, args.commit, args.patchset]:
parser.error("Incomplete arguments")
try:
self.changeId = re.search(r'\d+$', args.changeUrl).group()
except AttributeError:
parser.error("Invalid changeId")
self.project = args.project
self.commit = args.commit
self.patchset = args.patchset
self.private_key_path = args.private_key_path
self.server = args.server
self.port = args.port
self.ssh = args.ssh
self.ssh_port_flag = args.ssh_port_flag
Works on python 2.4 class CheckCallError(OSError):
""" """CheckCall() returned non-0."""
try: def __init__(self, command, cwd, retcode, stdout, stderr=None):
process = subprocess.Popen(command, cwd=cwd, stdout=subprocess.PIPE) OSError.__init__(self, command, cwd, retcode, stdout, stderr)
std_out, std_err = process.communicate() self.command = command
except OSError, e: self.cwd = cwd
raise CheckCallError(command, cwd, e.errno, None) self.retcode = retcode
if process.returncode: self.stdout = stdout
raise CheckCallError(command, cwd, process.returncode, std_out, std_err) self.stderr = stderr
return std_out, std_err
def GsqlQuery(sql_query, server, port): def CheckCall(self, command, cwd=None):
"""Runs a gerrit gsql query and returns the result""" """Like subprocess.check_call() but returns stdout.
gsql_cmd = ['ssh', '-p', port, server, 'gerrit', 'gsql', '--format',
'JSON', '-c', sql_query]
try:
(gsql_out, _gsql_stderr) = CheckCall(gsql_cmd)
except CheckCallError, e:
print "return code is %s" % e.retcode
print "stdout and stderr is\n%s%s" % (e.stdout, e.stderr)
raise
new_out = gsql_out.replace('}}\n', '}}\nsplit here\n') Works on python 2.4
return new_out.split('split here\n') """
try:
process = subprocess.Popen(command, cwd=cwd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
std_out, std_err = process.communicate()
except OSError, e:
raise self.CheckCallError(command, cwd, e.errno, None)
if process.returncode:
raise self.CheckCallError(command, cwd, process.returncode, std_out, std_err)
return std_out, std_err
def FindPrevRev(changeId, patchset, server, port): def GsqlQuery(self, sql_query):
"""Finds the revision of the previous patch set on the change""" """Runs a gerrit gsql query and returns the result"""
sql_query = ("\"SELECT revision FROM patch_sets WHERE " gsql_cmd = [self.ssh, self.ssh_port_flag, self.port, self.server, 'gerrit', 'gsql',
"change_id = %s AND patch_set_id = %s\"" % (changeId, (patchset - 1))) '--format', 'JSON', '-c', sql_query]
revisions = GsqlQuery(sql_query, server, port) try:
(gsql_out, _gsql_stderr) = self.CheckCall(gsql_cmd)
except self.CheckCallError, e:
print "return code is %s" % e.retcode
print "stdout and stderr is\n%s%s" % (e.stdout, e.stderr)
raise
json_dict = json.loads(revisions[0], strict=False) new_out = gsql_out.replace('}}\n', '}}\nsplit here\n')
return json_dict["columns"]["revision"] return new_out.split('split here\n')
def GetApprovals(changeId, patchset, server, port): def FindPrevRev(self):
"""Get all the approvals on a specific patch set """Finds the revision of the previous patch set on the change"""
sql_query = ("\"SELECT revision FROM patch_sets WHERE "
"change_id = %s AND patch_set_id = %s\"" %
(self.changeId, (self.patchset - 1)))
revisions = self.GsqlQuery(sql_query)
Returns a list of approval dicts""" json_dict = json.loads(revisions[0], strict=False)
sql_query = ("\"SELECT value,account_id,category_id FROM patch_set_approvals " return json_dict["columns"]["revision"]
"WHERE change_id = %s AND patch_set_id = %s AND value != 0\""
% (changeId, (patchset - 1)))
gsql_out = GsqlQuery(sql_query, server, port)
approvals = []
for json_str in gsql_out:
data = json.loads(json_str, strict=False)
if data["type"] == "row":
approvals.append(data["columns"])
return approvals
def GetEmailFromAcctId(account_id, server, port): def GetApprovals(self):
"""Returns the preferred email address associated with the account_id""" """Get all the approvals on a specific patch set
sql_query = ("\"SELECT preferred_email FROM accounts WHERE account_id = %s\""
% account_id)
email_addr = GsqlQuery(sql_query, server, port)
json_dict = json.loads(email_addr[0], strict=False) Returns a list of approval dicts"""
return json_dict["columns"]["preferred_email"] sql_query = ("\"SELECT value,account_id,category_id FROM patch_set_approvals "
"WHERE change_id = %s AND patch_set_id = %s AND value != 0\""
% (self.changeId, (self.patchset - 1)))
gsql_out = self.GsqlQuery(sql_query)
approvals = []
for json_str in gsql_out:
data = json.loads(json_str, strict=False)
if data["type"] == "row":
approvals.append(data["columns"])
return approvals
def GetPatchId(revision): def GetEmailFromAcctId(self, account_id):
git_show_cmd = ['git', 'show', revision] """Returns the preferred email address associated with the account_id"""
patch_id_cmd = ['git', 'patch-id'] sql_query = ("\"SELECT preferred_email FROM accounts WHERE account_id = %s\""
patch_id_process = subprocess.Popen(patch_id_cmd, stdout=subprocess.PIPE, % account_id)
stdin=subprocess.PIPE) email_addr = self.GsqlQuery(sql_query)
git_show_process = subprocess.Popen(git_show_cmd, stdout=subprocess.PIPE)
return patch_id_process.communicate(git_show_process.communicate()[0])[0]
def SuExec(server, port, private_key, as_user, cmd): json_dict = json.loads(email_addr[0], strict=False)
suexec_cmd = ['ssh', '-l', "Gerrit Code Review", '-p', port, server, '-i', return json_dict["columns"]["preferred_email"]
private_key, 'suexec', '--as', as_user, '--', cmd]
CheckCall(suexec_cmd)
def DiffCommitMessages(commit1, commit2): def GetPatchId(self, revision):
log_cmd1 = ['git', 'log', '--pretty=format:"%an %ae%n%s%n%b"', git_show_cmd = ['git', 'show', revision]
commit1 + '^!'] patch_id_cmd = ['git', 'patch-id']
commit1_log = CheckCall(log_cmd1) git_show_process = subprocess.Popen(git_show_cmd, stdout=subprocess.PIPE)
log_cmd2 = ['git', 'log', '--pretty=format:"%an %ae%n%s%n%b"', patch_id_process = subprocess.Popen(patch_id_cmd, stdout=subprocess.PIPE,
commit2 + '^!'] stdin=git_show_process.stdout)
commit2_log = CheckCall(log_cmd2) res = patch_id_process.communicate()[0] or '0'
if commit1_log != commit2_log: return res.split()[0]
return True
return False
def Main(): def SuExec(self, as_user, cmd):
server = 'localhost' suexec_cmd = [self.ssh, '-l', "Gerrit Code Review", self.ssh_port_flag, self.port, self.server]
usage = "%(prog)s <required options> [--server-port=PORT]" if self.private_key_path:
parser = argparse.ArgumentParser(usage=usage) suexec_cmd += ['-i', self.private_key_path]
parser.add_argument("--change-url", dest="changeUrl", help="Change URL") suexec_cmd += ['suexec', '--as', as_user, '--', cmd]
parser.add_argument("--project", help="Project path in Gerrit") self.CheckCall(suexec_cmd)
parser.add_argument("--commit", help="Git commit-ish for this patchset")
parser.add_argument("--patchset", type=int, help="The patchset number")
parser.add_argument("--private-key-path", dest="private_key_path",
help="Full path to Gerrit SSH daemon's private host key")
parser.add_argument("--server-port", dest="port", default='29418',
help="Port to connect to Gerrit's SSH daemon "
"[default: %(default)s]")
args = parser.parse_known_args()[0] def DiffCommitMessages(self, prev_commit):
try: log_cmd1 = ['git', 'log', '--pretty=format:"%an %ae%n%s%n%b"',
changeId = re.search(r'\d+', args.changeUrl).group() prev_commit + '^!']
except AttributeError: commit1_log = self.CheckCall(log_cmd1)
parser.print_help() log_cmd2 = ['git', 'log', '--pretty=format:"%an %ae%n%s%n%b"',
exit(0) self.commit + '^!']
commit2_log = self.CheckCall(log_cmd2)
if commit1_log != commit2_log:
return True
return False
if args.patchset == 1: def Run(self):
# Nothing to detect on first patchset if self.patchset == 1:
exit(0) # Nothing to detect on first patchset
prev_revision = None return
prev_revision = FindPrevRev(changeId, args.patchset, server, args.port) prev_revision = self.FindPrevRev()
if not prev_revision: assert prev_revision, "Previous revision not found"
# Couldn't find a previous revision prev_patch_id = self.GetPatchId(prev_revision)
exit(0) cur_patch_id = self.GetPatchId(self.commit)
prev_patch_id = GetPatchId(prev_revision) if prev_patch_id == '0' and cur_patch_id == '0':
cur_patch_id = GetPatchId(args.commit) print "commits %s and %s are both empty or merge commits" % (prev_revision, self.commit)
if not (prev_patch_id and cur_patch_id): return
if not prev_patch_id: if cur_patch_id != prev_patch_id:
print "GetPatchId failed for commit %s" % (prev_revision) # patch-ids don't match
if not cur_patch_id: return
print "GetPatchId failed for commit %s" % (args.commit) # Patch ids match. This is a trivial rebase.
exit(0) # In addition to patch-id we should check if the commit message changed. Most
if cur_patch_id.split()[0] != prev_patch_id.split()[0]: # approvers would want to re-review changes when the commit message changes.
# patch-ids don't match changed = self.DiffCommitMessages(prev_revision)
exit(0) if changed:
# Patch ids match. This is a trivial rebase. # Insert a comment into the change letting the approvers know only the
# In addition to patch-id we should check if the commit message changed. Most # commit message changed
# approvers would want to re-review changes when the commit message changes. comment_msg = ("\'--message=New patchset patch-id matches previous patchset"
changed = DiffCommitMessages(prev_revision, args.commit) ", but commit message has changed.'")
if changed: comment_cmd = [self.ssh, self.ssh_port_flag, self.port, self.server, 'gerrit',
# Insert a comment into the change letting the approvers know only the 'approve', '--project', self.project, comment_msg, self.commit]
# commit message changed self.CheckCall(comment_cmd)
comment_msg = ("\'--message=New patchset patch-id matches previous patchset" return
", but commit message has changed.'")
comment_cmd = ['ssh', '-p', args.port, server, 'gerrit', 'approve',
'--project', args.project, comment_msg, args.commit]
CheckCall(comment_cmd)
exit(0)
# Need to get all approvals on prior patch set, then suexec them onto # Need to get all approvals on prior patch set, then suexec them onto
# this patchset. # this patchset.
approvals = GetApprovals(changeId, args.patchset, server, args.port) approvals = self.GetApprovals()
gerrit_approve_msg = ("\'Automatically re-added by Gerrit trivial rebase " gerrit_approve_msg = ("\'Automatically re-added by Gerrit trivial rebase "
"detection script.\'") "detection script.\'")
for approval in approvals: for approval in approvals:
# Note: Sites with different 'copy_min_score' values in the # Note: Sites with different 'copy_min_score' values in the
# approval_categories DB table might want different behavior here. # approval_categories DB table might want different behavior here.
# Additional categories should also be added if desired. # Additional categories should also be added if desired.
if approval["category_id"] == "CRVW": if approval["category_id"] == "CRVW":
approve_category = '--code-review' approve_category = '--code-review'
elif approval["category_id"] == "VRIF": elif approval["category_id"] == "VRIF":
# Don't re-add verifies # Don't re-add verifies
#approve_category = '--verified' #approve_category = '--verified'
continue continue
elif approval["category_id"] == "SUBM": elif approval["category_id"] == "SUBM":
# We don't care about previous submit attempts # We don't care about previous submit attempts
continue continue
else: else:
print "Unsupported category: %s" % approval print "Unsupported category: %s" % approval
exit(0) continue
score = approval["value"] score = approval["value"]
gerrit_approve_cmd = ['gerrit', 'approve', '--project', args.project, gerrit_approve_cmd = ['gerrit', 'approve', '--project', self.project,
'--message', gerrit_approve_msg, approve_category, '--message', gerrit_approve_msg, approve_category,
score, args.commit] score, self.commit]
email_addr = GetEmailFromAcctId(approval["account_id"], server, email_addr = self.GetEmailFromAcctId(approval["account_id"])
args.port) self.SuExec(email_addr, ' '.join(gerrit_approve_cmd))
SuExec(server, args.port, args.private_key_path, email_addr,
' '.join(gerrit_approve_cmd))
exit(0)
if __name__ == "__main__": if __name__ == "__main__":
Main() try:
TrivialRebase().Run()
except AssertionError, e:
print >> sys.stderr, e

View File

@@ -92,6 +92,7 @@ final class ScpCommand extends BaseCommand {
private void runImp() { private void runImp() {
try { try {
readAck();
if (error != null) { if (error != null) {
throw error; throw error;
} }