dbt-platform-helper 10.11.2__tar.gz → 10.11.3__tar.gz

{dbt_platform_helper-10.11.2 → dbt_platform_helper-10.11.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dbt-platform-helper
-Version: 10.11.2
+Version: 10.11.3
 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.11.2 → dbt_platform_helper-10.11.3}/dbt_platform_helper/COMMANDS.md

@@ -1002,8 +1002,8 @@ platform-helper database copy <source_db> <target_db>
 
 [↩ Parent](#platform-helper)
 
-    Contains subcommands for getting version information about the current
-    project.
+    Contains subcommands for getting version information about the
+        current project.
 
 ## Usage
 

dbt_platform_helper-10.11.3/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 get_required_platform_helper_version
+
+
+class VersionCommand:
+    def __init__(self):
+        self.command_group = self.version
+        self.command = self.get_platform_helper_for_project
+
+    @click.group(chain=True, cls=ClickDocOptGroup)
+    def version():
+        """Contains subcommands for getting version information about the
+        current project."""
+
+    @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.11.3/dbt_platform_helper/utils/platform_config.py

@@ -0,0 +1,32 @@
+import yaml
+
+from pathlib import Path
+
+from dbt_platform_helper.constants import PLATFORM_CONFIG_FILE
+
+
+def _read_config_file_contents():
+    if Path(PLATFORM_CONFIG_FILE).exists():
+        return Path(PLATFORM_CONFIG_FILE).read_text()
+
+
+def load_unvalidated_config_file():
+    file_contents = _read_config_file_contents()
+    if not file_contents:
+        return {}
+    try:
+        return yaml.safe_load(file_contents)
+    except yaml.parser.ParserError:
+        return {}
+
+
+def get_environment_pipeline_names():
+    pipelines_config = load_unvalidated_config_file().get("environment_pipelines")
+    if pipelines_config:
+        return pipelines_config.keys()
+    return {}
+
+
+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.11.2 → dbt_platform_helper-10.11.3}/dbt_platform_helper/utils/validation.py

@@ -615,6 +615,8 @@ def load_and_validate_platform_config(
         return conf
     except ParserError:
         abort_with_error(f"{PLATFORM_CONFIG_FILE} is not valid YAML")
+    except SchemaError as e:
+        abort_with_error(f"Schema error in {PLATFORM_CONFIG_FILE}. {e}")
 
 
 def config_file_check(path=PLATFORM_CONFIG_FILE):

{dbt_platform_helper-10.11.2 → dbt_platform_helper-10.11.3}/dbt_platform_helper/utils/versioning.py

@@ -16,7 +16,7 @@ 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.validation import load_and_validate_platform_config
+from dbt_platform_helper.utils.platform_config import load_unvalidated_config_file
 
 VersionTuple = Optional[Tuple[int, int, int]]
 
@@ -104,22 +104,40 @@ def get_github_released_version(repository: str, tags: bool = False) -> Tuple[in
     return parse_version(package_info["tag_name"])
 
 
+def _get_latest_release():
+    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)
+    return parsed_released_versions[0]
+
+
 def get_platform_helper_versions(include_project_versions=True) -> PlatformHelperVersions:
     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]
+    latest_release = _get_latest_release()
+
+    if not include_project_versions:
+        return PlatformHelperVersions(
+            local_version=locally_installed_version,
+            latest_release=latest_release,
+        )
+
+    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
+    )
+
+    platform_config_default, pipeline_overrides = None, {}
 
-    platform_config_default, pipeline_overrides, version_from_file = None, {}, None
+    platform_config = load_unvalidated_config_file()
 
-    if include_project_versions:
-        platform_config = load_and_validate_platform_config(disable_aws_validation=True)
+    if platform_config:
         platform_config_default = parse_version(
             platform_config.get("default_versions", {}).get("platform-helper")
         )
@@ -130,13 +148,6 @@ def get_platform_helper_versions(include_project_versions=True) -> PlatformHelpe
             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
-        )
-
     out = PlatformHelperVersions(
         local_version=locally_installed_version,
         latest_release=latest_release,
@@ -145,8 +156,7 @@ def get_platform_helper_versions(include_project_versions=True) -> PlatformHelpe
         pipeline_overrides=pipeline_overrides,
     )
 
-    if include_project_versions:
-        _process_version_file_warnings(out)
+    _process_version_file_warnings(out)
 
     return out
 

{dbt_platform_helper-10.11.2 → dbt_platform_helper-10.11.3}/platform_helper.py

@@ -20,7 +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.commands.version import VersionCommand
 from dbt_platform_helper.utils.click import ClickDocOptGroup
 
 
@@ -47,7 +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)
+platform_helper.add_command(VersionCommand().command_group)
 
 if __name__ == "__main__":
     platform_helper()

{dbt_platform_helper-10.11.2 → dbt_platform_helper-10.11.3}/pyproject.toml

@@ -3,7 +3,7 @@ line-length = 100
 
 [tool.poetry]
 name = "dbt-platform-helper"
-version = "10.11.2"
+version = "10.11.3"
 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"

dbt_platform_helper-10.11.2/dbt_platform_helper/commands/version.py

@@ -1,38 +0,0 @@
-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.11.2/dbt_platform_helper/utils/platform_config.py

@@ -1,19 +0,0 @@
-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)