This is an archive of the discontinued Mercurial Phabricator instance.

Differential D11822

extension: add a `required` suboption to enforce the use of an extensions
ClosedPublic

Authored by marmoute on Nov 29 2021, 11:51 AM.

Details

Reviewers
Alphare
Group Reviewers
hg-reviewers
Commits
rHG0d0ce2529540: extension: add a `required` suboption to enforce the use of an extensions
Summary

If required is set, failing to load an extensions will abort. See the test
and documentation for details.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

marmoute created this revision.Nov 29 2021, 11:51 AM
mharbison72 added a subscriber: mharbison72.Nov 30 2021, 12:24 AM
mharbison72 added inline comments.
mercurial/extensions.py
325–326

Is there any precedent for multiple hints outside of evolve? I can't think of a time when a hint would already be present, but it seems like this hint would be always useful to show?

marmoute added inline comments.Nov 30 2021, 9:36 AM
mercurial/extensions.py
325–326

It isn't multiline, it is a single line (just a tad 86 char long), but heavily indented so I had to cut the line in two in the source.

Alphare accepted this revision.Nov 30 2021, 9:39 AM
This revision is now accepted and ready to land.Nov 30 2021, 9:39 AM

Revision Contents
Changeset List

Diff 31193

mercurial/configitems.py

) )
coreconfigitem( coreconfigitem(
b'extensions', b'extensions',
b'[^:]*', b'[^:]*',
default=None, default=None,
generic=True, generic=True,
) )
coreconfigitem( coreconfigitem(
b'extensions',
b'[^:]*:required',
default=False,
generic=True,
)
coreconfigitem(
b'extdata', b'extdata',
b'.*', b'.*',
default=None, default=None,
generic=True, generic=True,
) )
coreconfigitem( coreconfigitem(
b'format', b'format',
b'bookmarks-in-store', b'bookmarks-in-store',

mercurial/extensions.py

if path: if path:
error_msg = _( error_msg = _(
b'failed to import extension "%s" from %s: %s' b'failed to import extension "%s" from %s: %s'
) )
error_msg %= (name, path, msg) error_msg %= (name, path, msg)
else: else:
error_msg = _(b'failed to import extension "%s": %s') error_msg = _(b'failed to import extension "%s": %s')
error_msg %= (name, msg) error_msg %= (name, msg)
ext_options = ui.configsuboptions(b"extensions", name)[1]
if stringutil.parsebool(ext_options.get(b"required", b'no')):
hint = None
if isinstance(inst, error.Hint) and inst.hint:
hint = inst.hint
if hint is None:
hint = _(
b"loading of this extension was required, "
b"see `hg help config.extensions` for details"
mharbison72Unsubmitted
Not Done

Is there any precedent for multiple hints outside of evolve? I can't think of a time when a hint would already be present, but it seems like this hint would be always useful to show?

mharbison72: Is there any precedent for multiple hints outside of evolve? I can't think of a time when a…
marmouteAuthorUnsubmitted
Done

It isn't multiline, it is a single line (just a tad 86 char long), but heavily indented so I had to cut the line in two in the source.

marmoute: It isn't multiline, it is a single line (just a tad 86 char long), but heavily indented so I…
)
raise error.Abort(error_msg, hint=hint)
else:
ui.warn((b"*** %s\n") % error_msg) ui.warn((b"*** %s\n") % error_msg)
if isinstance(inst, error.Hint) and inst.hint: if isinstance(inst, error.Hint) and inst.hint:
ui.warn(_(b"*** (%s)\n") % inst.hint) ui.warn(_(b"*** (%s)\n") % inst.hint)
ui.traceback() ui.traceback()
ui.log( ui.log(
b'extension', b'extension',
b'> loaded %d extensions, total time %s\n', b'> loaded %d extensions, total time %s\n',
len(_order) - newindex, len(_order) - newindex,
stats, stats,
) )
# list of (objname, loadermod, loadername) tuple: # list of (objname, loadermod, loadername) tuple:

mercurial/helptext/config.txt

Example for ``~/.hgrc``:: Example for ``~/.hgrc``::
[extensions] [extensions]
# (the churn extension will get loaded from Mercurial's path) # (the churn extension will get loaded from Mercurial's path)
churn = churn =
# (this extension will get loaded from the file specified) # (this extension will get loaded from the file specified)
myfeature = ~/.hgext/myfeature.py myfeature = ~/.hgext/myfeature.py
If an extension fails to load, a warning will be issued, and Mercurial will
proceed. To enforce that an extension must be loaded, one can set the `required`
suboption in the config::
[extensions]
myfeature = ~/.hgext/myfeature.py
myfeature:required = yes
To debug extension loading issue, one can add `--traceback` to their mercurial
invocation.
``format`` ``format``
---------- ----------
Configuration that controls the repository format. Newer format options are more Configuration that controls the repository format. Newer format options are more
powerful, but incompatible with some older versions of Mercurial. Format options powerful, but incompatible with some older versions of Mercurial. Format options
are considered at repository initialization only. You need to make a new clone are considered at repository initialization only. You need to make a new clone
for config changes to be taken into account. for config changes to be taken into account.

tests/test-extension.t

> test_unicode_default_value = $TESTTMP/test_unicode_default_value.py > test_unicode_default_value = $TESTTMP/test_unicode_default_value.py
> EOF > EOF
$ hg -R $TESTTMP/opt-unicode-default dummy $ hg -R $TESTTMP/opt-unicode-default dummy
*** failed to import extension "test_unicode_default_value" from $TESTTMP/test_unicode_default_value.py: unicode 'value' found in cmdtable.dummy *** failed to import extension "test_unicode_default_value" from $TESTTMP/test_unicode_default_value.py: unicode 'value' found in cmdtable.dummy
*** (use b'' to make it byte string) *** (use b'' to make it byte string)
hg: unknown command 'dummy' hg: unknown command 'dummy'
(did you mean summary?) (did you mean summary?)
[10] [10]
Check the mandatory extension feature
-------------------------------------
$ hg init mandatory-extensions
$ cat > $TESTTMP/mandatory-extensions/.hg/good.py << EOF
> pass
> EOF
$ cat > $TESTTMP/mandatory-extensions/.hg/bad.py << EOF
> raise RuntimeError("babar")
> EOF
$ cat > $TESTTMP/mandatory-extensions/.hg/syntax.py << EOF
> def (
> EOF
Check that the good one load :
$ cat > $TESTTMP/mandatory-extensions/.hg/hgrc << EOF
> [extensions]
> good = $TESTTMP/mandatory-extensions/.hg/good.py
> EOF
$ hg -R mandatory-extensions id
000000000000 tip
Make it mandatory to load
$ cat >> $TESTTMP/mandatory-extensions/.hg/hgrc << EOF
> good:required = yes
> EOF
$ hg -R mandatory-extensions id
000000000000 tip
Check that the bad one does not load
$ cat >> $TESTTMP/mandatory-extensions/.hg/hgrc << EOF
> bad = $TESTTMP/mandatory-extensions/.hg/bad.py
> EOF
$ hg -R mandatory-extensions id
*** failed to import extension "bad" from $TESTTMP/mandatory-extensions/.hg/bad.py: babar
000000000000 tip
Make it mandatory to load
$ cat >> $TESTTMP/mandatory-extensions/.hg/hgrc << EOF
> bad:required = yes
> EOF
$ hg -R mandatory-extensions id
abort: failed to import extension "bad" from $TESTTMP/mandatory-extensions/.hg/bad.py: babar
(loading of this extension was required, see `hg help config.extensions` for details)
[255]
Make it not mandatory to load
$ cat >> $TESTTMP/mandatory-extensions/.hg/hgrc << EOF
> bad:required = no
> EOF
$ hg -R mandatory-extensions id
*** failed to import extension "bad" from $TESTTMP/mandatory-extensions/.hg/bad.py: babar
000000000000 tip
Same check with the syntax error one
$ cat >> $TESTTMP/mandatory-extensions/.hg/hgrc << EOF
> bad = !
> syntax = $TESTTMP/mandatory-extensions/.hg/syntax.py
> syntax:required = yes
> EOF
$ hg -R mandatory-extensions id
abort: failed to import extension "syntax" from $TESTTMP/mandatory-extensions/.hg/syntax.py: invalid syntax (*syntax.py, line 1) (glob)
(loading of this extension was required, see `hg help config.extensions` for details)
[255]
Same check with a missing one
$ cat >> $TESTTMP/mandatory-extensions/.hg/hgrc << EOF
> syntax = !
> syntax:required =
> missing = foo/bar/baz/I/do/not/exist/
> missing:required = yes
> EOF
$ hg -R mandatory-extensions id
abort: failed to import extension "missing" from foo/bar/baz/I/do/not/exist/: [Errno 2] $ENOENT$: 'foo/bar/baz/I/do/not/exist'
(loading of this extension was required, see `hg help config.extensions` for details)
[255]