Refactor http handler to interface pattern for simpler testing in autolinks#1
Merged
hoffm merged 3 commits intohoffm:autolink-referencesfrom Dec 24, 2024
Conversation
…ting This defines an AutolinkClient interface with a Get method used for fetching the autolinks lists from the api. Then, the http client for autolinks implements this interface with the AutolinkGetter struct. This allows for dependency injection of the AutolinkGetter struct into the listOptions, enabling mocking of the AutolinkGetter for testing. The result of this is simpler tests that are easier to maintain, because the interface for the table tests now allow for defining autolink structs as the response instead of large mocked api calls. This also allows for bespoke testing of the http file, which I'll follow up with in the next commit.
This adds the missing mocked http tests to the http_test.go file. These tests were previously bundled with the tests in list_test.go, creating a testing pattern that was difficult to understand and maintain. The refactor in the previous commit replaced these tests with the AutolinkClient interface, allowing for the httpmocks to be isolated to the AutolinkGetter that implements that interface.
hoffm
pushed a commit
that referenced
this pull request
Jan 5, 2025
hoffm
pushed a commit
that referenced
this pull request
Jan 6, 2025
Fixed test for stdout in non-tty use case of repo fork
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
2 participants
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.
Changes
This builds on cli#10124, where @hoffm has begun implementing the
gh repo autolinkfeature set. In particular, this is in response to this PR comment: it refactors the design of the http handler to an interface pattern. This allows for much simpler testing by leveraging dependency injection forlistRun().This addresses a pain-point in the current testing pattern in the repo, where the
httpmockpattern is used for testing commands, creating difficult to understand and maintain testing suites.Hopefully the advantages of this approach are apparent in the simplicity of the tests and can be leveraged for the rest of the
gh repo autolinkcommands.Testing
makebin/gh repo autolink list -R <OWNER/REPO>The unit tests do a great job of giving me confidence that this is performing as expected, now, and that confidence should translate to any changes to the peripheral functionality in the command set.