1 files changed, 533 insertions, 0 deletions
diff --git a/tests/repository_test.py b/tests/repository_test.py
new file mode 100644
index 0000000..ac065ec
--- /dev/null
+++ b/tests/repository_test.py
@@ -0,0 +1,533 @@
+from __future__ import annotations
+
+import os.path
+import shlex
+import shutil
+import sys
+from typing import Any
+from unittest import mock
+
+import cfgv
+import pytest
+
+import pre_commit.constants as C
+from pre_commit import lang_base
+from pre_commit.all_languages import languages
+from pre_commit.clientlib import CONFIG_SCHEMA
+from pre_commit.clientlib import load_manifest
+from pre_commit.hook import Hook
+from pre_commit.languages import python
+from pre_commit.languages import system
+from pre_commit.prefix import Prefix
+from pre_commit.repository import _hook_installed
+from pre_commit.repository import all_hooks
+from pre_commit.repository import install_hook_envs
+from pre_commit.util import cmd_output
+from pre_commit.util import cmd_output_b
+from testing.fixtures import make_config_from_repo
+from testing.fixtures import make_repo
+from testing.language_helpers import run_language
+from testing.util import cwd
+from testing.util import get_resource_path
+
+
+def _hook_run(hook, filenames, color):
+    return run_language(
+        path=hook.prefix.prefix_dir,
+        language=languages[hook.language],
+        exe=hook.entry,
+        args=hook.args,
+        file_args=filenames,
+        version=hook.language_version,
+        deps=hook.additional_dependencies,
+        is_local=hook.src == 'local',
+        require_serial=hook.require_serial,
+        color=color,
+    )
+
+
+def _get_hook_no_install(repo_config, store, hook_id):
+    config = {'repos': [repo_config]}
+    config = cfgv.validate(config, CONFIG_SCHEMA)
+    config = cfgv.apply_defaults(config, CONFIG_SCHEMA)
+    hooks = all_hooks(config, store)
+    hook, = (hook for hook in hooks if hook.id == hook_id)
+    return hook
+
+
+def _get_hook(repo_config, store, hook_id):
+    hook = _get_hook_no_install(repo_config, store, hook_id)
+    install_hook_envs([hook], store)
+    return hook
+
+
+def _test_hook_repo(
+        tempdir_factory,
+        store,
+        repo_path,
+        hook_id,
+        args,
+        expected,
+        expected_return_code=0,
+        config_kwargs=None,
+        color=False,
+):
+    path = make_repo(tempdir_factory, repo_path)
+    config = make_config_from_repo(path, **(config_kwargs or {}))
+    hook = _get_hook(config, store, hook_id)
+    ret, out = _hook_run(hook, args, color=color)
+    assert ret == expected_return_code
+    assert out == expected
+
+
+def test_python_venv_deprecation(store, caplog):
+    config = {
+        'repo': 'local',
+        'hooks': [{
+            'id': 'example',
+            'name': 'example',
+            'language': 'python_venv',
+            'entry': 'echo hi',
+        }],
+    }
+    _get_hook(config, store, 'example')
+    assert caplog.messages[-1] == (
+        '`repo: local` uses deprecated `language: python_venv`.  '
+        'This is an alias for `language: python`.  '
+        'Often `pre-commit autoupdate --repo local` will fix this.'
+    )
+
+
+def test_system_hook_with_spaces(tempdir_factory, store):
+    _test_hook_repo(
+        tempdir_factory, store, 'system_hook_with_spaces_repo',
+        'system-hook-with-spaces', [os.devnull], b'Hello World\n',
+    )
+
+
+def test_missing_executable(tempdir_factory, store):
+    _test_hook_repo(
+        tempdir_factory, store, 'not_found_exe',
+        'not-found-exe', [os.devnull],
+        b'Executable `i-dont-exist-lol` not found',
+        expected_return_code=1,
+    )
+
+
+def test_run_a_script_hook(tempdir_factory, store):
+    _test_hook_repo(
+        tempdir_factory, store, 'script_hooks_repo',
+        'bash_hook', ['bar'], b'bar\nHello World\n',
+    )
+
+
+def test_run_hook_with_spaced_args(tempdir_factory, store):
+    _test_hook_repo(
+        tempdir_factory, store, 'arg_per_line_hooks_repo',
+        'arg-per-line',
+        ['foo bar', 'baz'],
+        b'arg: hello\narg: world\narg: foo bar\narg: baz\n',
+    )
+
+
+def test_run_hook_with_curly_braced_arguments(tempdir_factory, store):
+    _test_hook_repo(
+        tempdir_factory, store, 'arg_per_line_hooks_repo',
+        'arg-per-line',
+        [],
+        b"arg: hi {1}\narg: I'm {a} problem\n",
+        config_kwargs={
+            'hooks': [{
+                'id': 'arg-per-line',
+                'args': ['hi {1}', "I'm {a} problem"],
+            }],
+        },
+    )
+
+
+def test_intermixed_stdout_stderr(tempdir_factory, store):
+    _test_hook_repo(
+        tempdir_factory, store, 'stdout_stderr_repo',
+        'stdout-stderr',
+        [],
+        b'0\n1\n2\n3\n4\n5\n',
+    )
+
+
+@pytest.mark.xfail(sys.platform == 'win32', reason='ptys are posix-only')
+def test_output_isatty(tempdir_factory, store):
+    _test_hook_repo(
+        tempdir_factory, store, 'stdout_stderr_repo',
+        'tty-check',
+        [],
+        b'stdin: False\nstdout: True\nstderr: True\n',
+        color=True,
+    )
+
+
+def _norm_pwd(path):
+    # Under windows bash's temp and windows temp is different.
+    # This normalizes to the bash /tmp
+    return cmd_output_b(
+        'bash', '-c', f"cd '{path}' && pwd",
+    )[1].strip()
+
+
+def test_cwd_of_hook(in_git_dir, tempdir_factory, store):
+    # Note: this doubles as a test for `system` hooks
+    _test_hook_repo(
+        tempdir_factory, store, 'prints_cwd_repo',
+        'prints_cwd', ['-L'], _norm_pwd(in_git_dir.strpath) + b'\n',
+    )
+
+
+def test_lots_of_files(tempdir_factory, store):
+    _test_hook_repo(
+        tempdir_factory, store, 'script_hooks_repo',
+        'bash_hook', [os.devnull] * 15000, mock.ANY,
+    )
+
+
+def test_additional_dependencies_roll_forward(tempdir_factory, store):
+    path = make_repo(tempdir_factory, 'python_hooks_repo')
+
+    config1 = make_config_from_repo(path)
+    hook1 = _get_hook(config1, store, 'foo')
+    with python.in_env(hook1.prefix, hook1.language_version):
+        assert 'mccabe' not in cmd_output('pip', 'freeze', '-l')[1]
+
+    # Make another repo with additional dependencies
+    config2 = make_config_from_repo(path)
+    config2['hooks'][0]['additional_dependencies'] = ['mccabe']
+    hook2 = _get_hook(config2, store, 'foo')
+    with python.in_env(hook2.prefix, hook2.language_version):
+        assert 'mccabe' in cmd_output('pip', 'freeze', '-l')[1]
+
+    # should not have affected original
+    with python.in_env(hook1.prefix, hook1.language_version):
+        assert 'mccabe' not in cmd_output('pip', 'freeze', '-l')[1]
+
+
+@pytest.mark.parametrize('v', ('v1', 'v2'))
+def test_repository_state_compatibility(tempdir_factory, store, v):
+    path = make_repo(tempdir_factory, 'python_hooks_repo')
+
+    config = make_config_from_repo(path)
+    hook = _get_hook(config, store, 'foo')
+    envdir = lang_base.environment_dir(
+        hook.prefix,
+        python.ENVIRONMENT_DIR,
+        hook.language_version,
+    )
+    os.remove(os.path.join(envdir, f'.install_state_{v}'))
+    assert _hook_installed(hook) is True
+
+
+def test_unknown_keys(store, caplog):
+    config = {
+        'repo': 'local',
+        'hooks': [{
+            'id': 'too-much',
+            'name': 'too much',
+            'hello': 'world',
+            'foo': 'bar',
+            'language': 'system',
+            'entry': 'true',
+        }],
+    }
+    _get_hook(config, store, 'too-much')
+    msg, = caplog.messages
+    assert msg == 'Unexpected key(s) present on local => too-much: foo, hello'
+
+
+def test_reinstall(tempdir_factory, store, log_info_mock):
+    path = make_repo(tempdir_factory, 'python_hooks_repo')
+    config = make_config_from_repo(path)
+    _get_hook(config, store, 'foo')
+    # We print some logging during clone (1) + install (3)
+    assert log_info_mock.call_count == 4
+    log_info_mock.reset_mock()
+    # Reinstall on another run should not trigger another install
+    _get_hook(config, store, 'foo')
+    assert log_info_mock.call_count == 0
+
+
+def test_control_c_control_c_on_install(tempdir_factory, store):
+    """Regression test for #186."""
+    path = make_repo(tempdir_factory, 'python_hooks_repo')
+    config = make_config_from_repo(path)
+    hooks = [_get_hook_no_install(config, store, 'foo')]
+
+    class MyKeyboardInterrupt(KeyboardInterrupt):
+        pass
+
+    # To simulate a killed install, we'll make PythonEnv.run raise ^C
+    # and then to simulate a second ^C during cleanup, we'll make shutil.rmtree
+    # raise as well.
+    with pytest.raises(MyKeyboardInterrupt):
+        with mock.patch.object(
+            lang_base, 'setup_cmd', side_effect=MyKeyboardInterrupt,
+        ):
+            with mock.patch.object(
+                shutil, 'rmtree', side_effect=MyKeyboardInterrupt,
+            ):
+                install_hook_envs(hooks, store)
+
+    # Should have made an environment, however this environment is broken!
+    hook, = hooks
+    envdir = lang_base.environment_dir(
+        hook.prefix,
+        python.ENVIRONMENT_DIR,
+        hook.language_version,
+    )
+
+    assert os.path.exists(envdir)
+
+    # However, it should be perfectly runnable (reinstall after botched
+    # install)
+    install_hook_envs(hooks, store)
+    ret, out = _hook_run(hook, (), color=False)
+    assert ret == 0
+
+
+def test_invalidated_virtualenv(tempdir_factory, store):
+    # A cached virtualenv may become invalidated if the system python upgrades
+    # This should not cause every hook in that virtualenv to fail.
+    path = make_repo(tempdir_factory, 'python_hooks_repo')
+    config = make_config_from_repo(path)
+    hook = _get_hook(config, store, 'foo')
+
+    # Simulate breaking of the virtualenv
+    envdir = lang_base.environment_dir(
+        hook.prefix,
+        python.ENVIRONMENT_DIR,
+        hook.language_version,
+    )
+    libdir = os.path.join(envdir, 'lib', hook.language_version)
+    paths = [
+        os.path.join(libdir, p) for p in ('site.py', 'site.pyc', '__pycache__')
+    ]
+    cmd_output_b('rm', '-rf', *paths)
+
+    # pre-commit should rebuild the virtualenv and it should be runnable
+    hook = _get_hook(config, store, 'foo')
+    ret, out = _hook_run(hook, (), color=False)
+    assert ret == 0
+
+
+def test_really_long_file_paths(tempdir_factory, store):
+    base_path = tempdir_factory.get()
+    really_long_path = os.path.join(base_path, 'really_long' * 10)
+    cmd_output_b('git', 'init', really_long_path)
+
+    path = make_repo(tempdir_factory, 'python_hooks_repo')
+    config = make_config_from_repo(path)
+
+    with cwd(really_long_path):
+        _get_hook(config, store, 'foo')
+
+
+def test_config_overrides_repo_specifics(tempdir_factory, store):
+    path = make_repo(tempdir_factory, 'script_hooks_repo')
+    config = make_config_from_repo(path)
+
+    hook = _get_hook(config, store, 'bash_hook')
+    assert hook.files == ''
+    # Set the file regex to something else
+    config['hooks'][0]['files'] = '\\.sh$'
+    hook = _get_hook(config, store, 'bash_hook')
+    assert hook.files == '\\.sh$'
+
+
+def _create_repo_with_tags(tempdir_factory, src, tag):
+    path = make_repo(tempdir_factory, src)
+    cmd_output_b('git', 'tag', tag, cwd=path)
+    return path
+
+
+def test_tags_on_repositories(in_tmpdir, tempdir_factory, store):
+    tag = 'v1.1'
+    git1 = _create_repo_with_tags(tempdir_factory, 'prints_cwd_repo', tag)
+    git2 = _create_repo_with_tags(tempdir_factory, 'script_hooks_repo', tag)
+
+    config1 = make_config_from_repo(git1, rev=tag)
+    hook1 = _get_hook(config1, store, 'prints_cwd')
+    ret1, out1 = _hook_run(hook1, ('-L',), color=False)
+    assert ret1 == 0
+    assert out1.strip() == _norm_pwd(in_tmpdir)
+
+    config2 = make_config_from_repo(git2, rev=tag)
+    hook2 = _get_hook(config2, store, 'bash_hook')
+    ret2, out2 = _hook_run(hook2, ('bar',), color=False)
+    assert ret2 == 0
+    assert out2 == b'bar\nHello World\n'
+
+
+@pytest.fixture
+def local_python_config():
+    # Make a "local" hooks repo that just installs our other hooks repo
+    repo_path = get_resource_path('python_hooks_repo')
+    manifest = load_manifest(os.path.join(repo_path, C.MANIFEST_FILE))
+    hooks = [
+        dict(hook, additional_dependencies=[repo_path]) for hook in manifest
+    ]
+    return {'repo': 'local', 'hooks': hooks}
+
+
+def test_local_python_repo(store, local_python_config):
+    hook = _get_hook(local_python_config, store, 'foo')
+    # language_version should have been adjusted to the interpreter version
+    assert hook.language_version != C.DEFAULT
+    ret, out = _hook_run(hook, ('filename',), color=False)
+    assert ret == 0
+    assert out == b"['filename']\nHello World\n"
+
+
+def test_default_language_version(store, local_python_config):
+    config: dict[str, Any] = {
+        'default_language_version': {'python': 'fake'},
+        'default_stages': ['pre-commit'],
+        'repos': [local_python_config],
+    }
+
+    # `language_version` was not set, should default
+    hook, = all_hooks(config, store)
+    assert hook.language_version == 'fake'
+
+    # `language_version` is set, should not default
+    config['repos'][0]['hooks'][0]['language_version'] = 'fake2'
+    hook, = all_hooks(config, store)
+    assert hook.language_version == 'fake2'
+
+
+def test_default_stages(store, local_python_config):
+    config: dict[str, Any] = {
+        'default_language_version': {'python': C.DEFAULT},
+        'default_stages': ['pre-commit'],
+        'repos': [local_python_config],
+    }
+
+    # `stages` was not set, should default
+    hook, = all_hooks(config, store)
+    assert hook.stages == ['pre-commit']
+
+    # `stages` is set, should not default
+    config['repos'][0]['hooks'][0]['stages'] = ['pre-push']
+    hook, = all_hooks(config, store)
+    assert hook.stages == ['pre-push']
+
+
+def test_hook_id_not_present(tempdir_factory, store, caplog):
+    path = make_repo(tempdir_factory, 'script_hooks_repo')
+    config = make_config_from_repo(path)
+    config['hooks'][0]['id'] = 'i-dont-exist'
+    with pytest.raises(SystemExit):
+        _get_hook(config, store, 'i-dont-exist')
+    _, msg = caplog.messages
+    assert msg == (
+        f'`i-dont-exist` is not present in repository file://{path}.  '
+        f'Typo? Perhaps it is introduced in a newer version?  '
+        f'Often `pre-commit autoupdate` fixes this.'
+    )
+
+
+def test_manifest_hooks(tempdir_factory, store):
+    path = make_repo(tempdir_factory, 'script_hooks_repo')
+    config = make_config_from_repo(path)
+    hook = _get_hook(config, store, 'bash_hook')
+
+    assert hook == Hook(
+        src=f'file://{path}',
+        prefix=Prefix(mock.ANY),
+        additional_dependencies=[],
+        alias='',
+        always_run=False,
+        args=[],
+        description='',
+        entry='bin/hook.sh',
+        exclude='^$',
+        exclude_types=[],
+        files='',
+        id='bash_hook',
+        language='script',
+        language_version='default',
+        log_file='',
+        minimum_pre_commit_version='0',
+        name='Bash hook',
+        pass_filenames=True,
+        require_serial=False,
+        stages=[
+            'commit-msg',
+            'post-checkout',
+            'post-commit',
+            'post-merge',
+            'post-rewrite',
+            'pre-commit',
+            'pre-merge-commit',
+            'pre-push',
+            'pre-rebase',
+            'prepare-commit-msg',
+            'manual',
+        ],
+        types=['file'],
+        types_or=[],
+        verbose=False,
+        fail_fast=False,
+    )
+
+
+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?'
+    )
+
+
+def test_args_with_spaces_and_quotes(tmp_path):
+    ret = run_language(
+        tmp_path, system,
+        f"{shlex.quote(sys.executable)} -c 'import sys; print(sys.argv[1:])'",
+        ('i have spaces', 'and"\'quotes', '$and !this'),
+    )
+
+    expected = b"['i have spaces', 'and\"\\'quotes', '$and !this']\n"
+    assert ret == (0, expected)