display origin of deprecated value in diagnostic

Author: DanielMSchmidt

internal/command/format/diagnostic.go

@@ -253,6 +253,16 @@ func (f *snippetFormatter) write() {
 		}
 		fmt.Fprintf(buf, "  on %s line %d%s:\n", diag.Range.Filename, diag.Range.Start.Line, contextStr)
 		f.writeSnippet(snippet, code)
+
+		if diag.DeprecationOriginRange != nil && diag.DeprecationOriginSnippet != nil {
+			var depContextStr string
+			if diag.DeprecationOriginSnippet.Context != nil {
+				depContextStr = fmt.Sprintf(", in %s", *snippet.Context)
+			}
+			buf.WriteByte('\n')
+			fmt.Fprintf(buf, "  (origin of deprecation on %s line %d%s):\n", diag.DeprecationOriginRange.Filename, diag.DeprecationOriginRange.Start.Line, depContextStr)
+			f.writeSnippet(diag.DeprecationOriginSnippet, diag.DeprecationOriginSnippet.Code)
+		}
 	}
 
 	buf.WriteByte('\n')

internal/command/format/diagnostic_test.go

@@ -405,12 +405,44 @@ func TestDiagnostic(t *testing.T) {
 [red]│[reset]
 [red]│[reset] Example crash
 [red]╵[reset]
+`,
+		},
+		"warning from deprecation": {
+			&hcl.Diagnostic{
+				Severity: hcl.DiagWarning,
+				Summary:  "Deprecation detected",
+				Detail:   "Countermeasures must be taken.",
+				Subject: &hcl.Range{
+					Filename: "test.tf",
+					Start:    hcl.Pos{Line: 1, Column: 6, Byte: 5},
+					End:      hcl.Pos{Line: 1, Column: 12, Byte: 11},
+				},
+				Extra: &tfdiags.DeprecationOriginDiagnosticExtra{
+					Origin: &tfdiags.SourceRange{
+						Filename: "deprecated.tf",
+						Start:    tfdiags.SourcePos{Line: 1, Column: 11, Byte: 10},
+						End:      tfdiags.SourcePos{Line: 1, Column: 22, Byte: 21},
+					},
+				},
+			},
+			`[yellow]╷[reset]
+[yellow]│[reset] [bold][yellow]Warning: [reset][bold]Deprecation detected[reset]
+[yellow]│[reset]
+[yellow]│[reset]   on test.tf line 1:
+[yellow]│[reset]    1: test [underline]source[reset] code
+[yellow]│[reset]
+[yellow]│[reset]   (origin of deprecation on deprecated.tf line 1):
+[yellow]│[reset]    1: source of [underline]deprecation[reset]
+[yellow]│[reset]
+[yellow]│[reset] Countermeasures must be taken.
+[yellow]╵[reset]
 `,
 		},
 	}
 
 	sources := map[string][]byte{
-		"test.tf": []byte(`test source code`),
+		"test.tf":       []byte(`test source code`),
+		"deprecated.tf": []byte(`source of deprecation`),
 	}
 
 	// This empty Colorize just passes through all of the formatting codes
@@ -424,8 +456,9 @@ func TestDiagnostic(t *testing.T) {
 			diag := diags[0]
 			got := strings.TrimSpace(Diagnostic(diag, sources, colorize, 40))
 			want := strings.TrimSpace(test.Want)
-			if got != want {
-				t.Errorf("wrong result\ngot:\n%s\n\nwant:\n%s\n\n", got, want)
+
+			if diff := cmp.Diff(got, want); diff != "" {
+				t.Errorf("wrong result\ngot:\n%s\n\nwant:\n%s\n\ndiff:\n%s\n\n", got, want, diff)
 			}
 		})
 	}
@@ -713,12 +746,44 @@ Error: Bad bad bad
    1: test source code
 
 Whatever shall we do?
+`,
+		},
+
+		"warning from deprecation": {
+			&hcl.Diagnostic{
+				Severity: hcl.DiagWarning,
+				Summary:  "Deprecation detected",
+				Detail:   "Countermeasures must be taken.",
+				Subject: &hcl.Range{
+					Filename: "test.tf",
+					Start:    hcl.Pos{Line: 1, Column: 6, Byte: 5},
+					End:      hcl.Pos{Line: 1, Column: 12, Byte: 11},
+				},
+				Extra: &tfdiags.DeprecationOriginDiagnosticExtra{
+					Origin: &tfdiags.SourceRange{
+						Filename: "deprecated.tf",
+						Start:    tfdiags.SourcePos{Line: 1, Column: 11, Byte: 10},
+						End:      tfdiags.SourcePos{Line: 1, Column: 22, Byte: 21},
+					},
+				},
+			},
+			`
+Warning: Deprecation detected
+
+  on test.tf line 1:
+   1: test source code
+
+  (origin of deprecation on deprecated.tf line 1):
+   1: source of deprecation
+
+Countermeasures must be taken.
 `,
 		},
 	}
 
 	sources := map[string][]byte{
-		"test.tf": []byte(`test source code`),
+		"test.tf":       []byte(`test source code`),
+		"deprecated.tf": []byte(`source of deprecation`),
 	}
 
 	for name, test := range tests {
@@ -728,8 +793,8 @@ Whatever shall we do?
 			diag := diags[0]
 			got := strings.TrimSpace(DiagnosticPlain(diag, sources, 40))
 			want := strings.TrimSpace(test.Want)
-			if got != want {
-				t.Errorf("wrong result\ngot:\n%s\n\nwant:\n%s\n\n", got, want)
+			if diff := cmp.Diff(got, want); diff != "" {
+				t.Errorf("wrong result\ngot:\n%s\n\nwant:\n%s\n\n,diff:\n%s\n\n", got, want, diff)
 			}
 		})
 	}