[ISSUE alibaba#10744]feat:Add HealthControllerV2 and HealthController…

…V2Test

console/src/main/java/com/alibaba/nacos/console/controller/v2/HealthControllerV2.java

@@ -0,0 +1,64 @@
+/*
+ * Copyright 1999-2018 Alibaba Group Holding Ltd.
+ *
+ * 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 com.alibaba.nacos.console.controller.v2;
+
+import com.alibaba.nacos.core.cluster.health.ModuleHealthCheckerHolder;
+import com.alibaba.nacos.core.cluster.health.ReadinessResult;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import javax.servlet.http.HttpServletRequest;
+
+/**
+ * Health ControllerV2.
+ *
+ * @author DiligenceLai
+ */
+@RestController("consoleHealth")
+@RequestMapping("/v2/console/health")
+public class HealthControllerV2 {
+
+    /**
+     * Whether the Nacos is in broken states or not, and cannot recover except by being restarted.
+     *
+     * @return HTTP code equal to 200 indicates that Nacos is in right states. HTTP code equal to 500 indicates that
+     * Nacos is in broken states.
+     */
+    @GetMapping("/liveness")
+    public ResponseEntity<String> liveness() {
+        return ResponseEntity.ok().body("OK");
+    }
+
+    /**
+     * Ready to receive the request or not.
+     *
+     * @return HTTP code equal to 200 indicates that Nacos is ready. HTTP code equal to 500 indicates that Nacos is not
+     * ready.
+     */
+    @GetMapping("/readiness")
+    public ResponseEntity<String> readiness(HttpServletRequest request) {
+        ReadinessResult result = ModuleHealthCheckerHolder.getInstance().checkReadiness();
+        if (result.isSuccess()) {
+            return ResponseEntity.ok().body("OK");
+        }
+        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(result.getResultMessage());
+    }
+
+}

console/src/test/java/com/alibaba/nacos/console/controller/v2/HealthControllerV2Test.java

@@ -0,0 +1,122 @@
+/*
+ * Copyright 1999-2018 Alibaba Group Holding Ltd.
+ *
+ * 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 com.alibaba.nacos.console.controller.v2;
+
+import com.alibaba.nacos.config.server.service.ConfigReadinessCheckService;
+import com.alibaba.nacos.config.server.service.repository.ConfigInfoPersistService;
+import com.alibaba.nacos.core.cluster.health.ModuleHealthCheckerHolder;
+import com.alibaba.nacos.naming.cluster.NamingReadinessCheckService;
+import com.alibaba.nacos.naming.cluster.ServerStatus;
+import com.alibaba.nacos.naming.cluster.ServerStatusManager;
+import org.junit.After;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.mockito.junit.MockitoJUnitRunner;
+import org.springframework.http.ResponseEntity;
+
+import java.lang.reflect.Field;
+import java.util.List;
+
+import static org.mockito.ArgumentMatchers.any;
+
+/**
+ * HealthControllerV2Test
+ *
+ * @author DiligenceLai
+ */
+@RunWith(MockitoJUnitRunner.class)
+public class HealthControllerV2Test {
+
+    @InjectMocks
+    private HealthControllerV2 healthControllerV2;
+
+    @Mock
+    private ConfigInfoPersistService configInfoPersistService;
+
+    @Mock
+    private ServerStatusManager serverStatusManager;
+
+    @Before
+    public void setUp() {
+        // auto register to module health checker holder.
+        new NamingReadinessCheckService(serverStatusManager);
+        new ConfigReadinessCheckService(configInfoPersistService);
+    }
+
+    @After
+    public void tearDown() throws IllegalAccessException, NoSuchFieldException {
+        Field moduleHealthCheckersField = ModuleHealthCheckerHolder.class.getDeclaredField("moduleHealthCheckers");
+        moduleHealthCheckersField.setAccessible(true);
+        ((List) moduleHealthCheckersField.get(ModuleHealthCheckerHolder.getInstance())).clear();
+    }
+
+    @Test
+    public void testLiveness() throws Exception {
+        ResponseEntity<String> response = healthControllerV2.liveness();
+        Assert.assertEquals(200, response.getStatusCodeValue());
+    }
+
+    @Test
+    public void testReadinessSuccess() throws Exception {
+
+        Mockito.when(configInfoPersistService.configInfoCount(any(String.class))).thenReturn(0);
+        Mockito.when(serverStatusManager.getServerStatus()).thenReturn(ServerStatus.UP);
+        ResponseEntity<String> response = healthControllerV2.readiness(null);
+        Assert.assertEquals(200, response.getStatusCodeValue());
+        Assert.assertEquals("OK", response.getBody());
+    }
+
+    @Test
+    public void testReadinessBothFailure() {
+        // Config and Naming are not in readiness
+        Mockito.when(configInfoPersistService.configInfoCount(any(String.class)))
+                .thenThrow(new RuntimeException("HealthControllerV2Test.testReadiness"));
+        Mockito.when(serverStatusManager.getServerStatus())
+                .thenThrow(new RuntimeException("HealthControllerV2Test.testReadiness"));
+        ResponseEntity<String> response = healthControllerV2.readiness(null);
+        Assert.assertEquals(500, response.getStatusCodeValue());
+        Assert.assertEquals("naming and config not in readiness", response.getBody());
+    }
+
+    @Test
+    public void testReadinessConfigFailure() {
+        // Config is not in readiness
+        Mockito.when(configInfoPersistService.configInfoCount(any(String.class)))
+                .thenThrow(new RuntimeException("HealthControllerV2Test.testReadiness"));
+        Mockito.when(serverStatusManager.getServerStatus()).thenReturn(ServerStatus.UP);
+        ResponseEntity<String> response = healthControllerV2.readiness(null);
+        Assert.assertEquals(500, response.getStatusCodeValue());
+        Assert.assertEquals("config not in readiness", response.getBody());
+    }
+
+    @Test
+    public void testReadinessNamingFailure() {
+        // Naming is not in readiness
+        Mockito.when(configInfoPersistService.configInfoCount(any(String.class))).thenReturn(0);
+        Mockito.when(serverStatusManager.getServerStatus())
+                .thenThrow(new RuntimeException("HealthControllerV2Test.testReadiness"));
+        ResponseEntity<String> response = healthControllerV2.readiness(null);
+        Assert.assertEquals(500, response.getStatusCodeValue());
+        Assert.assertEquals("naming not in readiness", response.getBody());
+    }
+
+}