Add examples and tests for !include Atmos YAML function

internal/exec/terraform_utils.go

@@ -117,12 +117,14 @@ func generateProviderOverrides(atmosConfig *schema.AtmosConfiguration, info *sch
 // requires the `Go` templates and Atmos YAML functions to be processed
 func needProcessTemplatesAndYamlFunctions(command string) bool {
 	commandsThatNeedFuncProcessing := []string{
+		"init",
 		"plan",
 		"apply",
 		"deploy",
 		"destroy",
 		"generate",
 		"output",
+		"clean",
 		"shell",
 		"write",
 		"force-unlock",

tests/fixtures/components/terraform/yaml-functions/outputs.tf

@@ -0,0 +1,19 @@
+output "string_var" {
+  description = "String output"
+  value       = var.string_var
+}
+
+output "boolean_var" {
+  description = "Boolean output"
+  value       = var.boolean_var
+}
+
+output "list_var" {
+  description = "List output"
+  value       = var.list_var
+}
+
+output "map_var" {
+  description = "Map output"
+  value       = var.map_var
+}

tests/fixtures/components/terraform/yaml-functions/variables.tf

@@ -0,0 +1,28 @@
+variable "stage" {
+  description = "Stage where it will be deployed"
+  type        = string
+}
+
+variable "string_var" {
+  description = "String variable"
+  type        = string
+  default     = "test"
+}
+
+variable "boolean_var" {
+  description = "Boolean variable"
+  type        = bool
+  default     = false
+}
+
+variable "list_var" {
+  description = "List variable"
+  type        = list(string)
+  default     = []
+}
+
+variable "map_var" {
+  description = "Map variable"
+  type        = map(string)
+  default     = {}
+}

tests/fixtures/scenarios/atmos-include-yaml-function/atmos.yaml

@@ -0,0 +1,21 @@
+base_path: "./"
+
+components:
+  terraform:
+    base_path: "../../components/terraform"
+    apply_auto_approve: false
+    deploy_run_init: true
+    init_run_reconfigure: true
+    auto_generate_backend_file: false
+
+stacks:
+  base_path: "stacks"
+  included_paths:
+    - "deploy/**/*"
+  excluded_paths:
+    - "**/_defaults.yaml"
+  name_pattern: "{stage}"
+
+logs:
+  file: "/dev/stderr"
+  level: Info

tests/fixtures/scenarios/atmos-include-yaml-function/stacks/deploy/nonprod.yaml

@@ -0,0 +1,15 @@
+# yaml-language-server: $schema=https://atmos.tools/schemas/atmos/atmos-manifest/1.0/atmos-manifest.json
+
+vars:
+  stage: nonprod
+
+components:
+  terraform:
+    component-1:
+      metadata:
+        component: yaml-functions
+      vars:
+        string_var: !include stacks/mixins/vars.json .string_var
+        boolean_var: !include stacks/mixins/vars.yaml .boolean_var
+        list_var: !include stacks/mixins/vars.tfvars .list_var
+        map_var: !include stacks/mixins/vars.tfvars .map_var

tests/fixtures/scenarios/atmos-include-yaml-function/stacks/mixins/vars.json

@@ -0,0 +1,14 @@
+{
+  "string_var": "abc",
+  "boolean_var": true,
+  "list_var": [
+    "a",
+    "b",
+    "c"
+  ],
+  "map_var": {
+    "a": 1,
+    "b": 2,
+    "c": 3
+  }
+}

tests/fixtures/scenarios/atmos-include-yaml-function/stacks/mixins/vars.tfvars

@@ -0,0 +1,8 @@
+string_var  = "abc"
+boolean_var = true
+list_var    = ["a", "b", "c"]
+map_var = {
+  a = 1
+  b = 2
+  c = 3
+}

tests/fixtures/scenarios/atmos-include-yaml-function/stacks/mixins/vars.yaml

@@ -0,0 +1,10 @@
+string_var: abc
+boolean_var: true
+list_var:
+  - a
+  - b
+  - c
+map_var:
+  a: 1
+  b: 2
+  c: 3

tests/test-cases/atmos-include-yaml-function.yaml

@@ -0,0 +1,21 @@
+tests:
+  - name: "terraform !include function test"
+    enabled: true
+    tty: true
+    clean: true
+    description: "Ensure the !include function works."
+    workdir: "fixtures/scenarios/atmos-include-yaml-function/"
+    command: "atmos"
+    args:
+      - "describe"
+      - "component"
+      - "component-1"
+      - "-s"
+      - "nonprod"
+    expect:
+      exit_code: 0
+      stdout:
+        - "string_var: abc"
+        - "boolean_var: true"
+      stderr:
+        - "^$"