( )⚙ D5237 fix: add suboption for configuring execution order of tools

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5237

fix: add suboption for configuring execution order of tools
ClosedPublic

Authored by hooper on Nov 6 2018, 9:02 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHGb9557567cc3f: fix: add suboption for configuring execution order of tools
Summary

This could be accomplished by using wrapper scripts, but that would diminish
the usefulness of the incremental formatting logic. Configuring execution order
along with other things in the hgrc is probably more convenient anyway.

This change highlights some awkwardness with suboptions and default values,
which should be addressed separately.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

hooper created this revision.Nov 6 2018, 9:02 PM
hooper updated this revision to Diff 12461.Nov 6 2018, 9:03 PM
yuja added a subscriber: yuja.Nov 7 2018, 7:34 AM

+ When multiple tools are configured to affect a file, they execute in an order
+ defined by the :priority suboption. The priority suboption has a default value
+ of zero for each tool. Tools are executed in order of ascending priority.

Appears that we use "descending" priority in hooks and merge-tools. Let's
follow these. Other than that, the patch looks good to me.

hooper updated this revision to Diff 12473.Nov 7 2018, 5:05 PM
Closed by commit rHGb9557567cc3f: fix: add suboption for configuring execution order of tools (authored by hooper). · Explain WhyNov 8 2018, 6:53 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mhgext/fix.py (45 lines)
Mtests/test-fix.t (68 lines)

Diff 12473

hgext/fix.py

Normally, execution of configured tools will continue after a failure (indicated Normally, execution of configured tools will continue after a failure (indicated
by a non-zero exit status). It can also be configured to abort after the first by a non-zero exit status). It can also be configured to abort after the first
such failure, so that no files will be affected if any tool fails. This abort such failure, so that no files will be affected if any tool fails. This abort
will also cause :hg:`fix` to exit with a non-zero status:: will also cause :hg:`fix` to exit with a non-zero status::
[fix] [fix]
failure = abort failure = abort
When multiple tools are configured to affect a file, they execute in an order
defined by the :priority suboption. The priority suboption has a default value
of zero for each tool. Tools are executed in order of descending priority. The
execution order of tools with equal priority is unspecified. For example, you
could use the 'sort' and 'head' utilities to keep only the 10 smallest numbers
in a text file by ensuring that 'sort' runs before 'head'::
[fix]
sort:command = sort --numeric-sort
head:command = head --lines=10
sort:pattern = numbers.txt
head:pattern = numbers.txt
sort:priority = 2
head:priority = 1
To account for changes made by each tool, the line numbers used for incremental
formatting are recomputed before executing the next tool. So, each tool may see
different values for the arguments added by the :linerange suboption.
""" """
from __future__ import absolute_import from __future__ import absolute_import
import collections import collections
import itertools import itertools
import os import os
import re import re
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', 'pattern') FIXER_ATTRS = {
'command': None,
'linerange': None,
'fileset': None,
'pattern': None,
'priority': 0,
}
for key in FIXER_ATTRS: for key, default in FIXER_ATTRS.items():
configitem('fix', '.*(:%s)?' % key, default=None, generic=True) configitem('fix', '.*(:%s)?' % key, default=default, 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')
# Allow fix commands to exit non-zero if an executed fixer tool exits non-zero. # Allow fix commands to exit non-zero if an executed fixer tool exits non-zero.
# This helps users do shell scripts that stop when a fixer tool signals a # This helps users do shell scripts that stop when a fixer tool signals a
replacements[ctx.node()] = sucnode replacements[ctx.node()] = sucnode
def getfixers(ui): def getfixers(ui):
"""Returns a map of configured fixer tools indexed by their names """Returns a map of configured fixer tools indexed by their names
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 = {} fixers = {}
for name in fixernames(ui): for name in fixernames(ui):
result[name] = Fixer() fixers[name] = Fixer()
attrs = ui.configsuboptions('fix', name)[1] attrs = ui.configsuboptions('fix', name)[1]
if 'fileset' in attrs and 'pattern' not in attrs: if 'fileset' in attrs and 'pattern' not in attrs:
ui.warn(_('the fix.tool:fileset config name is deprecated; ' ui.warn(_('the fix.tool:fileset config name is deprecated; '
'please rename it to fix.tool:pattern\n')) 'please rename it to fix.tool:pattern\n'))
attrs['pattern'] = attrs['fileset'] attrs['pattern'] = attrs['fileset']
for key in FIXER_ATTRS: for key, default in FIXER_ATTRS.items():
setattr(result[name], pycompat.sysstr('_' + key), setattr(fixers[name], pycompat.sysstr('_' + key),
attrs.get(key, '')) attrs.get(key, default))
return result fixers[name]._priority = int(fixers[name]._priority)
return collections.OrderedDict(
sorted(fixers.items(), key=lambda item: item[1]._priority,
reverse=True))
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

tests/test-fix.t

Normally, execution of configured tools will continue after a failure Normally, execution of configured tools will continue after a failure
(indicated by a non-zero exit status). It can also be configured to abort (indicated by a non-zero exit status). It can also be configured to abort
after the first such failure, so that no files will be affected if any tool after the first such failure, so that no files will be affected if any tool
fails. This abort will also cause 'hg fix' to exit with a non-zero status: fails. This abort will also cause 'hg fix' to exit with a non-zero status:
[fix] [fix]
failure = abort failure = abort
When multiple tools are configured to affect a file, they execute in an order
defined by the :priority suboption. The priority suboption has a default value
of zero for each tool. Tools are executed in order of descending priority. The
execution order of tools with equal priority is unspecified. For example, you
could use the 'sort' and 'head' utilities to keep only the 10 smallest numbers
in a text file by ensuring that 'sort' runs before 'head':
[fix]
sort:command = sort --numeric-sort
head:command = head --lines=10
sort:pattern = numbers.txt
head:pattern = numbers.txt
sort:priority = 2
head:priority = 1
To account for changes made by each tool, the line numbers used for
incremental formatting are recomputed before executing the next tool. So, each
tool may see different values for the arguments added by the :linerange
suboption.
list of commands: list of commands:
fix rewrite file content in changesets or working directory fix rewrite file content in changesets or working directory
(use 'hg help -v -e fix' to show built-in aliases and global options) (use 'hg help -v -e fix' to show built-in aliases and global options)
There is no default behavior in the absence of --rev and --working-dir. There is no default behavior in the absence of --rev and --working-dir.
$ cat foo.whole $ cat foo.whole
FOO FOO
$ cat bar.txt $ cat bar.txt
second second
first first
$ cd .. $ cd ..
The execution order of tools can be controlled. This example doesn't work if
you sort after truncating, but the config defines the correct order while the
definitions are out of order (which might imply the incorrect order given the
implementation of fix). The goal is to use multiple tools to select the lowest
5 numbers in the file.
$ hg init priorityexample
$ cd priorityexample
$ cat >> .hg/hgrc <<EOF
> [fix]
> head:command = head --lines=5
> head:pattern = numbers.txt
> head:priority = 1
> sort:command = sort --numeric-sort
> sort:pattern = numbers.txt
> sort:priority = 2
> EOF
$ printf "8\n2\n3\n6\n7\n4\n9\n5\n1\n0\n" > numbers.txt
$ hg add -q
$ hg fix -w
$ cat numbers.txt
0
1
2
3
4
And of course we should be able to break this by reversing the execution order.
Test negative priorities while we're at it.
$ cat >> .hg/hgrc <<EOF
> [fix]
> head:priority = -1
> sort:priority = -2
> EOF
$ printf "8\n2\n3\n6\n7\n4\n9\n5\n1\n0\n" > numbers.txt
$ hg fix -w
$ cat numbers.txt
2
3
6
7
8
$ cd ..