dbt-platform-helper 15.6.0__tar.gz → 15.7.0__tar.gz

{dbt_platform_helper-15.6.0 → dbt_platform_helper-15.7.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.3
 Name: dbt-platform-helper
-Version: 15.6.0
+Version: 15.7.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, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*, !=3.8.*
+Requires-Python: >3.9.1,<4.0
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
@@ -13,7 +13,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: Jinja2 (==3.1.6)
-Requires-Dist: PyYAML (==6.0.1)
+Requires-Dist: PyYAML (==6.0.2)
 Requires-Dist: aiohttp (>=3.11.16,<4.0.0)
 Requires-Dist: boto3 (>=1.35.2,<2.0.0)
 Requires-Dist: boto3-stubs (>=1.26.148,<2.0.0)
@@ -23,7 +23,6 @@ Requires-Dist: cfn-flip (==1.3.0)
 Requires-Dist: cfn-lint (>=1.4.2,<2.0.0)
 Requires-Dist: checkov (>=3.2.405,<4.0.0)
 Requires-Dist: click (>=8.1.3,<9.0.0)
-Requires-Dist: cloudfoundry-client (==1.35.2)
 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)
@@ -34,7 +33,7 @@ Requires-Dist: requests (>=2.31.0,<3.0.0)
 Requires-Dist: schema (==0.7.5)
 Requires-Dist: semver (>=3.0.2,<4.0.0)
 Requires-Dist: slack-sdk (>=3.27.1,<4.0.0)
-Requires-Dist: tomlkit (>=0.12.2,<0.13.0)
+Requires-Dist: tomlkit (>=0.12.2,<0.14.0)
 Requires-Dist: yamllint (>=1.35.1,<2.0.0)
 Description-Content-Type: text/markdown
 

{dbt_platform_helper-15.6.0 → dbt_platform_helper-15.7.0}/dbt_platform_helper/COMMANDS.md

@@ -27,6 +27,8 @@
     - [platform-helper secrets](#platform-helper-secrets)
         - [platform-helper secrets copy](#platform-helper-secrets-copy)
         - [platform-helper secrets list](#platform-helper-secrets-list)
+    - [platform-helper service](#platform-helper-service)
+        - [platform-helper service generate](#platform-helper-service-generate)
     - [platform-helper notify](#platform-helper-notify)
         - [platform-helper notify environment-progress](#platform-helper-notify-environment-progress)
         - [platform-helper notify post-message](#platform-helper-notify-post-message)
@@ -66,6 +68,7 @@ platform-helper <command> [--version]
 - [`notify` ↪](#platform-helper-notify)
 - [`pipeline` ↪](#platform-helper-pipeline)
 - [`secrets` ↪](#platform-helper-secrets)
+- [`service` ↪](#platform-helper-service)
 - [`version` ↪](#platform-helper-version)
 
 # platform-helper application
@@ -660,6 +663,54 @@ platform-helper secrets list <application> <environment>
 - `--help <boolean>` _Defaults to False._
   - Show this message and exit.
 
+# platform-helper service
+
+[↩ Parent](#platform-helper)
+
+    Commands affecting services.
+
+## Usage
+
+```
+platform-helper service generate 
+```
+
+## Options
+
+- `--help <boolean>` _Defaults to False._
+  - Show this message and exit.
+
+## Commands
+
+- [`generate` ↪](#platform-helper-service-generate)
+
+# platform-helper service generate
+
+[↩ Parent](#platform-helper-service)
+
+    Generate terraform manifest for the specified service(s).
+
+## Usage
+
+```
+platform-helper service generate [--name <name>] [--environment <environment>] 
+                                 [--image-tag <image_tag>] 
+```
+
+## Options
+
+- `--name
+-n <text>`
+  - The name of the service to generate a manifest for. Multiple values accepted.
+- `--environment
+-e <text>`
+  - The name of the environment to generate service manifests for. Multiple values accepted.
+- `--image-tag
+-i <text>`
+  - Docker image tag to deploy for the service. Overrides the $IMAGE_TAG environment variable.
+- `--help <boolean>` _Defaults to False._
+  - Show this message and exit.
+
 # platform-helper notify
 
 [↩ Parent](#platform-helper)

{dbt_platform_helper-15.6.0 → dbt_platform_helper-15.7.0}/dbt_platform_helper/commands/secrets.py

@@ -4,7 +4,6 @@ from pathlib import Path
 
 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
@@ -19,25 +18,6 @@ def secret_should_be_skipped(secret_name):
     return "AWS_" in secret_name
 
 
-def get_paas_env_vars(client: CloudFoundryClient, paas: str) -> dict:
-    org, space, app = paas.split("/")
-
-    env_vars = None
-
-    for paas_org in client.v2.organizations:
-        if paas_org["entity"]["name"] == org:
-            for paas_space in paas_org.spaces():
-                if paas_space["entity"]["name"] == space:
-                    for paas_app in paas_space.apps():
-                        if paas_app["entity"]["name"] == app:
-                            env_vars = paas_app["entity"]["environment_json"]
-
-    if not env_vars:
-        raise Exception(f"Application {paas} not found")
-
-    return dict(env_vars)
-
-
 @click.group(chain=True, cls=ClickDocOptGroup)
 def secrets():
     PlatformHelperVersioning().check_if_needs_update()

dbt_platform_helper-15.7.0/dbt_platform_helper/commands/service.py

@@ -0,0 +1,53 @@
+import click
+
+from dbt_platform_helper.domain.service import ServiceManager
+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
+
+
+@click.group(cls=ClickDocOptGroup)
+def service():
+    """Commands affecting services."""
+    PlatformHelperVersioning().check_if_needs_update()
+
+
+@service.command(help="Generate terraform manifest for the specified service(s).")
+@click.option(
+    "--name",
+    "-n",
+    required=False,
+    help="The name of the service to generate a manifest for. Multiple values accepted.",
+    multiple=True,
+)
+@click.option(
+    "--environment",
+    "-e",
+    required=False,
+    multiple=True,
+    help="The name of the environment to generate service manifests for. Multiple values accepted.",
+)
+@click.option(
+    "--image-tag",
+    "-i",
+    required=False,
+    help="Docker image tag to deploy for the service. Overrides the $IMAGE_TAG environment variable.",
+)
+def generate(name, environment, image_tag):
+    """Validates the service-config.yml format, applies the environment-specific
+    overrides, and generates a Terraform manifest at
+    /terraform/services/<environment>/<service>/main.tf.json."""
+
+    services = list(name)
+    environments = list(environment)
+    click_io = ClickIOProvider()
+
+    try:
+        service_manager = ServiceManager()
+        service_manager.generate(
+            environments=environments, services=services, image_tag_flag=image_tag
+        )
+
+    except PlatformException as err:
+        click_io.abort_with_error(str(err))

{dbt_platform_helper-15.6.0 → dbt_platform_helper-15.7.0}/dbt_platform_helper/constants.py

@@ -1,5 +1,7 @@
 # TODO: DBTP-1888: Move to Config provider
 PLATFORM_CONFIG_FILE = "platform-config.yml"
+SERVICE_DIRECTORY = "services"
+SERVICE_CONFIG_FILE = "service-config.yml"
 PLATFORM_HELPER_VERSION_OVERRIDE_KEY = "PLATFORM_HELPER_VERSION_OVERRIDE"
 TERRAFORM_EXTENSIONS_MODULE_SOURCE_OVERRIDE_ENV_VAR = "TERRAFORM_EXTENSIONS_MODULE_SOURCE_OVERRIDE"
 TERRAFORM_ENVIRONMENT_PIPELINES_MODULE_SOURCE_OVERRIDE_ENV_VAR = (
@@ -8,6 +10,11 @@ TERRAFORM_ENVIRONMENT_PIPELINES_MODULE_SOURCE_OVERRIDE_ENV_VAR = (
 TERRAFORM_CODEBASE_PIPELINES_MODULE_SOURCE_OVERRIDE_ENV_VAR = (
     "TERRAFORM_CODEBASE_PIPELINES_MODULE_SOURCE_OVERRIDE"
 )
+TERRAFORM_ECS_SERVICE_MODULE_SOURCE_OVERRIDE_ENV_VAR = (
+    "TERRAFORM_ECS_SERVICE_MODULE_SOURCE_OVERRIDE"
+)
+TERRAFORM_MODULE_SOURCE_TYPE_ENV_VAR = "TERRAFORM_MODULE_SOURCE_TYPE"  # "LOCAL", "SSH", "OVERRIDE"
+IMAGE_TAG_ENV_VAR = "IMAGE_TAG"
 PLATFORM_HELPER_PACKAGE_NAME = "dbt-platform-helper"
 SUPPORTED_TERRAFORM_VERSION = "~> 1.8"
 SUPPORTED_AWS_PROVIDER_VERSION = "~> 5"
@@ -15,6 +22,7 @@ FIRST_UPGRADABLE_PLATFORM_HELPER_MAJOR_VERSION = 13
 
 MERGED_TPM_PLATFORM_HELPER_VERSION = 14
 PLATFORM_CONFIG_SCHEMA_VERSION = 1
+SERVICE_CONFIG_SCHEMA_VERSION = 1
 
 # Keys
 CODEBASE_PIPELINES_KEY = "codebase_pipelines"

dbt_platform_helper-15.7.0/dbt_platform_helper/domain/service.py

@@ -0,0 +1,153 @@
+from datetime import datetime
+from importlib.metadata import version
+from pathlib import Path
+
+from dbt_platform_helper.constants import IMAGE_TAG_ENV_VAR
+from dbt_platform_helper.constants import PLATFORM_HELPER_VERSION_OVERRIDE_KEY
+from dbt_platform_helper.constants import SERVICE_CONFIG_FILE
+from dbt_platform_helper.constants import SERVICE_DIRECTORY
+from dbt_platform_helper.constants import (
+    TERRAFORM_ECS_SERVICE_MODULE_SOURCE_OVERRIDE_ENV_VAR,
+)
+from dbt_platform_helper.constants import TERRAFORM_MODULE_SOURCE_TYPE_ENV_VAR
+from dbt_platform_helper.domain.terraform_environment import (
+    EnvironmentNotFoundException,
+)
+from dbt_platform_helper.entities.service import ServiceConfig
+from dbt_platform_helper.platform_exception import PlatformException
+from dbt_platform_helper.providers.config import ConfigLoader
+from dbt_platform_helper.providers.config import ConfigProvider
+from dbt_platform_helper.providers.config_validator import ConfigValidator
+from dbt_platform_helper.providers.environment_variable import (
+    EnvironmentVariableProvider,
+)
+from dbt_platform_helper.providers.io import ClickIOProvider
+from dbt_platform_helper.providers.terraform_manifest import TerraformManifestProvider
+from dbt_platform_helper.providers.yaml_file import YamlFileProvider
+from dbt_platform_helper.utils.application import load_application
+from dbt_platform_helper.utils.deep_merge import deep_merge
+
+# TODO add schema version too service config
+
+
+class ServiceManager:
+    def __init__(
+        self,
+        config_provider=ConfigProvider(ConfigValidator()),
+        loader: ConfigLoader = ConfigLoader(),
+        io: ClickIOProvider = ClickIOProvider(),
+        file_provider=YamlFileProvider,
+        environment_variable_provider: EnvironmentVariableProvider = None,
+        manifest_provider: TerraformManifestProvider = None,
+        platform_helper_version_override: str = None,
+        load_application=load_application,
+    ):
+
+        self.file_provider = file_provider
+        self.config_provider = config_provider
+        self.loader = loader
+        self.io = io
+        self.environment_variable_provider = (
+            environment_variable_provider or EnvironmentVariableProvider()
+        )
+        self.manifest_provider = manifest_provider or TerraformManifestProvider()
+        self.platform_helper_version_override = (
+            platform_helper_version_override
+            or self.environment_variable_provider.get(PLATFORM_HELPER_VERSION_OVERRIDE_KEY)
+        )
+        self.load_application = load_application
+
+    def generate(self, environments: list[str], services: list[str], image_tag_flag: str = None):
+
+        config = self.config_provider.get_enriched_config()
+        application_name = config.get("application", "")
+        application = self.load_application(app=application_name)
+
+        if not environments:
+            for environment in application.environments:
+                environments.append(environment)
+        else:
+            for environment in environments:
+                if environment not in application.environments:
+                    raise EnvironmentNotFoundException(
+                        f"cannot generate terraform for environment {environment}.  It does not exist in your configuration"
+                    )
+
+        if not services:
+            try:
+                for dir in Path("services").iterdir():
+                    if dir.is_dir():
+                        config_path = dir / SERVICE_CONFIG_FILE
+                        if config_path.exists():
+                            services.append(dir.name)
+                        else:
+                            self.io.warn(
+                                f"Failed loading service name from {dir.name}.\n"
+                                "Please ensure that your '/services' directory follows the correct structure (i.e. /services/<service_name>/service-config.yml) and the 'service-config.yml' contents are correct."
+                            )
+            except Exception as e:
+                self.io.abort_with_error(f"Failed extracting services with exception, {e}")
+        service_models = []
+        for service in services:
+            service_models.append(
+                self.loader.load_into_model(
+                    f"{SERVICE_DIRECTORY}/{service}/{SERVICE_CONFIG_FILE}",
+                    ServiceConfig,
+                )
+            )
+
+        platform_helper_version_for_template: str = (
+            self.platform_helper_version_override
+            or config.get("default_versions", {}).get("platform-helper")
+        )
+
+        source_type = self.environment_variable_provider.get(TERRAFORM_MODULE_SOURCE_TYPE_ENV_VAR)
+
+        if source_type == "LOCAL":
+            module_source_override = ServiceConfig.local_terraform_source
+        elif source_type == "OVERRIDE":
+            module_source_override = self.environment_variable_provider.get(
+                TERRAFORM_ECS_SERVICE_MODULE_SOURCE_OVERRIDE_ENV_VAR
+            )
+        else:
+            module_source_override = None
+
+        image_tag = image_tag_flag or self.environment_variable_provider.get(IMAGE_TAG_ENV_VAR)
+        if not image_tag:
+            raise PlatformException(
+                f"An image tag must be provided to deploy a service. This can be set by the $IMAGE_TAG environment variable, or the --image-tag flag."
+            )
+
+        timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
+
+        for service in service_models:
+
+            for environment in environments:
+
+                model_dump = service.model_dump(exclude_none=True)
+                env_overrides = model_dump.get("environments", {}).get(environment)
+                if env_overrides:
+                    merged_config = deep_merge(model_dump, env_overrides)
+                else:
+                    merged_config = model_dump.copy()
+                merged_config.pop("environments", None)
+
+                output_path = Path(
+                    f"terraform/{SERVICE_DIRECTORY}/{environment}/{service.name}/{SERVICE_CONFIG_FILE}"
+                )
+                output_path.parent.mkdir(parents=True, exist_ok=True)
+
+                self.file_provider.write(
+                    str(output_path),
+                    merged_config,
+                    f"# WARNING: This is an autogenerated file, not for manual editing.\n# Generated by platform-helper {version('dbt-platform-helper')} / {timestamp}.\n",
+                )
+
+                self.manifest_provider.generate_service_config(
+                    service,
+                    environment,
+                    image_tag,
+                    platform_helper_version_for_template,
+                    config,
+                    module_source_override,
+                )

{dbt_platform_helper-15.6.0 → dbt_platform_helper-15.7.0}/dbt_platform_helper/entities/platform_config_schema.py

@@ -152,7 +152,7 @@ class PlatformConfigSchema:
                                 {
                                     "name": str,
                                     Optional("requires_approval"): bool,
-                                }
+                                },
                             ],
                         },
                         {
@@ -167,9 +167,16 @@ class PlatformConfigSchema:
                         },
                     ),
                 ],
+                Optional("cache_invalidation"): {
+                    "domains": PlatformConfigSchema.__cache_invalidation_domains_schema(),
+                },
             },
         }
 
+    @staticmethod
+    def __cache_invalidation_domains_schema() -> dict:
+        return {str: {"paths": [str], "environment": str}}
+
     @staticmethod
     def __default_versions_schema() -> dict:
         return {

dbt_platform_helper-15.7.0/dbt_platform_helper/entities/service.py

@@ -0,0 +1,114 @@
+from typing import ClassVar
+from typing import Dict
+from typing import Optional
+from typing import Union
+
+from pydantic import BaseModel
+from pydantic import Field
+
+
+class HealthCheck(BaseModel):
+    path: Optional[str] = Field(description="""Path the healthcheck calls""", default=None)
+    port: Optional[int] = Field(description="""Port the healthcheck calls""", default=None)
+    success_codes: Optional[str] = Field(
+        description="""The success codes the healthcheck looks for""", default=None
+    )
+    healthy_threshold: Optional[int] = Field(description="""The number of  """, default=None)
+    unhealthy_threshold: Optional[int] = Field(description="""The number of """, default=None)
+    interval: Optional[str] = Field(
+        description="""The interval inbetween health check calls""", default=None
+    )
+    timeout: Optional[str] = Field(
+        description="""The timeout for a healthcheck call""", default=None
+    )
+    grace_period: Optional[str] = Field(description="""The time""", default=None)
+
+
+class Http(BaseModel):
+    path: Optional[str] = Field(
+        description="""Requests to this path will be forwarded to your service.""", default=None
+    )
+    alb: Optional[str] = Field(default=None)
+    target_container: Optional[str] = Field(
+        description="""Target container for the requests""", default=None
+    )
+    healthcheck: Optional[HealthCheck] = Field(default=None)
+
+
+class Sidecar(BaseModel):
+    port: int = Field()
+    image: str = Field()
+    essential: Optional[bool] = Field(default=None)
+    variables: Optional[Dict[str, Union[str, int, bool]]] = Field(default=None)
+    secrets: Optional[Dict[str, str]] = Field(default=None)
+
+
+class SidecarOverride(BaseModel):
+    port: Optional[int] = Field(default=None)
+    image: Optional[str] = Field(default=None)
+    essential: Optional[bool] = Field(default=None)
+    variables: Optional[Dict[str, Union[str, int, bool]]] = Field(default=None)
+    secrets: Optional[Dict[str, str]] = Field(default=None)
+
+
+class Image(BaseModel):
+    build: Optional[str] = Field(default=None)
+    location: Optional[str] = Field(default=None)
+    port: int = Field()
+
+
+class VPC(BaseModel):
+    placement: str = Field()
+
+
+class Network(BaseModel):
+    connect: bool = Field(
+        description="Enable Service Connect for intra-environment traffic between services."
+    )
+    vpc: Optional[VPC] = Field(default=None)
+
+
+class Storage(BaseModel):
+    readonly_fs: bool
+
+
+class ServiceConfigEnvironmentOverride(BaseModel):
+    http: Optional[Http] = Field(default=None)
+    sidecars: Optional[Dict[str, SidecarOverride]] = Field(default=None)
+    image: Optional[Image] = Field(default=None)
+
+    cpu: Optional[int] = Field(default=None)
+    memory: Optional[int] = Field(default=None)
+    count: Optional[int] = Field(default=None)
+    exec: Optional[bool] = Field(default=None)
+    network: Optional[Network] = Field(default=None)
+
+    storage: Optional[Storage] = Field(default=None)
+
+    variables: Optional[Dict[str, Union[str, int, bool]]] = Field(default=None)
+    secrets: Optional[Dict[str, str]] = Field(default=None)
+
+
+class ServiceConfig(BaseModel):
+    name: str = Field(description="""Name of the Service.""")
+    type: str = Field(description="""The type of service""")
+
+    http: Optional[Http] = Field(default=None)  # TODO http required if service type load balancer
+    sidecars: Optional[Dict[str, Sidecar]] = Field(default=None)
+    image: Image = Field()
+
+    cpu: int = Field()
+    memory: int = Field()
+    count: int = Field()
+    exec: Optional[bool] = Field(default=None)
+    network: Optional[Network] = Field(default=None)
+
+    storage: Optional[Storage] = Field(default=None)
+
+    variables: Optional[Dict[str, Union[str, int, bool]]] = Field(default=None)
+    secrets: Optional[Dict[str, str]] = Field(default=None)
+    # Environment overrides can override almost the full config
+    environments: Optional[Dict[str, ServiceConfigEnvironmentOverride]] = Field(default=None)
+
+    # Class based variable used when handling the obejct
+    local_terraform_source: ClassVar[str] = "../../../../../platform-tools/terraform/ecs-service"

{dbt_platform_helper-15.6.0 → dbt_platform_helper-15.7.0}/dbt_platform_helper/providers/config.py

@@ -25,6 +25,34 @@ PLEASE_UPGRADE_TO_V13_MESSAGE = """Please ensure that you have already upgraded
 Then upgrade platform-helper to version {installed_platform_helper_version} and run 'platform-helper config migrate' to upgrade the configuration to the current schema version."""
 
 
+class ConfigLoader:
+    def __init__(self, file_provider=YamlFileProvider, io: ClickIOProvider = ClickIOProvider()):
+        self.io = io
+        self.file_provider = file_provider
+
+    def load_into_model(self, path, model):
+        try:
+            file_content = self.file_provider.load(path)
+            return model(**file_content)
+        except FileNotFoundException as e:
+            self.io.abort_with_error(
+                f"{e} Please check it exists and you are in the root directory of your -deploy repository."
+            )
+        except FileProviderException as e:
+            self.io.abort_with_error(f"Error loading configuration from {path}: {e}")
+
+    def load(self, path):
+        try:
+            file_content = self.file_provider.load(path)
+            return file_content
+        except FileNotFoundException as e:
+            self.io.abort_with_error(
+                f"{e} Please check it exists and you are in the root directory of your -deploy repository."
+            )
+        except FileProviderException as e:
+            self.io.abort_with_error(f"Error loading configuration from {path}: {e}")
+
+
 class ConfigProvider:
     def __init__(
         self,

{dbt_platform_helper-15.6.0 → dbt_platform_helper-15.7.0}/dbt_platform_helper/providers/config_validator.py

@@ -29,6 +29,7 @@ class ConfigValidator:
             self.validate_environment_pipelines_triggers,
             self.validate_database_copy_section,
             self.validate_database_migration_input_sources,
+            self.validate_cache_invalidation_config,
         ]
         self.io = io
         self.session = session
@@ -232,3 +233,25 @@ class ConfigValidator:
                     )
         if errors:
             raise ConfigValidatorError("\n".join(errors))
+
+    def validate_cache_invalidation_config(self, config: dict):
+        codebase_pipelines = config.get("codebase_pipelines")
+        if not codebase_pipelines:
+            return
+
+        errors = []
+
+        all_environments = [env for env in config.get("environments", {}).keys() if not env == "*"]
+
+        for codebase in codebase_pipelines.values():
+            cache_invalidation_config = codebase.get("cache_invalidation")
+            if cache_invalidation_config:
+                for domain, config in cache_invalidation_config.get("domains").items():
+                    environment = config.get("environment")
+                    if environment not in all_environments:
+                        errors.append(
+                            f"Error in cache invalidation configuration for the domain '{domain}'.  Environment '{environment}' is not defined for this application"
+                        )
+
+        if errors:
+            raise ConfigValidatorError("\n".join(errors))

{dbt_platform_helper-15.6.0 → dbt_platform_helper-15.7.0}/dbt_platform_helper/providers/environment_variable.py

@@ -7,12 +7,12 @@ from dbt_platform_helper.platform_exception import PlatformException
 class EnvironmentVariableProvider:
 
     @staticmethod
-    def get(env_var: str) -> Optional[str]:
+    def get(env_var: str, default=None) -> Optional[str]:
         """Returns the stripped value or None if not set or empty."""
         value = os.environ.get(env_var)
         if value and value.strip():
             return value.strip()
-        return None
+        return default
 
     @staticmethod
     def get_required(env_var: str) -> str:

{dbt_platform_helper-15.6.0 → dbt_platform_helper-15.7.0}/dbt_platform_helper/providers/terraform_manifest.py

@@ -17,6 +17,68 @@ class TerraformManifestProvider:
         self.file_provider = file_provider
         self.io = io
 
+    def generate_service_config(
+        self,
+        config_object,
+        environment,
+        image_tag,
+        platform_helper_version: str,
+        platform_config,
+        module_source_override: str = None,
+    ):
+
+        service_dir = f"terraform/services/{environment}/{config_object.name}"
+        platform_config = ConfigProvider.apply_environment_defaults(platform_config)
+        account = self._get_account_for_env(environment, platform_config)
+        state_key_suffix = f"{config_object.name}-{environment}"
+
+        terraform = {}
+        self._add_header(terraform)
+
+        self._add_service_locals(terraform, environment, image_tag)
+
+        self._add_provider(terraform, account)
+        self._add_backend(
+            terraform, platform_config, account, f"tfstate/services/{state_key_suffix}.tfstate"
+        )
+
+        self._add_service_module(terraform, platform_helper_version, module_source_override)
+
+        self._write_terraform_json(terraform, service_dir)
+
+    def _add_service_locals(self, terraform, environment, image_tag):
+        terraform["locals"] = {
+            "environment": environment,
+            "image_tag": image_tag,
+            "platform_config": '${yamldecode(file("../../../../platform-config.yml"))}',
+            "application": '${local.platform_config["application"]}',
+            "environments": '${local.platform_config["environments"]}',
+            "env_config": '${{for name, config in local.environments: name => merge(lookup(local.environments, "*", {}), config)}}',
+            "service_config": '${yamldecode(templatefile("./service-config.yml", {COPILOT_ENVIRONMENT_NAME = local.environment, IMAGE_TAG = local.image_tag}))}',
+            "raw_env_config": '${local.platform_config["environments"]}',
+            "combined_env_config": '${{for name, config in local.raw_env_config: name => merge(lookup(local.raw_env_config, "*", {}), config)}}',
+            "service_deployment_mode": '${lookup(local.combined_env_config[local.environment], "service-deployment-mode", "copilot")}',
+            "non_copilot_service_deployment_mode": '${local.service_deployment_mode == "dual-deploy-copilot-traffic" || local.service_deployment_mode == "dual-deploy-platform-traffic" || local.service_deployment_mode == "platform" ? 1 : 0}',
+        }
+
+    def _add_service_module(
+        self, terraform: dict, platform_helper_version: str, module_source_override: str = None
+    ):
+        source = (
+            module_source_override
+            or f"git::git@github.com:uktrade/platform-tools.git//terraform/ecs-service?depth=1&ref={platform_helper_version}"
+        )
+        terraform["module"] = {
+            "ecs-service": {
+                "source": source,
+                "count": "${local.non_copilot_service_deployment_mode}",
+                "application": "${local.application}",
+                "environment": "${local.environment}",
+                "service_config": "${local.service_config}",
+                "env_config": "${local.env_config}",
+            }
+        }
+
     def generate_codebase_pipeline_config(
         self,
         platform_config: dict,
@@ -32,7 +94,12 @@ class TerraformManifestProvider:
         self._add_header(terraform)
         self._add_codebase_pipeline_locals(terraform)
         self._add_provider(terraform, default_account)
-        self._add_backend(terraform, platform_config, default_account, state_key_suffix)
+        self._add_backend(
+            terraform,
+            platform_config,
+            default_account,
+            f"tfstate/application/{state_key_suffix}.tfstate",
+        )
         self._add_codebase_pipeline_module(
             terraform, platform_helper_version, deploy_repository, module_source
         )
@@ -56,7 +123,9 @@ class TerraformManifestProvider:
         terraform = {}
         self._add_header(terraform)
         self._add_environment_locals(terraform, application_name)
-        self._add_backend(terraform, platform_config, account, state_key_suffix)
+        self._add_backend(
+            terraform, platform_config, account, f"tfstate/application/{state_key_suffix}.tfstate"
+        )
         self._add_extensions_module(terraform, platform_helper_version, env, module_source_override)
         self._add_moved(terraform, platform_config)
         self._ensure_no_hcl_manifest_file(env_dir)
@@ -99,13 +168,13 @@ class TerraformManifestProvider:
         terraform["provider"]["aws"]["shared_credentials_files"] = ["~/.aws/config"]
 
     @staticmethod
-    def _add_backend(terraform: dict, platform_config: dict, account: str, state_key_suffix: str):
+    def _add_backend(terraform: dict, platform_config: dict, account: str, state_key: str):
         terraform["terraform"] = {
             "required_version": SUPPORTED_TERRAFORM_VERSION,
             "backend": {
                 "s3": {
                     "bucket": f"terraform-platform-state-{account}",
-                    "key": f"tfstate/application/{state_key_suffix}.tfstate",
+                    "key": state_key,
                     "region": "eu-west-2",
                     "encrypt": True,
                     "kms_key_id": f"alias/terraform-platform-state-s3-key-{account}",
@@ -135,6 +204,7 @@ class TerraformManifestProvider:
                 "deploy_repository": f"{deploy_repository}",
                 "deploy_repository_branch": '${lookup(each.value, "deploy_repository_branch", "main")}',
                 "additional_ecr_repository": '${lookup(each.value, "additional_ecr_repository", null)}',
+                "cache_invalidation": '${lookup(each.value, "cache_invalidation", null)}',
                 "pipelines": '${lookup(each.value, "pipelines", [])}',
                 "services": "${each.value.services}",
                 "requires_image_build": '${lookup(each.value, "requires_image_build", true)}',

{dbt_platform_helper-15.6.0 → dbt_platform_helper-15.7.0}/dbt_platform_helper/templates/svc/overrides/cfn.patches.yml

@@ -24,3 +24,8 @@
     Condition:
       StringEquals:
           'ssm:ResourceTag/copilot-application': '__all__'
+
+- op: add
+  path: /Resources/TaskDefinition/Properties/pidMode
+  value:
+    task

dbt_platform_helper-15.7.0/dbt_platform_helper/utils/deep_merge.py

@@ -0,0 +1,10 @@
+def deep_merge(base, override):
+    result = base.copy()
+
+    for k, v in override.items():
+        if k in result and isinstance(result[k], dict) and isinstance(v, dict):
+            result[k] = deep_merge(result[k], v)
+        else:
+            result[k] = v
+
+    return result

{dbt_platform_helper-15.6.0 → dbt_platform_helper-15.7.0}/platform_helper.py

@@ -15,6 +15,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.service import service as service_commands
 from dbt_platform_helper.commands.version import version as version_commands
 from dbt_platform_helper.utils.click import ClickDocOptGroup
 
@@ -37,6 +38,7 @@ platform_helper.add_command(environment_commands)
 platform_helper.add_command(generate_commands)
 platform_helper.add_command(pipeline_commands)
 platform_helper.add_command(secrets_commands)
+platform_helper.add_command(service_commands)
 platform_helper.add_command(notify_commands)
 platform_helper.add_command(database_commands)
 platform_helper.add_command(version_commands)

{dbt_platform_helper-15.6.0 → dbt_platform_helper-15.7.0}/pyproject.toml

@@ -3,7 +3,7 @@ line-length = 100
 
 [tool.poetry]
 name = "dbt-platform-helper"
-version = "15.6.0"
+version = "15.7.0"
 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"
@@ -21,15 +21,14 @@ platform-helper = "platform_helper:platform_helper"
 
 [tool.poetry.dependencies]
 Jinja2 = "3.1.6"
-PyYAML = "6.0.1"
+PyYAML = "6.0.2"
 yamllint = "^1.35.1"
 boto3 = "^1.35.2"
 boto3-stubs = "^1.26.148"
 botocore = "^1.34.85"
 click = "^8.1.3"
-cloudfoundry-client = "1.35.2"
 mypy-boto3-codebuild = "^1.26.0.post1"
-python = ">3.9.0,<3.9.1 || >3.9.1,<4.0"
+python = ">3.9.1,<4.0"
 schema = "0.7.5"
 cfn-flip = "1.3.0"
 aiohttp = "^3.11.16"
@@ -39,7 +38,7 @@ jinja2-simple-tags = "^0.5.0"
 requests = "^2.31.0"
 prettytable = "^3.9.0"
 semver = "^3.0.2"
-tomlkit = "^0.12.2"
+tomlkit = ">=0.12.2,<0.14.0"
 slack-sdk = "^3.27.1"
 jsonschema = "~=4.17.0"
 cfn-lint = "^1.4.2"
@@ -50,7 +49,7 @@ checkov = "^3.2.405"
 moto = {extras = ["all"], version = "^5.0.28"}
 pyfakefs = "^5.2.2"
 pytest = "^8.3.5"
-pytest-env = "^0.8.1"
+pytest-env = ">=0.8.1,<1.2.0"
 tox = "^4.6.0"
 pre-commit = "^3.3.3"
 freezegun = "^1.2.2"