feat: Add Terraform streaming UI with real-time visualization #1908

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.

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

Open

osterman wants to merge 42 commits into main from osterman/terraform-streaming-ui

.gitignore

-Original file line number
+Diff line change
@@ Expand Up / @@ -5,6 +5,7 @@ @@
     **/*.tf.json
     **/planfile
     **/*.planfile
+    **/.atmos-*.tfplan
     **/*.kubeconfig
     **/terraform.tfvars.json
     **/helmfile.vars.yaml
@@ Expand Down @@

cmd/terraform/apply.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -34,8 +34,8 @@ For complete Terraform/OpenTofu documentation, see: @@
     			return err
     		}
-    		// Parse base terraform options.
-    		opts := ParseTerraformRunOptions(v)
+    		// Parse base terraform options with command context for UI flag detection.
+    		opts := ParseTerraformRunOptions(v, cmd)
     		// Apply-specific flags (from-plan, planfile) flow through the
     		// legacy ProcessCommandLineArgs which sets info.UseTerraformPlan, info.PlanFile.
@@ Expand Down @@

cmd/terraform/deploy.go

-Original file line number
+Diff line change
@@ Expand Up @@
     			return err
     		}
-    		// Parse base terraform options.
-    		opts := ParseTerraformRunOptions(v)
+    		// Parse base terraform options with command context for UI flag detection.
+    		opts := ParseTerraformRunOptions(v, cmd)
     		// Deploy-specific flags (deploy-run-init, from-plan, planfile) flow through
     		// the legacy ProcessCommandLineArgs which sets info.DeployRunInit, etc.
@@ Expand Down @@

cmd/terraform/flags.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -62,6 +62,13 @@ func registerExecutionFlags(registry *flags.FlagRegistry) { @@
     		Description: "Customize User-Agent string in Terraform provider requests (sets TF_APPEND_USER_AGENT)",
     		EnvVars:     []string{"ATMOS_APPEND_USER_AGENT"},
     	})
+    	registry.Register(&flags.BoolFlag{
+    		Name:        "ui",
+    		Shorthand:   "",
+    		Default:     false,
+    		Description: "Enable streaming UI mode for real-time resource status display",
+    		EnvVars:     []string{"ATMOS_TERRAFORM_UI"},
+    	})
     }
     // BackendExecutionFlags returns flags for commands that generate backend files or run init.
@@ Expand Down @@

cmd/terraform/init.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -34,8 +34,8 @@ For complete Terraform/OpenTofu documentation, see: @@
     			return err
     		}
-    		// Parse base terraform options.
-    		opts := ParseTerraformRunOptions(v)
+    		// Parse base terraform options with command context for UI flag detection.
+    		opts := ParseTerraformRunOptions(v, cmd)
     		return terraformRunWithOptions(terraformCmd, cmd, args, opts)
     	},
@@ Expand Down @@

cmd/terraform/options.go

-Original file line number
+Diff line change
@@ -1,6 +1,7 @@
     package terraform
     import (
+    	"github.com/spf13/cobra"
     	"github.com/spf13/viper"
     	"github.com/cloudposse/atmos/pkg/perf"
@@ Expand Down Expand Up / @@ -33,13 +34,19 @@ type TerraformRunOptions struct { @@
     	Components []string
     	All        bool
     	Affected   bool
+    	// UI flags.
+    	UI        bool // Enable streaming UI mode.
+    	UIFlagSet bool // Whether --ui flag was explicitly set.
     }
     // ParseTerraformRunOptions parses shared terraform flags from Viper.
-    func ParseTerraformRunOptions(v *viper.Viper) *TerraformRunOptions {
+    // Pass cmd to detect if --ui flag was explicitly set (for tri-state logic).
+    // If cmd is nil, UIFlagSet will be false.
+    func ParseTerraformRunOptions(v *viper.Viper, cmd *cobra.Command) *TerraformRunOptions {
     	defer perf.Track(nil, "terraform.ParseTerraformRunOptions")()
-    	return &TerraformRunOptions{
+    	opts := &TerraformRunOptions{
     		ProcessTemplates:        v.GetBool("process-templates"),
     		ProcessFunctions:        v.GetBool("process-functions"),
     		Skip:                    v.GetStringSlice("skip"),
@@ Expand All @@
     		Components:              v.GetStringSlice("components"),
     		All:                     v.GetBool("all"),
     		Affected:                v.GetBool("affected"),
+    		UI:                      v.GetBool("ui"),
+    	}
+    	// Check if --ui flag was explicitly set (for tri-state: unset vs true vs false).
+    	if cmd != nil && cmd.Flags().Changed("ui") {
+    		opts.UIFlagSet = true
     	}
+    	return opts
     }

cmd/terraform/options_test.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -233,7 +233,7 @@ func TestParseTerraformRunOptions(t *testing.T) { @@
     			v := viper.New()
     			tt.setup(v)
-    			result := ParseTerraformRunOptions(v)
+    			result := ParseTerraformRunOptions(v, nil)
     			assert.Equal(t, tt.expected.ProcessTemplates, result.ProcessTemplates, "ProcessTemplates should match")
     			assert.Equal(t, tt.expected.ProcessFunctions, result.ProcessFunctions, "ProcessFunctions should match")
@@ Expand Down @@

cmd/terraform/plan.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -33,8 +33,8 @@ For complete Terraform/OpenTofu documentation, see: @@
     			return err
     		}
-    		// Parse base terraform options.
-    		opts := ParseTerraformRunOptions(v)
+    		// Parse base terraform options with command context for UI flag detection.
+    		opts := ParseTerraformRunOptions(v, cmd)
     		// Plan-specific flags (upload-status, skip-planfile) flow through the
     		// legacy ProcessCommandLineArgs which sets info.PlanSkipPlanfile.
@@ Expand Down @@

cmd/terraform/refresh.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,10 +2,15 @@ package terraform @@
     import (
     	"github.com/spf13/cobra"
+    	"github.com/spf13/viper"
     	"github.com/cloudposse/atmos/cmd/internal"
+    	"github.com/cloudposse/atmos/pkg/flags"
     )
+    // refreshParser handles flag parsing for refresh command.
+    var refreshParser *flags.StandardParser
     // refreshCmd represents the terraform refresh command.
     var refreshCmd = &cobra.Command{
     	Use:   "refresh",
@@ Expand All / @@ -16,11 +21,37 @@ For complete Terraform/OpenTofu documentation, see: @@
       https://developer.hashicorp.com/terraform/cli/commands/refresh
       https://opentofu.org/docs/cli/commands/refresh`,
     	RunE: func(cmd *cobra.Command, args []string) error {
-    		return terraformRun(terraformCmd, cmd, args)
+    		v := viper.GetViper()
+    		// Bind both parent and subcommand parsers.
+    		if err := terraformParser.BindFlagsToViper(cmd, v); err != nil {
+    			return err
+    		}
+    		if err := refreshParser.BindFlagsToViper(cmd, v); err != nil {
+    			return err
+    		}
+    		// Parse base terraform options with command context for UI flag detection.
+    		opts := ParseTerraformRunOptions(v, cmd)
+    		return terraformRunWithOptions(terraformCmd, cmd, args, opts)
     	},
     }
     func init() {
+    	// Create parser with refresh-specific flags (backend execution for init).
+    	refreshParser = flags.NewStandardParser(
+    		WithBackendExecutionFlags(),
+    	)
+    	// Register refresh-specific flags with Cobra.
+    	refreshParser.RegisterFlags(refreshCmd)
+    	// Bind flags to Viper for environment variable support.
+    	if err := refreshParser.BindToViper(viper.GetViper()); err != nil {
+    		panic(err)
+    	}
     	// Register completions for refreshCmd.
     	RegisterTerraformCompletions(refreshCmd)
@@ Expand Down @@

cmd/terraform/subcommands_test.go

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -173,7 +173,7 @@ func TestSubcommandParseOptions(t *testing.T) {
  
    			v.Set("skip-init", tc.skipInitVal)

    			v.Set("dry-run", true)

    			opts := ParseTerraformRunOptions(v)

    			opts := ParseTerraformRunOptions(v, nil)

    			assert.Equal(t, tc.backendFileVal, opts.AutoGenerateBackendFile)

    			assert.Equal(t, tc.reconfigureVal, opts.InitRunReconfigure)

    @@ -223,7 +223,7 @@ func TestSubcommandRunEFlagBinding(t *testing.T) {
  
    			require.NoError(t, err, "%sParser.BindFlagsToViper should succeed", tc.name)

    			// Parse options (simulating what RunE does).

    			opts := ParseTerraformRunOptions(v)

    			opts := ParseTerraformRunOptions(v, testCmd)

    			// Verify the options were parsed correctly.

    			assert.Equal(t, tc.backendFileVal, opts.AutoGenerateBackendFile)

    @@ -255,7 +255,7 @@ func TestSubcommandRunEWithDryRun(t *testing.T) {
  
    			require.NoError(t, err)

    			// Parse options.

    			opts := ParseTerraformRunOptions(v)

    			opts := ParseTerraformRunOptions(v, testCmd)

    			// Verify the flag binding and parsing worked correctly.

    			assert.True(t, opts.DryRun)

cmd/terraform/utils.go

-Original file line number
+Diff line change
@@ Expand Up @@
     		return err
     	}
-    	opts := ParseTerraformRunOptions(v)
+    	opts := ParseTerraformRunOptions(v, actualCmd)
     	return terraformRunWithOptions(parentCmd, actualCmd, args, opts)
     }
@@ Expand Down Expand Up @@
     	if opts.DeployRunInit {
     		info.DeployRunInit = "true"
     	}
+    	// UI flags.
+    	info.UIEnabled = opts.UI
+    	info.UIFlagExplicitlySet = opts.UIFlagSet
     }
     // terraformRunWithOptions is the shared execution logic for terraform subcommands.
@@ Expand Down @@

cmd/terraform/workspace.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -42,7 +42,7 @@ For complete Terraform/OpenTofu documentation, see: @@
     		}
     		// Parse base terraform options.
-    		opts := ParseTerraformRunOptions(v)
+    		opts := ParseTerraformRunOptions(v, cmd)
     		return terraformRunWithOptions(terraformCmd, cmd, args, opts)
     	},
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Add Terraform streaming UI with real-time visualization #1908

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

feat: Add Terraform streaming UI with real-time visualization #1908

Are you sure you want to change the base?

Uh oh!

feat: Add Terraform streaming UI with real-time visualization #1908

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!