Add integration tests for EKS Fargate Container Insights (#424)

Author: Richard To

terraform/templates/defaults/validator_docker_compose.tpl

@@ -26,5 +26,4 @@ services:
       - "--alarm-names=${cpu_alarm}"
       - "--alarm-names=${mem_alarm}"
       - "--alarm-names=${incoming_packets_alarm}"
-      - "--cortex-instance-endpoint=${cortex_instance_endpoint}"
-
+      - "--cortex-instance-endpoint=${cortex_instance_endpoint}"

terraform/testcases/eks_containerinsights_fargate/parameters.tfvars

@@ -0,0 +1,4 @@
+# this file is defined in validator/src/main/resources/validations
+validation_config = "eks-cw-container-insight.yml"
+
+aoc_base_scenario = "infra"

terraform/testcases/eks_containerinsights_fargate_metric/parameters.tfvars

@@ -0,0 +1,4 @@
+# this file is defined in validator/src/main/resources/validations
+validation_config = "otelFargate-metric-validation.yml"
+
+aoc_base_scenario = "infra"

validator/src/main/java/com/amazon/aoc/App.java

@@ -102,6 +102,11 @@ public class App implements Callable<Integer> {
       description = "cortex instance validating url")
   private String cortexInstanceEndpoint;
 
+  @CommandLine.Option(
+          names = {"--rollup"},
+          defaultValue = "true")
+  private boolean isRollup;
+
   private static final String TEST_CASE_DIM_KEY = "testcase";
   private static final String CANARY_NAMESPACE = "Otel/Canary";
   private static final String CANARY_METRIC_NAME = "Success";
@@ -115,7 +120,7 @@ public static void main(String[] args) throws Exception {
   public Integer call() throws Exception {
     final Instant startTime = Instant.now();
     // build context
-    Context context = new Context(this.testingId, this.region, this.isCanary);
+    Context context = new Context(this.testingId, this.region, this.isCanary, this.isRollup);
     context.setAccountId(this.accountId);
     context.setAvailabilityZone(this.availabilityZone);
     context.setMetricNamespace(this.metricNamespace);

validator/src/main/java/com/amazon/aoc/fileconfigs/PredefinedExpectedTemplate.java

@@ -35,6 +35,8 @@ public enum PredefinedExpectedTemplate implements FileConfig {
     "/expected-data-template/container-insight/eks/prometheus"),
   CONTAINER_INSIGHT_ECS_PROMETHEUS_METRIC(
       "/expected-data-template/container-insight/ecs/prometheus"),
+  FARGATE_EXPECTED_METRIC("/expected-data-template/EKSFargateCWCIExpectedMetric.mustache"),
+
 
   /**
    * trace template, defined in resources.
@@ -80,8 +82,11 @@ public enum PredefinedExpectedTemplate implements FileConfig {
     "/expected-data-template/container-insight/ecs/ecs-instance"),
   CONTAINER_INSIGHT_ECS_PROMETHEUS_LOG(
       "/expected-data-template/container-insight/ecs/prometheus"),
+  CONTAINER_INSIGHT_FARGATE_EKS_LOG(
+          "/expected-data-template/container-insight/eks/fargate"),
   ;
 
+
   private String path;
 
   PredefinedExpectedTemplate(String path) {

validator/src/main/java/com/amazon/aoc/helpers/CWMetricHelper.java

@@ -42,15 +42,13 @@ public class CWMetricHelper {
    * @param context        testing context
    * @param expectedMetric expected template
    * @param caller         http caller, none caller, could be null
-   * @param rollup         true then rollup metrics
    * @return list of metrics
    * @throws Exception when caller throws exception or template can not be found
    */
   public List<Metric> listExpectedMetrics(
       Context context,
       FileConfig expectedMetric,
-      ICaller caller,
-      boolean rollup
+      ICaller caller
   ) throws Exception {
     // call endpoint
     if (caller != null) {
@@ -66,9 +64,10 @@ public List<Metric> listExpectedMetrics(
           yamlExpectedMetrics.getBytes(StandardCharsets.UTF_8),
           new TypeReference<List<Metric>>() {});
 
-    if (rollup) {
+    if (context.getIsRollup()) {
       return this.rollupMetric(expectedMetricList);
     }
+
     return expectedMetricList;
   }
 

validator/src/main/java/com/amazon/aoc/models/Context.java

@@ -35,6 +35,9 @@ public class Context {
   @NonNull
   private Boolean isCanary;
 
+  @NonNull
+  private Boolean isRollup;
+
   private String metricNamespace;
 
   private String endpoint;

validator/src/main/java/com/amazon/aoc/validators/CWMetricValidator.java

@@ -68,8 +68,7 @@ public void validate() throws Exception {
     final List<Metric> expectedMetricList = cwMetricHelper.listExpectedMetrics(
         context,
         expectedMetric,
-        caller,
-        true
+        caller
     );
     Set<String> skippedDimensionNameList = new HashSet<>();
     for (Metric metric : expectedMetricList) {
@@ -146,7 +145,6 @@ private void compareMetricLists(List<Metric> toBeCheckedMetricList, List<Metric>
     for (Metric metric : baseMetricList) {
       metricSet.add(metric);
     }
-
     for (Metric metric : toBeCheckedMetricList) {
       if (!metricSet.contains(metric)) {
         throw new BaseException(
@@ -171,7 +169,6 @@ private List<Metric> listMetricFromCloudWatch(
     for (String metricName : metricNameMap.keySet()) {
       result.addAll(cloudWatchService.listMetrics(metricNameMap.get(metricName), metricName));
     }
-
     return result;
   }
 

validator/src/main/java/com/amazon/aoc/validators/ContainerInsightStructuredLogValidator.java

@@ -9,11 +9,10 @@
 import lombok.extern.log4j.Log4j2;
 import org.apache.commons.io.FilenameUtils;
 
+import java.io.IOException;
 import java.time.Instant;
 import java.util.Arrays;
-import java.util.HashSet;
 import java.util.List;
-import java.util.Set;
 
 
 @Log4j2
@@ -46,8 +45,12 @@ void init(Context context, FileConfig expectedDataTemplate) throws Exception {
       FileConfig fileConfig = new LocalPathExpectedTemplate(FilenameUtils.concat(
           expectedDataTemplate.getPath().toString(),
           logType + ".json"));
-      String templateInput = mustacheHelper.render(fileConfig, context);
-      schemasToValidate.put(logType, parseJsonSchema(templateInput));
+      try {
+        String templateInput = mustacheHelper.render(fileConfig, context);
+        schemasToValidate.put(logType, parseJsonSchema(templateInput));
+      } catch (IOException e) {
+        log.debug("The " + logType + " was not found for this expected template path.");
+      }
     }
   }
 
@@ -63,9 +66,9 @@ protected int getMaxRetryCount() {
 
   @Override
   protected void fetchAndValidateLogs(Instant startTime) throws Exception {
-    Set<String> logTypes = new HashSet<>(LOG_TYPE_TO_VALIDATE);
-    log.info("Fetch and validate logs with types: " + String.join(", ", logTypes));
-    for (String logType : logTypes) {
+    log.info("Fetch and validate logs with types: "
+            + String.join(", ", schemasToValidate.keySet()));
+    for (String logType : schemasToValidate.keySet()) {
       String filterPattern = String.format("{ $.Type = \"%s\"}", logType);
       List<FilteredLogEvent> logEvents = cloudWatchService.filterLogs(logGroupName, filterPattern,
               startTime.toEpochMilli(), QUERY_LIMIT);