Skip to content

Commit

Permalink
Fix kroxylicious#248: Allow user to bring their own test templating w…
Browse files Browse the repository at this point in the history 
…hen using KafkaClusterExtension

Signed-off-by: kwall <kwall@apache.org>
  • Loading branch information
@k-wall
k-wall committed Dec 6, 2023
1 parent ff1372d commit 9db0031
Show file tree
Hide file tree
Showing 3 changed files with 98 additions and 8 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ Please enumerate all user-facing changes using format `<githib issue/pr number>:

## 1.0.0

## 0.8.0

* [#248](https://github.com/kroxylicious/kroxylicious-junit5-extension/issues/248): Allow user to bring their own test templating when using KafkaClusterExtension

## 0.7.0

Expand Down
10 changes: 8 additions & 2 deletions ...xtension/src/main/java/io/kroxylicious/testing/kafka/junit5ext/KafkaClusterExtension.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

import java.lang.annotation.Annotation;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Executable;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
Expand Down Expand Up @@ -458,8 +459,13 @@ public void close() throws Throwable {

@Override
public boolean supportsParameter(ParameterContext parameterContext, ExtensionContext extensionContext) throws ParameterResolutionException {
return !parameterContext.getDeclaringExecutable().isAnnotationPresent(TestTemplate.class)
&& supportsParameter(parameterContext.getParameter());
return !hasTestTemplateConfiguration(parameterContext.getDeclaringExecutable()) && supportsParameter(parameterContext.getParameter());
}

private boolean hasTestTemplateConfiguration(Executable executable) {
return executable.isAnnotationPresent(TestTemplate.class)
&& Arrays.stream(executable.getParameters()).anyMatch(
p -> p.getAnnotationsByType(DimensionMethodSource.class).length > 0 || p.getAnnotationsByType(ConstraintsMethodSource.class).length > 0);
}

@Override
Expand Down
93 changes: 87 additions & 6 deletions junit5-extension/src/test/java/io/kroxylicious/testing/kafka/junit5ext/TemplateTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,27 @@
import java.util.Set;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import org.apache.kafka.clients.admin.Admin;
import org.apache.kafka.clients.admin.Config;
import org.apache.kafka.common.config.ConfigResource;
import org.apache.kafka.common.errors.UnsupportedVersionException;
import org.jetbrains.annotations.NotNull;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.TestInstance;
import org.junit.jupiter.api.TestTemplate;
import org.junit.jupiter.api.extension.ExtendWith;
import org.junit.jupiter.api.extension.Extension;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.api.extension.ParameterContext;
import org.junit.jupiter.api.extension.ParameterResolutionException;
import org.junit.jupiter.api.extension.TestTemplateInvocationContext;
import org.junit.jupiter.api.extension.TestTemplateInvocationContextProvider;
import org.junit.jupiter.api.extension.support.TypeBasedParameterResolver;

import io.kroxylicious.testing.kafka.api.KafkaCluster;
import io.kroxylicious.testing.kafka.common.BrokerCluster;
Expand All @@ -43,6 +52,7 @@
@ExtendWith(KafkaClusterExtension.class)
public class TemplateTest {

@SuppressWarnings("unused")
static Stream<BrokerCluster> clusterSizes() {
return Stream.of(
brokerCluster(1),
Expand All @@ -65,11 +75,13 @@ public void testMultipleClusterSizesWithAdminParameters(@DimensionMethodSource(v
assertThat(admin.describeCluster().nodes().get()).hasSize(cluster.getNumOfBrokers());
}

static Set<List<Object>> observedCartesianProduct = new HashSet<>();

@Nested
@TestInstance(TestInstance.Lifecycle.PER_CLASS)
public class CartesianProduct {

private final Set<List<Object>> observedCartesianProduct = new HashSet<>();

@SuppressWarnings("unused")
static Stream<BrokerConfig> compression() {
return Stream.of(
brokerConfig("compression.type", "zstd"),
Expand Down Expand Up @@ -110,18 +122,18 @@ public void afterAll() {
}
}

@SuppressWarnings("unused")
static Stream<List<Annotation>> tuples() {
return Stream.of(
List.of(brokerCluster(1), kraftCluster(1)),
List.of(brokerCluster(3), kraftCluster(1)),
List.of(brokerCluster(3), zooKeeperCluster()));
}

static Set<List<Integer>> observedTuples = new HashSet<>();

@Nested
@TestInstance(TestInstance.Lifecycle.PER_CLASS)
public class Tuples {
private final Set<List<Integer>> observedTuples = new HashSet<>();

@TestTemplate
public void testTuples(@ConstraintsMethodSource(value = "tuples", clazz = TemplateTest.class) KafkaCluster cluster,
Expand Down Expand Up @@ -166,12 +178,12 @@ private static Stream<Version> versions() {
version("3.1.2"));
}

static Set<String> observedVersions = new HashSet<>();

@Nested
@TestInstance(TestInstance.Lifecycle.PER_CLASS)
public class Versions {

private final Set<String> observedVersions = new HashSet<>();

@TestTemplate
public void testVersions(@DimensionMethodSource(value = "versions", clazz = TemplateTest.class) @KRaftCluster TestcontainersKafkaCluster cluster) {
observedVersions.add(cluster.getKafkaVersion());
Expand All @@ -182,4 +194,73 @@ public void afterAll() {
assertThat(observedVersions).isEqualTo(versions().map(Version::value).collect(Collectors.toSet()));
}
}

@Nested
@TestInstance(TestInstance.Lifecycle.PER_CLASS)
public class CooperationWithAnotherTestTemplateInvocationContextProvider {
private final AtomicInteger observedInvocations = new AtomicInteger();
private final Set<MyTestParam> observedResolvedParams = new HashSet<>();

@TestTemplate
@ExtendWith(MyTestTemplateInvocationContextProvider.class)
void invocation(KafkaCluster cluster) {
assertThat(cluster).isNotNull();
observedInvocations.incrementAndGet();
}

@TestTemplate
@ExtendWith(MyTestTemplateInvocationContextProvider.class)
void invocationWithResolvedParameter(KafkaCluster cluster, MyTestParam testParam) {
assertThat(cluster).isNotNull();
observedResolvedParams.add(testParam);
}

@AfterAll
void afterAll() {
assertThat(observedInvocations).hasValue(2);
assertThat(observedResolvedParams).containsExactly(new MyTestParam("one"), new MyTestParam("two"));
}

}

private record MyTestParam(String value) {
}

private static class MyTestTemplateInvocationContextProvider implements TestTemplateInvocationContextProvider {
@Override
public boolean supportsTestTemplate(ExtensionContext context) {
return true;
}

@Override
public Stream<TestTemplateInvocationContext> provideTestTemplateInvocationContexts(ExtensionContext context) {
return Stream.of(
getTestTemplateInvocationContext("one"),
getTestTemplateInvocationContext("two"));
}

@NotNull
private TestTemplateInvocationContext getTestTemplateInvocationContext(String value) {
return new TestTemplateInvocationContext() {
@Override
public String getDisplayName(int invocationIndex) {
return value;
}

@Override
public List<Extension> getAdditionalExtensions() {
return List.of(
new TypeBasedParameterResolver<MyTestParam>() {

@Override
public MyTestParam resolveParameter(ParameterContext parameterContext, ExtensionContext extensionContext)
throws ParameterResolutionException {
return new MyTestParam(value);
}
});
}

};
}
}
}

0 comments on commit 9db0031

Please sign in to comment.