Merge pull request #13926 from schCRABicus
* pr/13926: Polish "Add reactive health indicator for Couchbase" Add reactive health indicator for Couchbasepull/11125/merge
Stephane Nicoll
6 years ago
commit
3e4631011a
@ -0,0 +1,69 @@
|
||||
/*
|
||||
* Copyright 2012-2018 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
|
||||
*
|
||||
* http://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.actuate.autoconfigure.couchbase;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
import org.springframework.boot.actuate.autoconfigure.health.CompositeHealthIndicatorConfiguration;
|
||||
import org.springframework.boot.actuate.couchbase.CouchbaseHealthIndicator;
|
||||
import org.springframework.boot.actuate.health.HealthIndicator;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
|
||||
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.data.couchbase.core.CouchbaseOperations;
|
||||
|
||||
/**
|
||||
* Configuration for {@link CouchbaseHealthIndicator}.
|
||||
*
|
||||
* @author Eddú Meléndez
|
||||
* @author Stephane Nicoll
|
||||
* @since 2.0.0
|
||||
*/
|
||||
@Configuration
|
||||
@ConditionalOnClass(CouchbaseOperations.class)
|
||||
@ConditionalOnBean(CouchbaseOperations.class)
|
||||
@EnableConfigurationProperties(CouchbaseHealthIndicatorProperties.class)
|
||||
public class CouchbaseHealthIndicatorConfiguration extends
|
||||
CompositeHealthIndicatorConfiguration<CouchbaseHealthIndicator, CouchbaseOperations> {
|
||||
|
||||
private final Map<String, CouchbaseOperations> couchbaseOperations;
|
||||
|
||||
private final CouchbaseHealthIndicatorProperties properties;
|
||||
|
||||
CouchbaseHealthIndicatorConfiguration(
|
||||
Map<String, CouchbaseOperations> couchbaseOperations,
|
||||
CouchbaseHealthIndicatorProperties properties) {
|
||||
this.couchbaseOperations = couchbaseOperations;
|
||||
this.properties = properties;
|
||||
}
|
||||
|
||||
@Bean
|
||||
@ConditionalOnMissingBean(name = "couchbaseHealthIndicator")
|
||||
public HealthIndicator couchbaseHealthIndicator() {
|
||||
return createHealthIndicator(this.couchbaseOperations);
|
||||
}
|
||||
|
||||
@Override
|
||||
protected CouchbaseHealthIndicator createHealthIndicator(
|
||||
CouchbaseOperations couchbaseOperations) {
|
||||
return new CouchbaseHealthIndicator(couchbaseOperations,
|
||||
this.properties.getTimeout());
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,71 @@
|
||||
/*
|
||||
* Copyright 2012-2018 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
|
||||
*
|
||||
* http://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.actuate.autoconfigure.couchbase;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
import reactor.core.publisher.Flux;
|
||||
|
||||
import org.springframework.boot.actuate.autoconfigure.health.CompositeReactiveHealthIndicatorConfiguration;
|
||||
import org.springframework.boot.actuate.couchbase.CouchbaseReactiveHealthIndicator;
|
||||
import org.springframework.boot.actuate.health.ReactiveHealthIndicator;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
|
||||
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.data.couchbase.core.RxJavaCouchbaseOperations;
|
||||
|
||||
/**
|
||||
* Configuration for {@link CouchbaseReactiveHealthIndicator}.
|
||||
*
|
||||
* @author Mikalai Lushchytski
|
||||
* @author Stephane Nicoll
|
||||
* @since 2.1.0
|
||||
*/
|
||||
@Configuration
|
||||
@ConditionalOnClass({ RxJavaCouchbaseOperations.class, Flux.class })
|
||||
@ConditionalOnBean(RxJavaCouchbaseOperations.class)
|
||||
@EnableConfigurationProperties(CouchbaseHealthIndicatorProperties.class)
|
||||
public class CouchbaseReactiveHealthIndicatorConfiguration extends
|
||||
CompositeReactiveHealthIndicatorConfiguration<CouchbaseReactiveHealthIndicator, RxJavaCouchbaseOperations> {
|
||||
|
||||
private final Map<String, RxJavaCouchbaseOperations> couchbaseOperations;
|
||||
|
||||
private final CouchbaseHealthIndicatorProperties properties;
|
||||
|
||||
CouchbaseReactiveHealthIndicatorConfiguration(
|
||||
Map<String, RxJavaCouchbaseOperations> couchbaseOperations,
|
||||
CouchbaseHealthIndicatorProperties properties) {
|
||||
this.couchbaseOperations = couchbaseOperations;
|
||||
this.properties = properties;
|
||||
}
|
||||
|
||||
@Bean
|
||||
@ConditionalOnMissingBean(name = "couchbaseReactiveHealthIndicator")
|
||||
public ReactiveHealthIndicator couchbaseReactiveHealthIndicator() {
|
||||
return createHealthIndicator(this.couchbaseOperations);
|
||||
}
|
||||
|
||||
@Override
|
||||
protected CouchbaseReactiveHealthIndicator createHealthIndicator(
|
||||
RxJavaCouchbaseOperations couchbaseOperations) {
|
||||
return new CouchbaseReactiveHealthIndicator(couchbaseOperations,
|
||||
this.properties.getTimeout());
|
||||
}
|
||||
|
||||
}
|
||||
17
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/couchbase/CouchbaseHealthIndicatorAutoConfigurationTests.java → spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/couchbase/CouchbaseHealthIndicatorConfigurationTests.java
17
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/couchbase/CouchbaseHealthIndicatorAutoConfigurationTests.java → spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/couchbase/CouchbaseHealthIndicatorConfigurationTests.java
@ -0,0 +1,85 @@
|
||||
/*
|
||||
* Copyright 2012-2018 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
|
||||
*
|
||||
* http://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.actuate.autoconfigure.couchbase;
|
||||
|
||||
import java.time.Duration;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import org.springframework.boot.actuate.autoconfigure.health.HealthIndicatorAutoConfiguration;
|
||||
import org.springframework.boot.actuate.couchbase.CouchbaseHealthIndicator;
|
||||
import org.springframework.boot.actuate.couchbase.CouchbaseReactiveHealthIndicator;
|
||||
import org.springframework.boot.actuate.health.ApplicationHealthIndicator;
|
||||
import org.springframework.boot.autoconfigure.AutoConfigurations;
|
||||
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.data.couchbase.core.RxJavaCouchbaseOperations;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.mockito.Mockito.mock;
|
||||
|
||||
/**
|
||||
* Tests for {@link CouchbaseReactiveHealthIndicatorConfiguration}.
|
||||
*
|
||||
* @author Mikalai Lushchytski
|
||||
*/
|
||||
public class CouchbaseReactiveHealthIndicatorConfigurationTests {
|
||||
|
||||
private ApplicationContextRunner contextRunner = new ApplicationContextRunner()
|
||||
.withUserConfiguration(CouchbaseMockConfiguration.class).withConfiguration(
|
||||
AutoConfigurations.of(CouchbaseHealthIndicatorAutoConfiguration.class,
|
||||
HealthIndicatorAutoConfiguration.class));
|
||||
|
||||
@Test
|
||||
public void runShouldCreateIndicator() {
|
||||
this.contextRunner.run((context) -> assertThat(context)
|
||||
.hasSingleBean(CouchbaseReactiveHealthIndicator.class)
|
||||
.doesNotHaveBean(CouchbaseHealthIndicator.class)
|
||||
.doesNotHaveBean(ApplicationHealthIndicator.class));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void runWithCustomTimeoutShouldCreateIndicator() {
|
||||
this.contextRunner.withPropertyValues("management.health.couchbase.timeout=2s")
|
||||
.run((context) -> {
|
||||
assertThat(context)
|
||||
.hasSingleBean(CouchbaseReactiveHealthIndicator.class);
|
||||
assertThat(context.getBean(CouchbaseReactiveHealthIndicator.class))
|
||||
.hasFieldOrPropertyWithValue("timeout",
|
||||
Duration.ofSeconds(2));
|
||||
});
|
||||
}
|
||||
|
||||
@Test
|
||||
public void runWhenDisabledShouldNotCreateIndicator() {
|
||||
this.contextRunner.withPropertyValues("management.health.couchbase.enabled:false")
|
||||
.run((context) -> assertThat(context)
|
||||
.doesNotHaveBean(CouchbaseReactiveHealthIndicator.class)
|
||||
.hasSingleBean(ApplicationHealthIndicator.class));
|
||||
}
|
||||
|
||||
@Configuration
|
||||
protected static class CouchbaseMockConfiguration {
|
||||
|
||||
@Bean
|
||||
public RxJavaCouchbaseOperations couchbaseOperations() {
|
||||
return mock(RxJavaCouchbaseOperations.class);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,74 @@
|
||||
/*
|
||||
* Copyright 2012-2018 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
|
||||
*
|
||||
* http://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.actuate.couchbase;
|
||||
|
||||
import java.time.Duration;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
|
||||
import com.couchbase.client.java.bucket.BucketInfo;
|
||||
import com.couchbase.client.java.cluster.ClusterInfo;
|
||||
import reactor.core.publisher.Mono;
|
||||
import rx.Observable;
|
||||
import rx.RxReactiveStreams;
|
||||
import rx.Single;
|
||||
|
||||
import org.springframework.boot.actuate.health.AbstractReactiveHealthIndicator;
|
||||
import org.springframework.boot.actuate.health.Health;
|
||||
import org.springframework.boot.actuate.health.ReactiveHealthIndicator;
|
||||
import org.springframework.data.couchbase.core.RxJavaCouchbaseOperations;
|
||||
import org.springframework.util.StringUtils;
|
||||
|
||||
/**
|
||||
* A {@link ReactiveHealthIndicator} for Couchbase.
|
||||
*
|
||||
* @author Mikalai Lushchytski
|
||||
* @author Stephane Nicoll
|
||||
* @since 2.1.0
|
||||
*/
|
||||
public class CouchbaseReactiveHealthIndicator extends AbstractReactiveHealthIndicator {
|
||||
|
||||
private final RxJavaCouchbaseOperations couchbaseOperations;
|
||||
|
||||
private final Duration timeout;
|
||||
|
||||
/**
|
||||
* Create a new {@link CouchbaseReactiveHealthIndicator} instance.
|
||||
* @param couchbaseOperations the reactive couchbase operations
|
||||
* @param timeout the request timeout
|
||||
*/
|
||||
public CouchbaseReactiveHealthIndicator(RxJavaCouchbaseOperations couchbaseOperations,
|
||||
Duration timeout) {
|
||||
this.couchbaseOperations = couchbaseOperations;
|
||||
this.timeout = timeout;
|
||||
}
|
||||
|
||||
@Override
|
||||
protected Mono<Health> doHealthCheck(Health.Builder builder) {
|
||||
ClusterInfo cluster = this.couchbaseOperations.getCouchbaseClusterInfo();
|
||||
String versions = StringUtils
|
||||
.collectionToCommaDelimitedString(cluster.getAllVersions());
|
||||
Observable<BucketInfo> bucket = this.couchbaseOperations.getCouchbaseBucket()
|
||||
.bucketManager().async().info()
|
||||
.timeout(this.timeout.toMillis(), TimeUnit.MILLISECONDS);
|
||||
Single<Health> health = bucket.map(BucketInfo::nodeList)
|
||||
.map(StringUtils::collectionToCommaDelimitedString)
|
||||
.map((nodes) -> builder.up().withDetail("versions", versions)
|
||||
.withDetail("nodes", nodes).build())
|
||||
.toSingle();
|
||||
return Mono.from(RxReactiveStreams.toPublisher(health));
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,127 @@
|
||||
/*
|
||||
* Copyright 2012-2018 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
|
||||
*
|
||||
* http://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.actuate.couchbase;
|
||||
|
||||
import java.net.InetAddress;
|
||||
import java.time.Duration;
|
||||
import java.util.Arrays;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
import java.util.concurrent.TimeoutException;
|
||||
|
||||
import com.couchbase.client.java.Bucket;
|
||||
import com.couchbase.client.java.bucket.AsyncBucketManager;
|
||||
import com.couchbase.client.java.bucket.BucketInfo;
|
||||
import com.couchbase.client.java.bucket.BucketManager;
|
||||
import com.couchbase.client.java.cluster.ClusterInfo;
|
||||
import com.couchbase.client.java.error.TranscodingException;
|
||||
import com.couchbase.client.java.util.features.Version;
|
||||
import org.junit.Test;
|
||||
import reactor.core.publisher.Mono;
|
||||
import reactor.test.StepVerifier;
|
||||
import rx.Observable;
|
||||
|
||||
import org.springframework.boot.actuate.health.Health;
|
||||
import org.springframework.boot.actuate.health.Status;
|
||||
import org.springframework.data.couchbase.core.RxJavaCouchbaseOperations;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.mockito.BDDMockito.given;
|
||||
import static org.mockito.Mockito.mock;
|
||||
|
||||
/**
|
||||
* Tests for {@link CouchbaseReactiveHealthIndicator}.
|
||||
*/
|
||||
public class CouchbaseReactiveHealthIndicatorTests {
|
||||
|
||||
@Test
|
||||
public void couchbaseIsUp() {
|
||||
RxJavaCouchbaseOperations rxJavaCouchbaseOperations = mock(
|
||||
RxJavaCouchbaseOperations.class);
|
||||
AsyncBucketManager asyncBucketManager = mockAsyncBucketManager(
|
||||
rxJavaCouchbaseOperations);
|
||||
BucketInfo info = mock(BucketInfo.class);
|
||||
InetAddress node1Address = mock(InetAddress.class);
|
||||
InetAddress node2Address = mock(InetAddress.class);
|
||||
given(info.nodeList()).willReturn(Arrays.asList(node1Address, node2Address));
|
||||
given(node1Address.toString()).willReturn("127.0.0.1");
|
||||
given(node2Address.toString()).willReturn("127.0.0.2");
|
||||
given(asyncBucketManager.info()).willReturn(Observable.just(info));
|
||||
CouchbaseReactiveHealthIndicator couchbaseReactiveHealthIndicator = new CouchbaseReactiveHealthIndicator(
|
||||
rxJavaCouchbaseOperations, Duration.ofSeconds(2));
|
||||
Mono<Health> health = couchbaseReactiveHealthIndicator.health();
|
||||
StepVerifier.create(health).consumeNextWith((h) -> {
|
||||
assertThat(h.getStatus()).isEqualTo(Status.UP);
|
||||
assertThat(h.getDetails()).containsKeys("versions", "nodes");
|
||||
assertThat(h.getDetails().get("versions")).isEqualTo("5.5.0,6.0.0");
|
||||
assertThat(h.getDetails().get("nodes")).isEqualTo("127.0.0.1,127.0.0.2");
|
||||
}).verifyComplete();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void couchbaseTimeout() {
|
||||
RxJavaCouchbaseOperations rxJavaCouchbaseOperations = mock(
|
||||
RxJavaCouchbaseOperations.class);
|
||||
AsyncBucketManager asyncBucketManager = mockAsyncBucketManager(
|
||||
rxJavaCouchbaseOperations);
|
||||
given(asyncBucketManager.info()).willReturn(
|
||||
Observable.just(mock(BucketInfo.class)).delay(20, TimeUnit.MILLISECONDS));
|
||||
CouchbaseReactiveHealthIndicator couchbaseReactiveHealthIndicator = new CouchbaseReactiveHealthIndicator(
|
||||
rxJavaCouchbaseOperations, Duration.ofMillis(10));
|
||||
Mono<Health> health = couchbaseReactiveHealthIndicator.health();
|
||||
StepVerifier.create(health).consumeNextWith((h) -> {
|
||||
assertThat(h.getStatus()).isEqualTo(Status.DOWN);
|
||||
assertThat(h.getDetails()).containsOnlyKeys("error");
|
||||
assertThat(h.getDetails().get("error")).asString()
|
||||
.contains(TimeoutException.class.getName());
|
||||
}).verifyComplete();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void couchbaseIsDown() {
|
||||
RxJavaCouchbaseOperations rxJavaCouchbaseOperations = mock(
|
||||
RxJavaCouchbaseOperations.class);
|
||||
AsyncBucketManager asyncBucketManager = mockAsyncBucketManager(
|
||||
rxJavaCouchbaseOperations);
|
||||
given(asyncBucketManager.info())
|
||||
.willReturn(Observable.error(new TranscodingException("Failure")));
|
||||
CouchbaseReactiveHealthIndicator couchbaseReactiveHealthIndicator = new CouchbaseReactiveHealthIndicator(
|
||||
rxJavaCouchbaseOperations, Duration.ofSeconds(2));
|
||||
Mono<Health> health = couchbaseReactiveHealthIndicator.health();
|
||||
StepVerifier.create(health).consumeNextWith((h) -> {
|
||||
assertThat(h.getStatus()).isEqualTo(Status.DOWN);
|
||||
assertThat(h.getDetails()).containsOnlyKeys("error");
|
||||
assertThat(h.getDetails().get("error"))
|
||||
.isEqualTo(TranscodingException.class.getName() + ": Failure");
|
||||
}).verifyComplete();
|
||||
}
|
||||
|
||||
private AsyncBucketManager mockAsyncBucketManager(
|
||||
RxJavaCouchbaseOperations rxJavaCouchbaseOperations) {
|
||||
ClusterInfo clusterInfo = mock(ClusterInfo.class);
|
||||
given(rxJavaCouchbaseOperations.getCouchbaseClusterInfo())
|
||||
.willReturn(clusterInfo);
|
||||
given(clusterInfo.getAllVersions())
|
||||
.willReturn(Arrays.asList(new Version(5, 5, 0), new Version(6, 0, 0)));
|
||||
Bucket bucket = mock(Bucket.class);
|
||||
BucketManager bucketManager = mock(BucketManager.class);
|
||||
AsyncBucketManager asyncBucketManager = mock(AsyncBucketManager.class);
|
||||
given(rxJavaCouchbaseOperations.getCouchbaseBucket()).willReturn(bucket);
|
||||
given(bucket.bucketManager()).willReturn(bucketManager);
|
||||
given(bucketManager.async()).willReturn(asyncBucketManager);
|
||||
return asyncBucketManager;
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue