ephemerals: allow root ephemeral outputs in stacks and test (#37813)

liamcervante · web-flow · commit 411f18e6acc9 · 2025-10-28T09:29:44.000+01:00
* ephemerals: allow root ephemeral outputs in stacks and test

* remember to set new opt for apply stage
diff --git a/.changes/v1.14/BUG FIXES-20251024-164434.yaml b/.changes/v1.14/BUG FIXES-20251024-164434.yaml
@@ -0,0 +1,5 @@
+kind: BUG FIXES
+body: 'test: allow ephemeral outputs in root modules'
+time: 2025-10-24T16:44:34.197847+02:00
+custom:
+    Issue: "37813"
diff --git a/.changes/v1.14/BUG FIXES-20251024-164448.yaml b/.changes/v1.14/BUG FIXES-20251024-164448.yaml
@@ -0,0 +1,5 @@
+kind: BUG FIXES
+body: 'stacks: allow ephemeral outputs in root modules'
+time: 2025-10-24T16:44:48.264142+02:00
+custom:
+    Issue: "37813"
diff --git a/internal/command/test_test.go b/internal/command/test_test.go
@@ -409,6 +409,9 @@ func TestTest_Runs(t *testing.T) {
 			expectedOut: []string{"3 passed, 0 failed."},
 			code:        0,
 		},
+		"ephemeral_output": {
+			code: 0,
+		},
 		"no-tests": {
 			code: 0,
 		},
diff --git a/internal/command/testdata/test/ephemeral_output/main.tf b/internal/command/testdata/test/ephemeral_output/main.tf
@@ -0,0 +1,8 @@
+variable "foo" {
+    ephemeral = true
+    type = string
+}
+output "value" {
+  value = var.foo
+  ephemeral = true
+}
diff --git a/internal/command/testdata/test/ephemeral_output/main.tftest.hcl b/internal/command/testdata/test/ephemeral_output/main.tftest.hcl
@@ -0,0 +1,5 @@
+run "validate_ephemeral_input" {
+  variables {
+    foo = "whaaat"
+  }
+}
diff --git a/internal/configs/config.go b/internal/configs/config.go
@@ -1039,6 +1039,9 @@ func (c *Config) EffectiveRequiredProviderConfigs() addrs.Map[addrs.RootProvider
 	for _, rc := range c.Module.Actions {
 		maybePutLocal(rc.ProviderConfigAddr(), false)
 	}
+	for _, rc := range c.Module.EphemeralResources {
+		maybePutLocal(rc.ProviderConfigAddr(), false)
+	}
 	for _, ic := range c.Module.Import {
 		if ic.ProviderConfigRef != nil {
 			maybePutLocal(addrs.LocalProviderConfig{
diff --git a/internal/moduletest/graph/apply.go b/internal/moduletest/graph/apply.go
@@ -154,8 +154,9 @@ func apply(tfCtx *terraform.Context, run *configs.TestRun, module *configs.Confi
 	}
 
 	applyOpts := &terraform.ApplyOpts{
-		SetVariables:      ephemeralVariables,
-		ExternalProviders: providers,
+		SetVariables:              ephemeralVariables,
+		ExternalProviders:         providers,
+		AllowRootEphemeralOutputs: true,
 	}
 
 	waiter.update(tfCtx, progress, created)
diff --git a/internal/moduletest/graph/node_state_cleanup.go b/internal/moduletest/graph/node_state_cleanup.go
@@ -126,13 +126,14 @@ func (n *NodeStateCleanup) restore(ctx *EvalContext, file *configs.TestFile, run
 	setVariables, _, _ := FilterVariablesToModule(module, variables)
 
 	planOpts := &terraform.PlanOpts{
-		Mode:                   plans.NormalMode,
-		SetVariables:           setVariables,
-		Overrides:              mocking.PackageOverrides(run, file, mocks),
-		ExternalProviders:      providers,
-		SkipRefresh:            true,
-		OverridePreventDestroy: true,
-		DeferralAllowed:        ctx.deferralAllowed,
+		Mode:                      plans.NormalMode,
+		SetVariables:              setVariables,
+		Overrides:                 mocking.PackageOverrides(run, file, mocks),
+		ExternalProviders:         providers,
+		SkipRefresh:               true,
+		OverridePreventDestroy:    true,
+		DeferralAllowed:           ctx.deferralAllowed,
+		AllowRootEphemeralOutputs: true,
 	}
 
 	tfCtx, _ := terraform.NewContext(n.opts.ContextOpts)
@@ -177,13 +178,14 @@ func (n *NodeStateCleanup) destroy(ctx *EvalContext, file *configs.TestFile, run
 	setVariables, _, _ := FilterVariablesToModule(module, variables)
 
 	planOpts := &terraform.PlanOpts{
-		Mode:                   plans.DestroyMode,
-		SetVariables:           setVariables,
-		Overrides:              mocking.PackageOverrides(run, file, mocks),
-		ExternalProviders:      providers,
-		SkipRefresh:            true,
-		OverridePreventDestroy: true,
-		DeferralAllowed:        ctx.deferralAllowed,
+		Mode:                      plans.DestroyMode,
+		SetVariables:              setVariables,
+		Overrides:                 mocking.PackageOverrides(run, file, mocks),
+		ExternalProviders:         providers,
+		SkipRefresh:               true,
+		OverridePreventDestroy:    true,
+		DeferralAllowed:           ctx.deferralAllowed,
+		AllowRootEphemeralOutputs: true,
 	}
 
 	tfCtx, _ := terraform.NewContext(n.opts.ContextOpts)
diff --git a/internal/moduletest/graph/node_test_run.go b/internal/moduletest/graph/node_test_run.go
@@ -193,7 +193,8 @@ func (n *NodeTestRun) testValidate(providers map[addrs.RootProviderConfig]provid
 	}
 	waiter.update(tfCtx, moduletest.Running, nil)
 	validateDiags := tfCtx.Validate(config, &terraform.ValidateOpts{
-		ExternalProviders: providers,
+		ExternalProviders:         providers,
+		AllowRootEphemeralOutputs: true,
 	})
 	run.Diagnostics = run.Diagnostics.Append(validateDiags)
 	if validateDiags.HasErrors() {
diff --git a/internal/moduletest/graph/plan.go b/internal/moduletest/graph/plan.go
@@ -127,14 +127,15 @@ func plan(ctx *EvalContext, tfCtx *terraform.Context, file *configs.TestFile, ru
 				return plans.NormalMode
 			}
 		}(),
-		Targets:            targets,
-		ForceReplace:       replaces,
-		SkipRefresh:        !run.Options.Refresh,
-		SetVariables:       variables,
-		ExternalReferences: references,
-		ExternalProviders:  providers,
-		Overrides:          mocking.PackageOverrides(run, file, mocks),
-		DeferralAllowed:    ctx.deferralAllowed,
+		Targets:                   targets,
+		ForceReplace:              replaces,
+		SkipRefresh:               !run.Options.Refresh,
+		SetVariables:              variables,
+		ExternalReferences:        references,
+		ExternalProviders:         providers,
+		Overrides:                 mocking.PackageOverrides(run, file, mocks),
+		DeferralAllowed:           ctx.deferralAllowed,
+		AllowRootEphemeralOutputs: true,
 	}
 
 	waiter.update(tfCtx, moduletest.Running, nil)
diff --git a/internal/stacks/stackruntime/apply_test.go b/internal/stacks/stackruntime/apply_test.go
@@ -2229,6 +2229,69 @@ After applying this plan, Terraform will no longer manage these objects. You wil
 				},
 			},
 		},
+		"ephemeral-module-outputs": {
+			path: "ephemeral-module-output",
+			cycles: []TestCycle{
+				{
+					wantPlannedChanges: []stackplan.PlannedChange{
+						&stackplan.PlannedChangeApplyable{
+							Applyable: true,
+						},
+						&stackplan.PlannedChangeComponentInstance{
+							Addr:                mustAbsComponentInstance("component.ephemeral_in"),
+							PlanApplyable:       false,
+							PlanComplete:        true,
+							Action:              plans.Create,
+							RequiredComponents:  collections.NewSet(mustAbsComponent("component.ephemeral_out")),
+							PlannedInputValues:  make(map[string]plans.DynamicValue),
+							PlannedOutputValues: make(map[string]cty.Value),
+							PlannedCheckResults: new(states.CheckResults),
+							PlanTimestamp:       fakePlanTimestamp,
+						},
+						&stackplan.PlannedChangeComponentInstance{
+							Addr:               mustAbsComponentInstance("component.ephemeral_out"),
+							PlanApplyable:      false,
+							PlanComplete:       true,
+							Action:             plans.Create,
+							PlannedInputValues: make(map[string]plans.DynamicValue),
+							PlannedOutputValues: map[string]cty.Value{
+								"value": cty.DynamicVal, // ephemeral
+							},
+							PlannedCheckResults: new(states.CheckResults),
+							PlanTimestamp:       fakePlanTimestamp,
+						},
+						&stackplan.PlannedChangeHeader{
+							TerraformVersion: version.SemVer,
+						},
+						&stackplan.PlannedChangePlannedTimestamp{
+							PlannedTimestamp: fakePlanTimestamp,
+						},
+					},
+					wantAppliedChanges: []stackstate.AppliedChange{
+						&stackstate.AppliedChangeComponentInstance{
+							ComponentAddr:         mustAbsComponent("component.ephemeral_in"),
+							ComponentInstanceAddr: mustAbsComponentInstance("component.ephemeral_in"),
+							Dependencies: collections.NewSet[stackaddrs.AbsComponent](
+								mustAbsComponent("component.ephemeral_out"),
+							),
+							OutputValues: make(map[addrs.OutputValue]cty.Value),
+							InputVariables: map[addrs.InputVariable]cty.Value{
+								mustInputVariable("input"): cty.UnknownVal(cty.String), // ephemeral
+							},
+						},
+						&stackstate.AppliedChangeComponentInstance{
+							ComponentAddr:         mustAbsComponent("component.ephemeral_out"),
+							ComponentInstanceAddr: mustAbsComponentInstance("component.ephemeral_out"),
+							Dependents: collections.NewSet[stackaddrs.AbsComponent](
+								mustAbsComponent("component.ephemeral_in"),
+							),
+							OutputValues:   make(map[addrs.OutputValue]cty.Value),
+							InputVariables: make(map[addrs.InputVariable]cty.Value),
+						},
+					},
+				},
+			},
+		},
 	}
 
 	for name, tc := range tcs {
diff --git a/internal/stacks/stackruntime/internal/stackeval/component_config.go b/internal/stacks/stackruntime/internal/stackeval/component_config.go
@@ -378,7 +378,8 @@ func (c *ComponentConfig) checkValid(ctx context.Context, phase EvalPhase) tfdia
 		}()
 
 		diags = diags.Append(tfCtx.Validate(moduleTree, &terraform.ValidateOpts{
-			ExternalProviders: providerClients,
+			ExternalProviders:         providerClients,
+			AllowRootEphemeralOutputs: true,
 		}))
 		return diags, nil
 	})
diff --git a/internal/stacks/stackruntime/internal/stackeval/component_instance.go b/internal/stacks/stackruntime/internal/stackeval/component_instance.go
@@ -171,6 +171,8 @@ func (c *ComponentInstance) PlanOpts(ctx context.Context, mode plans.Mode, skipR
 		ExternalProviders:          providerClients,
 		ExternalDependencyDeferred: c.deferred,
 		DeferralAllowed:            true,
+		AllowRootEphemeralOutputs:  true,
+
 		// We want the same plantimestamp between all components and the stacks language
 		ForcePlanTimestamp: &plantimestamp,
 	}, nil
diff --git a/internal/stacks/stackruntime/internal/stackeval/removed_component_config.go b/internal/stacks/stackruntime/internal/stackeval/removed_component_config.go
@@ -196,7 +196,8 @@ func (r *RemovedComponentConfig) CheckValid(ctx context.Context, phase EvalPhase
 		}()
 
 		diags = diags.Append(tfCtx.Validate(moduleTree, &terraform.ValidateOpts{
-			ExternalProviders: providerClients,
+			ExternalProviders:         providerClients,
+			AllowRootEphemeralOutputs: true,
 		}))
 		return diags, nil
 	})
diff --git a/internal/stacks/stackruntime/internal/stackeval/removed_component_instance.go b/internal/stacks/stackruntime/internal/stackeval/removed_component_instance.go
@@ -135,6 +135,7 @@ func (r *RemovedComponentInstance) ModuleTreePlan(ctx context.Context) (*plans.P
 			DeferralAllowed:            true,
 			ExternalDependencyDeferred: deferred,
 			Forget:                     forget,
+			AllowRootEphemeralOutputs:  true,
 
 			// We want the same plantimestamp between all components and the stacks language
 			ForcePlanTimestamp: &plantimestamp,
diff --git a/internal/stacks/stackruntime/testdata/mainbundle/test/ephemeral-module-output/ephemeral-input/ephemeral-input.tf b/internal/stacks/stackruntime/testdata/mainbundle/test/ephemeral-module-output/ephemeral-input/ephemeral-input.tf
@@ -0,0 +1,5 @@
+
+variable "input" {
+  type = string
+  ephemeral = true
+}
diff --git a/internal/stacks/stackruntime/testdata/mainbundle/test/ephemeral-module-output/ephemeral-module-output.tfcomponent.hcl b/internal/stacks/stackruntime/testdata/mainbundle/test/ephemeral-module-output/ephemeral-module-output.tfcomponent.hcl
@@ -0,0 +1,28 @@
+required_providers {
+  testing = {
+    source  = "hashicorp/testing"
+    version = "0.1.0"
+  }
+}
+
+provider "testing" "main" {}
+
+component "ephemeral_out" {
+  source = "./ephemeral-output"
+
+  providers = {
+    testing = provider.testing.main
+  }
+}
+
+component "ephemeral_in" {
+  source = "./ephemeral-input"
+
+  providers = {
+    testing = provider.testing.main
+  }
+
+  inputs = {
+    input = component.ephemeral_out.value
+  }
+}
diff --git a/internal/stacks/stackruntime/testdata/mainbundle/test/ephemeral-module-output/ephemeral-output/ephemeral-output.tf b/internal/stacks/stackruntime/testdata/mainbundle/test/ephemeral-module-output/ephemeral-output/ephemeral-output.tf
@@ -0,0 +1,7 @@
+
+ephemeral "testing_resource" "resource" {}
+
+output "value" {
+  value = ephemeral.testing_resource.resource.value
+  ephemeral = true
+}
diff --git a/internal/stacks/stackruntime/testing/provider.go b/internal/stacks/stackruntime/testing/provider.go
@@ -28,6 +28,17 @@ var (
 		},
 	}
 
+	TestingEphemeralResourceSchema = providers.Schema{
+		Body: &configschema.Block{
+			Attributes: map[string]*configschema.Attribute{
+				"value": {
+					Type:     cty.String,
+					Computed: true,
+				},
+			},
+		},
+	}
+
 	DeferredResourceSchema = providers.Schema{
 		Body: &configschema.Block{
 			Attributes: map[string]*configschema.Attribute{
@@ -199,6 +210,11 @@ func NewProviderWithData(t *testing.T, store *ResourceStore) *MockProvider {
 						Body: WriteOnlyDataSourceSchema.Body,
 					},
 				},
+				EphemeralResourceTypes: map[string]providers.Schema{
+					"testing_resource": {
+						Body: TestingEphemeralResourceSchema.Body,
+					},
+				},
 				Functions: map[string]providers.FunctionDecl{
 					"echo": {
 						Parameters: []providers.FunctionParam{
@@ -299,6 +315,13 @@ func NewProviderWithData(t *testing.T, store *ResourceStore) *MockProvider {
 					Result: request.Arguments[0],
 				}
 			},
+			OpenEphemeralResourceFn: func(request providers.OpenEphemeralResourceRequest) providers.OpenEphemeralResourceResponse {
+				return providers.OpenEphemeralResourceResponse{
+					Result: cty.ObjectVal(map[string]cty.Value{
+						"value": cty.StringVal("secret"),
+					}),
+				}
+			},
 		},
 		ResourceStore: store,
 	}
diff --git a/internal/terraform/context_apply.go b/internal/terraform/context_apply.go
diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go
diff --git a/internal/terraform/context_validate.go b/internal/terraform/context_validate.go
diff --git a/internal/terraform/graph_builder_apply.go b/internal/terraform/graph_builder_apply.go
diff --git a/internal/terraform/graph_builder_plan.go b/internal/terraform/graph_builder_plan.go
diff --git a/internal/terraform/node_output.go b/internal/terraform/node_output.go
diff --git a/internal/terraform/transform_output.go b/internal/terraform/transform_output.go

Original file line number	Diff line number	Diff line change
`@@ -154,8 +154,9 @@ func apply(tfCtx terraform.Context, run configs.TestRun, module *configs.Confi`
`154`	`154`	`}`
`155`	`155`
`156`	`156`	`applyOpts := &terraform.ApplyOpts{`
`157`		`- SetVariables: ephemeralVariables,`
`158`		`- ExternalProviders: providers,`
	`157`	`+ SetVariables: ephemeralVariables,`
	`158`	`+ ExternalProviders: providers,`
	`159`	`+ AllowRootEphemeralOutputs: true,`
`159`	`160`	`}`
`160`	`161`
`161`	`162`	`waiter.update(tfCtx, progress, created)`