Merge pull request #5291 from getsentry/fix/queue-instrumentation-kafka-system-test-runner

fix(test): [Queue Instrumentation 16] Enable Kafka profile in system runner

Author: adinauer

sentry-spring-boot-jakarta/src/main/java/io/sentry/spring/boot/jakarta/SentryAutoConfiguration.java

@@ -77,7 +77,6 @@
 import org.springframework.core.annotation.Order;
 import org.springframework.core.env.Environment;
 import org.springframework.graphql.execution.DataFetcherExceptionResolverAdapter;
-import org.springframework.kafka.core.KafkaTemplate;
 import org.springframework.scheduling.quartz.SchedulerFactoryBean;
 import org.springframework.security.core.context.SecurityContextHolder;
 import org.springframework.web.client.RestClient;
@@ -250,7 +249,11 @@ static class SentryCacheConfiguration {
     }
 
     @Configuration(proxyBeanMethods = false)
-    @ConditionalOnClass(KafkaTemplate.class)
+    @ConditionalOnClass(
+        name = {
+          "org.springframework.kafka.core.KafkaTemplate",
+          "io.sentry.kafka.SentryKafkaProducerInterceptor"
+        })
     @ConditionalOnProperty(name = "sentry.enable-queue-tracing", havingValue = "true")
     @ConditionalOnMissingClass("io.sentry.opentelemetry.SentryAutoConfigurationCustomizerProvider")
     @Open

sentry-spring-boot-jakarta/src/test/kotlin/io/sentry/spring/boot/jakarta/SentryKafkaAutoConfigurationTest.kt

@@ -1,5 +1,6 @@
 package io.sentry.spring.boot.jakarta
 
+import io.sentry.kafka.SentryKafkaProducerInterceptor
 import io.sentry.opentelemetry.SentryAutoConfigurationCustomizerProvider
 import io.sentry.spring.jakarta.kafka.SentryKafkaConsumerBeanPostProcessor
 import io.sentry.spring.jakarta.kafka.SentryKafkaProducerBeanPostProcessor
@@ -30,6 +31,9 @@ class SentryKafkaAutoConfigurationTest {
   private val noOtelClassLoader =
     FilteredClassLoader(SentryAutoConfigurationCustomizerProvider::class.java)
 
+  private val noSentryKafkaClassLoader =
+    FilteredClassLoader(SentryKafkaProducerInterceptor::class.java)
+
   @Test
   fun `registers Kafka BPPs when queue tracing is enabled`() {
     contextRunner
@@ -49,6 +53,17 @@ class SentryKafkaAutoConfigurationTest {
     }
   }
 
+  @Test
+  fun `does not register Kafka BPPs when sentry-kafka is not present`() {
+    contextRunner
+      .withClassLoader(noSentryKafkaClassLoader)
+      .withPropertyValues("sentry.enable-queue-tracing=true")
+      .run { context ->
+        assertThat(context).doesNotHaveBean(SentryKafkaProducerBeanPostProcessor::class.java)
+        assertThat(context).doesNotHaveBean(SentryKafkaConsumerBeanPostProcessor::class.java)
+      }
+  }
+
   @Test
   fun `does not register Kafka BPPs when queue tracing is explicitly false`() {
     contextRunner

test/system-test-runner.py

@@ -68,6 +68,13 @@
 
 KAFKA_CONTAINER_NAME = "sentry-java-system-test-kafka"
 KAFKA_BOOTSTRAP_SERVERS = "localhost:9092"
+KAFKA_BROKER_REQUIRED_MODULES = {
+    "sentry-samples-console",
+    "sentry-samples-spring-boot-jakarta",
+}
+KAFKA_PROFILE_REQUIRED_MODULES = {
+    "sentry-samples-spring-boot-jakarta",
+}
 
 class ServerType(Enum):
     TOMCAT = 0
@@ -202,7 +209,10 @@ def kill_process(self, pid: int, name: str) -> None:
             print(f"Process {pid} was already dead")
 
     def module_requires_kafka(self, sample_module: str) -> bool:
-        return sample_module == "sentry-samples-console"
+        return sample_module in KAFKA_BROKER_REQUIRED_MODULES
+
+    def module_requires_kafka_profile(self, sample_module: str) -> bool:
+        return sample_module in KAFKA_PROFILE_REQUIRED_MODULES
 
     def wait_for_port(self, host: str, port: int, max_attempts: int = 20) -> bool:
         for _ in range(max_attempts):
@@ -423,6 +433,12 @@ def start_spring_server(self, sample_module: str, java_agent: str, java_agent_au
         env.update(SENTRY_ENVIRONMENT_VARIABLES)
         env["SENTRY_AUTO_INIT"] = java_agent_auto_init
 
+        if self.module_requires_kafka_profile(sample_module):
+            env["SPRING_PROFILES_ACTIVE"] = "kafka"
+            print("Enabling Spring profile: kafka")
+        else:
+            env.pop("SPRING_PROFILES_ACTIVE", None)
+
         # Build command
         jar_path = f"sentry-samples/{sample_module}/build/libs/{sample_module}-0.0.1-SNAPSHOT.jar"
         cmd = ["java"]