fix: update import to fix test by shenxianpeng · Pull Request #291 · commit-check/commit-check · GitHub

Summary by CodeRabbit

Tests
- Improved commit message and branch-name validation tests to better simulate edge cases and align patching with production imports, increasing test reliability. No user-facing changes.
Documentation
- Added "new" status metadata to several docs (changelog, migration, what's new, configuration) and enabled copyable configuration example blocks for easier reuse.

Walkthrough

Adds a mock-based test for a commit-message file-not-found path and updates a branch-validator test to patch commit_check.engine.get_branch_name; also adds :status: new metadata lines to several docs files.

Changes

Cohort / File(s)	Summary
Engine test updates tests/engine_test.py	Added test_commit_message_validator_file_not_found(self, mock_get_commit_info) which patches commit_check.engine.get_commit_info and uses a side_effect to simulate missing-file/invalid commit output; updated test_branch_validator_valid_branch to use @patch("commit_check.engine.get_branch_name").
Documentation status metadata docs/changelog.rst, docs/configuration.rst, docs/migration.rst, docs/what-is-new.rst	Inserted top-level metadata :status: new in each file; in docs/configuration.rst also added :class: copy directives to TOML example blocks.

Sequence Diagram(s)

sequenceDiagram
  participant Test as pytest
  participant Engine as commit_check.engine
  participant Git as git (mocked)

  rect rgba(200,230,255,0.25)
  note over Test,Engine: Commit message validator (file-not-found path)
  Test->>Engine: call validator (get_commit_info patched)
  Engine->>Git: patched get_commit_info side_effect -> simulate missing file / invalid message
  Git-->>Engine: error / invalid output
  Engine-->>Test: validator returns failure/assertion observed
  end

  rect rgba(220,255,220,0.18)
  note over Test,Engine: Branch validation (patched import path)
  Test->>Engine: call branch validator (get_branch_name patched at engine)
  Engine-->>Test: mocked branch name returned -> validation path executed
  end

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I twitch my nose at mocked pleas,
Git ghosts hidden in the trees;
I patch a branch, I nudge a test,
Carrot commits laid to rest.
Hooray — a tidy hop and jest 🥕🐇

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title clearly summarizes the primary code change—updating an import to fix a failing test—in a concise, single sentence and avoids extraneous details, making it easy for a teammate scanning history to understand the main update.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches 🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch bugfix/patch-1

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ebb13d6 and 48704ff.

📒 Files selected for processing (4)

docs/changelog.rst (1 hunks)
docs/configuration.rst (2 hunks)
docs/migration.rst (1 hunks)
docs/what-is-new.rst (1 hunks)

✅ Files skipped from review due to trivial changes (4)

docs/migration.rst
docs/what-is-new.rst
docs/configuration.rst
docs/changelog.rst

⏰ 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). (16)

GitHub Check: install (3.12, macos-latest)
GitHub Check: install (3.13, ubuntu-24.04)
GitHub Check: install (3.13, windows-latest)
GitHub Check: install (3.12, ubuntu-24.04)
GitHub Check: install (3.9, macos-latest)
GitHub Check: install (3.11, windows-latest)
GitHub Check: install (3.10, windows-latest)
GitHub Check: install (3.13, macos-latest)
GitHub Check: install (3.10, macos-latest)
GitHub Check: install (3.11, ubuntu-24.04)
GitHub Check: install (3.12, windows-latest)
GitHub Check: install (3.10, ubuntu-24.04)
GitHub Check: install (3.11, macos-latest)
GitHub Check: install (3.9, windows-latest)
GitHub Check: install (3.9, ubuntu-24.04)
GitHub Check: Run benchmarks

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.94%. Comparing base (e3d141c) to head (48704ff).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main     #291       +/-   ##
===========================================
- Coverage   97.80%   79.94%   -17.87%     
===========================================
  Files           8        8               
  Lines         365      673      +308     
===========================================
+ Hits          357      538      +181     
- Misses          8      135      +127

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

CodSpeed Performance Report

Merging #291 will not alter performance

Comparing bugfix/patch-1 (48704ff) with main (27d9850)

Summary

✅ 27 untouched
⏩ 85 skipped1

85 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

Actionable comments posted: 0

🧹 Nitpick comments (1)

tests/engine_test.py (1)
97-111: Consider using .get() for safer dict lookup and adding call count assertion.

The test correctly mocks the file-not-found scenario, but could be improved for consistency:

Line 101-104 uses [format_str] for dict lookup, which raises KeyError if an unexpected format string is passed. The similar test at line 120 uses .get(format_str, "") which is safer.

The similar test at line 128-129 verifies mock_get_commit_info.call_count == 2. Consider adding the same assertion here for consistency.

Apply this diff for improved robustness:
     # Mock git fallback to return a message that doesn't match regex
     mock_get_commit_info.side_effect = lambda format_str: {
         "s": "invalid commit message",
         "b": "",
-    }[format_str]
+    }.get(format_str, "")
 
     rule = ValidationRule(check="message", regex=r"^feat:")
     validator = CommitMessageValidator(rule)
     context = ValidationContext(commit_file="/nonexistent/file")
 
     result = validator.validate(context)
     assert result == ValidationResult.FAIL
+    assert mock_get_commit_info.call_count == 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 27d9850 and ebb13d6.

📒 Files selected for processing (1)

tests/engine_test.py (2 hunks)

🧰 Additional context used 📓 Path-based instructions (1) tests/**

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Ensure tests run via pytest -v and cover commit, branch, author, and CLI behaviors

Files:

tests/engine_test.py

⏰ 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). (11)

GitHub Check: install (3.13, ubuntu-24.04)
GitHub Check: install (3.13, windows-latest)
GitHub Check: install (3.10, macos-latest)
GitHub Check: install (3.11, windows-latest)
GitHub Check: install (3.12, ubuntu-24.04)
GitHub Check: install (3.10, ubuntu-24.04)
GitHub Check: install (3.12, windows-latest)
GitHub Check: install (3.9, windows-latest)
GitHub Check: install (3.9, macos-latest)
GitHub Check: install (3.10, windows-latest)
GitHub Check: Run benchmarks

🔇 Additional comments (1)

tests/engine_test.py (1)

133-133: LGTM! Patch target correctly aligned with engine module.

The decorator now patches commit_check.engine.get_branch_name, which aligns with where the function is imported in the engine module. This is consistent with other tests in the file (lines 145, 349) and fixes the test as indicated in the PR title.

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

fix: update import to fix test

ebb13d6

shenxianpeng added the bug Something isn't working label Oct 5, 2025

shenxianpeng requested a review from a team as a code owner October 5, 2025 21:26

coderabbitai Bot reviewed Oct 5, 2025

View reviewed changes

docs: add status and copy button

48704ff

github-actions Bot added the documentation Improvements or additions to documentation label Oct 5, 2025

shenxianpeng merged commit 996e742 into main Oct 5, 2025
28 of 29 checks passed

shenxianpeng deleted the bugfix/patch-1 branch October 5, 2025 21:43

This was referenced Oct 6, 2025

fix: remove allow_authors and add ignore_authors to branch section #292

Merged

chore: add more test cases #294

Merged

shenxianpeng removed the documentation Improvements or additions to documentation label Oct 10, 2025

coderabbitai Bot mentioned this pull request Dec 15, 2025

feat: Add comprehensive tests #331

Closed

fix: update import to fix test by shenxianpeng · Pull Request #291 · commit-check/commit-check · GitHub

Uh oh!

Uh oh!

fix: update import to fix test - #291

fix: update import to fix test#291
shenxianpeng merged 2 commits into
mainfrom
bugfix/patch-1

shenxianpeng commented Oct 5, 2025 •
edited by coderabbitai Bot
Loading

Uh oh!

Uh oh!

coderabbitai Bot commented Oct 5, 2025 •
edited
Loading

Uh oh!

Uh oh!

codecov Bot commented Oct 5, 2025 •
edited
Loading

Uh oh!

Uh oh!

codspeed-hq Bot commented Oct 5, 2025 •
edited
Loading

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

sonarqubecloud Bot commented Oct 5, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

fix: update import to fix test by shenxianpeng · Pull Request #291 · commit-check/commit-check · GitHub

Uh oh!

Uh oh!

fix: update import to fix test - #291

fix: update import to fix test#291shenxianpeng merged 2 commits intomaincommit-check/commit-check:mainfrom bugfix/patch-1commit-check/commit-check:bugfix/patch-1Copy head branch name to clipboard

Conversation

shenxianpeng commented Oct 5, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Oct 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Poem

Pre-merge checks and finishing touches

Uh oh!

codecov Bot commented Oct 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

codspeed-hq Bot commented Oct 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #291 will not alter performance

Summary

Footnotes

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Oct 5, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

fix: update import to fix test#291
shenxianpeng merged 2 commits into
mainfrom
bugfix/patch-1

shenxianpeng commented Oct 5, 2025 •
edited by coderabbitai Bot
Loading

coderabbitai Bot commented Oct 5, 2025 •
edited
Loading

codecov Bot commented Oct 5, 2025 •
edited
Loading

codspeed-hq Bot commented Oct 5, 2025 •
edited
Loading