feat: generate one test case for all services within package #267
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
In a upcoming commit, a file called `aiptest.pb.go` will be generated.
Before both filtering of which services to generate AIP tests for and the actual rendering of the code happened in one loop. This commit separate its into two parts: - Collect relevant services that tests can be generated for - Generate code for the collected services
radhus
reviewed
Oct 11, 2024
Preparation for upcoming commit where one interface will be created which embeds all service resource config providers. Without this, there is a risk of method name collision, where two different service resource config providers have the same methods.
thall
force-pushed
the
tra-1929-2
branch
2 times, most recently
from
2a0abd7 to
5ef888d
Compare
alethenorio
reviewed
Oct 11, 2024
radhus
approved these changes
Oct 11, 2024
ericwenn
reviewed
Oct 11, 2024
ericwenn
reviewed
Oct 11, 2024
ericwenn
approved these changes
Oct 11, 2024
There was a problem hiding this comment.
Overall LGTM!
Taking the time to consider shorter names on the generated interfaces that will be "main entrypoint" for testing is a good idea. This plugin currently generates a lot of interfaces and many of them have suffix ConfigProvider so it can be hard to find the correct one.
This is a continuation of [commit](f9ff1a1). Before each service within the package had its own test function, meaning that if you add a new service within that package, you would need to call a newly generated function, which could easily be forgotten. This commit introduces one test function for the whole package which takes a interface which embeds the other services test interfaces. With this in place, if you add a new service you will get a compilation error that you no longer fulfil the interface.
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.
This is a continuation of this PR.
Why
Before each service within the package had its own test function,
meaning that if you add a new service within that package, you would
need to call a newly generated function, which could easily be forgotten.
How
This commit introduces one test function for the whole package
which takes a interface which embeds the other services test interfaces.
With this in place, if you add a new service you will get a compilation
error that you no longer fulfill the interface.