refactor: DBTP-1630 Terraform environment domain tests refactor

dbt_platform_helper/COMMANDS.md

@@ -460,13 +460,11 @@ platform-helper environment online --app <application> --env <environment>
 ## Usage
 
 ```
-platform-helper environment generate --name <name> [--vpc-name <vpc_name>] 
+platform-helper environment generate --name <name> 
 ```
 
 ## Options
 
-- `--vpc-name <text>`
-
 - `--name
 -n <text>`
 

dbt_platform_helper/commands/copilot.py

@@ -13,12 +13,12 @@
 from dbt_platform_helper.domain.config_validator import ConfigValidator
 from dbt_platform_helper.domain.copilot_environment import CopilotTemplating
 from dbt_platform_helper.providers.config import ConfigProvider
+from dbt_platform_helper.providers.files import FileProvider
 from dbt_platform_helper.utils.application import get_application_name
 from dbt_platform_helper.utils.application import load_application
 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.files import generate_override_files
-from dbt_platform_helper.utils.files import mkfile
 from dbt_platform_helper.utils.messages import abort_with_error
 from dbt_platform_helper.utils.template import ADDON_TEMPLATE_MAP
 from dbt_platform_helper.utils.template import camel_case
@@ -379,7 +379,9 @@ def _generate_service_addons(
 
             (output_dir / service_path).mkdir(parents=True, exist_ok=True)
             click.echo(
-                mkfile(output_dir, service_path / f"{addon_name}.yml", contents, overwrite=True)
+                FileProvider.mkfile(
+                    output_dir, service_path / f"{addon_name}.yml", contents, overwrite=True
+                )
             )
 
 

dbt_platform_helper/commands/environment.py

@@ -56,15 +56,8 @@ def online(app, env):
 
 
 @environment.command()
-@click.option("--vpc-name", hidden=True)
 @click.option("--name", "-n", required=True)
-def generate(name, vpc_name):
-    if vpc_name:
-        click.secho(
-            f"This option is deprecated. Please add the VPC name for your envs to {PLATFORM_CONFIG_FILE}",
-            fg="red",
-        )
-        raise click.Abort
+def generate(name):
     try:
         config_provider = ConfigProvider(ConfigValidator())
         CopilotEnvironment(config_provider).generate(name)

dbt_platform_helper/commands/pipeline.py

@@ -8,13 +8,13 @@
 from dbt_platform_helper.constants import DEFAULT_TERRAFORM_PLATFORM_MODULES_VERSION
 from dbt_platform_helper.domain.config_validator import ConfigValidator
 from dbt_platform_helper.providers.config import ConfigProvider
+from dbt_platform_helper.providers.files import FileProvider
 from dbt_platform_helper.utils.application import get_application_name
 from dbt_platform_helper.utils.aws import get_account_details
 from dbt_platform_helper.utils.aws import get_codestar_connection_arn
 from dbt_platform_helper.utils.aws import get_public_repository_arn
 from dbt_platform_helper.utils.click import ClickDocOptGroup
 from dbt_platform_helper.utils.files import generate_override_files_from_template
-from dbt_platform_helper.utils.files import mkfile
 from dbt_platform_helper.utils.git import git_remote
 from dbt_platform_helper.utils.messages import abort_with_error
 from dbt_platform_helper.utils.template import setup_templates
@@ -178,7 +178,7 @@ def _create_file_from_template(
     contents = templates.get_template(
         f"pipelines/{file_name if template_name is None else template_name}"
     ).render(template_data)
-    message = mkfile(base_path, pipelines_dir / file_name, contents, overwrite=True)
+    message = FileProvider.mkfile(base_path, pipelines_dir / file_name, contents, overwrite=True)
     click.echo(message)
 
 
@@ -207,7 +207,7 @@ def _generate_terraform_environment_pipeline_manifest(
     dir_path = f"terraform/environment-pipelines/{aws_account}"
     makedirs(dir_path, exist_ok=True)
 
-    click.echo(mkfile(".", f"{dir_path}/main.tf", contents, overwrite=True))
+    click.echo(FileProvider.mkfile(".", f"{dir_path}/main.tf", contents, overwrite=True))
 
 
 def _determine_terraform_platform_modules_version(

dbt_platform_helper/domain/codebase.py

@@ -10,6 +10,7 @@
 from boto3 import Session
 
 from dbt_platform_helper.platform_exception import PlatformException
+from dbt_platform_helper.providers.files import FileProvider
 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
@@ -19,7 +20,6 @@
 from dbt_platform_helper.utils.aws import get_build_url_from_arn
 from dbt_platform_helper.utils.aws import list_latest_images
 from dbt_platform_helper.utils.aws import start_build_extraction
-from dbt_platform_helper.utils.files import mkfile
 from dbt_platform_helper.utils.git import check_if_commit_exists
 from dbt_platform_helper.utils.template import setup_templates
 
@@ -92,21 +92,25 @@ def prepare(self):
             repository=repository, builder_version=builder_version
         )
         self.echo(
-            mkfile(
+            FileProvider.mkfile(
                 Path("."), ".copilot/image_build_run.sh", image_build_run_contents, overwrite=True
             )
         )
 
         image_build_run_file = Path(".copilot/image_build_run.sh")
         image_build_run_file.chmod(image_build_run_file.stat().st_mode | stat.S_IEXEC)
 
-        self.echo(mkfile(Path("."), ".copilot/config.yml", config_contents, overwrite=True))
+        self.echo(
+            FileProvider.mkfile(Path("."), ".copilot/config.yml", config_contents, overwrite=True)
+        )
 
         for phase in ["build", "install", "post_build", "pre_build"]:
             phase_contents = templates.get_template(f".copilot/phases/{phase}.sh").render()
 
             self.echo(
-                mkfile(Path("./.copilot"), f"phases/{phase}.sh", phase_contents, overwrite=True)
+                FileProvider.mkfile(
+                    Path("./.copilot"), f"phases/{phase}.sh", phase_contents, overwrite=True
+                )
             )
 
     def build(self, app: str, codebase: str, commit: str):

dbt_platform_helper/domain/copilot_environment.py

@@ -5,9 +5,9 @@
 import click
 
 from dbt_platform_helper.platform_exception import PlatformException
+from dbt_platform_helper.providers.files import FileProvider
 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.files import mkfile
 from dbt_platform_helper.utils.template import S3_CROSS_ACCOUNT_POLICY
 from dbt_platform_helper.utils.template import camel_case
 from dbt_platform_helper.utils.template import setup_templates
@@ -111,7 +111,7 @@ def _generate_copilot_environment_manifests(
         }
     )
     click.echo(
-        mkfile(
+        FileProvider.mkfile(
             ".", f"copilot/environments/{environment_name}/manifest.yml", contents, overwrite=True
         )
     )
@@ -155,7 +155,7 @@ def generate(self, environment_name):
 
 
 class CopilotTemplating:
-    def __init__(self, mkfile_fn=mkfile):
+    def __init__(self, mkfile_fn=FileProvider.mkfile):
         self.mkfile_fn = mkfile_fn
 
     def generate_cross_account_s3_policies(self, environments: dict, extensions):

dbt_platform_helper/domain/terraform_environment.py

@@ -1,53 +1,72 @@
 import click
 
 from dbt_platform_helper.constants import DEFAULT_TERRAFORM_PLATFORM_MODULES_VERSION
-from dbt_platform_helper.utils.files import mkfile
+from dbt_platform_helper.providers.files import FileProvider
 from dbt_platform_helper.utils.template import setup_templates
 
 
-def _generate_terraform_environment_manifests(
-    application, env, env_config, cli_terraform_platform_modules_version
-):
-    env_template = setup_templates().get_template("environments/main.tf")
+class PlatformTerraformManifestGenerator:
+    def __init__(self, file_provider):
+        self.file_provider = file_provider
+        self.manifest_template = setup_templates().get_template("environments/main.tf")
 
-    terraform_platform_modules_version = _determine_terraform_platform_modules_version(
-        env_config, cli_terraform_platform_modules_version
-    )
-
-    contents = env_template.render(
-        {
-            "application": application,
-            "environment": env,
-            "config": env_config,
-            "terraform_platform_modules_version": terraform_platform_modules_version,
-        }
-    )
-
-    click.echo(mkfile(".", f"terraform/environments/{env}/main.tf", contents, overwrite=True))
+    def generate_manifest(
+        self,
+        environment_name: str,
+        application_name: str,
+        environment_config: dict,
+        terraform_platform_modules_version_override: str = None,
+    ):
+        terraform_platform_modules_version = (
+            terraform_platform_modules_version_override
+            or environment_config.get("versions", {}).get(
+                "terraform-platform-modules", DEFAULT_TERRAFORM_PLATFORM_MODULES_VERSION
+            )
+        )
 
+        return self.manifest_template.render(
+            {
+                "application": application_name,
+                "environment": environment_name,
+                "config": environment_config,
+                "terraform_platform_modules_version": terraform_platform_modules_version,
+            }
+        )
 
-def _determine_terraform_platform_modules_version(env_conf, cli_terraform_platform_modules_version):
-    cli_terraform_platform_modules_version = cli_terraform_platform_modules_version
-    env_conf_terraform_platform_modules_version = env_conf.get("versions", {}).get(
-        "terraform-platform-modules"
-    )
-    version_preference_order = [
-        cli_terraform_platform_modules_version,
-        env_conf_terraform_platform_modules_version,
-        DEFAULT_TERRAFORM_PLATFORM_MODULES_VERSION,
-    ]
-    return [version for version in version_preference_order if version][0]
+    def write_manifest(self, environment_name: str, manifest_content: str):
+        return self.file_provider.mkfile(
+            ".",
+            f"terraform/environments/{environment_name}/main.tf",
+            manifest_content,
+            overwrite=True,
+        )
 
 
 class TerraformEnvironment:
-    def __init__(self, config_provider):
+    def __init__(
+        self,
+        config_provider,
+        manifest_generator: PlatformTerraformManifestGenerator = None,
+        echo_fn=click.echo,
+    ):
+        self.echo = echo_fn
         self.config_provider = config_provider
+        self.manifest_generator = manifest_generator or PlatformTerraformManifestGenerator(
+            FileProvider()
+        )
 
-    def generate(self, name, terraform_platform_modules_version):
-        config = self.config_provider.load_and_validate_platform_config()
-        enriched_config = self.config_provider.apply_environment_defaults(config)
+    def generate(self, environment_name, terraform_platform_modules_version_override=None):
+        config = self.config_provider.get_enriched_config()
+
+        manifest = self.manifest_generator.generate_manifest(
+            environment_name=environment_name,
+            application_name=config["application"],
+            environment_config=config["environments"][environment_name],
+            terraform_platform_modules_version_override=terraform_platform_modules_version_override,
+        )
 
-        env_config = enriched_config["environments"][name]
-        _generate_terraform_environment_manifests(
-            config["application"], name, env_config, terraform_platform_modules_version
+        self.echo(
+            self.manifest_generator.write_manifest(
+                environment_name=environment_name, manifest_content=manifest
+            )
         )

dbt_platform_helper/domain/test_platform_terraform_manifest_generator.py

@@ -0,0 +1,100 @@
+from unittest.mock import Mock
+
+from dbt_platform_helper.constants import DEFAULT_TERRAFORM_PLATFORM_MODULES_VERSION
+from dbt_platform_helper.domain.terraform_environment import (
+    PlatformTerraformManifestGenerator,
+)
+from dbt_platform_helper.providers.files import FileProvider
+
+
+class TestPlatformTerraformManifestGenerator:
+
+    def test_generator_generates_expected_manifest_content_with_version_override(self):
+        test_environment_config = {
+            "vpc": "vpc3",
+            "accounts": {
+                "deploy": {"name": "non-prod-acc", "id": "1122334455"},
+                "dns": {"name": "non-prod-dns-acc", "id": "6677889900"},
+            },
+            "versions": {"terraform-platform-modules": 3},
+        }
+        expected_header = "# WARNING: This is an autogenerated file, not for manual editing."
+        expected_modules = "git::https://github.com/uktrade/terraform-platform-modules.git//extensions?depth=1&ref=123456"
+        expected_moved_block = (
+            "moved {\n  from = module.extensions-tf\n  to   = module.extensions\n}\n"
+        )
+
+        result = PlatformTerraformManifestGenerator(Mock()).generate_manifest(
+            "test", "test-app", test_environment_config, 123456
+        )
+
+        assert expected_header in result
+        assert expected_modules in result
+        assert expected_moved_block in result
+        assert 'environment = "test"' in result
+        assert 'application    = "test-app"' in result
+        assert 'vpc_name    = "vpc3"'
+
+    def test_generator_generates_expected_manifest_content_with_tpm_version_set_in_config(self):
+        test_environment_config = {
+            "vpc": "vpc3",
+            "accounts": {
+                "deploy": {"name": "non-prod-acc", "id": "1122334455"},
+                "dns": {"name": "non-prod-dns-acc", "id": "6677889900"},
+            },
+            "versions": {"terraform-platform-modules": 3},
+        }
+        expected_header = "# WARNING: This is an autogenerated file, not for manual editing."
+        expected_modules = "git::https://github.com/uktrade/terraform-platform-modules.git//extensions?depth=1&ref=3"
+        expected_moved_block = (
+            "moved {\n  from = module.extensions-tf\n  to   = module.extensions\n}\n"
+        )
+
+        result = PlatformTerraformManifestGenerator(Mock()).generate_manifest(
+            "test", "test-app", test_environment_config
+        )
+
+        assert expected_header in result
+        assert expected_modules in result
+        assert expected_moved_block in result
+        assert 'environment = "test"' in result
+        assert 'application    = "test-app"' in result
+        assert 'vpc_name    = "vpc3"'
+
+    def test_generator_generates_expected_manifest_content_with_default_version(self):
+        test_environment_config = {
+            "vpc": "vpc3",
+            "accounts": {
+                "deploy": {"name": "non-prod-acc", "id": "1122334455"},
+                "dns": {"name": "non-prod-dns-acc", "id": "6677889900"},
+            },
+        }
+        expected_header = "# WARNING: This is an autogenerated file, not for manual editing."
+        expected_modules = f"git::https://github.com/uktrade/terraform-platform-modules.git//extensions?depth=1&ref={DEFAULT_TERRAFORM_PLATFORM_MODULES_VERSION}"
+        expected_moved_block = (
+            "moved {\n  from = module.extensions-tf\n  to   = module.extensions\n}\n"
+        )
+
+        result = PlatformTerraformManifestGenerator(Mock()).generate_manifest(
+            "test", "test-app", test_environment_config
+        )
+
+        assert expected_header in result
+        assert expected_modules in result
+        assert expected_moved_block in result
+        assert 'environment = "test"' in result
+        assert 'application    = "test-app"' in result
+        assert 'vpc_name    = "vpc3"'
+
+    def test_generator_write_manifest_makes_the_expected_manifest_file(self):
+        mock_file_provider = Mock(spec=FileProvider)
+        PlatformTerraformManifestGenerator(mock_file_provider).write_manifest(
+            "test-environment", "test-manifest-content"
+        )
+
+        mock_file_provider.mkfile.assert_called_once_with(
+            ".",
+            f"terraform/environments/test-environment/main.tf",
+            "test-manifest-content",
+            overwrite=True,
+        )

dbt_platform_helper/providers/cache.py

@@ -1,14 +1,13 @@
 import os
 from datetime import datetime
 
-from dbt_platform_helper.providers.yaml_file import FileProvider
 from dbt_platform_helper.providers.yaml_file import YamlFileProvider
 
 
 class CacheProvider:
     def __init__(
         self,
-        file_provider: FileProvider = None,
+        file_provider: YamlFileProvider = None,
     ):
         self._cache_file = ".platform-helper-config-cache.yml"
         self.file_provider = file_provider or YamlFileProvider