dbt-platform-helper 13.1.0__py3-none-any.whl → 15.16.0__py3-none-any.whl

dbt_platform_helper/COMMANDS.md

@@ -12,6 +12,7 @@
     - [platform-helper conduit](#platform-helper-conduit)
     - [platform-helper config](#platform-helper-config)
         - [platform-helper config validate](#platform-helper-config-validate)
+        - [platform-helper config migrate](#platform-helper-config-migrate)
         - [platform-helper config aws](#platform-helper-config-aws)
     - [platform-helper copilot](#platform-helper-copilot)
         - [platform-helper copilot make-addons](#platform-helper-copilot-make-addons)
@@ -24,10 +25,12 @@
     - [platform-helper pipeline](#platform-helper-pipeline)
         - [platform-helper pipeline generate](#platform-helper-pipeline-generate)
     - [platform-helper secrets](#platform-helper-secrets)
+        - [platform-helper secrets create](#platform-helper-secrets-create)
         - [platform-helper secrets copy](#platform-helper-secrets-copy)
         - [platform-helper secrets list](#platform-helper-secrets-list)
     - [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)
         - [platform-helper notify add-comment](#platform-helper-notify-add-comment)
     - [platform-helper database](#platform-helper-database)
         - [platform-helper database dump](#platform-helper-database-dump)
@@ -61,6 +64,7 @@ platform-helper <command> [--version]
 - [`database` ↪](#platform-helper-database)
 - [`environment` ↪](#platform-helper-environment)
 - [`generate` ↪](#platform-helper-generate)
+- [`internal` ↪](#platform-helper-internal)
 - [`notify` ↪](#platform-helper-notify)
 - [`pipeline` ↪](#platform-helper-pipeline)
 - [`secrets` ↪](#platform-helper-secrets)
@@ -236,7 +240,8 @@ platform-helper codebase build --app <application> --codebase <codebase>
 
 ```
 platform-helper codebase deploy --app <application> --env <environment> --codebase <codebase> 
-                                --commit <commit> 
+                                [--tag <tag>] [--branch <branch>] 
+                                [--commit <commit>] 
 ```
 
 ## Options
@@ -247,8 +252,12 @@ platform-helper codebase deploy --app <application> --env <environment> --codeba
   - AWS Copilot environment
 - `--codebase <text>`
   - The codebase name as specified in the platform-config.yml file. This can be run from any directory.
+- `--tag <text>`
+  - Git tag that has been built into an image. Typically a semantic version of the form 1.2.3 or v1.2.3.
+- `--branch <text>`
+  - Git branch that has been built into an image.
 - `--commit <text>`
-  - GitHub commit hash
+  - Git sha hash that has been built into an image.
 - `--help <boolean>` _Defaults to False._
   - Show this message and exit.
 
@@ -290,7 +299,7 @@ platform-helper conduit <addon_name>
 ## Usage
 
 ```
-platform-helper config (validate|aws) 
+platform-helper config (validate|migrate|aws) 
 ```
 
 ## Options
@@ -301,6 +310,7 @@ platform-helper config (validate|aws)
 ## Commands
 
 - [`aws` ↪](#platform-helper-config-aws)
+- [`migrate` ↪](#platform-helper-config-migrate)
 - [`validate` ↪](#platform-helper-config-validate)
 
 # platform-helper config validate
@@ -317,6 +327,23 @@ platform-helper config validate
 
 ## Options
 
+- `--help <boolean>` _Defaults to False._
+  - Show this message and exit.
+
+# platform-helper config migrate
+
+[↩ Parent](#platform-helper-config)
+
+    Update configuration to match current schema.
+
+## Usage
+
+```
+platform-helper config migrate 
+```
+
+## Options
+
 - `--help <boolean>` _Defaults to False._
   - Show this message and exit.
 
@@ -483,7 +510,7 @@ platform-helper environment generate --name <name>
 ## Usage
 
 ```
-platform-helper environment generate-terraform --name <name> [--terraform-platform-modules-version <terraform_platform_modules_version>] 
+platform-helper environment generate-terraform --name <name> 
 ```
 
 ## Options
@@ -491,8 +518,6 @@ platform-helper environment generate-terraform --name <name> [--terraform-platfo
 - `--name
 -n <text>`
   - The name of the environment to generate a manifest for.
-- `--terraform-platform-modules-version <text>`
-  - Override the default version of terraform-platform-modules. (Default version is '7').
 - `--help <boolean>` _Defaults to False._
   - Show this message and exit.
 
@@ -545,27 +570,23 @@ platform-helper pipeline generate
     deployment pipelines.
 
     This command does the following in relation to the environment pipelines:
-    - Reads contents of `platform-config.yml/environment-pipelines` configuration.
+    - 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>
+    - Reads contents of `platform-config.yml/codebase_pipelines` configuration.
+      The `terraform/codebase-pipelines/main.tf.json` file is generated using this configuration.
+      The `main.tf.json` file is then used to generate Terraform for creating a codebase pipeline resource.
 
 ## Usage
 
 ```
-platform-helper pipeline generate [--terraform-platform-modules-version <terraform_platform_modules_version>] 
-                                  [--deploy-branch <deploy_branch>] 
+platform-helper pipeline generate [--deploy-branch <deploy_branch>] 
 ```
 
 ## Options
 
-- `--terraform-platform-modules-version <text>`
-  - 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 '7'.
 - `--deploy-branch <text>`
   - 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. 
@@ -581,7 +602,7 @@ This is generated from the terraform/environments-pipeline/<aws_account>/main.tf
 ## Usage
 
 ```
-platform-helper secrets (copy|list) 
+platform-helper secrets (create|copy|list) 
 ```
 
 ## Options
@@ -592,30 +613,53 @@ platform-helper secrets (copy|list)
 ## Commands
 
 - [`copy` ↪](#platform-helper-secrets-copy)
+- [`create` ↪](#platform-helper-secrets-create)
 - [`list` ↪](#platform-helper-secrets-list)
 
-# platform-helper secrets copy
+# platform-helper secrets create
 
 [↩ Parent](#platform-helper-secrets)
 
-    Copy secrets from one environment to a new environment.
+    Create a Parameter Store secret for all environments of an
+    application.
 
 ## Usage
 
 ```
-platform-helper secrets copy <source_environment> <target_environment> 
-                             --project-profile <project_profile> 
+platform-helper secrets create --app <application> --name <name> [--overwrite] 
 ```
 
-## Arguments
+## Options
+
+- `--app <text>`
+  - Application name.
+- `--name <text>`
+  - Secret name (automatically uppercased).
+- `--overwrite <boolean>` _Defaults to False._
+  - Allows overwriting the value of secrets if they already exist.
+- `--help <boolean>` _Defaults to False._
+  - Show this message and exit.
 
-- `source_environment <text>`
-- `target_environment <text>`
+# platform-helper secrets copy
+
+[↩ Parent](#platform-helper-secrets)
+
+    Copy secrets from one environment to another.
+
+## Usage
+
+```
+platform-helper secrets copy --app <application> --source <source> --target <target> 
+```
 
 ## Options
 
-- `--project-profile <text>`
-  - AWS account profile name
+- `--app <text>`
+  - Application name.
+- `--source <text>`
+  - Source environment where to copy secrets from.
+- `--target <text>`
+  - Destination environment where to copy secrets to.
 - `--help <boolean>` _Defaults to False._
   - Show this message and exit.
 
@@ -623,7 +667,7 @@ platform-helper secrets copy <source_environment> <target_environment>
 
 [↩ Parent](#platform-helper-secrets)
 
-    List secret names and values for an environment.
+    [DELETED] List secret names and values for an environment.
 
 ## Usage
 
@@ -650,7 +694,7 @@ platform-helper secrets list <application> <environment>
 ## Usage
 
 ```
-platform-helper notify (environment-progress|add-comment) 
+platform-helper notify (environment-progress|post-message|add-comment) 
 ```
 
 ## Options
@@ -662,6 +706,7 @@ platform-helper notify (environment-progress|add-comment)
 
 - [`add-comment` ↪](#platform-helper-notify-add-comment)
 - [`environment-progress` ↪](#platform-helper-notify-environment-progress)
+- [`post-message` ↪](#platform-helper-notify-post-message)
 
 # platform-helper notify environment-progress
 
@@ -694,6 +739,41 @@ platform-helper notify environment-progress <slack_channel_id> <slack_token>
 
 - `--commit-sha <text>`
 
+- `--slack-ref <text>`
+  - Slack message reference of the message to update
+- `--help <boolean>` _Defaults to False._
+  - Show this message and exit.
+
+# platform-helper notify post-message
+
+[↩ Parent](#platform-helper-notify)
+
+    Send Slack notifications. This creates (or updates if --slack-ref is provided) the top level message to the channel.
+
+## Usage
+
+```
+platform-helper notify post-message <slack_channel_id> <slack_token> 
+                                    <message> 
+                                    [--build-arn <build_arn>] [--repository <repository>] 
+                                    [--commit-sha <commit_sha>] 
+                                    [--slack-ref <slack_ref>] 
+```
+
+## Arguments
+
+- `slack-channel-id <text>`
+- `slack-token <text>`
+- `message <text>`
+
+## Options
+
+- `--build-arn <text>`
+
+- `--repository <text>`
+
+- `--commit-sha <text>`
+
 - `--slack-ref <text>`
   - Slack message reference of the message to update
 - `--help <boolean>` _Defaults to False._

dbt_platform_helper/commands/application.py

@@ -10,11 +10,9 @@ from datetime import timedelta
 import click
 from prettytable import PrettyTable
 
+from dbt_platform_helper.domain.versioning import PlatformHelperVersioning
 from dbt_platform_helper.utils.application import load_application
 from dbt_platform_helper.utils.click import ClickDocOptGroup
-from dbt_platform_helper.utils.versioning import (
-    check_platform_helper_version_needs_update,
-)
 
 YELLOW = "\033[93m"
 CYAN = "\033[96m"
@@ -97,7 +95,7 @@ def get_query_results(env, app, query_string, timeout):
 @click.group(chain=True, cls=ClickDocOptGroup, deprecated=True)
 def application():
     """[DEPRECATED] Application metrics."""
-    check_platform_helper_version_needs_update()
+    PlatformHelperVersioning().check_if_needs_update()
 
 
 @application.command(deprecated=True)
@@ -141,7 +139,7 @@ def container_stats(env, app, storage, network):
         storage_write = field[6]["value"]
         network_read = field[7]["value"]
         network_write = field[8]["value"]
-        cpu = "%.1f%%" % float(field[9]["value"])
+        cpu = f"{float(field[9]['value']):.1f}%"
         memory = f"{field[10]['value']}M"
 
         # Nothing to compare to at start.
@@ -283,12 +281,13 @@ def task_stats(env, app, disk, storage, network):
         memory,
         dsk,
     ) in cpu_response["results"]:
+        cpu_value = f"{float(cpu['value']):.1f}" + "%"
         values = [
             f"{YELLOW}{taskdef['value'].split('-')[-1]}",
             f"{YELLOW}{task['value']}",
             f"{YELLOW}{task_def_revision['value']}",
             f"{YELLOW}{status['value']}",
-            f"{YELLOW}{'%.1f' % float(cpu['value']) + '%'}",
+            f"{YELLOW}{cpu_value}",
             f"{YELLOW}{memory['value'] + 'M'}",
         ]
 

dbt_platform_helper/commands/codebase.py

@@ -1,25 +1,25 @@
 import click
 
 from dbt_platform_helper.domain.codebase import Codebase
+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.providers.parameter_store import ParameterStore
+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.versioning import (
-    check_platform_helper_version_needs_update,
-)
 
 
 @click.group(chain=True, cls=ClickDocOptGroup)
 def codebase():
     """Codebase commands."""
-    check_platform_helper_version_needs_update()
+    PlatformHelperVersioning().check_if_needs_update()
 
 
 @codebase.command()
 def prepare():
     """Sets up an application codebase for use within a DBT platform project."""
     try:
-        Codebase().prepare()
+        Codebase(ParameterStore(get_aws_session_or_abort().client("ssm"))).prepare()
     except PlatformException as err:
         ClickIOProvider().abort_with_error(str(err))
 
@@ -35,7 +35,7 @@ def prepare():
 def list(app, with_images):
     """List available codebases for the application."""
     try:
-        Codebase().list(app, with_images)
+        Codebase(ParameterStore(get_aws_session_or_abort().client("ssm"))).list(app, with_images)
     except PlatformException as err:
         ClickIOProvider().abort_with_error(str(err))
 
@@ -51,7 +51,9 @@ def list(app, with_images):
 def build(app, codebase, commit):
     """Trigger a CodePipeline pipeline based build."""
     try:
-        Codebase().build(app, codebase, commit)
+        Codebase(ParameterStore(get_aws_session_or_abort().client("ssm"))).build(
+            app, codebase, commit
+        )
     except PlatformException as err:
         ClickIOProvider().abort_with_error(str(err))
 
@@ -64,9 +66,28 @@ def build(app, codebase, commit):
     help="The codebase name as specified in the platform-config.yml file. This can be run from any directory.",
     required=True,
 )
-@click.option("--commit", help="GitHub commit hash", required=True)
-def deploy(app, env, codebase, commit):
+@click.option(
+    "--tag",
+    help="Git tag that has been built into an image. Typically a semantic version of the form 1.2.3 or v1.2.3.",
+    required=False,
+)
+@click.option(
+    "--branch",
+    help="Git branch that has been built into an image.",
+    required=False,
+)
+@click.option(
+    "--commit",
+    help="Git sha hash that has been built into an image.",
+    required=False,
+)
+def deploy(
+    app: str, env: str, codebase: str, commit: str = None, tag: str = None, branch: str = None
+):
+
     try:
-        Codebase().deploy(app, env, codebase, commit)
+        Codebase(ParameterStore(get_aws_session_or_abort().client("ssm"))).deploy(
+            app, env, codebase, commit, tag, branch
+        )
     except PlatformException as err:
         ClickIOProvider().abort_with_error(str(err))

dbt_platform_helper/commands/conduit.py

@@ -1,6 +1,7 @@
 import click
 
 from dbt_platform_helper.domain.conduit import Conduit
+from dbt_platform_helper.domain.versioning import PlatformHelperVersioning
 from dbt_platform_helper.platform_exception import PlatformException
 from dbt_platform_helper.providers.cloudformation import CloudFormation
 from dbt_platform_helper.providers.ecs import ECS
@@ -8,9 +9,6 @@ from dbt_platform_helper.providers.io import ClickIOProvider
 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 (
-    check_platform_helper_version_needs_update,
-)
 
 CONDUIT_ACCESS_OPTIONS = ["read", "write", "admin"]
 
@@ -28,8 +26,8 @@ CONDUIT_ACCESS_OPTIONS = ["read", "write", "admin"]
 def conduit(addon_name: str, app: str, env: str, access: str):
     """Opens a shell for a given addon_name create a conduit connection to
     interact with postgres, opensearch or redis."""
-    check_platform_helper_version_needs_update()
-    application = load_application(app)
+    PlatformHelperVersioning().check_if_needs_update()
+    application = load_application(app=app, env=env)
 
     try:
         secrets_provider: Secrets = Secrets(