dbt-platform-helper 12.3.0__py3-none-any.whl → 12.4.1__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,7 +1,7 @@
 import click
 
 from dbt_platform_helper.domain.codebase import Codebase
-from dbt_platform_helper.exceptions import PlatformException
+from dbt_platform_helper.platform_exception import PlatformException
 from dbt_platform_helper.utils.click import ClickDocOptGroup
 from dbt_platform_helper.utils.versioning import (
     check_platform_helper_version_needs_update,

dbt_platform_helper/commands/conduit.py

@@ -1,7 +1,7 @@
 import click
 
 from dbt_platform_helper.domain.conduit import Conduit
-from dbt_platform_helper.exceptions import AWSException
+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
@@ -53,6 +53,6 @@ def conduit(addon_name: str, app: str, env: str, access: str):
         Conduit(application, secrets_provider, cloudformation_provider, ecs_provider).start(
             env, addon_name, access
         )
-    except AWSException as err:
+    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/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/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/domain/codebase.py

@@ -9,10 +9,9 @@ import requests
 import yaml
 from boto3 import Session
 
-from dbt_platform_helper.exceptions import ApplicationDeploymentNotTriggered
-from dbt_platform_helper.exceptions import ApplicationEnvironmentNotFoundError
-from dbt_platform_helper.exceptions import NotInCodeBaseRepositoryError
+from dbt_platform_helper.platform_exception import PlatformException
 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
 from dbt_platform_helper.utils.aws import check_codebase_exists
 from dbt_platform_helper.utils.aws import check_image_exists
@@ -68,7 +67,7 @@ class Codebase:
             .removesuffix(".git")
         )
         if repository.endswith("-deploy") or Path("./copilot").exists():
-            raise NotInCodeBaseRepositoryError()
+            raise NotInCodeBaseRepositoryException()
 
         builder_configuration_url = "https://raw.githubusercontent.com/uktrade/ci-image-builder/main/image_builder/configuration/builder_configuration.yml"
         builder_configuration_response = requests.get(builder_configuration_url)
@@ -143,7 +142,7 @@ class Codebase:
 
         application = self.load_application(app, default_session=session)
         if not application.environments.get(env):
-            raise ApplicationEnvironmentNotFoundError(env)
+            raise ApplicationEnvironmentNotFoundException(env)
 
         self.check_codebase_exists(session, application, codebase)
 
@@ -220,3 +219,22 @@ class Codebase:
             build_arn = self.start_build_extraction(codebuild_client, build_options)
             return get_build_url_from_arn(build_arn)
         return None
+
+
+class ApplicationDeploymentNotTriggered(PlatformException):
+    def __init__(self, codebase: str):
+        super().__init__(f"""Your deployment for {codebase} was not triggered.""")
+
+
+class ApplicationEnvironmentNotFoundException(ApplicationException):
+    def __init__(self, environment: str):
+        super().__init__(
+            f"""The environment "{environment}" either does not exist or has not been deployed."""
+        )
+
+
+class NotInCodeBaseRepositoryException(PlatformException):
+    def __init__(self):
+        super().__init__(
+            "You are in the deploy repository; make sure you are in the application codebase repository.",
+        )

dbt_platform_helper/domain/conduit.py

@@ -6,7 +6,6 @@ import click
 from dbt_platform_helper.providers.cloudformation import CloudFormation
 from dbt_platform_helper.providers.copilot import connect_to_addon_client_task
 from dbt_platform_helper.providers.copilot import create_addon_client_task
-from dbt_platform_helper.providers.copilot import create_postgres_admin_task
 from dbt_platform_helper.providers.ecs import ECS
 from dbt_platform_helper.providers.secrets import Secrets
 from dbt_platform_helper.utils.application import Application
@@ -23,7 +22,6 @@ class Conduit:
         subprocess: subprocess = subprocess,
         connect_to_addon_client_task=connect_to_addon_client_task,
         create_addon_client_task=create_addon_client_task,
-        create_postgres_admin_task=create_postgres_admin_task,
     ):
 
         self.application = application
@@ -34,7 +32,6 @@ class Conduit:
         self.echo = echo
         self.connect_to_addon_client_task = connect_to_addon_client_task
         self.create_addon_client_task = create_addon_client_task
-        self.create_postgres_admin_task = create_postgres_admin_task
 
     def start(self, env: str, addon_name: str, access: str = "read"):
         clients = self._initialise_clients(env)
@@ -49,7 +46,6 @@ class Conduit:
             self.create_addon_client_task(
                 clients["iam"],
                 clients["ssm"],
-                clients["secrets_manager"],
                 self.subprocess,
                 self.application,
                 env,
@@ -89,8 +85,6 @@ class Conduit:
             "ecs": self.application.environments[env].session.client("ecs"),
             "iam": self.application.environments[env].session.client("iam"),
             "ssm": self.application.environments[env].session.client("ssm"),
-            "cloudformation": self.application.environments[env].session.client("cloudformation"),
-            "secrets_manager": self.application.environments[env].session.client("secretsmanager"),
         }
 
     def _get_addon_details(self, addon_name, access):

dbt_platform_helper/domain/database_copy.py

@@ -8,9 +8,9 @@ from boto3 import Session
 
 from dbt_platform_helper.constants import PLATFORM_CONFIG_FILE
 from dbt_platform_helper.domain.maintenance_page import MaintenancePageProvider
-from dbt_platform_helper.exceptions import ApplicationNotFoundError
-from dbt_platform_helper.exceptions import AWSException
+from dbt_platform_helper.providers.aws import AWSException
 from dbt_platform_helper.utils.application import Application
+from dbt_platform_helper.utils.application import ApplicationNotFoundException
 from dbt_platform_helper.utils.application import load_application
 from dbt_platform_helper.utils.aws import Vpc
 from dbt_platform_helper.utils.aws import get_connection_string
@@ -58,10 +58,10 @@ class DatabaseCopy:
 
         try:
             self.application = load_application(self.app)
-        except ApplicationNotFoundError:
+        except ApplicationNotFoundException:
             abort(f"No such application '{app}'.")
 
-    def _execute_operation(self, is_dump: bool, env: str, vpc_name: str, to_env: str):
+    def _execute_operation(self, is_dump: bool, env: str, vpc_name: str, filename: str):
         vpc_name = self.enrich_vpc_name(env, vpc_name)
 
         environments = self.application.environments
@@ -89,7 +89,7 @@ class DatabaseCopy:
 
         try:
             task_arn = self.run_database_copy_task(
-                env_session, env, vpc_config, is_dump, db_connection_string, to_env
+                env_session, env, vpc_config, is_dump, db_connection_string, filename
             )
         except Exception as exc:
             self.abort(f"{exc} (Account id: {self.account_id(env)})")
@@ -122,14 +122,15 @@ class DatabaseCopy:
         vpc_config: Vpc,
         is_dump: bool,
         db_connection_string: str,
-        to_env: str,
+        filename: str,
     ) -> str:
         client = session.client("ecs")
         action = "dump" if is_dump else "load"
+        dump_file_name = filename if filename else "data_dump"
         env_vars = [
             {"name": "DATA_COPY_OPERATION", "value": action.upper()},
             {"name": "DB_CONNECTION_STRING", "value": db_connection_string},
-            {"name": "TO_ENVIRONMENT", "value": to_env},
+            {"name": "DUMP_FILE_NAME", "value": dump_file_name},
         ]
         if not is_dump:
             env_vars.append({"name": "ECS_CLUSTER", "value": f"{self.app}-{env}"})
@@ -159,12 +160,12 @@ class DatabaseCopy:
 
         return response.get("tasks", [{}])[0].get("taskArn")
 
-    def dump(self, env: str, vpc_name: str, to_env: str):
-        self._execute_operation(True, env, vpc_name, to_env)
+    def dump(self, env: str, vpc_name: str, filename: str = None):
+        self._execute_operation(True, env, vpc_name, filename)
 
-    def load(self, env: str, vpc_name: str):
+    def load(self, env: str, vpc_name: str, filename: str = None):
         if self.is_confirmed_ready_to_load(env):
-            self._execute_operation(False, env, vpc_name, to_env=env)
+            self._execute_operation(False, env, vpc_name, filename)
 
     def copy(
         self,
@@ -179,8 +180,8 @@ class DatabaseCopy:
         to_vpc = self.enrich_vpc_name(to_env, to_vpc)
         if not no_maintenance_page:
             self.maintenance_page_provider.activate(self.app, to_env, services, template, to_vpc)
-        self.dump(from_env, from_vpc, to_env)
-        self.load(to_env, to_vpc)
+        self.dump(from_env, from_vpc, f"data_dump_{to_env}")
+        self.load(to_env, to_vpc, f"data_dump_{to_env}")
         if not no_maintenance_page:
             self.maintenance_page_provider.deactivate(self.app, to_env)
 

dbt_platform_helper/domain/maintenance_page.py

@@ -9,9 +9,9 @@ from typing import Union
 import boto3
 import click
 
-from dbt_platform_helper.providers.load_balancers import ListenerNotFoundError
-from dbt_platform_helper.providers.load_balancers import ListenerRuleNotFoundError
-from dbt_platform_helper.providers.load_balancers import LoadBalancerNotFoundError
+from dbt_platform_helper.providers.load_balancers import ListenerNotFoundException
+from dbt_platform_helper.providers.load_balancers import ListenerRuleNotFoundException
+from dbt_platform_helper.providers.load_balancers import LoadBalancerNotFoundException
 from dbt_platform_helper.providers.load_balancers import find_https_listener
 from dbt_platform_helper.utils.application import Environment
 from dbt_platform_helper.utils.application import Service
@@ -75,13 +75,13 @@ class MaintenancePageProvider:
             else:
                 raise click.Abort
 
-        except LoadBalancerNotFoundError:
+        except LoadBalancerNotFoundException:
             click.secho(
                 f"No load balancer found for environment {env} in the application {app}.", fg="red"
             )
             raise click.Abort
 
-        except ListenerNotFoundError:
+        except ListenerNotFoundException:
             click.secho(
                 f"No HTTPS listener found for environment {env} in the application {app}.", fg="red"
             )
@@ -110,13 +110,13 @@ class MaintenancePageProvider:
                 f"Maintenance page removed from environment {env} in application {app}", fg="green"
             )
 
-        except LoadBalancerNotFoundError:
+        except LoadBalancerNotFoundException:
             click.secho(
                 f"No load balancer found for environment {env} in the application {app}.", fg="red"
             )
             raise click.Abort
 
-        except ListenerNotFoundError:
+        except ListenerNotFoundException:
             click.secho(
                 f"No HTTPS listener found for environment {env} in the application {app}.", fg="red"
             )
@@ -180,7 +180,7 @@ def remove_maintenance_page(session: boto3.Session, listener_arn: str):
         deleted = delete_listener_rule(tag_descriptions, name, lb_client)
 
         if name == "MaintenancePage" and not deleted:
-            raise ListenerRuleNotFoundError()
+            raise ListenerRuleNotFoundException()
 
 
 def get_rules_tag_descriptions(rules: list, lb_client):
@@ -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/platform_exception.py

@@ -0,0 +1,5 @@
+# This exception exists so that we can easily catch exceptions
+# at the command level where we know we can just output the
+# error and abort.
+class PlatformException(Exception):
+    pass

dbt_platform_helper/providers/aws.py

@@ -0,0 +1,32 @@
+from dbt_platform_helper.platform_exception import PlatformException
+
+
+class AWSException(PlatformException):
+    pass
+
+
+class CreateTaskTimeoutException(AWSException):
+    def __init__(self, addon_name: str, application_name: str, environment: str):
+        super().__init__(
+            f"""Client ({addon_name}) ECS task has failed to start for "{application_name}" in "{environment}" environment."""
+        )
+
+
+class ImageNotFoundException(AWSException):
+    def __init__(self, commit: str):
+        super().__init__(
+            f"""The commit hash "{commit}" has not been built into an image, try the `platform-helper codebase build` command first."""
+        )
+
+
+class LogGroupNotFoundException(AWSException):
+    def __init__(self, log_group_name: str):
+        super().__init__(f"""No log group called "{log_group_name}".""")
+
+
+# Todo: This should probably be in the AWS Copilot provider, but was causing circular import when we tried it pre refactoring the utils/aws.py
+class CopilotCodebaseNotFoundException(PlatformException):
+    def __init__(self, codebase: str):
+        super().__init__(
+            f"""The codebase "{codebase}" either does not exist or has not been deployed."""
+        )

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)