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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dbt-platform-helper
-Version: 12.4.0
+Version: 12.4.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.0 → dbt_platform_helper-12.4.1}/dbt_platform_helper/commands/pipeline.py

@@ -67,14 +67,9 @@ def generate(terraform_platform_modules_version, deploy_branch):
     pipeline_config = load_and_validate_platform_config()
 
     has_codebase_pipelines = CODEBASE_PIPELINES_KEY in pipeline_config
-    has_legacy_environment_pipelines = ENVIRONMENTS_KEY in pipeline_config
     has_environment_pipelines = ENVIRONMENT_PIPELINES_KEY in pipeline_config
 
-    if (
-        not has_codebase_pipelines
-        and not has_legacy_environment_pipelines
-        and not has_environment_pipelines
-    ):
+    if not (has_codebase_pipelines or has_environment_pipelines):
         click.secho("No pipelines defined: nothing to do.", err=True, fg="yellow")
         return
 
@@ -178,29 +173,6 @@ def _generate_codebase_pipeline(
     )
 
 
-def _generate_copilot_environments_pipeline(
-    app_name, codestar_connection_arn, git_repo, configuration, base_path, pipelines_dir, templates
-):
-    makedirs(pipelines_dir / "environments/overrides", exist_ok=True)
-
-    template_data = {
-        "app_name": app_name,
-        "git_repo": git_repo,
-        "codestar_connection_arn": codestar_connection_arn,
-        "pipeline_environments": configuration,
-    }
-
-    _create_file_from_template(
-        base_path, "environments/buildspec.yml", pipelines_dir, template_data, templates
-    )
-    _create_file_from_template(
-        base_path, "environments/manifest.yml", pipelines_dir, template_data, templates
-    )
-    _create_file_from_template(
-        base_path, "environments/overrides/cfn.patches.yml", pipelines_dir, template_data, templates
-    )
-
-
 def _create_file_from_template(
     base_path, file_name, pipelines_dir, template_data, templates, template_name=None
 ):

{dbt_platform_helper-12.4.0 → dbt_platform_helper-12.4.1}/dbt_platform_helper/constants.py

@@ -1,7 +1,9 @@
+# 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"
-PLATFORM_HELPER_CACHE_FILE = ".platform-helper-config-cache.yml"
 
 # Keys
 CODEBASE_PIPELINES_KEY = "codebase_pipelines"

{dbt_platform_helper-12.4.0 → dbt_platform_helper-12.4.1}/dbt_platform_helper/domain/maintenance_page.py

@@ -261,7 +261,7 @@ def add_maintenance_page(
         )
 
         click.secho(
-            f"\nUse a browser plugin to add `Bypass-Key` header with value {bypass_value} to your requests. For more detail, visit https://platform.readme.trade.gov.uk/activities/holding-and-maintenance-pages/",
+            f"\nUse a browser plugin to add `Bypass-Key` header with value {bypass_value} to your requests. For more detail, visit https://platform.readme.trade.gov.uk/next-steps/put-a-service-under-maintenance/",
             fg="green",
         )
 

dbt_platform_helper-12.4.1/dbt_platform_helper/providers/cache.py

@@ -0,0 +1,83 @@
+import os
+from datetime import datetime
+from pathlib import Path
+
+import yaml
+
+
+class CacheProvider:
+    def __init__(self):
+        self._cache_file = ".platform-helper-config-cache.yml"
+
+    def read_supported_versions_from_cache(self, resource_name):
+
+        platform_helper_config = self.__read_file_as_yaml(self._cache_file)
+
+        return platform_helper_config.get(resource_name).get("versions")
+
+    def update_cache(self, resource_name, supported_versions):
+
+        platform_helper_config = {}
+
+        if self.__cache_exists():
+            platform_helper_config = self.__read_file_as_yaml(self._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)
+
+        self.__write_cache(platform_helper_config)
+
+    def cache_refresh_required(self, 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 self.__cache_exists():
+            return True
+
+        platform_helper_config = self.__read_file_as_yaml(self._cache_file)
+
+        if platform_helper_config.get(resource_name):
+            return self.__check_if_cached_datetime_is_greater_than_interval(
+                platform_helper_config[resource_name].get("date-retrieved"), 1
+            )
+
+        return True
+
+    @staticmethod
+    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
+
+    # TODO - same applies here as below
+    @staticmethod
+    def __read_file_as_yaml(file_name):
+
+        return yaml.safe_load(Path(file_name).read_text())
+
+    # TODO - temp fix to the unit test coverage issue, plan is to seperate out any yaml interaction methods into a seperate 'yaml' provider
+    # should be done under a different sub-task which will need to loop back to this provider as part of that work to use the yaml provider instead
+    def __write_cache(self, contents):
+
+        with open(self._cache_file, "w") as file:
+            file.write("# [!] This file is autogenerated via the platform-helper. Do not edit.\n")
+            yaml.dump(contents, file)
+
+    def __cache_exists(self):
+        return os.path.exists(self._cache_file)