# -*- coding: UTF-8 -*- from __future__ import unicode_literals import functools import io import os import os.path import subprocess import sys import mock import pytest import pre_commit.constants as C from pre_commit.commands.install_uninstall import install from pre_commit.commands.run import _get_skips from pre_commit.commands.run import _has_unmerged_paths from pre_commit.commands.run import get_changed_files from pre_commit.commands.run import run from pre_commit.ordereddict import OrderedDict from pre_commit.output import sys_stdout_write_wrapper from pre_commit.runner import Runner from pre_commit.util import cmd_output from pre_commit.util import cwd from testing.auto_namedtuple import auto_namedtuple from testing.fixtures import add_config_to_repo from testing.fixtures import make_consuming_repo from testing.fixtures import modify_config from testing.util import cmd_output_mocked_pre_commit_home @pytest.yield_fixture def repo_with_passing_hook(tempdir_factory): git_path = make_consuming_repo(tempdir_factory, 'script_hooks_repo') with cwd(git_path): yield git_path @pytest.yield_fixture def repo_with_failing_hook(tempdir_factory): git_path = make_consuming_repo(tempdir_factory, 'failing_hook_repo') with cwd(git_path): yield git_path def stage_a_file(filename='foo.py'): cmd_output('touch', filename) cmd_output('git', 'add', filename) def get_write_mock_output(write_mock): return b''.join(call[0][0] for call in write_mock.write.call_args_list) def _get_opts( all_files=False, files=(), color=False, verbose=False, hook=None, no_stash=False, origin='', source='', allow_unstaged_config=False, hook_stage='commit' ): # These are mutually exclusive assert not (all_files and files) return auto_namedtuple( all_files=all_files, files=files, color=color, verbose=verbose, hook=hook, hook_stage=hook_stage, no_stash=no_stash, origin=origin, source=source, allow_unstaged_config=allow_unstaged_config, ) def _do_run(repo, args, environ={}): runner = Runner(repo) write_mock = mock.Mock() write_fn = functools.partial(sys_stdout_write_wrapper, stream=write_mock) with cwd(runner.git_root): # replicates Runner.create behaviour ret = run(runner, args, write=write_fn, environ=environ) printed = get_write_mock_output(write_mock) return ret, printed def _test_run(repo, options, expected_outputs, expected_ret, stage): if stage: stage_a_file() args = _get_opts(**options) ret, printed = _do_run(repo, args) assert ret == expected_ret, (ret, expected_ret, printed) for expected_output_part in expected_outputs: assert expected_output_part in printed def test_run_all_hooks_failing( repo_with_failing_hook, mock_out_store_directory ): _test_run( repo_with_failing_hook, {}, ( b'Failing hook', b'Failed', b'hookid: failing_hook', b'Fail\nfoo.py\n', ), 1, True, ) def test_arbitrary_bytes_hook(tempdir_factory, mock_out_store_directory): git_path = make_consuming_repo(tempdir_factory, 'arbitrary_bytes_repo') with cwd(git_path): _test_run(git_path, {}, (b'\xe2\x98\x83\xb2\n',), 1, True) def test_hook_that_modifies_but_returns_zero( tempdir_factory, mock_out_store_directory, ): git_path = make_consuming_repo( tempdir_factory, 'modified_file_returns_zero_repo', ) with cwd(git_path): stage_a_file('bar.py') _test_run( git_path, {}, ( # The first should fail b'Failed', # With a modified file (default message + the hook's output) b'Files were modified by this hook. Additional output:\n\n' b'Modified: foo.py', # The next hook should pass despite the first modifying b'Passed', # The next hook should fail b'Failed', # bar.py was modified, but provides no additional output b'Files were modified by this hook.\n', ), 1, True, ) @pytest.mark.parametrize( ('options', 'outputs', 'expected_ret', 'stage'), ( ({}, (b'Bash hook', b'Passed'), 0, True), ({'verbose': True}, (b'foo.py\nHello World',), 0, True), ({'hook': 'bash_hook'}, (b'Bash hook', b'Passed'), 0, True), ({'hook': 'nope'}, (b'No hook with id `nope`',), 1, True), ( {'all_files': True, 'verbose': True}, (b'foo.py',), 0, True, ), ( {'files': ('foo.py',), 'verbose': True}, (b'foo.py',), 0, True, ), ({}, (b'Bash hook', b'(no files to check)', b'Skipped'), 0, False), ) ) def test_run( repo_with_passing_hook, options, outputs, expected_ret, stage, mock_out_store_directory, ): _test_run(repo_with_passing_hook, options, outputs, expected_ret, stage) def test_always_run(repo_with_passing_hook, mock_out_store_directory): with modify_config() as config: config[0]['hooks'][0]['always_run'] = True _test_run(repo_with_passing_hook, {}, (b'Bash hook', b'Passed'), 0, False) @pytest.mark.parametrize( ('origin', 'source', 'expect_failure'), ( ('master', 'master', False), ('master', '', True), ('', 'master', True), ) ) def test_origin_source_error_msg( repo_with_passing_hook, origin, source, expect_failure, mock_out_store_directory, ): args = _get_opts(origin=origin, source=source) ret, printed = _do_run(repo_with_passing_hook, args) warning_msg = b'Specify both --origin and --source.' if expect_failure: assert ret == 1 assert warning_msg in printed else: assert ret == 0 assert warning_msg not in printed @pytest.mark.parametrize( ('no_stash', 'all_files', 'expect_stash'), ( (True, True, False), (True, False, False), (False, True, False), (False, False, True), ), ) def test_no_stash( repo_with_passing_hook, no_stash, all_files, expect_stash, mock_out_store_directory, ): stage_a_file() # Make unstaged changes with open('foo.py', 'w') as foo_file: foo_file.write('import os\n') args = _get_opts(no_stash=no_stash, all_files=all_files) ret, printed = _do_run(repo_with_passing_hook, args) assert ret == 0 warning_msg = b'[WARNING] Unstaged files detected.' if expect_stash: assert warning_msg in printed else: assert warning_msg not in printed @pytest.mark.parametrize(('output', 'expected'), (('some', True), ('', False))) def test_has_unmerged_paths(output, expected): mock_runner = mock.Mock() mock_runner.cmd_runner.run.return_value = (1, output, '') assert _has_unmerged_paths(mock_runner) is expected def test_merge_conflict(in_merge_conflict, mock_out_store_directory): ret, printed = _do_run(in_merge_conflict, _get_opts()) assert ret == 1 assert b'Unmerged files. Resolve before committing.' in printed def test_merge_conflict_modified(in_merge_conflict, mock_out_store_directory): # Touch another file so we have unstaged non-conflicting things assert os.path.exists('dummy') with open('dummy', 'w') as dummy_file: dummy_file.write('bar\nbaz\n') ret, printed = _do_run(in_merge_conflict, _get_opts()) assert ret == 1 assert b'Unmerged files. Resolve before committing.' in printed def test_merge_conflict_resolved(in_merge_conflict, mock_out_store_directory): cmd_output('git', 'add', '.') ret, printed = _do_run(in_merge_conflict, _get_opts()) for msg in ( b'Checking merge-conflict files only.', b'Bash hook', b'Passed', ): assert msg in printed @pytest.mark.parametrize( ('environ', 'expected_output'), ( ({}, set([])), ({'SKIP': ''}, set([])), ({'SKIP': ','}, set([])), ({'SKIP': ',foo'}, set(['foo'])), ({'SKIP': 'foo'}, set(['foo'])), ({'SKIP': 'foo,bar'}, set(['foo', 'bar'])), ({'SKIP': ' foo , bar'}, set(['foo', 'bar'])), ), ) def test_get_skips(environ, expected_output): ret = _get_skips(environ) assert ret == expected_output def test_skip_hook(repo_with_passing_hook, mock_out_store_directory): ret, printed = _do_run( repo_with_passing_hook, _get_opts(), {'SKIP': 'bash_hook'}, ) for msg in (b'Bash hook', b'Skipped'): assert msg in printed def test_hook_id_not_in_non_verbose_output( repo_with_passing_hook, mock_out_store_directory ): ret, printed = _do_run(repo_with_passing_hook, _get_opts(verbose=False)) assert b'[bash_hook]' not in printed def test_hook_id_in_verbose_output( repo_with_passing_hook, mock_out_store_directory, ): ret, printed = _do_run(repo_with_passing_hook, _get_opts(verbose=True)) assert b'[bash_hook] Bash hook' in printed def test_multiple_hooks_same_id( repo_with_passing_hook, mock_out_store_directory, ): with cwd(repo_with_passing_hook): # Add bash hook on there again with modify_config() as config: config[0]['hooks'].append({'id': 'bash_hook'}) stage_a_file() ret, output = _do_run(repo_with_passing_hook, _get_opts()) assert ret == 0 assert output.count(b'Bash hook') == 2 def test_non_ascii_hook_id( repo_with_passing_hook, mock_out_store_directory, tempdir_factory, ): with cwd(repo_with_passing_hook): install(Runner(repo_with_passing_hook)) _, stdout, _ = cmd_output_mocked_pre_commit_home( sys.executable, '-m', 'pre_commit.main', 'run', '☃', retcode=None, tempdir_factory=tempdir_factory, ) assert 'UnicodeDecodeError' not in stdout # Doesn't actually happen, but a reasonable assertion assert 'UnicodeEncodeError' not in stdout def test_stdout_write_bug_py26( repo_with_failing_hook, mock_out_store_directory, tempdir_factory, ): with cwd(repo_with_failing_hook): with modify_config() as config: config[0]['hooks'][0]['args'] = ['☃'] stage_a_file() install(Runner(repo_with_failing_hook)) # Have to use subprocess because pytest monkeypatches sys.stdout _, stdout, _ = cmd_output_mocked_pre_commit_home( 'git', 'commit', '-m', 'Commit!', # git commit puts pre-commit to stderr stderr=subprocess.STDOUT, retcode=None, tempdir_factory=tempdir_factory, ) assert 'UnicodeEncodeError' not in stdout # Doesn't actually happen, but a reasonable assertion assert 'UnicodeDecodeError' not in stdout def test_hook_install_failure(mock_out_store_directory, tempdir_factory): git_path = make_consuming_repo(tempdir_factory, 'not_installable_repo') with cwd(git_path): install(Runner(git_path)) _, stdout, _ = cmd_output_mocked_pre_commit_home( 'git', 'commit', '-m', 'Commit!', # git commit puts pre-commit to stderr stderr=subprocess.STDOUT, retcode=None, encoding=None, tempdir_factory=tempdir_factory, ) assert b'UnicodeDecodeError' not in stdout # Doesn't actually happen, but a reasonable assertion assert b'UnicodeEncodeError' not in stdout # Sanity check our output assert ( b'An unexpected error has occurred: CalledProcessError: ' in stdout ) assert '☃'.encode('UTF-8') + '²'.encode('latin1') in stdout def test_get_changed_files(): files = get_changed_files( '78c682a1d13ba20e7cb735313b9314a74365cd3a', '3387edbb1288a580b37fe25225aa0b856b18ad1a', ) assert files == ['CHANGELOG.md', 'setup.py'] def test_lots_of_files(mock_out_store_directory, tempdir_factory): # windows xargs seems to have a bug, here's a regression test for # our workaround git_path = make_consuming_repo(tempdir_factory, 'python_hooks_repo') with cwd(git_path): # Override files so we run against them with modify_config() as config: config[0]['hooks'][0]['files'] = '' # Write a crap ton of files for i in range(400): filename = '{0}{1}'.format('a' * 100, i) open(filename, 'w').close() cmd_output('bash', '-c', 'git add .') install(Runner(git_path)) cmd_output_mocked_pre_commit_home( 'git', 'commit', '-m', 'Commit!', # git commit puts pre-commit to stderr stderr=subprocess.STDOUT, tempdir_factory=tempdir_factory, ) @pytest.mark.parametrize( ('hook_stage', 'stage_for_first_hook', 'stage_for_second_hook', 'expected_output'), ( ('push', ['commit'], ['commit'], [b'', b'']), ('push', ['commit', 'push'], ['commit', 'push'], [b'hook 1', b'hook 2']), ('push', [], [], [b'hook 1', b'hook 2']), ('push', [], ['commit'], [b'hook 1', b'']), ('push', ['push'], ['commit'], [b'hook 1', b'']), ('push', ['commit'], ['push'], [b'', b'hook 2']), ('commit', ['commit', 'push'], ['commit', 'push'], [b'hook 1', b'hook 2']), ('commit', ['commit'], ['commit'], [b'hook 1', b'hook 2']), ('commit', [], [], [b'hook 1', b'hook 2']), ('commit', [], ['commit'], [b'hook 1', b'hook 2']), ('commit', ['push'], ['commit'], [b'', b'hook 2']), ('commit', ['commit'], ['push'], [b'hook 1', b'']), ) ) def test_local_hook_for_stages( repo_with_passing_hook, mock_out_store_directory, stage_for_first_hook, stage_for_second_hook, hook_stage, expected_output ): config = OrderedDict(( ('repo', 'local'), ('hooks', (OrderedDict(( ('id', 'flake8'), ('name', 'hook 1'), ('entry', 'python -m flake8.__main__'), ('language', 'system'), ('files', r'\.py$'), ('stages', stage_for_first_hook) )), OrderedDict(( ('id', 'do_not_commit'), ('name', 'hook 2'), ('entry', 'DO NOT COMMIT'), ('language', 'pcre'), ('files', '^(.*)$'), ('stages', stage_for_second_hook) )))) )) add_config_to_repo(repo_with_passing_hook, config) with io.open('dummy.py', 'w') as staged_file: staged_file.write('"""TODO: something"""\n') cmd_output('git', 'add', 'dummy.py') _test_run( repo_with_passing_hook, {'hook_stage': hook_stage}, expected_outputs=expected_output, expected_ret=0, stage=False ) def test_local_hook_passes(repo_with_passing_hook, mock_out_store_directory): config = OrderedDict(( ('repo', 'local'), ('hooks', (OrderedDict(( ('id', 'flake8'), ('name', 'flake8'), ('entry', 'python -m flake8.__main__'), ('language', 'system'), ('files', r'\.py$'), )), OrderedDict(( ('id', 'do_not_commit'), ('name', 'Block if "DO NOT COMMIT" is found'), ('entry', 'DO NOT COMMIT'), ('language', 'pcre'), ('files', '^(.*)$'), )))) )) add_config_to_repo(repo_with_passing_hook, config) with io.open('dummy.py', 'w') as staged_file: staged_file.write('"""TODO: something"""\n') cmd_output('git', 'add', 'dummy.py') _test_run( repo_with_passing_hook, options={}, expected_outputs=[b''], expected_ret=0, stage=False ) def test_local_hook_fails(repo_with_passing_hook, mock_out_store_directory): config = OrderedDict(( ('repo', 'local'), ('hooks', [OrderedDict(( ('id', 'no-todo'), ('name', 'No TODO'), ('entry', 'sh -c "! grep -iI todo $@" --'), ('language', 'system'), ('files', ''), ))]) )) add_config_to_repo(repo_with_passing_hook, config) with io.open('dummy.py', 'w') as staged_file: staged_file.write('"""TODO: something"""\n') cmd_output('git', 'add', 'dummy.py') _test_run( repo_with_passing_hook, options={}, expected_outputs=[b''], expected_ret=1, stage=False, ) @pytest.yield_fixture def modified_config_repo(repo_with_passing_hook): with modify_config(repo_with_passing_hook, commit=False) as config: # Some minor modification config[0]['hooks'][0]['files'] = '' yield repo_with_passing_hook def test_allow_unstaged_config_option( modified_config_repo, mock_out_store_directory, ): args = _get_opts(allow_unstaged_config=True) ret, printed = _do_run(modified_config_repo, args) expected = ( b'You have an unstaged config file and have specified the ' b'--allow-unstaged-config option.' ) assert expected in printed assert ret == 0 def test_no_allow_unstaged_config_option( modified_config_repo, mock_out_store_directory, ): args = _get_opts(allow_unstaged_config=False) ret, printed = _do_run(modified_config_repo, args) assert b'Your .pre-commit-config.yaml is unstaged.' in printed assert ret == 1 @pytest.mark.parametrize( 'opts', ( {'allow_unstaged_config': False, 'no_stash': True}, {'all_files': True}, {'files': [C.CONFIG_FILE]}, ), ) def test_unstaged_message_suppressed( modified_config_repo, mock_out_store_directory, opts, ): args = _get_opts(**opts) ret, printed = _do_run(modified_config_repo, args) assert b'Your .pre-commit-config.yaml is unstaged.' not in printed def test_files_running_subdir( repo_with_passing_hook, mock_out_store_directory, tempdir_factory, ): with cwd(repo_with_passing_hook): install(Runner(repo_with_passing_hook)) os.mkdir('subdir') open('subdir/foo.py', 'w').close() cmd_output('git', 'add', 'subdir/foo.py') with cwd('subdir'): # Use subprocess to demonstrate behaviour in main _, stdout, _ = cmd_output_mocked_pre_commit_home( sys.executable, '-m', 'pre_commit.main', 'run', '-v', # Files relative to where we are (#339) '--files', 'foo.py', tempdir_factory=tempdir_factory, ) assert 'subdir/foo.py'.replace('/', os.sep) in stdout