dbt-platform-helper 13.2.0__tar.gz → 13.4.0__tar.gz

{dbt_platform_helper-13.2.0 → dbt_platform_helper-13.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dbt-platform-helper
-Version: 13.2.0
+Version: 13.4.0
 Summary: Set of tools to help transfer applications/services from GOV.UK PaaS to DBT PaaS augmenting AWS Copilot.
 License: MIT
 Author: Department for Business and Trade Platform Team
@@ -12,7 +12,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: Jinja2 (==3.1.5)
+Requires-Dist: Jinja2 (==3.1.6)
 Requires-Dist: PyYAML (==6.0.1)
 Requires-Dist: aiohttp (>=3.8.4,<4.0.0)
 Requires-Dist: boto3 (>=1.28.24,<2.0.0)

{dbt_platform_helper-13.2.0 → dbt_platform_helper-13.4.0}/dbt_platform_helper/COMMANDS.md

@@ -236,7 +236,8 @@ platform-helper codebase build --app <application> --codebase <codebase>
 
 ```
 platform-helper codebase deploy --app <application> --env <environment> --codebase <codebase> 
-                                --commit <commit> 
+                                [--tag <tag>] [--branch <branch>] 
+                                [--commit <commit>] 
 ```
 
 ## Options
@@ -247,8 +248,12 @@ platform-helper codebase deploy --app <application> --env <environment> --codeba
   - AWS Copilot environment
 - `--codebase <text>`
   - The codebase name as specified in the platform-config.yml file. This can be run from any directory.
+- `--tag <text>`
+  - Git tag that has been built into an image. Typically a semantic version of the form 1.2.3 or v1.2.3.
+- `--branch <text>`
+  - Git branch that has been built into an image.
 - `--commit <text>`
-  - GitHub commit hash
+  - Git sha hash that has been built into an image.
 - `--help <boolean>` _Defaults to False._
   - Show this message and exit.
 

{dbt_platform_helper-13.2.0 → dbt_platform_helper-13.4.0}/dbt_platform_helper/commands/codebase.py

@@ -4,6 +4,8 @@ from dbt_platform_helper.domain.codebase import Codebase
 from dbt_platform_helper.domain.versioning import PlatformHelperVersioning
 from dbt_platform_helper.platform_exception import PlatformException
 from dbt_platform_helper.providers.io import ClickIOProvider
+from dbt_platform_helper.providers.parameter_store import ParameterStore
+from dbt_platform_helper.utils.aws import get_aws_session_or_abort
 from dbt_platform_helper.utils.click import ClickDocOptGroup
 
 
@@ -17,7 +19,7 @@ def codebase():
 def prepare():
     """Sets up an application codebase for use within a DBT platform project."""
     try:
-        Codebase().prepare()
+        Codebase(ParameterStore(get_aws_session_or_abort().client("ssm"))).prepare()
     except PlatformException as err:
         ClickIOProvider().abort_with_error(str(err))
 
@@ -33,7 +35,7 @@ def prepare():
 def list(app, with_images):
     """List available codebases for the application."""
     try:
-        Codebase().list(app, with_images)
+        Codebase(ParameterStore(get_aws_session_or_abort().client("ssm"))).list(app, with_images)
     except PlatformException as err:
         ClickIOProvider().abort_with_error(str(err))
 
@@ -49,7 +51,9 @@ def list(app, with_images):
 def build(app, codebase, commit):
     """Trigger a CodePipeline pipeline based build."""
     try:
-        Codebase().build(app, codebase, commit)
+        Codebase(ParameterStore(get_aws_session_or_abort().client("ssm"))).build(
+            app, codebase, commit
+        )
     except PlatformException as err:
         ClickIOProvider().abort_with_error(str(err))
 
@@ -62,9 +66,28 @@ def build(app, codebase, commit):
     help="The codebase name as specified in the platform-config.yml file. This can be run from any directory.",
     required=True,
 )
-@click.option("--commit", help="GitHub commit hash", required=True)
-def deploy(app, env, codebase, commit):
+@click.option(
+    "--tag",
+    help="Git tag that has been built into an image. Typically a semantic version of the form 1.2.3 or v1.2.3.",
+    required=False,
+)
+@click.option(
+    "--branch",
+    help="Git branch that has been built into an image.",
+    required=False,
+)
+@click.option(
+    "--commit",
+    help="Git sha hash that has been built into an image.",
+    required=False,
+)
+def deploy(
+    app: str, env: str, codebase: str, commit: str = None, tag: str = None, branch: str = None
+):
+
     try:
-        Codebase().deploy(app, env, codebase, commit)
+        Codebase(ParameterStore(get_aws_session_or_abort().client("ssm"))).deploy(
+            app, env, codebase, commit, tag, branch
+        )
     except PlatformException as err:
         ClickIOProvider().abort_with_error(str(err))

dbt_platform_helper-13.4.0/dbt_platform_helper/commands/config.py

@@ -0,0 +1,38 @@
+import click
+
+from dbt_platform_helper.domain.config import Config
+from dbt_platform_helper.platform_exception import PlatformException
+from dbt_platform_helper.providers.aws.sso_auth import SSOAuthProvider
+from dbt_platform_helper.providers.io import ClickIOProvider
+from dbt_platform_helper.utils.aws import get_aws_session_or_abort
+from dbt_platform_helper.utils.click import ClickDocOptGroup
+
+
+@click.group(cls=ClickDocOptGroup)
+def config():
+    """Perform actions on configuration files."""
+
+
+@config.command()
+def validate():
+    """Validate deployment or application configuration."""
+    try:
+        Config().validate()
+    except PlatformException as err:
+        ClickIOProvider().abort_with_error(str(err))
+
+
+@config.command()
+@click.option("--file-path", "-fp", default="~/.aws/config")
+def aws(file_path):
+    """
+    Writes a local config file containing all the AWS profiles to which the
+    logged in user has access.
+
+    If no `--file-path` is specified, defaults to `~/.aws/config`.
+    """
+    try:
+        session = get_aws_session_or_abort()
+        Config(sso=SSOAuthProvider(session)).generate_aws(file_path)
+    except PlatformException as err:
+        ClickIOProvider().abort_with_error(str(err))

{dbt_platform_helper-13.2.0 → dbt_platform_helper-13.4.0}/dbt_platform_helper/commands/copilot.py

@@ -10,13 +10,10 @@ from dbt_platform_helper.providers.config_validator import ConfigValidator
 from dbt_platform_helper.providers.files import FileProvider
 from dbt_platform_helper.providers.io import ClickIOProvider
 from dbt_platform_helper.providers.kms import KMSProvider
+from dbt_platform_helper.providers.parameter_store import ParameterStore
 from dbt_platform_helper.utils.aws import get_aws_session_or_abort
 from dbt_platform_helper.utils.click import ClickDocOptGroup
 
-# TODOs
-# Figure out a pattern for copilot templating and the new copilot domain - probably a lot of overlap here that really belongs in the copilottemplating domain instead (atleast whatever is concerned with "templating")
-# Check for E2E test coverage.
-
 
 @click.group(chain=True, cls=ClickDocOptGroup)
 def copilot():
@@ -28,8 +25,15 @@ def make_addons():
     """Generate addons CloudFormation for each environment."""
     try:
         session = get_aws_session_or_abort()
+        parameter_provider = ParameterStore(session.client("ssm"))
         config_provider = ConfigProvider(ConfigValidator())
-        kms_provider = KMSProvider(session.client("kms"))
-        Copilot(config_provider, FileProvider(), CopilotTemplating(), kms_provider).make_addons()
+        Copilot(
+            config_provider,
+            parameter_provider,
+            FileProvider(),
+            CopilotTemplating(),
+            KMSProvider,
+            session,
+        ).make_addons()
     except Exception as err:
         ClickIOProvider().abort_with_error(str(err))

{dbt_platform_helper-13.2.0 → dbt_platform_helper-13.4.0}/dbt_platform_helper/commands/database.py

@@ -2,6 +2,8 @@ import click
 
 from dbt_platform_helper.commands.environment import AVAILABLE_TEMPLATES
 from dbt_platform_helper.domain.database_copy import DatabaseCopy
+from dbt_platform_helper.platform_exception import PlatformException
+from dbt_platform_helper.providers.io import ClickIOProvider
 from dbt_platform_helper.utils.click import ClickDocOptGroup
 
 
@@ -38,9 +40,11 @@ def database():
 )
 def dump(app, from_env, database, from_vpc, filename):
     """Dump a database into an S3 bucket."""
-    data_copy = DatabaseCopy(app, database)
-    data_copy.dump(from_env, from_vpc, filename)
-    # Todo: Catch expected errors and output message
+    try:
+        data_copy = DatabaseCopy(app, database)
+        data_copy.dump(from_env, from_vpc, filename)
+    except PlatformException as err:
+        ClickIOProvider().abort_with_error(str(err))
 
 
 @database.command(name="load")
@@ -68,9 +72,11 @@ def dump(app, from_env, database, from_vpc, filename):
 )
 def load(app, to_env, database, to_vpc, auto_approve, filename):
     """Load a database from an S3 bucket."""
-    data_copy = DatabaseCopy(app, database, auto_approve)
-    data_copy.load(to_env, to_vpc, filename)
-    # Todo: Catch expected errors and output message
+    try:
+        data_copy = DatabaseCopy(app, database, auto_approve)
+        data_copy.load(to_env, to_vpc, filename)
+    except PlatformException as err:
+        ClickIOProvider().abort_with_error(str(err))
 
 
 @database.command(name="copy")
@@ -120,6 +126,8 @@ def copy(
     no_maintenance_page,
 ):
     """Copy a database between environments."""
-    data_copy = DatabaseCopy(app, database, auto_approve)
-    data_copy.copy(from_env, to_env, from_vpc, to_vpc, svc, template, no_maintenance_page)
-    # Todo: Catch expected errors and output message
+    try:
+        data_copy = DatabaseCopy(app, database, auto_approve)
+        data_copy.copy(from_env, to_env, from_vpc, to_vpc, svc, template, no_maintenance_page)
+    except PlatformException as err:
+        ClickIOProvider().abort_with_error(str(err))

{dbt_platform_helper-13.2.0 → dbt_platform_helper-13.4.0}/dbt_platform_helper/commands/environment.py

@@ -94,9 +94,8 @@ def generate(name):
 def generate_terraform(name, terraform_platform_modules_version):
     click_io = ClickIOProvider()
     try:
-        # TODO = pass the session to ConfigValidator
-        get_aws_session_or_abort()
-        config_provider = ConfigProvider(ConfigValidator())
+        session = get_aws_session_or_abort()
+        config_provider = ConfigProvider(ConfigValidator(session=session))
         TerraformEnvironment(config_provider).generate(name, terraform_platform_modules_version)
     except PlatformException as err:
         click_io.abort_with_error(str(err))

{dbt_platform_helper-13.2.0 → dbt_platform_helper-13.4.0}/dbt_platform_helper/domain/codebase.py

@@ -3,20 +3,22 @@ import stat
 import subprocess
 from collections.abc import Callable
 from pathlib import Path
+from typing import Tuple
 
 import requests
 import yaml
 from boto3 import Session
 
 from dbt_platform_helper.platform_exception import PlatformException
+from dbt_platform_helper.providers.ecr import ECRProvider
 from dbt_platform_helper.providers.files import FileProvider
 from dbt_platform_helper.providers.io import ClickIOProvider
+from dbt_platform_helper.providers.parameter_store import ParameterStore
 from dbt_platform_helper.utils.application import Application
 from dbt_platform_helper.utils.application import (
     ApplicationEnvironmentNotFoundException,
 )
 from dbt_platform_helper.utils.application import load_application
-from dbt_platform_helper.utils.aws import check_image_exists
 from dbt_platform_helper.utils.aws import get_aws_session_or_abort
 from dbt_platform_helper.utils.aws import get_build_url_from_arn
 from dbt_platform_helper.utils.aws import get_build_url_from_pipeline_execution_id
@@ -32,10 +34,11 @@ from dbt_platform_helper.utils.template import setup_templates
 class Codebase:
     def __init__(
         self,
+        parameter_provider: ParameterStore,
         io: ClickIOProvider = ClickIOProvider(),
         load_application: Callable[[str], Application] = load_application,
         get_aws_session_or_abort: Callable[[str], Session] = get_aws_session_or_abort,
-        check_image_exists: Callable[[str], str] = check_image_exists,
+        ecr_provider: ECRProvider = ECRProvider(),
         get_image_build_project: Callable[[str], str] = get_image_build_project,
         get_manual_release_pipeline: Callable[[str], str] = get_manual_release_pipeline,
         get_build_url_from_arn: Callable[[str], str] = get_build_url_from_arn,
@@ -50,10 +53,11 @@ class Codebase:
         check_if_commit_exists: Callable[[str], str] = check_if_commit_exists,
         run_subprocess: Callable[[str], str] = subprocess.run,
     ):
+        self.parameter_provider = parameter_provider
         self.io = io
         self.load_application = load_application
         self.get_aws_session_or_abort = get_aws_session_or_abort
-        self.check_image_exists = check_image_exists
+        self.ecr_provider = ecr_provider
         self.get_image_build_project = get_image_build_project
         self.get_manual_release_pipeline = get_manual_release_pipeline
         self.get_build_url_from_arn = get_build_url_from_arn
@@ -151,31 +155,54 @@ class Codebase:
 
         raise ApplicationDeploymentNotTriggered(codebase)
 
-    def deploy(self, app, env, codebase, commit):
+    def deploy(
+        self,
+        app: str,
+        env: str,
+        codebase: str,
+        commit: str = None,
+        tag: str = None,
+        branch: str = None,
+    ):
         """Trigger a CodePipeline pipeline based deployment."""
-        session = self.get_aws_session_or_abort()
 
-        application = self.load_application(app, default_session=session)
-        if not application.environments.get(env):
-            raise ApplicationEnvironmentNotFoundException(application.name, env)
+        self._validate_reference_flags(commit, tag, branch)
 
-        self.check_image_exists(session, application, codebase, commit)
+        application, session = self._populate_application_values(app, env)
 
-        codepipeline_client = session.client("codepipeline")
+        image_ref = None
+        if commit:
+            image_ref = f"commit-{commit[0:7]}"
+        elif tag:
+            image_ref = f"tag-{tag}"
+        elif branch:
+            image_ref = f"branch-{branch}"
+        image_details = self.ecr_provider.get_image_details(application, codebase, image_ref)
+        image_ref = self.ecr_provider.find_commit_tag(image_details, image_ref)
 
+        codepipeline_client = session.client("codepipeline")
         pipeline_name = self.get_manual_release_pipeline(codepipeline_client, app, codebase)
 
+        corresponding_to = ""
+        if tag:
+            corresponding_to = f"(corresponding to tag {tag}) "
+        elif branch:
+            corresponding_to = f"(corresponding to branch {branch}) "
+
+        confirmation_message = f'\nYou are about to deploy "{app}" for "{codebase}" with image reference "{image_ref}" {corresponding_to}to the "{env}" environment using the "{pipeline_name}" deployment pipeline. Do you want to continue?'
+        build_options = {
+            "name": pipeline_name,
+            "variables": [
+                {"name": "ENVIRONMENT", "value": env},
+                {"name": "IMAGE_TAG", "value": image_ref},
+            ],
+        }
+
         build_url = self.__start_pipeline_execution_with_confirmation(
             codepipeline_client,
             self.get_build_url_from_pipeline_execution_id,
-            f'You are about to deploy "{app}" for "{codebase}" with commit "{commit}" to the "{env}" environment using the "{pipeline_name}" deployment pipeline. Do you want to continue?',
-            {
-                "name": pipeline_name,
-                "variables": [
-                    {"name": "ENVIRONMENT", "value": env},
-                    {"name": "IMAGE_TAG", "value": f"commit-{commit}"},
-                ],
-            },
+            confirmation_message,
+            build_options,
         )
 
         if build_url:
@@ -186,13 +213,31 @@ class Codebase:
 
         raise ApplicationDeploymentNotTriggered(codebase)
 
+    def _validate_reference_flags(self, commit: str, tag: str, branch: str):
+        provided = [ref for ref in [commit, tag, branch] if ref]
+
+        if len(provided) == 0:
+            self.io.abort_with_error(
+                "To deploy, you must provide one of the options --commit, --tag or --branch."
+            )
+        elif len(provided) > 1:
+            self.io.abort_with_error(
+                "You have provided more than one of the --tag, --branch and --commit options but these are mutually exclusive. Please provide only one of these options."
+            )
+
+    def _populate_application_values(self, app: str, env: str) -> Tuple[Application, Session]:
+        session = self.get_aws_session_or_abort()
+        application = self.load_application(app, default_session=session)
+        if not application.environments.get(env):
+            raise ApplicationEnvironmentNotFoundException(application.name, env)
+        return application, session
+
     def list(self, app: str, with_images: bool):
         """List available codebases for the application."""
         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)
+        codebases = self.__get_codebases(application, session.client("ssm"))
 
         self.io.info("The following codebases are available:")
 
@@ -209,11 +254,9 @@ class Codebase:
         self.io.info("")
 
     def __get_codebases(self, application, ssm_client):
-        parameters = ssm_client.get_parameters_by_path(
-            Path=f"/copilot/applications/{application.name}/codebases",
-            Recursive=True,
-        )["Parameters"]
-
+        parameters = self.parameter_provider.get_ssm_parameters_by_path(
+            f"/copilot/applications/{application.name}/codebases"
+        )
         codebases = [json.loads(p["Value"]) for p in parameters]
 
         if not codebases: