dbt-platform-helper 13.1.0__py3-none-any.whl → 13.1.2__py3-none-any.whl

dbt_platform_helper/domain/maintenance_page.py

@@ -8,18 +8,17 @@ from typing import Callable
 from typing import List
 from typing import Union
 
-import boto3
 import click
 
 from dbt_platform_helper.platform_exception import PlatformException
 from dbt_platform_helper.providers.io import ClickIOProvider
-from dbt_platform_helper.providers.load_balancers import ListenerNotFoundException
 from dbt_platform_helper.providers.load_balancers import ListenerRuleNotFoundException
-from dbt_platform_helper.providers.load_balancers import LoadBalancerNotFoundException
-from dbt_platform_helper.providers.load_balancers import (
-    get_https_listener_for_application,
-)
+from dbt_platform_helper.providers.load_balancers import LoadBalancerProvider
 from dbt_platform_helper.utils.application import Application
+from dbt_platform_helper.utils.application import (
+    ApplicationEnvironmentNotFoundException,
+)
+from dbt_platform_helper.utils.application import ApplicationServiceNotFoundException
 from dbt_platform_helper.utils.application import Environment
 from dbt_platform_helper.utils.application import Service
 
@@ -55,21 +54,7 @@ class FailedToActivateMaintenancePageException(MaintenancePageException):
         )
 
 
-def get_maintenance_page_type(session: boto3.Session, listener_arn: str) -> Union[str, None]:
-    lb_client = session.client("elbv2")
-
-    rules = lb_client.describe_rules(ListenerArn=listener_arn)["Rules"]
-    tag_descriptions = get_rules_tag_descriptions(rules, lb_client)
-
-    maintenance_page_type = None
-    for description in tag_descriptions:
-        tags = {t["Key"]: t["Value"] for t in description["Tags"]}
-        if tags.get("name") == "MaintenancePage":
-            maintenance_page_type = tags.get("type")
-
-    return maintenance_page_type
-
-
+# TODO should this be in its own provider, inside the VPC one, what logic is this sepcific too?
 def get_env_ips(vpc: str, application_environment: Environment) -> List[str]:
     account_name = f"{application_environment.session.profile_name}-vpc"
     vpc_name = vpc if vpc else account_name
@@ -84,164 +69,19 @@ def get_env_ips(vpc: str, application_environment: Environment) -> List[str]:
     return [ip.strip() for ip in param_value.split(",")]
 
 
-def add_maintenance_page(
-    session: boto3.Session,
-    listener_arn: str,
-    app: str,
-    env: str,
-    services: List[Service],
-    allowed_ips: List[str],
-    template: str = "default",
-):
-    lb_client = session.client("elbv2")
-    maintenance_page_content = get_maintenance_page_template(template)
-    bypass_value = "".join(random.choices(string.ascii_lowercase + string.digits, k=12))
-
-    rule_priority = itertools.count(start=1)
-    maintenance_page_host_header_conditions = []
-    try:
-        for svc in services:
-            target_group_arn = find_target_group(app, env, svc.name, session)
-
-            # not all of an application's services are guaranteed to have been deployed to an environment
-            if not target_group_arn:
-                continue
-
-            service_conditions = get_host_header_conditions(
-                lb_client, listener_arn, target_group_arn
-            )
-
-            for ip in allowed_ips:
-                create_header_rule(
-                    lb_client,
-                    listener_arn,
-                    target_group_arn,
-                    "X-Forwarded-For",
-                    [ip],
-                    "AllowedIps",
-                    next(rule_priority),
-                    service_conditions,
-                )
-                create_source_ip_rule(
-                    lb_client,
-                    listener_arn,
-                    target_group_arn,
-                    [ip],
-                    "AllowedSourceIps",
-                    next(rule_priority),
-                    service_conditions,
-                )
-
-            create_header_rule(
-                lb_client,
-                listener_arn,
-                target_group_arn,
-                "Bypass-Key",
-                [bypass_value],
-                "BypassIpFilter",
-                next(rule_priority),
-                service_conditions,
-            )
-
-            # add to accumilating list of conditions for maintenace page rule
-            maintenance_page_host_header_conditions.extend(service_conditions)
-
-        click.secho(
-            f"\nUse a browser plugin to add `Bypass-Key` header with value {bypass_value} to your requests. For more detail, visit https://platform.readme.trade.gov.uk/next-steps/put-a-service-under-maintenance/",
-        )
-
-        lb_client.create_rule(
-            ListenerArn=listener_arn,
-            Priority=next(rule_priority),
-            Conditions=[
-                {
-                    "Field": "path-pattern",
-                    "PathPatternConfig": {"Values": ["/*"]},
-                },
-                {
-                    "Field": "host-header",
-                    "HostHeaderConfig": {
-                        "Values": sorted(
-                            list(
-                                {
-                                    value
-                                    for condition in maintenance_page_host_header_conditions
-                                    for value in condition["HostHeaderConfig"]["Values"]
-                                }
-                            )
-                        )
-                    },
-                },
-            ],
-            Actions=[
-                {
-                    "Type": "fixed-response",
-                    "FixedResponseConfig": {
-                        "StatusCode": "503",
-                        "ContentType": "text/html",
-                        "MessageBody": maintenance_page_content,
-                    },
-                }
-            ],
-            Tags=[
-                {"Key": "name", "Value": "MaintenancePage"},
-                {"Key": "type", "Value": template},
-            ],
-        )
-    except Exception as e:
-        deleted_rules = clean_up_maintenance_page_rules(session, listener_arn)
-        raise FailedToActivateMaintenancePageException(
-            app, env, f"{e}:\n {traceback.format_exc()}", deleted_rules
-        )
-
-
-def clean_up_maintenance_page_rules(
-    session: boto3.Session, listener_arn: str, fail_when_not_deleted: bool = False
-) -> dict[str, bool]:
-    lb_client = session.client("elbv2")
-
-    rules = lb_client.describe_rules(ListenerArn=listener_arn)["Rules"]
-    tag_descriptions = get_rules_tag_descriptions(rules, lb_client)
-
-    deletes = {}
-    for name in ["MaintenancePage", "AllowedIps", "BypassIpFilter", "AllowedSourceIps"]:
-        deleted = delete_listener_rule(tag_descriptions, name, lb_client)
-        deletes[name] = bool(deleted)
-        if fail_when_not_deleted and name == "MaintenancePage" and not deleted:
-            raise ListenerRuleNotFoundException()
-
-    return deletes
-
-
-def remove_maintenance_page(session: boto3.Session, listener_arn: str):
-    clean_up_maintenance_page_rules(session, listener_arn, True)
-
-
 class MaintenancePage:
     def __init__(
         self,
         application: Application,
         io: ClickIOProvider = ClickIOProvider(),
-        get_https_listener_for_application: Callable[
-            [boto3.Session, str, str], str
-        ] = get_https_listener_for_application,
-        # TODO refactor get_maintenance_page_type, add_maintenance_page, remove_maintenance_page into MaintenancePage class with LoadBalancerProvider as the dependency
-        get_maintenance_page_type: Callable[
-            [boto3.Session, str], Union[str, None]
-        ] = get_maintenance_page_type,
+        load_balancer_provider: LoadBalancerProvider = LoadBalancerProvider,
         get_env_ips: Callable[[str, Environment], List[str]] = get_env_ips,
-        add_maintenance_page: Callable[
-            [boto3.Session, str, str, str, List[Service], tuple, str], None
-        ] = add_maintenance_page,
-        remove_maintenance_page: Callable[[boto3.Session, str], None] = remove_maintenance_page,
     ):
         self.application = application
-        self.get_https_listener_for_application = get_https_listener_for_application
         self.io = io
-        self.get_maintenance_page_type = get_maintenance_page_type
+        self.load_balancer_provider = load_balancer_provider  # TODO requires session from environment in application object which is only known during method execution
+        self.load_balancer: LoadBalancerProvider = None
         self.get_env_ips = get_env_ips
-        self.add_maintenance_page = add_maintenance_page
-        self.remove_maintenance_page = remove_maintenance_page
 
     def _get_deployed_load_balanced_web_services(self, app: Application, svc: List[str]):
         if "*" in svc:
@@ -253,155 +93,229 @@ class MaintenancePage:
             raise LoadBalancedWebServiceNotFoundException(app.name)
         return services
 
+    # TODO: inject load balancer provider in activate method to avoid passing load balancer provider in init?
     def activate(self, env: str, services: List[str], template: str, vpc: Union[str, None]):
 
         services = self._get_deployed_load_balanced_web_services(self.application, services)
         application_environment = get_app_environment(self.application, env)
+        self.load_balancer = self.load_balancer_provider(application_environment.session)
 
-        try:
-            https_listener = self.get_https_listener_for_application(
-                application_environment.session, self.application.name, env
-            )
-            current_maintenance_page = self.get_maintenance_page_type(
-                application_environment.session, https_listener
+        https_listener = self.load_balancer.get_https_listener_for_application(
+            self.application.name, env
+        )
+        current_maintenance_page = self.__get_maintenance_page_type(https_listener)
+        remove_current_maintenance_page = False
+        if current_maintenance_page:
+            remove_current_maintenance_page = self.io.confirm(
+                f"There is currently a '{current_maintenance_page}' maintenance page for the {env} "
+                f"environment in {self.application.name}.\nWould you like to replace it with a '{template}' "
+                f"maintenance page?"
             )
-            remove_current_maintenance_page = False
-            if current_maintenance_page:
-                remove_current_maintenance_page = self.io.confirm(
-                    f"There is currently a '{current_maintenance_page}' maintenance page for the {env} "
-                    f"environment in {self.application.name}.\nWould you like to replace it with a '{template}' "
-                    f"maintenance page?"
-                )
-                if not remove_current_maintenance_page:
-                    return
-
-            if remove_current_maintenance_page or self.io.confirm(
-                f"You are about to enable the '{template}' maintenance page for the {env} "
-                f"environment in {self.application.name}.\nWould you like to continue?"
-            ):
-                if current_maintenance_page and remove_current_maintenance_page:
-                    self.remove_maintenance_page(application_environment.session, https_listener)
-
-                allowed_ips = self.get_env_ips(vpc, application_environment)
-
-                self.add_maintenance_page(
-                    application_environment.session,
-                    https_listener,
-                    self.application.name,
-                    env,
-                    services,
-                    allowed_ips,
-                    template,
-                )
-                self.io.info(
-                    f"Maintenance page '{template}' added for environment {env} in application {self.application.name}",
-                )
+            if not remove_current_maintenance_page:
+                return
 
-        except LoadBalancerNotFoundException:
-            # TODO push exception to command layer
-            self.io.abort_with_error(
-                f"No load balancer found for environment {env} in the application {self.application.name}.",
+        if remove_current_maintenance_page or self.io.confirm(
+            f"You are about to enable the '{template}' maintenance page for the {env} "
+            f"environment in {self.application.name}.\nWould you like to continue?"
+        ):
+            if current_maintenance_page and remove_current_maintenance_page:
+                self.__remove_maintenance_page(https_listener)
+
+            allowed_ips = self.get_env_ips(vpc, application_environment)
+
+            self.add_maintenance_page(
+                https_listener,
+                self.application.name,
+                env,
+                services,
+                allowed_ips,
+                template,
             )
-
-        except ListenerNotFoundException:
-            # TODO push exception to command layer
-            self.io.abort_with_error(
-                f"No HTTPS listener found for environment {env} in the application {self.application.name}.",
+            self.io.info(
+                f"Maintenance page '{template}' added for environment {env} in application {self.application.name}",
             )
 
     def deactivate(self, env: str):
         application_environment = get_app_environment(self.application, env)
 
+        self.load_balancer = self.load_balancer_provider(application_environment.session)
+
+        https_listener = self.load_balancer.get_https_listener_for_application(
+            self.application.name, env
+        )
+        current_maintenance_page = self.__get_maintenance_page_type(https_listener)
+
+        if not current_maintenance_page:
+            self.io.warn("There is no current maintenance page to remove")
+            return
+
+        if not self.io.confirm(
+            f"There is currently a '{current_maintenance_page}' maintenance page, "
+            f"would you like to remove it?"
+        ):
+            return
+
+        self.__remove_maintenance_page(https_listener)
+        self.io.info(
+            f"Maintenance page removed from environment {env} in application {self.application.name}",
+        )
+
+    def add_maintenance_page(
+        self,
+        listener_arn: str,
+        app: str,
+        env: str,
+        services: List[Service],
+        allowed_ips: List[str],
+        template: str = "default",
+    ):
+
+        maintenance_page_content = get_maintenance_page_template(template)
+        bypass_value = "".join(random.choices(string.ascii_lowercase + string.digits, k=12))
+
+        rule_priority = itertools.count(start=1)
+        maintenance_page_host_header_conditions = []
         try:
-            https_listener = self.get_https_listener_for_application(
-                application_environment.session, self.application.name, env
-            )
-            current_maintenance_page = self.get_maintenance_page_type(
-                application_environment.session, https_listener
-            )
+            for svc in services:
+                target_group_arn = self.load_balancer.find_target_group(app, env, svc.name)
 
-            # TODO discuss, reduce number of return statements but more nested if statements
-            if not current_maintenance_page:
-                self.io.warn("There is no current maintenance page to remove")
-                return
+                # not all of an application's services are guaranteed to have been deployed to an environment
+                if not target_group_arn:
+                    continue
 
-            if not self.io.confirm(
-                f"There is currently a '{current_maintenance_page}' maintenance page, "
-                f"would you like to remove it?"
-            ):
-                return
+                service_conditions = self.load_balancer.get_host_header_conditions(
+                    listener_arn, target_group_arn
+                )
+
+                for ip in allowed_ips:
+                    self.load_balancer.create_header_rule(
+                        listener_arn,
+                        target_group_arn,
+                        "X-Forwarded-For",
+                        [ip],
+                        "AllowedIps",
+                        next(rule_priority),
+                        service_conditions,
+                    )
+                    self.load_balancer.create_source_ip_rule(
+                        listener_arn,
+                        target_group_arn,
+                        [ip],
+                        "AllowedSourceIps",
+                        next(rule_priority),
+                        service_conditions,
+                    )
+
+                self.load_balancer.create_header_rule(
+                    listener_arn,
+                    target_group_arn,
+                    "Bypass-Key",
+                    [bypass_value],
+                    "BypassIpFilter",
+                    next(rule_priority),
+                    service_conditions,
+                )
+
+                # add to accumilating list of conditions for maintenace page rule
+                maintenance_page_host_header_conditions.extend(service_conditions)
 
-            self.remove_maintenance_page(application_environment.session, https_listener)
             self.io.info(
-                f"Maintenance page removed from environment {env} in application {self.application.name}",
+                f"\nUse a browser plugin to add `Bypass-Key` header with value {bypass_value} to your requests. For more detail, visit https://platform.readme.trade.gov.uk/next-steps/put-a-service-under-maintenance/",
             )
 
-        except LoadBalancerNotFoundException:
-            # TODO push exception to command layer
-            self.io.abort_with_error(
-                f"No load balancer found for environment {env} in the application {self.application.name}.",
+            self.load_balancer.create_rule(
+                listener_arn=listener_arn,
+                priority=next(rule_priority),
+                conditions=[
+                    {
+                        "Field": "path-pattern",
+                        "PathPatternConfig": {"Values": ["/*"]},
+                    },
+                    {
+                        "Field": "host-header",
+                        "HostHeaderConfig": {
+                            "Values": sorted(
+                                list(
+                                    {
+                                        value
+                                        for condition in maintenance_page_host_header_conditions
+                                        for value in condition["HostHeaderConfig"]["Values"]
+                                    }
+                                )
+                            )
+                        },
+                    },
+                ],
+                actions=[
+                    {
+                        "Type": "fixed-response",
+                        "FixedResponseConfig": {
+                            "StatusCode": "503",
+                            "ContentType": "text/html",
+                            "MessageBody": maintenance_page_content,
+                        },
+                    }
+                ],
+                tags=[
+                    {"Key": "name", "Value": "MaintenancePage"},
+                    {"Key": "type", "Value": template},
+                ],
             )
-
-        except ListenerNotFoundException:
-            # TODO push exception to command layer
-            self.io.abort_with_error(
-                f"No HTTPS listener found for environment {env} in the application {self.application.name}.",
+        except Exception as e:
+            deleted_rules = self.__clean_up_maintenance_page_rules(listener_arn)
+            raise FailedToActivateMaintenancePageException(
+                app, env, f"{e}:\n {traceback.format_exc()}", deleted_rules
             )
 
+    def __clean_up_maintenance_page_rules(
+        self, listener_arn: str, fail_when_not_deleted: bool = False
+    ) -> dict[str, bool]:
 
-def get_app_service(application: Application, svc_name: str) -> Service:
-    application_service = application.services.get(svc_name)
-
-    if not application_service:
-        # TODO raise exception instead of abort
-        click.secho(
-            f"The service {svc_name} was not found in the application {application.name}. "
-            f"It either does not exist, or has not been deployed.",
-            fg="red",
+        tag_descriptions = self.load_balancer.get_rules_tag_descriptions_by_listener_arn(
+            listener_arn
         )
-        raise click.Abort
 
-    return application_service
+        deletes = {}
+        for name in ["MaintenancePage", "AllowedIps", "BypassIpFilter", "AllowedSourceIps"]:
+            deleted = self.load_balancer.delete_listener_rule_by_tags(tag_descriptions, name)
+            deletes[name] = bool(deleted)
+            if fail_when_not_deleted and name == "MaintenancePage" and not deleted:
+                raise ListenerRuleNotFoundException()
 
+        return deletes
 
-def get_app_environment(application: Application, env_name: str) -> Environment:
-    application_environment = application.environments.get(env_name)
+    def __remove_maintenance_page(self, listener_arn: str) -> dict[str, bool]:
+        self.__clean_up_maintenance_page_rules(listener_arn, True)
 
-    if not application_environment:
-        click.secho(
-            f"The environment {env_name} was not found in the application {application.name}. "
-            f"It either does not exist, or has not been deployed.",
-            fg="red",
+    def __get_maintenance_page_type(self, listener_arn: str) -> Union[str, None]:
+        tag_descriptions = self.load_balancer.get_rules_tag_descriptions_by_listener_arn(
+            listener_arn
         )
-        raise click.Abort
+        maintenance_page_type = None
+        for description in tag_descriptions:
+            tags = {t["Key"]: t["Value"] for t in description["Tags"]}
+            if tags.get("name") == "MaintenancePage":
+                maintenance_page_type = tags.get("type")
 
-    return application_environment
+        return maintenance_page_type
 
 
-def get_rules_tag_descriptions(rules: list, lb_client):
-    tag_descriptions = []
-    chunk_size = 20
+def get_app_service(application: Application, svc_name: str) -> Service:
+    application_service = application.services.get(svc_name)
 
-    for i in range(0, len(rules), chunk_size):
-        chunk = rules[i : i + chunk_size]
-        resource_arns = [r["RuleArn"] for r in chunk]
-        response = lb_client.describe_tags(ResourceArns=resource_arns)
-        tag_descriptions.extend(response["TagDescriptions"])
+    if not application_service:
+        raise ApplicationServiceNotFoundException(application.name, svc_name)
 
-    return tag_descriptions
+    return application_service
 
 
-def delete_listener_rule(tag_descriptions: list, tag_name: str, lb_client: boto3.client):
-    current_rule_arn = None
+def get_app_environment(application: Application, env_name: str) -> Environment:
+    application_environment = application.environments.get(env_name)
 
-    for description in tag_descriptions:
-        tags = {t["Key"]: t["Value"] for t in description["Tags"]}
-        if tags.get("name") == tag_name:
-            current_rule_arn = description["ResourceArn"]
-            if current_rule_arn:
-                lb_client.delete_rule(RuleArn=current_rule_arn)
+    if not application_environment:
+        raise ApplicationEnvironmentNotFoundException(application.name, env_name)
 
-    return current_rule_arn
+    return application_environment
 
 
 def get_maintenance_page_template(template) -> str:
@@ -416,148 +330,3 @@ def get_maintenance_page_template(template) -> str:
 
     # [^\S]\s+ - Remove any space that is not preceded by a non-space character.
     return re.sub(r"[^\S]\s+", "", template_contents)
-
-
-def find_target_group(app: str, env: str, svc: str, session: boto3.Session) -> str:
-    rg_tagging_client = session.client("resourcegroupstaggingapi")
-    response = rg_tagging_client.get_resources(
-        TagFilters=[
-            {
-                "Key": "copilot-application",
-                "Values": [
-                    app,
-                ],
-                "Key": "copilot-environment",
-                "Values": [
-                    env,
-                ],
-                "Key": "copilot-service",
-                "Values": [
-                    svc,
-                ],
-            },
-        ],
-        ResourceTypeFilters=[
-            "elasticloadbalancing:targetgroup",
-        ],
-    )
-    for resource in response["ResourceTagMappingList"]:
-        tags = {tag["Key"]: tag["Value"] for tag in resource["Tags"]}
-
-        if (
-            "copilot-service" in tags
-            and tags["copilot-service"] == svc
-            and "copilot-environment" in tags
-            and tags["copilot-environment"] == env
-            and "copilot-application" in tags
-            and tags["copilot-application"] == app
-        ):
-            return resource["ResourceARN"]
-
-    click.secho(
-        f"No target group found for application: {app}, environment: {env}, service: {svc}",
-        fg="red",
-    )
-
-    return None
-
-
-def create_header_rule(
-    lb_client: boto3.client,
-    listener_arn: str,
-    target_group_arn: str,
-    header_name: str,
-    values: list,
-    rule_name: str,
-    priority: int,
-    conditions: list,
-):
-    # add new condition to existing conditions
-    combined_conditions = [
-        {
-            "Field": "http-header",
-            "HttpHeaderConfig": {"HttpHeaderName": header_name, "Values": values},
-        }
-    ] + conditions
-
-    lb_client.create_rule(
-        ListenerArn=listener_arn,
-        Priority=priority,
-        Conditions=combined_conditions,
-        Actions=[{"Type": "forward", "TargetGroupArn": target_group_arn}],
-        Tags=[
-            {"Key": "name", "Value": rule_name},
-        ],
-    )
-
-    click.secho(
-        f"Creating listener rule {rule_name} for HTTPS Listener with arn {listener_arn}.\n\nIf request header {header_name} contains one of the values {values}, the request will be forwarded to target group with arn {target_group_arn}.",
-        fg="green",
-    )
-
-
-def normalise_to_cidr(ip: str):
-    if "/" in ip:
-        return ip
-    SINGLE_IPV4_CIDR_PREFIX_LENGTH = "32"
-    return f"{ip}/{SINGLE_IPV4_CIDR_PREFIX_LENGTH}"
-
-
-def create_source_ip_rule(
-    lb_client: boto3.client,
-    listener_arn: str,
-    target_group_arn: str,
-    values: list,
-    rule_name: str,
-    priority: int,
-    conditions: list,
-):
-    # add new condition to existing conditions
-
-    combined_conditions = [
-        {
-            "Field": "source-ip",
-            "SourceIpConfig": {"Values": [normalise_to_cidr(value) for value in values]},
-        }
-    ] + conditions
-
-    lb_client.create_rule(
-        ListenerArn=listener_arn,
-        Priority=priority,
-        Conditions=combined_conditions,
-        Actions=[{"Type": "forward", "TargetGroupArn": target_group_arn}],
-        Tags=[
-            {"Key": "name", "Value": rule_name},
-        ],
-    )
-
-    click.secho(
-        f"Creating listener rule {rule_name} for HTTPS Listener with arn {listener_arn}.\n\nIf request source ip matches one of the values {values}, the request will be forwarded to target group with arn {target_group_arn}.",
-        fg="green",
-    )
-
-
-def get_host_header_conditions(
-    lb_client: boto3.client, listener_arn: str, target_group_arn: str
-) -> list:
-    rules = lb_client.describe_rules(ListenerArn=listener_arn)["Rules"]
-
-    # Get current set of forwarding conditions for the target group
-    for rule in rules:
-        for action in rule["Actions"]:
-            if action["Type"] == "forward" and action["TargetGroupArn"] == target_group_arn:
-                conditions = rule["Conditions"]
-
-    # filter to host-header conditions
-    conditions = [
-        {i: condition[i] for i in condition if i != "Values"}
-        for condition in conditions
-        if condition["Field"] == "host-header"
-    ]
-
-    # remove internal hosts
-    conditions[0]["HostHeaderConfig"]["Values"] = [
-        v for v in conditions[0]["HostHeaderConfig"]["Values"]
-    ]
-
-    return conditions