dbt-platform-helper 12.2.4__py3-none-any.whl → 12.4.0__py3-none-any.whl

dbt_platform_helper/COMMANDS.md

@@ -765,6 +765,7 @@ platform-helper database (dump|load|copy)
 ```
 platform-helper database dump --from <from_env> --database <database> 
                               [--app <application>] [--from-vpc <from_vpc>] 
+                              [--filename <filename>] 
 ```
 
 ## Options
@@ -777,6 +778,8 @@ platform-helper database dump --from <from_env> --database <database>
   - The name of the database you are dumping data from
 - `--from-vpc <text>`
   - The vpc the specified environment is running in. Required unless you are running the command from your deploy repo
+- `--filename <text>`
+  - Specify a name for the database dump file. Recommended if the same dump database is being used for multiple load environments
 - `--help <boolean>` _Defaults to False._
   - Show this message and exit.
 
@@ -791,7 +794,7 @@ platform-helper database dump --from <from_env> --database <database>
 ```
 platform-helper database load --to <to_env> --database <database> 
                               [--app <application>] [--to-vpc <to_vpc>] 
-                              [--auto-approve] 
+                              [--filename <filename>] [--auto-approve] 
 ```
 
 ## Options
@@ -806,6 +809,8 @@ platform-helper database load --to <to_env> --database <database>
   - The vpc the specified environment is running in. Required unless you are running the command from your deploy repo
 - `--auto-approve <boolean>` _Defaults to False._
 
+- `--filename <text>`
+  - Specify a name for the database dump file. Recommended if the same dump database is being used for multiple load environments
 - `--help <boolean>` _Defaults to False._
   - Show this message and exit.
 

dbt_platform_helper/commands/codebase.py

@@ -1,18 +1,8 @@
-import json
-import os
-
 import click
 
 from dbt_platform_helper.domain.codebase import Codebase
-from dbt_platform_helper.exceptions import ApplicationDeploymentNotTriggered
-from dbt_platform_helper.exceptions import ApplicationEnvironmentNotFoundError
-from dbt_platform_helper.exceptions import ApplicationNotFoundError
-from dbt_platform_helper.exceptions import CopilotCodebaseNotFoundError
-from dbt_platform_helper.exceptions import ImageNotFoundError
-from dbt_platform_helper.exceptions import NoCopilotCodebasesFoundError
-from dbt_platform_helper.exceptions import NotInCodeBaseRepositoryError
+from dbt_platform_helper.platform_exception import PlatformException
 from dbt_platform_helper.utils.click import ClickDocOptGroup
-from dbt_platform_helper.utils.git import CommitNotFoundError
 from dbt_platform_helper.utils.versioning import (
     check_platform_helper_version_needs_update,
 )
@@ -29,12 +19,8 @@ def prepare():
     """Sets up an application codebase for use within a DBT platform project."""
     try:
         Codebase().prepare()
-    except NotInCodeBaseRepositoryError:
-        # TODO: Set exception message in the exceptions and just output the message in the command code
-        click.secho(
-            "You are in the deploy repository; make sure you are in the application codebase repository.",
-            fg="red",
-        )
+    except PlatformException as err:
+        click.secho(str(err), fg="red")
         raise click.Abort
 
 
@@ -50,17 +36,8 @@ def list(app, with_images):
     """List available codebases for the application."""
     try:
         Codebase().list(app, with_images)
-    except NoCopilotCodebasesFoundError:
-        click.secho(
-            f"""No codebases found for application "{app}""",
-            fg="red",
-        )
-        raise click.Abort
-    except ApplicationNotFoundError:
-        click.secho(
-            f"""The account "{os.environ.get("AWS_PROFILE")}" does not contain the application "{app}"; ensure you have set the environment variable "AWS_PROFILE" correctly.""",
-            fg="red",
-        )
+    except PlatformException as err:
+        click.secho(str(err), fg="red")
         raise click.Abort
 
 
@@ -76,23 +53,8 @@ def build(app, codebase, commit):
     """Trigger a CodePipeline pipeline based build."""
     try:
         Codebase().build(app, codebase, commit)
-    except ApplicationNotFoundError:
-        click.secho(
-            f"""The account "{os.environ.get("AWS_PROFILE")}" does not contain the application "{app}"; ensure you have set the environment variable "AWS_PROFILE" correctly.""",
-            fg="red",
-        )
-        raise click.Abort
-    except CommitNotFoundError:
-        click.secho(
-            f'The commit hash "{commit}" either does not exist or you need to run `git fetch`.',
-            fg="red",
-        )
-        raise click.Abort
-    except ApplicationDeploymentNotTriggered:
-        click.secho(
-            f"Your build for {codebase} was not triggered.",
-            fg="red",
-        )
+    except PlatformException as err:
+        click.secho(str(err), fg="red")
         raise click.Abort
 
 
@@ -108,39 +70,6 @@ def build(app, codebase, commit):
 def deploy(app, env, codebase, commit):
     try:
         Codebase().deploy(app, env, codebase, commit)
-    except ApplicationNotFoundError:
-        # TODO: Set exception message in the exceptions and just output the message in the command code
-        click.secho(
-            f"""The account "{os.environ.get("AWS_PROFILE")}" does not contain the application "{app}"; ensure you have set the environment variable "AWS_PROFILE" correctly.""",
-            fg="red",
-        )
-        raise click.Abort
-    except ApplicationEnvironmentNotFoundError:
-        click.secho(
-            f"""The environment "{env}" either does not exist or has not been deployed.""",
-            fg="red",
-        )
-        raise click.Abort
-    except (
-        CopilotCodebaseNotFoundError,
-        # TODO: Catch this error earlier and throw a more meaningful error, maybe it's CopilotCodebaseNotFoundError?
-        json.JSONDecodeError,
-    ):
-        click.secho(
-            f"""The codebase "{codebase}" either does not exist or has not been deployed.""",
-            fg="red",
-        )
-        raise click.Abort
-    except ImageNotFoundError:
-        click.secho(
-            f'The commit hash "{commit}" has not been built into an image, try the '
-            "`platform-helper codebase build` command first.",
-            fg="red",
-        )
-        raise click.Abort
-    except ApplicationDeploymentNotTriggered:
-        click.secho(
-            f"Your deployment for {codebase} was not triggered.",
-            fg="red",
-        )
+    except PlatformException as err:
+        click.secho(str(err), fg="red")
         raise click.Abort

dbt_platform_helper/commands/conduit.py

@@ -1,14 +1,10 @@
 import click
 
-from dbt_platform_helper.constants import CONDUIT_ADDON_TYPES
 from dbt_platform_helper.domain.conduit import Conduit
-from dbt_platform_helper.exceptions import AddonNotFoundError
-from dbt_platform_helper.exceptions import AddonTypeMissingFromConfigError
-from dbt_platform_helper.exceptions import CreateTaskTimeoutError
-from dbt_platform_helper.exceptions import InvalidAddonTypeError
-from dbt_platform_helper.exceptions import NoClusterError
-from dbt_platform_helper.exceptions import ParameterNotFoundError
-from dbt_platform_helper.providers.secrets import SecretNotFoundError
+from dbt_platform_helper.platform_exception import PlatformException
+from dbt_platform_helper.providers.cloudformation import CloudFormation
+from dbt_platform_helper.providers.ecs import ECS
+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 (
@@ -35,44 +31,28 @@ def conduit(addon_name: str, app: str, env: str, access: str):
     application = load_application(app)
 
     try:
-        Conduit(application).start(env, addon_name, access)
-    except NoClusterError:
-        # TODO: Set exception message in the exceptions and just output the message in the command code, should be able to catch all errors in one block
-        click.secho(f"""No ECS cluster found for "{app}" in "{env}" environment.""", fg="red")
-        exit(1)
-    except SecretNotFoundError as err:
-        click.secho(
-            f"""No secret called "{err}" for "{app}" in "{env}" environment.""",
-            fg="red",
+        secrets_provider: Secrets = Secrets(
+            application.environments[env].session.client("ssm"),
+            application.environments[env].session.client("secretsmanager"),
+            application.name,
+            env,
         )
-        exit(1)
-    except CreateTaskTimeoutError:
-        click.secho(
-            f"""Client ({addon_name}) ECS task has failed to start for "{app}" in "{env}" environment.""",
-            fg="red",
+        cloudformation_provider: CloudFormation = CloudFormation(
+            application.environments[env].session.client("cloudformation"),
+            application.environments[env].session.client("iam"),
+            application.environments[env].session.client("ssm"),
         )
-        exit(1)
-    except ParameterNotFoundError:
-        click.secho(
-            f"""No parameter called "/copilot/applications/{app}/environments/{env}/addons". Try deploying the "{app}" "{env}" environment.""",
-            fg="red",
-        )
-        exit(1)
-    except AddonNotFoundError:
-        click.secho(
-            f"""Addon "{addon_name}" does not exist.""",
-            fg="red",
-        )
-        exit(1)
-    except InvalidAddonTypeError as err:
-        click.secho(
-            f"""Addon type "{err.addon_type}" is not supported, we support: {", ".join(CONDUIT_ADDON_TYPES)}.""",
-            fg="red",
+
+        ecs_provider: ECS = ECS(
+            application.environments[env].session.client("ecs"),
+            application.environments[env].session.client("ssm"),
+            application.name,
+            env,
         )
-        exit(1)
-    except AddonTypeMissingFromConfigError:
-        click.secho(
-            f"""The configuration for the addon {addon_name}, is missconfigured and missing the addon type.""",
-            fg="red",
+
+        Conduit(application, secrets_provider, cloudformation_provider, ecs_provider).start(
+            env, addon_name, access
         )
-        exit(1)
+    except PlatformException as err:
+        click.secho(str(err), fg="red")
+        raise click.Abort

dbt_platform_helper/commands/config.py

@@ -8,8 +8,8 @@ import botocore
 import click
 from prettytable import PrettyTable
 
-from dbt_platform_helper.exceptions import IncompatibleMajorVersion
-from dbt_platform_helper.exceptions import ValidationException
+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
@@ -110,7 +110,7 @@ def deployment():
                 str(template_file.resolve())
             )
             versioning.validate_template_version(local_version, str(template_file.resolve()))
-        except IncompatibleMajorVersion:
+        except IncompatibleMajorVersionException:
             local_compatible_symbol = no
             compatible = False
             recommendations["dbt-platform-helper-upgrade"] = RECOMMENDATIONS[
@@ -134,7 +134,7 @@ def deployment():
                 str(template_file.resolve())
             )
             versioning.validate_template_version(latest_release, str(template_file.resolve()))
-        except IncompatibleMajorVersion:
+        except IncompatibleMajorVersionException:
             latest_compatible_symbol = no
             compatible = False
         except ValidationException:

dbt_platform_helper/commands/copilot.py

@@ -35,6 +35,14 @@ 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 [
@@ -248,9 +256,6 @@ def make_addons():
 
     application_name = get_application_name()
 
-    with open(PACKAGE_DIR / "addons-template-map.yml") as fd:
-        addon_template_map = yaml.safe_load(fd)
-
     click.echo("\n>>> Generating Terraform compatible addons CloudFormation\n")
 
     env_path = Path(f"copilot/environments/")
@@ -270,11 +275,6 @@ def make_addons():
         print(f">>>>>>>>> {addon_name}")
         addon_type = addon_config.pop("type")
         environments = addon_config.pop("environments")
-        if addon_template_map[addon_type].get("requires_addons_parameters", False):
-            pass
-        if addon_type in ["postgres"]:
-            pass
-
         environment_addon_config = {
             "addon_type": addon_type,
             "environments": environments,
@@ -309,7 +309,6 @@ def make_addons():
         _generate_service_addons(
             addon_config,
             addon_name,
-            addon_template_map,
             addon_type,
             output_dir,
             service_addon_config,
@@ -339,7 +338,6 @@ def _generate_env_overrides(output_dir):
 def _generate_service_addons(
     addon_config,
     addon_name,
-    addon_template_map,
     addon_type,
     output_dir,
     service_addon_config,
@@ -347,8 +345,8 @@ def _generate_service_addons(
     log_destination_arns,
 ):
     # generate svc addons
-    for addon in addon_template_map[addon_type].get("svc", []):
-        template = templates.get_template(addon["template"])
+    for addon_template in ADDON_TEMPLATE_MAP.get(addon_type, []):
+        template = templates.get_template(addon_template)
 
         for svc in addon_config.get("services", []):
             service_path = Path(f"copilot/{svc}/addons/")
@@ -360,10 +358,10 @@ def _generate_service_addons(
                 }
             )
 
-            filename = addon.get("filename", f"{addon_name}.yml")
-
             (output_dir / service_path).mkdir(parents=True, exist_ok=True)
-            click.echo(mkfile(output_dir, service_path / filename, contents, overwrite=True))
+            click.echo(
+                mkfile(output_dir, service_path / f"{addon_name}.yml", contents, overwrite=True)
+            )
 
 
 def _cleanup_old_files(config, output_dir, env_addons_path, env_overrides_path):

dbt_platform_helper/commands/database.py

@@ -31,10 +31,16 @@ def database():
     type=str,
     help="The vpc the specified environment is running in. Required unless you are running the command from your deploy repo",
 )
-def dump(app, from_env, database, from_vpc):
+@click.option(
+    "--filename",
+    type=str,
+    help="Specify a name for the database dump file. Recommended if the same dump database is being used for multiple load environments",
+)
+def dump(app, from_env, database, from_vpc, filename):
     """Dump a database into an S3 bucket."""
     data_copy = DatabaseCopy(app, database)
-    data_copy.dump(from_env, from_vpc)
+    data_copy.dump(from_env, from_vpc, filename)
+    # Todo: Catch expected errors and output message
 
 
 @database.command(name="load")
@@ -55,10 +61,16 @@ def dump(app, from_env, database, from_vpc):
     help="The vpc the specified environment is running in. Required unless you are running the command from your deploy repo",
 )
 @click.option("--auto-approve/--no-auto-approve", default=False)
-def load(app, to_env, database, to_vpc, auto_approve):
+@click.option(
+    "--filename",
+    type=str,
+    help="Specify a name for the database dump file. Recommended if the same dump database is being used for multiple load environments",
+)
+def load(app, to_env, database, to_vpc, auto_approve, filename):
     """Load a database from an S3 bucket."""
     data_copy = DatabaseCopy(app, database, auto_approve)
-    data_copy.load(to_env, to_vpc)
+    data_copy.load(to_env, to_vpc, filename)
+    # Todo: Catch expected errors and output message
 
 
 @database.command(name="copy")
@@ -110,3 +122,4 @@ def copy(
     """Copy a database between environments."""
     data_copy = DatabaseCopy(app, database, auto_approve)
     data_copy.copy(from_env, to_env, from_vpc, to_vpc, svc, template, no_maintenance_page)
+    # Todo: Catch expected errors and output message

dbt_platform_helper/commands/environment.py

@@ -5,6 +5,7 @@ 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.maintenance_page import MaintenancePageProvider
+from dbt_platform_helper.platform_exception import PlatformException
 from dbt_platform_helper.providers.load_balancers import find_https_listener
 from dbt_platform_helper.utils.aws import get_aws_session_or_abort
 from dbt_platform_helper.utils.click import ClickDocOptGroup
@@ -238,10 +239,10 @@ def find_https_certificate(session: boto3.Session, app: str, env: str) -> str:
     try:
         certificate_arn = next(c["CertificateArn"] for c in certificates if c["IsDefault"])
     except StopIteration:
-        raise CertificateNotFoundError()
+        raise CertificateNotFoundException()
 
     return certificate_arn
 
 
-class CertificateNotFoundError(Exception):
+class CertificateNotFoundException(PlatformException):
     pass

dbt_platform_helper/commands/secrets.py

@@ -102,7 +102,6 @@ def list(app, env):
     params = dict(Path=path, Recursive=False, WithDecryption=True, MaxResults=10)
     secrets = []
 
-    # TODO: refactor shared code with get_ssm_secret_names - Check if this is still valid
     while True:
         response = client.get_parameters_by_path(**params)
 
@@ -114,6 +113,7 @@ def list(app, env):
         else:
             break
 
+    # Todo: When we refactor this, the above could probably just use dbt_platform_helper.utils.aws.get_ssm_secret_names so we would end up with print("\n".join(get_ssm_secret_names(app, env)))
     print("\n".join(sorted(secrets)))