refactor(helpers): set good default on end_date metrics; fix yield

Author: heitorlessa

tests/e2e/metrics/conftest.py

@@ -33,20 +33,20 @@ def infrastructure(request: fixtures.SubRequest, tmp_path_factory: pytest.TempPa
         if worker_id == "master":
             # no parallelization, deploy stack and let fixture be cached
             yield stack.deploy()
-
-        # tmp dir shared by all workers
-        root_tmp_dir = tmp_path_factory.getbasetemp().parent
-
-        cache = root_tmp_dir / "cache.json"
-        with FileLock(f"{cache}.lock"):
-            # If cache exists, return stack outputs back
-            # otherwise it's the first run by the main worker
-            # deploy and return stack outputs so subsequent workers can reuse
-            if cache.is_file():
-                stack_outputs = json.loads(cache.read_text())
-            else:
-                stack_outputs: Dict = stack.deploy()
-                cache.write_text(json.dumps(stack_outputs))
-        yield stack_outputs
+        else:
+            # tmp dir shared by all workers
+            root_tmp_dir = tmp_path_factory.getbasetemp().parent
+
+            cache = root_tmp_dir / "cache.json"
+            with FileLock(f"{cache}.lock"):
+                # If cache exists, return stack outputs back
+                # otherwise it's the first run by the main worker
+                # deploy and return stack outputs so subsequent workers can reuse
+                if cache.is_file():
+                    stack_outputs = json.loads(cache.read_text())
+                else:
+                    stack_outputs: Dict = stack.deploy()
+                    cache.write_text(json.dumps(stack_outputs))
+            yield stack_outputs
     finally:
         stack.delete()

tests/e2e/metrics/test_metrics.py

@@ -1,11 +1,15 @@
-import datetime
 import json
 
 import pytest
 
 from tests.e2e.utils import helpers
 
 
+@pytest.fixture
+def basic_handler_fn(infrastructure: dict) -> str:
+    return infrastructure.get("BasicHandler", "")
+
+
 @pytest.fixture
 def basic_handler_fn_arn(infrastructure: dict) -> str:
     return infrastructure.get("BasicHandlerArn", "")
@@ -24,22 +28,19 @@ def cold_start_fn_arn(infrastructure: dict) -> str:
 METRIC_NAMESPACE = "powertools-e2e-metric"
 
 
-def test_basic_lambda_metric_is_visible(basic_handler_fn):
+def test_basic_lambda_metric_is_visible(basic_handler_fn: str, basic_handler_fn_arn: str):
     # GIVEN
     metric_name = helpers.build_metric_name()
     service = helpers.build_service_name()
+    dimensions = helpers.build_add_dimensions_input(service=service)
     metrics = helpers.build_multiple_add_metric_input(metric_name=metric_name, value=1, quantity=3)
 
     # WHEN
     event = json.dumps({"metrics": metrics, "service": service, "namespace": METRIC_NAMESPACE})
-    _, execution_time = helpers.trigger_lambda(lambda_arn=basic_handler_fn, payload=event)
+    _, execution_time = helpers.trigger_lambda(lambda_arn=basic_handler_fn_arn, payload=event)
 
     metrics = helpers.get_metrics(
-        start_date=execution_time,
-        end_date=execution_time + datetime.timedelta(minutes=2),
-        namespace=METRIC_NAMESPACE,
-        service_name=service,
-        metric_name=metric_name,
+        namespace=METRIC_NAMESPACE, start_date=execution_time, metric_name=metric_name, dimensions=dimensions
     )
 
     # THEN
@@ -58,11 +59,7 @@ def test_cold_start_metric(cold_start_fn_arn: str, cold_start_fn: str):
     _, execution_time = helpers.trigger_lambda(lambda_arn=cold_start_fn_arn, payload=event)
 
     metrics = helpers.get_metrics(
-        start_date=execution_time,
-        end_date=execution_time + datetime.timedelta(minutes=2),
-        namespace=METRIC_NAMESPACE,
-        metric_name=metric_name,
-        dimensions=dimensions,
+        namespace=METRIC_NAMESPACE, start_date=execution_time, metric_name=metric_name, dimensions=dimensions
     )
 
     # THEN
@@ -72,5 +69,4 @@ def test_cold_start_metric(cold_start_fn_arn: str, cold_start_fn: str):
 
 # helpers: adjust retries and wait to be much smaller
 # helpers: make retry config adjustable
-# Infra: Add temporary Powertools Layer
 # Create separate Infra class so they can live side by side

tests/e2e/utils/helpers.py

@@ -68,21 +68,50 @@ def get_metrics(
     namespace: str,
     start_date: datetime,
     metric_name: str,
-    service_name: str = "",
     dimensions: Optional[List[DimensionTypeDef]] = None,
     cw_client: Optional[CloudWatchClient] = None,
     end_date: Optional[datetime] = None,
     period: int = 60,
     stat: str = "Sum",
 ) -> MetricDataResultTypeDef:
+    """Fetch CloudWatch Metrics
+
+    It takes into account eventual consistency with up to 10 retries and 1s jitter.
+
+    Parameters
+    ----------
+    namespace : str
+        Metric Namespace
+    start_date : datetime
+        Start window to fetch metrics
+    metric_name : str
+        Metric name
+    dimensions : Optional[List[DimensionTypeDef]], optional
+        List of Metric Dimension, by default None
+    cw_client : Optional[CloudWatchClient], optional
+        Boto3 CloudWatch low-level client (boto3.client("cloudwatch"), by default None
+    end_date : Optional[datetime], optional
+        End window to fetch metrics, by default start_date + 2 minutes window
+    period : int, optional
+        Time period to fetch metrics for, by default 60
+    stat : str, optional
+        Aggregation function to use when fetching metrics, by default "Sum"
+
+    Returns
+    -------
+    MetricDataResultTypeDef
+        _description_
+
+    Raises
+    ------
+    ValueError
+        When no metric is found within retry window
+    """
     cw_client = cw_client or boto3.client("cloudwatch")
+    end_date = end_date or start_date + datetime.timedelta(minutes=2)
+
     metric_query = build_metric_query_data(
-        namespace=namespace,
-        metric_name=metric_name,
-        service_name=service_name,
-        period=period,
-        stat=stat,
-        dimensions=dimensions,
+        namespace=namespace, metric_name=metric_name, period=period, stat=stat, dimensions=dimensions
     )
 
     response = cw_client.get_metric_data(
@@ -162,17 +191,11 @@ def build_random_value(nbytes: int = 10) -> str:
 def build_metric_query_data(
     namespace: str,
     metric_name: str,
-    service_name: str = "",
     period: int = 60,
     stat: str = "Sum",
     dimensions: Optional[List[DimensionTypeDef]] = None,
 ) -> List[MetricDataQueryTypeDef]:
     dimensions = dimensions or []
-
-    # Maintenance: get rid of service_name param to avoid future mistakes
-    if service_name:
-        dimensions.append({"Name": "service", "Value": service_name})
-
     data_query: List[MetricDataQueryTypeDef] = [
         {
             "Id": metric_name.lower(),
@@ -235,24 +258,6 @@ def build_multiple_add_metric_input(
     return [{"name": metric_name, "unit": unit, "value": value} for _ in range(quantity)]
 
 
-def build_add_dimension_input(name: str, value: str) -> DimensionTypeDef:
-    """Create a dimension input to be used with either Metrics.add_dimension()
-
-    Parameters
-    ----------
-    name : str
-        dimension name
-    value : float
-        dimension value
-
-    Returns
-    -------
-    Dict
-        Metric dimension input
-    """
-    return {"Name": name, "Value": value}
-
-
 def build_add_dimensions_input(**dimensions) -> List[DimensionTypeDef]:
     """Create dimensions input to be used with either get_metrics or Metrics.add_dimension()