fix: kafka health indicator requires kafka configuration (#937)

micronaut-projects · Jan 15, 2024 · b1193d7 · b1193d7
1 parent d8d1d0a
commit b1193d7
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/kafka/src/main/java/io/micronaut/configuration/kafka/health/KafkaHealthIndicator.java b/kafka/src/main/java/io/micronaut/configuration/kafka/health/KafkaHealthIndicator.java
@@ -57,6 +57,7 @@
  * @since 1.0
  */
 @Singleton
+@Requires(bean = KafkaDefaultConfiguration.class)
 @Requires(property = KafkaHealthConfigurationProperties.PREFIX + ".enabled", value = StringUtils.TRUE, defaultValue = StringUtils.TRUE)
 public class KafkaHealthIndicator implements HealthIndicator, ClusterResourceListener {
     private static final String ID = "kafka";

diff --git a/...a/src/test/groovy/io/micronaut/configuration/kafka/health/KafkaHealthIndicatorSpec.groovy b/...a/src/test/groovy/io/micronaut/configuration/kafka/health/KafkaHealthIndicatorSpec.groovy
@@ -1,6 +1,7 @@
 package io.micronaut.configuration.kafka.health
 
 import io.micronaut.configuration.kafka.AbstractKafkaSpec
+import io.micronaut.configuration.kafka.config.KafkaDefaultConfiguration
 import io.micronaut.context.ApplicationContext
 import io.micronaut.core.io.socket.SocketUtils
 import io.micronaut.management.health.indicator.HealthResult
@@ -70,6 +71,27 @@ class KafkaHealthIndicatorSpec extends AbstractKafkaSpec {
         configvalue << [false, "false", "no", ""]
     }
 
+    void "test kafka health indicator - disabled when no kafka configuration provided"() {
+        given:
+        ApplicationContext applicationContext = ApplicationContext.run(configuration +
+                ["test-resources.containers.kafka.enabled": false])
+
+        when:
+        Optional<KafkaDefaultConfiguration> config = applicationContext.findBean(KafkaDefaultConfiguration)
+
+        then:
+        config.isEmpty()
+
+        when:
+        Optional<KafkaHealthIndicator> healthIndicator = applicationContext.findBean(KafkaHealthIndicator)
+
+        then:
+        healthIndicator.isEmpty()
+
+        cleanup:
+        applicationContext.close()
+    }
+
     @Unroll
     void "kafka health indicator handle missing replication factor config"() {
         given: