dbt-platform-helper 12.2.4__py3-none-any.whl → 12.4.0__py3-none-any.whl

dbt_platform_helper/domain/codebase.py

@@ -9,11 +9,9 @@ import requests
 import yaml
 from boto3 import Session
 
-from dbt_platform_helper.exceptions import ApplicationDeploymentNotTriggered
-from dbt_platform_helper.exceptions import ApplicationEnvironmentNotFoundError
-from dbt_platform_helper.exceptions import NoCopilotCodebasesFoundError
-from dbt_platform_helper.exceptions import NotInCodeBaseRepositoryError
+from dbt_platform_helper.platform_exception import PlatformException
 from dbt_platform_helper.utils.application import Application
+from dbt_platform_helper.utils.application import ApplicationException
 from dbt_platform_helper.utils.application import load_application
 from dbt_platform_helper.utils.aws import check_codebase_exists
 from dbt_platform_helper.utils.aws import check_image_exists
@@ -29,31 +27,31 @@ from dbt_platform_helper.utils.template import setup_templates
 class Codebase:
     def __init__(
         self,
-        input_fn: Callable[[str], str] = click.prompt,
-        echo_fn: Callable[[str], str] = click.secho,
-        confirm_fn: Callable[[str], bool] = click.confirm,
-        load_application_fn: Callable[[str], Application] = load_application,
-        get_aws_session_or_abort_fn: Callable[[str], Session] = get_aws_session_or_abort,
-        check_codebase_exists_fn: Callable[[str], str] = check_codebase_exists,
-        check_image_exists_fn: Callable[[str], str] = check_image_exists,
-        get_build_url_from_arn_fn: Callable[[str], str] = get_build_url_from_arn,
-        list_latest_images_fn: Callable[[str], str] = list_latest_images,
-        start_build_extraction_fn: Callable[[str], str] = start_build_extraction,
-        check_if_commit_exists_fn: Callable[[str], str] = check_if_commit_exists,
-        subprocess: Callable[[str], str] = subprocess.run,
+        input: Callable[[str], str] = click.prompt,
+        echo: Callable[[str], str] = click.secho,
+        confirm: Callable[[str], bool] = click.confirm,
+        load_application: Callable[[str], Application] = load_application,
+        get_aws_session_or_abort: Callable[[str], Session] = get_aws_session_or_abort,
+        check_codebase_exists: Callable[[str], str] = check_codebase_exists,
+        check_image_exists: Callable[[str], str] = check_image_exists,
+        get_build_url_from_arn: Callable[[str], str] = get_build_url_from_arn,
+        list_latest_images: Callable[[str], str] = list_latest_images,
+        start_build_extraction: Callable[[str], str] = start_build_extraction,
+        check_if_commit_exists: Callable[[str], str] = check_if_commit_exists,
+        run_subprocess: Callable[[str], str] = subprocess.run,
     ):
-        self.input_fn = input_fn
-        self.echo_fn = echo_fn
-        self.confirm_fn = confirm_fn
-        self.load_application_fn = load_application_fn
-        self.get_aws_session_or_abort_fn = get_aws_session_or_abort_fn
-        self.check_codebase_exists_fn = check_codebase_exists_fn
-        self.check_image_exists_fn = check_image_exists_fn
-        self.get_build_url_from_arn_fn = get_build_url_from_arn_fn
-        self.list_latest_images_fn = list_latest_images_fn
-        self.start_build_extraction_fn = start_build_extraction_fn
-        self.check_if_commit_exists_fn = check_if_commit_exists_fn
-        self.subprocess = subprocess
+        self.input = input
+        self.echo = echo
+        self.confirm = confirm
+        self.load_application = load_application
+        self.get_aws_session_or_abort = get_aws_session_or_abort
+        self.check_codebase_exists = check_codebase_exists
+        self.check_image_exists = check_image_exists
+        self.get_build_url_from_arn = get_build_url_from_arn
+        self.list_latest_images = list_latest_images
+        self.start_build_extraction = start_build_extraction
+        self.check_if_commit_exists = check_if_commit_exists
+        self.run_subprocess = run_subprocess
 
     def prepare(self):
         """Sets up an application codebase for use within a DBT platform
@@ -61,13 +59,15 @@ class Codebase:
         templates = setup_templates()
 
         repository = (
-            self.subprocess(["git", "remote", "get-url", "origin"], capture_output=True, text=True)
+            self.run_subprocess(
+                ["git", "remote", "get-url", "origin"], capture_output=True, text=True
+            )
             .stdout.split("/")[-1]
             .strip()
             .removesuffix(".git")
         )
         if repository.endswith("-deploy") or Path("./copilot").exists():
-            raise NotInCodeBaseRepositoryError
+            raise NotInCodeBaseRepositoryException()
 
         builder_configuration_url = "https://raw.githubusercontent.com/uktrade/ci-image-builder/main/image_builder/configuration/builder_configuration.yml"
         builder_configuration_response = requests.get(builder_configuration_url)
@@ -91,7 +91,7 @@ class Codebase:
         config_contents = templates.get_template(f".copilot/config.yml").render(
             repository=repository, builder_version=builder_version
         )
-        self.echo_fn(
+        self.echo(
             mkfile(
                 Path("."), ".copilot/image_build_run.sh", image_build_run_contents, overwrite=True
             )
@@ -100,27 +100,27 @@ class Codebase:
         image_build_run_file = Path(".copilot/image_build_run.sh")
         image_build_run_file.chmod(image_build_run_file.stat().st_mode | stat.S_IEXEC)
 
-        self.echo_fn(mkfile(Path("."), ".copilot/config.yml", config_contents, overwrite=True))
+        self.echo(mkfile(Path("."), ".copilot/config.yml", config_contents, overwrite=True))
 
         for phase in ["build", "install", "post_build", "pre_build"]:
             phase_contents = templates.get_template(f".copilot/phases/{phase}.sh").render()
 
-            self.echo_fn(
+            self.echo(
                 mkfile(Path("./.copilot"), f"phases/{phase}.sh", phase_contents, overwrite=True)
             )
 
     def build(self, app: str, codebase: str, commit: str):
         """Trigger a CodePipeline pipeline based build."""
-        session = self.get_aws_session_or_abort_fn()
-        self.load_application_fn(app, default_session=session)
+        session = self.get_aws_session_or_abort()
+        self.load_application(app, default_session=session)
 
-        self.check_if_commit_exists_fn(commit)
+        self.check_if_commit_exists(commit)
 
         codebuild_client = session.client("codebuild")
         build_url = self.__start_build_with_confirmation(
-            self.confirm_fn,
+            self.confirm,
             codebuild_client,
-            self.get_build_url_from_arn_fn,
+            self.get_build_url_from_arn,
             f'You are about to build "{app}" for "{codebase}" with commit "{commit}". Do you want to continue?',
             {
                 "projectName": f"codebuild-{app}-{codebase}",
@@ -130,29 +130,29 @@ class Codebase:
         )
 
         if build_url:
-            return self.echo_fn(
+            return self.echo(
                 f"Your build has been triggered. Check your build progress in the AWS Console: {build_url}"
             )
 
-        raise ApplicationDeploymentNotTriggered()
+        raise ApplicationDeploymentNotTriggered(codebase)
 
     def deploy(self, app, env, codebase, commit):
         """Trigger a CodePipeline pipeline based deployment."""
-        session = self.get_aws_session_or_abort_fn()
+        session = self.get_aws_session_or_abort()
 
-        application = self.load_application_fn(app, default_session=session)
+        application = self.load_application(app, default_session=session)
         if not application.environments.get(env):
-            raise ApplicationEnvironmentNotFoundError()
+            raise ApplicationEnvironmentNotFoundException(env)
 
-        self.check_codebase_exists_fn(session, application, codebase)
+        self.check_codebase_exists(session, application, codebase)
 
-        self.check_image_exists_fn(session, application, codebase, commit)
+        self.check_image_exists(session, application, codebase, commit)
 
         codebuild_client = session.client("codebuild")
         build_url = self.__start_build_with_confirmation(
-            self.confirm_fn,
+            self.confirm,
             codebuild_client,
-            self.get_build_url_from_arn_fn,
+            self.get_build_url_from_arn,
             f'You are about to deploy "{app}" for "{codebase}" with commit "{commit}" to the "{env}" environment. Do you want to continue?',
             {
                 "projectName": f"pipeline-{application.name}-{codebase}-BuildProject",
@@ -166,34 +166,34 @@ class Codebase:
         )
 
         if build_url:
-            return self.echo_fn(
+            return self.echo(
                 "Your deployment has been triggered. Check your build progress in the AWS Console: "
                 f"{build_url}",
             )
 
-        raise ApplicationDeploymentNotTriggered()
+        raise ApplicationDeploymentNotTriggered(codebase)
 
     def list(self, app: str, with_images: bool):
         """List available codebases for the application."""
-        session = self.get_aws_session_or_abort_fn()
-        application = self.load_application_fn(app, session)
+        session = self.get_aws_session_or_abort()
+        application = self.load_application(app, session)
         ssm_client = session.client("ssm")
         ecr_client = session.client("ecr")
         codebases = self.__get_codebases(application, ssm_client)
 
-        self.echo_fn("The following codebases are available:")
+        self.echo("The following codebases are available:")
 
         for codebase in codebases:
-            self.echo_fn(f"- {codebase['name']} (https://github.com/{codebase['repository']})")
+            self.echo(f"- {codebase['name']} (https://github.com/{codebase['repository']})")
             if with_images:
-                self.list_latest_images_fn(
+                self.list_latest_images(
                     ecr_client,
                     f"{application.name}/{codebase['name']}",
                     codebase["repository"],
-                    self.echo_fn,
+                    self.echo,
                 )
 
-        self.echo_fn("")
+        self.echo("")
 
     def __get_codebases(self, application, ssm_client):
         parameters = ssm_client.get_parameters_by_path(
@@ -204,19 +204,37 @@ class Codebase:
         codebases = [json.loads(p["Value"]) for p in parameters]
 
         if not codebases:
-            # TODO Is this really an error? Or just no codebases so we could return an empty list?
-            raise NoCopilotCodebasesFoundError
+            return []
         return codebases
 
     def __start_build_with_confirmation(
         self,
-        confirm_fn,
+        confirm,
         codebuild_client,
-        get_build_url_from_arn_fn,
+        get_build_url_from_arn,
         confirmation_message,
         build_options,
     ):
-        if confirm_fn(confirmation_message):
-            build_arn = self.start_build_extraction_fn(codebuild_client, build_options)
-            return get_build_url_from_arn_fn(build_arn)
+        if confirm(confirmation_message):
+            build_arn = self.start_build_extraction(codebuild_client, build_options)
+            return get_build_url_from_arn(build_arn)
         return None
+
+
+class ApplicationDeploymentNotTriggered(PlatformException):
+    def __init__(self, codebase: str):
+        super().__init__(f"""Your deployment for {codebase} was not triggered.""")
+
+
+class ApplicationEnvironmentNotFoundException(ApplicationException):
+    def __init__(self, environment: str):
+        super().__init__(
+            f"""The environment "{environment}" either does not exist or has not been deployed."""
+        )
+
+
+class NotInCodeBaseRepositoryException(PlatformException):
+    def __init__(self):
+        super().__init__(
+            "You are in the deploy repository; make sure you are in the application codebase repository.",
+        )

dbt_platform_helper/domain/conduit.py

@@ -3,80 +3,50 @@ from collections.abc import Callable
 
 import click
 
-from dbt_platform_helper.exceptions import ECSAgentNotRunning
-from dbt_platform_helper.providers.cloudformation import (
-    add_stack_delete_policy_to_task_role,
-)
-from dbt_platform_helper.providers.cloudformation import update_conduit_stack_resources
-from dbt_platform_helper.providers.cloudformation import (
-    wait_for_cloudformation_to_reach_status,
-)
+from dbt_platform_helper.providers.cloudformation import CloudFormation
 from dbt_platform_helper.providers.copilot import connect_to_addon_client_task
 from dbt_platform_helper.providers.copilot import create_addon_client_task
-from dbt_platform_helper.providers.copilot import create_postgres_admin_task
-from dbt_platform_helper.providers.ecs import ecs_exec_is_available
-from dbt_platform_helper.providers.ecs import get_cluster_arn
-from dbt_platform_helper.providers.ecs import get_ecs_task_arns
-from dbt_platform_helper.providers.ecs import get_or_create_task_name
-from dbt_platform_helper.providers.secrets import get_addon_type
-from dbt_platform_helper.providers.secrets import get_parameter_name
+from dbt_platform_helper.providers.ecs import ECS
+from dbt_platform_helper.providers.secrets import Secrets
 from dbt_platform_helper.utils.application import Application
-from dbt_platform_helper.utils.messages import abort_with_error
 
 
 class Conduit:
     def __init__(
         self,
         application: Application,
-        echo_fn: Callable[[str], str] = click.secho,
-        subprocess_fn: subprocess = subprocess,
-        get_ecs_task_arns_fn=get_ecs_task_arns,
-        connect_to_addon_client_task_fn=connect_to_addon_client_task,
-        create_addon_client_task_fn=create_addon_client_task,
-        create_postgres_admin_task_fn=create_postgres_admin_task,
-        get_addon_type_fn=get_addon_type,
-        ecs_exec_is_available_fn=ecs_exec_is_available,
-        get_cluster_arn_fn=get_cluster_arn,
-        get_parameter_name_fn=get_parameter_name,
-        get_or_create_task_name_fn=get_or_create_task_name,
-        add_stack_delete_policy_to_task_role_fn=add_stack_delete_policy_to_task_role,
-        update_conduit_stack_resources_fn=update_conduit_stack_resources,
-        wait_for_cloudformation_to_reach_status_fn=wait_for_cloudformation_to_reach_status,
-        abort_fn=abort_with_error,
+        secrets_provider: Secrets,
+        cloudformation_provider: CloudFormation,
+        ecs_provider: ECS,
+        echo: Callable[[str], str] = click.secho,
+        subprocess: subprocess = subprocess,
+        connect_to_addon_client_task=connect_to_addon_client_task,
+        create_addon_client_task=create_addon_client_task,
     ):
 
         self.application = application
-        self.subprocess_fn = subprocess_fn
-        self.echo_fn = echo_fn
-        self.get_ecs_task_arns_fn = get_ecs_task_arns_fn
-        self.connect_to_addon_client_task_fn = connect_to_addon_client_task_fn
-        self.create_addon_client_task_fn = create_addon_client_task_fn
-        self.create_postgres_admin_task = create_postgres_admin_task_fn
-        self.get_addon_type_fn = get_addon_type_fn
-        self.ecs_exec_is_available_fn = ecs_exec_is_available_fn
-        self.get_cluster_arn_fn = get_cluster_arn_fn
-        self.get_parameter_name_fn = get_parameter_name_fn
-        self.get_or_create_task_name_fn = get_or_create_task_name_fn
-        self.add_stack_delete_policy_to_task_role_fn = add_stack_delete_policy_to_task_role_fn
-        self.update_conduit_stack_resources_fn = update_conduit_stack_resources_fn
-        self.wait_for_cloudformation_to_reach_status_fn = wait_for_cloudformation_to_reach_status_fn
-        self.abort_fn = abort_fn
+        self.secrets_provider = secrets_provider
+        self.cloudformation_provider = cloudformation_provider
+        self.ecs_provider = ecs_provider
+        self.subprocess = subprocess
+        self.echo = echo
+        self.connect_to_addon_client_task = connect_to_addon_client_task
+        self.create_addon_client_task = create_addon_client_task
 
     def start(self, env: str, addon_name: str, access: str = "read"):
         clients = self._initialise_clients(env)
         addon_type, cluster_arn, parameter_name, task_name = self._get_addon_details(
-            env, addon_name, access
+            addon_name, access
         )
 
-        self.echo_fn(f"Checking if a conduit task is already running for {addon_type}")
-        task_arn = self.get_ecs_task_arns_fn(clients["ecs"], cluster_arn, task_name)
-        if not task_arn:
-            self.echo_fn("Creating conduit task")
-            self.create_addon_client_task_fn(
+        self.echo(f"Checking if a conduit task is already running for {addon_type}")
+        task_arns = self.ecs_provider.get_ecs_task_arns(cluster_arn, task_name)
+        if not task_arns:
+            self.echo("Creating conduit task")
+            self.create_addon_client_task(
                 clients["iam"],
                 clients["ssm"],
-                clients["secrets_manager"],
-                self.subprocess_fn,
+                self.subprocess,
                 self.application,
                 env,
                 addon_type,
@@ -85,11 +55,8 @@ class Conduit:
                 access,
             )
 
-            self.echo_fn("Updating conduit task")
+            self.echo("Updating conduit task")
             self._update_stack_resources(
-                clients["cloudformation"],
-                clients["iam"],
-                clients["ssm"],
                 self.application.name,
                 env,
                 addon_type,
@@ -99,21 +66,18 @@ class Conduit:
                 access,
             )
 
-            task_arn = self.get_ecs_task_arns_fn(clients["ecs"], cluster_arn, task_name)
+            task_arns = self.ecs_provider.get_ecs_task_arns(cluster_arn, task_name)
 
         else:
-            self.echo_fn("Conduit task already running")
+            self.echo("Conduit task already running")
 
-        self.echo_fn(f"Checking if exec is available for conduit task...")
+        self.echo(f"Checking if exec is available for conduit task...")
 
-        try:
-            self.ecs_exec_is_available_fn(clients["ecs"], cluster_arn, task_arn)
-        except ECSAgentNotRunning:
-            self.abort_fn('ECS exec agent never reached "RUNNING" status')
+        self.ecs_provider.ecs_exec_is_available(cluster_arn, task_arns)
 
-        self.echo_fn("Connecting to conduit task")
-        self.connect_to_addon_client_task_fn(
-            clients["ecs"], self.subprocess_fn, self.application.name, env, cluster_arn, task_name
+        self.echo("Connecting to conduit task")
+        self.connect_to_addon_client_task(
+            clients["ecs"], self.subprocess, self.application.name, env, cluster_arn, task_name
         )
 
     def _initialise_clients(self, env):
@@ -121,30 +85,18 @@ class Conduit:
             "ecs": self.application.environments[env].session.client("ecs"),
             "iam": self.application.environments[env].session.client("iam"),
             "ssm": self.application.environments[env].session.client("ssm"),
-            "cloudformation": self.application.environments[env].session.client("cloudformation"),
-            "secrets_manager": self.application.environments[env].session.client("secretsmanager"),
         }
 
-    def _get_addon_details(self, env, addon_name, access):
-        ssm_client = self.application.environments[env].session.client("ssm")
-        ecs_client = self.application.environments[env].session.client("ecs")
-
-        addon_type = self.get_addon_type_fn(ssm_client, self.application.name, env, addon_name)
-        cluster_arn = self.get_cluster_arn_fn(ecs_client, self.application.name, env)
-        parameter_name = self.get_parameter_name_fn(
-            self.application.name, env, addon_type, addon_name, access
-        )
-        task_name = self.get_or_create_task_name_fn(
-            ssm_client, self.application.name, env, addon_name, parameter_name
-        )
+    def _get_addon_details(self, addon_name, access):
+        addon_type = self.secrets_provider.get_addon_type(addon_name)
+        cluster_arn = self.ecs_provider.get_cluster_arn()
+        parameter_name = self.secrets_provider.get_parameter_name(addon_type, addon_name, access)
+        task_name = self.ecs_provider.get_or_create_task_name(addon_name, parameter_name)
 
         return addon_type, cluster_arn, parameter_name, task_name
 
     def _update_stack_resources(
         self,
-        cloudformation_client,
-        iam_client,
-        ssm_client,
         app_name,
         env,
         addon_type,
@@ -153,11 +105,8 @@ class Conduit:
         parameter_name,
         access,
     ):
-        self.add_stack_delete_policy_to_task_role_fn(cloudformation_client, iam_client, task_name)
-        stack_name = self.update_conduit_stack_resources_fn(
-            cloudformation_client,
-            iam_client,
-            ssm_client,
+        self.cloudformation_provider.add_stack_delete_policy_to_task_role(task_name)
+        stack_name = self.cloudformation_provider.update_conduit_stack_resources(
             app_name,
             env,
             addon_type,
@@ -166,7 +115,7 @@ class Conduit:
             parameter_name,
             access,
         )
-        self.echo_fn("Waiting for conduit task update to complete...")
-        self.wait_for_cloudformation_to_reach_status_fn(
-            cloudformation_client, "stack_update_complete", stack_name
+        self.echo("Waiting for conduit task update to complete...")
+        self.cloudformation_provider.wait_for_cloudformation_to_reach_status(
+            "stack_update_complete", stack_name
         )