refactor!: Replace log.Fatal with error returns, achieve 93% coverage - #39
Merged
Conversation
BREAKING CHANGE: InitGeneric now returns (*FakeDevice, error). ParseArgs now returns (int, *int, TranscriptMap, error). GenericListener now returns error. Refactor all log.Fatal calls to return errors, enabling full testability. Extract run() from main() and add LoadTranscriptMap for testable YAML parsing. Coverage by package: fakedevices: 100% ssh_server/handlers: 92.6% ssh_server/sshlistners: 100% utils: 100% Total: 93.0% Remaining uncovered: main() wrapper (os.Exit), run() happy path (blocks on channel), and defensive CmdMatch error branches (CmdMatch never returns errors). Closes #32
Annotate structurally untestable code paths: - main(): thin wrapper calling os.Exit via log.Fatal - run() goroutine loop: blocks forever on <-done - CmdMatch error branches: CmdMatch never returns errors
Contributor
Merging this branch will increase overall coverage
Coverage by fileChanged files (no unit tests)
Please note that the "Total", "Covered", and "Missed" counts above refer to code statements instead of lines of code. The value in brackets refers to the test coverage of that file in the old version of the code. Changed unit test files
|
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
1 participant
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.
Summary
Refactor all
log.Fatalcalls to return errors, making the codebase fully testable. Achieve 93% total test coverage.Breaking changes
InitGenericnow returns(*FakeDevice, error)ParseArgsnow returns(int, *int, TranscriptMap, error)GenericListenernow returnserrorRefactoring
readFile→ returns(string, error)TranscriptReader→ removedlog.Fatal, returns errors onlyGenericCiscoHandler→ logs + breaks on TranscriptReader error instead of fatalGenericListener→ returns error fromListenAndServe, removed dead coderun()frommain()for testabilityLoadTranscriptMap()fromParseArgsfor testabilityCoverage results (28 tests)
Remaining uncovered (7%)
main()— 3-line wrapper callinglog.Fatal/os.Exit(standard Go convention)run()happy path — goroutine loop + channel wait (blocks forever)GenericCiscoHandler— defensiveCmdMatcherror branches (CmdMatchnever returns errors)Closes #32