from __future__ import absolute_import from __future__ import unicode_literals import io import os import os.path import re import pkg_resources import subprocess import stat from plumbum import local from pre_commit.commands.install import install from pre_commit.commands.install import is_our_pre_commit from pre_commit.commands.install import make_executable from pre_commit.runner import Runner from testing.fixtures import git_dir from testing.fixtures import make_consuming_repo def test_is_not_our_pre_commit(): assert is_our_pre_commit('setup.py') is False def test_is_our_pre_commit(): assert is_our_pre_commit( pkg_resources.resource_filename( 'pre_commit', 'resources/pre-commit-hook', ) ) is True def test_install_pre_commit(tmpdir_factory): path = git_dir(tmpdir_factory) runner = Runner(path) ret = install(runner) assert ret == 0 assert os.path.exists(runner.pre_commit_path) pre_commit_contents = io.open(runner.pre_commit_path).read() pre_commit_script = pkg_resources.resource_filename( 'pre_commit', 'resources/pre-commit-hook', ) expected_contents = io.open(pre_commit_script).read() assert pre_commit_contents == expected_contents stat_result = os.stat(runner.pre_commit_path) assert stat_result.st_mode & (stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH) def _get_commit_output(tmpdir_factory, touch_file='foo'): local['touch'](touch_file) local['git']('add', touch_file) # Don't want to write to home directory env = dict(os.environ, **{'PRE_COMMIT_HOME': tmpdir_factory.get()}) return local['git'].run( ['commit', '-m', 'Commit!', '--allow-empty'], # git commit puts pre-commit to stderr stderr=subprocess.STDOUT, env=env, retcode=None, )[:2] NORMAL_PRE_COMMIT_RUN = re.compile( r'^\[INFO\] Installing environment for .+\.\n' r'\[INFO\] Once installed this environment will be reused\.\n' r'\[INFO\] This may take a few minutes\.\.\.\n' r'Bash hook\.+Passed\n' r'\[master [a-f0-9]{7}\] Commit!\n' r' 0 files changed\n' r' create mode 100644 foo\n$' ) def test_install_pre_commit_and_run(tmpdir_factory): path = make_consuming_repo(tmpdir_factory, 'script_hooks_repo') with local.cwd(path): assert install(Runner(path)) == 0 ret, output = _get_commit_output(tmpdir_factory) assert ret == 0 assert NORMAL_PRE_COMMIT_RUN.match(output) def test_install_idempotent(tmpdir_factory): path = make_consuming_repo(tmpdir_factory, 'script_hooks_repo') with local.cwd(path): assert install(Runner(path)) == 0 assert install(Runner(path)) == 0 ret, output = _get_commit_output(tmpdir_factory) assert ret == 0 assert NORMAL_PRE_COMMIT_RUN.match(output) def test_environment_not_sourced(tmpdir_factory): path = make_consuming_repo(tmpdir_factory, 'script_hooks_repo') with local.cwd(path): assert install(Runner(path)) == 0 ret, stdout, stderr = local['git'].run( ['commit', '--allow-empty', '-m', 'foo'], env={}, retcode=None, ) assert ret == 1 assert stdout == '' assert stderr == ( '`pre-commit` not found. ' 'Did you forget to activate your virtualenv?\n' ) FAILING_PRE_COMMIT_RUN = re.compile( r'^\[INFO\] Installing environment for .+\.\n' r'\[INFO\] Once installed this environment will be reused\.\n' r'\[INFO\] This may take a few minutes\.\.\.\n' r'Failing hook\.+Failed\n' r'\n' r'Fail\n' r'foo\n' r'\n$' ) def test_failing_hooks_returns_nonzero(tmpdir_factory): path = make_consuming_repo(tmpdir_factory, 'failing_hook_repo') with local.cwd(path): assert install(Runner(path)) == 0 ret, output = _get_commit_output(tmpdir_factory) assert ret == 1 assert FAILING_PRE_COMMIT_RUN.match(output) EXISTING_COMMIT_RUN = re.compile( r'^legacy hook\n' r'\[master [a-f0-9]{7}\] Commit!\n' r' 0 files changed\n' r' create mode 100644 baz\n$' ) def test_install_existing_hooks_no_overwrite(tmpdir_factory): path = make_consuming_repo(tmpdir_factory, 'script_hooks_repo') with local.cwd(path): runner = Runner(path) # Write out an "old" hook with io.open(runner.pre_commit_path, 'w') as hook_file: hook_file.write('#!/usr/bin/env bash\necho "legacy hook"\n') make_executable(runner.pre_commit_path) # Make sure we installed the "old" hook correctly ret, output = _get_commit_output(tmpdir_factory, touch_file='baz') assert ret == 0 assert EXISTING_COMMIT_RUN.match(output) # Now install pre-commit (no-overwrite) assert install(Runner(path)) == 0 # We should run both the legacy and pre-commit hooks ret, output = _get_commit_output(tmpdir_factory) assert ret == 0 assert output.startswith('legacy hook\n') assert NORMAL_PRE_COMMIT_RUN.match(output[len('legacy hook\n'):]) FAIL_OLD_HOOK = re.compile( r'fail!\n' r'\[INFO\] Installing environment for .+\.\n' r'\[INFO\] Once installed this environment will be reused\.\n' r'\[INFO\] This may take a few minutes\.\.\.\n' r'Bash hook\.+Passed\n' ) def test_failing_existing_hook_returns_1(tmpdir_factory): path = make_consuming_repo(tmpdir_factory, 'script_hooks_repo') with local.cwd(path): runner = Runner(path) # Write out a failing "old" hook with io.open(runner.pre_commit_path, 'w') as hook_file: hook_file.write('#!/usr/bin/env bash\necho "fail!"\nexit 1\n') make_executable(runner.pre_commit_path) assert install(Runner(path)) == 0 # We should get a failure from the legacy hook ret, output = _get_commit_output(tmpdir_factory) assert ret == 1 assert FAIL_OLD_HOOK.match(output)