feat: add dependency on modules invocation (#283)

* chore: add dependency on modules invocation * feat: add depends on for module array * fix: remove unnecessary ModuleDependsOn * fix: drop DependsOn
vincenthsh · Apr 23, 2024 · aef1949 · aef1949
1 parent 37611ae
commit aef1949
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 0 deletions.
diff --git a/apply/apply.go b/apply/apply.go
@@ -607,6 +607,7 @@ type moduleData struct {
 	Outputs                    []*tfconfig.Output
 	IntegrationRegistryEntries []*IntegrationRegistryEntry
 	ProvidersMap               map[string]string
+	DependsOn                  []string
 }
 
 type IntegrationRegistryEntry struct {
@@ -738,6 +739,7 @@ func applyModuleInvocation(
 			Outputs:                    outputs,
 			IntegrationRegistryEntries: integrationRegistryEntries,
 			ProvidersMap:               mi.module.ProvidersMap,
+			DependsOn:                  mi.module.DependsOn,
 		})
 	}
 

diff --git a/config/v2/config.go b/config/v2/config.go
@@ -260,6 +260,8 @@ type ComponentModule struct {
 	ProvidersMap map[string]string `yaml:"providers,omitempty"`
 	// For Each metadata argument https://developer.hashicorp.com/terraform/language/modules/syntax#meta-arguments
 	ForEach *string `yaml:"for_each,omitempty"`
+	// Dependencies of this module
+	DependsOn []string `yaml:"depends_on,omitempty"`
 }
 
 type ModuleIntegrationConfig struct {

diff --git a/templates/templates/module-invocation/main.tf.tmpl b/templates/templates/module-invocation/main.tf.tmpl
@@ -24,5 +24,13 @@ module "{{.ModuleName}}" {
   {{- end}}
   }
   {{- end }}
+
+  {{- if .DependsOn }}
+  depends_on = [
+  {{- range .DependsOn }}
+    module.{{ . }},
+  {{- end }}
+  ]
+  {{- end }}
 }
 {{ end }}
diff --git a/testdata/v2_atlantis_depends_on/fogg.yml b/testdata/v2_atlantis_depends_on/fogg.yml
@@ -45,7 +45,13 @@ envs:
               - tags
               - banana
           - source: "terraform/modules/my_module"
+            name: "my_module"
+            depends_on: 
+              - "vpc"
           - source: "foo_modules/bar"
+            depends_on:
+              - "vpc"
+              - "my_module"
       db:
         depends_on:
           components:

diff --git a/testdata/v2_atlantis_depends_on/terraform/envs/test/vpc/main.tf b/testdata/v2_atlantis_depends_on/terraform/envs/test/vpc/main.tf
@@ -15,8 +15,15 @@ module "vpc" {
 
 module "my_module" {
   source = "../../../modules/my_module"
+  depends_on = [
+    module.vpc,
+  ]
 }
 
 module "bar" {
   source = "../../../../foo_modules/bar"
+  depends_on = [
+    module.vpc,
+    module.my_module,
+  ]
 }