Skip to content

Support list-valued Kafka binder brokers in Kafka Streams #3310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sudhanshubliz wants to merge 1 commit into from
+85 −5
Closed

Support list-valued Kafka binder brokers in Kafka Streams #3310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions ...amework/cloud/stream/binder/kafka/streams/KafkaStreamsBinderSupportAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,16 +196,24 @@ public Map<String, Object> streamConfigGlobalProperties(
String kafkaConnectionString = configProperties.getKafkaConnectionString();

if (kafkaConnectionString != null && kafkaConnectionString.equals("localhost:9092")) {
Binder binder = Binder.get(environment);
//Making sure that the application indeed set a property.
String kafkaStreamsBinderBroker = environment.getProperty("spring.cloud.stream.kafka.streams.binder.brokers");
String[] kafkaStreamsBinderBrokers = binder.bind("spring.cloud.stream.kafka.streams.binder.brokers",
String[].class).orElse(null);
String kafkaStreamsBinderBroker = ObjectUtils.isEmpty(kafkaStreamsBinderBrokers) ? null
: StringUtils.arrayToCommaDelimitedString(kafkaStreamsBinderBrokers);

if (!StringUtils.hasText(kafkaStreamsBinderBroker)) {
//Kafka Streams binder specific property for brokers is not set by the application.
//See if there is one configured at the kafka binder level.
String kafkaBinderBroker = environment.getProperty("spring.cloud.stream.kafka.binder.brokers");
if (StringUtils.hasText(kafkaBinderBroker)) {
kafkaConnectionString = kafkaBinderBroker;
configProperties.setBrokers(kafkaConnectionString);
String[] kafkaBinderBrokers = binder.bind("spring.cloud.stream.kafka.binder.brokers",
String[].class).orElse(null);
if (!ObjectUtils.isEmpty(kafkaBinderBrokers)) {
String kafkaBinderBroker = StringUtils.arrayToCommaDelimitedString(kafkaBinderBrokers);
if (StringUtils.hasText(kafkaBinderBroker)) {
kafkaConnectionString = kafkaBinderBroker;
configProperties.setBrokers(kafkaBinderBrokers);
}
}
}
}
Expand Down
55 changes: 55 additions & 0 deletions ...rk/cloud/stream/binder/kafka/streams/KafkaStreamsBinderSupportAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,11 @@

package org.springframework.cloud.stream.binder.kafka.streams;

import java.util.Map;
import java.util.stream.Stream;

import org.apache.kafka.streams.StreamsConfig;

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.ObjectProvider;
Expand All @@ -26,6 +29,8 @@
import org.springframework.cloud.stream.config.BindingServiceProperties;
import org.springframework.cloud.stream.function.StreamFunctionProperties;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.mock.env.MockEnvironment;
import org.springframework.kafka.config.KafkaStreamsConfiguration;
import org.springframework.kafka.config.StreamsBuilderFactoryBeanConfigurer;
import org.springframework.kafka.core.CleanupConfig;

Expand All @@ -40,6 +45,56 @@
*/
class KafkaStreamsBinderSupportAutoConfigurationTests {

@Test
void kafkaBinderBrokerListIsUsedAsStreamsFallback() {
MockEnvironment environment = new MockEnvironment()
.withProperty("spring.cloud.stream.kafka.binder.brokers[0]", "host1:9092")
.withProperty("spring.cloud.stream.kafka.binder.brokers[1]", "host2:9092");

assertThat(streamConfigGlobalProperties(environment).get(StreamsConfig.BOOTSTRAP_SERVERS_CONFIG))
.isEqualTo("host1:9092,host2:9092");
}

@Test
void kafkaBinderBrokerStringIsUsedAsStreamsFallback() {
MockEnvironment environment = new MockEnvironment()
.withProperty("spring.cloud.stream.kafka.binder.brokers", "host1:9092,host2:9092");

assertThat(streamConfigGlobalProperties(environment).get(StreamsConfig.BOOTSTRAP_SERVERS_CONFIG))
.isEqualTo("host1:9092,host2:9092");
}

@Test
void streamsBrokerListPreventsKafkaBinderFallback() {
MockEnvironment environment = new MockEnvironment()
.withProperty("spring.cloud.stream.kafka.streams.binder.brokers[0]", "streams-host:9092")
.withProperty("spring.cloud.stream.kafka.binder.brokers[0]", "kafka-host:9092");

assertThat(streamConfigGlobalProperties(environment).get(StreamsConfig.BOOTSTRAP_SERVERS_CONFIG))
.isEqualTo("localhost:9092");
}

@Test
void emptyKafkaBinderBrokersLeaveStreamsDefaultUnchanged() {
MockEnvironment environment = new MockEnvironment()
.withProperty("spring.cloud.stream.kafka.binder.brokers", "");

assertThat(streamConfigGlobalProperties(environment).get(StreamsConfig.BOOTSTRAP_SERVERS_CONFIG))
.isEqualTo("localhost:9092");
}

private Map<String, Object> streamConfigGlobalProperties(MockEnvironment environment) {
KafkaStreamsBinderConfigurationProperties binderProperties = mock(KafkaStreamsBinderConfigurationProperties.class);
when(binderProperties.getKafkaConnectionString()).thenReturn("localhost:9092");
when(binderProperties.mergedConsumerConfiguration()).thenReturn(Map.of());
when(binderProperties.mergedProducerConfiguration()).thenReturn(Map.of());

return new KafkaStreamsBinderSupportAutoConfiguration().streamConfigGlobalProperties(
binderProperties,
new KafkaStreamsConfiguration(Map.of(StreamsConfig.BOOTSTRAP_SERVERS_CONFIG, "localhost:9092")),
environment, mock(SendToDlqAndContinue.class));
}

@Test
@SuppressWarnings("unchecked")
void kafkaStreamsFunctionProcessorUsesAllStreamsBuilderFactoryBeanConfigurers() {
Expand Down
17 changes: 17 additions & 0 deletions ...ramework/cloud/stream/binder/kafka/streams/bootstrap/KafkaStreamsBinderBootstrapTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package org.springframework.cloud.stream.binder.kafka.streams.bootstrap;

import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.function.Consumer;
Expand All @@ -24,6 +25,7 @@
import tools.jackson.databind.type.TypeFactory;
import org.apache.kafka.common.header.Headers;
import org.apache.kafka.common.security.JaasUtils;
import org.apache.kafka.streams.StreamsConfig;
import org.apache.kafka.streams.kstream.GlobalKTable;
import org.apache.kafka.streams.kstream.KStream;
import org.apache.kafka.streams.kstream.KTable;
Expand Down Expand Up @@ -82,6 +84,21 @@ void kafkaStreamsBinderWithStandardConfigCanStart(boolean excludeKafkaAutoConfig
} // @checkstyle:on
}

@Test
@SuppressWarnings("unchecked")
void kafkaStreamsBinderUsesKafkaBinderBrokerList() {
try (ConfigurableApplicationContext context = new SpringApplicationBuilder(SimpleKafkaStreamsApplication.class)
.web(WebApplicationType.NONE).run(
"--spring.cloud.function.definition=input1",
"--spring.cloud.stream.kafka.streams.bindings.input1-in-0.consumer.application-id"
+ "=testKafkaStreamsBinderUsesKafkaBinderBrokerList",
"--spring.cloud.stream.kafka.binder.brokers[0]=" + embeddedKafka.getBrokersAsString())) {
Map<String, Object> properties = context.getBean("streamConfigGlobalProperties", Map.class);
assertThat(properties.get(StreamsConfig.BOOTSTRAP_SERVERS_CONFIG))
.isEqualTo(List.of(embeddedKafka.getBrokersAsString()));
}
}

@ParameterizedTest
@ValueSource(booleans = { false, true })
void kafkaStreamsBinderWithCustomConfigCanStart(boolean excludeKafkaAutoConfig) {
Expand Down