mirror of
https://github.com/pre-commit/pre-commit.git
synced 2026-01-25 02:08:41 -06:00
278 lines
8.8 KiB
Python
278 lines
8.8 KiB
Python
import mock
|
|
import os
|
|
import os.path
|
|
import pkg_resources
|
|
import pytest
|
|
import shutil
|
|
import stat
|
|
from asottile.ordereddict import OrderedDict
|
|
from asottile.yaml import ordered_dump
|
|
from plumbum import local
|
|
|
|
|
|
import pre_commit.constants as C
|
|
from pre_commit import commands
|
|
from pre_commit import git
|
|
from pre_commit.clientlib.validate_config import CONFIG_JSON_SCHEMA
|
|
from pre_commit.clientlib.validate_config import validate_config_extra
|
|
from pre_commit.jsonschema_extensions import apply_defaults
|
|
from pre_commit.runner import Runner
|
|
from testing.auto_namedtuple import auto_namedtuple
|
|
from testing.util import get_resource_path
|
|
|
|
|
|
def test_install_pre_commit(empty_git_dir):
|
|
runner = Runner(empty_git_dir)
|
|
ret = commands.install(runner)
|
|
assert ret == 0
|
|
assert os.path.exists(runner.pre_commit_path)
|
|
pre_commit_contents = open(runner.pre_commit_path).read()
|
|
pre_commit_sh = pkg_resources.resource_filename('pre_commit', 'resources/pre-commit.sh')
|
|
expected_contents = open(pre_commit_sh).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 test_uninstall_pre_commit_does_not_blow_up_when_not_there(empty_git_dir):
|
|
runner = Runner(empty_git_dir)
|
|
ret = commands.uninstall(runner)
|
|
assert ret == 0
|
|
|
|
|
|
def test_uninstall(empty_git_dir):
|
|
runner = Runner(empty_git_dir)
|
|
assert not os.path.exists(runner.pre_commit_path)
|
|
commands.install(runner)
|
|
assert os.path.exists(runner.pre_commit_path)
|
|
commands.uninstall(runner)
|
|
assert not os.path.exists(runner.pre_commit_path)
|
|
|
|
|
|
@pytest.yield_fixture
|
|
def up_to_date_repo(python_hooks_repo):
|
|
config = OrderedDict((
|
|
('repo', python_hooks_repo),
|
|
('sha', git.get_head_sha(python_hooks_repo)),
|
|
('hooks', [OrderedDict((('id', 'foo'), ('files', '')))]),
|
|
))
|
|
wrapped_config = apply_defaults([config], CONFIG_JSON_SCHEMA)
|
|
validate_config_extra(wrapped_config)
|
|
config = wrapped_config[0]
|
|
|
|
with open(os.path.join(python_hooks_repo, C.CONFIG_FILE), 'w') as file_obj:
|
|
file_obj.write(
|
|
ordered_dump([config], **C.YAML_DUMP_KWARGS)
|
|
)
|
|
|
|
yield auto_namedtuple(
|
|
repo_config=config,
|
|
python_hooks_repo=python_hooks_repo,
|
|
)
|
|
|
|
|
|
def test_up_to_date_repo(up_to_date_repo):
|
|
input_sha = up_to_date_repo.repo_config['sha']
|
|
ret = commands._update_repository(up_to_date_repo.repo_config)
|
|
assert ret['sha'] == input_sha
|
|
|
|
|
|
def test_autoupdate_up_to_date_repo(up_to_date_repo):
|
|
before = open(C.CONFIG_FILE).read()
|
|
runner = Runner(up_to_date_repo.python_hooks_repo)
|
|
ret = commands.autoupdate(runner)
|
|
after = open(C.CONFIG_FILE).read()
|
|
assert ret == 0
|
|
assert before == after
|
|
|
|
|
|
@pytest.yield_fixture
|
|
def out_of_date_repo(python_hooks_repo):
|
|
config = OrderedDict((
|
|
('repo', python_hooks_repo),
|
|
('sha', git.get_head_sha(python_hooks_repo)),
|
|
('hooks', [OrderedDict((('id', 'foo'), ('files', '')))]),
|
|
))
|
|
config_wrapped = apply_defaults([config], CONFIG_JSON_SCHEMA)
|
|
validate_config_extra(config_wrapped)
|
|
config = config_wrapped[0]
|
|
local['git']['commit', '--allow-empty', '-m', 'foo']()
|
|
head_sha = git.get_head_sha(python_hooks_repo)
|
|
|
|
with open(os.path.join(python_hooks_repo, C.CONFIG_FILE), 'w') as file_obj:
|
|
file_obj.write(
|
|
ordered_dump([config], **C.YAML_DUMP_KWARGS)
|
|
)
|
|
|
|
yield auto_namedtuple(
|
|
repo_config=config,
|
|
head_sha=head_sha,
|
|
python_hooks_repo=python_hooks_repo,
|
|
)
|
|
|
|
|
|
def test_out_of_date_repo(out_of_date_repo):
|
|
ret = commands._update_repository(out_of_date_repo.repo_config)
|
|
assert ret['sha'] == out_of_date_repo.head_sha
|
|
|
|
|
|
def test_removes_defaults(out_of_date_repo):
|
|
ret = commands._update_repository(out_of_date_repo.repo_config)
|
|
assert 'args' not in ret['hooks'][0]
|
|
assert 'expected_return_value' not in ret['hooks'][0]
|
|
|
|
|
|
def test_autoupdate_out_of_date_repo(out_of_date_repo):
|
|
before = open(C.CONFIG_FILE).read()
|
|
runner = Runner(out_of_date_repo.python_hooks_repo)
|
|
ret = commands.autoupdate(runner)
|
|
after = open(C.CONFIG_FILE).read()
|
|
assert ret == 0
|
|
assert before != after
|
|
assert out_of_date_repo.head_sha in after
|
|
|
|
|
|
@pytest.yield_fixture
|
|
def hook_disappearing_repo(python_hooks_repo):
|
|
config = OrderedDict((
|
|
('repo', python_hooks_repo),
|
|
('sha', git.get_head_sha(python_hooks_repo)),
|
|
('hooks', [OrderedDict((('id', 'foo'), ('files', '')))]),
|
|
))
|
|
config_wrapped = apply_defaults([config], CONFIG_JSON_SCHEMA)
|
|
validate_config_extra(config_wrapped)
|
|
config = config_wrapped[0]
|
|
shutil.copy(get_resource_path('manifest_without_foo.yaml'), C.MANIFEST_FILE)
|
|
local['git']['add', '.']()
|
|
local['git']['commit', '-m', 'Remove foo']()
|
|
|
|
with open(os.path.join(python_hooks_repo, C.CONFIG_FILE), 'w') as file_obj:
|
|
file_obj.write(
|
|
ordered_dump([config], **C.YAML_DUMP_KWARGS)
|
|
)
|
|
|
|
yield auto_namedtuple(
|
|
repo_config=config,
|
|
python_hooks_repo=python_hooks_repo,
|
|
)
|
|
|
|
|
|
def test_hook_disppearing_repo_raises(hook_disappearing_repo):
|
|
with pytest.raises(commands.RepositoryCannotBeUpdatedError):
|
|
commands._update_repository(hook_disappearing_repo.repo_config)
|
|
|
|
|
|
def test_autoupdate_hook_disappearing_repo(hook_disappearing_repo):
|
|
before = open(C.CONFIG_FILE).read()
|
|
runner = Runner(hook_disappearing_repo.python_hooks_repo)
|
|
ret = commands.autoupdate(runner)
|
|
after = open(C.CONFIG_FILE).read()
|
|
assert ret == 1
|
|
assert before == after
|
|
|
|
|
|
def test_clean(empty_git_dir):
|
|
os.mkdir(C.HOOKS_WORKSPACE)
|
|
commands.clean(Runner(empty_git_dir))
|
|
assert not os.path.exists(C.HOOKS_WORKSPACE)
|
|
|
|
|
|
def test_clean_empty(empty_git_dir):
|
|
assert not os.path.exists(C.HOOKS_WORKSPACE)
|
|
commands.clean(Runner(empty_git_dir))
|
|
assert not os.path.exists(C.HOOKS_WORKSPACE)
|
|
|
|
|
|
def stage_a_file():
|
|
local['touch']['foo.py']()
|
|
local['git']['add', 'foo.py']()
|
|
|
|
|
|
def get_write_mock_output(write_mock):
|
|
return ''.join(call[0][0] for call in write_mock.call_args_list)
|
|
|
|
|
|
def test_run_all_hooks_passing(repo_with_passing_hook):
|
|
stage_a_file()
|
|
runner = Runner(repo_with_passing_hook)
|
|
args = auto_namedtuple(
|
|
all_files=False, color=False, verbose=False, hook=None,
|
|
)
|
|
write_mock = mock.Mock()
|
|
ret = commands.run(runner, args, write=write_mock)
|
|
assert ret == 0
|
|
printed = get_write_mock_output(write_mock)
|
|
assert 'Bash hook' in printed
|
|
assert 'Passed' in printed
|
|
|
|
|
|
def test_verbose_prints_output(repo_with_passing_hook):
|
|
stage_a_file()
|
|
runner = Runner(repo_with_passing_hook)
|
|
args = auto_namedtuple(
|
|
all_files=False, color=False, verbose=True, hook=None,
|
|
)
|
|
write_mock = mock.Mock()
|
|
ret = commands.run(runner, args, write=write_mock)
|
|
assert ret == 0
|
|
printed = get_write_mock_output(write_mock)
|
|
assert 'foo.py\nHello World\n' in printed
|
|
|
|
|
|
def test_run_all_hooks_failing(repo_with_failing_hook):
|
|
stage_a_file()
|
|
runner = Runner(repo_with_failing_hook)
|
|
args = auto_namedtuple(
|
|
all_files=False, color=False, verbose=False, hook=None,
|
|
)
|
|
write_mock = mock.Mock()
|
|
ret = commands.run(runner, args, write=write_mock)
|
|
assert ret == 1
|
|
printed = get_write_mock_output(write_mock)
|
|
assert 'Failing hook' in printed
|
|
assert 'Failed' in printed
|
|
assert 'Fail\nfoo.py\n' in printed
|
|
|
|
|
|
def test_run_a_specific_hook(repo_with_passing_hook):
|
|
stage_a_file()
|
|
runner = Runner(repo_with_passing_hook)
|
|
args = auto_namedtuple(
|
|
all_files=False, color=False, verbose=False, hook='bash_hook',
|
|
)
|
|
write_mock = mock.Mock()
|
|
ret = commands.run(runner, args, write=write_mock)
|
|
assert ret == 0
|
|
printed = get_write_mock_output(write_mock)
|
|
assert 'Bash hook' in printed
|
|
assert 'Passed' in printed
|
|
|
|
|
|
def test_run_a_non_existing_hook(repo_with_passing_hook):
|
|
stage_a_file()
|
|
runner = Runner(repo_with_passing_hook)
|
|
args = auto_namedtuple(
|
|
all_files=False, color=False, verbose=False, hook='nope',
|
|
)
|
|
write_mock = mock.Mock()
|
|
ret = commands.run(runner, args, write=write_mock)
|
|
assert ret == 1
|
|
printed = get_write_mock_output(write_mock)
|
|
assert 'No hook with id `nope`' in printed
|
|
|
|
|
|
def test_run_all_files(repo_with_passing_hook):
|
|
stage_a_file()
|
|
runner = Runner(repo_with_passing_hook)
|
|
args = auto_namedtuple(
|
|
all_files=True, color=False, verbose=True, hook=None,
|
|
)
|
|
write_mock = mock.Mock()
|
|
ret = commands.run(runner, args, write=write_mock)
|
|
assert ret == 0
|
|
printed = get_write_mock_output(write_mock)
|
|
# These are all the files checked into the repo.
|
|
# This seems kind of weird but it is because py.test reuses fixtures
|
|
for filename in 'hooks.yaml bin/hook.sh foo.py dummy'.split():
|
|
assert filename in printed
|