phabricator.py
980 lines
| 35.0 KiB
| text/x-python
|
PythonLexer
/ contrib / phabricator.py
|
r33195 | # phabricator.py - simple Phabricator integration | ||
# | ||||
# Copyright 2017 Facebook, Inc. | ||||
# | ||||
# This software may be used and distributed according to the terms of the | ||||
# GNU General Public License version 2 or any later version. | ||||
"""simple Phabricator integration | ||||
|
r33196 | This extension provides a ``phabsend`` command which sends a stack of | ||
|
r33977 | changesets to Phabricator, and a ``phabread`` command which prints a stack of | ||
revisions in a format suitable for :hg:`import`, and a ``phabupdate`` command | ||||
to update statuses in batch. | ||||
|
r33196 | |||
By default, Phabricator requires ``Test Plan`` which might prevent some | ||||
changeset from being sent. The requirement could be disabled by changing | ||||
``differential.require-test-plan-field`` config server side. | ||||
|
r33195 | Config:: | ||
[phabricator] | ||||
# Phabricator URL | ||||
url = https://phab.example.com/ | ||||
|
r33196 | # Repo callsign. If a repo has a URL https://$HOST/diffusion/FOO, then its | ||
# callsign is "FOO". | ||||
callsign = FOO | ||||
|
r33197 | |||
|
r34066 | # curl command to use. If not set (default), use builtin HTTP library to | ||
# communicate. If set, use the specified curl command. This could be useful | ||||
# if you need to specify advanced options that is not easily supported by | ||||
# the internal library. | ||||
curlcmd = curl --connect-timeout 2 --retry 3 --silent | ||||
|
r36805 | |||
|
r38017 | [auth] | ||
|
r38018 | example.schemes = https | ||
example.prefix = phab.example.com | ||||
|
r36805 | # API token. Get it from https://$HOST/conduit/login/ | ||
|
r38017 | example.phabtoken = cli-xxxxxxxxxxxxxxxxxxxxxxxxxxxx | ||
|
r33195 | """ | ||
from __future__ import absolute_import | ||||
|
r33831 | import itertools | ||
|
r33195 | import json | ||
|
r33831 | import operator | ||
|
r33196 | import re | ||
|
r33195 | |||
|
r33443 | from mercurial.node import bin, nullid | ||
|
r33195 | from mercurial.i18n import _ | ||
from mercurial import ( | ||||
|
r33784 | cmdutil, | ||
context, | ||||
|
r33196 | encoding, | ||
|
r33195 | error, | ||
|
r38018 | httpconnection as httpconnectionmod, | ||
|
r33196 | mdiff, | ||
|
r33701 | obsutil, | ||
|
r33831 | parser, | ||
|
r33196 | patch, | ||
|
r33195 | registrar, | ||
|
r33196 | scmutil, | ||
|
r33831 | smartset, | ||
|
r33196 | tags, | ||
|
r33195 | url as urlmod, | ||
util, | ||||
) | ||||
|
r37138 | from mercurial.utils import ( | ||
procutil, | ||||
|
r37818 | stringutil, | ||
|
r37138 | ) | ||
|
r33195 | |||
cmdtable = {} | ||||
command = registrar.command(cmdtable) | ||||
|
r38053 | configtable = {} | ||
configitem = registrar.configitem(configtable) | ||||
# developer config: phabricator.batchsize | ||||
|
r38411 | configitem(b'phabricator', b'batchsize', | ||
|
r38053 | default=12, | ||
) | ||||
|
r38411 | configitem(b'phabricator', b'callsign', | ||
|
r38053 | default=None, | ||
) | ||||
|
r38411 | configitem(b'phabricator', b'curlcmd', | ||
|
r38053 | default=None, | ||
) | ||||
# developer config: phabricator.repophid | ||||
|
r38411 | configitem(b'phabricator', b'repophid', | ||
|
r38053 | default=None, | ||
) | ||||
|
r38411 | configitem(b'phabricator', b'url', | ||
|
r38053 | default=None, | ||
) | ||||
|
r38411 | configitem(b'phabsend', b'confirm', | ||
|
r38053 | default=False, | ||
) | ||||
|
r34065 | colortable = { | ||
|
r38411 | b'phabricator.action.created': b'green', | ||
b'phabricator.action.skipped': b'magenta', | ||||
b'phabricator.action.updated': b'magenta', | ||||
b'phabricator.desc': b'', | ||||
b'phabricator.drev': b'bold', | ||||
b'phabricator.node': b'', | ||||
|
r34065 | } | ||
|
r33195 | def urlencodenested(params): | ||
"""like urlencode, but works with nested parameters. | ||||
For example, if params is {'a': ['b', 'c'], 'd': {'e': 'f'}}, it will be | ||||
flattened to {'a[0]': 'b', 'a[1]': 'c', 'd[e]': 'f'} and then passed to | ||||
urlencode. Note: the encoding is consistent with PHP's http_build_query. | ||||
""" | ||||
flatparams = util.sortdict() | ||||
def process(prefix, obj): | ||||
items = {list: enumerate, dict: lambda x: x.items()}.get(type(obj)) | ||||
if items is None: | ||||
flatparams[prefix] = obj | ||||
else: | ||||
for k, v in items(obj): | ||||
if prefix: | ||||
|
r38411 | process(b'%s[%s]' % (prefix, k), v) | ||
|
r33195 | else: | ||
process(k, v) | ||||
|
r38411 | process(b'', params) | ||
|
r33195 | return util.urlreq.urlencode(flatparams) | ||
|
r38017 | printed_token_warning = False | ||
|
r33195 | |||
|
r38017 | def readlegacytoken(repo, url): | ||
"""Transitional support for old phabricator tokens. | ||||
Remove before the 4.7 release. | ||||
|
r33195 | """ | ||
|
r36805 | groups = {} | ||
|
r38411 | for key, val in repo.ui.configitems(b'phabricator.auth'): | ||
if b'.' not in key: | ||||
repo.ui.warn(_(b"ignoring invalid [phabricator.auth] key '%s'\n") | ||||
|
r36805 | % key) | ||
continue | ||||
|
r38411 | group, setting = key.rsplit(b'.', 1) | ||
|
r36805 | groups.setdefault(group, {})[setting] = val | ||
token = None | ||||
for group, auth in groups.iteritems(): | ||||
|
r38411 | if url != auth.get(b'url'): | ||
|
r36805 | continue | ||
|
r38411 | token = auth.get(b'token') | ||
|
r36805 | if token: | ||
break | ||||
|
r38017 | global printed_token_warning | ||
if token and not printed_token_warning: | ||||
printed_token_warning = True | ||||
|
r38411 | repo.ui.warn(_(b'phabricator.auth.token is deprecated - please ' | ||
b'migrate to auth.phabtoken.\n')) | ||||
|
r38017 | return token | ||
def readurltoken(repo): | ||||
"""return conduit url, token and make sure they exist | ||||
|
r38018 | Currently read from [auth] config section. In the future, it might | ||
|
r38017 | make sense to read from .arcconfig and .arcrc as well. | ||
""" | ||||
|
r38411 | url = repo.ui.config(b'phabricator', b'url') | ||
|
r38017 | if not url: | ||
|
r38411 | raise error.Abort(_(b'config %s.%s is required') | ||
% (b'phabricator', b'url')) | ||||
|
r38017 | |||
|
r38018 | res = httpconnectionmod.readauthforuri(repo.ui, url, util.url(url).user) | ||
token = None | ||||
|
r38017 | |||
|
r38018 | if res: | ||
group, auth = res | ||||
|
r38411 | repo.ui.debug(b"using auth.%s.* for authentication\n" % group) | ||
|
r38018 | |||
|
r38411 | token = auth.get(b'phabtoken') | ||
|
r38017 | |||
|
r36805 | if not token: | ||
|
r38017 | token = readlegacytoken(repo, url) | ||
if not token: | ||||
|
r38411 | raise error.Abort(_(b'Can\'t find conduit token associated to %s') | ||
|
r38017 | % (url,)) | ||
|
r36805 | |||
return url, token | ||||
|
r33195 | |||
def callconduit(repo, name, params): | ||||
"""call Conduit API, params is a dict. return json.loads result, or None""" | ||||
host, token = readurltoken(repo) | ||||
|
r38411 | url, authinfo = util.url(b'/'.join([host, b'api', name])).authinfo() | ||
repo.ui.debug(b'Conduit Call: %s %s\n' % (url, params)) | ||||
|
r33195 | params = params.copy() | ||
|
r38411 | params[b'api.token'] = token | ||
|
r34066 | data = urlencodenested(params) | ||
|
r38411 | curlcmd = repo.ui.config(b'phabricator', b'curlcmd') | ||
|
r34066 | if curlcmd: | ||
|
r38411 | sin, sout = procutil.popen2(b'%s -d @- %s' | ||
|
r37138 | % (curlcmd, procutil.shellquote(url))) | ||
|
r34066 | sin.write(data) | ||
sin.close() | ||||
body = sout.read() | ||||
else: | ||||
urlopener = urlmod.opener(repo.ui, authinfo) | ||||
request = util.urlreq.request(url, data=data) | ||||
body = urlopener.open(request).read() | ||||
|
r38411 | repo.ui.debug(b'Conduit Response: %s\n' % body) | ||
|
r33195 | parsed = json.loads(body) | ||
if parsed.get(r'error_code'): | ||||
|
r38411 | msg = (_(b'Conduit Error (%s): %s') | ||
|
r33195 | % (parsed[r'error_code'], parsed[r'error_info'])) | ||
raise error.Abort(msg) | ||||
return parsed[r'result'] | ||||
|
r38411 | @command(b'debugcallconduit', [], _(b'METHOD')) | ||
|
r33195 | def debugcallconduit(ui, repo, name): | ||
"""call Conduit API | ||||
Call parameters are read from stdin as a JSON blob. Result will be written | ||||
to stdout as a JSON blob. | ||||
""" | ||||
params = json.loads(ui.fin.read()) | ||||
result = callconduit(repo, name, params) | ||||
|
r38411 | s = json.dumps(result, sort_keys=True, indent=2, separators=(b',', b': ')) | ||
ui.write(b'%s\n' % s) | ||||
|
r33196 | |||
def getrepophid(repo): | ||||
"""given callsign, return repository PHID or None""" | ||||
# developer config: phabricator.repophid | ||||
|
r38411 | repophid = repo.ui.config(b'phabricator', b'repophid') | ||
|
r33196 | if repophid: | ||
return repophid | ||||
|
r38411 | callsign = repo.ui.config(b'phabricator', b'callsign') | ||
|
r33196 | if not callsign: | ||
return None | ||||
|
r38411 | query = callconduit(repo, b'diffusion.repository.search', | ||
{b'constraints': {b'callsigns': [callsign]}}) | ||||
|
r33196 | if len(query[r'data']) == 0: | ||
return None | ||||
repophid = encoding.strtolocal(query[r'data'][0][r'phid']) | ||||
|
r38411 | repo.ui.setconfig(b'phabricator', b'repophid', repophid) | ||
|
r33196 | return repophid | ||
|
r38411 | _differentialrevisiontagre = re.compile(b'\AD([1-9][0-9]*)\Z') | ||
|
r33263 | _differentialrevisiondescre = re.compile( | ||
|
r38411 | b'^Differential Revision:\s*(?P<url>(?:.*)D(?P<id>[1-9][0-9]*))$', re.M) | ||
|
r33196 | |||
|
r33442 | def getoldnodedrevmap(repo, nodelist): | ||
"""find previous nodes that has been sent to Phabricator | ||||
|
r33654 | return {node: (oldnode, Differential diff, Differential Revision ID)} | ||
|
r33442 | for node in nodelist with known previous sent versions, or associated | ||
|
r33654 | Differential Revision IDs. ``oldnode`` and ``Differential diff`` could | ||
be ``None``. | ||||
|
r33196 | |||
|
r33654 | Examines commit messages like "Differential Revision:" to get the | ||
association information. | ||||
|
r33263 | |||
|
r33654 | If such commit message line is not found, examines all precursors and their | ||
tags. Tags with format like "D1234" are considered a match and the node | ||||
with that tag, and the number after "D" (ex. 1234) will be returned. | ||||
The ``old node``, if not None, is guaranteed to be the last diff of | ||||
corresponding Differential Revision, and exist in the repo. | ||||
|
r33196 | """ | ||
|
r33442 | url, token = readurltoken(repo) | ||
unfi = repo.unfiltered() | ||||
|
r33196 | nodemap = unfi.changelog.nodemap | ||
|
r33263 | |||
|
r33654 | result = {} # {node: (oldnode?, lastdiff?, drev)} | ||
toconfirm = {} # {node: (force, {precnode}, drev)} | ||||
|
r33442 | for node in nodelist: | ||
ctx = unfi[node] | ||||
|
r33443 | # For tags like "D123", put them into "toconfirm" to verify later | ||
|
r33701 | precnodes = list(obsutil.allpredecessors(unfi.obsstore, [node])) | ||
|
r33443 | for n in precnodes: | ||
|
r33442 | if n in nodemap: | ||
for tag in unfi.nodetags(n): | ||||
m = _differentialrevisiontagre.match(tag) | ||||
if m: | ||||
|
r33654 | toconfirm[node] = (0, set(precnodes), int(m.group(1))) | ||
|
r33442 | continue | ||
|
r33263 | |||
|
r33654 | # Check commit message | ||
|
r33442 | m = _differentialrevisiondescre.search(ctx.description()) | ||
if m: | ||||
|
r38411 | toconfirm[node] = (1, set(precnodes), int(m.group(b'id'))) | ||
|
r33263 | |||
|
r33443 | # Double check if tags are genuine by collecting all old nodes from | ||
# Phabricator, and expect precursors overlap with it. | ||||
if toconfirm: | ||||
|
r33654 | drevs = [drev for force, precs, drev in toconfirm.values()] | ||
|
r38411 | alldiffs = callconduit(unfi, b'differential.querydiffs', | ||
{b'revisionIDs': drevs}) | ||||
|
r33654 | getnode = lambda d: bin(encoding.unitolocal( | ||
|
r38411 | getdiffmeta(d).get(r'node', b''))) or None | ||
|
r33654 | for newnode, (force, precset, drev) in toconfirm.items(): | ||
diffs = [d for d in alldiffs.values() | ||||
if int(d[r'revisionID']) == drev] | ||||
# "precursors" as known by Phabricator | ||||
phprecset = set(getnode(d) for d in diffs) | ||||
# Ignore if precursors (Phabricator and local repo) do not overlap, | ||||
# and force is not set (when commit message says nothing) | ||||
if not force and not bool(phprecset & precset): | ||||
|
r38411 | tagname = b'D%d' % drev | ||
|
r33443 | tags.tag(repo, tagname, nullid, message=None, user=None, | ||
date=None, local=True) | ||||
|
r38411 | unfi.ui.warn(_(b'D%s: local tag removed - does not match ' | ||
b'Differential history\n') % drev) | ||||
|
r33654 | continue | ||
# Find the last node using Phabricator metadata, and make sure it | ||||
# exists in the repo | ||||
oldnode = lastdiff = None | ||||
if diffs: | ||||
lastdiff = max(diffs, key=lambda d: int(d[r'id'])) | ||||
oldnode = getnode(lastdiff) | ||||
if oldnode and oldnode not in nodemap: | ||||
oldnode = None | ||||
result[newnode] = (oldnode, lastdiff, drev) | ||||
|
r33443 | |||
|
r33442 | return result | ||
|
r33196 | |||
def getdiff(ctx, diffopts): | ||||
"""plain-text diff without header (user, commit message, etc)""" | ||||
output = util.stringio() | ||||
for chunk, _label in patch.diffui(ctx.repo(), ctx.p1().node(), ctx.node(), | ||||
None, opts=diffopts): | ||||
output.write(chunk) | ||||
return output.getvalue() | ||||
def creatediff(ctx): | ||||
"""create a Differential Diff""" | ||||
repo = ctx.repo() | ||||
repophid = getrepophid(repo) | ||||
# Create a "Differential Diff" via "differential.createrawdiff" API | ||||
|
r38411 | params = {b'diff': getdiff(ctx, mdiff.diffopts(git=True, context=32767))} | ||
|
r33196 | if repophid: | ||
|
r38411 | params[b'repositoryPHID'] = repophid | ||
diff = callconduit(repo, b'differential.createrawdiff', params) | ||||
|
r33196 | if not diff: | ||
|
r38411 | raise error.Abort(_(b'cannot create diff for %s') % ctx) | ||
|
r33196 | return diff | ||
def writediffproperties(ctx, diff): | ||||
"""write metadata to diff so patches could be applied losslessly""" | ||||
params = { | ||||
|
r38411 | b'diff_id': diff[r'id'], | ||
b'name': b'hg:meta', | ||||
b'data': json.dumps({ | ||||
b'user': ctx.user(), | ||||
b'date': b'%d %d' % ctx.date(), | ||||
b'node': ctx.hex(), | ||||
b'parent': ctx.p1().hex(), | ||||
|
r33196 | }), | ||
} | ||||
|
r38411 | callconduit(ctx.repo(), b'differential.setdiffproperty', params) | ||
|
r33196 | |||
|
r37818 | params = { | ||
|
r38411 | b'diff_id': diff[r'id'], | ||
b'name': b'local:commits', | ||||
b'data': json.dumps({ | ||||
|
r37818 | ctx.hex(): { | ||
|
r38411 | b'author': stringutil.person(ctx.user()), | ||
b'authorEmail': stringutil.email(ctx.user()), | ||||
b'time': ctx.date()[0], | ||||
|
r37818 | }, | ||
}), | ||||
} | ||||
|
r38411 | callconduit(ctx.repo(), b'differential.setdiffproperty', params) | ||
|
r37818 | |||
|
r33498 | def createdifferentialrevision(ctx, revid=None, parentrevid=None, oldnode=None, | ||
|
r33655 | olddiff=None, actions=None): | ||
|
r33196 | """create or update a Differential Revision | ||
If revid is None, create a new Differential Revision, otherwise update | ||||
revid. If parentrevid is not None, set it as a dependency. | ||||
|
r33265 | |||
If oldnode is not None, check if the patch content (without commit message | ||||
and metadata) has changed before creating another diff. | ||||
|
r33498 | |||
If actions is not None, they will be appended to the transaction. | ||||
|
r33196 | """ | ||
repo = ctx.repo() | ||||
|
r33265 | if oldnode: | ||
|
r33978 | diffopts = mdiff.diffopts(git=True, context=32767) | ||
|
r33265 | oldctx = repo.unfiltered()[oldnode] | ||
neednewdiff = (getdiff(ctx, diffopts) != getdiff(oldctx, diffopts)) | ||||
else: | ||||
neednewdiff = True | ||||
|
r33196 | |||
|
r33265 | transactions = [] | ||
if neednewdiff: | ||||
diff = creatediff(ctx) | ||||
|
r38411 | transactions.append({b'type': b'update', b'value': diff[r'phid']}) | ||
|
r33655 | else: | ||
# Even if we don't need to upload a new diff because the patch content | ||||
# does not change. We might still need to update its metadata so | ||||
# pushers could know the correct node metadata. | ||||
assert olddiff | ||||
diff = olddiff | ||||
writediffproperties(ctx, diff) | ||||
|
r33196 | |||
# Use a temporary summary to set dependency. There might be better ways but | ||||
# I cannot find them for now. But do not do that if we are updating an | ||||
# existing revision (revid is not None) since that introduces visible | ||||
# churns (someone edited "Summary" twice) on the web page. | ||||
if parentrevid and revid is None: | ||||
|
r38411 | summary = b'Depends on D%s' % parentrevid | ||
transactions += [{b'type': b'summary', b'value': summary}, | ||||
{b'type': b'summary', b'value': b' '}] | ||||
|
r33196 | |||
|
r33498 | if actions: | ||
transactions += actions | ||||
|
r33196 | # Parse commit message and update related fields. | ||
desc = ctx.description() | ||||
|
r38411 | info = callconduit(repo, b'differential.parsecommitmessage', | ||
{b'corpus': desc}) | ||||
|
r33196 | for k, v in info[r'fields'].items(): | ||
|
r38411 | if k in [b'title', b'summary', b'testPlan']: | ||
transactions.append({b'type': k, b'value': v}) | ||||
|
r33196 | |||
|
r38411 | params = {b'transactions': transactions} | ||
|
r33196 | if revid is not None: | ||
# Update an existing Differential Revision | ||||
|
r38411 | params[b'objectIdentifier'] = revid | ||
|
r33196 | |||
|
r38411 | revision = callconduit(repo, b'differential.revision.edit', params) | ||
|
r33196 | if not revision: | ||
|
r38411 | raise error.Abort(_(b'cannot create revision for %s') % ctx) | ||
|
r33196 | |||
|
r33784 | return revision, diff | ||
|
r33196 | |||
|
r33498 | def userphids(repo, names): | ||
"""convert user names to PHIDs""" | ||||
|
r38411 | query = {b'constraints': {b'usernames': names}} | ||
result = callconduit(repo, b'user.search', query) | ||||
|
r33498 | # username not found is not an error of the API. So check if we have missed | ||
# some names here. | ||||
data = result[r'data'] | ||||
resolved = set(entry[r'fields'][r'username'] for entry in data) | ||||
unresolved = set(names) - resolved | ||||
if unresolved: | ||||
|
r38411 | raise error.Abort(_(b'unknown username: %s') | ||
% b' '.join(sorted(unresolved))) | ||||
|
r33498 | return [entry[r'phid'] for entry in data] | ||
|
r38411 | @command(b'phabsend', | ||
[(b'r', b'rev', [], _(b'revisions to send'), _(b'REV')), | ||||
(b'', b'amend', True, _(b'update commit messages')), | ||||
(b'', b'reviewer', [], _(b'specify reviewers')), | ||||
(b'', b'confirm', None, _(b'ask for confirmation before sending'))], | ||||
_(b'REV [OPTIONS]')) | ||||
|
r33196 | def phabsend(ui, repo, *revs, **opts): | ||
"""upload changesets to Phabricator | ||||
If there are multiple revisions specified, they will be send as a stack | ||||
with a linear dependencies relationship using the order specified by the | ||||
revset. | ||||
For the first time uploading changesets, local tags will be created to | ||||
maintain the association. After the first time, phabsend will check | ||||
obsstore and tags information so it can figure out whether to update an | ||||
existing Differential Revision, or create a new one. | ||||
|
r33653 | |||
|
r33784 | If --amend is set, update commit messages so they have the | ||
``Differential Revision`` URL, remove related tags. This is similar to what | ||||
arcanist will do, and is more desired in author-push workflows. Otherwise, | ||||
use local tags to record the ``Differential Revision`` association. | ||||
|
r33653 | The --confirm option lets you confirm changesets before sending them. You | ||
can also add following to your configuration file to make it default | ||||
|
r33976 | behaviour:: | ||
|
r33653 | |||
|
r33976 | [phabsend] | ||
confirm = true | ||||
|
r33784 | |||
phabsend will check obsstore and the above association to decide whether to | ||||
update an existing Differential Revision, or create a new one. | ||||
|
r33196 | """ | ||
|
r38411 | revs = list(revs) + opts.get(b'rev', []) | ||
|
r33196 | revs = scmutil.revrange(repo, revs) | ||
|
r33266 | if not revs: | ||
|
r38411 | raise error.Abort(_(b'phabsend requires at least one changeset')) | ||
if opts.get(b'amend'): | ||||
|
r33784 | cmdutil.checkunfinished(repo) | ||
|
r33266 | |||
|
r33980 | # {newnode: (oldnode, olddiff, olddrev} | ||
oldmap = getoldnodedrevmap(repo, [repo[r].node() for r in revs]) | ||||
|
r38411 | confirm = ui.configbool(b'phabsend', b'confirm') | ||
confirm |= bool(opts.get(b'confirm')) | ||||
|
r33653 | if confirm: | ||
|
r33980 | confirmed = _confirmbeforesend(repo, revs, oldmap) | ||
|
r33653 | if not confirmed: | ||
|
r38411 | raise error.Abort(_(b'phabsend cancelled')) | ||
|
r33653 | |||
|
r33498 | actions = [] | ||
|
r38411 | reviewers = opts.get(b'reviewer', []) | ||
|
r33498 | if reviewers: | ||
phids = userphids(repo, reviewers) | ||||
|
r38411 | actions.append({b'type': b'reviewers.add', b'value': phids}) | ||
|
r33498 | |||
|
r33784 | drevids = [] # [int] | ||
diffmap = {} # {newnode: diff} | ||||
|
r33196 | # Send patches one by one so we know their Differential Revision IDs and | ||
# can provide dependency relationship | ||||
lastrevid = None | ||||
for rev in revs: | ||||
|
r38411 | ui.debug(b'sending rev %d\n' % rev) | ||
|
r33196 | ctx = repo[rev] | ||
# Get Differential Revision ID | ||||
|
r33654 | oldnode, olddiff, revid = oldmap.get(ctx.node(), (None, None, None)) | ||
|
r38411 | if oldnode != ctx.node() or opts.get(b'amend'): | ||
|
r33196 | # Create or update Differential Revision | ||
|
r33784 | revision, diff = createdifferentialrevision( | ||
ctx, revid, lastrevid, oldnode, olddiff, actions) | ||||
diffmap[ctx.node()] = diff | ||||
|
r33196 | newrevid = int(revision[r'object'][r'id']) | ||
if revid: | ||||
|
r38411 | action = b'updated' | ||
|
r33196 | else: | ||
|
r38411 | action = b'created' | ||
|
r33196 | |||
|
r33784 | # Create a local tag to note the association, if commit message | ||
# does not have it already | ||||
m = _differentialrevisiondescre.search(ctx.description()) | ||||
|
r38411 | if not m or int(m.group(b'id')) != newrevid: | ||
tagname = b'D%d' % newrevid | ||||
|
r33784 | tags.tag(repo, tagname, ctx.node(), message=None, user=None, | ||
date=None, local=True) | ||||
|
r33196 | else: | ||
# Nothing changed. But still set "newrevid" so the next revision | ||||
# could depend on this one. | ||||
newrevid = revid | ||||
|
r38411 | action = b'skipped' | ||
|
r33196 | |||
|
r34065 | actiondesc = ui.label( | ||
|
r38411 | {b'created': _(b'created'), | ||
b'skipped': _(b'skipped'), | ||||
b'updated': _(b'updated')}[action], | ||||
b'phabricator.action.%s' % action) | ||||
drevdesc = ui.label(b'D%s' % newrevid, b'phabricator.drev') | ||||
nodedesc = ui.label(bytes(ctx), b'phabricator.node') | ||||
desc = ui.label(ctx.description().split(b'\n')[0], b'phabricator.desc') | ||||
ui.write(_(b'%s - %s - %s: %s\n') % (drevdesc, actiondesc, nodedesc, | ||||
desc)) | ||||
|
r33784 | drevids.append(newrevid) | ||
|
r33196 | lastrevid = newrevid | ||
|
r33197 | |||
|
r33784 | # Update commit messages and remove tags | ||
|
r38411 | if opts.get(b'amend'): | ||
|
r33784 | unfi = repo.unfiltered() | ||
|
r38411 | drevs = callconduit(repo, b'differential.query', {b'ids': drevids}) | ||
with repo.wlock(), repo.lock(), repo.transaction(b'phabsend'): | ||||
wnode = unfi[b'.'].node() | ||||
|
r33784 | mapping = {} # {oldnode: [newnode]} | ||
for i, rev in enumerate(revs): | ||||
old = unfi[rev] | ||||
drevid = drevids[i] | ||||
drev = [d for d in drevs if int(d[r'id']) == drevid][0] | ||||
newdesc = getdescfromdrev(drev) | ||||
# Make sure commit message contain "Differential Revision" | ||||
if old.description() != newdesc: | ||||
parents = [ | ||||
mapping.get(old.p1().node(), (old.p1(),))[0], | ||||
mapping.get(old.p2().node(), (old.p2(),))[0], | ||||
] | ||||
new = context.metadataonlyctx( | ||||
repo, old, parents=parents, text=newdesc, | ||||
user=old.user(), date=old.date(), extra=old.extra()) | ||||
|
r38355 | |||
|
r38442 | newnode = new.commit() | ||
|
r38355 | |||
|
r33784 | mapping[old.node()] = [newnode] | ||
# Update diff property | ||||
writediffproperties(unfi[newnode], diffmap[old.node()]) | ||||
# Remove local tags since it's no longer necessary | ||||
|
r38411 | tagname = b'D%d' % drevid | ||
|
r33784 | if tagname in repo.tags(): | ||
tags.tag(repo, tagname, nullid, message=None, user=None, | ||||
date=None, local=True) | ||||
|
r38442 | scmutil.cleanupnodes(repo, mapping, b'phabsend', fixphase=True) | ||
|
r33784 | if wnode in mapping: | ||
unfi.setparents(mapping[wnode][0]) | ||||
|
r33264 | # Map from "hg:meta" keys to header understood by "hg import". The order is | ||
# consistent with "hg export" output. | ||||
|
r38411 | _metanamemap = util.sortdict([(r'user', b'User'), (r'date', b'Date'), | ||
(r'node', b'Node ID'), (r'parent', b'Parent ')]) | ||||
|
r33264 | |||
|
r33980 | def _confirmbeforesend(repo, revs, oldmap): | ||
|
r33979 | url, token = readurltoken(repo) | ||
|
r33653 | ui = repo.ui | ||
for rev in revs: | ||||
ctx = repo[rev] | ||||
desc = ctx.description().splitlines()[0] | ||||
|
r33980 | oldnode, olddiff, drevid = oldmap.get(ctx.node(), (None, None, None)) | ||
if drevid: | ||||
|
r38411 | drevdesc = ui.label(b'D%s' % drevid, b'phabricator.drev') | ||
|
r33980 | else: | ||
|
r38411 | drevdesc = ui.label(_(b'NEW'), b'phabricator.drev') | ||
|
r33980 | |||
|
r38411 | ui.write(_(b'%s - %s: %s\n') | ||
% (drevdesc, | ||||
ui.label(bytes(ctx), b'phabricator.node'), | ||||
ui.label(desc, b'phabricator.desc'))) | ||||
|
r33653 | |||
|
r38411 | if ui.promptchoice(_(b'Send the above changes to %s (yn)?' | ||
b'$$ &Yes $$ &No') % url): | ||||
|
r33653 | return False | ||
return True | ||||
|
r38411 | _knownstatusnames = {b'accepted', b'needsreview', b'needsrevision', b'closed', | ||
b'abandoned'} | ||||
|
r33832 | |||
def _getstatusname(drev): | ||||
"""get normalized status name from a Differential Revision""" | ||||
|
r38411 | return drev[r'statusName'].replace(b' ', b'').lower() | ||
|
r33832 | |||
|
r33831 | # Small language to specify differential revisions. Support symbols: (), :X, | ||
# +, and -. | ||||
_elements = { | ||||
# token-type: binding-strength, primary, prefix, infix, suffix | ||||
|
r38411 | b'(': (12, None, (b'group', 1, b')'), None, None), | ||
b':': (8, None, (b'ancestors', 8), None, None), | ||||
b'&': (5, None, None, (b'and_', 5), None), | ||||
b'+': (4, None, None, (b'add', 4), None), | ||||
b'-': (4, None, None, (b'sub', 4), None), | ||||
b')': (0, None, None, None, None), | ||||
b'symbol': (0, b'symbol', None, None, None), | ||||
b'end': (0, None, None, None, None), | ||||
|
r33831 | } | ||
def _tokenize(text): | ||||
view = memoryview(text) # zero-copy slice | ||||
|
r38411 | special = b'():+-& ' | ||
|
r33831 | pos = 0 | ||
length = len(text) | ||||
while pos < length: | ||||
|
r38411 | symbol = b''.join(itertools.takewhile(lambda ch: ch not in special, | ||
view[pos:])) | ||||
|
r33831 | if symbol: | ||
|
r38411 | yield (b'symbol', symbol, pos) | ||
|
r33831 | pos += len(symbol) | ||
|
r33832 | else: # special char, ignore space | ||
|
r38411 | if text[pos] != b' ': | ||
|
r33832 | yield (text[pos], None, pos) | ||
|
r33831 | pos += 1 | ||
|
r38411 | yield (b'end', None, pos) | ||
|
r33831 | |||
def _parse(text): | ||||
tree, pos = parser.parser(_elements).parse(_tokenize(text)) | ||||
if pos != len(text): | ||||
|
r38411 | raise error.ParseError(b'invalid token', pos) | ||
|
r33831 | return tree | ||
def _parsedrev(symbol): | ||||
"""str -> int or None, ex. 'D45' -> 45; '12' -> 12; 'x' -> None""" | ||||
|
r38411 | if symbol.startswith(b'D') and symbol[1:].isdigit(): | ||
|
r33831 | return int(symbol[1:]) | ||
if symbol.isdigit(): | ||||
return int(symbol) | ||||
def _prefetchdrevs(tree): | ||||
"""return ({single-drev-id}, {ancestor-drev-id}) to prefetch""" | ||||
drevs = set() | ||||
ancestordrevs = set() | ||||
op = tree[0] | ||||
|
r38411 | if op == b'symbol': | ||
|
r33831 | r = _parsedrev(tree[1]) | ||
if r: | ||||
drevs.add(r) | ||||
|
r38411 | elif op == b'ancestors': | ||
|
r33831 | r, a = _prefetchdrevs(tree[1]) | ||
drevs.update(r) | ||||
ancestordrevs.update(r) | ||||
ancestordrevs.update(a) | ||||
else: | ||||
for t in tree[1:]: | ||||
r, a = _prefetchdrevs(t) | ||||
drevs.update(r) | ||||
ancestordrevs.update(a) | ||||
return drevs, ancestordrevs | ||||
def querydrev(repo, spec): | ||||
|
r33267 | """return a list of "Differential Revision" dicts | ||
|
r33831 | spec is a string using a simple query language, see docstring in phabread | ||
for details. | ||||
|
r33267 | |||
A "Differential Revision dict" looks like: | ||||
{ | ||||
"id": "2", | ||||
"phid": "PHID-DREV-672qvysjcczopag46qty", | ||||
"title": "example", | ||||
"uri": "https://phab.example.com/D2", | ||||
"dateCreated": "1499181406", | ||||
"dateModified": "1499182103", | ||||
"authorPHID": "PHID-USER-tv3ohwc4v4jeu34otlye", | ||||
"status": "0", | ||||
"statusName": "Needs Review", | ||||
"properties": [], | ||||
"branch": null, | ||||
"summary": "", | ||||
"testPlan": "", | ||||
"lineCount": "2", | ||||
"activeDiffPHID": "PHID-DIFF-xoqnjkobbm6k4dk6hi72", | ||||
"diffs": [ | ||||
"3", | ||||
"4", | ||||
], | ||||
"commits": [], | ||||
"reviewers": [], | ||||
"ccs": [], | ||||
"hashes": [], | ||||
"auxiliary": { | ||||
"phabricator:projects": [], | ||||
"phabricator:depends-on": [ | ||||
"PHID-DREV-gbapp366kutjebt7agcd" | ||||
] | ||||
}, | ||||
"repositoryPHID": "PHID-REPO-hub2hx62ieuqeheznasv", | ||||
"sourcePath": null | ||||
} | ||||
""" | ||||
|
r33269 | def fetch(params): | ||
"""params -> single drev or None""" | ||||
key = (params.get(r'ids') or params.get(r'phids') or [None])[0] | ||||
if key in prefetched: | ||||
return prefetched[key] | ||||
|
r38411 | drevs = callconduit(repo, b'differential.query', params) | ||
|
r33269 | # Fill prefetched with the result | ||
for drev in drevs: | ||||
prefetched[drev[r'phid']] = drev | ||||
prefetched[int(drev[r'id'])] = drev | ||||
if key not in prefetched: | ||||
|
r38411 | raise error.Abort(_(b'cannot get Differential Revision %r') | ||
% params) | ||||
|
r33269 | return prefetched[key] | ||
|
r33831 | def getstack(topdrevids): | ||
"""given a top, get a stack from the bottom, [id] -> [id]""" | ||||
visited = set() | ||||
result = [] | ||||
queue = [{r'ids': [i]} for i in topdrevids] | ||||
while queue: | ||||
params = queue.pop() | ||||
drev = fetch(params) | ||||
if drev[r'id'] in visited: | ||||
continue | ||||
visited.add(drev[r'id']) | ||||
result.append(int(drev[r'id'])) | ||||
|
r33267 | auxiliary = drev.get(r'auxiliary', {}) | ||
depends = auxiliary.get(r'phabricator:depends-on', []) | ||||
for phid in depends: | ||||
|
r38411 | queue.append({b'phids': [phid]}) | ||
|
r33831 | result.reverse() | ||
return smartset.baseset(result) | ||||
# Initialize prefetch cache | ||||
prefetched = {} # {id or phid: drev} | ||||
tree = _parse(spec) | ||||
drevs, ancestordrevs = _prefetchdrevs(tree) | ||||
# developer config: phabricator.batchsize | ||||
|
r38411 | batchsize = repo.ui.configint(b'phabricator', b'batchsize') | ||
|
r33831 | |||
# Prefetch Differential Revisions in batch | ||||
tofetch = set(drevs) | ||||
for r in ancestordrevs: | ||||
tofetch.update(range(max(1, r - batchsize), r + 1)) | ||||
if drevs: | ||||
fetch({r'ids': list(tofetch)}) | ||||
|
r33832 | validids = sorted(set(getstack(list(ancestordrevs))) | set(drevs)) | ||
|
r33831 | |||
# Walk through the tree, return smartsets | ||||
def walk(tree): | ||||
op = tree[0] | ||||
|
r38411 | if op == b'symbol': | ||
|
r33831 | drev = _parsedrev(tree[1]) | ||
if drev: | ||||
return smartset.baseset([drev]) | ||||
|
r33832 | elif tree[1] in _knownstatusnames: | ||
drevs = [r for r in validids | ||||
if _getstatusname(prefetched[r]) == tree[1]] | ||||
return smartset.baseset(drevs) | ||||
|
r33831 | else: | ||
|
r38411 | raise error.Abort(_(b'unknown symbol: %s') % tree[1]) | ||
elif op in {b'and_', b'add', b'sub'}: | ||||
|
r33831 | assert len(tree) == 3 | ||
return getattr(operator, op)(walk(tree[1]), walk(tree[2])) | ||||
|
r38411 | elif op == b'group': | ||
|
r33831 | return walk(tree[1]) | ||
|
r38411 | elif op == b'ancestors': | ||
|
r33831 | return getstack(walk(tree[1])) | ||
else: | ||||
|
r38411 | raise error.ProgrammingError(b'illegal tree: %r' % tree) | ||
|
r33831 | |||
return [prefetched[r] for r in walk(tree)] | ||||
|
r33267 | |||
|
r33268 | def getdescfromdrev(drev): | ||
"""get description (commit message) from "Differential Revision" | ||||
This is similar to differential.getcommitmessage API. But we only care | ||||
about limited fields: title, summary, test plan, and URL. | ||||
""" | ||||
title = drev[r'title'] | ||||
summary = drev[r'summary'].rstrip() | ||||
testplan = drev[r'testPlan'].rstrip() | ||||
if testplan: | ||||
|
r38411 | testplan = b'Test Plan:\n%s' % testplan | ||
uri = b'Differential Revision: %s' % drev[r'uri'] | ||||
return b'\n\n'.join(filter(None, [title, summary, testplan, uri])) | ||||
|
r33268 | |||
|
r33441 | def getdiffmeta(diff): | ||
"""get commit metadata (date, node, user, p1) from a diff object | ||||
The metadata could be "hg:meta", sent by phabsend, like: | ||||
"properties": { | ||||
"hg:meta": { | ||||
"date": "1499571514 25200", | ||||
"node": "98c08acae292b2faf60a279b4189beb6cff1414d", | ||||
"user": "Foo Bar <foo@example.com>", | ||||
"parent": "6d0abad76b30e4724a37ab8721d630394070fe16" | ||||
} | ||||
} | ||||
Or converted from "local:commits", sent by "arc", like: | ||||
"properties": { | ||||
"local:commits": { | ||||
"98c08acae292b2faf60a279b4189beb6cff1414d": { | ||||
"author": "Foo Bar", | ||||
"time": 1499546314, | ||||
"branch": "default", | ||||
"tag": "", | ||||
"commit": "98c08acae292b2faf60a279b4189beb6cff1414d", | ||||
"rev": "98c08acae292b2faf60a279b4189beb6cff1414d", | ||||
"local": "1000", | ||||
"parents": ["6d0abad76b30e4724a37ab8721d630394070fe16"], | ||||
"summary": "...", | ||||
"message": "...", | ||||
"authorEmail": "foo@example.com" | ||||
} | ||||
} | ||||
} | ||||
Note: metadata extracted from "local:commits" will lose time zone | ||||
information. | ||||
""" | ||||
props = diff.get(r'properties') or {} | ||||
meta = props.get(r'hg:meta') | ||||
if not meta and props.get(r'local:commits'): | ||||
commit = sorted(props[r'local:commits'].values())[0] | ||||
meta = { | ||||
r'date': r'%d 0' % commit[r'time'], | ||||
r'node': commit[r'rev'], | ||||
r'user': r'%s <%s>' % (commit[r'author'], commit[r'authorEmail']), | ||||
} | ||||
if len(commit.get(r'parents', ())) >= 1: | ||||
meta[r'parent'] = commit[r'parents'][0] | ||||
return meta or {} | ||||
|
r33830 | def readpatch(repo, drevs, write): | ||
|
r33197 | """generate plain-text patch readable by 'hg import' | ||
|
r33830 | write is usually ui.write. drevs is what "querydrev" returns, results of | ||
"differential.query". | ||||
|
r33197 | """ | ||
|
r33267 | # Prefetch hg:meta property for all diffs | ||
diffids = sorted(set(max(int(v) for v in drev[r'diffs']) for drev in drevs)) | ||||
|
r38411 | diffs = callconduit(repo, b'differential.querydiffs', {b'ids': diffids}) | ||
|
r33197 | |||
|
r33267 | # Generate patch for each drev | ||
for drev in drevs: | ||||
|
r38411 | repo.ui.note(_(b'reading D%s\n') % drev[r'id']) | ||
|
r33197 | |||
|
r33267 | diffid = max(int(v) for v in drev[r'diffs']) | ||
|
r38411 | body = callconduit(repo, b'differential.getrawdiff', | ||
{b'diffID': diffid}) | ||||
|
r33268 | desc = getdescfromdrev(drev) | ||
|
r38411 | header = b'# HG changeset patch\n' | ||
|
r33267 | |||
# Try to preserve metadata from hg:meta property. Write hg patch | ||||
# headers that can be read by the "import" command. See patchheadermap | ||||
# and extract in mercurial/patch.py for supported headers. | ||||
|
r33441 | meta = getdiffmeta(diffs[str(diffid)]) | ||
for k in _metanamemap.keys(): | ||||
if k in meta: | ||||
|
r38411 | header += b'# %s %s\n' % (_metanamemap[k], meta[k]) | ||
|
r33197 | |||
|
r38411 | content = b'%s%s\n%s' % (header, desc, body) | ||
|
r33602 | write(encoding.unitolocal(content)) | ||
|
r33197 | |||
|
r38411 | @command(b'phabread', | ||
[(b'', b'stack', False, _(b'read dependencies'))], | ||||
_(b'DREVSPEC [OPTIONS]')) | ||||
|
r33831 | def phabread(ui, repo, spec, **opts): | ||
|
r33197 | """print patches from Phabricator suitable for importing | ||
|
r33831 | DREVSPEC could be a Differential Revision identity, like ``D123``, or just | ||
the number ``123``. It could also have common operators like ``+``, ``-``, | ||||
``&``, ``(``, ``)`` for complex queries. Prefix ``:`` could be used to | ||||
select a stack. | ||||
|
r33832 | ``abandoned``, ``accepted``, ``closed``, ``needsreview``, ``needsrevision`` | ||
could be used to filter patches by status. For performance reason, they | ||||
only represent a subset of non-status selections and cannot be used alone. | ||||
|
r33831 | For example, ``:D6+8-(2+D4)`` selects a stack up to D6, plus D8 and exclude | ||
|
r33832 | D2 and D4. ``:D9 & needsreview`` selects "Needs Review" revisions in a | ||
stack up to D9. | ||||
|
r33197 | |||
If --stack is given, follow dependencies information and read all patches. | ||||
|
r33831 | It is equivalent to the ``:`` operator. | ||
|
r33197 | """ | ||
|
r38411 | if opts.get(b'stack'): | ||
spec = b':(%s)' % spec | ||||
|
r33831 | drevs = querydrev(repo, spec) | ||
|
r33830 | readpatch(repo, drevs, ui.write) | ||
|
r33833 | |||
|
r38411 | @command(b'phabupdate', | ||
[(b'', b'accept', False, _(b'accept revisions')), | ||||
(b'', b'reject', False, _(b'reject revisions')), | ||||
(b'', b'abandon', False, _(b'abandon revisions')), | ||||
(b'', b'reclaim', False, _(b'reclaim revisions')), | ||||
(b'm', b'comment', b'', _(b'comment on the last revision')), | ||||
], _(b'DREVSPEC [OPTIONS]')) | ||||
|
r33833 | def phabupdate(ui, repo, spec, **opts): | ||
"""update Differential Revision in batch | ||||
DREVSPEC selects revisions. See :hg:`help phabread` for its usage. | ||||
""" | ||||
|
r38411 | flags = [n for n in b'accept reject abandon reclaim'.split() if opts.get(n)] | ||
|
r33833 | if len(flags) > 1: | ||
|
r38411 | raise error.Abort(_(b'%s cannot be used together') % b', '.join(flags)) | ||
|
r33833 | |||
actions = [] | ||||
for f in flags: | ||||
|
r38411 | actions.append({b'type': f, b'value': b'true'}) | ||
|
r33833 | |||
drevs = querydrev(repo, spec) | ||||
for i, drev in enumerate(drevs): | ||||
|
r38411 | if i + 1 == len(drevs) and opts.get(b'comment'): | ||
actions.append({b'type': b'comment', b'value': opts[b'comment']}) | ||||
|
r33833 | if actions: | ||
|
r38411 | params = {b'objectIdentifier': drev[r'phid'], | ||
b'transactions': actions} | ||||
callconduit(repo, b'differential.revision.edit', params) | ||||
|
r35740 | |||
templatekeyword = registrar.templatekeyword() | ||||
|
r38411 | @templatekeyword(b'phabreview', requires={b'ctx'}) | ||
|
r36531 | def template_review(context, mapping): | ||
|
r35740 | """:phabreview: Object describing the review for this changeset. | ||
Has attributes `url` and `id`. | ||||
""" | ||||
|
r38411 | ctx = context.resource(mapping, b'ctx') | ||
|
r35740 | m = _differentialrevisiondescre.search(ctx.description()) | ||
if m: | ||||
return { | ||||
|
r38411 | b'url': m.group(b'url'), | ||
b'id': b"D{}".format(m.group(b'id')), | ||||
|
r35740 | } | ||