third-party/pre-commit
1
0
Fork 0
mirror of https://github.com/pre-commit/pre-commit.git synced 2026-02-19 09:04:41 +04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #821 from pre-commit/allow_language_fail_check_useless_excludes

Browse source 
Exempt `language: fail` hooks from check-hooks-apply
This commit is contained in:
Anthony Sottile 2018-09-02 19:49:01 -07:00 • committed by GitHub
commit a2bd0097c5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 140 additions and 117 deletions
Download patch file Download diff file Expand all files Collapse all files

2
pre_commit/meta_hooks/check_hooks_apply.py
View file

@ -15,7 +15,7 @@ def check_all_hooks_match_files(config_file):
for repo in repositories(load_config(config_file), Store()): for repo in repositories(load_config(config_file), Store()):
for hook_id, hook in repo.hooks: for hook_id, hook in repo.hooks:
if hook['always_run']: if hook['always_run'] or hook['language'] == 'fail':
continue continue
include, exclude = hook['files'], hook['exclude'] include, exclude = hook['files'], hook['exclude']
filtered = _filter_by_include_exclude(files, include, exclude) filtered = _filter_by_include_exclude(files, include, exclude)

160
tests/meta_hooks/check_hooks_apply_test.py
View file

@ -1,5 +1,3 @@
from collections import OrderedDict
from pre_commit.meta_hooks import check_hooks_apply from pre_commit.meta_hooks import check_hooks_apply
from testing.fixtures import add_config_to_repo from testing.fixtures import add_config_to_repo
from testing.fixtures import git_dir from testing.fixtures import git_dir
@ -7,17 +5,19 @@ from testing.util import cwd
def test_hook_excludes_everything(capsys, tempdir_factory, mock_store_dir): def test_hook_excludes_everything(capsys, tempdir_factory, mock_store_dir):
config = OrderedDict(( config = {
('repo', 'meta'), 'repos': [
( {
'hooks', ( 'repo': 'meta',
OrderedDict(( 'hooks': [
('id', 'check-useless-excludes'), {
('exclude', '.pre-commit-config.yaml'), 'id': 'check-useless-excludes',
)), 'exclude': '.pre-commit-config.yaml',
), },
), ],
)) },
],
}
repo = git_dir(tempdir_factory) repo = git_dir(tempdir_factory)
add_config_to_repo(repo, config) add_config_to_repo(repo, config)
@ -30,17 +30,19 @@ def test_hook_excludes_everything(capsys, tempdir_factory, mock_store_dir):
def test_hook_includes_nothing(capsys, tempdir_factory, mock_store_dir): def test_hook_includes_nothing(capsys, tempdir_factory, mock_store_dir):
config = OrderedDict(( config = {
('repo', 'meta'), 'repos': [
( {
'hooks', ( 'repo': 'meta',
OrderedDict(( 'hooks': [
('id', 'check-useless-excludes'), {
('files', 'foo'), 'id': 'check-useless-excludes',
)), 'files': 'foo',
), },
), ],
)) },
],
}
repo = git_dir(tempdir_factory) repo = git_dir(tempdir_factory)
add_config_to_repo(repo, config) add_config_to_repo(repo, config)
@ -53,17 +55,19 @@ def test_hook_includes_nothing(capsys, tempdir_factory, mock_store_dir):
def test_hook_types_not_matched(capsys, tempdir_factory, mock_store_dir): def test_hook_types_not_matched(capsys, tempdir_factory, mock_store_dir):
config = OrderedDict(( config = {
('repo', 'meta'), 'repos': [
( {
'hooks', ( 'repo': 'meta',
OrderedDict(( 'hooks': [
('id', 'check-useless-excludes'), {
('types', ['python']), 'id': 'check-useless-excludes',
)), 'types': ['python'],
), },
), ],
)) },
],
}
repo = git_dir(tempdir_factory) repo = git_dir(tempdir_factory)
add_config_to_repo(repo, config) add_config_to_repo(repo, config)
@ -78,17 +82,19 @@ def test_hook_types_not_matched(capsys, tempdir_factory, mock_store_dir):
def test_hook_types_excludes_everything( def test_hook_types_excludes_everything(
capsys, tempdir_factory, mock_store_dir, capsys, tempdir_factory, mock_store_dir,
): ):
config = OrderedDict(( config = {
('repo', 'meta'), 'repos': [
( {
'hooks', ( 'repo': 'meta',
OrderedDict(( 'hooks': [
('id', 'check-useless-excludes'), {
('exclude_types', ['yaml']), 'id': 'check-useless-excludes',
)), 'exclude_types': ['yaml'],
), },
), ],
)) },
],
}
repo = git_dir(tempdir_factory) repo = git_dir(tempdir_factory)
add_config_to_repo(repo, config) add_config_to_repo(repo, config)
@ -100,23 +106,51 @@ def test_hook_types_excludes_everything(
assert 'check-useless-excludes does not apply to this repository' in out assert 'check-useless-excludes does not apply to this repository' in out
def test_valid_includes(capsys, tempdir_factory, mock_store_dir): def test_valid_always_run(capsys, tempdir_factory, mock_store_dir):
config = OrderedDict(( config = {
('repo', 'meta'), 'repos': [
( {
'hooks', ( 'repo': 'meta',
OrderedDict(( 'hooks': [
('id', 'check-useless-excludes'), # Should not be reported as an error due to always_run
)), {
# Should not be reported as an error due to always_run 'id': 'check-useless-excludes',
OrderedDict(( 'files': '^$',
('id', 'check-useless-excludes'), 'always_run': True,
('files', '^$'), },
('always_run', True), ],
)), },
), ],
), }
))
repo = git_dir(tempdir_factory)
add_config_to_repo(repo, config)
with cwd(repo):
assert check_hooks_apply.main(()) == 0
out, _ = capsys.readouterr()
assert out == ''
def test_valid_language_fail(capsys, tempdir_factory, mock_store_dir):
config = {
'repos': [
{
'repo': 'local',
'hooks': [
# Should not be reported as an error due to language: fail
{
'id': 'changelogs-rst',
'name': 'changelogs must be rst',
'entry': 'changelog filenames must end in .rst',
'language': 'fail',
'files': r'changelog/.*(?<!\.rst)$',
},
],
},
],
}
repo = git_dir(tempdir_factory) repo = git_dir(tempdir_factory)
add_config_to_repo(repo, config) add_config_to_repo(repo, config)

95
tests/meta_hooks/useless_excludes_test.py → tests/meta_hooks/check_useless_excludes_test.py
View file

@ -1,5 +1,3 @@
from collections import OrderedDict
from pre_commit.meta_hooks import check_useless_excludes from pre_commit.meta_hooks import check_useless_excludes
from testing.fixtures import add_config_to_repo from testing.fixtures import add_config_to_repo
from testing.fixtures import git_dir from testing.fixtures import git_dir
@ -7,23 +5,15 @@ from testing.util import cwd
def test_useless_exclude_global(capsys, tempdir_factory): def test_useless_exclude_global(capsys, tempdir_factory):
config = OrderedDict(( config = {
('exclude', 'foo'), 'exclude': 'foo',
( 'repos': [
'repos', [ {
OrderedDict(( 'repo': 'meta',
('repo', 'meta'), 'hooks': [{'id': 'check-useless-excludes'}],
( },
'hooks', ( ],
OrderedDict(( }
('id', 'check-useless-excludes'),
)),
),
),
)),
],
),
))
repo = git_dir(tempdir_factory) repo = git_dir(tempdir_factory)
add_config_to_repo(repo, config) add_config_to_repo(repo, config)
@ -32,21 +22,19 @@ def test_useless_exclude_global(capsys, tempdir_factory):
assert check_useless_excludes.main(()) == 1 assert check_useless_excludes.main(()) == 1
out, _ = capsys.readouterr() out, _ = capsys.readouterr()
assert "The global exclude pattern 'foo' does not match any files" in out out = out.strip()
assert "The global exclude pattern 'foo' does not match any files" == out
def test_useless_exclude_for_hook(capsys, tempdir_factory): def test_useless_exclude_for_hook(capsys, tempdir_factory):
config = OrderedDict(( config = {
('repo', 'meta'), 'repos': [
( {
'hooks', ( 'repo': 'meta',
OrderedDict(( 'hooks': [{'id': 'check-useless-excludes', 'exclude': 'foo'}],
('id', 'check-useless-excludes'), },
('exclude', 'foo'), ],
)), }
),
),
))
repo = git_dir(tempdir_factory) repo = git_dir(tempdir_factory)
add_config_to_repo(repo, config) add_config_to_repo(repo, config)
@ -55,24 +43,23 @@ def test_useless_exclude_for_hook(capsys, tempdir_factory):
assert check_useless_excludes.main(()) == 1 assert check_useless_excludes.main(()) == 1
out, _ = capsys.readouterr() out, _ = capsys.readouterr()
out = out.strip()
expected = ( expected = (
"The exclude pattern 'foo' for check-useless-excludes " "The exclude pattern 'foo' for check-useless-excludes "
"does not match any files" "does not match any files"
) )
assert expected in out assert expected == out
def test_no_excludes(capsys, tempdir_factory): def test_no_excludes(capsys, tempdir_factory):
config = OrderedDict(( config = {
('repo', 'meta'), 'repos': [
( {
'hooks', ( 'repo': 'meta',
OrderedDict(( 'hooks': [{'id': 'check-useless-excludes'}],
('id', 'check-useless-excludes'), },
)), ],
), }
),
))
repo = git_dir(tempdir_factory) repo = git_dir(tempdir_factory)
add_config_to_repo(repo, config) add_config_to_repo(repo, config)
@ -85,17 +72,19 @@ def test_no_excludes(capsys, tempdir_factory):
def test_valid_exclude(capsys, tempdir_factory): def test_valid_exclude(capsys, tempdir_factory):
config = OrderedDict(( config = {
('repo', 'meta'), 'repos': [
( {
'hooks', ( 'repo': 'meta',
OrderedDict(( 'hooks': [
('id', 'check-useless-excludes'), {
('exclude', '.pre-commit-config.yaml'), 'id': 'check-useless-excludes',
)), 'exclude': '.pre-commit-config.yaml',
), },
), ],
)) },
],
}
repo = git_dir(tempdir_factory) repo = git_dir(tempdir_factory)
add_config_to_repo(repo, config) add_config_to_repo(repo, config)