This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5226

fix: rename :fileset subconfig to :pattern
ClosedPublic

Authored by hooper on Nov 5 2018, 7:21 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG2ecf5c24d0cd: fix: rename :fileset subconfig to :pattern
Summary

This name was always inaccurate, since the config accepts any pattern.
Hopefully so few people use this right now that it won't matter, but there will
now be a warning if the old config name is used.

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

hooper created this revision.Nov 5 2018, 7:21 PM
hooper updated this revision to Diff 12437.Nov 5 2018, 7:45 PM
yuja added a subscriber: yuja.Nov 6 2018, 6:51 AM
This name was always inaccurate, since the config accepts any pattern.
Hopefully so few people use this right now that it won't matter, but there will
now be a warning if the old config name is used.

Sounds good as the fix is still an experimental extension. Queued, thanks.

Closed by commit rHG2ecf5c24d0cd: fix: rename :fileset subconfig to :pattern (authored by hooper). · Explain WhyNov 6 2018, 6:52 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mhgext/fix.py (16 lines)
Mtests/test-fix-clang-format.t (2 lines)
Mtests/test-fix-topology.t (2 lines)
Mtests/test-fix.t (46 lines)

Diff 12446

hgext/fix.py

writing back any fixes to the working copy or replacing changesets. writing back any fixes to the working copy or replacing changesets.
Here is an example configuration that causes :hg:`fix` to apply automatic Here is an example configuration that causes :hg:`fix` to apply automatic
formatting fixes to modified lines in C++ code:: formatting fixes to modified lines in C++ code::
[fix] [fix]
clang-format:command=clang-format --assume-filename={rootpath} clang-format:command=clang-format --assume-filename={rootpath}
clang-format:linerange=--lines={first}:{last} clang-format:linerange=--lines={first}:{last}
clang-format:fileset=set:**.cpp or **.hpp clang-format:pattern=set:**.cpp or **.hpp
The :command suboption forms the first part of the shell command that will be The :command suboption forms the first part of the shell command that will be
used to fix a file. The content of the file is passed on standard input, and the used to fix a file. The content of the file is passed on standard input, and the
fixed file content is expected on standard output. Any output on standard error fixed file content is expected on standard output. Any output on standard error
will be displayed as a warning. If the exit status is not zero, the file will will be displayed as a warning. If the exit status is not zero, the file will
not be affected. A placeholder warning is displayed if there is a non-zero exit not be affected. A placeholder warning is displayed if there is a non-zero exit
status but no standard error output. Some values may be substituted into the status but no standard error output. Some values may be substituted into the
command:: command::
{rootpath} The path of the file being fixed, relative to the repo root {rootpath} The path of the file being fixed, relative to the repo root
{basename} The name of the file being fixed, without the directory path {basename} The name of the file being fixed, without the directory path
If the :linerange suboption is set, the tool will only be run if there are If the :linerange suboption is set, the tool will only be run if there are
changed lines in a file. The value of this suboption is appended to the shell changed lines in a file. The value of this suboption is appended to the shell
command once for every range of changed lines in the file. Some values may be command once for every range of changed lines in the file. Some values may be
substituted into the command:: substituted into the command::
{first} The 1-based line number of the first line in the modified range {first} The 1-based line number of the first line in the modified range
{last} The 1-based line number of the last line in the modified range {last} The 1-based line number of the last line in the modified range
The :fileset suboption determines which files will be passed through each The :pattern suboption determines which files will be passed through each
configured tool. See :hg:`help fileset` for possible values. If there are file configured tool. See :hg:`help patterns` for possible values. If there are file
arguments to :hg:`fix`, the intersection of these filesets is used. arguments to :hg:`fix`, the intersection of these patterns is used.
There is also a configurable limit for the maximum size of file that will be There is also a configurable limit for the maximum size of file that will be
processed by :hg:`fix`:: processed by :hg:`fix`::
[fix] [fix]
maxfilesize = 2MB maxfilesize = 2MB
Normally, execution of configured tools will continue after a failure (indicated Normally, execution of configured tools will continue after a failure (indicated
cmdtable = {} cmdtable = {}
command = registrar.command(cmdtable) command = registrar.command(cmdtable)
configtable = {} configtable = {}
configitem = registrar.configitem(configtable) configitem = registrar.configitem(configtable)
# Register the suboptions allowed for each configured fixer. # Register the suboptions allowed for each configured fixer.
FIXER_ATTRS = ('command', 'linerange', 'fileset') FIXER_ATTRS = ('command', 'linerange', 'fileset', 'pattern')
for key in FIXER_ATTRS: for key in FIXER_ATTRS:
configitem('fix', '.*(:%s)?' % key, default=None, generic=True) configitem('fix', '.*(:%s)?' % key, default=None, generic=True)
# A good default size allows most source code files to be fixed, but avoids # A good default size allows most source code files to be fixed, but avoids
# letting fixer tools choke on huge inputs, which could be surprising to the # letting fixer tools choke on huge inputs, which could be surprising to the
# user. # user.
configitem('fix', 'maxfilesize', default='2MB') configitem('fix', 'maxfilesize', default='2MB')
Each value is a Fixer object with methods that implement the behavior of the Each value is a Fixer object with methods that implement the behavior of the
fixer's config suboptions. Does not validate the config values. fixer's config suboptions. Does not validate the config values.
""" """
result = {} result = {}
for name in fixernames(ui): for name in fixernames(ui):
result[name] = Fixer() result[name] = Fixer()
attrs = ui.configsuboptions('fix', name)[1] attrs = ui.configsuboptions('fix', name)[1]
if 'fileset' in attrs and 'pattern' not in attrs:
ui.warn(_('the fix.tool:fileset config name is deprecated; '
'please rename it to fix.tool:pattern\n'))
attrs['pattern'] = attrs['fileset']
for key in FIXER_ATTRS: for key in FIXER_ATTRS:
setattr(result[name], pycompat.sysstr('_' + key), setattr(result[name], pycompat.sysstr('_' + key),
attrs.get(key, '')) attrs.get(key, ''))
return result return result
def fixernames(ui): def fixernames(ui):
"""Returns the names of [fix] config options that have suboptions""" """Returns the names of [fix] config options that have suboptions"""
names = set() names = set()
for k, v in ui.configitems('fix'): for k, v in ui.configitems('fix'):
if ':' in k: if ':' in k:
names.add(k.split(':', 1)[0]) names.add(k.split(':', 1)[0])
return names return names
class Fixer(object): class Fixer(object):
"""Wraps the raw config values for a fixer with methods""" """Wraps the raw config values for a fixer with methods"""
def affects(self, opts, fixctx, path): def affects(self, opts, fixctx, path):
"""Should this fixer run on the file at the given path and context?""" """Should this fixer run on the file at the given path and context?"""
return scmutil.match(fixctx, [self._fileset], opts)(path) return scmutil.match(fixctx, [self._pattern], opts)(path)
def command(self, ui, path, rangesfn): def command(self, ui, path, rangesfn):
"""A shell command to use to invoke this fixer on the given file/lines """A shell command to use to invoke this fixer on the given file/lines
May return None if there is no appropriate command to run for the given May return None if there is no appropriate command to run for the given
parameters. parameters.
""" """
expand = cmdutil.rendercommandtemplate expand = cmdutil.rendercommandtemplate

tests/test-fix-clang-format.t

#require clang-format #require clang-format
Test that a simple "hg fix" configuration for clang-format works. Test that a simple "hg fix" configuration for clang-format works.
$ cat >> $HGRCPATH <<EOF $ cat >> $HGRCPATH <<EOF
> [extensions] > [extensions]
> fix = > fix =
> [experimental] > [experimental]
> evolution.createmarkers=True > evolution.createmarkers=True
> evolution.allowunstable=True > evolution.allowunstable=True
> [fix] > [fix]
> clang-format:command=clang-format --style=Google --assume-filename={rootpath} > clang-format:command=clang-format --style=Google --assume-filename={rootpath}
> clang-format:linerange=--lines={first}:{last} > clang-format:linerange=--lines={first}:{last}
> clang-format:fileset=set:**.cpp or **.hpp > clang-format:pattern=set:**.cpp or **.hpp
> EOF > EOF
$ hg init repo $ hg init repo
$ cd repo $ cd repo
$ printf "void foo(){int x=2;}\n" > foo.cpp $ printf "void foo(){int x=2;}\n" > foo.cpp
$ printf "void\nfoo();\n" > foo.hpp $ printf "void\nfoo();\n" > foo.hpp
$ hg commit -Am "foo commit" $ hg commit -Am "foo commit"

tests/test-fix-topology.t

Looks for correct incremental fixing and reproduction of parent/child Looks for correct incremental fixing and reproduction of parent/child
relationships. We indicate fixed file content by uppercasing it. relationships. We indicate fixed file content by uppercasing it.
$ cat >> $HGRCPATH <<EOF $ cat >> $HGRCPATH <<EOF
> [extensions] > [extensions]
> fix = > fix =
> [fix] > [fix]
> uppercase-whole-file:command="$PYTHON" $UPPERCASEPY > uppercase-whole-file:command="$PYTHON" $UPPERCASEPY
> uppercase-whole-file:fileset=set:** > uppercase-whole-file:pattern=set:**
> EOF > EOF
This tests the only behavior that should really be affected by obsolescence, so This tests the only behavior that should really be affected by obsolescence, so
we'll test it with evolution off and on. This only changes the revision we'll test it with evolution off and on. This only changes the revision
numbers, if all is well. numbers, if all is well.
#testcases obsstore-off obsstore-on #testcases obsstore-off obsstore-on
#if obsstore-on #if obsstore-on

tests/test-fix.t

$ cat >> $HGRCPATH <<EOF $ cat >> $HGRCPATH <<EOF
> [extensions] > [extensions]
> fix = > fix =
> [experimental] > [experimental]
> evolution.createmarkers=True > evolution.createmarkers=True
> evolution.allowunstable=True > evolution.allowunstable=True
> [fix] > [fix]
> uppercase-whole-file:command="$PYTHON" $UPPERCASEPY all > uppercase-whole-file:command="$PYTHON" $UPPERCASEPY all
> uppercase-whole-file:fileset=set:**.whole > uppercase-whole-file:pattern=set:**.whole
> uppercase-changed-lines:command="$PYTHON" $UPPERCASEPY > uppercase-changed-lines:command="$PYTHON" $UPPERCASEPY
> uppercase-changed-lines:linerange={first}-{last} > uppercase-changed-lines:linerange={first}-{last}
> uppercase-changed-lines:fileset=set:**.changed > uppercase-changed-lines:pattern=set:**.changed
> EOF > EOF
Help text for fix. Help text for fix.
$ hg help fix $ hg help fix
hg fix [OPTION]... [FILE]... hg fix [OPTION]... [FILE]...
rewrite file content in changesets or working directory rewrite file content in changesets or working directory
files, writing back any fixes to the working copy or replacing changesets. files, writing back any fixes to the working copy or replacing changesets.
Here is an example configuration that causes 'hg fix' to apply automatic Here is an example configuration that causes 'hg fix' to apply automatic
formatting fixes to modified lines in C++ code: formatting fixes to modified lines in C++ code:
[fix] [fix]
clang-format:command=clang-format --assume-filename={rootpath} clang-format:command=clang-format --assume-filename={rootpath}
clang-format:linerange=--lines={first}:{last} clang-format:linerange=--lines={first}:{last}
clang-format:fileset=set:**.cpp or **.hpp clang-format:pattern=set:**.cpp or **.hpp
The :command suboption forms the first part of the shell command that will be The :command suboption forms the first part of the shell command that will be
used to fix a file. The content of the file is passed on standard input, and used to fix a file. The content of the file is passed on standard input, and
the fixed file content is expected on standard output. Any output on standard the fixed file content is expected on standard output. Any output on standard
error will be displayed as a warning. If the exit status is not zero, the file error will be displayed as a warning. If the exit status is not zero, the file
will not be affected. A placeholder warning is displayed if there is a non- will not be affected. A placeholder warning is displayed if there is a non-
zero exit status but no standard error output. Some values may be substituted zero exit status but no standard error output. Some values may be substituted
into the command: into the command:
{rootpath} The path of the file being fixed, relative to the repo root {rootpath} The path of the file being fixed, relative to the repo root
{basename} The name of the file being fixed, without the directory path {basename} The name of the file being fixed, without the directory path
If the :linerange suboption is set, the tool will only be run if there are If the :linerange suboption is set, the tool will only be run if there are
changed lines in a file. The value of this suboption is appended to the shell changed lines in a file. The value of this suboption is appended to the shell
command once for every range of changed lines in the file. Some values may be command once for every range of changed lines in the file. Some values may be
substituted into the command: substituted into the command:
{first} The 1-based line number of the first line in the modified range {first} The 1-based line number of the first line in the modified range
{last} The 1-based line number of the last line in the modified range {last} The 1-based line number of the last line in the modified range
The :fileset suboption determines which files will be passed through each The :pattern suboption determines which files will be passed through each
configured tool. See 'hg help fileset' for possible values. If there are file configured tool. See 'hg help patterns' for possible values. If there are file
arguments to 'hg fix', the intersection of these filesets is used. arguments to 'hg fix', the intersection of these patterns is used.
There is also a configurable limit for the maximum size of file that will be There is also a configurable limit for the maximum size of file that will be
processed by 'hg fix': processed by 'hg fix':
[fix] [fix]
maxfilesize = 2MB maxfilesize = 2MB
Normally, execution of configured tools will continue after a failure Normally, execution of configured tools will continue after a failure
$ cd incrementalfixedlines $ cd incrementalfixedlines
$ printf "a\nb\nc\nd\ne\nf\ng\n" > foo.txt $ printf "a\nb\nc\nd\ne\nf\ng\n" > foo.txt
$ hg commit -Aqm "foo" $ hg commit -Aqm "foo"
$ printf "zz\na\nc\ndd\nee\nff\nf\ngg\n" > foo.txt $ printf "zz\na\nc\ndd\nee\nff\nf\ngg\n" > foo.txt
$ hg --config "fix.fail:command=echo" \ $ hg --config "fix.fail:command=echo" \
> --config "fix.fail:linerange={first}:{last}" \ > --config "fix.fail:linerange={first}:{last}" \
> --config "fix.fail:fileset=foo.txt" \ > --config "fix.fail:pattern=foo.txt" \
> fix --working-dir > fix --working-dir
$ cat foo.txt $ cat foo.txt
1:1 4:6 8:8 1:1 4:6 8:8
$ cd .. $ cd ..
Test that --whole fixes all lines regardless of the diffs present. Test that --whole fixes all lines regardless of the diffs present.
$ hg add $ hg add
adding hello.txt adding hello.txt
$ cat > $TESTTMP/work.sh <<'EOF' $ cat > $TESTTMP/work.sh <<'EOF'
> printf 'HELLO\n' > printf 'HELLO\n'
> printf "$@: some\nerror that didn't stop the tool" >&2 > printf "$@: some\nerror that didn't stop the tool" >&2
> exit 0 # success despite the stderr output > exit 0 # success despite the stderr output
> EOF > EOF
$ hg --config "fix.work:command=sh $TESTTMP/work.sh {rootpath}" \ $ hg --config "fix.work:command=sh $TESTTMP/work.sh {rootpath}" \
> --config "fix.work:fileset=hello.txt" \ > --config "fix.work:pattern=hello.txt" \
> fix --working-dir > fix --working-dir
[wdir] work: hello.txt: some [wdir] work: hello.txt: some
[wdir] work: error that didn't stop the tool [wdir] work: error that didn't stop the tool
$ cat hello.txt $ cat hello.txt
HELLO HELLO
$ printf "goodbye\n" > hello.txt $ printf "goodbye\n" > hello.txt
$ printf "foo\n" > foo.whole $ printf "foo\n" > foo.whole
$ hg add $ hg add
adding foo.whole adding foo.whole
$ cat > $TESTTMP/fail.sh <<'EOF' $ cat > $TESTTMP/fail.sh <<'EOF'
> printf 'GOODBYE\n' > printf 'GOODBYE\n'
> printf "$@: some\nerror that did stop the tool\n" >&2 > printf "$@: some\nerror that did stop the tool\n" >&2
> exit 42 # success despite the stdout output > exit 42 # success despite the stdout output
> EOF > EOF
$ hg --config "fix.fail:command=sh $TESTTMP/fail.sh {rootpath}" \ $ hg --config "fix.fail:command=sh $TESTTMP/fail.sh {rootpath}" \
> --config "fix.fail:fileset=hello.txt" \ > --config "fix.fail:pattern=hello.txt" \
> --config "fix.failure=abort" \ > --config "fix.failure=abort" \
> fix --working-dir > fix --working-dir
[wdir] fail: hello.txt: some [wdir] fail: hello.txt: some
[wdir] fail: error that did stop the tool [wdir] fail: error that did stop the tool
abort: no fixes will be applied abort: no fixes will be applied
(use --config fix.failure=continue to apply any successful fixes anyway) (use --config fix.failure=continue to apply any successful fixes anyway)
[255] [255]
$ cat hello.txt $ cat hello.txt
goodbye goodbye
$ cat foo.whole $ cat foo.whole
foo foo
$ hg --config "fix.fail:command=sh $TESTTMP/fail.sh {rootpath}" \ $ hg --config "fix.fail:command=sh $TESTTMP/fail.sh {rootpath}" \
> --config "fix.fail:fileset=hello.txt" \ > --config "fix.fail:pattern=hello.txt" \
> fix --working-dir > fix --working-dir
[wdir] fail: hello.txt: some [wdir] fail: hello.txt: some
[wdir] fail: error that did stop the tool [wdir] fail: error that did stop the tool
$ cat hello.txt $ cat hello.txt
goodbye goodbye
$ cat foo.whole $ cat foo.whole
FOO FOO
$ hg --config "fix.fail:command=exit 42" \ $ hg --config "fix.fail:command=exit 42" \
> --config "fix.fail:fileset=hello.txt" \ > --config "fix.fail:pattern=hello.txt" \
> fix --working-dir > fix --working-dir
[wdir] fail: exited with status 42 [wdir] fail: exited with status 42
$ cd .. $ cd ..
Fixing the working directory and its parent revision at the same time should Fixing the working directory and its parent revision at the same time should
check out the replacement revision for the parent. This prevents any new check out the replacement revision for the parent. This prevents any new
uncommitted changes from appearing. We test this for a clean working directory uncommitted changes from appearing. We test this for a clean working directory
$ cd substitution $ cd substitution
$ mkdir foo $ mkdir foo
$ printf "hello\ngoodbye\n" > foo/bar $ printf "hello\ngoodbye\n" > foo/bar
$ hg add $ hg add
adding foo/bar adding foo/bar
$ hg --config "fix.fail:command=printf '%s\n' '{rootpath}' '{basename}'" \ $ hg --config "fix.fail:command=printf '%s\n' '{rootpath}' '{basename}'" \
> --config "fix.fail:linerange='{first}' '{last}'" \ > --config "fix.fail:linerange='{first}' '{last}'" \
> --config "fix.fail:fileset=foo/bar" \ > --config "fix.fail:pattern=foo/bar" \
> fix --working-dir > fix --working-dir
$ cat foo/bar $ cat foo/bar
foo/bar foo/bar
bar bar
1 1
2 2
$ cd .. $ cd ..
$ hg fix --working-dir --base 0 --whole $ hg fix --working-dir --base 0 --whole
$ cat *.changed $ cat *.changed
BAR BAR
FOO1 FOO1
FOO2 FOO2
$ cd .. $ cd ..
The :fileset subconfig was a misnomer, so we renamed it to :pattern. We will
still accept :fileset by itself as if it were :pattern, but this will issue a
warning.
$ hg init filesetispattern
$ cd filesetispattern
$ printf "foo\n" > foo.whole
$ printf "first\nsecond\n" > bar.txt
$ hg add -q
$ hg fix -w --config fix.sometool:fileset=bar.txt \
> --config fix.sometool:command=tac
the fix.tool:fileset config name is deprecated; please rename it to fix.tool:pattern
$ cat foo.whole
FOO
$ cat bar.txt
second
first
$ cd ..