You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by fr...@apache.org on 2025/04/20 04:25:35 UTC

(kafka) branch trunk updated: MINOR: Extend @ApiKeyVersionsSource annotation (#19516)

This is an automated email from the ASF dual-hosted git repository.

frankvicky pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/trunk by this push:
     new b94c7f9167d MINOR: Extend @ApiKeyVersionsSource annotation (#19516)
b94c7f9167d is described below

commit b94c7f9167d1ff8c94ce3730ab2120d55ebbd7b8
Author: David Jacot <da...@gmail.com>
AuthorDate: Sun Apr 20 06:25:27 2025 +0200

    MINOR: Extend @ApiKeyVersionsSource annotation (#19516)
    
    This patch extends the `@ApiKeyVersionsSource` annotation to allow
    specifying the `fromVersion` and the `toVersion`. This is pretty handy
    when we only want to test a subset of the versions.
    
    Reviewers: Kuan-Po Tseng <br...@gmail.com>, TengYao Chi
    <ki...@gmail.com>
---
 .../utils/annotation/ApiKeyVersionsProvider.java   |  26 ++++-
 .../annotation/ApiKeyVersionsProviderTest.java     | 118 +++++++++++++++++++++
 .../utils/annotation/ApiKeyVersionsSource.java     |   3 +
 3 files changed, 146 insertions(+), 1 deletion(-)

diff --git a/clients/src/test/java/org/apache/kafka/common/utils/annotation/ApiKeyVersionsProvider.java b/clients/src/test/java/org/apache/kafka/common/utils/annotation/ApiKeyVersionsProvider.java
index ac424cd288e..ea510414f04 100644
--- a/clients/src/test/java/org/apache/kafka/common/utils/annotation/ApiKeyVersionsProvider.java
+++ b/clients/src/test/java/org/apache/kafka/common/utils/annotation/ApiKeyVersionsProvider.java
@@ -23,16 +23,40 @@ import org.junit.jupiter.params.provider.Arguments;
 import org.junit.jupiter.params.provider.ArgumentsProvider;
 import org.junit.jupiter.params.support.AnnotationConsumer;
 
+import java.util.stream.IntStream;
 import java.util.stream.Stream;
 
 public class ApiKeyVersionsProvider implements ArgumentsProvider, AnnotationConsumer<ApiKeyVersionsSource> {
     private ApiKeys apiKey;
+    private short fromVersion;
+    private short toVersion;
 
     public void accept(ApiKeyVersionsSource source) {
         apiKey = source.apiKey();
+
+        short oldestVersion = apiKey.oldestVersion();
+        short latestVersion = apiKey.latestVersion(source.enableUnstableLastVersion());
+
+        fromVersion = source.fromVersion() == -1 ? oldestVersion : source.fromVersion();
+        toVersion = source.toVersion() == -1 ? latestVersion : source.toVersion();
+
+        if (fromVersion > toVersion) {
+            throw new IllegalArgumentException(String.format("The fromVersion %s is larger than the toVersion %s",
+                fromVersion, toVersion));
+        }
+
+        if (fromVersion < oldestVersion) {
+            throw new IllegalArgumentException(String.format("The fromVersion %s is older than the oldest version %s",
+                fromVersion, oldestVersion));
+        }
+
+        if (toVersion > latestVersion) {
+            throw new IllegalArgumentException(String.format("The toVersion %s is newer than the latest version %s",
+                fromVersion, latestVersion));
+        }
     }
 
     public Stream<? extends Arguments> provideArguments(ExtensionContext context) {
-        return apiKey.allVersions().stream().map(Arguments::of);
+        return IntStream.rangeClosed(fromVersion, toVersion).mapToObj(i -> Arguments.of((short) i));
     }
 }
diff --git a/clients/src/test/java/org/apache/kafka/common/utils/annotation/ApiKeyVersionsProviderTest.java b/clients/src/test/java/org/apache/kafka/common/utils/annotation/ApiKeyVersionsProviderTest.java
new file mode 100644
index 00000000000..eca4f7670b1
--- /dev/null
+++ b/clients/src/test/java/org/apache/kafka/common/utils/annotation/ApiKeyVersionsProviderTest.java
@@ -0,0 +1,118 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.common.utils.annotation;
+
+import org.apache.kafka.common.protocol.ApiKeys;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtensionContext;
+
+import java.util.List;
+import java.util.stream.Collectors;
+import java.util.stream.IntStream;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+public class ApiKeyVersionsProviderTest {
+    @Test
+    void testProvideArgumentsWithExplicitRange() {
+        ApiKeyVersionsProvider provider = new ApiKeyVersionsProvider();
+
+        ApiKeyVersionsSource mockSource = mock(ApiKeyVersionsSource.class);
+        when(mockSource.apiKey()).thenReturn(ApiKeys.FETCH);
+        when(mockSource.fromVersion()).thenReturn((short) 5);
+        when(mockSource.toVersion()).thenReturn((short) 7);
+        when(mockSource.enableUnstableLastVersion()).thenReturn(false);
+
+        provider.accept(mockSource);
+
+        List<Short> versions = provider.provideArguments(mock(ExtensionContext.class))
+            .map(arg -> (Short) arg.get()[0])
+            .collect(Collectors.toList());
+
+        assertEquals(List.of((short) 5, (short) 6, (short) 7), versions);
+    }
+
+    @Test
+    void testProvideArgumentsWithDefaultRange() {
+        ApiKeyVersionsProvider provider = new ApiKeyVersionsProvider();
+
+        ApiKeyVersionsSource mockSource = mock(ApiKeyVersionsSource.class);
+        when(mockSource.apiKey()).thenReturn(ApiKeys.METADATA);
+        when(mockSource.fromVersion()).thenReturn((short) -1);
+        when(mockSource.toVersion()).thenReturn((short) -1);
+        when(mockSource.enableUnstableLastVersion()).thenReturn(false);
+
+        provider.accept(mockSource);
+
+        short oldest = ApiKeys.METADATA.oldestVersion();
+        short latest = ApiKeys.METADATA.latestVersion(false);
+
+        List<Short> versions = provider.provideArguments(mock(ExtensionContext.class))
+            .map(arg -> (Short) arg.get()[0])
+            .collect(Collectors.toList());
+
+        List<Short> expected = IntStream
+            .rangeClosed(oldest, latest)
+            .mapToObj(i -> (short) i)
+            .collect(Collectors.toList());
+
+        assertEquals(expected, versions);
+    }
+
+    @Test
+    void testInvalidRangeThrowsExceptionFromGreaterThanTo() {
+        ApiKeyVersionsProvider provider = new ApiKeyVersionsProvider();
+
+        ApiKeyVersionsSource mockSource = mock(ApiKeyVersionsSource.class);
+        when(mockSource.apiKey()).thenReturn(ApiKeys.FETCH);
+        when(mockSource.fromVersion()).thenReturn((short) 10);
+        when(mockSource.toVersion()).thenReturn((short) 5);
+        when(mockSource.enableUnstableLastVersion()).thenReturn(false);
+
+        assertThrows(IllegalArgumentException.class, () -> provider.accept(mockSource));
+    }
+
+    @Test
+    void testFromVersionTooOldThrowsException() {
+        ApiKeyVersionsProvider provider = new ApiKeyVersionsProvider();
+
+        ApiKeyVersionsSource mockSource = mock(ApiKeyVersionsSource.class);
+        when(mockSource.apiKey()).thenReturn(ApiKeys.FETCH);
+        when(mockSource.fromVersion()).thenReturn((short) (ApiKeys.FETCH.oldestVersion() - 1));
+        when(mockSource.toVersion()).thenReturn((short) 10);
+        when(mockSource.enableUnstableLastVersion()).thenReturn(false);
+
+        assertThrows(IllegalArgumentException.class, () -> provider.accept(mockSource));
+    }
+
+    @Test
+    void testToVersionTooNewThrowsException() {
+        ApiKeyVersionsProvider provider = new ApiKeyVersionsProvider();
+
+        ApiKeyVersionsSource mockSource = mock(ApiKeyVersionsSource.class);
+        when(mockSource.apiKey()).thenReturn(ApiKeys.FETCH);
+        when(mockSource.fromVersion()).thenReturn((short) 0);
+        when(mockSource.toVersion()).thenReturn((short) (ApiKeys.FETCH.latestVersion(true) + 1));
+        when(mockSource.enableUnstableLastVersion()).thenReturn(true);
+
+        assertThrows(IllegalArgumentException.class, () -> provider.accept(mockSource));
+    }
+}
diff --git a/clients/src/test/java/org/apache/kafka/common/utils/annotation/ApiKeyVersionsSource.java b/clients/src/test/java/org/apache/kafka/common/utils/annotation/ApiKeyVersionsSource.java
index c89cdb70b0f..4806605a545 100644
--- a/clients/src/test/java/org/apache/kafka/common/utils/annotation/ApiKeyVersionsSource.java
+++ b/clients/src/test/java/org/apache/kafka/common/utils/annotation/ApiKeyVersionsSource.java
@@ -30,4 +30,7 @@ import java.lang.annotation.Target;
 @ArgumentsSource(ApiKeyVersionsProvider.class)
 public @interface ApiKeyVersionsSource {
     ApiKeys apiKey();
+    short fromVersion() default -1;
+    short toVersion() default -1;
+    boolean enableUnstableLastVersion() default true;
 }