resource deprecation

Author: DanielMSchmidt

internal/configs/configschema/validate_traversal.go

@@ -89,6 +89,9 @@ func (b *Block) StaticValidateTraversal(traversal hcl.Traversal) tfdiags.Diagnos
 		// traversal alone. More precise detection of deprecated attributes
 		// would require adding metadata like marks to the cty value itself, to
 		// be caught during evaluation.
+		//
+		// For all other kinds of deprecations we have marks.Deprecation, but since
+		// we return an unknown value here, we can not attach marks to it.
 		if attrS.Deprecated {
 			diags = diags.Append(&hcl.Diagnostic{
 				Severity: hcl.DiagWarning,

internal/terraform/context_validate_test.go

@@ -4415,3 +4415,65 @@ module "sink" {
 		},
 	}))
 }
+
+func TestContext2Validate_deprecated_resource(t *testing.T) {
+	m := testModuleInline(t, map[string]string{
+		"main.tf": `
+resource "test_resource" "test" { # WARNING
+    attr = "value"
+}
+
+output "a" {
+    value = test_resource.test.attr # WARNING
+}
+
+output "b" {
+    value = test_resource.test.attr # OK
+    deprecated = "redeprecated output"
+}
+`,
+	})
+
+	p := new(testing_provider.MockProvider)
+	p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(&providerSchema{
+		ResourceTypes: map[string]*configschema.Block{
+			"test_resource": {
+				Deprecated: true,
+				Attributes: map[string]*configschema.Attribute{
+					"attr": {
+						Type:     cty.String,
+						Computed: 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:  `Usage of deprecated resource "test_resource"`,
+		Detail:   `The resource "test_resource" has been marked as deprecated by its provider. Please check the provider documentation for more information.`,
+		Subject: &hcl.Range{
+			Filename: filepath.Join(m.Module.SourceDir, "main.tf"),
+			Start:    hcl.Pos{Line: 2, Column: 1, Byte: 1},
+			End:      hcl.Pos{Line: 2, Column: 32, Byte: 32},
+		},
+	}).Append(&hcl.Diagnostic{
+		Severity: hcl.DiagWarning,
+		Summary:  "Deprecated value used",
+		Detail:   `Resource "test_resource" is deprecated`,
+		Subject: &hcl.Range{
+			Filename: filepath.Join(m.Module.SourceDir, "main.tf"),
+			Start:    hcl.Pos{Line: 7, Column: 13, Byte: 92},
+			End:      hcl.Pos{Line: 7, Column: 36, Byte: 115},
+		},
+	}))
+}

internal/terraform/evaluate.go

@@ -803,7 +803,11 @@ func (d *evaluationStateData) GetResource(addr addrs.Resource, rng tfdiags.Sourc
 			// We should only end up here during the validate walk (or
 			// console/eval), since later walks should have at least partial
 			// states populated for all resources in the configuration.
-			return cty.DynamicVal, diags
+			ret := cty.DynamicVal
+			if schema.Body.Deprecated {
+				ret = ret.Mark(marks.NewDeprecation(fmt.Sprintf("Resource %q is deprecated", addr.Type), nil))
+			}
+			return ret, diags
 		}
 	}
 
@@ -878,6 +882,10 @@ func (d *evaluationStateData) GetResource(addr addrs.Resource, rng tfdiags.Sourc
 		ret = val
 	}
 
+	if schema.Body.Deprecated {
+		ret = ret.Mark(marks.NewDeprecation(fmt.Sprintf("Resource %q is deprecated", addr.Type), nil))
+	}
+
 	return ret, diags
 }
 

internal/terraform/node_resource_validate.go

@@ -69,6 +69,16 @@ func (n *NodeValidatableResource) Execute(ctx EvalContext, op walkOperation) (di
 			}
 		}
 	}
+
+	if n.Schema != nil && n.Schema.Body != nil && n.Schema.Body.Deprecated {
+		diags = diags.Append(&hcl.Diagnostic{
+			Severity: hcl.DiagWarning,
+			Summary:  fmt.Sprintf("Usage of deprecated resource %q", n.Addr.Resource.Type),
+			Detail:   fmt.Sprintf("The resource %q has been marked as deprecated by its provider. Please check the provider documentation for more information.", n.Addr.Resource.Type),
+			Subject:  &n.Config.DeclRange,
+		})
+	}
+
 	return diags
 }