dbt-platform-helper 12.5.0__py3-none-any.whl → 12.6.0__py3-none-any.whl

dbt_platform_helper/providers/load_balancers.py

@@ -2,8 +2,11 @@ import boto3
 
 from dbt_platform_helper.platform_exception import PlatformException
 
+# TODO - a good candidate for a dataclass when this is refactored into a class.
+# Below methods should also really be refactored to not be so tightly coupled with eachother.
 
-def find_load_balancer(session: boto3.Session, app: str, env: str) -> str:
+
+def get_load_balancer_for_application(session: boto3.Session, app: str, env: str) -> str:
     lb_client = session.client("elbv2")
 
     describe_response = lb_client.describe_load_balancers()
@@ -23,8 +26,8 @@ def find_load_balancer(session: boto3.Session, app: str, env: str) -> str:
     return load_balancer_arn
 
 
-def find_https_listener(session: boto3.Session, app: str, env: str) -> str:
-    load_balancer_arn = find_load_balancer(session, app, env)
+def get_https_listener_for_application(session: boto3.Session, app: str, env: str) -> str:
+    load_balancer_arn = get_load_balancer_for_application(session, app, env)
     lb_client = session.client("elbv2")
     listeners = lb_client.describe_listeners(LoadBalancerArn=load_balancer_arn)["Listeners"]
 
@@ -41,6 +44,22 @@ def find_https_listener(session: boto3.Session, app: str, env: str) -> str:
     return listener_arn
 
 
+def get_https_certificate_for_application(session: boto3.Session, app: str, env: str) -> str:
+
+    listener_arn = get_https_listener_for_application(session, app, env)
+    cert_client = session.client("elbv2")
+    certificates = cert_client.describe_listener_certificates(ListenerArn=listener_arn)[
+        "Certificates"
+    ]
+
+    try:
+        certificate_arn = next(c["CertificateArn"] for c in certificates if c["IsDefault"])
+    except StopIteration:
+        raise CertificateNotFoundException(env)
+
+    return certificate_arn
+
+
 class LoadBalancerException(PlatformException):
     pass
 
@@ -55,3 +74,10 @@ class ListenerNotFoundException(LoadBalancerException):
 
 class ListenerRuleNotFoundException(LoadBalancerException):
     pass
+
+
+class CertificateNotFoundException(PlatformException):
+    def __init__(self, environment_name: str):
+        super().__init__(
+            f"""No certificate found with domain name matching environment {environment_name}."."""
+        )

dbt_platform_helper/providers/platform_config_schema.py

@@ -443,14 +443,17 @@ class PlatformConfigSchema:
                 error=f"{key} must contain a valid ARN for an S3 bucket",
             )
 
+        _single_import_config = {
+            Optional("source_kms_key_arn"): PlatformConfigSchema.__valid_kms_key_arn(
+                "source_kms_key_arn"
+            ),
+            "source_bucket_arn": _valid_s3_bucket_arn("source_bucket_arn"),
+            "worker_role_arn": PlatformConfigSchema.__valid_iam_role_arn("worker_role_arn"),
+        }
+
         _valid_s3_data_migration = {
-            "import": {
-                Optional("source_kms_key_arn"): PlatformConfigSchema.__valid_kms_key_arn(
-                    "source_kms_key_arn"
-                ),
-                "source_bucket_arn": _valid_s3_bucket_arn("source_bucket_arn"),
-                "worker_role_arn": PlatformConfigSchema.__valid_iam_role_arn("worker_role_arn"),
-            },
+            Optional("import"): _single_import_config,
+            Optional("import_sources"): [_single_import_config],
         }
 
         _valid_s3_bucket_retention_policy = Or(

dbt_platform_helper/providers/vpc.py

@@ -0,0 +1,106 @@
+from dataclasses import dataclass
+
+from dbt_platform_helper.platform_exception import PlatformException
+
+
+class VpcProviderException(PlatformException):
+    pass
+
+
+class SubnetsNotFoundException(VpcProviderException):
+    pass
+
+
+class PrivateSubnetsNotFoundException(VpcProviderException):
+    pass
+
+
+class PublicSubnetsNotFoundException(VpcProviderException):
+    pass
+
+
+class SecurityGroupNotFoundException(VpcProviderException):
+    pass
+
+
+class VpcNotFoundForNameException(VpcProviderException):
+    pass
+
+
+class VpcIdMissingException(VpcProviderException):
+    pass
+
+
+@dataclass
+class Vpc:
+    id: str
+    public_subnets: list[str]
+    private_subnets: list[str]
+    security_groups: list[str]
+
+
+class VpcProvider:
+    def __init__(self, session):
+        self.ec2_client = session.client("ec2")
+
+    def _get_subnet_ids(self, vpc_id):
+        subnets = self.ec2_client.describe_subnets(
+            Filters=[{"Name": "vpc-id", "Values": [vpc_id]}]
+        ).get("Subnets")
+
+        if not subnets:
+            raise SubnetsNotFoundException(f"No subnets found for VPC with id: {vpc_id}.")
+
+        public_tag = {"Key": "subnet_type", "Value": "public"}
+        public_subnets = [subnet["SubnetId"] for subnet in subnets if public_tag in subnet["Tags"]]
+
+        private_tag = {"Key": "subnet_type", "Value": "private"}
+        private_subnets = [
+            subnet["SubnetId"] for subnet in subnets if private_tag in subnet["Tags"]
+        ]
+
+        return public_subnets, private_subnets
+
+    def _get_vpc_id_by_name(self, vpc_name: str) -> str:
+        vpcs = self.ec2_client.describe_vpcs(
+            Filters=[{"Name": "tag:Name", "Values": [vpc_name]}]
+        ).get("Vpcs", [])
+
+        if not vpcs:
+            raise VpcNotFoundForNameException(f"VPC not found for name '{vpc_name}'")
+
+        vpc_id = vpcs[0].get("VpcId")
+
+        if not vpc_id:
+            raise VpcIdMissingException(f"VPC id not present in vpc '{vpc_name}'")
+
+        return vpc_id
+
+    def _get_security_groups(self, app: str, env: str, vpc_id: str) -> list:
+
+        vpc_filter = {"Name": "vpc-id", "Values": [vpc_id]}
+        tag_filter = {"Name": f"tag:Name", "Values": [f"copilot-{app}-{env}-env"]}
+        response = self.ec2_client.describe_security_groups(Filters=[vpc_filter, tag_filter])
+
+        return [sg.get("GroupId") for sg in response.get("SecurityGroups")]
+
+    def get_vpc(self, app: str, env: str, vpc_name: str) -> Vpc:
+
+        vpc_id = self._get_vpc_id_by_name(vpc_name)
+
+        public_subnets, private_subnets = self._get_subnet_ids(vpc_id)
+
+        if not private_subnets:
+            raise PrivateSubnetsNotFoundException(f"No private subnets found in vpc '{vpc_name}'")
+
+        if not public_subnets:
+            raise PublicSubnetsNotFoundException(f"No public subnets found in vpc '{vpc_name}'")
+
+        sec_groups = self._get_security_groups(app, env, vpc_id)
+
+        if not sec_groups:
+            raise SecurityGroupNotFoundException(
+                f"No matching security groups found in vpc '{vpc_name}'"
+            )
+
+        return Vpc(vpc_id, public_subnets, private_subnets, sec_groups)

dbt_platform_helper/providers/yaml_file.py

@@ -1,5 +1,3 @@
-from abc import ABC
-from abc import abstractmethod
 from pathlib import Path
 
 import yaml
@@ -16,7 +14,7 @@ class YamlFileProviderException(FileProviderException):
     pass
 
 
-class FileNotFoundException(YamlFileProviderException):
+class FileNotFoundException(FileProviderException):
     pass
 
 
@@ -28,13 +26,7 @@ class DuplicateKeysException(YamlFileProviderException):
     pass
 
 
-class FileProvider(ABC):
-    @abstractmethod
-    def load(path: str) -> dict:
-        raise NotImplementedError("Implement this in the subclass")
-
-
-class YamlFileProvider(FileProvider):
+class YamlFileProvider:
     def load(path: str) -> dict:
         """
         Raises:
@@ -43,10 +35,7 @@ class YamlFileProvider(FileProvider):
             DuplicateKeysException: yaml contains duplicate keys
         """
         if not Path(path).exists():
-            # TODO this error message is domain specific and should not mention deployment directory project here
-            raise FileNotFoundException(
-                f"`{path}` is missing. Please check it exists and you are in the root directory of your deployment project."
-            )
+            raise FileNotFoundException(f"`{path}` is missing.")
         try:
             yaml_content = yaml.safe_load(Path(path).read_text())
         except ParserError:

dbt_platform_helper/templates/COMMANDS.md.jinja

@@ -1,8 +1,10 @@
 # Commands Reference
 
-{% for command in toc -%}
-- [{{ command }}](#{{ command.lower() | replace(" ", "-") }})
-{% endfor %}
+{% for meta in metadata -%}
+{% if meta.name -%}
+{{ meta.indent }}- [{{ meta.name }}](#{{ meta.name.lower() | replace(" ", "-") }})
+{% endif -%}
+{% endfor -%}
 
 {%- for meta in metadata +%}
 {% if meta.name -%}