Merge pull request innogames#34 from seqizz/g_regexpcheck

Add optional branch name regexp check

Author: seqizz

README.rst

@@ -44,6 +44,7 @@ Features
 * Accept commits tagged as ``[HOTFIX]``, ``[MESS]``, ``[TEMP]``, or ``[WIP]``
  with issues
 * Check executable bits and shebangs
+* Check for allowed branch names
 * Check symlinks
 * Check CSS files with ``csslint``
 * Check Go files with ``golint``
@@ -210,6 +211,9 @@ Version 3.1
 Version 3.2
  * Reduce severity of length for merge commit summary to warning
 
+Version 3.3
+ * Add optional branch name check via regular expressions
+
 
 License
 -------

igcommit/__init__.py

@@ -4,4 +4,4 @@
 Portions Copyright (c) 2021 Emre Hasegeli
 """
 
-VERSION= (3, 2)
+VERSION= (3, 3)

igcommit/commit_list_checks.py

@@ -4,10 +4,13 @@
 Portions Copyright (c) 2021 Emre Hasegeli
 """
 
+importre
 fromtimeimporttime
+fromos.pathimportexists
+fromosimportremove
 
 fromigcommit.base_checkimportBaseCheck, Severity
-fromigcommit.gitimportCommit, CommitList
+fromigcommit.gitimportCommit, CommitList, CommittedFile
 
 
 classCommitListCheck(BaseCheck):
@@ -253,3 +256,97 @@ def check_contributor(self, contributor, commit):
 'the same name'
  .format(commit, contributor.email, other.email),
  )
+
+
+classCheckBranchNameRegexp(CommitListCheck):
+"""Check branch names against regular expressions
+
+ The configuration file can contain a list of regular expressions
+ (one per line). The branch names are checked against those,
+ and the commit is rejected if none of them match.
+ """
+
+config_files= []
+
+defprepare(self, obj):
+new=super(CheckBranchNameRegexp, self).prepare(obj)
+config_exists=new._prepare_configs(obj)
+ifconfig_exists:
+returnnew
+
+def_prepare_configs(self, commitlist):
+"""Update used configuration files, return true if any exist
+
+ This is copied from file_checks.py and slightly modified.
+ Please check the original file for explanation and
+ shortcomings.
+ """
+config_exists=False
+forconfig_fileinself.config_files:
+prev_commit=config_file.commit
+# We will check if the config file exists on the latest commit
+config_file.commit=commitlist[-1]
+
+ifconfig_file.exists():
+config_exists=True
+
+# If the file is not changed on this commit, we can skip
+# downloading.
+ifnotprev_commitorconfig_file.changed():
+withopen(config_file.path, 'wb') asfd:
+fd.write(config_file.get_content())
+elifexists(config_file.path):
+# Not found on the latest commit, but it exists on the
+# workspace. Remove it.
+remove(config_file.path)
+
+returnconfig_exists
+
+defget_allowed_regexes(self):
+forconfig_fileinself.config_files:
+withopen(config_file.path) asf:
+allowed_regexes=f.read().splitlines()
+valid_list= []
+failed_list= []
+forregexlineinallowed_regexes:
+try:
+ifnotregexline.strip():
+continue
+re.compile(regexline)
+valid_list.append(regexline)
+exceptre.error:
+failed_list.append(regexline)
+returnvalid_list, failed_list
+
+defcheck_branch_name(self, regexp_list, branch_name):
+"""Fails if the branch name does not match any regexp
+
+ It's enough to fit only one of the allowed patterns
+ """
+trimmed_branch_name=re.sub('refs/heads/', '', branch_name)
+forpatterninregexp_list:
+ifre.match(pattern, trimmed_branch_name):
+returnTrue
+returnFalse
+
+defget_problems(self):
+branch_name=self.commit_list.branch_name
+valid_regexes, broken_regexes=self.get_allowed_regexes()
+ifbroken_regexes:
+yield (
+Severity.WARNING,
+'following string is not a valid pattern '
+'for branch name comparison:\n{}'
+ .format("\n".join(broken_regexes))
+ )
+ifnotself.check_branch_name(valid_regexes, branch_name):
+yield (
+Severity.ERROR,
+'{} is not an allowed branch name.\n'
+'Branch names must match any of the following '
+'list of regular expressions:\n{}'
+ .format(
+branch_name,
+'\n'.join(valid_regexes)
+ )
+ )

igcommit/config.py

@@ -19,6 +19,7 @@
 CheckDuplicateCommitSummaries,
 CheckMisleadingMergeCommit,
 CheckTimestamps,
+CheckBranchNameRegexp,
 )
 fromigcommit.file_checksimport (
 CheckCommand,
@@ -35,6 +36,9 @@
 checks.append(CheckMisleadingMergeCommit())
 checks.append(CheckTimestamps())
 checks.append(CheckContributors())
+checks.append(CheckBranchNameRegexp(
+config_files=[CommittedFile('.igcommit-branch-name.conf')]
+))
 
 # Commit checks
 checks.append(CheckCommitMessage())