chore: document remaining changes, cleanup

Author: heitorlessa

tests/e2e/metrics/test_metrics.py

@@ -65,8 +65,3 @@ def test_cold_start_metric(cold_start_fn_arn: str, cold_start_fn: str):
     # THEN
     metric_data = metrics.get("Values", [])
     assert metric_data and metric_data[0] == 1.0
-
-
-# Abstract Infrastructure fixture parallelization work
-# helpers: adjust retries and wait to be much smaller
-# helpers: make retry config adjustable

tests/e2e/utils/asset.py

@@ -2,25 +2,35 @@
 import json
 import zipfile
 from pathlib import Path
-from typing import TYPE_CHECKING, List, Optional
+from typing import List, Optional
 
 import boto3
 import botocore.exceptions
+from mypy_boto3_s3 import S3Client
 
 from aws_lambda_powertools import Logger
 from tests.e2e.utils.models import AssetTemplateConfig, TemplateAssembly
 
-if TYPE_CHECKING:
-    from mypy_boto3_s3 import S3Client
-
-
 logger = Logger(service="e2e-utils")
 
 
 class Asset:
     def __init__(
-        self, config: AssetTemplateConfig, account_id: str, region: str, boto3_client: Optional["S3Client"] = None
+        self, config: AssetTemplateConfig, account_id: str, region: str, boto3_client: Optional[S3Client] = None
     ) -> None:
+        """CDK Asset logic to verify existence and resolve deeply nested configuration
+
+        Parameters
+        ----------
+        config : AssetTemplateConfig
+            CDK Asset configuration found in synthesized template
+        account_id : str
+            AWS Account ID
+        region : str
+            AWS Region
+        boto3_client : Optional["S3Client"], optional
+            S3 client instance for asset operations, by default None
+        """
         self.config = config
         self.s3 = boto3_client or boto3.client("s3")
         self.account_id = account_id
@@ -47,8 +57,21 @@ def _resolve_bucket_name(self) -> str:
 
 class Assets:
     def __init__(
-        self, cfn_template: Path, account_id: str, region: str, boto3_client: Optional["S3Client"] = None
+        self, cfn_template: Path, account_id: str, region: str, boto3_client: Optional[S3Client] = None
     ) -> None:
+        """CDK Assets logic to find each asset, compress, and upload
+
+        Parameters
+        ----------
+        cfn_template : Path
+            CloudFormation template synthesized (self.__synthesize)
+        account_id : str
+            AWS Account ID
+        region : str
+            AWS Region
+        boto3_client : Optional[S3Client], optional
+            S3 client instance for asset operations, by default None
+        """
         self.template = cfn_template
         self.account_id = account_id
         self.region = region
@@ -57,8 +80,7 @@ def __init__(
         self.assets_location = str(self.template.parent)
 
     def upload(self):
-        """
-        This method is drop-in replacement for cdk-assets package s3 upload part.
+        """Drop-in replacement for cdk-assets package s3 upload part.
         https://www.npmjs.com/package/cdk-assets.
         We use custom solution to avoid dependencies from nodejs ecosystem.
         We follow the same design cdk-assets:
@@ -96,6 +118,3 @@ def _compress_assets(self, asset: Asset) -> io.BytesIO:
                 archive.write(asset_file, arcname=asset_file.relative_to(asset_dir))
         buf.seek(0)
         return buf
-
-    def __iter__(self) -> Asset:
-        yield from self.assets

tests/e2e/utils/infrastructure.py

@@ -119,7 +119,7 @@ def __init__(self, stack_name: str, handlers_dir: str, config: dict) -> None:
         session = boto3.Session()
         self.s3_client = session.client("s3")
         self.lambda_client = session.client("lambda")
-        self.cf_client = session.client("cloudformation")
+        self.cfn = session.client("cloudformation")
         self.s3_resource = session.resource("s3")
         self.account_id = session.client("sts").get_caller_identity()["Account"]
         self.region = session.region_name
@@ -138,7 +138,7 @@ def deploy(self, Stack: Type[BaseInfrastructureStack]) -> Dict[str, str]:
         return self._transform_output(response["Stacks"][0]["Outputs"])
 
     def delete(self):
-        self.cf_client.delete_stack(StackName=self.stack_name)
+        self.cfn.delete_stack(StackName=self.stack_name)
 
     def _upload_assets(self, asset_root_dir: str, asset_manifest_file: str):
         """
@@ -181,16 +181,16 @@ def _find_files(self, directory: str) -> List:
         return file_paths
 
     def _deploy_stack(self, stack_name: str, template: dict):
-        response = self.cf_client.create_stack(
+        response = self.cfn.create_stack(
             StackName=stack_name,
             TemplateBody=yaml.dump(template),
             TimeoutInMinutes=10,
             OnFailure="ROLLBACK",
             Capabilities=["CAPABILITY_IAM"],
         )
-        waiter = self.cf_client.get_waiter("stack_create_complete")
+        waiter = self.cfn.get_waiter("stack_create_complete")
         waiter.wait(StackName=stack_name, WaiterConfig={"Delay": 10, "MaxAttempts": 50})
-        response = self.cf_client.describe_stacks(StackName=stack_name)
+        response = self.cfn.describe_stacks(StackName=stack_name)
         return response
 
     def _find_assets(self, asset_template: str, account_id: str, region: str):
@@ -220,14 +220,15 @@ class BaseInfrastructureV2(ABC):
     def __init__(self, feature_name: str, handlers_dir: Path) -> None:
         self.stack_name = f"test-{feature_name}-{uuid4()}"
         self.handlers_dir = handlers_dir
+        self.stack_outputs: Dict[str, str] = {}
         self.app = App()
         self.stack = Stack(self.app, self.stack_name)
         self.session = boto3.Session()
-        self.cf_client: CloudFormationClient = self.session.client("cloudformation")
+        self.cfn: CloudFormationClient = self.session.client("cloudformation")
+
         # NOTE: CDK stack account and region are tokens, we need to resolve earlier
         self.account_id = self.session.client("sts").get_caller_identity()["Account"]
         self.region = self.session.region_name
-        self.stack_outputs: Dict[str, str] = {}
 
     def create_lambda_functions(self, function_props: Optional[Dict] = None):
         """Create Lambda functions available under handlers_dir
@@ -242,7 +243,7 @@ def create_lambda_functions(self, function_props: Optional[Dict] = None):
             CDK Lambda FunctionProps as dictionary to override defaults
 
         Examples
-        -------
+        --------
 
         Creating Lambda functions available in the handlers directory
 
@@ -310,10 +311,8 @@ def deploy(self) -> Dict[str, str]:
         return self._deploy_stack(self.stack_name, template)
 
     def delete(self):
-        self.cf_client.delete_stack(StackName=self.stack_name)
-
-    def get_stack_outputs(self) -> Dict[str, str]:
-        return self.stack_outputs
+        """Delete CloudFormation Stack"""
+        self.cfn.delete_stack(StackName=self.stack_name)
 
     @abstractmethod
     def create_resources(self):
@@ -351,17 +350,17 @@ def _synthesize(self) -> Tuple[Dict, Path]:
         return cf_template, Path(cloud_assembly_assets_manifest_path)
 
     def _deploy_stack(self, stack_name: str, template: Dict) -> Dict[str, str]:
-        self.cf_client.create_stack(
+        self.cfn.create_stack(
             StackName=stack_name,
             TemplateBody=yaml.dump(template),
             TimeoutInMinutes=10,
             OnFailure="ROLLBACK",
             Capabilities=["CAPABILITY_IAM"],
         )
-        waiter = self.cf_client.get_waiter("stack_create_complete")
+        waiter = self.cfn.get_waiter("stack_create_complete")
         waiter.wait(StackName=stack_name, WaiterConfig={"Delay": 10, "MaxAttempts": 50})
 
-        stack_details = self.cf_client.describe_stacks(StackName=stack_name)
+        stack_details = self.cfn.describe_stacks(StackName=stack_name)
         stack_outputs = stack_details["Stacks"][0]["Outputs"]
         self.stack_outputs = {
             output["OutputKey"]: output["OutputValue"] for output in stack_outputs if output["OutputKey"]