From baec30836715238f66bedb3f49484c2a477a32eb Mon Sep 17 00:00:00 2001 From: Anthony Sottile Date: Sat, 9 Jun 2018 11:16:14 -0700 Subject: [PATCH] Allow multiple branches to be protected Original patch by @moas --- README.md | 5 ++++- pre_commit_hooks/no_commit_to_branch.py | 9 +++++---- tests/no_commit_to_branch_test.py | 17 +++++++++++++---- 3 files changed, 22 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 6a6af91..82830f4 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,10 @@ Add this to your `.pre-commit-config.yaml` - `name-tests-test` - Assert that files in tests/ end in `_test.py`. - Use `args: ['--django']` to match `test*.py` instead. - `no-commit-to-branch` - Protect specific branches from direct checkins. - - Use `args: -b ` to set the branch. `master` is the default if no argument is set. + - Use `args: [--branch ]` to set the branch. `master` is the + default if no argument is set. + - `-b` / `--branch` may be specified multiple times to protect multiple + branches. - `pyflakes` - Run pyflakes on your python files. - `pretty-format-json` - Checks that all your JSON files are pretty. "Pretty" here means that keys are sorted and indented. You can configure this with diff --git a/pre_commit_hooks/no_commit_to_branch.py b/pre_commit_hooks/no_commit_to_branch.py index 0c75217..fdd146b 100644 --- a/pre_commit_hooks/no_commit_to_branch.py +++ b/pre_commit_hooks/no_commit_to_branch.py @@ -12,18 +12,19 @@ def is_on_branch(protected): except CalledProcessError: return False chunks = branch.strip().split('/') - return '/'.join(chunks[2:]) == protected + return '/'.join(chunks[2:]) in protected def main(argv=None): parser = argparse.ArgumentParser() parser.add_argument( - '-b', '--branch', default='master', - help='branch to disallow commits to', + '-b', '--branch', action='append', + help='branch to disallow commits to, may be specified multiple times', ) args = parser.parse_args(argv) - return int(is_on_branch(args.branch)) + protected = set(args.branch or ('master',)) + return int(is_on_branch(protected)) if __name__ == '__main__': diff --git a/tests/no_commit_to_branch_test.py b/tests/no_commit_to_branch_test.py index 7e39256..c275bf7 100644 --- a/tests/no_commit_to_branch_test.py +++ b/tests/no_commit_to_branch_test.py @@ -1,6 +1,8 @@ from __future__ import absolute_import from __future__ import unicode_literals +import pytest + from pre_commit_hooks.no_commit_to_branch import is_on_branch from pre_commit_hooks.no_commit_to_branch import main from pre_commit_hooks.util import cmd_output @@ -9,24 +11,24 @@ from pre_commit_hooks.util import cmd_output def test_other_branch(temp_git_dir): with temp_git_dir.as_cwd(): cmd_output('git', 'checkout', '-b', 'anotherbranch') - assert is_on_branch('master') is False + assert is_on_branch(('master',)) is False def test_multi_branch(temp_git_dir): with temp_git_dir.as_cwd(): cmd_output('git', 'checkout', '-b', 'another/branch') - assert is_on_branch('master') is False + assert is_on_branch(('master',)) is False def test_multi_branch_fail(temp_git_dir): with temp_git_dir.as_cwd(): cmd_output('git', 'checkout', '-b', 'another/branch') - assert is_on_branch('another/branch') is True + assert is_on_branch(('another/branch',)) is True def test_master_branch(temp_git_dir): with temp_git_dir.as_cwd(): - assert is_on_branch('master') is True + assert is_on_branch(('master',)) is True def test_main_branch_call(temp_git_dir): @@ -35,6 +37,13 @@ def test_main_branch_call(temp_git_dir): assert main(('--branch', 'other')) == 1 +@pytest.mark.parametrize('branch_name', ('b1', 'b2')) +def test_forbid_multiple_branches(temp_git_dir, branch_name): + with temp_git_dir.as_cwd(): + cmd_output('git', 'checkout', '-b', branch_name) + assert main(('--branch', 'b1', '--branch', 'b2')) + + def test_main_default_call(temp_git_dir): with temp_git_dir.as_cwd(): cmd_output('git', 'checkout', '-b', 'anotherbranch')