chore: address everyone's feedback

Author: heitorlessa

tests/e2e/metrics/conftest.py

@@ -10,8 +10,12 @@ def infrastructure(request: pytest.FixtureRequest, tmp_path_factory: pytest.Temp
 
     Parameters
     ----------
-    request : fixtures.SubRequest
-        test fixture containing metadata about test execution
+    request : pytest.FixtureRequest
+        pytest request fixture to introspect absolute path to test being executed
+    tmp_path_factory : pytest.TempPathFactory
+        pytest temporary path factory to discover shared tmp when multiple CPU processes are spun up
+    worker_id : str
+        pytest-xdist worker identification to detect whether parallelization is enabled
 
     Yields
     ------

tests/e2e/tracer/conftest.py

@@ -10,8 +10,12 @@ def infrastructure(request: pytest.FixtureRequest, tmp_path_factory: pytest.Temp
 
     Parameters
     ----------
-    request : fixtures.SubRequest
-        test fixture containing metadata about test execution
+    request : pytest.FixtureRequest
+        pytest request fixture to introspect absolute path to test being executed
+    tmp_path_factory : pytest.TempPathFactory
+        pytest temporary path factory to discover shared tmp when multiple CPU processes are spun up
+    worker_id : str
+        pytest-xdist worker identification to detect whether parallelization is enabled
 
     Yields
     ------

tests/e2e/tracer/handlers/sync_async_capture.py

@@ -14,6 +14,8 @@ def get_todos():
 
 @tracer.capture_method
 async def async_get_users():
+    # dummy block to prevent basic failures where
+    # we weren't priming coroutines correctly in the past but returning unresolved
     await asyncio.sleep(1)
     return [{"id": f"{uuid4()}"} for _ in range(5)]
 

tests/e2e/tracer/infrastructure.py

@@ -12,6 +12,6 @@ class TracerStack(BaseInfrastructureV2):
     def __init__(self, handlers_dir: Path, feature_name: str = "tracer") -> None:
         super().__init__(feature_name, handlers_dir)
 
-    def create_resources(self):
+    def create_resources(self) -> None:
         env_vars = {"POWERTOOLS_SERVICE_NAME": self.SERVICE_NAME}
         self.create_lambda_functions(function_props={"environment": env_vars})

tests/e2e/utils/data_builder/metrics.py

@@ -13,6 +13,26 @@ def build_metric_query_data(
     stat: str = "Sum",
     dimensions: Optional[List[DimensionTypeDef]] = None,
 ) -> List[MetricDataQueryTypeDef]:
+    """Create input for CloudWatch GetMetricData API call
+
+    Parameters
+    ----------
+    namespace : str
+        Metric namespace to search for
+    metric_name : str
+        Metric name to search for
+    period : int, optional
+        Time period in seconds to search metrics, by default 60
+    stat : str, optional
+        Aggregate function to use for results, by default "Sum"
+    dimensions : Optional[List[DimensionTypeDef]], optional
+        Metric dimensions to search for, by default None
+
+    Returns
+    -------
+    List[MetricDataQueryTypeDef]
+        _description_
+    """
     dimensions = dimensions or []
     data_query: List[MetricDataQueryTypeDef] = [
         {

tests/e2e/utils/data_fetcher/metrics.py

@@ -46,7 +46,7 @@ def get_metrics(
     Returns
     -------
     MetricDataResultTypeDef
-        _description_
+        Dict with metric values found
 
     Raises
     ------

tests/e2e/utils/infrastructure.py

@@ -312,12 +312,12 @@ def deploy(self) -> Dict[str, str]:
         assets.upload()
         return self._deploy_stack(self.stack_name, template)
 
-    def delete(self):
+    def delete(self) -> None:
         """Delete CloudFormation Stack"""
         self.cfn.delete_stack(StackName=self.stack_name)
 
     @abstractmethod
-    def create_resources(self):
+    def create_resources(self) -> None:
         """Create any necessary CDK resources. It'll be called before deploy
 
         Examples