dbt-platform-helper 12.3.0__py3-none-any.whl → 12.4.1__py3-none-any.whl

dbt_platform_helper/providers/validation.py

@@ -0,0 +1,19 @@
+from dbt_platform_helper.platform_exception import PlatformException
+
+
+class ValidationException(PlatformException):
+    pass
+
+
+class IncompatibleMajorVersionException(ValidationException):
+    def __init__(self, app_version: str, check_version: str):
+        super().__init__()
+        self.app_version = app_version
+        self.check_version = check_version
+
+
+class IncompatibleMinorVersionException(ValidationException):
+    def __init__(self, app_version: str, check_version: str):
+        super().__init__()
+        self.app_version = app_version
+        self.check_version = check_version

dbt_platform_helper/utils/application.py

@@ -1,4 +1,5 @@
 import json
+import os
 import re
 from pathlib import Path
 from typing import Dict
@@ -8,7 +9,7 @@ import yaml
 from boto3 import Session
 from yaml.parser import ParserError
 
-from dbt_platform_helper.exceptions import ApplicationNotFoundError
+from dbt_platform_helper.platform_exception import PlatformException
 from dbt_platform_helper.utils.aws import get_aws_session_or_abort
 from dbt_platform_helper.utils.aws import get_profile_name_from_account_id
 from dbt_platform_helper.utils.aws import get_ssm_secrets
@@ -80,7 +81,7 @@ def load_application(app: str = None, default_session: Session = None) -> Applic
             WithDecryption=False,
         )
     except ssm_client.exceptions.ParameterNotFound:
-        raise ApplicationNotFoundError(app)
+        raise ApplicationNotFoundException(app)
 
     path = f"/copilot/applications/{application.name}/environments"
     secrets = get_ssm_secrets(app, None, current_session, path)
@@ -135,3 +136,14 @@ def get_application_name():
         abort_with_error("Cannot get application name. No copilot/.workspace file found")
 
     return app_name
+
+
+class ApplicationException(PlatformException):
+    pass
+
+
+class ApplicationNotFoundException(ApplicationException):
+    def __init__(self, application_name: str):
+        super().__init__(
+            f"""The account "{os.environ.get("AWS_PROFILE")}" does not contain the application "{application_name}"; ensure you have set the environment variable "AWS_PROFILE" correctly."""
+        )

dbt_platform_helper/utils/arn_parser.py

@@ -1,4 +1,4 @@
-from dbt_platform_helper.exceptions import ValidationException
+from dbt_platform_helper.providers.validation import ValidationException
 
 
 class ARN:

dbt_platform_helper/utils/aws.py

@@ -13,14 +13,13 @@ import click
 import yaml
 from boto3 import Session
 
-from dbt_platform_helper.exceptions import AWSException
-from dbt_platform_helper.exceptions import CopilotCodebaseNotFoundError
-from dbt_platform_helper.exceptions import ImageNotFoundError
-from dbt_platform_helper.exceptions import ResourceNotFoundException
-from dbt_platform_helper.exceptions import ValidationException
-from dbt_platform_helper.utils.files import cache_refresh_required
-from dbt_platform_helper.utils.files import read_supported_versions_from_cache
-from dbt_platform_helper.utils.files import write_to_cache
+from dbt_platform_helper.platform_exception import PlatformException
+from dbt_platform_helper.providers.aws import AWSException
+from dbt_platform_helper.providers.aws import CopilotCodebaseNotFoundException
+from dbt_platform_helper.providers.aws import ImageNotFoundException
+from dbt_platform_helper.providers.aws import LogGroupNotFoundException
+from dbt_platform_helper.providers.cache import CacheProvider
+from dbt_platform_helper.providers.validation import ValidationException
 
 SSM_BASE_PATH = "/copilot/{app}/{env}/secrets/"
 SSM_PATH = "/copilot/{app}/{env}/secrets/{name}"
@@ -95,7 +94,7 @@ def _log_account_info(account_name: list, account_id: str) -> None:
         )
 
 
-class NoProfileForAccountIdError(Exception):
+class NoProfileForAccountIdException(PlatformException):
     def __init__(self, account_id):
         super().__init__(f"No profile found for account {account_id}")
 
@@ -110,7 +109,7 @@ def get_profile_name_from_account_id(account_id: str):
         if account_id == found_account_id:
             return section.removeprefix("profile ")
 
-    raise NoProfileForAccountIdError(account_id)
+    raise NoProfileForAccountIdException(account_id)
 
 
 def get_ssm_secret_names(app, env):
@@ -361,9 +360,9 @@ def get_postgres_connection_data_updated_with_master_secret(session, parameter_n
 
 def get_supported_redis_versions():
 
-    if cache_refresh_required("redis"):
+    cache_provider = CacheProvider()
 
-        supported_versions = []
+    if cache_provider.cache_refresh_required("redis"):
 
         session = get_aws_session_or_abort()
         elasticache_client = session.client("elasticache")
@@ -377,19 +376,19 @@ def get_supported_redis_versions():
             for version in supported_versions_response["CacheEngineVersions"]
         ]
 
-        write_to_cache("redis", supported_versions)
+        cache_provider.update_cache("redis", supported_versions)
 
         return supported_versions
 
     else:
-        return read_supported_versions_from_cache("redis")
+        return cache_provider.read_supported_versions_from_cache("redis")
 
 
 def get_supported_opensearch_versions():
 
-    if cache_refresh_required("opensearch"):
+    cache_provider = CacheProvider()
 
-        supported_versions = []
+    if cache_provider.cache_refresh_required("opensearch"):
 
         session = get_aws_session_or_abort()
         opensearch_client = session.client("opensearch")
@@ -404,12 +403,12 @@ def get_supported_opensearch_versions():
             version.removeprefix("OpenSearch_") for version in opensearch_versions
         ]
 
-        write_to_cache("opensearch", supported_versions)
+        cache_provider.update_cache("opensearch", supported_versions)
 
         return supported_versions
 
     else:
-        return read_supported_versions_from_cache("opensearch")
+        return cache_provider.read_supported_versions_from_cache("opensearch")
 
 
 def get_connection_string(
@@ -488,8 +487,10 @@ def start_build_extraction(codebuild_client, build_options):
     return response["build"]["arn"]
 
 
+# Todo: This should probably be in the AWS Copilot provider
 def check_codebase_exists(session: Session, application, codebase: str):
     try:
+        # Todo: Can this leverage dbt_platform_helper.providers.secrets.Secrets.get_connection_secret_arn?
         ssm_client = session.client("ssm")
         json.loads(
             ssm_client.get_parameter(
@@ -502,7 +503,7 @@ def check_codebase_exists(session: Session, application, codebase: str):
         ssm_client.exceptions.ParameterNotFound,
         json.JSONDecodeError,
     ):
-        raise CopilotCodebaseNotFoundError(codebase)
+        raise CopilotCodebaseNotFoundException(codebase)
 
 
 def check_image_exists(session, application, codebase, commit):
@@ -516,7 +517,7 @@ def check_image_exists(session, application, codebase, commit):
         ecr_client.exceptions.RepositoryNotFoundException,
         ecr_client.exceptions.ImageNotFoundException,
     ):
-        raise ImageNotFoundError(commit)
+        raise ImageNotFoundException(commit)
 
 
 def get_build_url_from_arn(build_arn: str) -> str:
@@ -577,4 +578,4 @@ def wait_for_log_group_to_exist(log_client, log_group_name, attempts=30):
         time.sleep(1)
 
     if not log_group_exists:
-        raise ResourceNotFoundException
+        raise LogGroupNotFoundException(log_group_name)

dbt_platform_helper/utils/files.py

@@ -1,6 +1,4 @@
-import os
 from copy import deepcopy
-from datetime import datetime
 from os import makedirs
 from pathlib import Path
 
@@ -9,8 +7,6 @@ import yaml
 from jinja2 import Environment
 from jinja2 import FileSystemLoader
 
-from dbt_platform_helper.constants import PLATFORM_HELPER_CACHE_FILE
-
 
 def to_yaml(value):
     return yaml.dump(value, sort_keys=False)
@@ -106,69 +102,3 @@ def apply_environment_defaults(config):
     enriched_config["environments"] = defaulted_envs
 
     return enriched_config
-
-
-def read_supported_versions_from_cache(resource_name):
-
-    platform_helper_config = read_file_as_yaml(PLATFORM_HELPER_CACHE_FILE)
-
-    return platform_helper_config.get(resource_name).get("versions")
-
-
-def write_to_cache(resource_name, supported_versions):
-
-    platform_helper_config = {}
-
-    if os.path.exists(PLATFORM_HELPER_CACHE_FILE):
-        platform_helper_config = read_file_as_yaml(PLATFORM_HELPER_CACHE_FILE)
-
-    cache_dict = {
-        resource_name: {
-            "versions": supported_versions,
-            "date-retrieved": datetime.now().strftime("%d-%m-%y %H:%M:%S"),
-        }
-    }
-
-    platform_helper_config.update(cache_dict)
-
-    with open(PLATFORM_HELPER_CACHE_FILE, "w") as file:
-        file.write("# [!] This file is autogenerated via the platform-helper. Do not edit.\n")
-        yaml.dump(platform_helper_config, file)
-
-
-def cache_refresh_required(resource_name) -> bool:
-    """
-    Checks if the platform-helper should reach out to AWS to 'refresh' its
-    cached values.
-
-    An API call is needed if any of the following conditions are met:
-        1. No cache file (.platform-helper-config.yml) exists.
-        2. The resource name (e.g. redis, opensearch) does not exist within the cache file.
-        3. The date-retrieved value of the cached data is > than a time interval. In this case 1 day.
-    """
-
-    if not os.path.exists(PLATFORM_HELPER_CACHE_FILE):
-        return True
-
-    platform_helper_config = read_file_as_yaml(PLATFORM_HELPER_CACHE_FILE)
-
-    if platform_helper_config.get(resource_name):
-        return check_if_cached_datetime_is_greater_than_interval(
-            platform_helper_config[resource_name].get("date-retrieved"), 1
-        )
-
-    return True
-
-
-def check_if_cached_datetime_is_greater_than_interval(date_retrieved, interval_in_days):
-
-    current_datetime = datetime.now()
-    cached_datetime = datetime.strptime(date_retrieved, "%d-%m-%y %H:%M:%S")
-    delta = current_datetime - cached_datetime
-
-    return delta.days > interval_in_days
-
-
-def read_file_as_yaml(file_name):
-
-    return yaml.safe_load(Path(file_name).read_text())

dbt_platform_helper/utils/git.py

@@ -2,7 +2,7 @@ import re
 import subprocess
 
 
-class CommitNotFoundError(Exception):
+class CommitNotFoundException(Exception):
     pass
 
 
@@ -26,4 +26,4 @@ def check_if_commit_exists(commit):
     )
 
     if branches_containing_commit.stderr:
-        raise CommitNotFoundError()
+        raise CommitNotFoundException()