Support showDetail=false in readiness endpoint

sofa-boot-project/sofa-boot-actuator-autoconfigure/src/test/java/com/alipay/sofa/actuator/autoconfigure/test/EndPointTest.java → sofa-boot-project/sofa-boot-actuator-autoconfigure/src/test/java/com/alipay/sofa/actuator/autoconfigure/test/ManualEndPointNoExistTest.java

@@ -33,7 +33,7 @@
  */
 @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, classes = EmptyConfiguration.class)
 @RunWith(SpringRunner.class)
-public class EndPointTest {
+public class ManualEndPointNoExistTest {
     @Autowired
     private TestRestTemplate restTemplate;
 

sofa-boot-project/sofa-boot-actuator-autoconfigure/src/test/java/com/alipay/sofa/actuator/autoconfigure/test/ReadinessEndpointTest.java

@@ -0,0 +1,80 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.alipay.sofa.actuator.autoconfigure.test;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.web.client.TestRestTemplate;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.test.context.junit4.SpringRunner;
+
+import java.util.Map;
+
+/**
+ * @author huzijie
+ * @version ReadinessEndpointTest.java, v 0.1 2022年04月28日 11:11 AM huzijie Exp $
+ */
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, classes = EmptyConfiguration.class)
+@RunWith(SpringRunner.class)
+public class ReadinessEndpointTest {
+    @Autowired
+    private TestRestTemplate restTemplate;
+
+    @Test
+    public void test() {
+        ResponseEntity<HealthResponse> response = restTemplate.getForEntity("/actuator/readiness",
+            HealthResponse.class);
+        Assert.assertEquals(HttpStatus.OK, response.getStatusCode());
+        HealthResponse health = response.getBody();
+        Assert.assertNotNull(health);
+        Assert.assertNotNull(health.getDetails());
+
+        response = restTemplate.getForEntity("/actuator/readiness?showDetail=false",
+            HealthResponse.class);
+        Assert.assertEquals(HttpStatus.OK, response.getStatusCode());
+        health = response.getBody();
+        Assert.assertNotNull(health);
+        Assert.assertNull(health.getDetails());
+    }
+
+    private static class HealthResponse {
+
+        private String              status;
+
+        private Map<String, Object> details;
+
+        public String getStatus() {
+            return status;
+        }
+
+        public void setStatus(String status) {
+            this.status = status;
+        }
+
+        public Map<String, Object> getDetails() {
+            return details;
+        }
+
+        public void setDetails(Map<String, Object> details) {
+            this.details = details;
+        }
+    }
+}

sofa-boot-project/sofa-boot-actuator/src/main/java/com/alipay/sofa/boot/actuator/health/ReadinessEndpointWebExtension.java

@@ -16,12 +16,12 @@
  */
 package com.alipay.sofa.boot.actuator.health;
 
-import org.springframework.boot.actuate.endpoint.SecurityContext;
 import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
 import org.springframework.boot.actuate.endpoint.web.WebEndpointResponse;
 import org.springframework.boot.actuate.endpoint.web.annotation.EndpointWebExtension;
 import org.springframework.boot.actuate.health.Health;
 import org.springframework.boot.actuate.health.HttpCodeStatusMapper;
+import org.springframework.lang.Nullable;
 
 /**
  * @author qilong.zql
@@ -39,8 +39,8 @@ public ReadinessEndpointWebExtension(SofaBootReadinessEndpoint delegate,
     }
 
     @ReadOperation
-    public WebEndpointResponse<Health> getHealth(SecurityContext securityContext) {
-        Health result = delegate.health();
+    public WebEndpointResponse<Health> getHealth(@Nullable String showDetail) {
+        Health result = delegate.health(showDetail);
         return new WebEndpointResponse<>(result, statusMapper.getStatusCode(result.getStatus()));
     }
 }

sofa-boot-project/sofa-boot-actuator/src/main/java/com/alipay/sofa/boot/actuator/health/SofaBootReadinessEndpoint.java

@@ -20,6 +20,7 @@
 import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
 import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
 import org.springframework.boot.actuate.health.Health;
+import org.springframework.lang.Nullable;
 
 /**
  * The health check HTTP checker for start status.
@@ -38,7 +39,11 @@ public SofaBootReadinessEndpoint(ReadinessCheckListener readinessCheckListener)
     }
 
     @ReadOperation
-    public Health health() {
-        return readinessCheckListener.aggregateReadinessHealth();
+    public Health health(@Nullable String showDetail) {
+        Health health = readinessCheckListener.aggregateReadinessHealth();
+        if (showDetail == null || Boolean.parseBoolean(showDetail)) {
+            return health;
+        }
+        return new Health.Builder(health.getStatus()).build();
     }
 }