feat: alternative way to bootstrap the tests #263
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
fredrikaverpil
approved these changes
Oct 4, 2024
fredrikaverpil
previously requested changes
Oct 4, 2024
radhus
approved these changes
Oct 9, 2024
ericwenn
reviewed
Oct 9, 2024
proto/gen/googleapis/aiplatform/apiv1/aiplatformpb/dataset_service_aiptest.pb.go
Outdated
Show resolved
Hide resolved
ericwenn
reviewed
Oct 9, 2024
ericwenn
approved these changes
Oct 9, 2024
This commit replaces the `ctx` field on the config struct, with a function for getting a context. Same context is used as before, this is preparation for upcomming commits.
This commit replaces the `service` field on the config struct, with a function for getting the service to be tested. This is a preparation for upcomming commit.
We have noticed historically, that when people adds new resources, it's easy to forget to implement the newly generated AIP tests, either directly or later. This commit tries to solve that issue by introducing a main entrypoint to execute the tests, which takes a interface that the user needs to implement. When a new resource is added, the interface will be extended with another method that the user needs to implement, if not, a compilation error would be raised. The user can choose to return `nil` to indicate that it can't be implemented right directly. All tests will still be executed, but if not implemented it will be skipped, this to show it's available but not implemented. This commit is backwards compatible with the current test setup. For example usage, see `examples/`.
|
@thall late to the party, but I was just wondering if you wanted to also add a note to the main README about this new type of setup? |
|
@fredrikaverpil yes, I will update the README as well, thanks for the reminder! |
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.
TL;DR
With this setup you need to explicit opt-out tests instead of explicit opt-int.
Why
We have noticed historically, that when people adds new
resources, it's easy to forget to implement the newly
generated AIP tests, either directly or later.
How
This commit tries to solve that issue by introducing a
main entrypoint to execute the tests, which takes a interface
that the user needs to implement.
When a new resource is added, the interface will be extended with
another method that the user needs to implement, if not, a compilation
error would be raised.
The user can choose to return
nilto indicate that it can't beimplemented right directly.
All tests will still be executed, but if not implemented it will be
skipped, this to show it's available but not implemented.
This commit is backwards compatible with the current test setup.
For example usage, see
examples/.