From 80e6149cf2a2c11b0f829d9fcb75966ab53b7fd0 Mon Sep 17 00:00:00 2001 From: Alessio Izzo Date: Thu, 18 Jan 2024 09:33:01 +0100 Subject: [PATCH] add check on pre-push stage: exit if staged files not committed yet --- .gitignore | 1 + pre_commit/commands/run.py | 9 ++++++++- tests/commands/run_test.py | 33 +++++++++++++++++++++++++++++++++ 3 files changed, 42 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index c2021816..12790fcc 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ /.tox /dist .vscode/ +.idea diff --git a/pre_commit/commands/run.py b/pre_commit/commands/run.py index 8ab505ff..3c356dbe 100644 --- a/pre_commit/commands/run.py +++ b/pre_commit/commands/run.py @@ -371,7 +371,14 @@ def run( environ.get('_PRE_COMMIT_SKIP_POST_CHECKOUT') ): return 0 - + # prevent pushing staged files not committed (#2486) + if ( + args.hook_stage == 'pre-push' and git.get_staged_files() + ): + logger.error( + 'Staged files found. Please commit before pushing', + ) + return 1 # Expose prepare_commit_message_source / commit_object_name # as environment variables for the hooks if args.prepare_commit_message_source: diff --git a/tests/commands/run_test.py b/tests/commands/run_test.py index e4af1e16..ea9012c8 100644 --- a/tests/commands/run_test.py +++ b/tests/commands/run_test.py @@ -1246,3 +1246,36 @@ def test_pre_commit_env_variable_set(cap_out, store, repo_with_passing_hook): cap_out, store, repo_with_passing_hook, args, environ, ) assert environ['PRE_COMMIT'] == '1' + + +def test_pre_push_fails_if_staged_files( + cap_out, store, repo_with_passing_hook, +): + config = { + 'repo': 'local', + 'hooks': [{ + 'id': 'no-todo', + 'name': 'No TODO', + 'entry': 'sh -c "! grep -iI todo $@" --', + 'language': 'system', + 'stage': 'pre-push', + }], + } + add_config_to_repo(repo_with_passing_hook, config) + + with open('placeholder.py', 'w') as staged_file: + staged_file.write('"""TODO: something"""\n') + cmd_output('git', 'add', 'placeholder.py') + git_commit() + with open('placeholder.py', 'w') as staged_file: + staged_file.write('"""Ok"""\n') + + cmd_output('git', 'add', 'placeholder.py') + + args = run_opts(hook_stage='pre-push') + ret, printed = _do_run(cap_out, store, repo_with_passing_hook, args) + assert ret == 1 + assert printed == ( + b'[ERROR] Staged files found.' + b' Please commit before pushing\n' + )