testcontainers don't work with graalvm native

Author: zeitlinger

.github/workflows/reusable-native-tests.yml

@@ -24,4 +24,10 @@ jobs:
           echo "JAVA_HOME: $JAVA_HOME"
           java --version
           native-image --version
+          # Testcontainers does not work with native-image, 
+          # therefore we're starting a Kafka container manually for the tests
+          # The requested image's platform (linux/arm64/v8) does not match the detected host platform (linux/amd64/v3) and no specific platform was requested
+          # todo: build image from https://github.com/hey-johnnypark/docker-kafka-zookeeper and publish
+          docker run -p 2181:2181 -p 9092:9092 -e ADVERTISED_HOST=localhost --rm kafka-zookeepter
           ./gradlew nativeTest
+          docker stop kafka # is this needed?

smoke-tests-otel-starter/spring-boot-3/src/test/java/io/opentelemetry/smoketest/KafkaSpringStarterSmokeTest.java smoke-tests-otel-starter/spring-boot-3/src/test/java/io/opentelemetry/smoketest/AbstractKafkaSpringStarterSmokeTest.java

@@ -14,49 +14,33 @@
 import io.opentelemetry.spring.smoketest.AbstractSpringStarterSmokeTest;
 import io.opentelemetry.spring.smoketest.OtelSpringStarterSmokeTestApplication;
 import io.opentelemetry.spring.smoketest.SpringSmokeOtelConfiguration;
-import java.time.Duration;
 import org.apache.kafka.clients.admin.NewTopic;
 import org.apache.kafka.clients.consumer.ConsumerRecord;
 import org.assertj.core.api.AbstractLongAssert;
 import org.assertj.core.api.AbstractStringAssert;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.kafka.annotation.KafkaListener;
 import org.springframework.kafka.config.TopicBuilder;
 import org.springframework.kafka.core.KafkaTemplate;
-import org.testcontainers.containers.KafkaContainer;
-import org.testcontainers.containers.wait.strategy.Wait;
-import org.testcontainers.junit.jupiter.Container;
-import org.testcontainers.junit.jupiter.Testcontainers;
-import org.testcontainers.utility.DockerImageName;
 
-@Testcontainers
 @SpringBootTest(
     classes = {
       OtelSpringStarterSmokeTestApplication.class,
       SpringSmokeOtelConfiguration.class,
-      KafkaSpringStarterSmokeTest.KafkaConfig.class
+      AbstractKafkaSpringStarterSmokeTest.KafkaConfig.class
     },
     webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT,
     properties = {
       "spring.kafka.consumer.auto-offset-reset=earliest",
       "spring.kafka.consumer.linger-ms=10",
-      "spring.kafka.admin.operation-timeout=5m",
       "spring.kafka.listener.idle-between-polls=1000",
       "spring.kafka.producer.transaction-id-prefix=test-"
     })
-public class KafkaSpringStarterSmokeTest extends AbstractSpringStarterSmokeTest {
-
-  @Container @ServiceConnection
-  static KafkaContainer kafka =
-      new KafkaContainer(DockerImageName.parse("confluentinc/cp-kafka:6.2.10"))
-          .withEnv("KAFKA_HEAP_OPTS", "-Xmx256m")
-          .waitingFor(Wait.forLogMessage(".*started \\(kafka.server.KafkaServer\\).*", 1))
-          .withStartupTimeout(Duration.ofMinutes(1));
+abstract class AbstractKafkaSpringStarterSmokeTest extends AbstractSpringStarterSmokeTest {
 
   @Autowired private KafkaTemplate<String, String> kafkaTemplate;
 
@@ -106,7 +90,7 @@ void shouldInstrumentProducerAndConsumer() {
                     span.hasName("testTopic process")
                         .hasKind(SpanKind.CONSUMER)
                         .hasParent(trace.getSpan(1))
-                        .hasAttributesSatisfyingExactly(
+                        .hasAttributesSatisfying(
                             equalTo(MessagingIncubatingAttributes.MESSAGING_SYSTEM, "kafka"),
                             equalTo(
                                 MessagingIncubatingAttributes.MESSAGING_DESTINATION_NAME,

smoke-tests-otel-starter/spring-boot-3/src/test/java/io/opentelemetry/smoketest/GraalVmNativeKafkaSpringStarterSmokeTest.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.smoketest;
+
+import org.junit.jupiter.api.condition.EnabledInNativeImage;
+
+/**
+ * GraalVM native image doesn't support Testcontainers in our case, so the docker container is
+ * started manually before running the tests.
+ *
+ * <p>In other cases, it does work, e.g. <a
+ * href="https://info.michael-simons.eu/2023/10/25/run-your-integration-tests-against-testcontainers-with-graalvm-native-image/">here</a>,
+ * it's not yet clear why it doesn't work in our case.
+ *
+ * <p>In CI, this is done in reusable-native-tests.yml. If you want to run the tests locally, you
+ * need to start the container manually: docker run -d -p 9092:9092 --name kafka --rm
+ * confluentinc/cp-kafka:6.2.10
+ */
+@EnabledInNativeImage
+public class GraalVmNativeKafkaSpringStarterSmokeTest extends AbstractKafkaSpringStarterSmokeTest {}

smoke-tests-otel-starter/spring-boot-3/src/test/java/io/opentelemetry/smoketest/JvmKafkaSpringStarterSmokeTest.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.smoketest;
+
+import java.time.Duration;
+import org.junit.jupiter.api.condition.DisabledInNativeImage;
+import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
+import org.testcontainers.containers.KafkaContainer;
+import org.testcontainers.containers.wait.strategy.Wait;
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+import org.testcontainers.utility.DockerImageName;
+
+@Testcontainers
+@DisabledInNativeImage
+public class JvmKafkaSpringStarterSmokeTest extends AbstractKafkaSpringStarterSmokeTest {
+
+  @Container @ServiceConnection
+  static KafkaContainer kafka =
+      new KafkaContainer(DockerImageName.parse("confluentinc/cp-kafka:6.2.10"))
+          .withEnv("KAFKA_HEAP_OPTS", "-Xmx256m")
+          .waitingFor(Wait.forLogMessage(".*started \\(kafka.server.KafkaServer\\).*", 1))
+          .withStartupTimeout(Duration.ofMinutes(1));
+}