[test] Add tests for logger.writeJSONToFile and initAndSetGlobalNoFileLogger#9276
Merged
Merged
Conversation
Adds comprehensive table-driven tests for writeJSONToFile (0→100% coverage) and an additional test for the uncovered error path in initAndSetGlobalNoFileLogger (81.8%→90.9% coverage). Tests cover: - Happy path: simple map, nil value, struct, slice, empty struct - Overwrite existing file atomically - json.MarshalIndent failure for unmarshalable type (channel) - atomicWriteFile failure when destination directory does not exist - factory.setup() error path in initAndSetGlobalNoFileLogger Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds dedicated logger tests for JSON persistence and no-file logger initialization error handling.
Changes:
- Covers JSON write success, overwrite, marshal failure, and write failure paths.
- Covers factory setup errors during global logger initialization.
Show a summary per file
| File | Description |
|---|---|
internal/logger/write_json_to_file_test.go |
Adds unit tests for logger persistence and initialization helpers. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 2
- Review effort level: Medium
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Collaborator
Contributor
Fixed in I pulled both failing lint job logs and applied the minimal fix: |
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.
Test Coverage Improvement:
logger.writeJSONToFileFunction Analyzed
internal/loggerwriteJSONToFile(primary),initAndSetGlobalNoFileLogger(secondary)writeJSONToFile75.0%,initAndSetGlobalNoFileLogger81.8%writeJSONToFile100%,initAndSetGlobalNoFileLogger90.9%Why These Functions?
writeJSONToFilehad zero dedicated tests despite being a shared helper used by multiple logger types (ToolsLogger,ObservedURLDomainsLogger) for persisting state to disk. Its uncovered branch — thejson.MarshalIndentfailure path — is only reachable with unmarshalable types like channels.initAndSetGlobalNoFileLoggerwas missing coverage for thefactory.setup()error path, which required constructing a custom factory that returns an error from setup.Tests Added
json.MarshalIndentfails for a channel (unmarshalable type)atomicWriteFilefails when destination directory does not existinitAndSetGlobalNoFileLogger: error returned whenfactory.setup()failsCoverage Report
Test Execution
All tests pass:
Generated by Test Coverage Improver
Warning
Firewall blocked 7 domains
The following domains were blocked by the firewall during workflow execution:
awmgmcpggo.opentelemetry.iogo.yaml.ingolang.orggoogle.golang.orggopkg.inproxy.golang.orgSee Network Configuration for more information.