KafkaStreamsInteractiveQueryIntegrationTests.java

/*
 * Copyright 2017-present the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

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

import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.function.Function;

import org.apache.kafka.clients.consumer.Consumer;
import org.apache.kafka.clients.consumer.ConsumerConfig;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.apache.kafka.common.serialization.IntegerSerializer;
import org.apache.kafka.common.serialization.Serdes;
import org.apache.kafka.common.serialization.StringSerializer;
import org.apache.kafka.streams.KafkaStreams;
import org.apache.kafka.streams.KeyQueryMetadata;
import org.apache.kafka.streams.KeyValue;
import org.apache.kafka.streams.StoreQueryParameters;
import org.apache.kafka.streams.StreamsConfig;
import org.apache.kafka.streams.kstream.Grouped;
import org.apache.kafka.streams.kstream.KStream;
import org.apache.kafka.streams.kstream.Materialized;
import org.apache.kafka.streams.state.HostInfo;
import org.apache.kafka.streams.state.QueryableStoreType;
import org.apache.kafka.streams.state.QueryableStoreTypes;
import org.apache.kafka.streams.state.ReadOnlyKeyValueStore;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;

import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.WebApplicationType;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.kafka.autoconfigure.KafkaProperties;
import org.springframework.cloud.stream.binder.kafka.streams.properties.KafkaStreamsBinderConfigurationProperties;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.kafka.config.StreamsBuilderFactoryBean;
import org.springframework.kafka.core.CleanupConfig;
import org.springframework.kafka.core.DefaultKafkaConsumerFactory;
import org.springframework.kafka.core.DefaultKafkaProducerFactory;
import org.springframework.kafka.core.KafkaTemplate;
import org.springframework.kafka.support.serializer.JacksonJsonSerde;
import org.springframework.kafka.test.EmbeddedKafkaBroker;
import org.springframework.kafka.test.condition.EmbeddedKafkaCondition;
import org.springframework.kafka.test.context.EmbeddedKafka;
import org.springframework.kafka.test.utils.KafkaTestUtils;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.mockito.Mockito.mock;
import static org.mockito.internal.verification.VerificationModeFactory.times;

/**
 * @author Soby Chacko
 * @author Gary Russell
 * @author Nico Pommerening
 */
@EmbeddedKafka(topics = "counts-id")
class KafkaStreamsInteractiveQueryIntegrationTests {

	private static Consumer<String, String> consumer;

	private static EmbeddedKafkaBroker embeddedKafka;

	@BeforeAll
	public static void setUp() throws Exception {
		embeddedKafka = EmbeddedKafkaCondition.getBroker();
		Map<String, Object> consumerProps = KafkaTestUtils.consumerProps("group-id",
				"false", embeddedKafka);
		consumerProps.put(ConsumerConfig.AUTO_OFFSET_RESET_CONFIG, "earliest");
		DefaultKafkaConsumerFactory<String, String> cf = new DefaultKafkaConsumerFactory<>(
				consumerProps);
		consumer = cf.createConsumer();
		embeddedKafka.consumeFromAnEmbeddedTopic(consumer, "counts-id");
	}

	@AfterAll
	public static void tearDown() {
		consumer.close();
	}

	@Test
	@SuppressWarnings("unchecked")
	void stateStoreRetrievalRetriedOnFailure() {

		StreamsBuilderFactoryBean mock = Mockito.mock(StreamsBuilderFactoryBean.class);
		KafkaStreams mockKafkaStreams = Mockito.mock(KafkaStreams.class);
		Mockito.when(mock.getKafkaStreams()).thenReturn(mockKafkaStreams);
		KafkaStreamsRegistry kafkaStreamsRegistry = new KafkaStreamsRegistry();
		kafkaStreamsRegistry.registerKafkaStreams(mock);
		Mockito.when(mock.isRunning()).thenReturn(true);
		Properties mockProperties = new Properties();
		mockProperties.put(StreamsConfig.APPLICATION_ID_CONFIG, "fooApp");
		Mockito.when(mock.getStreamsConfiguration()).thenReturn(mockProperties);
		KafkaStreamsBinderConfigurationProperties binderConfigurationProperties =
				new KafkaStreamsBinderConfigurationProperties(new KafkaProperties(), mock(ObjectProvider.class));
		binderConfigurationProperties.getStateStoreRetry().setMaxAttempts(3);
		InteractiveQueryService interactiveQueryService = new InteractiveQueryService(kafkaStreamsRegistry,
				binderConfigurationProperties);

		QueryableStoreType<ReadOnlyKeyValueStore<Object, Object>> storeType = QueryableStoreTypes.keyValueStore();
		try {
			interactiveQueryService.getQueryableStore("foo", storeType);
		}
		catch (Exception ignored) {

		}
		Mockito.verify(mockKafkaStreams, times(4))
				.store(StoreQueryParameters.fromNameAndType("foo", storeType));
	}

	@Test
	@SuppressWarnings("unchecked")
	void hostInfoRetrievalRetriedOnFailure() {
		StreamsBuilderFactoryBean mock = Mockito.mock(StreamsBuilderFactoryBean.class);
		KafkaStreams mockKafkaStreams = Mockito.mock(KafkaStreams.class);
		Mockito.when(mock.getKafkaStreams()).thenReturn(mockKafkaStreams);
		KafkaStreamsRegistry kafkaStreamsRegistry = new KafkaStreamsRegistry();
		kafkaStreamsRegistry.registerKafkaStreams(mock);
		Mockito.when(mock.isRunning()).thenReturn(true);
		Properties mockProperties = new Properties();
		mockProperties.put(StreamsConfig.APPLICATION_ID_CONFIG, "foobarApp-123");
		Mockito.when(mock.getStreamsConfiguration()).thenReturn(mockProperties);
		KafkaStreamsBinderConfigurationProperties binderConfigurationProperties =
				new KafkaStreamsBinderConfigurationProperties(new KafkaProperties(), mock(ObjectProvider.class));
		binderConfigurationProperties.getStateStoreRetry().setMaxAttempts(3);
		InteractiveQueryService interactiveQueryService = new InteractiveQueryService(kafkaStreamsRegistry,
				binderConfigurationProperties);

		QueryableStoreType<ReadOnlyKeyValueStore<Object, Object>> storeType = QueryableStoreTypes.keyValueStore();
		final StringSerializer serializer = new StringSerializer();
		try {
			interactiveQueryService.getHostInfo("foo", "foobarApp-key", serializer);
		}
		catch (Exception ignored) {

		}
		Mockito.verify(mockKafkaStreams, times(4))
				.queryMetadataForKey("foo", "foobarApp-key", serializer);
	}

	@Test
	void queryServiceProvidesStateStoreAndHostInfo() {
		SpringApplication app = new SpringApplication(ProductCountApplication.class);
		app.setWebApplicationType(WebApplicationType.NONE);
		ConfigurableApplicationContext context = app.run("--server.port=0",
				"--spring.jmx.enabled=false",
				"--spring.cloud.stream.function.bindings.process-in-0=input",
				"--spring.cloud.stream.function.bindings.process-out-0=output",
				"--spring.cloud.stream.bindings.input.destination=foos",
				"--spring.cloud.stream.bindings.output.destination=counts-id",
				"--spring.cloud.stream.kafka.streams.binder.configuration.commit.interval.ms=1000",
				"--spring.cloud.stream.kafka.streams.binder.configuration.default.key.serde"
						+ "=org.apache.kafka.common.serialization.Serdes$StringSerde",
				"--spring.cloud.stream.kafka.streams.binder.configuration.default.value.serde"
						+ "=org.apache.kafka.common.serialization.Serdes$StringSerde",
				"--spring.cloud.stream.kafka.streams.bindings.input.consumer.applicationId=ProductCountApplication-def",
				"--spring.cloud.stream.kafka.streams.binder.configuration.application.server"
						+ "=" + embeddedKafka.getBrokersAsString(),
				"--spring.cloud.stream.kafka.streams.binder.brokers="
						+ embeddedKafka.getBrokersAsString());
		try {
			receiveAndValidateFoo(context);
		}
		finally {
			context.close();
		}
	}

	private void receiveAndValidateFoo(ConfigurableApplicationContext context) {
		Map<String, Object> senderProps = KafkaTestUtils.producerProps(embeddedKafka);
		DefaultKafkaProducerFactory<Integer, String> pf = new DefaultKafkaProducerFactory<>(
				senderProps);
		KafkaTemplate<Integer, String> template = new KafkaTemplate<>(pf, true);
		template.setDefaultTopic("foos");
		template.sendDefault("{\"id\":\"123\"}");

		ConsumerRecord<String, String> cr = KafkaTestUtils.getSingleRecord(consumer, "counts-id");
		assertThat(cr.value()).isIn("Count for product with ID 123: 1", "Count for product with ID 123: 2");

		// Make sure the count can be retrieved from local state store
		ProductCountApplication.Foo foo = context.getBean(ProductCountApplication.Foo.class);
		assertThat(foo.getProductStock(123)).isIn(1L, 2L);

		// perform assertions on HostInfo related methods in InteractiveQueryService
		InteractiveQueryService interactiveQueryService = context
				.getBean(InteractiveQueryService.class);
		HostInfo currentHostInfo = interactiveQueryService.getCurrentHostInfo();

		assertThat(currentHostInfo.host() + ":" + currentHostInfo.port())
				.isEqualTo(embeddedKafka.getBrokersAsString());

		final KeyQueryMetadata keyQueryMetadata = interactiveQueryService.getKeyQueryMetadata("prod-id-count-store",
				123, new IntegerSerializer());
		final HostInfo activeHost = keyQueryMetadata.activeHost();
		assertThat(activeHost.host() + ":" + activeHost.port())
				.isEqualTo(embeddedKafka.getBrokersAsString());

		final KafkaStreams kafkaStreams = interactiveQueryService.getKafkaStreams("prod-id-count-store",
				123, new IntegerSerializer());
		assertThat(kafkaStreams).isNotNull();
		assertThat(interactiveQueryService.getKafkaStreams("non-existent-store",
				123, new IntegerSerializer())).isNull();

		HostInfo hostInfo = interactiveQueryService.getHostInfo("prod-id-count-store",
				123, new IntegerSerializer());
		assertThat(hostInfo.host() + ":" + hostInfo.port())
				.isEqualTo(embeddedKafka.getBrokersAsString());

		assertThatThrownBy(() -> interactiveQueryService
				.getHostInfo("prod-id-count-store-foo", 123, new IntegerSerializer()))
				.isInstanceOf(IllegalStateException.class)
				.hasMessageContaining("Error when retrieving state store.");

		final List<HostInfo> hostInfos = interactiveQueryService.getAllHostsInfo("prod-id-count-store");
		assertThat(hostInfos.size()).isEqualTo(1);
		final HostInfo hostInfo1 = hostInfos.get(0);
		assertThat(hostInfo1.host() + ":" + hostInfo1.port())
				.isEqualTo(embeddedKafka.getBrokersAsString());
	}

	@Test
	void queryServiceProvidesStateStoreWithoutSettingAppServerProperty() {
		SpringApplication app = new SpringApplication(ProductCountApplication.class);
		app.setWebApplicationType(WebApplicationType.NONE);
		try (ConfigurableApplicationContext context = app.run("--server.port=0",
				"--spring.jmx.enabled=false",
				"--spring.cloud.stream.function.bindings.process-in-0=input",
				"--spring.cloud.stream.function.bindings.process-out-0=output",
				"--spring.cloud.stream.bindings.input.destination=foos",
				"--spring.cloud.stream.bindings.output.destination=counts-id",
				"--spring.cloud.stream.kafka.streams.binder.configuration.commit.interval.ms=1000",
				"--spring.cloud.stream.kafka.streams.binder.configuration.default.key.serde"
						+ "=org.apache.kafka.common.serialization.Serdes$StringSerde",
				"--spring.cloud.stream.kafka.streams.binder.configuration.default.value.serde"
						+ "=org.apache.kafka.common.serialization.Serdes$StringSerde",
				"--spring.cloud.stream.kafka.streams.bindings.input.consumer.applicationId=ProductCountApplication-def",
				"--spring.cloud.stream.kafka.streams.binder.brokers=" + embeddedKafka.getBrokersAsString())
		) {
			// Send an input product record
			Map<String, Object> senderProps = KafkaTestUtils.producerProps(embeddedKafka);
			DefaultKafkaProducerFactory<Integer, String> pf = new DefaultKafkaProducerFactory<>(senderProps);
			KafkaTemplate<Integer, String> template = new KafkaTemplate<>(pf, true);
			template.setDefaultTopic("foos");
			template.sendDefault("{\"id\":\"123\"}");

			// Wait for output from the streams app
			ConsumerRecord<String, String> cr = KafkaTestUtils.getSingleRecord(consumer, "counts-id");
			assertThat(cr.value()).isIn("Count for product with ID 123: 1", "Count for product with ID 123: 2");

			// Make sure the count can be retrieved from local state store
			ProductCountApplication.Foo foo = context.getBean(ProductCountApplication.Foo.class);
			assertThat(foo.getProductStock(123)).isIn(1L, 2L);
		}
	}

	@EnableAutoConfiguration
	public static class ProductCountApplication {

		@Bean
		public Function<KStream<Object, Product>, KStream<?, String>> process() {

			return input -> input.filter((key, product) -> product.getId() == 123)
					.map((key, value) -> new KeyValue<>(value.id, value))
					.groupByKey(Grouped.with(new Serdes.IntegerSerde(),
							new JacksonJsonSerde<>(Product.class)))
					.count(Materialized.as("prod-id-count-store")).toStream()
					.map((key, value) -> new KeyValue<>(null, "Count for product with ID 123: " + value));
		}

		@Bean
		public Foo foo(InteractiveQueryService interactiveQueryService) {
			return new Foo(interactiveQueryService);
		}

		@Bean
		public CleanupConfig cleanupConfig() {
			return new CleanupConfig(false, true);
		}

		static class Foo {

			InteractiveQueryService interactiveQueryService;

			Foo(InteractiveQueryService interactiveQueryService) {
				this.interactiveQueryService = interactiveQueryService;
			}

			public Long getProductStock(Integer id) {
				ReadOnlyKeyValueStore<Object, Object> keyValueStore = interactiveQueryService
						.getQueryableStore("prod-id-count-store",
								QueryableStoreTypes.keyValueStore());

				return (Long) keyValueStore.get(id);
			}

		}
	}

	static class Product {

		Integer id;

		public Integer getId() {
			return id;
		}

		public void setId(Integer id) {
			this.id = id;
		}

	}

}