This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9981

hooks: introduce a `:run-with-plain` option for hooks
ClosedPublic

Authored by marmoute on Feb 10 2021, 6:47 PM.

Download Raw Diff

Details

Reviewers

None

Group Reviewers

hg-reviewers

Commits

rHG7289eac777ec: hooks: introduce a `:run-with-plain` option for hooks
rHGf22f663733e6: hooks: introduce a `:run-with-plain` option for hooks

Summary

This option control if HGPLAIN should be set or not for the hooks. This is the
first step to give user some control of the HGPLAIN setting for they hooks.

Some hooks (eg: consistency checking) deserve to be run with HGPLAIN, some other
(eg: user set visual helper) might need to respect the user config and setting.

So both usage are valid and we need to restore the ability to run -without-
HGPLAIN that got lost in Mercurial 5.7.

This does not offer a way to restore the pre-5.7 behavior yet (respect whatever
HGPLAIN setting from the shell), this will be dealt with in the next changeset.

The option name is a bit verbose because implementing this highlighs the need
for another option: :run-if-plain. That would make it possible for some hooks
to be easily disabled if HG PLAIN is set. However such option would be a new
feature, not something introduced to mitigate a behavior change introduced in
5.7, so the :run-if-plain option belong to the default branch and is not part
of this series.

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

marmoute created this revision.Feb 10 2021, 6:47 PM

Herald added a reviewer: hg-reviewers. · View Herald TranscriptFeb 10 2021, 6:47 PM

Herald added a subscriber: mercurial-patches. · View Herald Transcript

marmoute added a child revision: D9982: hooks: add a `auto` value for `hooks.*run-with-plain`.Feb 10 2021, 6:47 PM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

marmoute added a commit: rHGf22f663733e6: hooks: introduce a `:run-with-plain` option for hooks.Feb 11 2021, 11:34 AM

This revision was not accepted when it landed; it landed in state Needs Review.

Closed by commit rHGf22f663733e6: hooks: introduce a `:run-with-plain` option for hooks (authored by marmoute). · Explain Why

This revision was automatically updated to reflect the committed changes.

marmoute added a commit: rHG7289eac777ec: hooks: introduce a `:run-with-plain` option for hooks.Feb 12 2021, 12:04 AM

Revision Contents
Changeset List

			Path	Packages
M			mercurial/configitems.py (6 lines)
M			mercurial/helptext/config.txt (5 lines)
M			mercurial/hook.py (7 lines)
M			tests/test-hook.t (10 lines)

Diff	ID	Description	Created	Lint	Unit
Base		Base
Diff 1	25539		Feb 10 2021, 6:47 PM	★	★
Diff 2	25543		Feb 10 2021, 8:11 PM	★	★
Diff 3	25545		Feb 11 2021, 5:25 AM	★	★
Diff 4	25551	rHGf22f663733e6fe335b1527347984bba892dde7f0	Feb 10 2021, 5:21 PM	★	★

Status	Author	Revision
Abandoned	marmoute	D9980 procutil: add a way to unset and environment variable
Closed	marmoute	D9982 hooks: add a `auto` value for `hooks.*run-with-plain`
Closed	marmoute	D9981 hooks: introduce a `:run-with-plain` option for hooks
Closed	marmoute	D9979 hooks: add some test about HGPLAIN setting and hooks
Closed	marmoute	D9978 hooks: forbid ':' in hook name

Diff 25551

mercurial/configitems.py

	)			)
	coreconfigitem(			coreconfigitem(
	b'hooks',			b'hooks',
	b'[^:]*',			b'[^:]*',
	default=dynamicdefault,			default=dynamicdefault,
	generic=True,			generic=True,
	)			)
	coreconfigitem(			coreconfigitem(
				b'hooks',
				b'.*:run-with-plain',
				default=True,
				generic=True,
				)
				coreconfigitem(
	b'hgweb-paths',			b'hgweb-paths',
	b'.*',			b'.*',
	default=list,			default=list,
	generic=True,			generic=True,
	)			)
	coreconfigitem(			coreconfigitem(
	b'hostfingerprints',			b'hostfingerprints',
	b'.*',			b'.*',

mercurial/helptext/config.txt

	# update working directory after adding changesets			# update working directory after adding changesets
	changegroup.update = hg update			changegroup.update = hg update
	# do not use the site-wide hook			# do not use the site-wide hook
	incoming =			incoming =
	incoming.email = /my/email/hook			incoming.email = /my/email/hook
	incoming.autobuild = /my/build/hook			incoming.autobuild = /my/build/hook
	# force autobuild hook to run before other incoming hooks			# force autobuild hook to run before other incoming hooks
	priority.incoming.autobuild = 1			priority.incoming.autobuild = 1
				### control HGPLAIN setting when running autobuild hook
				# HGPLAIN always set (default from Mercurial 5.7)
				incoming.autobuild:run-with-plain = yes
				# HGPLAIN never set
				incoming.autobuild:run-with-plain = no

	Most hooks are run with environment variables set that give useful			Most hooks are run with environment variables set that give useful
	additional information. For each hook below, the environment variables			additional information. For each hook below, the environment variables
	it is passed are listed with names in the form ``$HG_foo``. The			it is passed are listed with names in the form ``$HG_foo``. The
	``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.			``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
	They contain the type of hook which triggered the run and the full name			They contain the type of hook which triggered the run and the full name
	of the hook in the config, respectively. In the example above, this will			of the hook in the config, respectively. In the example above, this will
	be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.			be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.

mercurial/hook.py

	# make in-memory changes visible to external process			# make in-memory changes visible to external process
	if repo is not None:			if repo is not None:
	tr = repo.currenttransaction()			tr = repo.currenttransaction()
	repo.dirstate.write(tr)			repo.dirstate.write(tr)
	if tr and tr.writepending():			if tr and tr.writepending():
	env[b'HG_PENDING'] = repo.root			env[b'HG_PENDING'] = repo.root
	env[b'HG_HOOKTYPE'] = htype			env[b'HG_HOOKTYPE'] = htype
	env[b'HG_HOOKNAME'] = name			env[b'HG_HOOKNAME'] = name

				plain = ui.configbool(b'hooks', b'%s:run-with-plain' % name)
				if plain:
	env[b'HGPLAIN'] = b'1'			env[b'HGPLAIN'] = b'1'
				else:
				env[b'HGPLAIN'] = b''

	for k, v in pycompat.iteritems(args):			for k, v in pycompat.iteritems(args):
	# transaction changes can accumulate MBs of data, so skip it			# transaction changes can accumulate MBs of data, so skip it
	# for external hooks			# for external hooks
	if k == b'changes':			if k == b'changes':
	continue			continue
	if callable(v):			if callable(v):
	v = v()			v = v()

tests/test-hook.t

	> untrusted=!			> untrusted=!
	> EOF			> EOF

	HGPLAIN setting in hooks			HGPLAIN setting in hooks
	========================			========================

	$ cat << EOF >> .hg/hgrc			$ cat << EOF >> .hg/hgrc
	> [hooks]			> [hooks]
	> pre-version.testing-default=echo '### default ###' plain: \$HGPLAIN			> pre-version.testing-default=echo '### default ###' plain: \${HGPLAIN:-'<unset>'}
				> pre-version.testing-yes=echo '### yes #######' plain: \${HGPLAIN:-'<unset>'}
				> pre-version.testing-yes:run-with-plain=yes
				> pre-version.testing-no=echo '### no ########' plain: \${HGPLAIN:-'<unset>'}
				> pre-version.testing-no:run-with-plain=no
	> EOF			> EOF

	$ (unset HGPLAIN; hg version --quiet)			$ (unset HGPLAIN; hg version --quiet)
	### default ### plain: 1			### default ### plain: 1
				### yes ####### plain: 1
				### no ######## plain: <unset>
	Mercurial Distributed SCM (*) (glob)			Mercurial Distributed SCM (*) (glob)

	$ HGPLAIN=1 hg version --quiet			$ HGPLAIN=1 hg version --quiet
	### default ### plain: 1			### default ### plain: 1
				### yes ####### plain: 1
				### no ######## plain: <unset>
	Mercurial Distributed SCM (*) (glob)			Mercurial Distributed SCM (*) (glob)