github.Client: Add tests #410
Open
Conversation
This file contains 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
Adds some simple end-to-end tests for the GitHub client to avoid breaking this with other planned changes. This introduces a new test dependency [dnaeon/go-vcr][1], but it's a pretty small surface area, and go-vcr itself only depends on yaml.v3. [1]: https://github.com/dnaeon/go-vcr The way the test works is pretty straightforward: - In record mode (enabled with `go test -update`) actual requests are made to GitHub and recorded into testdata files. - In replay mode (the default), the HTTP client only replays the previously recorded interactions, and rejects any new requests. So tests will not make actual requests to GitHub after first run. This test exposed a small bug in GitHub client initialization: It ignored the supplied client if a token was not provided. This change fixes that bug as well.
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.
Adds some simple end-to-end tests for the GitHub client
to avoid breaking this with other planned changes.
This introduces a new test dependency dnaeon/go-vcr,
but it's a pretty small surface area,
and go-vcr itself only depends on yaml.v3.
The way the test works is pretty straightforward:
go test -update)actual requests are made to GitHub and recorded into testdata files.
the HTTP client only replays the previously recorded interactions,
and rejects any new requests.
So tests will not make actual requests to GitHub after first run.
This test exposed a small bug in GitHub client initialization:
It ignored the supplied client if a token was not provided.
This change fixes that bug as well.