test: make onReleaseChangelog hook error test robust - #484
Merged
Conversation
Stub console.error so the expected hook failure is not printed as stderr (which Vitest reports as ✘ [error]), inject GitHub releases so the hook always runs, and assert the error is logged. Co-authored-by: Jared Wray <me@jaredwray.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #484 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 18 18
Lines 2760 2760
Branches 846 846
=========================================
Hits 2760 2760 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Test robustness / flake fix.
Why
should handle onReleaseChangelog hook errors gracefullywas leaking the expected hook failure to stderr:DoculaConsole.error()always writes toconsole.error(even in quiet mode), so Vitest reports it as a failed-looking✘ [error]line. The test also depended on the GitHub HTTP mock actually supplying releases, so the hook was not guaranteed to run.What
Harden that test in
test/builder-changelog.test.ts:getGithubDataso the hook always runsbuilder.console.errorso the expected log does not leak to stderr