Skip to content

Commit

Permalink
Polish "Mark Redis as down when cluster_state is fail"
Browse files Browse the repository at this point in the history 
See gh-27300
  • Loading branch information
@wilkinsona
wilkinsona committed Jul 13, 2021
1 parent f31141d commit 49baacb
Show file tree
Hide file tree
Showing 5 changed files with 93 additions and 94 deletions.
7 changes: 4 additions & 3 deletions ...pring-boot-actuator/src/main/java/org/springframework/boot/actuate/redis/RedisHealth.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2021 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.
Expand Down Expand Up @@ -38,14 +38,15 @@ static Builder up(Health.Builder builder, Properties info) {
return builder.up();
}

static Builder info(Health.Builder builder, ClusterInfo clusterInfo) {
static Builder fromClusterInfo(Health.Builder builder, ClusterInfo clusterInfo) {
builder.withDetail("cluster_size", clusterInfo.getClusterSize());
builder.withDetail("slots_up", clusterInfo.getSlotsOk());
builder.withDetail("slots_fail", clusterInfo.getSlotsFail());

if ("fail".equalsIgnoreCase(clusterInfo.getState())) {
return builder.down();
} else {
}
else {
return builder.up();
}
}
Expand Down
4 changes: 2 additions & 2 deletions ...t-actuator/src/main/java/org/springframework/boot/actuate/redis/RedisHealthIndicator.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2021 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.
Expand Down Expand Up @@ -57,7 +57,7 @@ protected void doHealthCheck(Health.Builder builder) throws Exception {

private void doHealthCheck(Health.Builder builder, RedisConnection connection) {
if (connection instanceof RedisClusterConnection) {
RedisHealth.info(builder, ((RedisClusterConnection) connection).clusterGetClusterInfo());
RedisHealth.fromClusterInfo(builder, ((RedisClusterConnection) connection).clusterGetClusterInfo());
}
else {
RedisHealth.up(builder, connection.info("server"));
Expand Down
8 changes: 4 additions & 4 deletions ...or/src/main/java/org/springframework/boot/actuate/redis/RedisReactiveHealthIndicator.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2021 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.
Expand Down Expand Up @@ -65,7 +65,7 @@ private Mono<Health> doHealthCheck(Health.Builder builder, ReactiveRedisConnecti
private Mono<Health> getHealth(Health.Builder builder, ReactiveRedisConnection connection) {
if (connection instanceof ReactiveRedisClusterConnection) {
return ((ReactiveRedisClusterConnection) connection).clusterGetClusterInfo()
.map(info -> info(builder, info));
.map((info) -> fromClusterInfo(builder, info));
}
return connection.serverCommands().info("server").map((info) -> up(builder, info));
}
Expand All @@ -74,8 +74,8 @@ private Health up(Health.Builder builder, Properties info) {
return RedisHealth.up(builder, info).build();
}

private Health info(Health.Builder builder, ClusterInfo clusterInfo) {
return RedisHealth.info(builder, clusterInfo).build();
private Health fromClusterInfo(Health.Builder builder, ClusterInfo clusterInfo) {
return RedisHealth.fromClusterInfo(builder, clusterInfo).build();
}

}
82 changes: 41 additions & 41 deletions ...uator/src/test/java/org/springframework/boot/actuate/redis/RedisHealthIndicatorTests.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2021 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.
Expand Down Expand Up @@ -68,22 +68,11 @@ void redisIsDown() {
assertThat((String) health.getDetails().get("error")).contains("Connection failed");
}

private RedisHealthIndicator createHealthIndicator(RedisConnection redisConnection) {
RedisConnectionFactory redisConnectionFactory = mock(RedisConnectionFactory.class);
given(redisConnectionFactory.getConnection()).willReturn(redisConnection);
return new RedisHealthIndicator(redisConnectionFactory);
}

@Test
void redisClusterIsUpWithoutState() {
final Properties clusterProperties = new Properties();
clusterProperties.setProperty("cluster_size", "4");
clusterProperties.setProperty("cluster_slots_ok", "4");
clusterProperties.setProperty("cluster_slots_fail", "0");
final RedisConnectionFactory redisConnectionFactory = mockRedisClusterConnectionFactory(clusterProperties);

final RedisHealthIndicator healthIndicator = new RedisHealthIndicator(redisConnectionFactory);
final Health health = healthIndicator.health();
void healthWhenClusterStateIsAbsentShouldBeUp() {
RedisConnectionFactory redisConnectionFactory = createClusterConnectionFactory(null);
RedisHealthIndicator healthIndicator = new RedisHealthIndicator(redisConnectionFactory);
Health health = healthIndicator.health();
assertThat(health.getStatus()).isEqualTo(Status.UP);
assertThat(health.getDetails().get("cluster_size")).isEqualTo(4L);
assertThat(health.getDetails().get("slots_up")).isEqualTo(4L);
Expand All @@ -92,41 +81,52 @@ void redisClusterIsUpWithoutState() {
}

@Test
void redisClusterIsUpWithState() {
final Properties clusterProperties = new Properties();
clusterProperties.setProperty("cluster_state", "ok");
clusterProperties.setProperty("cluster_size", "4");
clusterProperties.setProperty("cluster_slots_ok", "4");
clusterProperties.setProperty("cluster_slots_fail", "0");
final RedisConnectionFactory redisConnectionFactory = mockRedisClusterConnectionFactory(clusterProperties);

final RedisHealthIndicator healthIndicator = new RedisHealthIndicator(redisConnectionFactory);
final Health health = healthIndicator.health();
void healthWhenClusterStateIsOkShouldBeUp() {
RedisConnectionFactory redisConnectionFactory = createClusterConnectionFactory("ok");
RedisHealthIndicator healthIndicator = new RedisHealthIndicator(redisConnectionFactory);
Health health = healthIndicator.health();
assertThat(health.getStatus()).isEqualTo(Status.UP);
assertThat(health.getDetails().get("cluster_size")).isEqualTo(4L);
assertThat(health.getDetails().get("slots_up")).isEqualTo(4L);
assertThat(health.getDetails().get("slots_fail")).isEqualTo(0L);
verify(redisConnectionFactory, atLeastOnce()).getConnection();
}

@Test
void redisClusterIsDown() {
final Properties clusterProperties = new Properties();
clusterProperties.setProperty("cluster_state", "fail");
clusterProperties.setProperty("cluster_size", "3");
clusterProperties.setProperty("cluster_slots_ok", "4");
clusterProperties.setProperty("cluster_slots_fail", "0");
final RedisConnectionFactory redisConnectionFactory = mockRedisClusterConnectionFactory(clusterProperties);

final RedisHealthIndicator healthIndicator = new RedisHealthIndicator(redisConnectionFactory);
final Health health = healthIndicator.health();
void healthWhenClusterStateIsFailShouldBeDown() {
RedisConnectionFactory redisConnectionFactory = createClusterConnectionFactory("fail");
RedisHealthIndicator healthIndicator = new RedisHealthIndicator(redisConnectionFactory);
Health health = healthIndicator.health();
assertThat(health.getStatus()).isEqualTo(Status.DOWN);
assertThat(health.getDetails().get("cluster_size")).isEqualTo(4L);
assertThat(health.getDetails().get("slots_up")).isEqualTo(3L);
assertThat(health.getDetails().get("slots_fail")).isEqualTo(1L);
verify(redisConnectionFactory, atLeastOnce()).getConnection();
}

private RedisHealthIndicator createHealthIndicator(RedisConnection redisConnection) {
RedisConnectionFactory redisConnectionFactory = mock(RedisConnectionFactory.class);
given(redisConnectionFactory.getConnection()).willReturn(redisConnection);
return new RedisHealthIndicator(redisConnectionFactory);
}

private static RedisConnectionFactory mockRedisClusterConnectionFactory(Properties clusterProperties) {
final List<RedisClusterNode> redisMasterNodes = Arrays.asList(new RedisClusterNode("127.0.0.1", 7001),
new RedisClusterNode("127.0.0.2", 7001));
final RedisClusterConnection redisConnection = mock(RedisClusterConnection.class);
private RedisConnectionFactory createClusterConnectionFactory(String state) {
Properties clusterProperties = new Properties();
if (state != null) {
clusterProperties.setProperty("cluster_state", state);
}
clusterProperties.setProperty("cluster_size", "4");
boolean failure = "fail".equals(state);
clusterProperties.setProperty("cluster_slots_ok", failure ? "3" : "4");
clusterProperties.setProperty("cluster_slots_fail", failure ? "1" : "0");
List<RedisClusterNode> redisMasterNodes = Arrays.asList(new RedisClusterNode("127.0.0.1", 7001),
new RedisClusterNode("127.0.0.2", 7001));
RedisClusterConnection redisConnection = mock(RedisClusterConnection.class);
given(redisConnection.clusterGetNodes()).willReturn(redisMasterNodes);
given(redisConnection.clusterGetClusterInfo()).willReturn(new ClusterInfo(clusterProperties));
final RedisConnectionFactory redisConnectionFactory = mock(RedisConnectionFactory.class);
RedisConnectionFactory redisConnectionFactory = mock(RedisConnectionFactory.class);
given(redisConnectionFactory.getConnection()).willReturn(redisConnection);
return redisConnectionFactory;
}

}
86 changes: 42 additions & 44 deletions ...c/test/java/org/springframework/boot/actuate/redis/RedisReactiveHealthIndicatorTests.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2021 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.
Expand All @@ -16,14 +16,13 @@

package org.springframework.boot.actuate.redis;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;

import java.util.Properties;

import io.lettuce.core.RedisConnectionException;
import org.junit.jupiter.api.Test;
import reactor.core.publisher.Mono;
import reactor.test.StepVerifier;

import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.Status;
import org.springframework.data.redis.RedisConnectionFailureException;
Expand All @@ -33,9 +32,10 @@
import org.springframework.data.redis.connection.ReactiveRedisConnectionFactory;
import org.springframework.data.redis.connection.ReactiveServerCommands;

import io.lettuce.core.RedisConnectionException;
import reactor.core.publisher.Mono;
import reactor.test.StepVerifier;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;

/**
* Tests for {@link RedisReactiveHealthIndicator}.
Expand Down Expand Up @@ -67,16 +67,11 @@ void redisIsUp() {
}

@Test
void redisClusterIsUpWithoutState() {
final Properties clusterProperties = new Properties();
clusterProperties.setProperty("cluster_size", "4");
clusterProperties.setProperty("cluster_slots_ok", "4");
clusterProperties.setProperty("cluster_slots_fail", "0");
final ReactiveRedisConnectionFactory redisConnectionFactory = mockRedisClusterConnectionFactory(clusterProperties);

final RedisReactiveHealthIndicator healthIndicator = new RedisReactiveHealthIndicator(redisConnectionFactory);
final Mono<Health> health = healthIndicator.health();
StepVerifier.create(health).consumeNextWith(h -> {
void healthWhenClusterStateIsAbsentShouldBeUp() {
ReactiveRedisConnectionFactory redisConnectionFactory = createClusterConnectionFactory(null);
RedisReactiveHealthIndicator healthIndicator = new RedisReactiveHealthIndicator(redisConnectionFactory);
Mono<Health> health = healthIndicator.health();
StepVerifier.create(health).consumeNextWith((h) -> {
assertThat(h.getStatus()).isEqualTo(Status.UP);
assertThat(h.getDetails().get("cluster_size")).isEqualTo(4L);
assertThat(h.getDetails().get("slots_up")).isEqualTo(4L);
Expand All @@ -86,34 +81,29 @@ void redisClusterIsUpWithoutState() {
}

@Test
void redisClusterIsUpWithState() {
final Properties clusterProperties = new Properties();
clusterProperties.setProperty("cluster_state", "ok");
clusterProperties.setProperty("cluster_size", "4");
clusterProperties.setProperty("cluster_slots_ok", "4");
clusterProperties.setProperty("cluster_slots_fail", "0");
final ReactiveRedisConnectionFactory redisConnectionFactory = mockRedisClusterConnectionFactory(clusterProperties);

final RedisReactiveHealthIndicator healthIndicator = new RedisReactiveHealthIndicator(redisConnectionFactory);
final Mono<Health> health = healthIndicator.health();
StepVerifier.create(health).consumeNextWith(h -> {
void healthWhenClusterStateIsOkShouldBeUp() {
ReactiveRedisConnectionFactory redisConnectionFactory = createClusterConnectionFactory("ok");
RedisReactiveHealthIndicator healthIndicator = new RedisReactiveHealthIndicator(redisConnectionFactory);
Mono<Health> health = healthIndicator.health();
StepVerifier.create(health).consumeNextWith((h) -> {
assertThat(h.getStatus()).isEqualTo(Status.UP);
assertThat(h.getDetails().get("cluster_size")).isEqualTo(4L);
assertThat(h.getDetails().get("slots_up")).isEqualTo(4L);
assertThat(h.getDetails().get("slots_fail")).isEqualTo(0L);
}).verifyComplete();
}

@Test
void redisClusterIsDown() {
final Properties clusterProperties = new Properties();
void healthWhenClusterStateIsFailShouldBeDown() {
Properties clusterProperties = new Properties();
clusterProperties.setProperty("cluster_state", "fail");
clusterProperties.setProperty("cluster_size", "3");
clusterProperties.setProperty("cluster_slots_ok", "4");
clusterProperties.setProperty("cluster_slots_fail", "0");
final ReactiveRedisConnectionFactory redisConnectionFactory = mockRedisClusterConnectionFactory(clusterProperties);

final RedisReactiveHealthIndicator healthIndicator = new RedisReactiveHealthIndicator(redisConnectionFactory);
final Mono<Health> health = healthIndicator.health();
StepVerifier.create(health).consumeNextWith(h -> {
ReactiveRedisConnectionFactory redisConnectionFactory = createClusterConnectionFactory("fail");
RedisReactiveHealthIndicator healthIndicator = new RedisReactiveHealthIndicator(redisConnectionFactory);
Mono<Health> health = healthIndicator.health();
StepVerifier.create(health).consumeNextWith((h) -> {
assertThat(h.getStatus()).isEqualTo(Status.DOWN);
assertThat(h.getDetails().get("slots_up")).isEqualTo(3L);
assertThat(h.getDetails().get("slots_fail")).isEqualTo(1L);
}).verifyComplete();
}

Expand Down Expand Up @@ -143,19 +133,27 @@ void redisConnectionIsDown() {

private RedisReactiveHealthIndicator createHealthIndicator(ReactiveRedisConnection redisConnection,
ReactiveServerCommands serverCommands) {

ReactiveRedisConnectionFactory redisConnectionFactory = mock(ReactiveRedisConnectionFactory.class);
given(redisConnectionFactory.getReactiveConnection()).willReturn(redisConnection);
given(redisConnection.serverCommands()).willReturn(serverCommands);
return new RedisReactiveHealthIndicator(redisConnectionFactory);
}

private static ReactiveRedisConnectionFactory mockRedisClusterConnectionFactory(Properties clusterProperties) {
final ReactiveRedisClusterConnection redisConnection = mock(ReactiveRedisClusterConnection.class);
private ReactiveRedisConnectionFactory createClusterConnectionFactory(String state) {
Properties clusterProperties = new Properties();
if (state != null) {
clusterProperties.setProperty("cluster_state", state);
}
clusterProperties.setProperty("cluster_size", "4");
boolean failure = "fail".equals(state);
clusterProperties.setProperty("cluster_slots_ok", failure ? "3" : "4");
clusterProperties.setProperty("cluster_slots_fail", failure ? "1" : "0");
ReactiveRedisClusterConnection redisConnection = mock(ReactiveRedisClusterConnection.class);
given(redisConnection.closeLater()).willReturn(Mono.empty());
given(redisConnection.clusterGetClusterInfo()).willReturn(Mono.just(new ClusterInfo(clusterProperties)));
final ReactiveRedisConnectionFactory redisConnectionFactory = mock(ReactiveRedisConnectionFactory.class);
ReactiveRedisConnectionFactory redisConnectionFactory = mock(ReactiveRedisConnectionFactory.class);
given(redisConnectionFactory.getReactiveConnection()).willReturn(redisConnection);
return redisConnectionFactory;
}

}

0 comments on commit 49baacb

Please sign in to comment.