diff --git a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/redis/RedisHealth.java b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/redis/RedisHealth.java index 028eafe9b23..943c2a19aa7 100644 --- a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/redis/RedisHealth.java +++ b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/redis/RedisHealth.java @@ -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. @@ -38,11 +38,17 @@ final class RedisHealth { return builder.up(); } - static Builder up(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()); - return builder.up(); + + if ("fail".equalsIgnoreCase(clusterInfo.getState())) { + return builder.down(); + } + else { + return builder.up(); + } } } diff --git a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/redis/RedisHealthIndicator.java b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/redis/RedisHealthIndicator.java index 569c850a923..63486870c23 100644 --- a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/redis/RedisHealthIndicator.java +++ b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/redis/RedisHealthIndicator.java @@ -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. @@ -57,7 +57,7 @@ public class RedisHealthIndicator extends AbstractHealthIndicator { private void doHealthCheck(Health.Builder builder, RedisConnection connection) { if (connection instanceof RedisClusterConnection) { - RedisHealth.up(builder, ((RedisClusterConnection) connection).clusterGetClusterInfo()); + RedisHealth.fromClusterInfo(builder, ((RedisClusterConnection) connection).clusterGetClusterInfo()); } else { RedisHealth.up(builder, connection.info("server")); diff --git a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/redis/RedisReactiveHealthIndicator.java b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/redis/RedisReactiveHealthIndicator.java index 757b1fd7919..e9155317082 100644 --- a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/redis/RedisReactiveHealthIndicator.java +++ b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/redis/RedisReactiveHealthIndicator.java @@ -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. @@ -65,7 +65,7 @@ public class RedisReactiveHealthIndicator extends AbstractReactiveHealthIndicato private Mono getHealth(Health.Builder builder, ReactiveRedisConnection connection) { if (connection instanceof ReactiveRedisClusterConnection) { return ((ReactiveRedisClusterConnection) connection).clusterGetClusterInfo() - .map((info) -> up(builder, info)); + .map((info) -> fromClusterInfo(builder, info)); } return connection.serverCommands().info("server").map((info) -> up(builder, info)); } @@ -74,8 +74,8 @@ public class RedisReactiveHealthIndicator extends AbstractReactiveHealthIndicato return RedisHealth.up(builder, info).build(); } - private Health up(Health.Builder builder, ClusterInfo clusterInfo) { - return RedisHealth.up(builder, clusterInfo).build(); + private Health fromClusterInfo(Health.Builder builder, ClusterInfo clusterInfo) { + return RedisHealth.fromClusterInfo(builder, clusterInfo).build(); } } diff --git a/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/redis/RedisHealthIndicatorTests.java b/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/redis/RedisHealthIndicatorTests.java index 592a0128303..0dfd4f2672d 100644 --- a/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/redis/RedisHealthIndicatorTests.java +++ b/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/redis/RedisHealthIndicatorTests.java @@ -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. @@ -68,25 +68,9 @@ class RedisHealthIndicatorTests { 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 redisClusterIsUp() { - Properties clusterProperties = new Properties(); - clusterProperties.setProperty("cluster_size", "4"); - clusterProperties.setProperty("cluster_slots_ok", "4"); - clusterProperties.setProperty("cluster_slots_fail", "0"); - List 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)); - RedisConnectionFactory redisConnectionFactory = mock(RedisConnectionFactory.class); - given(redisConnectionFactory.getConnection()).willReturn(redisConnection); + void healthWhenClusterStateIsAbsentShouldBeUp() { + RedisConnectionFactory redisConnectionFactory = createClusterConnectionFactory(null); RedisHealthIndicator healthIndicator = new RedisHealthIndicator(redisConnectionFactory); Health health = healthIndicator.health(); assertThat(health.getStatus()).isEqualTo(Status.UP); @@ -96,4 +80,53 @@ class RedisHealthIndicatorTests { verify(redisConnectionFactory, atLeastOnce()).getConnection(); } + @Test + 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 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 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 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)); + RedisConnectionFactory redisConnectionFactory = mock(RedisConnectionFactory.class); + given(redisConnectionFactory.getConnection()).willReturn(redisConnection); + return redisConnectionFactory; + } + } diff --git a/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/redis/RedisReactiveHealthIndicatorTests.java b/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/redis/RedisReactiveHealthIndicatorTests.java index 8452982dbdf..431cdf165e1 100644 --- a/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/redis/RedisReactiveHealthIndicatorTests.java +++ b/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/redis/RedisReactiveHealthIndicatorTests.java @@ -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. @@ -67,16 +67,8 @@ class RedisReactiveHealthIndicatorTests { } @Test - void redisClusterIsUp() { - Properties clusterProperties = new Properties(); - clusterProperties.setProperty("cluster_size", "4"); - clusterProperties.setProperty("cluster_slots_ok", "4"); - clusterProperties.setProperty("cluster_slots_fail", "0"); - ReactiveRedisClusterConnection redisConnection = mock(ReactiveRedisClusterConnection.class); - given(redisConnection.closeLater()).willReturn(Mono.empty()); - given(redisConnection.clusterGetClusterInfo()).willReturn(Mono.just(new ClusterInfo(clusterProperties))); - ReactiveRedisConnectionFactory redisConnectionFactory = mock(ReactiveRedisConnectionFactory.class); - given(redisConnectionFactory.getReactiveConnection()).willReturn(redisConnection); + void healthWhenClusterStateIsAbsentShouldBeUp() { + ReactiveRedisConnectionFactory redisConnectionFactory = createClusterConnectionFactory(null); RedisReactiveHealthIndicator healthIndicator = new RedisReactiveHealthIndicator(redisConnectionFactory); Mono health = healthIndicator.health(); StepVerifier.create(health).consumeNextWith((h) -> { @@ -85,7 +77,34 @@ class RedisReactiveHealthIndicatorTests { assertThat(h.getDetails().get("slots_up")).isEqualTo(4L); assertThat(h.getDetails().get("slots_fail")).isEqualTo(0L); }).verifyComplete(); - verify(redisConnection).closeLater(); + verify(redisConnectionFactory.getReactiveConnection()).closeLater(); + } + + @Test + void healthWhenClusterStateIsOkShouldBeUp() { + ReactiveRedisConnectionFactory redisConnectionFactory = createClusterConnectionFactory("ok"); + RedisReactiveHealthIndicator healthIndicator = new RedisReactiveHealthIndicator(redisConnectionFactory); + Mono 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 healthWhenClusterStateIsFailShouldBeDown() { + Properties clusterProperties = new Properties(); + clusterProperties.setProperty("cluster_state", "fail"); + ReactiveRedisConnectionFactory redisConnectionFactory = createClusterConnectionFactory("fail"); + RedisReactiveHealthIndicator healthIndicator = new RedisReactiveHealthIndicator(redisConnectionFactory); + Mono 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(); } @Test @@ -114,11 +133,27 @@ class RedisReactiveHealthIndicatorTests { 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 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))); + ReactiveRedisConnectionFactory redisConnectionFactory = mock(ReactiveRedisConnectionFactory.class); + given(redisConnectionFactory.getReactiveConnection()).willReturn(redisConnection); + return redisConnectionFactory; + } + }