Add "--check" option support to end_of_file_fixer hook

This commit is contained in:
zhiwei.meng 2026-04-01 17:16:02 +08:00
parent f1dff44d3a
commit 3b8b26a097
2 changed files with 52 additions and 24 deletions

View file

@ -10,34 +10,56 @@ from pre_commit_hooks.end_of_file_fixer import main
# Input, expected return value, expected output
TESTS = (
(b'foo\n', 0, b'foo\n'),
(b'', 0, b''),
(b'\n\n', 1, b''),
(b'\n\n\n\n', 1, b''),
(b'foo', 1, b'foo\n'),
(b'foo\n\n\n', 1, b'foo\n'),
(b'\xe2\x98\x83', 1, b'\xe2\x98\x83\n'),
(b'foo\r\n', 0, b'foo\r\n'),
(b'foo\r\n\r\n\r\n', 1, b'foo\r\n'),
(b'foo\r', 0, b'foo\r'),
(b'foo\r\r\r\r', 1, b'foo\r'),
(b'foo\n', 0, b'foo\n', None),
(b'', 0, b'', None),
(b'\n\n', 1, b'', None),
(b'\n\n\n\n', 1, b'', None),
(b'foo', 1, b'foo\n', None),
(b'foo\n\n\n', 1, b'foo\n', None),
(b'\xe2\x98\x83', 1, b'\xe2\x98\x83\n', None),
(b'foo\r\n', 0, b'foo\r\n', None),
(b'foo\r\n\r\n\r\n', 1, b'foo\r\n', None),
(b'foo\r', 0, b'foo\r', None),
(b'foo\r\r\r\r', 1, b'foo\r', None),
(b'foo\n', 0, b'foo\n', '--check'),
(b'', 0, b'', '--check'),
(b'\n\n', 1, b'\n\n', '--check'),
(b'\n\n\n\n', 1, b'\n\n\n\n', '--check'),
(b'foo', 1, b'foo', '--check'),
(b'foo\n\n\n', 1, b'foo\n\n\n', '--check'),
(b'\xe2\x98\x83', 1, b'\xe2\x98\x83', '--check'),
(b'foo\r\n', 0, b'foo\r\n', '--check'),
(b'foo\r\n\r\n\r\n', 1, b'foo\r\n\r\n\r\n', '--check'),
(b'foo\r', 0, b'foo\r', '--check'),
(b'foo\r\r\r\r', 1, b'foo\r\r\r\r', '--check'),
)
@pytest.mark.parametrize(('input_s', 'expected_retval', 'output'), TESTS)
def test_fix_file(input_s, expected_retval, output):
@pytest.mark.parametrize(('input_s', 'expected_retval', 'output', 'options'), TESTS)
def test_fix_file(input_s, expected_retval, output, options):
if options is None:
options = []
elif isinstance(options, str):
options = [options]
file_obj = io.BytesIO(input_s)
ret = fix_file(file_obj)
ret = fix_file(file_obj, "--check" in [*options])
assert file_obj.getvalue() == output
assert ret == expected_retval
@pytest.mark.parametrize(('input_s', 'expected_retval', 'output'), TESTS)
def test_integration(input_s, expected_retval, output, tmpdir):
@pytest.mark.parametrize(('input_s', 'expected_retval', 'output', 'options'), TESTS)
def test_integration(input_s, expected_retval, output, options, tmpdir):
path = tmpdir.join('file.txt')
path.write_binary(input_s)
ret = main([str(path)])
if options is None:
options = []
elif isinstance(options, str):
options = [options]
ret = main([*options, str(path)])
file_output = path.read_binary()
assert file_output == output