dbt-platform-helper 12.0.2__py3-none-any.whl → 12.2.0__py3-none-any.whl

dbt_platform_helper/COMMANDS.md

@@ -222,7 +222,7 @@ platform-helper codebase build --app <application> --codebase <codebase>
 - `--app <text>`
   - AWS application name
 - `--codebase <text>`
-  - The codebase name as specified in the pipelines.yml file
+  - The codebase name as specified in the platform-config.yml file
 - `--commit <text>`
   - GitHub commit hash
 - `--help <boolean>` _Defaults to False._
@@ -232,8 +232,6 @@ platform-helper codebase build --app <application> --codebase <codebase>
 
 [↩ Parent](#platform-helper-codebase)
 
-    Trigger a CodePipeline pipeline based deployment.
-
 ## Usage
 
 ```
@@ -248,7 +246,7 @@ platform-helper codebase deploy --app <application> --env <environment> --codeba
 - `--env <text>`
   - AWS Copilot environment
 - `--codebase <text>`
-  - The codebase name as specified in the pipelines.yml file
+  - The codebase name as specified in the platform-config.yml file
 - `--commit <text>`
   - GitHub commit hash
 - `--help <boolean>` _Defaults to False._
@@ -258,7 +256,8 @@ platform-helper codebase deploy --app <application> --env <environment> --codeba
 
 [↩ Parent](#platform-helper)
 
-    Create a conduit connection to an addon.
+    Opens a shell for a given addon_name create a conduit connection to
+    interact with postgres, opensearch or redis.
 
 ## Usage
 
@@ -274,11 +273,11 @@ platform-helper conduit <addon_name>
 ## Options
 
 - `--app <text>`
-  - AWS application name
+  - Application name
 - `--env <text>`
-  - AWS environment name
+  - Environment name
 - `--access <choice>` _Defaults to read._
-  - Allow write or admin access to database addons
+  - Allow read, write or admin access to the database addons.
 - `--help <boolean>` _Defaults to False._
   - Show this message and exit.
 

dbt_platform_helper/commands/application.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 
 # application commands are deprecated, do not spend time refactoring them
+# Service teams are trained to use them as a replacement for cf app(s)
 
 import time
 from datetime import datetime

dbt_platform_helper/commands/codebase.py

@@ -1,21 +1,18 @@
 import json
 import os
-import stat
-import subprocess
-from pathlib import Path
 
 import click
-import requests
-import yaml
-from boto3 import Session
 
-from dbt_platform_helper.utils.application import Application
-from dbt_platform_helper.utils.application import ApplicationNotFoundError
-from dbt_platform_helper.utils.application import load_application
-from dbt_platform_helper.utils.aws import get_aws_session_or_abort
+from dbt_platform_helper.domain.codebase import Codebase
+from dbt_platform_helper.exceptions import ApplicationDeploymentNotTriggered
+from dbt_platform_helper.exceptions import ApplicationEnvironmentNotFoundError
+from dbt_platform_helper.exceptions import ApplicationNotFoundError
+from dbt_platform_helper.exceptions import CopilotCodebaseNotFoundError
+from dbt_platform_helper.exceptions import ImageNotFoundError
+from dbt_platform_helper.exceptions import NoCopilotCodebasesFoundError
+from dbt_platform_helper.exceptions import NotInCodeBaseRepositoryError
 from dbt_platform_helper.utils.click import ClickDocOptGroup
-from dbt_platform_helper.utils.files import mkfile
-from dbt_platform_helper.utils.template import setup_templates
+from dbt_platform_helper.utils.git import CommitNotFoundError
 from dbt_platform_helper.utils.versioning import (
     check_platform_helper_version_needs_update,
 )
@@ -30,92 +27,15 @@ def codebase():
 @codebase.command()
 def prepare():
     """Sets up an application codebase for use within a DBT platform project."""
-    templates = setup_templates()
-
-    repository = (
-        subprocess.run(["git", "remote", "get-url", "origin"], capture_output=True, text=True)
-        .stdout.split("/")[-1]
-        .strip()
-        .removesuffix(".git")
-    )
-
-    if repository.endswith("-deploy") or Path("./copilot").exists():
+    try:
+        Codebase().prepare()
+    except NotInCodeBaseRepositoryError:
+        # TODO: Set exception message in the exceptions and just output the message in the command code
         click.secho(
             "You are in the deploy repository; make sure you are in the application codebase repository.",
             fg="red",
         )
-        exit(1)
-
-    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)
-    builder_configuration_content = yaml.safe_load(
-        builder_configuration_response.content.decode("utf-8")
-    )
-    builder_versions = next(
-        (
-            item
-            for item in builder_configuration_content["builders"]
-            if item["name"] == "paketobuildpacks/builder-jammy-base"
-        ),
-        None,
-    )
-    builder_version = max(x["version"] for x in builder_versions["versions"])
-    # Temporary hack until https://uktrade.atlassian.net/browse/DBTP-351 is done
-    # Will need a change in tests/platform_helper/expected_files/.copilot/config.yml, when removed.
-    builder_version = min(builder_version, "0.4.240")
-
-    Path("./.copilot/phases").mkdir(parents=True, exist_ok=True)
-    image_build_run_contents = templates.get_template(f".copilot/image_build_run.sh").render()
-
-    config_contents = templates.get_template(f".copilot/config.yml").render(
-        repository=repository, builder_version=builder_version
-    )
-
-    click.echo(
-        mkfile(Path("."), ".copilot/image_build_run.sh", image_build_run_contents, overwrite=True)
-    )
-
-    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)
-
-    click.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()
-
-        click.echo(mkfile(Path("./.copilot"), f"phases/{phase}.sh", phase_contents, overwrite=True))
-
-
-def list_latest_images(ecr_client, ecr_repository_name, codebase_repository):
-    paginator = ecr_client.get_paginator("describe_images")
-    describe_images_response_iterator = paginator.paginate(
-        repositoryName=ecr_repository_name,
-        filter={"tagStatus": "TAGGED"},
-    )
-    images = []
-    for page in describe_images_response_iterator:
-        images += page["imageDetails"]
-
-    sorted_images = sorted(
-        images,
-        key=lambda i: i["imagePushedAt"],
-        reverse=True,
-    )
-
-    MAX_RESULTS = 20
-
-    for image in sorted_images[:MAX_RESULTS]:
-        try:
-            commit_tag = next(t for t in image["imageTags"] if t.startswith("commit-"))
-            if not commit_tag:
-                continue
-
-            commit_hash = commit_tag.replace("commit-", "")
-            click.echo(
-                f"  - https://github.com/{codebase_repository}/commit/{commit_hash} - published: {image['imagePushedAt']}"
-            )
-        except StopIteration:
-            continue
+        raise click.Abort
 
 
 @codebase.command()
@@ -128,184 +48,99 @@ def list_latest_images(ecr_client, ecr_repository_name, codebase_repository):
 )
 def list(app, with_images):
     """List available codebases for the application."""
-    session = get_aws_session_or_abort()
-    application = load_application_or_abort(session, app)
-    ssm_client = session.client("ssm")
-    ecr_client = session.client("ecr")
-    parameters = ssm_client.get_parameters_by_path(
-        Path=f"/copilot/applications/{application.name}/codebases",
-        Recursive=True,
-    )["Parameters"]
-
-    codebases = [json.loads(p["Value"]) for p in parameters]
-
-    if not codebases:
-        click.secho(f'No codebases found for application "{application.name}"', fg="red")
+    try:
+        Codebase().list(app, with_images)
+    except NoCopilotCodebasesFoundError:
+        click.secho(
+            f"""No codebases found for application "{app}""",
+            fg="red",
+        )
+        raise click.Abort
+    except ApplicationNotFoundError:
+        click.secho(
+            f"""The account "{os.environ.get("AWS_PROFILE")}" does not contain the application "{app}"; ensure you have set the environment variable "AWS_PROFILE" correctly.""",
+            fg="red",
+        )
         raise click.Abort
-
-    click.echo("The following codebases are available:")
-
-    for codebase in codebases:
-        click.echo(f"- {codebase['name']} (https://github.com/{codebase['repository']})")
-        if with_images:
-            list_latest_images(
-                ecr_client, f"{application.name}/{codebase['name']}", codebase["repository"]
-            )
-
-    click.echo("")
 
 
 @codebase.command()
 @click.option("--app", help="AWS application name", required=True)
 @click.option(
-    "--codebase", help="The codebase name as specified in the pipelines.yml file", required=True
+    "--codebase",
+    help="The codebase name as specified in the platform-config.yml file",
+    required=True,
 )
 @click.option("--commit", help="GitHub commit hash", required=True)
 def build(app, codebase, commit):
     """Trigger a CodePipeline pipeline based build."""
-    session = get_aws_session_or_abort()
-    load_application_or_abort(session, app)
-
-    check_if_commit_exists = subprocess.run(
-        ["git", "branch", "-r", "--contains", f"{commit}"], capture_output=True, text=True
-    )
-
-    if check_if_commit_exists.stderr:
+    try:
+        Codebase().build(app, codebase, commit)
+    except ApplicationNotFoundError:
         click.secho(
-            f"""The commit hash "{commit}" either does not exist or you need to run `git fetch`.""",
+            f"""The account "{os.environ.get("AWS_PROFILE")}" does not contain the application "{app}"; ensure you have set the environment variable "AWS_PROFILE" correctly.""",
             fg="red",
         )
         raise click.Abort
-
-    codebuild_client = session.client("codebuild")
-    build_url = start_build_with_confirmation(
-        codebuild_client,
-        f'You are about to build "{app}" for "{codebase}" with commit "{commit}". Do you want to continue?',
-        {
-            "projectName": f"codebuild-{app}-{codebase}",
-            "artifactsOverride": {"type": "NO_ARTIFACTS"},
-            "sourceVersion": commit,
-        },
-    )
-
-    if build_url:
-        return click.echo(
-            "Your build has been triggered. Check your build progress in the AWS Console: "
-            f"{build_url}",
+    except CommitNotFoundError:
+        click.secho(
+            f'The commit hash "{commit}" either does not exist or you need to run `git fetch`.',
+            fg="red",
         )
-
-    return click.echo("Your build was not triggered.")
+        raise click.Abort
+    except ApplicationDeploymentNotTriggered:
+        click.secho(
+            f"Your build for {codebase} was not triggered.",
+            fg="red",
+        )
+        raise click.Abort
 
 
 @codebase.command()
 @click.option("--app", help="AWS application name", required=True)
 @click.option("--env", help="AWS Copilot environment", required=True)
 @click.option(
-    "--codebase", help="The codebase name as specified in the pipelines.yml file", required=True
+    "--codebase",
+    help="The codebase name as specified in the platform-config.yml file",
+    required=True,
 )
 @click.option("--commit", help="GitHub commit hash", required=True)
 def deploy(app, env, codebase, commit):
-    """Trigger a CodePipeline pipeline based deployment."""
-    session = get_aws_session_or_abort()
-    application = load_application_with_environment(session, app, env)
-    check_codebase_exists(session, application, codebase)
-    check_image_exists(session, application, codebase, commit)
-
-    codebuild_client = session.client("codebuild")
-    build_url = start_build_with_confirmation(
-        codebuild_client,
-        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",
-            "artifactsOverride": {"type": "NO_ARTIFACTS"},
-            "sourceTypeOverride": "NO_SOURCE",
-            "environmentVariablesOverride": [
-                {"name": "COPILOT_ENVIRONMENT", "value": env},
-                {"name": "IMAGE_TAG", "value": f"commit-{commit}"},
-            ],
-        },
-    )
-
-    if build_url:
-        return click.echo(
-            "Your deployment has been triggered. Check your build progress in the AWS Console: "
-            f"{build_url}",
-        )
-
-    return click.echo("Your deployment was not triggered.")
-
-
-def load_application_or_abort(session: Session, app: str) -> Application:
     try:
-        return load_application(app, default_session=session)
+        Codebase().deploy(app, env, codebase, commit)
     except ApplicationNotFoundError:
+        # TODO: Set exception message in the exceptions and just output the message in the command code
         click.secho(
             f"""The account "{os.environ.get("AWS_PROFILE")}" does not contain the application "{app}"; ensure you have set the environment variable "AWS_PROFILE" correctly.""",
             fg="red",
         )
         raise click.Abort
-
-
-def check_image_exists(session: Session, application: Application, codebase: str, commit: str):
-    ecr_client = session.client("ecr")
-    try:
-        ecr_client.describe_images(
-            repositoryName=f"{application.name}/{codebase}",
-            imageIds=[{"imageTag": f"commit-{commit}"}],
-        )
-    except ecr_client.exceptions.RepositoryNotFoundException:
+    except ApplicationEnvironmentNotFoundError:
         click.secho(
-            f'The ECR Repository for codebase "{codebase}" does not exist.',
+            f"""The environment "{env}" either does not exist or has not been deployed.""",
             fg="red",
         )
         raise click.Abort
-    except ecr_client.exceptions.ImageNotFoundException:
+    except (
+        CopilotCodebaseNotFoundError,
+        # TODO: Catch this error earlier and throw a more meaningful error, maybe it's CopilotCodebaseNotFoundError?
+        json.JSONDecodeError,
+    ):
         click.secho(
-            f'The commit hash "{commit}" has not been built into an image, try the '
-            "`platform-helper codebase build` command first.",
+            f"""The codebase "{codebase}" either does not exist or has not been deployed.""",
             fg="red",
         )
         raise click.Abort
-
-
-def check_codebase_exists(session: Session, application: Application, codebase: str):
-    ssm_client = session.client("ssm")
-    try:
-        parameter = ssm_client.get_parameter(
-            Name=f"/copilot/applications/{application.name}/codebases/{codebase}"
-        )
-        value = parameter["Parameter"]["Value"]
-        json.loads(value)
-    except (KeyError, ValueError, json.JSONDecodeError, ssm_client.exceptions.ParameterNotFound):
+    except ImageNotFoundError:
         click.secho(
-            f"""The codebase "{codebase}" either does not exist or has not been deployed.""",
+            f'The commit hash "{commit}" has not been built into an image, try the '
+            "`platform-helper codebase build` command first.",
             fg="red",
         )
         raise click.Abort
-
-
-def load_application_with_environment(session: Session, app, env):
-    application = load_application_or_abort(session, app)
-
-    if not application.environments.get(env):
+    except ApplicationDeploymentNotTriggered:
         click.secho(
-            f"""The environment "{env}" either does not exist or has not been deployed.""",
+            f"Your deployment for {codebase} was not triggered.",
             fg="red",
         )
         raise click.Abort
-    return application
-
-
-def get_build_url_from_arn(build_arn: str) -> str:
-    _, _, _, region, account_id, project_name, build_id = build_arn.split(":")
-    project_name = project_name.removeprefix("build/")
-    return (
-        f"https://eu-west-2.console.aws.amazon.com/codesuite/codebuild/{account_id}/projects/"
-        f"{project_name}/build/{project_name}%3A{build_id}"
-    )
-
-
-def start_build_with_confirmation(codebuild_client, confirmation_message, build_options):
-    if click.confirm(confirmation_message):
-        response = codebuild_client.start_build(**build_options)
-        return get_build_url_from_arn(response["build"]["arn"])