-
Notifications
You must be signed in to change notification settings - Fork 42
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Simplify mocking of iterator and waiter objects #769
Merged
Merged
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
work Improvements for testing work
hectorcast-db
approved these changes
Jan 16, 2024
3 tasks
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jan 16, 2024
## Changes This was meant to be included in #769, but I forgot to push the change. ## Tests <!-- How is this tested? Please see the checklist below and also describe any other relevant tests --> - [ ] `make test` passing - [ ] `make fmt` applied - [ ] relevant integration tests applied
mgyucht
added a commit
that referenced
this pull request
Jan 16, 2024
This patch release contains two small changes: * Retry on Status Code 503 ([#733](#733)), improving the stability of the SDK in light of transient API unavailability. * Simplify mocking of iterator and waiter objects ([#769](#769), [#770](#770)). See the [Testing section of the README.md](https://github.com/databricks/databricks-sdk-go#testing) for usage information and examples.
mgyucht
added a commit
that referenced
this pull request
Jan 16, 2024
This patch release contains two small changes: * Retry on Status Code 503 ([#733](#733)), improving the stability of the SDK in light of transient API unavailability. * Simplify mocking of iterator and waiter objects ([#769](#769), [#770](#770)). See the [Testing section of the README.md](https://github.com/databricks/databricks-sdk-go#testing) for usage information and examples.
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jan 16, 2024
This patch release contains two small changes: * Retry on Status Code 503 ([#733](#733)), improving the stability of the SDK in light of transient API unavailability. * Simplify mocking of iterator and waiter objects ([#769](#769), [#770](#770)). See the [Testing section of the README.md](https://github.com/databricks/databricks-sdk-go#testing) for usage information and examples.
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.
Changes
It is currently challenging to mock APIs that return iterator structs like
*listing.PaginatedIterator
or*listing.DedupedIterator
. To simplify mocking of iterator responses, we can change the return type for these methods to return thelisting.Iterator
interface. Then, users who need to write tests can uselisting.SliceIterator
to mock the response, for example:Similarly, methods returning
Wait*
objects are difficult to mock. TheGet()
method calls the internalpoll
field, but that cannot be set by users who want to mock the response. Exposing this method allows users to define mock responses, for example:Callers can then call
w.Warehouses.Create(...).Get()
.Lastly, waiters for which the initial method doesn't have a response have a type parameter of
any
which cannot be mocked easily. Instead, I changed this tostruct{}
to indicate that the response is empty.Tests