refactor: Unit tests for environment command into the new format (#708)

Co-authored-by: Connor Hindle <Connor.Hindle@digital.trade.gov.uk>
Co-authored-by: Connor Hindle <69192234+DeveloperConnor@users.noreply.github.com>

dbt_platform_helper/commands/environment.py

@@ -5,7 +5,7 @@
 from dbt_platform_helper.constants import PLATFORM_CONFIG_FILE
 from dbt_platform_helper.domain.config_validator import ConfigValidator
 from dbt_platform_helper.domain.copilot_environment import CopilotEnvironment
-from dbt_platform_helper.domain.maintenance_page import MaintenancePageProvider
+from dbt_platform_helper.domain.maintenance_page import MaintenancePage
 from dbt_platform_helper.domain.terraform_environment import TerraformEnvironment
 from dbt_platform_helper.platform_exception import PlatformException
 from dbt_platform_helper.providers.config import ConfigProvider
@@ -37,7 +37,7 @@ def environment():
 def offline(app, env, svc, template, vpc):
     """Take load-balanced web services offline with a maintenance page."""
     try:
-        MaintenancePageProvider().activate(app, env, svc, template, vpc)
+        MaintenancePage().activate(app, env, svc, template, vpc)
     except PlatformException as err:
         click.secho(str(err), fg="red")
         raise click.Abort
@@ -49,7 +49,7 @@ def offline(app, env, svc, template, vpc):
 def online(app, env):
     """Remove a maintenance page from an environment."""
     try:
-        MaintenancePageProvider().deactivate(app, env)
+        MaintenancePage().deactivate(app, env)
     except PlatformException as err:
         click.secho(str(err), fg="red")
         raise click.Abort
@@ -71,6 +71,9 @@ def generate(name, vpc_name):
     except SchemaError as ex:
         click.secho(f"Invalid `{PLATFORM_CONFIG_FILE}` file: {str(ex)}", fg="red")
         raise click.Abort
+    except PlatformException as err:
+        click.secho(str(err), fg="red")
+        raise click.Abort
 
 
 @environment.command(help="Generate terraform manifest for the specified environment.")
@@ -82,5 +85,10 @@ def generate(name, vpc_name):
     help=f"Override the default version of terraform-platform-modules. (Default version is '{DEFAULT_TERRAFORM_PLATFORM_MODULES_VERSION}').",
 )
 def generate_terraform(name, terraform_platform_modules_version):
-    config_provider = ConfigProvider(ConfigValidator())
-    TerraformEnvironment(config_provider).generate(name, terraform_platform_modules_version)
+
+    try:
+        config_provider = ConfigProvider(ConfigValidator())
+        TerraformEnvironment(config_provider).generate(name, terraform_platform_modules_version)
+    except PlatformException as err:
+        click.secho(str(err), fg="red")
+        raise click.Abort

dbt_platform_helper/domain/database_copy.py

@@ -8,7 +8,7 @@
 
 from dbt_platform_helper.constants import PLATFORM_CONFIG_FILE
 from dbt_platform_helper.domain.config_validator import ConfigValidator
-from dbt_platform_helper.domain.maintenance_page import MaintenancePageProvider
+from dbt_platform_helper.domain.maintenance_page import MaintenancePage
 from dbt_platform_helper.providers.aws import AWSException
 from dbt_platform_helper.providers.config import ConfigProvider
 from dbt_platform_helper.utils.application import Application
@@ -34,7 +34,7 @@ def __init__(
         ] = get_connection_string,
         maintenance_page_provider: Callable[
             [str, str, list[str], str, str], None
-        ] = MaintenancePageProvider(),
+        ] = MaintenancePage(),
         input: Callable[[str], str] = click.prompt,
         echo: Callable[[str], str] = click.secho,
         abort: Callable[[str], None] = abort_with_error,

dbt_platform_helper/domain/maintenance_page.py

@@ -18,7 +18,7 @@
 from dbt_platform_helper.utils.application import load_application
 
 
-class MaintenancePageProvider:
+class MaintenancePage:
     def activate(self, app, env, svc, template, vpc):
         application = load_application(app)
         application_environment = get_app_environment(app, env)

dbt_platform_helper/providers/config.py

@@ -7,6 +7,7 @@
 from dbt_platform_helper.constants import PLATFORM_CONFIG_FILE
 from dbt_platform_helper.domain.config_validator import ConfigValidator
 from dbt_platform_helper.providers.platform_config_schema import PlatformConfigSchema
+from dbt_platform_helper.providers.yaml_file import FileNotFoundException
 from dbt_platform_helper.providers.yaml_file import FileProvider
 from dbt_platform_helper.providers.yaml_file import FileProviderException
 from dbt_platform_helper.providers.yaml_file import YamlFileProvider
@@ -35,6 +36,10 @@ def validate_platform_config(self):
     def load_and_validate_platform_config(self, path=PLATFORM_CONFIG_FILE):
         try:
             self.config = self.file_provider.load(path)
+        except FileNotFoundException as e:
+            abort_with_error(
+                f"{e} Please check it exists and you are in the root directory of your deployment project."
+            )
         except FileProviderException as e:
             abort_with_error(f"Error loading configuration from {path}: {e}")
 

dbt_platform_helper/providers/yaml_file.py

@@ -16,7 +16,7 @@ class YamlFileProviderException(FileProviderException):
     pass
 
 
-class FileNotFoundException(YamlFileProviderException):
+class FileNotFoundException(FileProviderException):
     pass
 
 
@@ -43,10 +43,7 @@ def load(path: str) -> dict:
             DuplicateKeysException: yaml contains duplicate keys
         """
         if not Path(path).exists():
-            # TODO this error message is domain specific and should not mention deployment directory project here
-            raise FileNotFoundException(
-                f"`{path}` is missing. Please check it exists and you are in the root directory of your deployment project."
-            )
+            raise FileNotFoundException(f"`{path}` is missing.")
         try:
             yaml_content = yaml.safe_load(Path(path).read_text())
         except ParserError: