Updating to support adding messages to clarify what failed

Author: dtaivpp

commit_msg_regex_hook/commit_msg_regex_hook.py

@@ -44,14 +44,32 @@ def main():
   Parse passed in regex and verify message matches
   """
   parser = argparse.ArgumentParser()
-  parser.add_argument("message", nargs="?", type=process_file, default=COMMIT_EDITMSG,
-                      help="File path for commit message")
-  parser.add_argument("--pattern", type=process_pattern)
   parser.add_argument(
-    '--debug',
-    action='store_true',
-    help='print debug messages to stdout'
-  )
+    "message", 
+    nargs="?", 
+    type=process_file, 
+    default=COMMIT_EDITMSG,
+    help="File path for commit message")
+
+
+  parser.add_argument(
+    "--failure_message", 
+    type=str, 
+    default="Commit Message does not match pattern", 
+    help="The message to display if the commit message doesn't match the Regex")
+
+
+  parser.add_argument(
+    "--pattern",
+    type=process_pattern,
+    help="Pattern to check the commit message against")
+
+
+  parser.add_argument(
+    "--debug",
+    action="store_true",
+    help="Flag to get debugging messages")
+
 
   args = parser.parse_args()
 
@@ -60,7 +78,7 @@ def main():
 
   checks = [
     message_not_empty(args.message),
-    message_pattern_match(args.message, args.pattern)
+    message_pattern_match(args.message, args.pattern, args.failure_message)
   ]
 
   run_checks(checks)
@@ -130,15 +148,17 @@ def check():
   return check
 
 
-def message_pattern_match(message: str, pattern: Pattern) -> Result:
+def message_pattern_match(message: str, pattern: Pattern, failure_message: str) -> Result:
   """Verify the commit message matches the pattern
   """
   def check():
     logger.debug("Pattern: {regex}\nMessage: {message}", regex=pattern, message=message)
 
     if not pattern.match(message):
       # Fail the commit message
-      return Result(f"Commit Message does not match pattern\n\t{pattern}\n\t{message}", FAIL)
+      return Result(f"""{failure_message}\n\t
+                        Pattern: {pattern}\n\t
+                        Message: {message}""", FAIL)
 
     return Result("The commit message matches the regex", PASS)
   return check

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = commit-msg-regex-hook
-version = v0.0.8
+version = v0.2.0
 author = David Tippett
 description = Checks if commit message matches supplied regex
 long_description = file: README.md

test/test.py

@@ -20,11 +20,11 @@ class TestMessagePatternMatch(unittest.TestCase):
   def test_pattern_not_match(self):
     pattern = re.compile(r'[A-Z]{3,4}-[0-9]{3,6} \| [\w\s]* \| .+')
     test_str = "asefagrragadsrgasr"
-    result = commit_msg_regex_hook.message_pattern_match(test_str, pattern)()
+    result = commit_msg_regex_hook.message_pattern_match(test_str, pattern, "Testing")()
     self.assertEqual(result.is_passing(), False)
 
   def test_pattern_match(self):
     pattern = re.compile(r'[A-Z]{3,4}-[0-9]{3,6} \| [\w\s]* \| .+')
     test_str = "ABC-123 | David | Commit message!"
-    result = commit_msg_regex_hook.message_pattern_match(test_str, pattern)()
+    result = commit_msg_regex_hook.message_pattern_match(test_str, pattern, "Testing")()
     self.assertEqual(result.is_passing(), True)