fix: terraform_binary with run version command (#4095)

Author: lev-ok

cli/commands/run/run.go

@@ -85,16 +85,16 @@ func Run(ctx context.Context, opts *options.TerragruntOptions) error {
 		return errors.New(MissingCommand{})
 	}
 
-	return runTerraform(ctx, opts, new(Target))
+	return run(ctx, opts, new(Target))
 }
 
 func RunWithTarget(ctx context.Context, opts *options.TerragruntOptions, target *Target) error {
-	return runTerraform(ctx, opts, target)
+	return run(ctx, opts, target)
 }
 
-func runTerraform(ctx context.Context, terragruntOptions *options.TerragruntOptions, target *Target) error {
+func run(ctx context.Context, terragruntOptions *options.TerragruntOptions, target *Target) error {
 	if terragruntOptions.TerraformCommand == tf.CommandNameVersion {
-		return tf.RunCommand(ctx, terragruntOptions, tf.CommandNameVersion)
+		return runVersionCommand(ctx, terragruntOptions)
 	}
 
 	// We need to get the credentials from auth-provider-cmd at the very beginning, since the locals block may contain `get_aws_account_id()` func.
@@ -907,3 +907,15 @@ func setTerragruntNullValues(terragruntOptions *options.TerragruntOptions, terra
 func useLegacyNullValues() bool {
 	return os.Getenv(useLegacyNullValuesEnvVar) == "1"
 }
+
+func getTerragruntConfig(ctx context.Context, opts *options.TerragruntOptions) (*config.TerragruntConfig, error) {
+	configCtx := config.NewParsingContext(ctx, opts).WithDecodeList(
+		config.TerragruntVersionConstraints, config.FeatureFlagsBlock)
+
+	// TODO: See if we should be ignore this lint error
+	return config.PartialParseConfigFile( //nolint: contextcheck
+		configCtx,
+		opts.TerragruntConfigPath,
+		nil,
+	)
+}

cli/commands/run/version_check.go

@@ -7,7 +7,6 @@ import (
 	"regexp"
 	"strings"
 
-	"github.com/gruntwork-io/terragrunt/config"
 	"github.com/gruntwork-io/terragrunt/internal/errors"
 	"github.com/gruntwork-io/terragrunt/options"
 	"github.com/gruntwork-io/terragrunt/tf"
@@ -35,15 +34,7 @@ const versionParts = 3
 // - FeatureFlags
 // TODO: Look into a way to refactor this function to avoid the side effect.
 func CheckVersionConstraints(ctx context.Context, terragruntOptions *options.TerragruntOptions) error {
-	configContext := config.NewParsingContext(ctx, terragruntOptions).WithDecodeList(
-		config.TerragruntVersionConstraints, config.FeatureFlagsBlock)
-
-	// TODO: See if we should be ignore this lint error
-	partialTerragruntConfig, err := config.PartialParseConfigFile( //nolint: contextcheck
-		configContext,
-		terragruntOptions.TerragruntConfigPath,
-		nil,
-	)
+	partialTerragruntConfig, err := getTerragruntConfig(ctx, terragruntOptions)
 	if err != nil {
 		return err
 	}

cli/commands/run/version_command.go

@@ -0,0 +1,34 @@
+package run
+
+import (
+	"context"
+
+	"github.com/gruntwork-io/terragrunt/options"
+	"github.com/gruntwork-io/terragrunt/tf"
+	"github.com/gruntwork-io/terragrunt/util"
+)
+
+func runVersionCommand(ctx context.Context, opts *options.TerragruntOptions) error {
+	if tfPath, err := getTfPathFromConfig(ctx, opts); err != nil {
+		return err
+	} else if tfPath != "" {
+		opts.TerraformPath = tfPath
+	}
+
+	return tf.RunCommand(ctx, opts, tf.CommandNameVersion)
+}
+
+func getTfPathFromConfig(ctx context.Context, opts *options.TerragruntOptions) (string, error) {
+	if !util.FileExists(opts.TerragruntConfigPath) {
+		opts.Logger.Debugf("Did not find the config file %s", opts.TerragruntConfigPath)
+
+		return "", nil
+	}
+
+	cfg, err := getTerragruntConfig(ctx, opts)
+	if err != nil {
+		return "", err
+	}
+
+	return cfg.TerraformBinary, nil
+}

test/fixtures/tf-path/main.tf

@@ -0,0 +1 @@
+# Intentionally empty

test/fixtures/tf-path/terragrunt.hcl

@@ -0,0 +1,2 @@
+# We can't explicitly specify `tofu` or `terraform` because a CircleCI job contains either `terraform` or `tofu` binary, but not both in the same job.
+terraform_binary = "./tf.sh"

test/fixtures/tf-path/tf.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+tfpath="${TG_TF_PATH:-tofu}"
+
+$tfpath "$@"

test/integration_test.go

@@ -111,6 +111,7 @@ const (
 	testFixtureLogStreaming                   = "fixtures/streaming"
 	testFixtureCLIFlagHints                   = "fixtures/cli-flag-hints"
 	testFixtureEphemeralInputs                = "fixtures/ephemeral-inputs"
+	testFixtureTfPath                         = "fixtures/tf-path"
 
 	terraformFolder = ".terraform"
 
@@ -1067,6 +1068,10 @@ func TestTerraformCommandCliArgs(t *testing.T) {
 		expected    string
 		command     []string
 	}{
+		{
+			command:  []string{"version"},
+			expected: wrappedBinary() + " version",
+		},
 		{
 			command:  []string{"--", "version"},
 			expected: wrappedBinary() + " version",
@@ -4173,3 +4178,19 @@ func TestTF110EphemeralVars(t *testing.T) {
 	require.NoError(t, err)
 	assert.Contains(t, stdout, "Apply complete! Resources: 1 added, 0 changed, 0 destroyed")
 }
+
+func TestTfPath(t *testing.T) {
+	t.Parallel()
+	// Test that the terragrunt run version command correctly identifies and uses
+	// the terraform_binary path configuration if present
+	helpers.CleanupTerraformFolder(t, testFixtureTfPath)
+	rootPath := helpers.CopyEnvironment(t, testFixtureTfPath)
+	workingDir := util.JoinPath(rootPath, testFixtureTfPath)
+	workingDir, err := filepath.EvalSymlinks(workingDir)
+	require.NoError(t, err)
+
+	stdout, stderr, err := helpers.RunTerragruntCommandWithOutput(t, "terragrunt run version --experiment cli-redesign --working-dir "+workingDir)
+	require.NoError(t, err)
+
+	assert.Regexp(t, "(?i)(terraform|opentofu)", stdout+stderr)
+}