Add unit tests for High Resolution Metrics

Author: Meshwa Savalia

src/main/java/software/amazon/cloudwatchlogs/emf/logger/MetricsLogger.java

@@ -35,6 +35,7 @@
 import software.amazon.cloudwatchlogs.emf.model.StorageResolution;
 import software.amazon.cloudwatchlogs.emf.model.Unit;
 import software.amazon.cloudwatchlogs.emf.sinks.ISink;
+import software.amazon.cloudwatchlogs.emf.util.Validator;
 
 /**
  * A metrics logger. Use this interface to publish logs to CloudWatch Logs and extract metrics to
@@ -93,6 +94,7 @@ public void flush() {
             configureContextForEnvironment(context, environment);
             sink.accept(context);
             context = context.createCopyWithContext(flushPreserveDimensions);
+            Validator.metricNameAndResolutionMap.clear();
         } finally {
             rwl.writeLock().unlock();
         }

src/main/java/software/amazon/cloudwatchlogs/emf/util/Validator.java

@@ -26,6 +26,8 @@
 import software.amazon.cloudwatchlogs.emf.model.Unit;
 
 public class Validator {
+    public static Map<String, String> metricNameAndResolutionMap = new HashMap<>();
+
     private Validator() {
         throw new IllegalStateException("Utility class");
     }
@@ -98,8 +100,6 @@ public static void validateMetric(
             String name, double value, Unit unit, StorageResolution storageResolution)
             throws InvalidMetricException {
 
-        Map<String, String> metricNameAndResolutionMap = new HashMap<>();
-
         if (name == null || name.trim().isEmpty()) {
             throw new InvalidMetricException(
                     "Metric name " + name + " must include at least one non-whitespace character");
@@ -120,8 +120,8 @@ public static void validateMetric(
         if (unit == null) {
             throw new InvalidMetricException("Metric unit cannot be null");
         }
-        // TODO_M validate storageResolution ?
-        if (storageResolution.getValue() == -1) {
+
+        if (storageResolution == null) {
             throw new InvalidMetricException("Metric resolution cannot be null");
         }
 

src/test/java/software/amazon/cloudwatchlogs/emf/logger/MetricsLoggerTest.java

@@ -38,6 +38,8 @@
 import software.amazon.cloudwatchlogs.emf.exception.InvalidTimestampException;
 import software.amazon.cloudwatchlogs.emf.model.DimensionSet;
 import software.amazon.cloudwatchlogs.emf.model.MetricsContext;
+import software.amazon.cloudwatchlogs.emf.model.StorageResolution;
+import software.amazon.cloudwatchlogs.emf.model.Unit;
 import software.amazon.cloudwatchlogs.emf.sinks.SinkShunt;
 
 class MetricsLoggerTest {
@@ -349,7 +351,24 @@ void whenPutMetric_withInvalidValue_thenThrowInvalidMetricException(double value
 
     @Test
     void whenPutMetric_withNullUnit_thenThrowInvalidMetricException() {
-        assertThrows(InvalidMetricException.class, () -> logger.putMetric("test", 1, null));
+        assertThrows(InvalidMetricException.class, () -> logger.putMetric("test", 1, (Unit) null));
+    }
+
+    @Test
+    void whenPutMetric_withNullStorageResolution_thenThrowInvalidMetricException() {
+        assertThrows(
+                InvalidMetricException.class,
+                () -> logger.putMetric("test", 1, (StorageResolution) null));
+    }
+
+    @Test
+    void whenPutMetric_withDifferentStorageResolution_thenThrowInvalidMetricException() {
+        assertThrows(
+                InvalidMetricException.class,
+                () -> {
+                    logger.putMetric("test", 1);
+                    logger.putMetric("test", 1, StorageResolution.HIGH);
+                });
     }
 
     @Test

src/test/java/software/amazon/cloudwatchlogs/emf/model/MetricDirectiveTest.java

@@ -90,6 +90,51 @@ void testPutMetricWithUnit() {
                 Unit.MILLISECONDS, metricDirective.getMetrics().get("Time").getUnit());
     }
 
+    @Test
+    void testPutMetricWithoutStorageResolution() throws JsonProcessingException {
+        MetricDirective metricDirective = new MetricDirective();
+        metricDirective.putMetric("Time", 10);
+
+        String serializedMetricDirective = objectMapper.writeValueAsString(metricDirective);
+
+        Assertions.assertEquals(
+                StorageResolution.STANDARD,
+                metricDirective.getMetrics().get("Time").getStorageResolution());
+        Assertions.assertEquals(
+                "{\"Dimensions\":[[]],\"Metrics\":[{\"Name\":\"Time\",\"Unit\":\"None\"}],\"Namespace\":\"aws-embedded-metrics\"}",
+                serializedMetricDirective);
+    }
+
+    @Test
+    void testPutMetricWithStandardStorageResolution() throws JsonProcessingException {
+        MetricDirective metricDirective = new MetricDirective();
+        metricDirective.putMetric("Time", 10, StorageResolution.STANDARD);
+
+        String serializedMetricDirective = objectMapper.writeValueAsString(metricDirective);
+
+        Assertions.assertEquals(
+                StorageResolution.STANDARD,
+                metricDirective.getMetrics().get("Time").getStorageResolution());
+        Assertions.assertEquals(
+                "{\"Dimensions\":[[]],\"Metrics\":[{\"Name\":\"Time\",\"Unit\":\"None\"}],\"Namespace\":\"aws-embedded-metrics\"}",
+                serializedMetricDirective);
+    }
+
+    @Test
+    void testPutMetricWithHighStorageResolution() throws JsonProcessingException {
+        MetricDirective metricDirective = new MetricDirective();
+        metricDirective.putMetric("Time", 10, StorageResolution.HIGH);
+
+        String serializedMetricDirective = objectMapper.writeValueAsString(metricDirective);
+
+        Assertions.assertEquals(
+                StorageResolution.HIGH,
+                metricDirective.getMetrics().get("Time").getStorageResolution());
+        Assertions.assertEquals(
+                "{\"Dimensions\":[[]],\"Metrics\":[{\"Name\":\"Time\",\"StorageResolution\":1,\"Unit\":\"None\"}],\"Namespace\":\"aws-embedded-metrics\"}",
+                serializedMetricDirective);
+    }
+
     @Test
     void testPutDimensions()
             throws JsonProcessingException, InvalidDimensionException,