Amend approach for no-commit-to-branch to use regex matching based on feedback. Adds --pattern optional argument which can be used alongside --branch to block commits to a branch which matches a supplied regex expression
diff --git a/README.md b/README.md index abcd030..96325b9 100644 --- a/README.md +++ b/README.md
@@ -79,10 +79,12 @@ - `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: [--branch, staging, --branch, master, --branch, release/*]` to set the branch. + - Use `args: [--branch, staging, --branch, master]` to set the branch. `master` is the default if no argument is set. - `-b` / `--branch` may be specified multiple times to protect multiple branches. + - `-p` / `--pattern` can be used to protect branches that match a supplied regex + (e.g. `--pattern, release/.*`). May be specified multiple times. - `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 the following commandline options:
diff --git a/pre_commit_hooks/no_commit_to_branch.py b/pre_commit_hooks/no_commit_to_branch.py index 8729891..585eadc 100644 --- a/pre_commit_hooks/no_commit_to_branch.py +++ b/pre_commit_hooks/no_commit_to_branch.py
@@ -1,7 +1,7 @@ from __future__ import print_function import argparse -import fnmatch +import re from typing import Optional from typing import Sequence from typing import Set @@ -10,14 +10,17 @@ from pre_commit_hooks.util import cmd_output -def is_on_branch(protected): # type: (Set[str]) -> bool +def is_on_branch(protected, patterns=set()): + # type: (Set[str], Set[str]) -> bool try: ref_name = cmd_output('git', 'symbolic-ref', 'HEAD') except CalledProcessError: return False chunks = ref_name.strip().split('/') branch_name = '/'.join(chunks[2:]) - return any(fnmatch.fnmatch(branch_name, s) for s in protected) + return branch_name in protected or any( + re.match(p, branch_name) for p in patterns + ) def main(argv=None): # type: (Optional[Sequence[str]]) -> int @@ -26,10 +29,18 @@ '-b', '--branch', action='append', help='branch to disallow commits to, may be specified multiple times', ) + parser.add_argument( + '-p', '--pattern', action='append', + help=( + 'regex pattern for branch name to disallow commits to, ' + 'May be specified multiple times' + ), + ) args = parser.parse_args(argv) protected = set(args.branch or ('master',)) - return int(is_on_branch(protected)) + patterns = set(args.pattern or ()) + return int(is_on_branch(protected, patterns)) if __name__ == '__main__':
diff --git a/tests/no_commit_to_branch_test.py b/tests/no_commit_to_branch_test.py index a83d8de..a2ab1f1 100644 --- a/tests/no_commit_to_branch_test.py +++ b/tests/no_commit_to_branch_test.py
@@ -44,17 +44,17 @@ assert main(('--branch', 'b1', '--branch', 'b2')) -def test_branch_wildcard_fail(temp_git_dir): +def test_branch_pattern_fail(temp_git_dir): with temp_git_dir.as_cwd(): cmd_output('git', 'checkout', '-b', 'another/branch') - assert is_on_branch({'another/*'}) is True + assert is_on_branch(set(), {'another/.*'}) is True @pytest.mark.parametrize('branch_name', ('master', 'another/branch')) -def test_branch_wildcard_multiple_branches_fail(temp_git_dir, branch_name): +def test_branch_pattern_multiple_branches_fail(temp_git_dir, branch_name): with temp_git_dir.as_cwd(): cmd_output('git', 'checkout', '-b', branch_name) - assert main(('--branch', 'master', '--branch', 'another/*')) + assert main(('--branch', 'master', '--pattern', 'another/.*')) def test_main_default_call(temp_git_dir):