This is an archive of the discontinued Mercurial Phabricator instance.

Differential D7934

phabricator: use .arcconfig for the callsign if not set locally (issue6243)
ClosedPublic

Authored by mharbison72 on Jan 17 2020, 5:47 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG59b3fe1e2021: phabricator: use .arcconfig for the callsign if not set locally (issue6243)
Summary

This makes things easier for people working with more than one repository
because this file can be committed to each repository. The bug report asks to
read <repo>/.arcrc, but AFAICT, that file lives in ~/ and holds the credentials.
And we already track an .arcconfig file. Any callsign set globally is still
used if that is all that is present, but .arcconfig will override it if
available. The idea behind letting the local hgrc override .arcconfig is that
the developer may need to do testing against another server, and not dirty the
working directory.

Originally I was going to just try to read the callsign in getrepophid() if it
wasn't present in the hg config. That works fine, but I think it also makes
sense to read the URL from this file too. That would have worked less well
because readurltoken() doesn't have access to the repo object to know where to
find the file. Supplimenting the config mechanism is less magical because it
reports the source and value of the properties used, and it doesn't need to read
the file twice.

Invalid hgrc files generally cause the program to abort. I only flagged it as a
warning here because it's not our config file, not crucial to the whole program
operating, and really shouldn't be corrupt in the typical case where it is
checked into the repo.

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.

Revision Contents
Changeset List

PathPackages
Mhgext/phabricator.py (35 lines)
Mtests/test-phabricator.t (32 lines)

Diff 19485

hgext/phabricator.py

from mercurial import ( from mercurial import (
cmdutil, cmdutil,
context, context,
encoding, encoding,
error, error,
exthelper, exthelper,
graphmod, graphmod,
httpconnection as httpconnectionmod, httpconnection as httpconnectionmod,
localrepo,
logcmdutil, logcmdutil,
match, match,
mdiff, mdiff,
obsutil, obsutil,
parser, parser,
patch, patch,
phases, phases,
pycompat, pycompat,
testedwith = b'ships-with-hg-core' testedwith = b'ships-with-hg-core'
eh = exthelper.exthelper() eh = exthelper.exthelper()
cmdtable = eh.cmdtable cmdtable = eh.cmdtable
command = eh.command command = eh.command
configtable = eh.configtable configtable = eh.configtable
templatekeyword = eh.templatekeyword templatekeyword = eh.templatekeyword
uisetup = eh.finaluisetup
# developer config: phabricator.batchsize # developer config: phabricator.batchsize
eh.configitem( eh.configitem(
b'phabricator', b'batchsize', default=12, b'phabricator', b'batchsize', default=12,
) )
eh.configitem( eh.configitem(
b'phabricator', b'callsign', default=None, b'phabricator', b'callsign', default=None,
) )
b'Path to a vcr file. If nonexistent, will record a new vcr transcript' 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', otherwise will mock all http requests using the specified vcr file.'
b' (ADVANCED)' b' (ADVANCED)'
), ),
), ),
] ]
@eh.wrapfunction(localrepo, "loadhgrc")
def _loadhgrc(orig, ui, wdirvfs, hgvfs, requirements):
"""Load ``.arcconfig`` content into a ui instance on repository open.
"""
result = False
arcconfig = {}
try:
# json.loads only accepts bytes from 3.6+
rawparams = encoding.unifromlocal(wdirvfs.read(b".arcconfig"))
# json.loads only returns unicode strings
arcconfig = pycompat.rapply(
lambda x: encoding.unitolocal(x)
if isinstance(x, pycompat.unicode)
else x,
pycompat.json_loads(rawparams),
)
result = True
except ValueError:
ui.warn(_(b"invalid JSON in %s\n") % wdirvfs.join(b".arcconfig"))
except IOError:
pass
if b"repository.callsign" in arcconfig:
ui.applyconfig(
{(b"phabricator", b"callsign"): arcconfig[b"repository.callsign"]},
source=wdirvfs.join(b".arcconfig"),
)
return orig(ui, wdirvfs, hgvfs, requirements) or result # Load .hg/hgrc
def vcrcommand(name, flags, spec, helpcategory=None, optionalrepo=False): def vcrcommand(name, flags, spec, helpcategory=None, optionalrepo=False):
fullflags = flags + _VCR_FLAGS fullflags = flags + _VCR_FLAGS
def hgmatcher(r1, r2): def hgmatcher(r1, r2):
if r1.uri != r2.uri or r1.method != r2.method: if r1.uri != r2.uri or r1.method != r2.method:
return False return False
r1params = util.urlreq.parseqs(r1.body) r1params = util.urlreq.parseqs(r1.body)
r2params = util.urlreq.parseqs(r2.body) r2params = util.urlreq.parseqs(r2.body)

tests/test-phabricator.t

+ def getvisibilityexceptions(self): + def getvisibilityexceptions(self):
+ # should be called on a filtered repository + # should be called on a filtered repository
+ return set() + return set()
+ +
def _loadextensions(self): def _loadextensions(self):
extensions.loadall(self.ui) extensions.loadall(self.ui)
A bad .arcconfig doesn't error out
$ echo 'garbage' > .arcconfig
$ hg config phabricator --debug
invalid JSON in $TESTTMP/repo/.arcconfig
read config from: */.hgrc (glob)
$TESTTMP/repo/.hg/hgrc:*: phabricator.url=https://phab.mercurial-scm.org/ (glob)
$TESTTMP/repo/.hg/hgrc:*: phabricator.callsign=HG (glob)
The .arcconfig content overrides global config
$ cat >> $HGRCPATH << EOF
> [phabricator]
> url = global
> callsign = global
> EOF
$ cp $TESTDIR/../.arcconfig .
$ mv .hg/hgrc .hg/hgrc.bak
$ hg config phabricator --debug
read config from: */.hgrc (glob)
*/.hgrc:*: phabricator.url=global (glob)
$TESTTMP/repo/.arcconfig: phabricator.callsign=HG
But it doesn't override local config
$ cat >> .hg/hgrc << EOF
> [phabricator]
> url = local
> callsign = local
> EOF
$ hg config phabricator --debug
read config from: */.hgrc (glob)
$TESTTMP/repo/.hg/hgrc:*: phabricator.url=local (glob)
$TESTTMP/repo/.hg/hgrc:*: phabricator.callsign=local (glob)
$ mv .hg/hgrc.bak .hg/hgrc
$ cd .. $ cd ..