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

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

@@ -1,14 +1,13 @@
 Metadata-Version: 2.3
 Name: dbt-platform-helper
-Version: 13.1.1
+Version: 13.2.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
 Author-email: sre-team@digital.trade.gov.uk
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.9, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*, !=3.8.*
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -25,7 +24,7 @@ Requires-Dist: cfn-lint (>=1.4.2,<2.0.0)
 Requires-Dist: checkov (>=3.1.67,<4.0.0)
 Requires-Dist: click (>=8.1.3,<9.0.0)
 Requires-Dist: cloudfoundry-client (==1.35.2)
-Requires-Dist: cryptography (>=41.0.3,<44.0.0)
+Requires-Dist: cryptography (>=44.0.1,<45)
 Requires-Dist: jinja2-simple-tags (>=0.5.0,<0.6.0)
 Requires-Dist: jsonschema (>=4.17.0,<4.18.0)
 Requires-Dist: mypy-boto3-codebuild (>=1.26.0.post1,<2.0.0)

{dbt_platform_helper-13.1.1 → dbt_platform_helper-13.2.0}/dbt_platform_helper/commands/application.py

@@ -10,11 +10,9 @@ from datetime import timedelta
 import click
 from prettytable import PrettyTable
 
+from dbt_platform_helper.domain.versioning import PlatformHelperVersioning
 from dbt_platform_helper.utils.application import load_application
 from dbt_platform_helper.utils.click import ClickDocOptGroup
-from dbt_platform_helper.utils.versioning import (
-    check_platform_helper_version_needs_update,
-)
 
 YELLOW = "\033[93m"
 CYAN = "\033[96m"
@@ -97,7 +95,7 @@ def get_query_results(env, app, query_string, timeout):
 @click.group(chain=True, cls=ClickDocOptGroup, deprecated=True)
 def application():
     """[DEPRECATED] Application metrics."""
-    check_platform_helper_version_needs_update()
+    PlatformHelperVersioning().check_if_needs_update()
 
 
 @application.command(deprecated=True)
@@ -141,7 +139,7 @@ def container_stats(env, app, storage, network):
         storage_write = field[6]["value"]
         network_read = field[7]["value"]
         network_write = field[8]["value"]
-        cpu = "%.1f%%" % float(field[9]["value"])
+        cpu = f"{float(field[9]['value']):.1f}%"
         memory = f"{field[10]['value']}M"
 
         # Nothing to compare to at start.

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

@@ -1,18 +1,16 @@
 import click
 
 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.utils.click import ClickDocOptGroup
-from dbt_platform_helper.utils.versioning import (
-    check_platform_helper_version_needs_update,
-)
 
 
 @click.group(chain=True, cls=ClickDocOptGroup)
 def codebase():
     """Codebase commands."""
-    check_platform_helper_version_needs_update()
+    PlatformHelperVersioning().check_if_needs_update()
 
 
 @codebase.command()

{dbt_platform_helper-13.1.1 → dbt_platform_helper-13.2.0}/dbt_platform_helper/commands/conduit.py

@@ -1,6 +1,7 @@
 import click
 
 from dbt_platform_helper.domain.conduit import Conduit
+from dbt_platform_helper.domain.versioning import PlatformHelperVersioning
 from dbt_platform_helper.platform_exception import PlatformException
 from dbt_platform_helper.providers.cloudformation import CloudFormation
 from dbt_platform_helper.providers.ecs import ECS
@@ -8,9 +9,6 @@ from dbt_platform_helper.providers.io import ClickIOProvider
 from dbt_platform_helper.providers.secrets import Secrets
 from dbt_platform_helper.utils.application import load_application
 from dbt_platform_helper.utils.click import ClickDocOptCommand
-from dbt_platform_helper.utils.versioning import (
-    check_platform_helper_version_needs_update,
-)
 
 CONDUIT_ACCESS_OPTIONS = ["read", "write", "admin"]
 
@@ -28,7 +26,7 @@ CONDUIT_ACCESS_OPTIONS = ["read", "write", "admin"]
 def conduit(addon_name: str, app: str, env: str, access: str):
     """Opens a shell for a given addon_name create a conduit connection to
     interact with postgres, opensearch or redis."""
-    check_platform_helper_version_needs_update()
+    PlatformHelperVersioning().check_if_needs_update()
     application = load_application(app)
 
     try:

{dbt_platform_helper-13.1.1 → dbt_platform_helper-13.2.0}/dbt_platform_helper/commands/config.py

@@ -9,13 +9,14 @@ import click
 from prettytable import PrettyTable
 
 from dbt_platform_helper.providers.config import ConfigProvider
+from dbt_platform_helper.providers.io import ClickIOProvider
 from dbt_platform_helper.providers.semantic_version import (
     IncompatibleMajorVersionException,
 )
 from dbt_platform_helper.providers.validation import ValidationException
-from dbt_platform_helper.utils import versioning
+from dbt_platform_helper.utils import tool_versioning
 from dbt_platform_helper.utils.click import ClickDocOptGroup
-from dbt_platform_helper.utils.versioning import get_platform_helper_versions
+from dbt_platform_helper.utils.tool_versioning import get_platform_helper_version_status
 
 yes = "\033[92m✔\033[0m"
 no = "\033[91m✖\033[0m"
@@ -75,14 +76,15 @@ def deployment():
     click.secho()
 
     compatible = True
-    platform_helper_versions = get_platform_helper_versions()
-    copilot_versions = versioning.get_copilot_versions()
-    aws_versions = versioning.get_aws_versions()
-    _check_tool_versions(platform_helper_versions, copilot_versions, aws_versions)
+    platform_helper_version_status = get_platform_helper_version_status()
+    ClickIOProvider().process_messages(platform_helper_version_status.validate())
+    copilot_versions = tool_versioning.get_copilot_versions()
+    aws_versions = tool_versioning.get_aws_versions()
+    _check_tool_versions(platform_helper_version_status, copilot_versions, aws_versions)
     click.secho("Checking addons templates versions...", fg="blue")
 
-    local_version = platform_helper_versions.local
-    latest_release = platform_helper_versions.latest
+    local_version = platform_helper_version_status.installed
+    latest_release = platform_helper_version_status.latest
     addons_templates_table = PrettyTable()
     addons_templates_table.field_names = [
         "Addons Template File",
@@ -108,10 +110,10 @@ def deployment():
         latest_compatible_symbol = yes
 
         try:
-            generated_with_version = versioning.get_template_generated_with_version(
+            generated_with_version = tool_versioning.get_template_generated_with_version(
                 str(template_file.resolve())
             )
-            versioning.validate_template_version(local_version, str(template_file.resolve()))
+            tool_versioning.validate_template_version(local_version, str(template_file.resolve()))
         except IncompatibleMajorVersionException:
             local_compatible_symbol = no
             compatible = False
@@ -132,10 +134,10 @@ def deployment():
             ]
 
         try:
-            generated_with_version = versioning.get_template_generated_with_version(
+            generated_with_version = tool_versioning.get_template_generated_with_version(
                 str(template_file.resolve())
             )
-            versioning.validate_template_version(latest_release, str(template_file.resolve()))
+            tool_versioning.validate_template_version(latest_release, str(template_file.resolve()))
         except IncompatibleMajorVersionException:
             latest_compatible_symbol = no
             compatible = False
@@ -162,14 +164,14 @@ def _check_tool_versions(platform_helper_versions, copilot_versions, aws_version
     click.secho("Checking tooling versions...", fg="blue")
     recommendations = {}
 
-    local_copilot_version = copilot_versions.local
+    local_copilot_version = copilot_versions.installed
     copilot_latest_release = copilot_versions.latest
     if local_copilot_version is None:
         recommendations["install-copilot"] = (
             "Install AWS Copilot https://aws.github.io/copilot-cli/"
         )
 
-    if aws_versions.local is None:
+    if aws_versions.installed is None:
         recommendations["install-aws"] = "Install AWS CLI https://aws.amazon.com/cli/"
 
     tool_versions_table = PrettyTable()
@@ -184,7 +186,7 @@ def _check_tool_versions(platform_helper_versions, copilot_versions, aws_version
     tool_versions_table.add_row(
         [
             "aws",
-            str(aws_versions.local),
+            str(aws_versions.installed),
             str(aws_versions.latest),
             no if aws_versions.is_outdated() else yes,
         ]
@@ -192,7 +194,7 @@ def _check_tool_versions(platform_helper_versions, copilot_versions, aws_version
     tool_versions_table.add_row(
         [
             "copilot",
-            str(copilot_versions.local),
+            str(copilot_versions.installed),
             str(copilot_versions.latest),
             no if copilot_versions.is_outdated() else yes,
         ]
@@ -200,7 +202,7 @@ def _check_tool_versions(platform_helper_versions, copilot_versions, aws_version
     tool_versions_table.add_row(
         [
             "dbt-platform-helper",
-            str(platform_helper_versions.local),
+            str(platform_helper_versions.installed),
             str(platform_helper_versions.latest),
             no if platform_helper_versions.is_outdated() else yes,
         ]

dbt_platform_helper-13.2.0/dbt_platform_helper/commands/copilot.py

@@ -0,0 +1,35 @@
+#!/usr/bin/env python
+
+import click
+
+from dbt_platform_helper.domain.copilot import Copilot
+from dbt_platform_helper.domain.copilot_environment import CopilotTemplating
+from dbt_platform_helper.domain.versioning import PlatformHelperVersioning
+from dbt_platform_helper.providers.config import ConfigProvider
+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.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():
+    PlatformHelperVersioning().check_if_needs_update()
+
+
+@copilot.command()
+def make_addons():
+    """Generate addons CloudFormation for each environment."""
+    try:
+        session = get_aws_session_or_abort()
+        config_provider = ConfigProvider(ConfigValidator())
+        kms_provider = KMSProvider(session.client("kms"))
+        Copilot(config_provider, FileProvider(), CopilotTemplating(), kms_provider).make_addons()
+    except Exception as err:
+        ClickIOProvider().abort_with_error(str(err))

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

@@ -4,6 +4,7 @@ from dbt_platform_helper.constants import DEFAULT_TERRAFORM_PLATFORM_MODULES_VER
 from dbt_platform_helper.domain.copilot_environment import CopilotEnvironment
 from dbt_platform_helper.domain.maintenance_page import MaintenancePage
 from dbt_platform_helper.domain.terraform_environment import TerraformEnvironment
+from dbt_platform_helper.domain.versioning import PlatformHelperVersioning
 from dbt_platform_helper.platform_exception import PlatformException
 from dbt_platform_helper.providers.cloudformation import CloudFormation
 from dbt_platform_helper.providers.config import ConfigProvider
@@ -13,9 +14,6 @@ from dbt_platform_helper.providers.vpc import VpcProvider
 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.utils.click import ClickDocOptGroup
-from dbt_platform_helper.utils.versioning import (
-    check_platform_helper_version_needs_update,
-)
 
 AVAILABLE_TEMPLATES = ["default", "migration", "dmas-migration"]
 
@@ -23,7 +21,7 @@ AVAILABLE_TEMPLATES = ["default", "migration", "dmas-migration"]
 @click.group(cls=ClickDocOptGroup)
 def environment():
     """Commands affecting environments."""
-    check_platform_helper_version_needs_update()
+    PlatformHelperVersioning().check_if_needs_update()
 
 
 @environment.command()
@@ -94,9 +92,11 @@ def generate(name):
     help=f"Override the default version of terraform-platform-modules. (Default version is '{DEFAULT_TERRAFORM_PLATFORM_MODULES_VERSION}').",
 )
 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())
         TerraformEnvironment(config_provider).generate(name, terraform_platform_modules_version)
     except PlatformException as err:
-        ClickIOProvider().abort_with_error(str(err))
+        click_io.abort_with_error(str(err))

{dbt_platform_helper-13.1.1 → dbt_platform_helper-13.2.0}/dbt_platform_helper/commands/generate.py

@@ -3,8 +3,8 @@ import click
 
 from dbt_platform_helper.commands.copilot import make_addons
 from dbt_platform_helper.commands.pipeline import generate as pipeline_generate
+from dbt_platform_helper.domain.versioning import PlatformHelperVersioning
 from dbt_platform_helper.utils.click import ClickDocOptCommand
-from dbt_platform_helper.utils.versioning import RequiredVersion
 
 
 @click.command(cls=ClickDocOptCommand)
@@ -16,7 +16,6 @@ def generate(ctx: click.Context):
 
     Wraps pipeline generate and make-addons.
     """
-
-    RequiredVersion().check_platform_helper_version_mismatch()
+    PlatformHelperVersioning().check_platform_helper_version_mismatch()
     ctx.invoke(pipeline_generate)
     ctx.invoke(make_addons)

{dbt_platform_helper-13.1.1 → dbt_platform_helper-13.2.0}/dbt_platform_helper/commands/notify.py

@@ -2,16 +2,14 @@ import click
 from slack_sdk import WebClient
 from slack_sdk.models import blocks
 
+from dbt_platform_helper.domain.versioning import PlatformHelperVersioning
 from dbt_platform_helper.utils.arn_parser import ARN
 from dbt_platform_helper.utils.click import ClickDocOptGroup
-from dbt_platform_helper.utils.versioning import (
-    check_platform_helper_version_needs_update,
-)
 
 
 @click.group(cls=ClickDocOptGroup, help="Send Slack notifications")
 def notify():
-    check_platform_helper_version_needs_update()
+    PlatformHelperVersioning().check_if_needs_update()
 
 
 @notify.command(

{dbt_platform_helper-13.1.1 → dbt_platform_helper-13.2.0}/dbt_platform_helper/commands/pipeline.py

@@ -3,6 +3,7 @@ import click
 
 from dbt_platform_helper.constants import DEFAULT_TERRAFORM_PLATFORM_MODULES_VERSION
 from dbt_platform_helper.domain.pipelines import Pipelines
+from dbt_platform_helper.domain.versioning import PlatformHelperVersioning
 from dbt_platform_helper.providers.config import ConfigProvider
 from dbt_platform_helper.providers.config_validator import ConfigValidator
 from dbt_platform_helper.providers.ecr import ECRProvider
@@ -11,15 +12,12 @@ from dbt_platform_helper.providers.terraform_manifest import TerraformManifestPr
 from dbt_platform_helper.utils.aws import get_codestar_connection_arn
 from dbt_platform_helper.utils.click import ClickDocOptGroup
 from dbt_platform_helper.utils.git import git_remote
-from dbt_platform_helper.utils.versioning import (
-    check_platform_helper_version_needs_update,
-)
 
 
 @click.group(chain=True, cls=ClickDocOptGroup)
 def pipeline():
     """Pipeline commands."""
-    check_platform_helper_version_needs_update()
+    PlatformHelperVersioning().check_if_needs_update()
 
 
 @pipeline.command()

{dbt_platform_helper-13.1.1 → dbt_platform_helper-13.2.0}/dbt_platform_helper/commands/secrets.py

@@ -6,15 +6,13 @@ import click
 from botocore.exceptions import ClientError
 from cloudfoundry_client.client import CloudFoundryClient
 
+from dbt_platform_helper.domain.versioning import PlatformHelperVersioning
 from dbt_platform_helper.utils.application import get_application_name
 from dbt_platform_helper.utils.aws import SSM_BASE_PATH
 from dbt_platform_helper.utils.aws import get_aws_session_or_abort
 from dbt_platform_helper.utils.aws import get_ssm_secrets
 from dbt_platform_helper.utils.aws import set_ssm_param
 from dbt_platform_helper.utils.click import ClickDocOptGroup
-from dbt_platform_helper.utils.versioning import (
-    check_platform_helper_version_needs_update,
-)
 
 
 def secret_should_be_skipped(secret_name):
@@ -42,7 +40,7 @@ def get_paas_env_vars(client: CloudFoundryClient, paas: str) -> dict:
 
 @click.group(chain=True, cls=ClickDocOptGroup)
 def secrets():
-    check_platform_helper_version_needs_update()
+    PlatformHelperVersioning().check_if_needs_update()
 
 
 @secrets.command()

{dbt_platform_helper-13.1.1 → dbt_platform_helper-13.2.0}/dbt_platform_helper/commands/version.py

@@ -1,9 +1,9 @@
 import click
 
+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.utils.click import ClickDocOptGroup
-from dbt_platform_helper.utils.versioning import RequiredVersion
 
 
 @click.group(chain=True, cls=ClickDocOptGroup)
@@ -32,6 +32,6 @@ def get_platform_helper_for_project(pipeline):
         - Fall back on the version in the deprecated '.platform-helper-version' file
     """
     try:
-        RequiredVersion().get_required_version(pipeline)
+        PlatformHelperVersioning().get_required_version(pipeline)
     except PlatformException as err:
         ClickIOProvider().abort_with_error(str(err))

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

@@ -12,12 +12,16 @@ from dbt_platform_helper.platform_exception import PlatformException
 from dbt_platform_helper.providers.files import FileProvider
 from dbt_platform_helper.providers.io import ClickIOProvider
 from dbt_platform_helper.utils.application import Application
-from dbt_platform_helper.utils.application import ApplicationException
+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
+from dbt_platform_helper.utils.aws import get_image_build_project
+from dbt_platform_helper.utils.aws import get_manual_release_pipeline
 from dbt_platform_helper.utils.aws import list_latest_images
 from dbt_platform_helper.utils.aws import start_build_extraction
 from dbt_platform_helper.utils.aws import start_pipeline_and_return_execution_id
@@ -32,6 +36,8 @@ class Codebase:
         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,
+        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,
         get_build_url_from_pipeline_execution_id: Callable[
             [str], str
@@ -48,6 +54,8 @@ class Codebase:
         self.load_application = load_application
         self.get_aws_session_or_abort = get_aws_session_or_abort
         self.check_image_exists = check_image_exists
+        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
         self.get_build_url_from_pipeline_execution_id = get_build_url_from_pipeline_execution_id
         self.list_latest_images = list_latest_images
@@ -124,12 +132,13 @@ class Codebase:
         self.check_if_commit_exists(commit)
 
         codebuild_client = session.client("codebuild")
+        project_name = self.get_image_build_project(codebuild_client, app, codebase)
         build_url = self.__start_build_with_confirmation(
             codebuild_client,
             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"{app}-{codebase}-codebase-pipeline-image-build",
+                "projectName": project_name,
                 "artifactsOverride": {"type": "NO_ARTIFACTS"},
                 "sourceVersion": commit,
             },
@@ -148,13 +157,14 @@ class Codebase:
 
         application = self.load_application(app, default_session=session)
         if not application.environments.get(env):
-            raise ApplicationEnvironmentNotFoundException(env)
+            raise ApplicationEnvironmentNotFoundException(application.name, env)
 
         self.check_image_exists(session, application, codebase, commit)
 
-        pipeline_name = f"{app}-{codebase}-manual-release-pipeline"
         codepipeline_client = session.client("codepipeline")
 
+        pipeline_name = self.get_manual_release_pipeline(codepipeline_client, app, codebase)
+
         build_url = self.__start_pipeline_execution_with_confirmation(
             codepipeline_client,
             self.get_build_url_from_pipeline_execution_id,
@@ -242,13 +252,6 @@ class ApplicationDeploymentNotTriggered(PlatformException):
         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__(