MINOR: Introduce ApiKeyVersionsSource annotation for ParameterizedTest
#11468
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
dajac
changed the title
ApiKeyVersionsSource annotation for ParameterizedTest
|
@hachikuji What do you think about this? |
showuon
reviewed
Nov 11, 2021
| public class ApiKeyVersionsProvider implements ArgumentsProvider, AnnotationConsumer<ApiKeyVersionsSource> { | ||
| private ApiKeys apiKey; | ||
|
|
||
| ApiKeyVersionsProvider() { } |
There was a problem hiding this comment.
nit: Is this constructor necessary?
| import org.apache.kafka.common.protocol.ApiKeys; | ||
| import org.junit.jupiter.params.provider.ArgumentsSource; | ||
|
|
||
| @Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD}) |
There was a problem hiding this comment.
We only applied for ElementType.METHOD, so ElementType.ANNOTATION_TYPE can be removed.
dajac
force-pushed
the
api-keys-source
branch
from
5db1d6a
to
3b3f2ae
Compare
|
@showuon Thanks for your review. I have addressed your comments. |
|
I will merge the PR as the minor comments have been addressed. |
dajac
added a commit
that referenced
this pull request
Nov 11, 2021
…Test` (#11468) It is common in our code base to have unit tests which must be run for all the versions of a given request. Most of the time, we do so by iterating over all the versions in the test itself which is error prone. With JUnit5 and ParameterizedTest, we can now use a custom arguments source for this case, which is way more convenient. It looks likes this: ``` @ParameterizedTest @ApiKeyVersionsSource(apiKey = ApiKeys.ADD_PARTITIONS_TO_TXN) public void mytest(short version) { // do smth based on version... } ``` This patch introduces the new annotation and updates `AddPartitionsToTxnRequestTest` test as a first example. I will migrate all the other cases in subsequent PRs. Reviewers: Luke Chen <showuon@gmail.com>, Jason Gustafson <jason@confluent.io>
|
Merged to trunk and 3.1. |
xdgrulez
pushed a commit
to xdgrulez/kafka
that referenced
this pull request
Dec 22, 2021
…Test` (apache#11468) It is common in our code base to have unit tests which must be run for all the versions of a given request. Most of the time, we do so by iterating over all the versions in the test itself which is error prone. With JUnit5 and ParameterizedTest, we can now use a custom arguments source for this case, which is way more convenient. It looks likes this: ``` @ParameterizedTest @ApiKeyVersionsSource(apiKey = ApiKeys.ADD_PARTITIONS_TO_TXN) public void mytest(short version) { // do smth based on version... } ``` This patch introduces the new annotation and updates `AddPartitionsToTxnRequestTest` test as a first example. I will migrate all the other cases in subsequent PRs. Reviewers: Luke Chen <showuon@gmail.com>, Jason Gustafson <jason@confluent.io>
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.
It is common in our code base to have unit tests which must be run for all the versions of a given request. Most of the time, we do so by iterating over all the versions in the test itself which is error prone.
With JUnit5 and ParameterizedTest, we can now use a custom arguments source for this case, which is way more convenient. It looks likes this:
This patch introduces the new annotation and updates
AddPartitionsToTxnRequestTesttest as a first example. I will migrate all the other cases in subsequent PRs.Committer Checklist (excluded from commit message)