feat: Allow for mocking sdk.Client #355
Merged
+1,409
−50
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
nieomylnieja
requested review from
skrolikiewicz and
daniel-zelazny
as code owners
Closed
Closed
daniel-zelazny
approved these changes
Apr 4, 2024
…obl9-go into allow-for-mocking-client-methods
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.
Motivation
Currently it's impossible to mock
sdk.Clientdue to how versioned endpoints groups are returned, for example:sdk.Client.Objectsreturns a concrete struct:Versionswhich in turn holds methods for extracting specific API version's endpoints. There's no point mocking thesdk.Client.Objectsmethod, it doesn't give us anything as it's just an intermediary on our way to access the specific endpoint function.Summary
Changed the
endpointspackage to return interfaces rather than concrete structs so that they can be mocked.Used https://github.com/vburenin/ifacemaker for the interfaces generation as it lifts up the maintenance cost of adding/modifying API methods.