handle supression of deprecation messages

Author: DanielMSchmidt

internal/addrs/check.go

@@ -106,6 +106,11 @@ func (c AbsCheck) CheckRule(typ CheckRuleType, i int) CheckRule {
 	}
 }
 
+// ModuleInstance returns the module instance portion of the address.
+func (c AbsCheck) ModuleInstance() ModuleInstance {
+	return c.Module
+}
+
 // ConfigCheckable returns the ConfigCheck address for this absolute reference.
 func (c AbsCheck) ConfigCheckable() ConfigCheckable {
 	return ConfigCheck{

internal/addrs/check_rule.go

@@ -115,3 +115,8 @@ func (c CheckRuleType) Description() string {
 		return "Condition"
 	}
 }
+
+// ModuleInstance returns the module instance address containing this check rule.
+func (c CheckRule) ModuleInstance() ModuleInstance {
+	return c.Container.ModuleInstance()
+}

internal/addrs/checkable.go

@@ -39,6 +39,7 @@ type Checkable interface {
 
 	CheckableKind() CheckableKind
 	String() string
+	ModuleInstance() ModuleInstance
 }
 
 var (

internal/addrs/input_variable.go

@@ -81,6 +81,11 @@ func (v AbsInputVariableInstance) CheckRule(typ CheckRuleType, i int) CheckRule
 	}
 }
 
+// ModuleInstance returns the module instance portion of the address.
+func (v AbsInputVariableInstance) ModuleInstance() ModuleInstance {
+	return v.Module
+}
+
 func (v AbsInputVariableInstance) ConfigCheckable() ConfigCheckable {
 	return ConfigInputVariable{
 		Module:   v.Module.Module(),

internal/addrs/output_value.go

@@ -77,6 +77,11 @@ func (m ModuleInstance) OutputValue(name string) AbsOutputValue {
 	}
 }
 
+// ModuleInstance returns the module instance portion of the address.
+func (v AbsOutputValue) ModuleInstance() ModuleInstance {
+	return v.Module
+}
+
 func (v AbsOutputValue) CheckRule(t CheckRuleType, i int) CheckRule {
 	return CheckRule{
 		Container: v,

internal/addrs/resource.go

@@ -280,6 +280,11 @@ func (m ModuleInstance) ResourceInstance(mode ResourceMode, typeName string, nam
 	}
 }
 
+// ModuleInstance returns the module instance portion of the address.
+func (r AbsResourceInstance) ModuleInstance() ModuleInstance {
+	return r.Module
+}
+
 // ContainingResource returns the address of the resource that contains the
 // receving resource instance. In other words, it discards the key portion
 // of the address to produce an AbsResource value.

internal/configs/module_call.go

@@ -9,6 +9,7 @@ import (
 	"github.com/hashicorp/hcl/v2"
 	"github.com/hashicorp/hcl/v2/gohcl"
 	"github.com/hashicorp/hcl/v2/hclsyntax"
+	"github.com/zclconf/go-cty/cty"
 
 	"github.com/hashicorp/terraform/internal/addrs"
 	"github.com/hashicorp/terraform/internal/getmodules/moduleaddrs"
@@ -35,6 +36,8 @@ type ModuleCall struct {
 	DependsOn []hcl.Traversal
 
 	DeclRange hcl.Range
+
+	IgnoreNestedDeprecations bool
 }
 
 func decodeModuleBlock(block *hcl.Block, override bool) (*ModuleCall, hcl.Diagnostics) {
@@ -163,6 +166,30 @@ func decodeModuleBlock(block *hcl.Block, override bool) (*ModuleCall, hcl.Diagno
 		mc.Providers = append(mc.Providers, providers...)
 	}
 
+	if attr, exists := content.Attributes["ignore_nested_deprecations"]; exists {
+		// We only allow static boolean values for this argument.
+		val, evalDiags := attr.Expr.Value(&hcl.EvalContext{})
+		if len(evalDiags.Errs()) > 0 {
+			diags = append(diags, &hcl.Diagnostic{
+				Severity: hcl.DiagError,
+				Summary:  "Invalid value for ignore_nested_deprecations",
+				Detail:   "The value for ignore_nested_deprecations must be a static boolean (true or false).",
+				Subject:  attr.Expr.Range().Ptr(),
+			})
+		}
+
+		if val.Type() != cty.Bool {
+			diags = append(diags, &hcl.Diagnostic{
+				Severity: hcl.DiagError,
+				Summary:  "Invalid type for ignore_nested_deprecations",
+				Detail:   fmt.Sprintf("The value for ignore_nested_deprecations must be a boolean (true or false), but the given value has type %s.", val.Type().FriendlyName()),
+				Subject:  attr.Expr.Range().Ptr(),
+			})
+		}
+
+		mc.IgnoreNestedDeprecations = val.True()
+	}
+
 	var seenEscapeBlock *hcl.Block
 	for _, block := range content.Blocks {
 		switch block.Type {
@@ -278,6 +305,9 @@ var moduleBlockSchema = &hcl.BodySchema{
 		{
 			Name: "providers",
 		},
+		{
+			Name: "ignore_nested_deprecations",
+		},
 	},
 	Blocks: []hcl.BlockHeaderSchema{
 		{Type: "_"}, // meta-argument escaping block

internal/deprecation/deprecation.go

@@ -0,0 +1,96 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: BUSL-1.1
+
+package deprecation
+
+import (
+	"sync"
+
+	"github.com/hashicorp/hcl/v2"
+	"github.com/hashicorp/terraform/internal/addrs"
+	"github.com/hashicorp/terraform/internal/lang/marks"
+	"github.com/hashicorp/terraform/internal/tfdiags"
+	"github.com/zclconf/go-cty/cty"
+)
+
+// Deprecations keeps track of meta-information related to deprecation, e.g. which module calls
+// suppress deprecation warnings.
+type Deprecations struct {
+	// Must hold this lock when accessing all fields after this one.
+	mu sync.Mutex
+
+	suppressedModules addrs.Set[addrs.Module]
+}
+
+func NewDeprecations() *Deprecations {
+	return &Deprecations{
+		suppressedModules: addrs.MakeSet[addrs.Module](),
+	}
+}
+
+func (d *Deprecations) SuppressModuleCallDeprecation(addr addrs.Module) {
+	d.mu.Lock()
+	defer d.mu.Unlock()
+
+	d.suppressedModules.Add(addr)
+}
+
+func (d *Deprecations) Validate(value cty.Value, module addrs.Module, rng *hcl.Range) (cty.Value, tfdiags.Diagnostics) {
+	var diags tfdiags.Diagnostics
+	deprecationMarks := marks.GetDeprecationMarks(value)
+	if len(deprecationMarks) == 0 {
+		return value, diags
+	}
+
+	notDeprecatedValue := marks.RemoveDeprecationMarks(value)
+
+	// Check if we need to suppress deprecation warnings for this module call.
+	if d.IsModuleCallDeprecationSuppressed(module) {
+		return notDeprecatedValue, diags
+	}
+
+	for _, depMark := range deprecationMarks {
+		diags = diags.Append(&hcl.Diagnostic{
+			Severity: hcl.DiagWarning,
+			Summary:  "Deprecated value used",
+			Detail:   depMark.Message,
+			Subject:  rng,
+		})
+	}
+
+	return notDeprecatedValue, diags
+}
+
+func (d *Deprecations) ValidateAsConfig(value cty.Value, module addrs.Module) tfdiags.Diagnostics {
+	var diags tfdiags.Diagnostics
+	_, pvms := value.UnmarkDeepWithPaths()
+
+	if len(pvms) == 0 || d.IsModuleCallDeprecationSuppressed(module) {
+		return diags
+	}
+
+	for _, pvm := range pvms {
+		for m := range pvm.Marks {
+			if depMark, ok := m.(marks.DeprecationMark); ok {
+				diags = diags.Append(
+					tfdiags.AttributeValue(
+						tfdiags.Warning,
+						"Deprecated value used",
+						depMark.Message,
+						pvm.Path,
+					),
+				)
+			}
+		}
+	}
+	return diags
+}
+
+func (d *Deprecations) IsModuleCallDeprecationSuppressed(addr addrs.Module) bool {
+	for _, mod := range d.suppressedModules {
+		if addr.Equal(mod) || mod.TargetContains(addr) {
+			return true
+		}
+	}
+	return false
+}

internal/terraform/context_validate_test.go

@@ -3898,7 +3898,7 @@ resource "test_resource" "test" {
 
 	tfdiags.AssertDiagnosticsMatch(t, diags, tfdiags.Diagnostics{}.Append(&hcl.Diagnostic{
 		Severity: hcl.DiagWarning,
-		Summary:  "Deprecated value used as for_each argument",
+		Summary:  "Deprecated value used",
 		Detail:   "Please stop using this",
 		Subject: &hcl.Range{
 			Filename: filepath.Join(m.Module.SourceDir, "main.tf"),
@@ -3907,7 +3907,7 @@ resource "test_resource" "test" {
 		},
 	}).Append(&hcl.Diagnostic{
 		Severity: hcl.DiagWarning,
-		Summary:  "Deprecated value used as for_each argument",
+		Summary:  "Deprecated value used",
 		Detail:   "Please stop using this",
 		Subject: &hcl.Range{
 			Filename: filepath.Join(m.Module.SourceDir, "main.tf"),
@@ -3968,7 +3968,7 @@ resource "test_resource" "test" {
 
 	tfdiags.AssertDiagnosticsMatch(t, diags, tfdiags.Diagnostics{}.Append(&hcl.Diagnostic{
 		Severity: hcl.DiagWarning,
-		Summary:  "Deprecated value used as count argument",
+		Summary:  "Deprecated value used",
 		Detail:   "Please stop using this",
 		Subject: &hcl.Range{
 			Filename: filepath.Join(m.Module.SourceDir, "main.tf"),
@@ -3977,7 +3977,7 @@ resource "test_resource" "test" {
 		},
 	}).Append(&hcl.Diagnostic{
 		Severity: hcl.DiagWarning,
-		Summary:  "Deprecated value used as count argument",
+		Summary:  "Deprecated value used",
 		Detail:   "Please stop using this",
 		Subject: &hcl.Range{
 			Filename: filepath.Join(m.Module.SourceDir, "main.tf"),
@@ -4522,3 +4522,132 @@ output "test_output" {
 		},
 	}))
 }
+
+func TestContext2Validate_ignoring_nested_module_deprecations(t *testing.T) {
+	m := testModuleInline(t, map[string]string{
+		"mod/main.tf": `
+output "old" {
+    deprecated = "Please stop using this"
+    value = "old"
+}
+
+module "nested" {
+    source = "./nested"
+}
+
+locals {
+  foo = module.nested.old # WARNING (if not muted)
+}
+`,
+		"mod/nested/main.tf": `
+output "old" {
+    deprecated = "Please stop using this nested output"
+    value = "old"
+}
+
+module "deeper" {
+    source = "./deeper"
+}
+
+locals {
+  bar = module.deeper.old # WARNING (if not muted)
+}
+`,
+		"mod/nested/deeper/main.tf": `
+output "old" {
+  deprecated = "Please stop using this deeply nested output"
+  value = "old"
+}
+`,
+		"main.tf": `
+module "normal" {
+    source = "./mod"
+}
+
+module "silenced" {
+    source = "./mod"
+
+    # We don't want deprecations within this module call
+    ignore_nested_deprecations = true
+}
+
+# We want to still have deprecation warnings within our control surface
+locals {
+  using_normal_old = module.normal.old # WARNING
+  using_silenced_old = module.silenced.old # WARNING
+}
+`,
+	})
+
+	p := new(testing_provider.MockProvider)
+	p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(&providerSchema{
+		ResourceTypes: map[string]*configschema.Block{
+			"test_resource": {
+				Attributes: map[string]*configschema.Attribute{
+					"attr": {
+						Type:     cty.String,
+						Computed: true,
+					},
+				},
+			},
+		},
+		Actions: map[string]*providers.ActionSchema{
+			"test_action": {
+				ConfigSchema: &configschema.Block{
+					Attributes: map[string]*configschema.Attribute{
+						"attr": {
+							Type:     cty.String,
+							Required: true,
+						},
+					},
+				},
+			},
+		},
+	})
+
+	ctx := testContext2(t, &ContextOpts{
+		Providers: map[addrs.Provider]providers.Factory{
+			addrs.NewDefaultProvider("test"): testProviderFuncFixed(p),
+		},
+	})
+
+	diags := ctx.Validate(m, &ValidateOpts{})
+
+	tfdiags.AssertDiagnosticsMatch(t, diags, tfdiags.Diagnostics{}.Append(&hcl.Diagnostic{
+		Severity: hcl.DiagWarning,
+		Summary:  "Deprecated value used",
+		Detail:   "Please stop using this",
+		Subject: &hcl.Range{
+			Filename: filepath.Join(m.Module.SourceDir, "main.tf"),
+			Start:    hcl.Pos{Line: 15, Column: 22, Byte: 285},
+			End:      hcl.Pos{Line: 15, Column: 39, Byte: 302},
+		},
+	}).Append(&hcl.Diagnostic{
+		Severity: hcl.DiagWarning,
+		Summary:  "Deprecated value used",
+		Detail:   "Please stop using this",
+		Subject: &hcl.Range{
+			Filename: filepath.Join(m.Module.SourceDir, "main.tf"),
+			Start:    hcl.Pos{Line: 16, Column: 24, Byte: 336},
+			End:      hcl.Pos{Line: 16, Column: 43, Byte: 355},
+		},
+	}).Append(&hcl.Diagnostic{
+		Severity: hcl.DiagWarning,
+		Summary:  "Deprecated value used",
+		Detail:   "Please stop using this nested output",
+		Subject: &hcl.Range{
+			Filename: filepath.Join(m.Module.SourceDir, "mod", "main.tf"),
+			Start:    hcl.Pos{Line: 12, Column: 9, Byte: 141},
+			End:      hcl.Pos{Line: 12, Column: 26, Byte: 158},
+		},
+	}).Append(&hcl.Diagnostic{
+		Severity: hcl.DiagWarning,
+		Summary:  "Deprecated value used",
+		Detail:   "Please stop using this deeply nested output",
+		Subject: &hcl.Range{
+			Filename: filepath.Join(m.Module.SourceDir, "mod", "nested", "main.tf"),
+			Start:    hcl.Pos{Line: 12, Column: 9, Byte: 155},
+			End:      hcl.Pos{Line: 12, Column: 26, Byte: 172},
+		},
+	}))
+}