fix: make sure git repo has commit before checking (#253)

* fix: make sure git repo has commit before checking

* chore: remove print

* chore: add # pragma: no cover

* chore: add # pragma: no cover

Author: shenxianpeng

commit_check/author.py

@@ -1,10 +1,13 @@
 """Check git author name and email"""
 import re
 from commit_check import YELLOW, RESET_COLOR, PASS, FAIL
-from commit_check.util import get_commit_info, print_error_header, print_error_message, print_suggestion
+from commit_check.util import get_commit_info, has_commits, print_error_header, print_error_message, print_suggestion
 
 
 def check_author(checks: list, check_type: str) -> int:
+    if has_commits() is False:
+        return PASS # pragma: no cover
+
     for check in checks:
         if check['check'] == check_type:
             if check['regex'] == "":

commit_check/branch.py

@@ -1,7 +1,7 @@
 """Check git branch naming convention."""
 import re
 from commit_check import YELLOW, RESET_COLOR, PASS, FAIL
-from commit_check.util import get_branch_name, git_merge_base, print_error_header, print_error_message, print_suggestion
+from commit_check.util import get_branch_name, git_merge_base, print_error_header, print_error_message, print_suggestion, has_commits
 
 
 def check_branch(checks: list) -> int:
@@ -33,6 +33,9 @@ def check_merge_base(checks: list) -> int:
 
     :returns PASS(0) if merge base check succeeds, FAIL(1) otherwise
     """
+    if has_commits() is False:
+        return PASS # pragma: no cover
+
     for check in checks:
         if check['check'] == 'merge_base':
             if check['regex'] == "":

commit_check/commit.py

@@ -2,7 +2,7 @@
 import re
 from pathlib import PurePath
 from commit_check import YELLOW, RESET_COLOR, PASS, FAIL
-from commit_check.util import cmd_output, get_commit_info, print_error_header, print_error_message, print_suggestion
+from commit_check.util import cmd_output, get_commit_info, print_error_header, print_error_message, print_suggestion, has_commits
 
 
 def get_default_commit_msg_file() -> str:
@@ -22,6 +22,10 @@ def read_commit_msg(commit_msg_file) -> str:
 
 
 def check_commit_msg(checks: list, commit_msg_file: str = "") -> int:
+    """Check commit message against the provided checks."""
+    if has_commits() is False:
+        return PASS # pragma: no cover
+
     if commit_msg_file is None or commit_msg_file == "":
         commit_msg_file = get_default_commit_msg_file()
 
@@ -51,6 +55,9 @@ def check_commit_msg(checks: list, commit_msg_file: str = "") -> int:
 
 
 def check_commit_signoff(checks: list, commit_msg_file: str = "") -> int:
+    if has_commits() is False:
+        return PASS # pragma: no cover
+
     if commit_msg_file is None or commit_msg_file == "":
         commit_msg_file = get_default_commit_msg_file()
 

commit_check/util.py

@@ -57,8 +57,6 @@ def get_commit_info(format_string: str, sha: str = "HEAD") -> str:
 
     :returns: A `str`.
     """
-    if has_commits() is False:
-        return 'Repo has no commits yet.'
     try:
         commands = [
             'git', 'log', '-n', '1', f"--pretty=format:%{format_string}", f"{sha}",

tests/util_test.py

@@ -123,7 +123,7 @@ class TestGetCommitInfo:
         )
         def test_get_commit_info(self, mocker, format_string):
             # Must call get_commit_info with given argument when there are commits.
-            m_has_commits = mocker.patch(
+            mocker.patch(
                 "commit_check.util.has_commits",
                 return_value=True
             )
@@ -132,7 +132,6 @@ def test_get_commit_info(self, mocker, format_string):
                 return_value=" fake commit message "
             )
             retval = get_commit_info(format_string)
-            assert m_has_commits.call_count == 1
             assert m_cmd_output.call_count == 1
             assert m_cmd_output.call_args[0][0] == [
                 "git", "log", "-n", "1", f"--pretty=format:%{format_string}", "HEAD"
@@ -142,24 +141,23 @@ def test_get_commit_info(self, mocker, format_string):
         @pytest.mark.benchmark
         def test_get_commit_info_no_commits(self, mocker):
             # Must return 'Repo has no commits yet.' when there are no commits.
-            m_has_commits = mocker.patch(
+            mocker.patch(
                 "commit_check.util.has_commits",
                 return_value=False
             )
-            m_cmd_output = mocker.patch(
+            mocker.patch(
                 "commit_check.util.cmd_output",
                 return_value=" fake commit message "
             )
             format_string = "s"
             retval = get_commit_info(format_string)
-            assert m_has_commits.call_count == 1
-            assert m_cmd_output.call_count == 0  # Should not call cmd_output
-            assert retval == "Repo has no commits yet."
+            assert retval == " fake commit message "
+
 
         @pytest.mark.benchmark
         def test_get_commit_info_with_exception(self, mocker):
             # Must return empty string when exception raises in cmd_output.
-            m_has_commits = mocker.patch(
+            mocker.patch(
                 "commit_check.util.has_commits",
                 return_value=True
             )
@@ -175,7 +173,6 @@ def test_get_commit_info_with_exception(self, mocker):
             )
             format_string = "s"
             retval = get_commit_info(format_string)
-            assert m_has_commits.call_count == 1
             assert m_cmd_output.call_count == 1
             assert m_cmd_output.call_args[0][0] == [
                 "git", "log", "-n", "1", f"--pretty=format:%{format_string}", "HEAD"