refactor: DBTP-1630 Terraform environment domain tests refactor #715

DeveloperConnor · 2025-01-10T14:39:39Z

Addresses DBTP-1630

Moves manifest writing and generating into a ManifestGenerator class
Implements FileProvider and moves files mkfile utility into it
Moves environment terraform-generate tests out of _legacy tests file and into domain tests with ManifestGenerator mocking, decoupling domain from click
removes deprecated vpc-name flag and logic
add handling for EnvironmentNotFoundException (previously led to stack trace in cli)
removes obsolete get_environment_pipeline_names function and tests

Checklist:

Title:

Scope included as per conventional commits
Ticket reference included (unless it's a quick out of ticket thing)

Description:

Link to ticket included (unless it's a quick out of ticket thing)
Includes tests (or an explanation for why it doesn't)
If the work includes user interface changes, before and after screenshots included in description
Includes any applicable changes to the documentation in this code base
Includes link(s) to any applicable changes to the documentation in the DBT Platform Documentation (can be to a pull request)

Tasks:

Run the end to end tests for this branch and confirm that they are passing

DeveloperConnor · 2025-01-10T14:41:13Z

dbt_platform_helper/commands/environment.py

-            fg="red",
-        )
-        raise click.Abort
+def generate(name):


Removed the deprecation warning when providing a vpc to generate-terraform - its been here for 7months now, seems like no one should be impacted /shrug

dbt_platform_helper/domain/terraform_environment.py

tests/platform_helper/providers/test_config.py

dbt_platform_helper/domain/test_platform_terraform_manifest_generator.py

a-gleeson · 2025-01-13T13:18:02Z

dbt_platform_helper/domain/terraform_environment.py

-):
-    env_template = setup_templates().get_template("environments/main.tf")
+class PlatformTerraformManifestGenerator:
+    def __init__(self, file_provider):


missing type hints?

a-gleeson · 2025-01-13T13:18:09Z

dbt_platform_helper/domain/terraform_environment.py

-    def __init__(self, config_provider):
+    def __init__(
+        self,
+        config_provider,


missing type hints?

DeveloperConnor · 2025-01-13T16:15:26Z

dbt_platform_helper/domain/terraform_environment.py

+            }
+        )
+
+    def write_manifest(self, environment_name: str, manifest_content: str):


This should prob be a private method?

a-gleeson · 2025-01-13T16:15:44Z

dbt_platform_helper/domain/terraform_environment.py

+        application_name: str,
+        environment_config: dict,
+        terraform_platform_modules_version_override: str = None,
+    ):


return value?

tony-griffin · 2025-01-14T09:07:11Z

dbt_platform_helper/providers/cache.py

 from dbt_platform_helper.providers.yaml_file import YamlFileProvider


 class CacheProvider:
    def __init__(
        self,
-        file_provider: FileProvider = None,
+        file_provider: YamlFileProvider = None,


At what point do we create the ".platform-helper-config-cache.yml" file?

ksugden and others added 24 commits January 9, 2025 12:22

Add command level test for without the version flag

fd35780

Refactor parameter names and tidy test pydocs

d47c6ad

Add test for warning on deprecated flag

c673198

Remove test covered in test_command_environment.py

c5239a0

DBTP-1630 remove --vpc flag depreaction warning and tests

2bc06c6

first pass at moving files methods into FilesProvider

96c03db

add TODO

cf8adf6

separate manifest generation from file writing

46d6e19

Move private methods inside the class

078b792

inline a bunch of stuff

05dbbd3

inline more stuff

6c7ec8c

inline it all!

58695dd

Add PlatformTerraformManifestGenerator class

03fc0d3

remove print

456ae88

add tests for generate_manifest

543f1d7

use PlatformTerraformManifestGenerator in generate function

2b188f9

Add file provider dependency for writing manifest file

11c8d38

inline environment_config

54fec1a

Add further assertions on the expected manifest content

ee4b436

add get_enriched_config function

53cbcb3

Add comments

c924ec3

move get_enriched_config into config provider

03e9603

fixes order of parameters

9673547

added assertions on write_manifest and echo_fn in terraform_generate

95f93de

DeveloperConnor requested a review from a team as a code owner January 10, 2025 14:39

DeveloperConnor commented Jan 10, 2025

View reviewed changes

DeveloperConnor and others added 4 commits January 10, 2025 14:46

Merge branch 'main' into DBTP-1630-terraform-environment-tests

e03a3ce

Add todo

4000135

remove obsolete test

bb17344

Adds exception for generate called on non existent env

42ff1b5

ksugden added 3 commits January 10, 2025 16:11

Add todo for redundant exception handling

e51456b

remove obsolete function

828ddaa

Corrects invalid modules version format

4a7b6d2

ksugden reviewed Jan 13, 2025

View reviewed changes

dbt_platform_helper/domain/terraform_environment.py Outdated Show resolved Hide resolved

ksugden reviewed Jan 13, 2025

View reviewed changes

tests/platform_helper/providers/test_config.py Outdated Show resolved Hide resolved

ksugden reviewed Jan 13, 2025

View reviewed changes

dbt_platform_helper/domain/test_platform_terraform_manifest_generator.py Outdated Show resolved Hide resolved

ksugden added 2 commits January 13, 2025 11:17

Correct typo

87ed0ad

Remove _fn suffix

7a199b7

a-gleeson reviewed Jan 13, 2025

View reviewed changes

ksugden force-pushed the DBTP-1630-terraform-environment-tests branch from 3c7d315 to 7a199b7 Compare January 13, 2025 13:37

DeveloperConnor commented Jan 13, 2025

View reviewed changes

a-gleeson reviewed Jan 13, 2025

View reviewed changes

tony-griffin reviewed Jan 14, 2025

View reviewed changes

Merge branch 'main' into DBTP-1630-terraform-environment-tests

b1e6a5d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: DBTP-1630 Terraform environment domain tests refactor #715

refactor: DBTP-1630 Terraform environment domain tests refactor #715

DeveloperConnor commented Jan 10, 2025 •

edited by ksugden

Loading

DeveloperConnor Jan 10, 2025

a-gleeson Jan 13, 2025

a-gleeson Jan 13, 2025

DeveloperConnor Jan 13, 2025

a-gleeson Jan 13, 2025

tony-griffin Jan 14, 2025

refactor: DBTP-1630 Terraform environment domain tests refactor #715

Are you sure you want to change the base?

refactor: DBTP-1630 Terraform environment domain tests refactor #715

Conversation

DeveloperConnor commented Jan 10, 2025 • edited by ksugden Loading

Checklist:

Title:

Description:

Tasks:

DeveloperConnor Jan 10, 2025

Choose a reason for hiding this comment

a-gleeson Jan 13, 2025

Choose a reason for hiding this comment

a-gleeson Jan 13, 2025

Choose a reason for hiding this comment

DeveloperConnor Jan 13, 2025

Choose a reason for hiding this comment

a-gleeson Jan 13, 2025

Choose a reason for hiding this comment

tony-griffin Jan 14, 2025

Choose a reason for hiding this comment

DeveloperConnor commented Jan 10, 2025 •

edited by ksugden

Loading