internal/lsp: cleanup the diagnostic and completion tests
this make the same kinds of changes I already made to the symbol tests,
to make the messages more detailed and remove the goto
Change-Id: I7cb27839b2ab696ad4e3d6537d91152e34fb1d89
Reviewed-on: https://go-review.googlesource.com/c/tools/+/172477
Run-TryBot: Ian Cottrell <iancottrell@google.com>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Rebecca Stambler <rstambler@golang.org>
diff --git a/internal/lsp/diagnostics.go b/internal/lsp/diagnostics.go
index aa9fa0f..5f91464 100644
--- a/internal/lsp/diagnostics.go
+++ b/internal/lsp/diagnostics.go
@@ -6,7 +6,6 @@
import (
"context"
- "sort"
"golang.org/x/tools/internal/lsp/cache"
"golang.org/x/tools/internal/lsp/protocol"
@@ -100,15 +99,3 @@
}
return reports, nil
}
-
-func sorted(d []protocol.Diagnostic) {
- sort.Slice(d, func(i int, j int) bool {
- if d[i].Range.Start.Line == d[j].Range.Start.Line {
- if d[i].Range.Start.Character == d[j].Range.Start.Character {
- return d[i].Message < d[j].Message
- }
- return d[i].Range.Start.Character < d[j].Range.Start.Character
- }
- return d[i].Range.Start.Line < d[j].Range.Start.Line
- })
-}
diff --git a/internal/lsp/lsp_test.go b/internal/lsp/lsp_test.go
index 12099ca..6dc678c 100644
--- a/internal/lsp/lsp_test.go
+++ b/internal/lsp/lsp_test.go
@@ -197,7 +197,6 @@
if err != nil {
t.Fatal(err)
}
- sorted(got)
if diff := diffDiagnostics(uri, want, got); diff != "" {
t.Error(diff)
}
@@ -233,41 +232,69 @@
d[spn.URI()] = append(d[spn.URI()], want)
}
+func sortDiagnostics(d []protocol.Diagnostic) {
+ sort.Slice(d, func(i int, j int) bool {
+ if d[i].Range.Start.Line < d[j].Range.Start.Line {
+ return true
+ }
+ if d[i].Range.Start.Line > d[j].Range.Start.Line {
+ return false
+ }
+ if d[i].Range.Start.Character < d[j].Range.Start.Character {
+ return true
+ }
+ if d[i].Range.Start.Character > d[j].Range.Start.Character {
+ return false
+ }
+ return d[i].Message < d[j].Message
+ })
+}
+
// diffDiagnostics prints the diff between expected and actual diagnostics test
// results.
func diffDiagnostics(uri span.URI, want, got []protocol.Diagnostic) string {
+ sortDiagnostics(want)
+ sortDiagnostics(got)
if len(got) != len(want) {
- goto Failed
+ return summarizeDiagnostics(-1, want, got, "different lengths got %v want %v", len(got), len(want))
}
for i, w := range want {
g := got[i]
if w.Message != g.Message {
- goto Failed
+ return summarizeDiagnostics(i, want, got, "incorrect Message got %v want %v", g.Message, w.Message)
}
if w.Range.Start != g.Range.Start {
- goto Failed
+ return summarizeDiagnostics(i, want, got, "incorrect Range.Start got %v want %v", g.Range.Start, w.Range.Start)
}
// Special case for diagnostics on parse errors.
if strings.Contains(string(uri), "noparse") {
if g.Range.Start != g.Range.End || w.Range.Start != g.Range.End {
- goto Failed
+ return summarizeDiagnostics(i, want, got, "incorrect Range.End got %v want %v", g.Range.End, w.Range.Start)
}
} else if g.Range.End != g.Range.Start { // Accept any 'want' range if the diagnostic returns a zero-length range.
if w.Range.End != g.Range.End {
- goto Failed
+ return summarizeDiagnostics(i, want, got, "incorrect Range.End got %v want %v", g.Range.End, w.Range.End)
}
}
if w.Severity != g.Severity {
- goto Failed
+ return summarizeDiagnostics(i, want, got, "incorrect Severity got %v want %v", g.Severity, w.Severity)
}
if w.Source != g.Source {
- goto Failed
+ return summarizeDiagnostics(i, want, got, "incorrect Source got %v want %v", g.Source, w.Source)
}
}
return ""
-Failed:
+}
+
+func summarizeDiagnostics(i int, want []protocol.Diagnostic, got []protocol.Diagnostic, reason string, args ...interface{}) string {
msg := &bytes.Buffer{}
- fmt.Fprintf(msg, "diagnostics failed for %s:\nexpected:\n", uri)
+ fmt.Fprint(msg, "diagnostics failed")
+ if i >= 0 {
+ fmt.Fprintf(msg, " at %d", i)
+ }
+ fmt.Fprint(msg, " because of ")
+ fmt.Fprintf(msg, reason, args...)
+ fmt.Fprint(msg, ":\nexpected:\n")
for _, d := range want {
fmt.Fprintf(msg, " %v\n", d)
}
@@ -371,24 +398,32 @@
// test results.
func diffCompletionItems(t *testing.T, pos token.Position, want, got []protocol.CompletionItem) string {
if len(got) != len(want) {
- goto Failed
+ return summarizeCompletionItems(-1, want, got, "different lengths got %v want %v", len(got), len(want))
}
for i, w := range want {
g := got[i]
if w.Label != g.Label {
- goto Failed
+ return summarizeCompletionItems(i, want, got, "incorrect Label got %v want %v", g.Label, w.Label)
}
if w.Detail != g.Detail {
- goto Failed
+ return summarizeCompletionItems(i, want, got, "incorrect Detail got %v want %v", g.Detail, w.Detail)
}
if w.Kind != g.Kind {
- goto Failed
+ return summarizeCompletionItems(i, want, got, "incorrect Kind got %v want %v", g.Kind, w.Kind)
}
}
return ""
-Failed:
+}
+
+func summarizeCompletionItems(i int, want []protocol.CompletionItem, got []protocol.CompletionItem, reason string, args ...interface{}) string {
msg := &bytes.Buffer{}
- fmt.Fprintf(msg, "completion failed for %s:%v:%v:\nexpected:\n", filepath.Base(pos.Filename), pos.Line, pos.Column)
+ fmt.Fprint(msg, "completion failed")
+ if i >= 0 {
+ fmt.Fprintf(msg, " at %d", i)
+ }
+ fmt.Fprint(msg, " because of ")
+ fmt.Fprintf(msg, reason, args...)
+ fmt.Fprint(msg, ":\nexpected:\n")
for _, d := range want {
fmt.Fprintf(msg, " %v\n", d)
}
