commit-check · shenxianpeng · Jan 28, 2025 · Jan 28, 2025 · Jan 28, 2025 · Jan 28, 2025
@@ -15,12 +15,13 @@ repos:
     -   id: trailing-whitespace
     -   id: name-tests-test
     -   id: requirements-txt-fixer
--   repo: https://github.com/PyCQA/flake8
-    rev: 7.1.1
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.9.3
     hooks:
-    -   id: flake8
-        args: [--max-line-length=100, --ignore=E501]
-        exclude: ^commit_check/__init__.py
+    # Run the linter.
+    -   id: ruff
+        args: [ --fix ]
 -   repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.14.1
     hooks:

@@ -16,7 +16,7 @@ def check_branch(checks: list) -> int:
             result = re.match(check['regex'], branch_name)
             if result is None:
                 if not print_error_header.has_been_called:
-                    print_error_header()
+                    print_error_header() # pragma: no cover
                 print_error_message(
                     check['check'], check['regex'],
                     check['error'], branch_name,
@@ -45,7 +45,7 @@ def check_merge_base(checks: list) -> int:
             result = git_merge_base(target_branch, current_branch)
             if result != 0:
                 if not print_error_header.has_been_called:
-                    print_error_header()
+                    print_error_header() # pragma: no cover
                 print_error_message(
                     check['check'], check['regex'],
                     check['error'], current_branch,

@@ -38,7 +38,7 @@ def check_commit_msg(checks: list, commit_msg_file: str = "") -> int:
             result = re.match(check['regex'], commit_msg)
             if result is None:
                 if not print_error_header.has_been_called:
-                    print_error_header()
+                    print_error_header() # pragma: no cover
                 print_error_message(
                     check['check'], check['regex'],
                     check['error'], commit_msg,
@@ -67,7 +67,7 @@ def check_commit_signoff(checks: list, commit_msg_file: str = "") -> int:
             result = re.search(check['regex'], commit_msg)
             if result is None:
                 if not print_error_header.has_been_called:
-                    print_error_header()
+                    print_error_header() # pragma: no cover
                 print_error_message(
                     check['check'], check['regex'],
                     check['error'], commit_hash,

@@ -55,6 +55,7 @@ def commit_check(session):
 @nox.session()
 def coverage(session):
     session.install(".")
+    session.install("-r", REQUIREMENTS["dev"])
     session.run("coverage", "run", "--source", "commit_check", "-m", "pytest")
     session.run("coverage", "report")
     session.run("coverage", "xml")

@@ -122,6 +122,17 @@ def test_check_merge_base_with_empty_checks(self, mocker):
         assert retval == PASS
         assert m_check_merge.call_count == 0
 
+
+    def test_check_merge_base_with_empty_regex(self, mocker):
+        checks = [{
+            "check": "merge_base",
+            "regex": ""
+        }]
+        m_check_merge = mocker.patch(f"{LOCATION}.check_merge_base")
+        retval = check_merge_base(checks)
+        assert retval == PASS
+        assert m_check_merge.call_count == 0
+
     def test_check_merge_base_with_different_check(self, mocker):
         checks = [{
             "check": "branch",

@@ -30,6 +30,25 @@ def test_read_commit_msg_file_not_found(mocker):
     assert m_commits_info.call_count == 0
 
 
+def test_check_commit_msg_no_commit_msg_file(mocker):
+    mock_get_default_commit_msg_file = mocker.patch(
+        "commit_check.commit.get_default_commit_msg_file",
+        return_value=".git/COMMIT_EDITMSG"
+    )
+    mock_read_commit_msg = mocker.patch(
+        "commit_check.commit.read_commit_msg",
+        return_value="Sample commit message"
+    )
+
+    checks = [{"regex": ".*", "check": "message", "error": "Invalid", "suggest": None}]
+
+    result = check_commit_msg(checks, commit_msg_file="")
+
+    mock_get_default_commit_msg_file.assert_called_once()
+    mock_read_commit_msg.assert_called_once_with(".git/COMMIT_EDITMSG")
+    assert result == 0
+
+
 def test_check_commit_with_empty_checks(mocker):
     checks = []
     m_re_match = mocker.patch(

@@ -24,6 +24,32 @@ def test_error_handler_unexpected_error():
     assert exit_info.value.code == 3
 
 
+def test_error_handler_cannot_access(mocker):
+    with pytest.raises(SystemExit):
+        store_dir = "/fake/commit-check"
+        log_path = os.path.join(store_dir, "commit-check.log")
+        mocker.patch.dict(os.environ, {"COMMIT_CHECK_HOME": store_dir})
+        mock_os_access = mocker.patch("os.access", return_value=False)
+        mocker.patch("os.path.exists", return_value=True)
+        mocker.patch("os.makedirs")
+        mock_open = mocker.patch("builtins.open", mocker.mock_open())
+        mocker.patch("commit_check.util.cmd_output", return_value="mock_version")
+        mocker.patch("sys.version", "Mock Python Version")
+        mocker.patch("sys.executable", "/mock/path/to/python")
+
+        from commit_check.error import log_and_exit
+        log_and_exit(
+            msg="Test error message",
+            ret_code=1,
+            exc=ValueError("Test exception"),
+            formatted="Mocked formatted stack trace"
+        )
+
+        mock_os_access.assert_called_once_with(store_dir, os.W_OK)
+        mock_open.assert_called_with(log_path, "a")
+        mock_open().write.assert_any_call(f"Failed to write to log at {log_path}\n")
+
+
 @pytest.mark.xfail
 def test_log_and_exit(monkeypatch):
     monkeypatch.setenv("COMMIT_CHECK_HOME", "")