feat: support GPG signature check #261
Conversation
WalkthroughA new GPG signature verification feature was introduced to the commit check system. This includes adding the check to the default configuration, implementing the signature validation logic, updating the CLI to support a new flag, and expanding the test suite to cover the new check and its integration with the main entry point. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant CLI
participant CommitCheck
participant Git
User->>CLI: Runs commit-check with --gpg-signature
CLI->>CommitCheck: Parse args, detect --gpg-signature
CommitCheck->>CommitCheck: check_commit_gpg_signature()
CommitCheck->>Git: git log --pretty=format:%G? -1
Git-->>CommitCheck: Return GPG status code
CommitCheck->>CLI: Report PASS/FAIL based on status
CLI->>User: Output result and suggestions
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~18 minutes Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (2)
commit_check/commit.py (1)
95-155: LGTM! Solid GPG signature verification implementation.The function correctly handles various GPG signature states with appropriate error messages. The security posture of only accepting 'G' and 'U' status codes is reasonable.
However, consider improving exception handling to avoid potential secondary failures:
except Exception: # If we can't check GPG status, treat as failure if not print_error_header.has_been_called: print_error_header() # pragma: no cover + try: + commit_hash = get_commit_info("H") + except Exception: + commit_hash = "unknown" print_error_message( check['check'], 'Unknown', - 'Unable to check GPG signature status', get_commit_info("H"), + 'Unable to check GPG signature status', commit_hash, )tests/commit_test.py (1)
560-565: Add missing has_commits mock for completeness.Even though this test has empty checks, it should mock
has_commits()for consistency.checks = [] + mocker.patch("commit_check.commit.has_commits", return_value=True)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
commit_check/__init__.py(1 hunks)commit_check/commit.py(1 hunks)commit_check/main.py(2 hunks)tests/commit_test.py(2 hunks)tests/main_test.py(6 hunks)
🧰 Additional context used
🪛 GitHub Actions: main
tests/commit_test.py
[error] 418-418: AssertionError: test_check_commit_gpg_signature_valid failed. Expected PASS but got failure indicating GPG signature check did not pass.
[error] 435-435: AssertionError: test_check_commit_gpg_signature_valid_unknown failed. Expected PASS but got failure indicating GPG signature check did not pass for unknown validity.
[error] 537-537: Exception: test_check_commit_gpg_signature_exception failed due to 'Git command failed' exception raised during GPG signature check.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Run benchmarks
🔇 Additional comments (6)
commit_check/main.py (2)
79-85: LGTM! Clean CLI argument addition.The new
--gpg-signatureargument follows the established pattern and is properly configured.
139-140: LGTM! Proper integration in main execution flow.The GPG signature check is correctly integrated following the same pattern as other checks.
commit_check/__init__.py (1)
51-56: LGTM! Well-structured configuration addition.The GPG signature check configuration follows the established pattern with appropriate error message and helpful suggestion. The empty regex is correct since this check doesn't use pattern matching.
tests/main_test.py (2)
11-29: LGTM! Comprehensive test parameter updates.The parametrized test cases properly include the new GPG signature check with appropriate call count expectations for various CLI flag combinations.
39-39: LGTM! Proper test mocking integration.The test methods correctly mock
check_commit_gpg_signatureand verify call counts, maintaining consistency with existing test patterns.Also applies to: 55-55, 64-64, 82-82, 91-91
tests/commit_test.py (1)
3-3: LGTM! Proper import addition.The import correctly includes the new
check_commit_gpg_signaturefunction.
| def test_check_commit_gpg_signature_valid(mocker): | ||
| """Test GPG signature check passes for good signature.""" | ||
| checks = [{ | ||
| "check": "gpg_signature", | ||
| "regex": "", | ||
| "error": "Commit does not have a valid GPG signature", | ||
| "suggest": "Use git commit -S to sign commits" | ||
| }] | ||
|
|
||
| mocker.patch("commit_check.util.cmd_output", return_value="G") | ||
| mocker.patch("commit_check.util.get_commit_info", return_value="abc123") | ||
|
|
||
| retval = check_commit_gpg_signature(checks) | ||
| assert retval == PASS |
There was a problem hiding this comment.
Fix missing mock for has_commits function.
The test is likely failing because has_commits() is not mocked, causing the function to potentially return early with PASS before executing the GPG check logic.
Add the missing mock:
mocker.patch("commit_check.util.cmd_output", return_value="G")
mocker.patch("commit_check.util.get_commit_info", return_value="abc123")
+ mocker.patch("commit_check.commit.has_commits", return_value=True)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| def test_check_commit_gpg_signature_valid(mocker): | |
| """Test GPG signature check passes for good signature.""" | |
| checks = [{ | |
| "check": "gpg_signature", | |
| "regex": "", | |
| "error": "Commit does not have a valid GPG signature", | |
| "suggest": "Use git commit -S to sign commits" | |
| }] | |
| mocker.patch("commit_check.util.cmd_output", return_value="G") | |
| mocker.patch("commit_check.util.get_commit_info", return_value="abc123") | |
| retval = check_commit_gpg_signature(checks) | |
| assert retval == PASS | |
| def test_check_commit_gpg_signature_valid(mocker): | |
| """Test GPG signature check passes for good signature.""" | |
| checks = [{ | |
| "check": "gpg_signature", | |
| "regex": "", | |
| "error": "Commit does not have a valid GPG signature", | |
| "suggest": "Use git commit -S to sign commits" | |
| }] | |
| mocker.patch("commit_check.util.cmd_output", return_value="G") | |
| mocker.patch("commit_check.util.get_commit_info", return_value="abc123") | |
| mocker.patch("commit_check.commit.has_commits", return_value=True) | |
| retval = check_commit_gpg_signature(checks) | |
| assert retval == PASS |
🧰 Tools
🪛 GitHub Actions: main
[error] 418-418: AssertionError: test_check_commit_gpg_signature_valid failed. Expected PASS but got failure indicating GPG signature check did not pass.
🤖 Prompt for AI Agents
In tests/commit_test.py around lines 405 to 418, the
test_check_commit_gpg_signature_valid function is missing a mock for the
has_commits function, which may cause the test to return early and not properly
test the GPG signature logic. Add a mock for has_commits to return True before
calling check_commit_gpg_signature to ensure the GPG signature check code is
executed during the test.
| def test_check_commit_gpg_signature_valid_unknown(mocker): | ||
| """Test GPG signature check passes for good signature with unknown validity.""" | ||
| checks = [{ | ||
| "check": "gpg_signature", | ||
| "regex": "", | ||
| "error": "Commit does not have a valid GPG signature", | ||
| "suggest": "Use git commit -S to sign commits" | ||
| }] | ||
|
|
||
| mocker.patch("commit_check.util.cmd_output", return_value="U") | ||
| mocker.patch("commit_check.util.get_commit_info", return_value="abc123") | ||
|
|
||
| retval = check_commit_gpg_signature(checks) | ||
| assert retval == PASS |
There was a problem hiding this comment.
Fix missing mock for has_commits function.
Same issue as the previous test - missing has_commits() mock.
Add the missing mock:
mocker.patch("commit_check.util.cmd_output", return_value="U")
mocker.patch("commit_check.util.get_commit_info", return_value="abc123")
+ mocker.patch("commit_check.commit.has_commits", return_value=True)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| def test_check_commit_gpg_signature_valid_unknown(mocker): | |
| """Test GPG signature check passes for good signature with unknown validity.""" | |
| checks = [{ | |
| "check": "gpg_signature", | |
| "regex": "", | |
| "error": "Commit does not have a valid GPG signature", | |
| "suggest": "Use git commit -S to sign commits" | |
| }] | |
| mocker.patch("commit_check.util.cmd_output", return_value="U") | |
| mocker.patch("commit_check.util.get_commit_info", return_value="abc123") | |
| retval = check_commit_gpg_signature(checks) | |
| assert retval == PASS | |
| def test_check_commit_gpg_signature_valid_unknown(mocker): | |
| """Test GPG signature check passes for good signature with unknown validity.""" | |
| checks = [{ | |
| "check": "gpg_signature", | |
| "regex": "", | |
| "error": "Commit does not have a valid GPG signature", | |
| "suggest": "Use git commit -S to sign commits" | |
| }] | |
| mocker.patch("commit_check.util.cmd_output", return_value="U") | |
| mocker.patch("commit_check.util.get_commit_info", return_value="abc123") | |
| mocker.patch("commit_check.commit.has_commits", return_value=True) | |
| retval = check_commit_gpg_signature(checks) | |
| assert retval == PASS |
🧰 Tools
🪛 GitHub Actions: main
[error] 435-435: AssertionError: test_check_commit_gpg_signature_valid_unknown failed. Expected PASS but got failure indicating GPG signature check did not pass for unknown validity.
🤖 Prompt for AI Agents
In tests/commit_test.py around lines 422 to 435, the test is missing a mock for
the has_commits() function, which is necessary for the test to run correctly.
Add a mock for has_commits() using mocker.patch to return True or an appropriate
value before calling check_commit_gpg_signature. This will ensure the test
environment simulates the presence of commits properly.
| def test_check_commit_gpg_signature_no_signature(mocker): | ||
| """Test GPG signature check fails for unsigned commit.""" | ||
| checks = [{ | ||
| "check": "gpg_signature", | ||
| "regex": "", | ||
| "error": "Commit does not have a valid GPG signature", | ||
| "suggest": "Use git commit -S to sign commits" | ||
| }] | ||
|
|
||
| mocker.patch("commit_check.util.cmd_output", return_value="N") | ||
| mocker.patch("commit_check.util.get_commit_info", return_value="abc123") | ||
| m_print_error_message = mocker.patch(f"{LOCATION}.print_error_message") | ||
| m_print_suggestion = mocker.patch(f"{LOCATION}.print_suggestion") | ||
|
|
||
| retval = check_commit_gpg_signature(checks) | ||
| assert retval == FAIL | ||
| assert m_print_error_message.call_count == 1 | ||
| assert m_print_suggestion.call_count == 1 | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add missing has_commits mock for consistency.
These tests should also mock has_commits() to ensure consistent test behavior and prevent potential early returns.
Add the missing mock to all GPG signature tests:
+ mocker.patch("commit_check.commit.has_commits", return_value=True)Also applies to: 460-478, 481-499, 502-520
🤖 Prompt for AI Agents
In tests/commit_test.py around lines 439 to 457, the
test_check_commit_gpg_signature_no_signature function is missing a mock for
has_commits(), which can cause inconsistent test behavior or early returns. Add
a mock for has_commits() returning True in this test and similarly add the same
mock to the other GPG signature tests at lines 460-478, 481-499, and 502-520 to
ensure consistent test execution.
| def test_check_commit_gpg_signature_exception(mocker): | ||
| """Test GPG signature check fails when git command throws exception.""" | ||
| checks = [{ | ||
| "check": "gpg_signature", | ||
| "regex": "", | ||
| "error": "Commit does not have a valid GPG signature", | ||
| "suggest": "Use git commit -S to sign commits" | ||
| }] | ||
|
|
||
| mocker.patch("commit_check.util.cmd_output", side_effect=Exception("Git command failed")) | ||
| mocker.patch("commit_check.util.get_commit_info", return_value="abc123") | ||
| m_print_error_message = mocker.patch(f"{LOCATION}.print_error_message") | ||
| m_print_suggestion = mocker.patch(f"{LOCATION}.print_suggestion") | ||
|
|
||
| retval = check_commit_gpg_signature(checks) | ||
| assert retval == FAIL | ||
| assert m_print_error_message.call_count == 1 | ||
| assert m_print_suggestion.call_count == 1 | ||
|
|
There was a problem hiding this comment.
Fix exception test setup and add missing mock.
The exception test needs proper mocking and should handle the case where both cmd_output and get_commit_info might fail.
mocker.patch("commit_check.util.cmd_output", side_effect=Exception("Git command failed"))
- mocker.patch("commit_check.util.get_commit_info", return_value="abc123")
+ mocker.patch("commit_check.util.get_commit_info", return_value="abc123")
+ mocker.patch("commit_check.commit.has_commits", return_value=True)The test should pass with these mocks since the exception handler in the implementation calls get_commit_info("H") which is mocked to return "abc123".
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| def test_check_commit_gpg_signature_exception(mocker): | |
| """Test GPG signature check fails when git command throws exception.""" | |
| checks = [{ | |
| "check": "gpg_signature", | |
| "regex": "", | |
| "error": "Commit does not have a valid GPG signature", | |
| "suggest": "Use git commit -S to sign commits" | |
| }] | |
| mocker.patch("commit_check.util.cmd_output", side_effect=Exception("Git command failed")) | |
| mocker.patch("commit_check.util.get_commit_info", return_value="abc123") | |
| m_print_error_message = mocker.patch(f"{LOCATION}.print_error_message") | |
| m_print_suggestion = mocker.patch(f"{LOCATION}.print_suggestion") | |
| retval = check_commit_gpg_signature(checks) | |
| assert retval == FAIL | |
| assert m_print_error_message.call_count == 1 | |
| assert m_print_suggestion.call_count == 1 | |
| def test_check_commit_gpg_signature_exception(mocker): | |
| """Test GPG signature check fails when git command throws exception.""" | |
| checks = [{ | |
| "check": "gpg_signature", | |
| "regex": "", | |
| "error": "Commit does not have a valid GPG signature", | |
| "suggest": "Use git commit -S to sign commits" | |
| }] | |
| mocker.patch("commit_check.util.cmd_output", side_effect=Exception("Git command failed")) | |
| mocker.patch("commit_check.util.get_commit_info", return_value="abc123") | |
| mocker.patch("commit_check.commit.has_commits", return_value=True) | |
| m_print_error_message = mocker.patch(f"{LOCATION}.print_error_message") | |
| m_print_suggestion = mocker.patch(f"{LOCATION}.print_suggestion") | |
| retval = check_commit_gpg_signature(checks) | |
| assert retval == FAIL | |
| assert m_print_error_message.call_count == 1 | |
| assert m_print_suggestion.call_count == 1 |
🧰 Tools
🪛 GitHub Actions: main
[error] 537-537: Exception: test_check_commit_gpg_signature_exception failed due to 'Git command failed' exception raised during GPG signature check.
🤖 Prompt for AI Agents
In tests/commit_test.py around lines 523 to 541, the test for GPG signature
exception handling lacks proper mocking for both cmd_output and get_commit_info
functions. Fix this by ensuring that cmd_output is mocked to raise an Exception
and get_commit_info is also mocked to return a valid commit hash like "abc123".
This setup will correctly simulate the exception scenario and allow the test to
pass as the exception handler calls get_commit_info("H").
closes #217
Summary by CodeRabbit
New Features
Tests