fix: add details of providers to reponse body of ready health check

, add trusted content to healthcheck, and add more required adjustments

Signed-off-by: Zvi Grinberg <[email protected]>

Author: zvigrinberg

src/main/java/com/redhat/exhort/integration/Constants.java

@@ -31,6 +31,7 @@ public final class Constants {
 
   private Constants() {}
 
+  public static final String PROVIDER_NAME = "providerName";
   public static final String PROVIDERS_PARAM = "providers";
 
   public static final String HEALTH_CHECKS_LIST_HEADER_NAME = "healthChecksRoutesList";

src/main/java/com/redhat/exhort/integration/backend/ExhortIntegration.java

@@ -36,6 +36,7 @@
 import com.redhat.exhort.integration.Constants;
 import com.redhat.exhort.integration.backend.sbom.SbomParserFactory;
 import com.redhat.exhort.integration.providers.ProviderAggregationStrategy;
+import com.redhat.exhort.integration.providers.ProvidersBodyPlusResponseCodeAggregationStrategy;
 import com.redhat.exhort.integration.providers.VulnerabilityProvider;
 import com.redhat.exhort.integration.trustedcontent.TcResponseAggregation;
 import com.redhat.exhort.monitoring.MonitoringProcessor;
@@ -203,6 +204,12 @@ public void configure() {
       .setHeader(Exchange.HTTP_RESPONSE_CODE, constant(Status.INTERNAL_SERVER_ERROR.getStatusCode()))
       .setHeader(Exchange.CONTENT_TYPE, constant(MediaType.TEXT_PLAIN));
     //fmt:on
+
+    from(direct("exhortHealthCheck"))
+        .routeId("exhortHealthCheck")
+        .setProperty(PROVIDERS_PARAM, method(vulnerabilityProvider, "getEnabled"))
+        .recipientList(header(Constants.HEALTH_CHECKS_LIST_HEADER_NAME))
+        .aggregationStrategy(new ProvidersBodyPlusResponseCodeAggregationStrategy());
   }
 
   private void processAnalysisRequest(Exchange exchange) {

src/main/java/com/redhat/exhort/integration/providers/ProviderHealthCheck.java

@@ -21,6 +21,7 @@
 import java.util.Collection;
 import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
 
 import org.apache.camel.builder.ExchangeBuilder;
 import org.apache.camel.health.HealthCheckResultBuilder;
@@ -30,9 +31,14 @@
 
 public class ProviderHealthCheck extends AbstractHealthCheck {
 
+  private static final List<String> allProvidersHealthChecks =
+      List.of("direct:snykHealthCheck", "direct:osvNvdHealthCheck", "direct:ossIndexHealthCheck");
+  public static final String PROVIDER_HTTP_STATUS_CODE_KEY = "StatusCode";
+  public static final String PROVIDER_IS_ENABLED_KEY = "isEnabled";
+  public static final String PROVIDER_RESPONSE_BODY_KEY = "responseBody";
+
   public ProviderHealthCheck() {
     super("External Providers Readiness Check");
-    setEnabled(true);
   }
 
   @Override
@@ -41,32 +47,36 @@ protected void doCall(HealthCheckResultBuilder builder, Map<String, Object> opti
         getCamelContext()
             .createProducerTemplate()
             .send(
-                getHealthCheckRoute(),
+                "direct:exhortHealthCheck",
                 ExchangeBuilder.anExchange(getCamelContext())
                     .withHeader(
-                        Constants.HEALTH_CHECKS_LIST_HEADER_NAME, getAllProvidersHealthChecks())
+                        Constants.HEALTH_CHECKS_LIST_HEADER_NAME, this.allProvidersHealthChecks)
                     .build());
 
-    List<Map<Integer, String>> httpResponseBodiesAndStatuses =
-        (List<Map<Integer, String>>) response.getMessage().getBody();
+    List<Map<String, Map<String, String>>> httpResponseBodiesAndStatuses =
+        (List<Map<String, Map<String, String>>>) response.getMessage().getBody();
+    Map<String, Object> providers =
+        httpResponseBodiesAndStatuses.stream()
+            .map(Map::entrySet)
+            .flatMap(Collection::stream)
+            .collect(
+                Collectors.toMap(entry -> entry.getKey(), entry -> entry.getValue(), (a, b) -> a));
+    builder.details(providers);
+
     if (httpResponseBodiesAndStatuses.stream()
-        .map(entry -> entry.keySet())
+        .map(Map::values)
         .flatMap(Collection::stream)
-        .anyMatch(status -> status < 400)) {
+        .anyMatch(
+            providerDetails ->
+                Integer.valueOf(providerDetails.get(PROVIDER_HTTP_STATUS_CODE_KEY)) < 400
+                    && Boolean.parseBoolean(providerDetails.get(PROVIDER_IS_ENABLED_KEY)))) {
       builder.up();
+
     } else {
       builder.down();
     }
   }
 
-  private List<String> getAllProvidersHealthChecks() {
-    return List.of("direct:snykHealthCheck", "direct:osvNvdHealthCheck");
-  }
-
-  private String getHealthCheckRoute() {
-    return "direct:exhortHealthCheck";
-  }
-
   @Override
   public boolean isLiveness() {
     return false;

src/main/java/com/redhat/exhort/integration/providers/ProvidersBodyPlusResponseCodeAggregationStrategy.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2024 Red Hat, Inc. and/or its affiliates
+ * and other contributors as indicated by the @author tags.
+ *
+ * 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.redhat.exhort.integration.providers;
+
+import static com.redhat.exhort.integration.providers.ProviderHealthCheck.*;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.apache.camel.Exchange;
+import org.apache.camel.processor.aggregate.AbstractListAggregationStrategy;
+
+import com.redhat.exhort.integration.Constants;
+
+public class ProvidersBodyPlusResponseCodeAggregationStrategy
+    extends AbstractListAggregationStrategy<Map<String, Map<String, String>>> {
+  @Override
+  public Map<String, Map<String, String>> getValue(Exchange exchange) {
+    Map<String, Map<String, String>> result = new HashMap<>();
+    Map<String, String> providerValues = new HashMap<>();
+    providerValues.put(PROVIDER_RESPONSE_BODY_KEY, exchange.getMessage().getBody(String.class));
+    providerValues.put(
+        PROVIDER_HTTP_STATUS_CODE_KEY,
+        exchange.getMessage().getHeader(Exchange.HTTP_RESPONSE_CODE, Integer.class).toString());
+    List<String> enabledProviders = exchange.getProperty(Constants.PROVIDERS_PARAM, List.class);
+    if (enabledProviders.contains(exchange.getProperty(Constants.PROVIDER_NAME, String.class))) {
+      providerValues.put(PROVIDER_IS_ENABLED_KEY, "true");
+    } else {
+      providerValues.put(PROVIDER_IS_ENABLED_KEY, "false");
+    }
+    result.put(exchange.getProperty(Constants.PROVIDER_NAME, String.class), providerValues);
+    return result;
+  }
+}

src/main/java/com/redhat/exhort/integration/providers/ProvidersBodyPlusResponseCodeStrategy.java

@@ -82,6 +82,12 @@ public void configure() {
         .onFallback()
           .process(responseHandler::processResponseError);
 
+    from(direct("ossIndexHealthCheck"))
+            .routeId("ossIndexHealthCheck")
+            .setProperty(Constants.PROVIDER_NAME, constant(Constants.OSS_INDEX_PROVIDER))
+            .setHeader(Constants.OSS_INDEX_TOKEN_HEADER,constant(" "))
+            .to(direct("ossValidateCredentials"));
+
     from(direct("ossValidateCredentials"))
       .routeId("ossValidateCredentials")
       .circuitBreaker()

src/main/java/com/redhat/exhort/integration/providers/ProvidersIntegration.java

@@ -19,6 +19,7 @@
 package com.redhat.exhort.integration.providers.osvnvd;
 
 import org.apache.camel.Exchange;
+import org.apache.camel.builder.ExpressionBuilder;
 import org.apache.camel.builder.endpoint.EndpointRouteBuilder;
 import org.eclipse.microprofile.config.inject.ConfigProperty;
 
@@ -62,6 +63,7 @@ public void configure() throws Exception {
 
     from(direct("osvNvdHealthCheck"))
         .routeId("osvNvdHealthCheck")
+        .setProperty(Constants.PROVIDER_NAME, constant(Constants.OSV_NVD_PROVIDER))
         .process(this::processHealthRequest)
         .circuitBreaker()
         .faultToleranceConfiguration()
@@ -70,7 +72,9 @@ public void configure() throws Exception {
         .end()
         .to(vertxHttp("{{api.osvnvd.management.host}}"))
         .onFallback()
-        .process(responseHandler::processTokenFallBack);
+        .setBody(ExpressionBuilder.bodyExpression("osvNvd Service is down"))
+        .setHeader(Exchange.HTTP_RESPONSE_CODE,constant("503"));
+
     // fmt:on
   }
 

src/main/java/com/redhat/exhort/integration/providers/ProvidersResponseCodeStrategy.java

@@ -97,10 +97,13 @@ public void configure() {
       .routeId("snykValidateToken")
       .process(this::processTokenValidation)
       .to(direct("snykTokenRequest"));
+
     from(direct("snykHealthCheck"))
       .routeId("snykHealthCheck")
+      .setProperty(Constants.PROVIDER_NAME, constant(Constants.SNYK_PROVIDER))
       .process(this::setAuthToken)
       .to(direct("snykTokenRequest"));
+
     from(direct("snykTokenRequest"))
       .routeId("snykTokenRequest")
       .process(this::processTokenRequest)