( )⚙ D4600 phabricator: add support for using the vcr library to mock interactions

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D4600

phabricator: add support for using the vcr library to mock interactions
ClosedPublic

Authored by durin42 on Sep 15 2018, 1:23 AM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHGd8f07b16abfc: phabricator: add support for using the vcr library to mock interactions
Summary

I'll use this in an upcoming test. The decorator dancing in this is
more complicated than I'd like, but it beats repeating all this code
everywhere.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

durin42 created this revision.Sep 15 2018, 1:23 AM
yuja added a subscriber: yuja.Sep 15 2018, 3:12 AM

Queued the series, thanks.

+_VCR_FLAGS = [
+ (b'', b'test-vcr', b'',
+ _(b'Path to a vcr file. If nonexistent, will record a new vcr transcript'
+ b', otherwise will mock all http requests using the specified vcr file.'
+ b' (DEPRECATED)'

s/(DEPRECATED)/(ADVANCED)/ in flight.

+def vcrcommand(name, flags, spec):
+ fullflags = flags + _VCR_FLAGS
+ def decorate(fn):
+ def inner(*args, **kwargs):
+ cassette = kwargs.pop(r'test_vcr', None)
+ if cassette:
+ import hgdemandimport
+ with hgdemandimport.deactivated():
+ import vcr as vcrmod
+ from vcr import stubs

Fixed check-module-imports warning in flight.

+ vcr = vcrmod.VCR(
+ serializer=r'json',
+ custom_patches=[
+ (urlmod, 'httpconnection', stubs.VCRHTTPConnection),
+ (urlmod, 'httpsconnection', stubs.VCRHTTPSConnection),
+ ])
+ with vcr.use_cassette(cassette):
+ return fn(*args, kwargs)
+ return fn(*args, kwargs)
+ inner.name = fn.name
+ return command(name, fullflags, spec)(inner)
+ return decorate

Perhaps, it's easier to extend the registrar.command class instead. Another
option is to turn --test-vcr into a config knob, and hook somewhere in
dispatch.

Closed by commit rHGd8f07b16abfc: phabricator: add support for using the vcr library to mock interactions (authored by durin42). · Explain WhySep 15 2018, 3:31 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mcontrib/phabricator.py (39 lines)

Diff 11089

contrib/phabricator.py

b'phabricator.action.created': b'green', b'phabricator.action.created': b'green',
b'phabricator.action.skipped': b'magenta', b'phabricator.action.skipped': b'magenta',
b'phabricator.action.updated': b'magenta', b'phabricator.action.updated': b'magenta',
b'phabricator.desc': b'', b'phabricator.desc': b'',
b'phabricator.drev': b'bold', b'phabricator.drev': b'bold',
b'phabricator.node': b'', b'phabricator.node': b'',
} }
_VCR_FLAGS = [
(b'', b'test-vcr', b'',
_(b'Path to a vcr file. If nonexistent, will record a new vcr transcript'
b', otherwise will mock all http requests using the specified vcr file.'
b' (ADVANCED)'
)),
]
def vcrcommand(name, flags, spec):
fullflags = flags + _VCR_FLAGS
def decorate(fn):
def inner(*args, **kwargs):
cassette = kwargs.pop(r'test_vcr', None)
if cassette:
import hgdemandimport
with hgdemandimport.deactivated():
import vcr as vcrmod
import vcr.stubs as stubs
vcr = vcrmod.VCR(
serializer=r'json',
custom_patches=[
(urlmod, 'httpconnection', stubs.VCRHTTPConnection),
(urlmod, 'httpsconnection', stubs.VCRHTTPSConnection),
])
with vcr.use_cassette(cassette):
return fn(*args, **kwargs)
return fn(*args, **kwargs)
inner.__name__ = fn.__name__
return command(name, fullflags, spec)(inner)
return decorate
def urlencodenested(params): def urlencodenested(params):
"""like urlencode, but works with nested parameters. """like urlencode, but works with nested parameters.
For example, if params is {'a': ['b', 'c'], 'd': {'e': 'f'}}, it will be 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 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. urlencode. Note: the encoding is consistent with PHP's http_build_query.
""" """
flatparams = util.sortdict() flatparams = util.sortdict()
repo.ui.debug(b'Conduit Response: %s\n' % body) repo.ui.debug(b'Conduit Response: %s\n' % body)
parsed = json.loads(body) parsed = json.loads(body)
if parsed.get(r'error_code'): if parsed.get(r'error_code'):
msg = (_(b'Conduit Error (%s): %s') msg = (_(b'Conduit Error (%s): %s')
% (parsed[r'error_code'], parsed[r'error_info'])) % (parsed[r'error_code'], parsed[r'error_info']))
raise error.Abort(msg) raise error.Abort(msg)
return parsed[r'result'] return parsed[r'result']
@command(b'debugcallconduit', [], _(b'METHOD')) @vcrcommand(b'debugcallconduit', [], _(b'METHOD'))
def debugcallconduit(ui, repo, name): def debugcallconduit(ui, repo, name):
"""call Conduit API """call Conduit API
Call parameters are read from stdin as a JSON blob. Result will be written Call parameters are read from stdin as a JSON blob. Result will be written
to stdout as a JSON blob. to stdout as a JSON blob.
""" """
params = json.loads(ui.fin.read()) params = json.loads(ui.fin.read())
result = callconduit(repo, name, params) result = callconduit(repo, name, params)
data = result[r'data'] data = result[r'data']
resolved = set(entry[r'fields'][r'username'] for entry in data) resolved = set(entry[r'fields'][r'username'] for entry in data)
unresolved = set(names) - resolved unresolved = set(names) - resolved
if unresolved: if unresolved:
raise error.Abort(_(b'unknown username: %s') raise error.Abort(_(b'unknown username: %s')
% b' '.join(sorted(unresolved))) % b' '.join(sorted(unresolved)))
return [entry[r'phid'] for entry in data] return [entry[r'phid'] for entry in data]
@command(b'phabsend', @vcrcommand(b'phabsend',
[(b'r', b'rev', [], _(b'revisions to send'), _(b'REV')), [(b'r', b'rev', [], _(b'revisions to send'), _(b'REV')),
(b'', b'amend', True, _(b'update commit messages')), (b'', b'amend', True, _(b'update commit messages')),
(b'', b'reviewer', [], _(b'specify reviewers')), (b'', b'reviewer', [], _(b'specify reviewers')),
(b'', b'confirm', None, _(b'ask for confirmation before sending'))], (b'', b'confirm', None, _(b'ask for confirmation before sending'))],
_(b'REV [OPTIONS]')) _(b'REV [OPTIONS]'))
def phabsend(ui, repo, *revs, **opts): def phabsend(ui, repo, *revs, **opts):
"""upload changesets to Phabricator """upload changesets to Phabricator
meta = getdiffmeta(diffs[str(diffid)]) meta = getdiffmeta(diffs[str(diffid)])
for k in _metanamemap.keys(): for k in _metanamemap.keys():
if k in meta: if k in meta:
header += b'# %s %s\n' % (_metanamemap[k], meta[k]) header += b'# %s %s\n' % (_metanamemap[k], meta[k])
content = b'%s%s\n%s' % (header, desc, body) content = b'%s%s\n%s' % (header, desc, body)
write(encoding.unitolocal(content)) write(encoding.unitolocal(content))
@command(b'phabread', @vcrcommand(b'phabread',
[(b'', b'stack', False, _(b'read dependencies'))], [(b'', b'stack', False, _(b'read dependencies'))],
_(b'DREVSPEC [OPTIONS]')) _(b'DREVSPEC [OPTIONS]'))
def phabread(ui, repo, spec, **opts): def phabread(ui, repo, spec, **opts):
"""print patches from Phabricator suitable for importing """print patches from Phabricator suitable for importing
DREVSPEC could be a Differential Revision identity, like ``D123``, or just DREVSPEC could be a Differential Revision identity, like ``D123``, or just
the number ``123``. It could also have common operators like ``+``, ``-``, the number ``123``. It could also have common operators like ``+``, ``-``,
``&``, ``(``, ``)`` for complex queries. Prefix ``:`` could be used to ``&``, ``(``, ``)`` for complex queries. Prefix ``:`` could be used to
If --stack is given, follow dependencies information and read all patches. If --stack is given, follow dependencies information and read all patches.
It is equivalent to the ``:`` operator. It is equivalent to the ``:`` operator.
""" """
if opts.get(b'stack'): if opts.get(b'stack'):
spec = b':(%s)' % spec spec = b':(%s)' % spec
drevs = querydrev(repo, spec) drevs = querydrev(repo, spec)
readpatch(repo, drevs, ui.write) readpatch(repo, drevs, ui.write)
@command(b'phabupdate', @vcrcommand(b'phabupdate',
[(b'', b'accept', False, _(b'accept revisions')), [(b'', b'accept', False, _(b'accept revisions')),
(b'', b'reject', False, _(b'reject revisions')), (b'', b'reject', False, _(b'reject revisions')),
(b'', b'abandon', False, _(b'abandon revisions')), (b'', b'abandon', False, _(b'abandon revisions')),
(b'', b'reclaim', False, _(b'reclaim revisions')), (b'', b'reclaim', False, _(b'reclaim revisions')),
(b'm', b'comment', b'', _(b'comment on the last revision')), (b'm', b'comment', b'', _(b'comment on the last revision')),
], _(b'DREVSPEC [OPTIONS]')) ], _(b'DREVSPEC [OPTIONS]'))
def phabupdate(ui, repo, spec, **opts): def phabupdate(ui, repo, spec, **opts):
"""update Differential Revision in batch """update Differential Revision in batch