Health check fixed (helidon-io#1809)

* Health check fixed for native image.
* Also fixed for hotspot (used Set instead of List)

Signed-off-by: Tomas Langer <tomas.langer@oracle.com>

Author: tomas-langer

health/health-checks/src/main/java/io/helidon/health/checks/DeadlockHealthCheck.java

@@ -23,6 +23,7 @@
 import javax.enterprise.context.ApplicationScoped;
 import javax.inject.Inject;
 
+import io.helidon.common.NativeImageHelper;
 import io.helidon.health.common.BuiltInHealthCheck;
 
 import org.eclipse.microprofile.health.HealthCheck;
@@ -40,16 +41,20 @@
 @BuiltInHealthCheck
 public final class DeadlockHealthCheck implements HealthCheck {
     private static final Logger LOGGER = Logger.getLogger(DeadlockHealthCheck.class.getName());
+    private static final String NAME = "deadlock";
 
     /**
      * Used for detecting deadlocks. Injected in the constructor.
      */
     private final ThreadMXBean threadBean;
+    private final boolean disabled;
 
     @Inject
         // this will be ignored if not within CDI
     DeadlockHealthCheck(ThreadMXBean threadBean) {
         this.threadBean = threadBean;
+        // in Graal native image, we cannot use this check, as it would always fail
+        this.disabled = NativeImageHelper.isNativeImage();
     }
 
     /**
@@ -65,6 +70,16 @@ public static DeadlockHealthCheck create(ThreadMXBean threadBean) {
 
     @Override
     public HealthCheckResponse call() {
+        if (disabled) {
+            LOGGER.log(Level.FINEST, "Running in graal native image, this health-check always returns up.");
+            return HealthCheckResponse.builder()
+                    .name(NAME)
+                    .withData("enabled", "false")
+                    .withData("description", "in native image")
+                    .up()
+                    .build();
+        }
+
         boolean noDeadLock = false;
         try {
             // Thanks to https://stackoverflow.com/questions/1102359/programmatic-deadlock-detection-in-java#1102410
@@ -73,7 +88,7 @@ public HealthCheckResponse call() {
             // ThreadBean does not work - probably in native image
             LOGGER.log(Level.FINEST, "Failed to find deadlocks in ThreadMXBean, ignoring this healthcheck", e);
         }
-        return HealthCheckResponse.named("deadlock")
+        return HealthCheckResponse.named(NAME)
                 .state(noDeadLock)
                 .build();
     }

health/health-checks/src/main/java/io/helidon/health/checks/HealthChecks.java

@@ -18,6 +18,7 @@
 import java.lang.management.ManagementFactory;
 
 import io.helidon.common.HelidonFeatures;
+import io.helidon.common.NativeImageHelper;
 
 import org.eclipse.microprofile.health.HealthCheck;
 
@@ -27,8 +28,6 @@
  * @see #healthChecks()
  */
 public final class HealthChecks {
-    private static final boolean IS_GRAAL_VM = Boolean.getBoolean("com.oracle.graalvm.isaot");
-
     static {
         HelidonFeatures.register("Health", "Built-ins");
     }
@@ -75,7 +74,7 @@ public static HeapMemoryHealthCheck heapMemoryCheck() {
      * @see io.helidon.health.HealthSupport.Builder#addLiveness(org.eclipse.microprofile.health.HealthCheck...)
      */
     public static HealthCheck[] healthChecks() {
-        if (IS_GRAAL_VM) {
+        if (NativeImageHelper.isNativeImage()) {
             return new HealthCheck[] {
                     //diskSpaceCheck(), // - bug
                     heapMemoryCheck()

health/health/src/main/java/io/helidon/health/HealthSupport.java

@@ -20,7 +20,6 @@
 import java.util.Collections;
 import java.util.Comparator;
 import java.util.HashSet;
-import java.util.LinkedHashSet;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
@@ -260,9 +259,9 @@ public static HealthSupport create(Config config) {
      * Fluent API builder for {@link io.helidon.health.HealthSupport}.
      */
     public static final class Builder implements io.helidon.common.Builder<HealthSupport> {
-        private final Set<HealthCheck> allChecks = new LinkedHashSet<>();
-        private final Set<HealthCheck> livenessChecks = new LinkedHashSet<>();
-        private final Set<HealthCheck> readinessChecks = new LinkedHashSet<>();
+        private final List<HealthCheck> allChecks = new LinkedList<>();
+        private final List<HealthCheck> livenessChecks = new LinkedList<>();
+        private final List<HealthCheck> readinessChecks = new LinkedList<>();
 
         private final Set<Class<?>> excludedClasses = new HashSet<>();
         private final Set<String> includedHealthChecks = new HashSet<>();

microprofile/health/src/main/java/io/helidon/microprofile/health/HealthCdiExtension.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2020 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2019, 2020 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,6 +35,7 @@
 import io.helidon.common.HelidonFlavor;
 import io.helidon.common.serviceloader.HelidonServiceLoader;
 import io.helidon.config.Config;
+import io.helidon.config.mp.MpConfig;
 import io.helidon.health.HealthSupport;
 import io.helidon.health.common.BuiltInHealthCheck;
 import io.helidon.microprofile.server.RoutingBuilders;
@@ -89,22 +90,22 @@ void registerProducers(@Observes BeforeBeanDiscovery bbd) {
     }
 
     void registerHealth(@Observes @Initialized(ApplicationScoped.class) Object adv, BeanManager bm) {
-        Config config = ((Config) ConfigProvider.getConfig()).get("health");
+        org.eclipse.microprofile.config.Config config = ConfigProvider.getConfig();
+        Config helidonConfig = MpConfig.toHelidonConfig(config).get("health");
 
-        if (!config.get("enabled").asBoolean().orElse(true)) {
+        if (!config.getOptionalValue("health.enabled", Boolean.class).orElse(true)) {
             LOGGER.finest("Health support is disabled in configuration");
             return;
         }
 
         HealthSupport.Builder builder = HealthSupport.builder()
-                .config(config);
+                .config(helidonConfig);
 
         CDI<Object> cdi = CDI.current();
 
         // Collect built-in checks if disabled, otherwise set list to empty for filtering
-        Optional<Boolean> disableDefaults = config.get("mp.health.disable-default-procedures")
-                .asBoolean()
-                .asOptional();
+        Optional<Boolean> disableDefaults = config.getOptionalValue("mp.health.disable-default-procedures",
+                                                                    Boolean.class);
 
         List<HealthCheck> builtInHealthChecks = disableDefaults.map(
                 b -> b ? cdi.select(HealthCheck.class, BUILT_IN_HEALTH_CHECK_LITERAL)
@@ -134,7 +135,7 @@ void registerHealth(@Observes @Initialized(ApplicationScoped.class) Object adv,
                     healthCheckProvider.readinessChecks().forEach(builder::addReadiness);
                 });
 
-        RoutingBuilders.create(config)
+        RoutingBuilders.create(helidonConfig)
                 .routingBuilder()
                 .register(builder.build());
     }

microprofile/health/src/main/java/module-info.java

@@ -33,6 +33,7 @@
     requires java.json;
     requires microprofile.config.api;
     requires microprofile.health.api;
+    requires io.helidon.config.mp;
 
     exports io.helidon.microprofile.health;
 

tests/integration/native-image/mp-1/src/main/java/io/helidon/tests/integration/nativeimage/mp1/BeanClass.java

@@ -27,7 +27,6 @@ public class BeanClass {
     @Produces
     @RequestScoped
     public BeanType produceBeanType(@ConfigProperty(name = "app.message") String message) {
-        System.out.println("Producing in request scoped.");
         return new BeanType(message);
     }
 

tests/integration/native-image/mp-1/src/main/java/io/helidon/tests/integration/nativeimage/mp1/LivenessHealthcheck.java

@@ -1,5 +1,17 @@
 /*
- * Copyright (c) 2019, 2020 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2019, 2020 Oracle and/or its affiliates.
+ *
+ * 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 io.helidon.tests.integration.nativeimage.mp1;
 
@@ -23,7 +35,7 @@ public class LivenessHealthcheck implements HealthCheck {
 
     @Override
     public HealthCheckResponse call() {
-        return HealthCheckResponse.named("message")
+        return HealthCheckResponse.named("mp1-live")
                 .state(true)
                 .withData("app.message", message)
                 .build();

tests/integration/native-image/mp-1/src/main/java/io/helidon/tests/integration/nativeimage/mp1/Mp1Main.java

@@ -23,8 +23,10 @@
 import java.time.Instant;
 import java.util.ArrayList;
 import java.util.Base64;
+import java.util.HashMap;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.atomic.AtomicInteger;
@@ -115,11 +117,11 @@ public static void main(final String[] args) {
                 .forEach(names::add);
         names.sort(String::compareTo);
 
-        System.out.println("All configuration options:");
-        names.forEach(it -> {
-            config.getOptionalValue(it, String.class)
-                    .ifPresent(value -> System.out.println(it + "=" + value));
-        });
+        //        System.out.println("All configuration options:");
+        //        names.forEach(it -> {
+        //            config.getOptionalValue(it, String.class)
+        //                    .ifPresent(value -> System.out.println(it + "=" + value));
+        //        });
 
         server.stop();
 
@@ -427,8 +429,13 @@ private static void validateHealth(Errors.Collector collector, WebTarget target)
                 .get(JsonObject.class);
 
         JsonArray checks = health.getJsonArray("checks");
-        if (checks.size() < 1) {
-            collector.fatal("There should be at least one readiness healtcheck provided by this app");
+        if (checks.size() != 1) {
+            collector.fatal("There should be a readiness health check provided by this app");
+        } else {
+            JsonObject check = checks.getJsonObject(0);
+            if (!"mp1-ready".equals(check.getString("name"))) {
+                collector.fatal("The readiness health check should be named \"mp1-ready\", but is " + check.getString("name"));
+            }
         }
 
         try {
@@ -439,13 +446,48 @@ private static void validateHealth(Errors.Collector collector, WebTarget target)
             checks = health.getJsonArray("checks");
             if (checks.size() < 1) {
                 collector.fatal("There should be at least one liveness healtcheck provided by this app");
+            } else {
+                Map<String, JsonObject> checkMap = new HashMap<>();
+                checks.forEach(it -> {
+                    JsonObject healthCheck = (JsonObject) it;
+                    checkMap.put(healthCheck.getString("name"), healthCheck);
+                });
+                // now the check map contains all healthchecks we have
+                // validate our own
+                JsonObject healthCheck = healthExistsAndUp(collector, checkMap, "mp1-live");
+                if (null != healthCheck) {
+                    String message = healthCheck.getJsonObject("data").getString("app.message");
+                    if (!"Properties message".equals(message)) {
+                        collector.fatal("Message health check should return injected app.message from properties, but got "
+                                                + message);
+                    }
+                }
+
+                healthExistsAndUp(collector, checkMap, "deadlock");
+                healthExistsAndUp(collector, checkMap, "diskSpace");
+                healthExistsAndUp(collector, checkMap, "heapMemory");
             }
         } catch (ServiceUnavailableException e) {
             collector.fatal(e, "Failed to invoke health endpoint. Exception: " + e.getClass().getName()
                     + ", message: " + e.getMessage() + ", " + e.getResponse().readEntity(String.class));
         }
     }
 
+    private static JsonObject healthExistsAndUp(Errors.Collector collector,
+                                                Map<String, JsonObject> checkMap,
+                                                String name) {
+        JsonObject healthCheck = checkMap.get(name);
+        if (null == healthCheck) {
+            collector.fatal("\"" + name + "\" health check is not available");
+        } else {
+            String status = healthCheck.getString("state");
+            if (!"UP".equals(status)) {
+                collector.fatal("Health check \"" + name + "\" should be up, but is " + status);
+            }
+        }
+        return healthCheck;
+    }
+
     private static void validateMetrics(Errors.Collector collector, WebTarget target) {
         JsonObject vendor = target.path("/metrics/vendor")
                 .request(MediaType.APPLICATION_JSON)

tests/integration/native-image/mp-1/src/main/java/io/helidon/tests/integration/nativeimage/mp1/ReadinessHealthcheck.java

@@ -35,7 +35,7 @@ public class ReadinessHealthcheck implements HealthCheck {
 
     @Override
     public HealthCheckResponse call() {
-        return HealthCheckResponse.named("message")
+        return HealthCheckResponse.named("mp1-ready")
                 .state(true)
                 .withData("app.message", message)
                 .build();

tests/integration/native-image/mp-1/src/main/java/module-info.java

@@ -32,6 +32,9 @@
     requires microprofile.metrics.api;
     requires java.json.bind;
     requires microprofile.config.api;
+    // this is required, as otherwise the beans from this module
+    // never reach health check CDI extension
+    requires io.helidon.health.checks;
 
     exports io.helidon.tests.integration.nativeimage.mp1;