dbt-platform-helper 12.4.1__tar.gz → 12.5.1__tar.gz

{dbt_platform_helper-12.4.1 → dbt_platform_helper-12.5.1}/PKG-INFO

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

@@ -460,13 +460,11 @@ platform-helper environment online --app <application> --env <environment>
 ## Usage
 
 ```
-platform-helper environment generate --name <name> [--vpc-name <vpc_name>] 
+platform-helper environment generate --name <name> 
 ```
 
 ## Options
 
-- `--vpc-name <text>`
-
 - `--name
 -n <text>`
 
@@ -551,9 +549,6 @@ platform-helper pipeline generate
     This command does the following in relation to the codebase pipelines:
     - Generates the copilot pipeline manifest.yml for copilot/pipelines/<codebase_pipeline_name>
 
-    (Deprecated) This command does the following for non terraform projects (legacy AWS Copilot):
-    - Generates the copilot manifest.yml for copilot/environments/<environment>
-
 ## Usage
 
 ```

{dbt_platform_helper-12.4.1 → dbt_platform_helper-12.5.1}/dbt_platform_helper/commands/config.py

@@ -8,11 +8,11 @@ import botocore
 import click
 from prettytable import PrettyTable
 
+from dbt_platform_helper.providers.config import ConfigProvider
 from dbt_platform_helper.providers.validation import IncompatibleMajorVersionException
 from dbt_platform_helper.providers.validation import ValidationException
 from dbt_platform_helper.utils import versioning
 from dbt_platform_helper.utils.click import ClickDocOptGroup
-from dbt_platform_helper.utils.validation import config_file_check
 from dbt_platform_helper.utils.versioning import get_platform_helper_versions
 
 yes = "\033[92m✔\033[0m"
@@ -98,7 +98,7 @@ def deployment():
 
     recommendations = {}
 
-    config_file_check()
+    ConfigProvider.config_file_check()
 
     for template_file in addons_templates:
         generated_with_version = maybe

{dbt_platform_helper-12.4.1 → dbt_platform_helper-12.5.1}/dbt_platform_helper/commands/copilot.py

@@ -7,17 +7,22 @@ from pathlib import PosixPath
 
 import click
 import yaml
+from schema import SchemaError
 
 from dbt_platform_helper.constants import PLATFORM_CONFIG_FILE
+from dbt_platform_helper.domain.config_validator import ConfigValidator
+from dbt_platform_helper.domain.copilot_environment import CopilotTemplating
+from dbt_platform_helper.providers.config import ConfigProvider
+from dbt_platform_helper.providers.files import FileProvider
 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 generate_override_files
-from dbt_platform_helper.utils.files import mkfile
+from dbt_platform_helper.utils.messages import abort_with_error
+from dbt_platform_helper.utils.template import ADDON_TEMPLATE_MAP
 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
 from dbt_platform_helper.utils.validation import validate_addons
 from dbt_platform_helper.utils.versioning import (
     check_platform_helper_version_needs_update,
@@ -35,14 +40,6 @@ SERVICE_TYPES = [
     "Worker Service",
 ]
 
-ADDON_TEMPLATE_MAP = {
-    "s3": ["addons/svc/s3-policy.yml"],
-    "s3-policy": ["addons/svc/s3-policy.yml"],
-    "appconfig-ipfilter": ["addons/svc/appconfig-ipfilter.yml"],
-    "subscription-filter": ["addons/svc/subscription-filter.yml"],
-    "prometheus-policy": ["addons/svc/prometheus-policy.yml"],
-}
-
 
 def list_copilot_local_environments():
     return [
@@ -244,25 +241,42 @@ def _get_s3_kms_alias_arns(session, application_name, config):
     return arns
 
 
+def copilot_provider():
+    return CopilotTemplating()
+
+
 @copilot.command()
 def make_addons():
     """Generate addons CloudFormation for each environment."""
-    output_dir = Path(".").absolute()
-    config_file_check()
+    try:
+        config_provider = ConfigProvider(ConfigValidator())
+        _make_addons(config_provider)
+    except Exception as exc:
+        abort_with_error(exc)
+
+
+def _make_addons(config_provider: ConfigProvider):
+    config_provider.config_file_check()
+    try:
+        config = config_provider.load_and_validate_platform_config()
+    except SchemaError as ex:
+        click.secho(f"Invalid `{PLATFORM_CONFIG_FILE}` file: {str(ex)}", fg="red")
+        raise click.Abort
 
     templates = setup_templates()
-    config = _get_config()
+    extensions = _get_extensions()
     session = get_aws_session_or_abort()
 
     application_name = get_application_name()
 
     click.echo("\n>>> Generating Terraform compatible addons CloudFormation\n")
 
+    output_dir = Path(".").absolute()
     env_path = Path(f"copilot/environments/")
     env_addons_path = env_path / "addons"
     env_overrides_path = env_path / "overrides"
 
-    _cleanup_old_files(config, output_dir, env_addons_path, env_overrides_path)
+    _cleanup_old_files(extensions, output_dir, env_addons_path, env_overrides_path)
     _generate_env_overrides(output_dir)
 
     svc_names = list_copilot_local_services()
@@ -271,33 +285,33 @@ def make_addons():
         _generate_svc_overrides(base_path, templates, svc_name)
 
     services = []
-    for addon_name, addon_config in config.items():
-        print(f">>>>>>>>> {addon_name}")
-        addon_type = addon_config.pop("type")
-        environments = addon_config.pop("environments")
+    for ext_name, ext_data in extensions.items():
+        extension = {**ext_data}
+        addon_type = extension.pop("type")
+        environments = extension.pop("environments")
         environment_addon_config = {
             "addon_type": addon_type,
             "environments": environments,
-            "name": addon_config.get("name", None) or addon_name,
-            "prefix": camel_case(addon_name),
-            "secret_name": addon_name.upper().replace("-", "_"),
-            **addon_config,
+            "name": extension.get("name", None) or ext_name,
+            "prefix": camel_case(ext_name),
+            "secret_name": ext_name.upper().replace("-", "_"),
+            **extension,
         }
 
         services.append(environment_addon_config)
 
         service_addon_config = {
             "application_name": application_name,
-            "name": addon_config.get("name", None) or addon_name,
-            "prefix": camel_case(addon_name),
+            "name": extension.get("name", None) or ext_name,
+            "prefix": camel_case(ext_name),
             "environments": environments,
-            **addon_config,
+            **extension,
         }
 
         log_destination_arns = get_log_destination_arn()
 
         if addon_type in ["s3", "s3-policy"]:
-            if config[addon_name].get("serve_static_content"):
+            if extensions[ext_name].get("serve_static_content"):
                 continue
 
             s3_kms_arns = _get_s3_kms_alias_arns(session, application_name, environments)
@@ -307,8 +321,8 @@ def make_addons():
                 )
 
         _generate_service_addons(
-            addon_config,
-            addon_name,
+            extension,
+            ext_name,
             addon_type,
             output_dir,
             service_addon_config,
@@ -316,10 +330,15 @@ def make_addons():
             log_destination_arns,
         )
 
+    environments = config_provider.apply_environment_defaults(config)["environments"]
+
+    provider = copilot_provider()
+    provider.generate_cross_account_s3_policies(environments, extensions)
+
     click.echo(templates.get_template("addon-instructions.txt").render(services=services))
 
 
-def _get_config():
+def _get_extensions():
     config = _validate_and_normalise_extensions_config(PACKAGE_DIR / "default-extensions.yml")
     project_config = _validate_and_normalise_extensions_config(PLATFORM_CONFIG_FILE, "extensions")
     config.update(project_config)
@@ -360,7 +379,9 @@ def _generate_service_addons(
 
             (output_dir / service_path).mkdir(parents=True, exist_ok=True)
             click.echo(
-                mkfile(output_dir, service_path / f"{addon_name}.yml", contents, overwrite=True)
+                FileProvider.mkfile(
+                    output_dir, service_path / f"{addon_name}.yml", contents, overwrite=True
+                )
             )
 
 

dbt_platform_helper-12.5.1/dbt_platform_helper/commands/environment.py

@@ -0,0 +1,88 @@
+import click
+from schema import SchemaError
+
+from dbt_platform_helper.constants import DEFAULT_TERRAFORM_PLATFORM_MODULES_VERSION
+from dbt_platform_helper.constants import PLATFORM_CONFIG_FILE
+from dbt_platform_helper.domain.config_validator import ConfigValidator
+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.platform_exception import PlatformException
+from dbt_platform_helper.providers.config import ConfigProvider
+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"]
+
+
+@click.group(cls=ClickDocOptGroup)
+def environment():
+    """Commands affecting environments."""
+    check_platform_helper_version_needs_update()
+
+
+@environment.command()
+@click.option("--app", type=str, required=True)
+@click.option("--env", type=str, required=True)
+@click.option("--svc", type=str, required=True, multiple=True, default=["web"])
+@click.option(
+    "--template",
+    type=click.Choice(AVAILABLE_TEMPLATES),
+    default="default",
+    help="The maintenance page you wish to put up.",
+)
+@click.option("--vpc", type=str)
+def offline(app, env, svc, template, vpc):
+    """Take load-balanced web services offline with a maintenance page."""
+    try:
+        MaintenancePage().activate(app, env, svc, template, vpc)
+    except PlatformException as err:
+        click.secho(str(err), fg="red")
+        raise click.Abort
+
+
+@environment.command()
+@click.option("--app", type=str, required=True)
+@click.option("--env", type=str, required=True)
+def online(app, env):
+    """Remove a maintenance page from an environment."""
+    try:
+        MaintenancePage().deactivate(app, env)
+    except PlatformException as err:
+        click.secho(str(err), fg="red")
+        raise click.Abort
+
+
+@environment.command()
+@click.option("--name", "-n", required=True)
+def generate(name):
+    try:
+        config_provider = ConfigProvider(ConfigValidator())
+        CopilotEnvironment(config_provider).generate(name)
+    # TODO this exception will never be caught as the config provider catches schema errors and aborts
+    except SchemaError as ex:
+        click.secho(f"Invalid `{PLATFORM_CONFIG_FILE}` file: {str(ex)}", fg="red")
+        raise click.Abort
+    except PlatformException as err:
+        click.secho(str(err), fg="red")
+        raise click.Abort
+
+
+@environment.command(help="Generate terraform manifest for the specified environment.")
+@click.option(
+    "--name", "-n", required=True, help="The name of the environment to generate a manifest for."
+)
+@click.option(
+    "--terraform-platform-modules-version",
+    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):
+
+    try:
+        config_provider = ConfigProvider(ConfigValidator())
+        TerraformEnvironment(config_provider).generate(name, terraform_platform_modules_version)
+    except PlatformException as err:
+        click.secho(str(err), fg="red")
+        raise click.Abort

dbt_platform_helper-12.5.1/dbt_platform_helper/commands/pipeline.py

@@ -0,0 +1,60 @@
+#!/usr/bin/env python
+
+import click
+
+from dbt_platform_helper.constants import DEFAULT_TERRAFORM_PLATFORM_MODULES_VERSION
+from dbt_platform_helper.domain.config_validator import ConfigValidator
+from dbt_platform_helper.domain.pipelines import Pipelines
+from dbt_platform_helper.providers.config import ConfigProvider
+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.messages import abort_with_error
+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()
+
+
+@pipeline.command()
+@click.option(
+    "--terraform-platform-modules-version",
+    help=f"""Override the default version of terraform-platform-modules with a specific version or branch. 
+    Precedence of version used is version supplied via CLI, then the version found in 
+    platform-config.yml/default_versions/terraform-platform-modules. 
+    In absence of these inputs, defaults to version '{DEFAULT_TERRAFORM_PLATFORM_MODULES_VERSION}'.""",
+)
+@click.option(
+    "--deploy-branch",
+    help="""Specify the branch of <application>-deploy used to configure the source stage in the environment-pipeline resource. 
+    This is generated from the terraform/environments-pipeline/<aws_account>/main.tf file. 
+    (Default <application>-deploy branch is specified in 
+    <application>-deploy/platform-config.yml/environment_pipelines/<environment-pipeline>/branch).""",
+    default=None,
+)
+def generate(terraform_platform_modules_version, deploy_branch):
+    """
+    Given a platform-config.yml file, generate environment and service
+    deployment pipelines.
+
+    This command does the following in relation to the environment pipelines:
+    - Reads contents of `platform-config.yml/environment-pipelines` configuration.
+      The `terraform/environment-pipelines/<aws_account>/main.tf` file is generated using this configuration.
+      The `main.tf` file is then used to generate Terraform for creating an environment pipeline resource.
+
+    This command does the following in relation to the codebase pipelines:
+    - Generates the copilot pipeline manifest.yml for copilot/pipelines/<codebase_pipeline_name>
+    """
+    pipelines = Pipelines(
+        ConfigProvider(ConfigValidator()),
+        click.secho,
+        abort_with_error,
+        git_remote,
+        get_codestar_connection_arn,
+    )
+    pipelines.generate(terraform_platform_modules_version, deploy_branch)

dbt_platform_helper-12.5.1/dbt_platform_helper/constants.py

@@ -0,0 +1,28 @@
+# Todo: Move to Config provider
+PLATFORM_CONFIG_FILE = "platform-config.yml"
+# Todo: Can we get rid of this yet?
+PLATFORM_HELPER_VERSION_FILE = ".platform-helper-version"
+# Todo: Move to ???
+DEFAULT_TERRAFORM_PLATFORM_MODULES_VERSION = "5"
+
+# Keys
+CODEBASE_PIPELINES_KEY = "codebase_pipelines"
+ENVIRONMENTS_KEY = "environments"
+ENVIRONMENT_PIPELINES_KEY = "environment_pipelines"
+
+# Conduit
+CONDUIT_ADDON_TYPES = [
+    "opensearch",
+    "postgres",
+    "redis",
+]
+CONDUIT_DOCKER_IMAGE_LOCATION = "public.ecr.aws/uktrade/tunnel"
+HYPHENATED_APPLICATION_NAME = "hyphenated-application-name"
+ALPHANUMERIC_ENVIRONMENT_NAME = "alphanumericenvironmentname123"
+ALPHANUMERIC_SERVICE_NAME = "alphanumericservicename123"
+COPILOT_IDENTIFIER = "c0PIlotiD3ntIF3r"
+CLUSTER_NAME_SUFFIX = f"Cluster-{COPILOT_IDENTIFIER}"
+SERVICE_NAME_SUFFIX = f"Service-{COPILOT_IDENTIFIER}"
+REFRESH_TOKEN_MESSAGE = (
+    "To refresh this SSO session run `aws sso login` with the corresponding profile"
+)

{dbt_platform_helper-12.4.1 → dbt_platform_helper-12.5.1}/dbt_platform_helper/domain/codebase.py

@@ -10,6 +10,7 @@ import yaml
 from boto3 import Session
 
 from dbt_platform_helper.platform_exception import PlatformException
+from dbt_platform_helper.providers.files import FileProvider
 from dbt_platform_helper.utils.application import Application
 from dbt_platform_helper.utils.application import ApplicationException
 from dbt_platform_helper.utils.application import load_application
@@ -19,7 +20,6 @@ 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 list_latest_images
 from dbt_platform_helper.utils.aws import start_build_extraction
-from dbt_platform_helper.utils.files import mkfile
 from dbt_platform_helper.utils.git import check_if_commit_exists
 from dbt_platform_helper.utils.template import setup_templates
 
@@ -92,7 +92,7 @@ class Codebase:
             repository=repository, builder_version=builder_version
         )
         self.echo(
-            mkfile(
+            FileProvider.mkfile(
                 Path("."), ".copilot/image_build_run.sh", image_build_run_contents, overwrite=True
             )
         )
@@ -100,13 +100,17 @@ class Codebase:
         image_build_run_file = Path(".copilot/image_build_run.sh")
         image_build_run_file.chmod(image_build_run_file.stat().st_mode | stat.S_IEXEC)
 
-        self.echo(mkfile(Path("."), ".copilot/config.yml", config_contents, overwrite=True))
+        self.echo(
+            FileProvider.mkfile(Path("."), ".copilot/config.yml", config_contents, overwrite=True)
+        )
 
         for phase in ["build", "install", "post_build", "pre_build"]:
             phase_contents = templates.get_template(f".copilot/phases/{phase}.sh").render()
 
             self.echo(
-                mkfile(Path("./.copilot"), f"phases/{phase}.sh", phase_contents, overwrite=True)
+                FileProvider.mkfile(
+                    Path("./.copilot"), f"phases/{phase}.sh", phase_contents, overwrite=True
+                )
             )
 
     def build(self, app: str, codebase: str, commit: str):