Add support for Elasticsearch Sniffer

spring-boot-project/spring-boot-autoconfigure/build.gradle

@@ -77,6 +77,7 @@ dependencies {
 	optional("org.ehcache:ehcache")
 	optional("org.elasticsearch.client:elasticsearch-rest-client")
 	optional("org.elasticsearch.client:elasticsearch-rest-high-level-client")
+	optional("org.elasticsearch.client:elasticsearch-rest-client-sniffer")
 	optional("org.flywaydb:flyway-core")
 	optional("org.freemarker:freemarker")
 	optional("org.glassfish.jersey.core:jersey-server")

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/elasticsearch/sniff/ElasticsearchSnifferAutoConfiguration.java

@@ -0,0 +1,78 @@
+/*
+ * Copyright 2012-2020 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.boot.autoconfigure.elasticsearch.sniff;
+
+import org.elasticsearch.client.RestClient;
+import org.elasticsearch.client.RestHighLevelClient;
+import org.elasticsearch.client.sniff.Sniffer;
+import org.elasticsearch.client.sniff.SnifferBuilder;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.boot.context.properties.PropertyMapper;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import java.time.Duration;
+
+/**
+ * {@link EnableAutoConfiguration Auto-configuration} for Elasticsearch Sniffer.
+ *
+ * @since
+ */
+@Configuration(proxyBeanMethods = false)
+@ConditionalOnClass(RestHighLevelClient.class)
+@ConditionalOnMissingBean(RestClient.class)
+@EnableConfigurationProperties(ElasticsearchSnifferProperties.class)
+public class ElasticsearchSnifferAutoConfiguration {
+
+	@Configuration(proxyBeanMethods = false)
+	@ConditionalOnMissingBean(SnifferBuilder.class)
+	static class SnifferBuilderConfiguration {
+
+		@Bean
+		SnifferBuilderCustomizer defaultSnifferBuilderCustomizer(ElasticsearchSnifferProperties properties) {
+			return new DefaultSnifferBuilderCustomizer(properties);
+		}
+
+		@Bean
+		Sniffer elasticsearchSnifferBuilder(ElasticsearchSnifferProperties properties,
+											RestClient elasticsearchRestClient) {
+			return Sniffer.builder(elasticsearchRestClient).build();
+		}
+	}
+
+	static class DefaultSnifferBuilderCustomizer implements SnifferBuilderCustomizer {
+
+		private static final PropertyMapper map = PropertyMapper.get();
+
+		private final ElasticsearchSnifferProperties properties;
+
+		DefaultSnifferBuilderCustomizer(ElasticsearchSnifferProperties properties) {
+			this.properties = properties;
+		}
+
+		@Override
+		public void customize(SnifferBuilder builder) {
+			map.from(this.properties::getSniffIntervalMillis).whenNonNull().asInt(Duration::toMillis)
+					.to(builder::setSniffIntervalMillis);
+			map.from(this.properties::getSniffFailureDelayMillis).whenNonNull().asInt(Duration::toMillis)
+					.to(builder::setSniffAfterFailureDelayMillis);
+		}
+	}
+}

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/elasticsearch/sniff/ElasticsearchSnifferProperties.java

@@ -0,0 +1,58 @@
+/*
+ * Copyright 2012-2020 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.boot.autoconfigure.elasticsearch.sniff;
+
+import org.elasticsearch.client.sniff.NodesSniffer;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+import java.time.Duration;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+/**
+ * Configuration properties for Elasticsearch sniffer.
+ *
+ */
+@ConfigurationProperties(prefix = "spring.elasticsearch.sniff")
+public class ElasticsearchSnifferProperties {
+
+	/**
+	 * Sniffer interval millis
+	 */
+	private Duration sniffIntervalMillis = Duration.ofMillis(1L);
+	/**
+	 * Sniffer failure delay millis.
+	 */
+	private Duration sniffFailureDelayMillis = Duration.ofMillis(1L);
+
+	public Duration getSniffIntervalMillis() {
+		return sniffIntervalMillis;
+	}
+
+	public void setSniffIntervalMillis(Duration sniffIntervalMillis) {
+		this.sniffIntervalMillis = sniffIntervalMillis;
+	}
+
+	public Duration getSniffFailureDelayMillis() {
+		return sniffFailureDelayMillis;
+	}
+
+	public void setSniffFailureDelayMillis(Duration sniffFailureDelayMillis) {
+		this.sniffFailureDelayMillis = sniffFailureDelayMillis;
+	}
+}

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/elasticsearch/sniff/SnifferBuilderCustomizer.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2012-2020 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.boot.autoconfigure.elasticsearch.sniff;
+
+import org.apache.http.client.config.RequestConfig;
+import org.apache.http.impl.nio.client.HttpAsyncClientBuilder;
+import org.elasticsearch.client.RestClientBuilder;
+import org.elasticsearch.client.sniff.SnifferBuilder;
+
+/**
+ * Callback interface that can be implemented by beans wishing to further customize the
+ * {@link org.elasticsearch.client.sniff.Sniffer} via a {@link org.elasticsearch.client.sniff.SnifferBuilder} whilst
+ * retaining default auto-configuration.
+ *
+ */
+@FunctionalInterface
+public interface SnifferBuilderCustomizer {
+
+	/**
+	 * Customize the {@link org.elasticsearch.client.sniff.SnifferBuilder}.
+	 * <p>
+	 * Possibly overrides customizations made with the {@code "spring.elasticsearch.client.sniff"}
+	 * configuration properties namespace. For more targeted changes, see
+
+	 * @param builder the builder to customize
+	 */
+	void customize(SnifferBuilder builder);
+}

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/elasticsearch/sniff/ElasticsearchSnifferAutoConfigurationTests.java

@@ -0,0 +1,100 @@
+/*
+ * Copyright 2012-2020 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.boot.autoconfigure.elasticsearch.sniff;
+
+import org.apache.http.HttpHost;
+import org.apache.http.auth.AuthScope;
+import org.apache.http.auth.Credentials;
+import org.apache.http.client.CredentialsProvider;
+import org.apache.http.client.config.RequestConfig;
+import org.apache.http.impl.nio.client.HttpAsyncClientBuilder;
+import org.assertj.core.api.InstanceOfAssertFactories;
+import org.elasticsearch.action.get.GetRequest;
+import org.elasticsearch.action.index.IndexRequest;
+import org.elasticsearch.client.*;
+import org.elasticsearch.client.sniff.ElasticsearchNodesSniffer;
+import org.elasticsearch.client.sniff.NodesSniffer;
+import org.elasticsearch.client.sniff.Sniffer;
+import org.elasticsearch.client.sniff.SnifferBuilder;
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.autoconfigure.AutoConfigurations;
+import org.springframework.boot.autoconfigure.elasticsearch.ElasticsearchRestClientAutoConfiguration;
+import org.springframework.boot.autoconfigure.elasticsearch.sniff.SnifferBuilderCustomizer;
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.boot.testsupport.testcontainers.DockerImageNames;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.testcontainers.elasticsearch.ElasticsearchContainer;
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+
+import java.io.IOException;
+import java.time.Duration;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
+
+/**
+ * Tests for {@link org.springframework.boot.autoconfigure.elasticsearch.sniff.ElasticsearchSnifferAutoConfiguration}.
+ *
+ * @author Asha Somayajula
+ */
+@Testcontainers(disabledWithoutDocker = true)
+class ElasticsearchSnifferAutoConfigurationTests {
+
+	@Container
+	static final ElasticsearchContainer elasticsearch = new ElasticsearchContainer(DockerImageNames.elasticsearch())
+			.withStartupAttempts(5).withStartupTimeout(Duration.ofMinutes(10));
+
+	private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
+			.withConfiguration(AutoConfigurations.of(ElasticsearchRestClientAutoConfiguration.class));
+
+	@Test
+	void configureShouldOnlyCreateSnifferInstance() {
+		this.contextRunner.run((context) -> assertThat(context).doesNotHaveBean(RestClient.class)
+				.hasSingleBean(RestHighLevelClient.class));
+		this.contextRunner.run((context) -> assertThat(context).hasSingleBean(Sniffer.class));
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	static class BuilderCustomizerConfiguration {
+
+		@Bean
+		SnifferBuilderCustomizer myCustomizer() {
+			return new SnifferBuilderCustomizer() {
+
+				@Override
+				public void customize(SnifferBuilder builder) {
+					builder.setSniffAfterFailureDelayMillis(100);
+					builder.setSniffIntervalMillis(100);
+					NodesSniffer nodesSniffer = new NodesSniffer() {
+						@Override
+						public List<Node> sniff() throws IOException {
+							return null;
+						}
+					};
+
+					builder.setNodesSniffer(nodesSniffer);
+				}
+			};
+			};
+		}
+	}