Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: TF_CLI_ARGS_* Handling #898

Merged
merged 19 commits into from
Jan 7, 2025
Merged

feat: TF_CLI_ARGS_* Handling #898

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
d9b0d2d
added warning message when TF_CLI var-file specified
milldr Dec 27, 2024
42c3026
Merge branch 'main' into feat/DEV-2793_dont-squash-tfcli
milldr Dec 27, 2024
ec5dce2
Merge branch 'main' into feat/DEV-2793_dont-squash-tfcli
milldr Jan 2, 2025
0cbee45
Refactor handling of Terraform environment variables
milldr Jan 2, 2025
971be07
Update handling of Terraform environment variables
milldr Jan 2, 2025
b8245ca
Apply suggestions from code review
milldr Jan 3, 2025
a9969ad
Update internal/exec/shell_utils.go
milldr Jan 3, 2025
a496cb3
Merge branch 'main' into feat/DEV-2793_dont-squash-tfcli
milldr Jan 6, 2025
d110e6a
Merge branch 'main' into feat/DEV-2793_dont-squash-tfcli
milldr Jan 6, 2025
1851b82
Merge branch 'main' into feat/DEV-2793_dont-squash-tfcli
osterman Jan 7, 2025
1aaaf05
Merge branch 'main' into feat/DEV-2793_dont-squash-tfcli
milldr Jan 7, 2025
4502ccc
Merge environment variables in shell command
milldr Jan 7, 2025
b8c2511
Merge branch 'feat/DEV-2793_dont-squash-tfcli' of github.com:cloudpos…
milldr Jan 7, 2025
5bf487c
Update internal/exec/shell_utils.go
milldr Jan 7, 2025
62c4809
Update mergeEnvVars function to handle conflicts
milldr Jan 7, 2025
cb9cf64
Merge branch 'feat/DEV-2793_dont-squash-tfcli' of github.com:cloudpos…
milldr Jan 7, 2025
af8138f
fix indentation
milldr Jan 7, 2025
4587133
Merge branch 'main' into feat/DEV-2793_dont-squash-tfcli
aknysh Jan 7, 2025
accde7a
combine TF_CLI handling with single function
milldr Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions internal/exec/shell_utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,13 +227,22 @@ func execTerraformShellCommand(
}
}()

// Set the Terraform environment variables to reference the var file
componentEnvList = append(componentEnvList, fmt.Sprintf("TF_CLI_ARGS_plan=-var-file=%s", varFile))
componentEnvList = append(componentEnvList, fmt.Sprintf("TF_CLI_ARGS_apply=-var-file=%s", varFile))
componentEnvList = append(componentEnvList, fmt.Sprintf("TF_CLI_ARGS_refresh=-var-file=%s", varFile))
componentEnvList = append(componentEnvList, fmt.Sprintf("TF_CLI_ARGS_import=-var-file=%s", varFile))
componentEnvList = append(componentEnvList, fmt.Sprintf("TF_CLI_ARGS_destroy=-var-file=%s", varFile))
componentEnvList = append(componentEnvList, fmt.Sprintf("TF_CLI_ARGS_console=-var-file=%s", varFile))
// Define the Terraform commands that may use var-file configuration
tfCommands := []string{"plan", "apply", "refresh", "import", "destroy", "console"}

// Check for existing var-file arguments in TF_CLI environment variables
for _, cmd := range tfCommands {
envVar := fmt.Sprintf("TF_CLI_ARGS_%s", cmd)
existing := os.Getenv(envVar)
if existing != "" {
u.LogWarning(atmosConfig, fmt.Sprintf("detected '%s' set in the environment; this may interfere with Atmos's control of Terraform.", envVar))
// Create new value by combining existing and new var-file argument
newValue := fmt.Sprintf("\"%s -var-file=%s\"", existing, varFile)
componentEnvList = append(componentEnvList, fmt.Sprintf("%s=%s", envVar, newValue))
} else {
componentEnvList = append(componentEnvList, fmt.Sprintf("%s=-var-file=%s", envVar, varFile))
}
}
milldr marked this conversation as resolved.
Show resolved Hide resolved

// Set environment variables to indicate the details of the Atmos shell configuration
componentEnvList = append(componentEnvList, fmt.Sprintf("ATMOS_STACK=%s", stack))
Expand Down Expand Up @@ -277,7 +286,7 @@ func execTerraformShellCommand(
pa := os.ProcAttr{
Files: []*os.File{os.Stdin, os.Stdout, os.Stderr},
Dir: componentPath,
Env: append(os.Environ(), componentEnvList...),
Env: append(componentEnvList, os.Environ()...), // Give priority to Atmos defined env vars
osterman marked this conversation as resolved.
Show resolved Hide resolved
}

// Start a new shell
Expand Down
8 changes: 8 additions & 0 deletions internal/exec/terraform.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,14 @@ func ExecuteTerraform(info schema.ConfigAndStacksInfo) error {
}
}

// Check for any Terraform environment variables that might conflict with Atmos
for _, envVar := range os.Environ() {
if strings.HasPrefix(envVar, "TF_") {
varName := strings.Split(envVar, "=")[0]
milldr marked this conversation as resolved.
Show resolved Hide resolved
u.LogWarning(atmosConfig, fmt.Sprintf("detected '%s' set in the environment; this may interfere with Atmos's control of Terraform.", varName))
}
}

// Set `TF_IN_AUTOMATION` ENV var to `true` to suppress verbose instructions after terraform commands
// https://developer.hashicorp.com/terraform/cli/config/environment-variables#tf_in_automation
info.ComponentEnvList = append(info.ComponentEnvList, "TF_IN_AUTOMATION=true")
Expand Down
Loading