Skip to content

Commit

Permalink
produce a more useful error message when non-installable things use l…
Browse files Browse the repository at this point in the history
…anguage_version or additional_dependencies
  • Loading branch information
asottile committed Jan 22, 2021
1 parent bb50e00 commit 4f39946
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 0 deletions.
18 changes: 18 additions & 0 deletions pre_commit/repository.py
Expand Up @@ -118,6 +118,24 @@ def _hook(
if not ret['stages']:
ret['stages'] = root_config['default_stages']

if languages[lang].ENVIRONMENT_DIR is None:
if ret['language_version'] != C.DEFAULT:
logger.error(
f'The hook `{ret["id"]}` specifies `language_version` but is '
f'using language `{lang}` which does not install an '
f'environment. '
f'Perhaps you meant to use a specific language?',
)
exit(1)
if ret['additional_dependencies']:
logger.error(
f'The hook `{ret["id"]}` specifies `additional_dependencies` '
f'but is using language `{lang}` which does not install an '
f'environment. '
f'Perhaps you meant to use a specific language?',
)
exit(1)

return ret


Expand Down
46 changes: 46 additions & 0 deletions tests/repository_test.py
Expand Up @@ -942,3 +942,49 @@ def test_dotnet_hook(tempdir_factory, store, repo):
tempdir_factory, store, repo,
'dotnet example hook', [], b'Hello from dotnet!\n',
)


def test_non_installable_hook_error_for_language_version(store, caplog):
config = {
'repo': 'local',
'hooks': [{
'id': 'system-hook',
'name': 'system-hook',
'language': 'system',
'entry': 'python3 -c "import sys; print(sys.version)"',
'language_version': 'python3.10',
}],
}
with pytest.raises(SystemExit) as excinfo:
_get_hook(config, store, 'system-hook')
assert excinfo.value.code == 1

msg, = caplog.messages
assert msg == (
'The hook `system-hook` specifies `language_version` but is using '
'language `system` which does not install an environment. '
'Perhaps you meant to use a specific language?'
)


def test_non_installable_hook_error_for_additional_dependencies(store, caplog):
config = {
'repo': 'local',
'hooks': [{
'id': 'system-hook',
'name': 'system-hook',
'language': 'system',
'entry': 'python3 -c "import sys; print(sys.version)"',
'additional_dependencies': ['astpretty'],
}],
}
with pytest.raises(SystemExit) as excinfo:
_get_hook(config, store, 'system-hook')
assert excinfo.value.code == 1

msg, = caplog.messages
assert msg == (
'The hook `system-hook` specifies `additional_dependencies` but is '
'using language `system` which does not install an environment. '
'Perhaps you meant to use a specific language?'
)

0 comments on commit 4f39946

Please sign in to comment.