dbt-platform-helper 10.6.1__tar.gz → 10.7.1__tar.gz

{dbt_platform_helper-10.6.1 → dbt_platform_helper-10.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dbt-platform-helper
-Version: 10.6.1
+Version: 10.7.1
 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

{dbt_platform_helper-10.6.1 → dbt_platform_helper-10.7.1}/dbt_platform_helper/COMMANDS.md

@@ -41,6 +41,8 @@
 - [platform-helper notify add-comment](#platform-helper-notify-add-comment)
 - [platform-helper database](#platform-helper-database)
 - [platform-helper database copy](#platform-helper-database-copy)
+- [platform-helper version](#platform-helper-version)
+- [platform-helper version get-platform-helper-for-project](#platform-helper-version-get-platform-helper-for-project)
 
 # platform-helper
 
@@ -73,6 +75,7 @@ platform-helper <command> [--version]
 - [`notify` ↪](#platform-helper-notify)
 - [`pipeline` ↪](#platform-helper-pipeline)
 - [`secrets` ↪](#platform-helper-secrets)
+- [`version` ↪](#platform-helper-version)
 
 # platform-helper application
 
@@ -994,3 +997,44 @@ platform-helper database copy <source_db> <target_db>
 
 - `--help <boolean>` _Defaults to False._
   - Show this message and exit.
+
+# platform-helper version
+
+[↩ Parent](#platform-helper)
+
+    Contains subcommands for getting version information about the current
+    project.
+
+## Usage
+
+```
+platform-helper version get-platform-helper-for-project 
+```
+
+## Options
+
+- `--help <boolean>` _Defaults to False._
+  - Show this message and exit.
+
+## Commands
+
+- [`get-platform-helper-for-project` ↪](#platform-helper-version-get-platform-helper-for-project)
+
+# platform-helper version get-platform-helper-for-project
+
+[↩ Parent](#platform-helper-version)
+
+    Print the version of platform-tools required by the current project
+
+## Usage
+
+```
+platform-helper version get-platform-helper-for-project [--pipeline (main|test|prod-main)] 
+```
+
+## Options
+
+- `--pipeline <choice>`
+  - Take into account platform-tools version overrides in the specified pipeline
+- `--help <boolean>` _Defaults to False._
+  - Show this message and exit.

{dbt_platform_helper-10.6.1 → dbt_platform_helper-10.7.1}/dbt_platform_helper/commands/conduit.py

@@ -12,7 +12,7 @@ from dbt_platform_helper.utils.application import Application
 from dbt_platform_helper.utils.application import load_application
 from dbt_platform_helper.utils.aws import update_postgres_parameter_with_master_secret
 from dbt_platform_helper.utils.click import ClickDocOptCommand
-from dbt_platform_helper.utils.files import is_terraform_project
+from dbt_platform_helper.utils.platform_config import is_terraform_project
 from dbt_platform_helper.utils.versioning import (
     check_platform_helper_version_needs_update,
 )

{dbt_platform_helper-10.6.1 → dbt_platform_helper-10.7.1}/dbt_platform_helper/commands/copilot.py

@@ -10,14 +10,14 @@ from pathlib import PosixPath
 import click
 import yaml
 
+from dbt_platform_helper.constants import PLATFORM_CONFIG_FILE
 from dbt_platform_helper.utils.application import get_application_name
 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.files import PLATFORM_CONFIG_FILE
 from dbt_platform_helper.utils.files import generate_override_files
-from dbt_platform_helper.utils.files import is_terraform_project
 from dbt_platform_helper.utils.files import mkfile
+from dbt_platform_helper.utils.platform_config import is_terraform_project
 from dbt_platform_helper.utils.template import camel_case
 from dbt_platform_helper.utils.template import setup_templates
 from dbt_platform_helper.utils.validation import config_file_check

{dbt_platform_helper-10.6.1 → dbt_platform_helper-10.7.1}/dbt_platform_helper/commands/environment.py

@@ -17,8 +17,8 @@ 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.files import apply_environment_defaults
-from dbt_platform_helper.utils.files import is_terraform_project
 from dbt_platform_helper.utils.files import mkfile
+from dbt_platform_helper.utils.platform_config import is_terraform_project
 from dbt_platform_helper.utils.template import setup_templates
 from dbt_platform_helper.utils.validation import load_and_validate_platform_config
 from dbt_platform_helper.utils.versioning import (

{dbt_platform_helper-10.6.1 → dbt_platform_helper-10.7.1}/dbt_platform_helper/commands/generate.py

@@ -5,7 +5,6 @@ from dbt_platform_helper.commands.copilot import make_addons
 from dbt_platform_helper.commands.pipeline import generate as pipeline_generate
 from dbt_platform_helper.utils.click import ClickDocOptCommand
 from dbt_platform_helper.utils.versioning import check_platform_helper_version_mismatch
-from dbt_platform_helper.utils.versioning import generate_platform_helper_version_file
 
 
 @click.command(cls=ClickDocOptCommand)
@@ -18,7 +17,6 @@ def generate(ctx: click.Context):
     Wraps pipeline generate and make-addons.
     """
 
-    generate_platform_helper_version_file()
     check_platform_helper_version_mismatch()
     ctx.invoke(pipeline_generate)
     ctx.invoke(make_addons)

{dbt_platform_helper-10.6.1 → dbt_platform_helper-10.7.1}/dbt_platform_helper/commands/pipeline.py

@@ -12,10 +12,10 @@ from dbt_platform_helper.utils.aws import get_public_repository_arn
 from dbt_platform_helper.utils.click import ClickDocOptGroup
 from dbt_platform_helper.utils.files import apply_environment_defaults
 from dbt_platform_helper.utils.files import generate_override_files_from_template
-from dbt_platform_helper.utils.files import is_terraform_project
 from dbt_platform_helper.utils.files import mkfile
 from dbt_platform_helper.utils.git import git_remote
 from dbt_platform_helper.utils.messages import abort_with_error
+from dbt_platform_helper.utils.platform_config import is_terraform_project
 from dbt_platform_helper.utils.template import setup_templates
 from dbt_platform_helper.utils.validation import load_and_validate_platform_config
 from dbt_platform_helper.utils.versioning import (

dbt_platform_helper-10.7.1/dbt_platform_helper/commands/version.py

@@ -0,0 +1,38 @@
+import click
+
+from dbt_platform_helper.utils.click import ClickDocOptGroup
+from dbt_platform_helper.utils.platform_config import get_environment_pipeline_names
+from dbt_platform_helper.utils.versioning import (
+    check_platform_helper_version_needs_update,
+)
+from dbt_platform_helper.utils.versioning import get_required_platform_helper_version
+
+
+@click.group(chain=True, cls=ClickDocOptGroup)
+def version():
+    """Contains subcommands for getting version information about the current
+    project."""
+    check_platform_helper_version_needs_update()
+
+
+@version.command(help="Print the version of platform-tools required by the current project")
+@click.option(
+    "--pipeline",
+    required=False,
+    type=click.Choice(get_environment_pipeline_names()),
+    help="Take into account platform-tools version overrides in the specified pipeline",
+)
+def get_platform_helper_for_project(pipeline):
+    """
+    Version precedence is in this order:
+        - if the --pipeline option is supplied, the version in 'platform-config.yml' in:
+            environment_pipelines:
+                <pipeline>:
+                    ...
+                    versions:
+                        platform-helper
+        - The version from default_versions/platform-helper in 'platform-config.yml'
+        - Fall back on the version in the deprecated '.platform-helper-version' file
+    """
+    required_version = get_required_platform_helper_version(pipeline)
+    click.secho(required_version)

{dbt_platform_helper-10.6.1 → dbt_platform_helper-10.7.1}/dbt_platform_helper/constants.py

@@ -1,4 +1,5 @@
 PLATFORM_CONFIG_FILE = "platform-config.yml"
+PLATFORM_HELPER_VERSION_FILE = ".platform-helper-version"
 CODEBASE_PIPELINES_KEY = "codebase_pipelines"
 ENVIRONMENTS_KEY = "environments"
 DEFAULT_TERRAFORM_PLATFORM_MODULES_VERSION = "5"

{dbt_platform_helper-10.6.1 → dbt_platform_helper-10.7.1}/dbt_platform_helper/templates/pipelines/codebase/overrides/buildspec.deploy.yml

@@ -10,15 +10,8 @@ env:
 phases:
   build:
     commands:
-      - |
-        environments="{{environments}}"
-        echo "Environments are - ${environments}"
-        if echo ",${environments}," | grep -q ",${COPILOT_ENVIRONMENT},"; then
-          echo "Copilot environment is ${COPILOT_ENVIRONMENT}"
-          /work/cli deploy --send-notifications
-        else
-          exit 1
-        fi
+      - echo "Copilot environment is ${COPILOT_ENVIRONMENT}"
+      - /work/cli deploy --send-notifications
 
   post_build:
     commands:

{dbt_platform_helper-10.6.1 → dbt_platform_helper-10.7.1}/dbt_platform_helper/templates/svc/overrides/cfn.patches.yml

@@ -12,3 +12,15 @@
   path: /Resources/TaskDefinition/Properties/Volumes
   value:
     - Name: temporary-fs
+
+- op: add
+  path: /Resources/ExecutionRole/Properties/Policies/0/PolicyDocument/Statement/4
+  value:
+    Effect: 'Allow'
+    Action:
+      - 'ssm:GetParameters'
+    Resource:
+      - !Sub 'arn:${AWS::Partition}:ssm:${AWS::Region}:${AWS::AccountId}:parameter/*'
+    Condition:
+      StringEquals:
+          'ssm:ResourceTag/copilot-application': '__all__'

{dbt_platform_helper-10.6.1 → dbt_platform_helper-10.7.1}/dbt_platform_helper/utils/files.py

@@ -7,14 +7,6 @@ import yaml
 from jinja2 import Environment
 from jinja2 import FileSystemLoader
 
-from dbt_platform_helper.constants import PLATFORM_CONFIG_FILE
-
-CONFIG_FILE_MESSAGES = {
-    "storage.yml": " under the key 'extensions'",
-    "extensions.yml": " under the key 'extensions'",
-    "pipelines.yml": ", change the key 'codebases' to 'codebase_pipelines'",
-}
-
 
 def to_yaml(value):
     return yaml.dump(value, sort_keys=False)
@@ -88,15 +80,25 @@ def apply_environment_defaults(config):
     without_defaults_entry = {
         name: data if data else {} for name, data in environments.items() if name != "*"
     }
+
+    default_versions = config.get("default_versions", {})
+
+    def combine_env_data(data):
+        return {
+            **env_defaults,
+            **data,
+            "versions": {
+                **default_versions,
+                **env_defaults.get("versions", {}),
+                **data.get("versions", {}),
+            },
+        }
+
     defaulted_envs = {
-        name: {**env_defaults, **data} for name, data in without_defaults_entry.items()
+        env_name: combine_env_data(env_data)
+        for env_name, env_data in without_defaults_entry.items()
     }
 
     enriched_config["environments"] = defaulted_envs
 
     return enriched_config
-
-
-def is_terraform_project() -> bool:
-    config = yaml.safe_load(Path(PLATFORM_CONFIG_FILE).read_text())
-    return not config.get("legacy_project", False)

dbt_platform_helper-10.7.1/dbt_platform_helper/utils/platform_config.py

@@ -0,0 +1,19 @@
+from pathlib import Path
+
+import yaml
+
+from dbt_platform_helper.constants import PLATFORM_CONFIG_FILE
+from dbt_platform_helper.utils.validation import load_and_validate_platform_config
+
+
+def get_environment_pipeline_names():
+    if not Path(PLATFORM_CONFIG_FILE).exists():
+        return {}
+
+    config = load_and_validate_platform_config(disable_aws_validation=True, disable_file_check=True)
+    return config.get("environment_pipelines", {}).keys()
+
+
+def is_terraform_project() -> bool:
+    config = yaml.safe_load(Path(PLATFORM_CONFIG_FILE).read_text())
+    return not config.get("legacy_project", False)

{dbt_platform_helper-10.6.1 → dbt_platform_helper-10.7.1}/dbt_platform_helper/utils/validation.py

@@ -15,6 +15,7 @@ from yaml.parser import ParserError
 from dbt_platform_helper.constants import CODEBASE_PIPELINES_KEY
 from dbt_platform_helper.constants import ENVIRONMENTS_KEY
 from dbt_platform_helper.constants import PLATFORM_CONFIG_FILE
+from dbt_platform_helper.constants import PLATFORM_HELPER_VERSION_FILE
 from dbt_platform_helper.utils.aws import get_aws_session_or_abort
 from dbt_platform_helper.utils.files import apply_environment_defaults
 from dbt_platform_helper.utils.messages import abort_with_error
@@ -93,10 +94,6 @@ def validate_s3_bucket_name(name: str):
         if name.endswith(suffix):
             errors.append(f"Names cannot be suffixed '{suffix}'.")
 
-    if not errors:
-        # Don't waste time calling AWS if the bucket name is not even valid.
-        warn_on_s3_bucket_name_availability(name)
-
     if errors:
         raise SchemaError(
             S3_BUCKET_NAME_ERROR_TEMPLATE.format(name, "\n".join(f"  {e}" for e in errors))
@@ -127,6 +124,8 @@ def validate_addons(addons: dict):
         except SchemaError as ex:
             errors[addon_name] = f"Error in {addon_name}: {ex.code}"
 
+    _validate_s3_bucket_uniqueness({"extensions": addons})
+
     return errors
 
 
@@ -376,6 +375,17 @@ PROMETHEUS_POLICY_DEFINITION = {
     },
 }
 
+_DEFAULT_VERSIONS_DEFINITION = {
+    Optional("terraform-platform-modules"): str,
+    Optional("platform-helper"): str,
+}
+_ENVIRONMENTS_VERSIONS_OVERRIDES = {
+    Optional("terraform-platform-modules"): str,
+}
+_PIPELINE_VERSIONS_OVERRIDES = {
+    Optional("platform-helper"): str,
+}
+
 _ENVIRONMENTS_PARAMS = {
     Optional("accounts"): {
         "deploy": {
@@ -388,14 +398,11 @@ _ENVIRONMENTS_PARAMS = {
         },
     },
     Optional("requires_approval"): bool,
+    Optional("versions"): _ENVIRONMENTS_VERSIONS_OVERRIDES,
     Optional("vpc"): str,
 }
 
-ENVIRONMENTS_DEFINITION = {
-    str: Or(
-        None, {**_ENVIRONMENTS_PARAMS, Optional("versions"): {"terraform-platform-modules": str}}
-    )
-}
+ENVIRONMENTS_DEFINITION = {str: Or(None, _ENVIRONMENTS_PARAMS)}
 
 CODEBASE_PIPELINES_DEFINITION = [
     {
@@ -435,6 +442,7 @@ ENVIRONMENT_PIPELINES_DEFINITION = {
         Optional("account"): str,
         Optional("branch", default="main"): str,
         Optional("pipeline_to_trigger"): str,
+        Optional("versions"): _PIPELINE_VERSIONS_OVERRIDES,
         "slack_channel": str,
         "trigger_on_push": bool,
         "environments": {str: Or(None, _ENVIRONMENTS_PARAMS)},
@@ -446,6 +454,7 @@ PLATFORM_CONFIG_SCHEMA = Schema(
         # The following line is for the AWS Copilot version, will be removed under DBTP-1002
         "application": str,
         Optional("legacy_project", default=False): bool,
+        Optional("default_versions"): _DEFAULT_VERSIONS_DEFINITION,
         Optional("accounts"): list[str],
         Optional("environments"): ENVIRONMENTS_DEFINITION,
         Optional("codebase_pipelines"): CODEBASE_PIPELINES_DEFINITION,
@@ -467,13 +476,30 @@ PLATFORM_CONFIG_SCHEMA = Schema(
 )
 
 
-def validate_platform_config(config):
-    get_aws_session_or_abort()  # Ensure we have a valid session as validation requires it.
+def _validate_s3_bucket_uniqueness(enriched_config):
+    extensions = enriched_config.get("extensions", {})
+    bucket_extensions = [
+        s3_ext
+        for s3_ext in extensions.values()
+        if "type" in s3_ext and s3_ext["type"] in ("s3", "s3-policy")
+    ]
+    environments = [
+        env for ext in bucket_extensions for env in ext.get("environments", {}).values()
+    ]
+    bucket_names = [env.get("bucket_name") for env in environments]
+
+    for name in bucket_names:
+        warn_on_s3_bucket_name_availability(name)
+
+
+def validate_platform_config(config, disable_aws_validation=False):
     PLATFORM_CONFIG_SCHEMA.validate(config)
     enriched_config = apply_environment_defaults(config)
     _validate_environment_pipelines(enriched_config)
     _validate_environment_pipelines_triggers(enriched_config)
     _validate_codebase_pipelines(enriched_config)
+    if not disable_aws_validation:
+        _validate_s3_bucket_uniqueness(enriched_config)
 
 
 def _validate_environment_pipelines(config):
@@ -545,11 +571,14 @@ def _validate_environment_pipelines_triggers(config):
         abort_with_error(error_message + "\n  ".join(errors))
 
 
-def load_and_validate_platform_config(path=PLATFORM_CONFIG_FILE):
-    config_file_check(path)
+def load_and_validate_platform_config(
+    path=PLATFORM_CONFIG_FILE, disable_aws_validation=False, disable_file_check=False
+):
+    if not disable_file_check:
+        config_file_check(path)
     try:
         conf = yaml.safe_load(Path(path).read_text())
-        validate_platform_config(conf)
+        validate_platform_config(conf, disable_aws_validation)
         return conf
     except ParserError:
         abort_with_error(f"{PLATFORM_CONFIG_FILE} is not valid YAML")
@@ -558,28 +587,39 @@ def load_and_validate_platform_config(path=PLATFORM_CONFIG_FILE):
 def config_file_check(path=PLATFORM_CONFIG_FILE):
     platform_config_exists = Path(path).exists()
     errors = []
+    warnings = []
 
     messages = {
-        "storage.yml": " under the key 'extensions'",
-        "extensions.yml": " under the key 'extensions'",
-        "pipelines.yml": ", change the key 'codebases' to 'codebase_pipelines'",
+        "storage.yml": {"instruction": " under the key 'extensions'", "type": errors},
+        "extensions.yml": {"instruction": " under the key 'extensions'", "type": errors},
+        "pipelines.yml": {
+            "instruction": ", change the key 'codebases' to 'codebase_pipelines'",
+            "type": errors,
+        },
+        PLATFORM_HELPER_VERSION_FILE: {
+            "instruction": ", under the key `default_versions: platform-helper:`",
+            "type": warnings,
+        },
     }
 
     for file in messages.keys():
         if Path(file).exists():
-            if platform_config_exists:
-                message = f"`{file}` has been superseded by `{PLATFORM_CONFIG_FILE}` and should be deleted."
-            else:
-                message = f"`{file}` is no longer supported. Please move its contents into a file named `{PLATFORM_CONFIG_FILE}`{messages[file]} and delete `{file}`."
-            errors.append(message)
+            message = (
+                f"`{file}` is no longer supported. Please move its contents into the "
+                f"`{PLATFORM_CONFIG_FILE}` file{messages[file]['instruction']} and delete `{file}`."
+            )
+            messages[file]["type"].append(message)
 
-    if not errors and not platform_config_exists:
+    if not errors and not warnings and not platform_config_exists:
         errors.append(
-            f"`{PLATFORM_CONFIG_FILE}` is missing. Please check it exists and you are in the root directory of your deployment project."
+            f"`{PLATFORM_CONFIG_FILE}` is missing. "
+            "Please check it exists and you are in the root directory of your deployment project."
         )
 
+    if warnings:
+        click.secho("\n".join(warnings), bg="yellow", fg="black")
     if errors:
-        click.secho("\n".join(errors), bg="red")
+        click.secho("\n".join(errors), bg="red", fg="white")
         exit(1)
 
 

{dbt_platform_helper-10.6.1 → dbt_platform_helper-10.7.1}/dbt_platform_helper/utils/versioning.py

@@ -1,41 +1,56 @@
 import os
 import re
 import subprocess
+from importlib.metadata import PackageNotFoundError
 from importlib.metadata import version
 from pathlib import Path
+from typing import Optional
 from typing import Tuple
 from typing import Union
 
 import click
 import requests
 
+from dbt_platform_helper.constants import PLATFORM_CONFIG_FILE
+from dbt_platform_helper.constants import PLATFORM_HELPER_VERSION_FILE
 from dbt_platform_helper.exceptions import IncompatibleMajorVersion
 from dbt_platform_helper.exceptions import IncompatibleMinorVersion
 from dbt_platform_helper.exceptions import ValidationException
-from dbt_platform_helper.utils.files import mkfile
+from dbt_platform_helper.utils.validation import load_and_validate_platform_config
+
+VersionTuple = Optional[Tuple[int, int, int]]
 
 
 class Versions:
-    def __init__(self, local_version=None, latest_release=None):
+    def __init__(self, local_version: VersionTuple = None, latest_release: VersionTuple = None):
         self.local_version = local_version
         self.latest_release = latest_release
 
 
 class PlatformHelperVersions:
-    def __init__(self, local_version=None, latest_release=None, platform_helper_file_version=None):
+    def __init__(
+        self,
+        local_version: VersionTuple = None,
+        latest_release: VersionTuple = None,
+        platform_helper_file_version: VersionTuple = None,
+        platform_config_default: VersionTuple = None,
+        pipeline_overrides: dict[str, str] = None,
+    ):
         self.local_version = local_version
         self.latest_release = latest_release
         self.platform_helper_file_version = platform_helper_file_version
+        self.platform_config_default = platform_config_default
+        self.pipeline_overrides = pipeline_overrides
 
 
-def string_version(input_version: Union[Tuple[int, int, int], None]) -> str:
+def string_version(input_version: VersionTuple) -> str:
     if input_version is None:
         return "unknown"
     major, minor, patch = input_version
     return ".".join([str(s) for s in [major, minor, patch]])
 
 
-def parse_version(input_version: Union[str, None]) -> Union[Tuple[int, int, int], None]:
+def parse_version(input_version: Union[str, None]) -> VersionTuple:
     if input_version is None:
         return None
 
@@ -90,28 +105,72 @@ def get_github_released_version(repository: str, tags: bool = False) -> Tuple[in
 
 
 def get_platform_helper_versions() -> PlatformHelperVersions:
-    locally_installed_version = parse_version(version("dbt-platform-helper"))
+    try:
+        locally_installed_version = parse_version(version("dbt-platform-helper"))
+    except PackageNotFoundError:
+        locally_installed_version = None
 
     package_info = requests.get("https://pypi.org/pypi/dbt-platform-helper/json").json()
     released_versions = package_info["releases"].keys()
     parsed_released_versions = [parse_version(v) for v in released_versions]
     parsed_released_versions.sort(reverse=True)
     latest_release = parsed_released_versions[0]
+    platform_config = load_and_validate_platform_config(disable_aws_validation=True)
+    platform_config_default = parse_version(
+        platform_config.get("default_versions", {}).get("platform-helper")
+    )
 
-    version_from_file = None
-    message = "Cannot get dbt-platform-helper version from file '.platform-helper-version'. Check if file exists."
-
-    try:
-        version_from_file = parse_version(Path(".platform-helper-version").read_text())
-    except FileNotFoundError:
-        click.secho(f"{message}", fg="yellow")
+    pipeline_overrides = {
+        name: pipeline.get("versions", {}).get("platform-helper")
+        for name, pipeline in platform_config.get("environment_pipelines", {}).items()
+        if pipeline.get("versions", {}).get("platform-helper")
+    }
+
+    deprecated_version_file = Path(PLATFORM_HELPER_VERSION_FILE)
+    version_from_file = (
+        parse_version(deprecated_version_file.read_text())
+        if deprecated_version_file.exists()
+        else None
+    )
 
-    return PlatformHelperVersions(
+    out = PlatformHelperVersions(
         local_version=locally_installed_version,
         latest_release=latest_release,
         platform_helper_file_version=version_from_file,
+        platform_config_default=platform_config_default,
+        pipeline_overrides=pipeline_overrides,
     )
 
+    _process_version_file_warnings(out)
+
+    return out
+
+
+def _process_version_file_warnings(versions: PlatformHelperVersions):
+    messages = []
+    missing_default_version_message = f"Create a section in the root of '{PLATFORM_CONFIG_FILE}':\n\ndefault_versions:\n  platform-helper: "
+    deprecation_message = f"Please delete '{PLATFORM_HELPER_VERSION_FILE}' as it is now deprecated."
+
+    if versions.platform_config_default and versions.platform_helper_file_version:
+        messages.append(deprecation_message)
+
+    if versions.platform_config_default and not versions.platform_helper_file_version:
+        return
+
+    if not versions.platform_config_default and versions.platform_helper_file_version:
+        messages.append(deprecation_message)
+        messages.append(
+            f"{missing_default_version_message}{string_version(versions.platform_helper_file_version)}\n"
+        )
+
+    if not versions.platform_config_default and not versions.platform_helper_file_version:
+        messages.append(f"Cannot get dbt-platform-helper version from '{PLATFORM_CONFIG_FILE}'.")
+        messages.append(
+            f"{missing_default_version_message}{string_version(versions.local_version)}\n"
+        )
+
+    click.secho("\n".join(messages), fg="yellow")
+
 
 def validate_version_compatibility(
     app_version: Tuple[int, int, int], check_version: Tuple[int, int, int]
@@ -160,12 +219,6 @@ def validate_template_version(app_version: Tuple[int, int, int], template_file_p
     )
 
 
-def generate_platform_helper_version_file(directory="."):
-    base_path = Path(directory)
-    local_version = string_version(get_platform_helper_versions().local_version)
-    click.echo(mkfile(base_path, ".platform-helper-version", f"{local_version}\n"))
-
-
 def check_platform_helper_version_needs_update():
     if not running_as_installed_package() or "PLATFORM_TOOLS_SKIP_VERSION_CHECK" in os.environ:
         return
@@ -197,10 +250,25 @@ def check_platform_helper_version_mismatch():
     if not check_version_on_file_compatibility(local_version, platform_helper_file_version):
         message = (
             f"WARNING: You are running platform-helper v{string_version(local_version)} against "
-            f"v{string_version(platform_helper_file_version)} specified by .platform-helper-version."
+            f"v{string_version(platform_helper_file_version)} specified by {PLATFORM_HELPER_VERSION_FILE}."
         )
         click.secho(message, fg="red")
 
 
 def running_as_installed_package():
     return "site-packages" in __file__
+
+
+def get_required_platform_helper_version(pipeline: str = None) -> str:
+    versions = get_platform_helper_versions()
+    pipeline_version = versions.pipeline_overrides.get(pipeline)
+    version_precedence = [
+        pipeline_version,
+        versions.platform_config_default,
+        versions.platform_helper_file_version,
+    ]
+    non_null_version_precedence = [
+        string_version(v) if isinstance(v, tuple) else v for v in version_precedence if v
+    ]
+
+    return non_null_version_precedence[0] if non_null_version_precedence else None

{dbt_platform_helper-10.6.1 → dbt_platform_helper-10.7.1}/platform_helper.py

@@ -20,6 +20,7 @@ from dbt_platform_helper.commands.generate import generate as generate_commands
 from dbt_platform_helper.commands.notify import notify as notify_commands
 from dbt_platform_helper.commands.pipeline import pipeline as pipeline_commands
 from dbt_platform_helper.commands.secrets import secrets as secrets_commands
+from dbt_platform_helper.commands.version import version as version_commands
 from dbt_platform_helper.utils.click import ClickDocOptGroup
 
 
@@ -46,6 +47,7 @@ platform_helper.add_command(pipeline_commands)
 platform_helper.add_command(secrets_commands)
 platform_helper.add_command(notify_commands)
 platform_helper.add_command(database_commands)
+platform_helper.add_command(version_commands)
 
 if __name__ == "__main__":
     platform_helper()

{dbt_platform_helper-10.6.1 → dbt_platform_helper-10.7.1}/pyproject.toml

@@ -3,7 +3,7 @@ line-length = 100
 
 [tool.poetry]
 name = "dbt-platform-helper"
-version = "10.6.1"
+version = "10.7.1"
 description = "Set of tools to help transfer applications/services from GOV.UK PaaS to DBT PaaS augmenting AWS Copilot."
 authors = ["Department for Business and Trade Platform Team <sre-team@digital.trade.gov.uk>"]
 license = "MIT"