refactor(metrics): make test more explicit

Author: heitorlessa

tests/e2e/metrics/handlers/basic_handler.py

@@ -1,14 +1,17 @@
 from aws_lambda_powertools import Metrics
-from aws_lambda_powertools.metrics import MetricUnit
 
-metrics = Metrics()
+my_metrics = Metrics()
 
 
-@metrics.log_metrics
+@my_metrics.log_metrics
 def lambda_handler(event, context):
-    metric = event.get("metric_name")
-    metrics.namespace = "powertools-e2e-metric"
-    metrics.service = event.get("service")
+    metrics, namespace, service = event.get("metrics"), event.get("namespace"), event.get("service")
+
+    # Maintenance: create a public method to set these explicitly
+    my_metrics.namespace = namespace
+    my_metrics.service = service
+
+    for metric in metrics:
+        my_metrics.add_metric(**metric)
 
-    metrics.add_metric(name=metric, unit=MetricUnit.Count, value=1)
     return "success"

tests/e2e/metrics/test_metrics.py

@@ -23,10 +23,11 @@ def test_basic_lambda_metric_is_visible(basic_handler_fn):
     # GIVEN
     metric_name = helpers.build_metric_name()
     service = helpers.build_service_name()
-    event = json.dumps({"metric_name": metric_name, "service": service, "namespace": METRIC_NAMESPACE})
+    metrics = helpers.build_multiple_add_metric_input(metric_name=metric_name, value=1, quantity=3)
 
     # WHEN
-    ret, execution_time = helpers.trigger_lambda(lambda_arn=basic_handler_fn, payload=event)
+    event = json.dumps({"metrics": metrics, "service": service, "namespace": METRIC_NAMESPACE})
+    _, execution_time = helpers.trigger_lambda(lambda_arn=basic_handler_fn, payload=event)
 
     metrics = helpers.get_metrics(
         start_date=execution_time,
@@ -37,18 +38,11 @@ def test_basic_lambda_metric_is_visible(basic_handler_fn):
     )
 
     # THEN
-    assert len(metrics.get("Timestamps", [])) == 1
     metric_data = metrics.get("Values", [])
-    assert metric_data and metric_data[0] == 1
-
-    # for later... we could break the test early if the function failed
-    # we could extend `trigger_lambda` with a default param to check on that
-    # making the test less verbose. For explicit invoke failure, we could override
-    assert ret is not None
+    assert metric_data and metric_data[0] == 3.0
 
 
 # helpers: adjust retries and wait to be much smaller
 # helpers: make retry config adjustable
 # Infra: Add temporary Powertools Layer
-# Powertools: should have a method to set namespace at runtime
 # Create separate Infra class so they can live side by side

tests/e2e/utils/helpers.py

@@ -13,8 +13,10 @@
 from pydantic import BaseModel
 from retry import retry
 
-
 # Helper methods && Class
+from aws_lambda_powertools.metrics import MetricUnit
+
+
 class Log(BaseModel):
     level: str
     location: str
@@ -174,3 +176,47 @@ def build_metric_query_data(
             "ReturnData": True,
         }
     ]
+
+
+def build_add_metric_input(metric_name: str, value: float, unit: str = MetricUnit.Count.value) -> Dict:
+    """Create a metric input to be used with Metrics.add_metric()
+
+    Parameters
+    ----------
+    metric_name : str
+        metric name
+    value : float
+        metric value
+    unit : str, optional
+        metric unit, by default Count
+
+    Returns
+    -------
+    Dict
+        Metric input
+    """
+    return {"name": metric_name, "unit": unit, "value": value}
+
+
+def build_multiple_add_metric_input(
+    metric_name: str, value: float, unit: str = MetricUnit.Count.value, quantity: int = 1
+) -> Dict:
+    """Create list of metrics input to be used with Metrics.add_metric()
+
+    Parameters
+    ----------
+    metric_name : str
+        metric name
+    value : float
+        metric value
+    unit : str, optional
+        metric unit, by default Count
+    quantity : int, optional
+        number of metrics to be created, by default 1
+
+    Returns
+    -------
+    List[Dict]
+        List of metrics
+    """
+    return [{"name": metric_name, "unit": unit, "value": value} for _ in range(quantity)]