1 // Copyright 2018 The Go Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style
3 // license that can be found in the LICENSE file.
17 "golang.org/x/tools/internal/lsp/cache"
18 "golang.org/x/tools/internal/lsp/diff"
19 "golang.org/x/tools/internal/lsp/diff/myers"
20 "golang.org/x/tools/internal/lsp/fuzzy"
21 "golang.org/x/tools/internal/lsp/protocol"
22 "golang.org/x/tools/internal/lsp/source"
23 "golang.org/x/tools/internal/lsp/source/completion"
24 "golang.org/x/tools/internal/lsp/tests"
25 "golang.org/x/tools/internal/span"
26 "golang.org/x/tools/internal/testenv"
27 errors "golang.org/x/xerrors"
30 func TestMain(m *testing.M) {
31 testenv.ExitIfSmallMachine()
35 func TestSource(t *testing.T) {
36 tests.RunTests(t, "../testdata", true, testSource)
40 snapshot source.Snapshot
44 normalizers []tests.Normalizer
47 func testSource(t *testing.T, datum *tests.Data) {
48 ctx := tests.Context(t)
50 cache := cache.New(ctx, nil)
51 session := cache.NewSession(ctx)
52 options := source.DefaultOptions().Clone()
53 tests.DefaultOptions(options)
54 options.SetEnvSlice(datum.Config.Env)
55 view, _, release, err := session.NewView(ctx, "source_test", span.URIFromPath(datum.Config.Dir), "", options)
60 defer view.Shutdown(ctx)
62 // Enable type error analyses for tests.
63 // TODO(golang/go#38212): Delete this once they are enabled by default.
64 tests.EnableAllAnalyzers(view, options)
65 view.SetOptions(ctx, options)
67 var modifications []source.FileModification
68 for filename, content := range datum.Config.Overlay {
69 kind := source.DetectLanguage("", filename)
70 if kind != source.Go {
73 modifications = append(modifications, source.FileModification{
74 URI: span.URIFromPath(filename),
81 if err := session.ModifyFiles(ctx, modifications); err != nil {
84 snapshot, release := view.Snapshot(ctx)
91 normalizers: tests.CollectNormalizers(datum.Exported),
93 tests.Run(t, r, datum)
96 func (r *runner) CallHierarchy(t *testing.T, spn span.Span, expectedCalls *tests.CallHierarchyResult) {
97 mapper, err := r.data.Mapper(spn.URI())
101 loc, err := mapper.Location(spn)
103 t.Fatalf("failed for %v: %v", spn, err)
105 fh, err := r.snapshot.GetFile(r.ctx, spn.URI())
110 items, err := source.PrepareCallHierarchy(r.ctx, r.snapshot, fh, loc.Range.Start)
115 t.Fatalf("expected call hierarchy item to be returned for identifier at %v\n", loc.Range)
118 callLocation := protocol.Location{
120 Range: items[0].Range,
122 if callLocation != loc {
123 t.Fatalf("expected source.PrepareCallHierarchy to return identifier at %v but got %v\n", loc, callLocation)
126 incomingCalls, err := source.IncomingCalls(r.ctx, r.snapshot, fh, loc.Range.Start)
130 var incomingCallItems []protocol.CallHierarchyItem
131 for _, item := range incomingCalls {
132 incomingCallItems = append(incomingCallItems, item.From)
134 msg := tests.DiffCallHierarchyItems(incomingCallItems, expectedCalls.IncomingCalls)
136 t.Error(fmt.Sprintf("incoming calls differ: %s", msg))
139 outgoingCalls, err := source.OutgoingCalls(r.ctx, r.snapshot, fh, loc.Range.Start)
143 var outgoingCallItems []protocol.CallHierarchyItem
144 for _, item := range outgoingCalls {
145 outgoingCallItems = append(outgoingCallItems, item.To)
147 msg = tests.DiffCallHierarchyItems(outgoingCallItems, expectedCalls.OutgoingCalls)
149 t.Error(fmt.Sprintf("outgoing calls differ: %s", msg))
153 func (r *runner) Diagnostics(t *testing.T, uri span.URI, want []*source.Diagnostic) {
154 fileID, got, err := source.FileDiagnostics(r.ctx, r.snapshot, uri)
158 // A special case to test that there are no diagnostics for a file.
159 if len(want) == 1 && want[0].Source == "no_diagnostics" {
161 t.Errorf("expected no diagnostics for %s, got %v", uri, got)
165 if diff := tests.DiffDiagnostics(fileID.URI, want, got); diff != "" {
170 func (r *runner) Completion(t *testing.T, src span.Span, test tests.Completion, items tests.CompletionItems) {
171 var want []protocol.CompletionItem
172 for _, pos := range test.CompletionItems {
173 want = append(want, tests.ToProtocolCompletionItem(*items[pos]))
175 _, got := r.callCompletion(t, src, func(opts *source.Options) {
176 opts.Matcher = source.CaseInsensitive
177 opts.DeepCompletion = false
178 opts.CompleteUnimported = false
179 opts.InsertTextFormat = protocol.SnippetTextFormat
180 if !strings.Contains(string(src.URI()), "literal") {
181 opts.LiteralCompletions = false
184 got = tests.FilterBuiltins(src, got)
185 if diff := tests.DiffCompletionItems(want, got); diff != "" {
186 t.Errorf("%s: %s", src, diff)
190 func (r *runner) CompletionSnippet(t *testing.T, src span.Span, expected tests.CompletionSnippet, placeholders bool, items tests.CompletionItems) {
191 _, list := r.callCompletion(t, src, func(opts *source.Options) {
192 opts.UsePlaceholders = placeholders
193 opts.DeepCompletion = true
194 opts.CompleteUnimported = false
196 got := tests.FindItem(list, *items[expected.CompletionItem])
197 want := expected.PlainSnippet
199 want = expected.PlaceholderSnippet
201 if diff := tests.DiffSnippets(want, got); diff != "" {
202 t.Errorf("%s: %s", src, diff)
206 func (r *runner) UnimportedCompletion(t *testing.T, src span.Span, test tests.Completion, items tests.CompletionItems) {
207 var want []protocol.CompletionItem
208 for _, pos := range test.CompletionItems {
209 want = append(want, tests.ToProtocolCompletionItem(*items[pos]))
211 _, got := r.callCompletion(t, src, func(opts *source.Options) {})
212 got = tests.FilterBuiltins(src, got)
213 if diff := tests.CheckCompletionOrder(want, got, false); diff != "" {
214 t.Errorf("%s: %s", src, diff)
218 func (r *runner) DeepCompletion(t *testing.T, src span.Span, test tests.Completion, items tests.CompletionItems) {
219 var want []protocol.CompletionItem
220 for _, pos := range test.CompletionItems {
221 want = append(want, tests.ToProtocolCompletionItem(*items[pos]))
223 prefix, list := r.callCompletion(t, src, func(opts *source.Options) {
224 opts.DeepCompletion = true
225 opts.Matcher = source.CaseInsensitive
226 opts.CompleteUnimported = false
228 list = tests.FilterBuiltins(src, list)
229 fuzzyMatcher := fuzzy.NewMatcher(prefix)
230 var got []protocol.CompletionItem
231 for _, item := range list {
232 if fuzzyMatcher.Score(item.Label) <= 0 {
235 got = append(got, item)
237 if msg := tests.DiffCompletionItems(want, got); msg != "" {
238 t.Errorf("%s: %s", src, msg)
242 func (r *runner) FuzzyCompletion(t *testing.T, src span.Span, test tests.Completion, items tests.CompletionItems) {
243 var want []protocol.CompletionItem
244 for _, pos := range test.CompletionItems {
245 want = append(want, tests.ToProtocolCompletionItem(*items[pos]))
247 _, got := r.callCompletion(t, src, func(opts *source.Options) {
248 opts.DeepCompletion = true
249 opts.Matcher = source.Fuzzy
250 opts.CompleteUnimported = false
252 got = tests.FilterBuiltins(src, got)
253 if msg := tests.DiffCompletionItems(want, got); msg != "" {
254 t.Errorf("%s: %s", src, msg)
258 func (r *runner) CaseSensitiveCompletion(t *testing.T, src span.Span, test tests.Completion, items tests.CompletionItems) {
259 var want []protocol.CompletionItem
260 for _, pos := range test.CompletionItems {
261 want = append(want, tests.ToProtocolCompletionItem(*items[pos]))
263 _, list := r.callCompletion(t, src, func(opts *source.Options) {
264 opts.Matcher = source.CaseSensitive
265 opts.CompleteUnimported = false
267 list = tests.FilterBuiltins(src, list)
268 if diff := tests.DiffCompletionItems(want, list); diff != "" {
269 t.Errorf("%s: %s", src, diff)
273 func (r *runner) RankCompletion(t *testing.T, src span.Span, test tests.Completion, items tests.CompletionItems) {
274 var want []protocol.CompletionItem
275 for _, pos := range test.CompletionItems {
276 want = append(want, tests.ToProtocolCompletionItem(*items[pos]))
278 _, got := r.callCompletion(t, src, func(opts *source.Options) {
279 opts.DeepCompletion = true
280 opts.Matcher = source.Fuzzy
282 if msg := tests.CheckCompletionOrder(want, got, true); msg != "" {
283 t.Errorf("%s: %s", src, msg)
287 func (r *runner) callCompletion(t *testing.T, src span.Span, options func(*source.Options)) (string, []protocol.CompletionItem) {
288 fh, err := r.snapshot.GetFile(r.ctx, src.URI())
292 original := r.view.Options()
293 modified := original.Clone()
295 newView, err := r.view.SetOptions(r.ctx, modified)
296 if newView != r.view {
297 t.Fatalf("options change unexpectedly created new view")
302 defer r.view.SetOptions(r.ctx, original)
304 list, surrounding, err := completion.Completion(r.ctx, r.snapshot, fh, protocol.Position{
305 Line: uint32(src.Start().Line() - 1),
306 Character: uint32(src.Start().Column() - 1),
307 }, protocol.CompletionContext{})
308 if err != nil && !errors.As(err, &completion.ErrIsDefinition{}) {
309 t.Fatalf("failed for %v: %v", src, err)
312 if surrounding != nil {
313 prefix = strings.ToLower(surrounding.Prefix())
316 var numDeepCompletionsSeen int
317 var items []completion.CompletionItem
318 // Apply deep completion filtering.
319 for _, item := range list {
321 if !modified.DeepCompletion {
324 if numDeepCompletionsSeen >= completion.MaxDeepCompletions {
327 numDeepCompletionsSeen++
329 items = append(items, item)
331 return prefix, tests.ToProtocolCompletionItems(items)
334 func (r *runner) FoldingRanges(t *testing.T, spn span.Span) {
337 fh, err := r.snapshot.GetFile(r.ctx, spn.URI())
341 data, err := fh.Read()
347 // Test all folding ranges.
348 ranges, err := source.FoldingRange(r.ctx, r.snapshot, fh, false)
353 r.foldingRanges(t, "foldingRange", uri, string(data), ranges)
355 // Test folding ranges with lineFoldingOnly
356 ranges, err = source.FoldingRange(r.ctx, r.snapshot, fh, true)
361 r.foldingRanges(t, "foldingRange-lineFolding", uri, string(data), ranges)
364 func (r *runner) foldingRanges(t *testing.T, prefix string, uri span.URI, data string, ranges []*source.FoldingRangeInfo) {
367 nonOverlapping := nonOverlappingRanges(t, ranges)
368 for i, rngs := range nonOverlapping {
369 got, err := foldRanges(string(data), rngs)
374 tag := fmt.Sprintf("%s-%d", prefix, i)
375 want := string(r.data.Golden(tag, uri.Filename(), func() ([]byte, error) {
376 return []byte(got), nil
379 if diff := tests.Diff(t, want, got); diff != "" {
380 t.Errorf("%s: foldingRanges failed for %s, diff:\n%v", tag, uri.Filename(), diff)
385 kinds := []protocol.FoldingRangeKind{protocol.Imports, protocol.Comment}
386 for _, kind := range kinds {
387 var kindOnly []*source.FoldingRangeInfo
388 for _, fRng := range ranges {
389 if fRng.Kind == kind {
390 kindOnly = append(kindOnly, fRng)
394 nonOverlapping := nonOverlappingRanges(t, kindOnly)
395 for i, rngs := range nonOverlapping {
396 got, err := foldRanges(string(data), rngs)
401 tag := fmt.Sprintf("%s-%s-%d", prefix, kind, i)
402 want := string(r.data.Golden(tag, uri.Filename(), func() ([]byte, error) {
403 return []byte(got), nil
406 if diff := tests.Diff(t, want, got); diff != "" {
407 t.Errorf("%s: failed for %s, diff:\n%v", tag, uri.Filename(), diff)
414 func nonOverlappingRanges(t *testing.T, ranges []*source.FoldingRangeInfo) (res [][]*source.FoldingRangeInfo) {
415 for _, fRng := range ranges {
417 for i := 0; i < len(res); i++ {
419 for _, rng := range res[i] {
420 if conflict(t, rng, fRng) {
430 if setNum == len(res) {
431 res = append(res, []*source.FoldingRangeInfo{})
433 res[setNum] = append(res[setNum], fRng)
438 func conflict(t *testing.T, a, b *source.FoldingRangeInfo) bool {
439 arng, err := a.Range()
443 brng, err := b.Range()
447 // a start position is <= b start positions
448 return protocol.ComparePosition(arng.Start, brng.Start) <= 0 && protocol.ComparePosition(arng.End, brng.Start) > 0
451 func foldRanges(contents string, ranges []*source.FoldingRangeInfo) (string, error) {
454 // Apply the folds from the end of the file forward
455 // to preserve the offsets.
456 for i := len(ranges) - 1; i >= 0; i-- {
458 spn, err := fRange.Span()
462 start := spn.Start().Offset()
463 end := spn.End().Offset()
465 tmp := res[0:start] + foldedText
466 res = tmp + res[end:]
471 func (r *runner) Format(t *testing.T, spn span.Span) {
472 gofmted := string(r.data.Golden("gofmt", spn.URI().Filename(), func() ([]byte, error) {
473 cmd := exec.Command("gofmt", spn.URI().Filename())
474 out, _ := cmd.Output() // ignore error, sometimes we have intentionally ungofmt-able files
477 fh, err := r.snapshot.GetFile(r.ctx, spn.URI())
481 edits, err := source.Format(r.ctx, r.snapshot, fh)
488 data, err := fh.Read()
492 m, err := r.data.Mapper(spn.URI())
496 diffEdits, err := source.FromProtocolEdits(m, edits)
500 got := diff.ApplyEdits(string(data), diffEdits)
502 t.Errorf("format failed for %s, expected:\n%v\ngot:\n%v", spn.URI().Filename(), gofmted, got)
506 func (r *runner) SemanticTokens(t *testing.T, spn span.Span) {
507 t.Skip("nothing to test in source")
510 func (r *runner) Import(t *testing.T, spn span.Span) {
511 fh, err := r.snapshot.GetFile(r.ctx, spn.URI())
515 edits, _, err := source.AllImportsFixes(r.ctx, r.snapshot, fh)
519 data, err := fh.Read()
523 m, err := r.data.Mapper(fh.URI())
527 diffEdits, err := source.FromProtocolEdits(m, edits)
531 got := diff.ApplyEdits(string(data), diffEdits)
532 want := string(r.data.Golden("goimports", spn.URI().Filename(), func() ([]byte, error) {
533 return []byte(got), nil
536 d, err := myers.ComputeEdits(spn.URI(), want, got)
540 t.Errorf("import failed for %s: %s", spn.URI().Filename(), diff.ToUnified("want", "got", want, d))
544 func (r *runner) Definition(t *testing.T, spn span.Span, d tests.Definition) {
545 _, srcRng, err := spanToRange(r.data, d.Src)
549 fh, err := r.snapshot.GetFile(r.ctx, spn.URI())
553 ident, err := source.Identifier(r.ctx, r.snapshot, fh, srcRng.Start)
555 t.Fatalf("failed for %v: %v", d.Src, err)
557 h, err := source.HoverIdentifier(r.ctx, ident)
559 t.Fatalf("failed for %v: %v", d.Src, err)
561 hover, err := source.FormatHover(h, r.view.Options())
565 rng, err := ident.Declaration.MappedRange[0].Range()
570 rng, err = ident.Type.Range()
576 didSomething := false
579 tag := fmt.Sprintf("%s-hover", d.Name)
580 expectHover := string(r.data.Golden(tag, d.Src.URI().Filename(), func() ([]byte, error) {
581 return []byte(hover), nil
583 if hover != expectHover {
584 t.Errorf("hover for %s failed:\n%s", d.Src, tests.Diff(t, expectHover, hover))
589 if _, defRng, err := spanToRange(r.data, d.Def); err != nil {
591 } else if rng != defRng {
592 t.Errorf("for %v got %v want %v", d.Src, rng, defRng)
596 t.Errorf("no tests ran for %s", d.Src.URI())
600 func (r *runner) Implementation(t *testing.T, spn span.Span, impls []span.Span) {
601 sm, err := r.data.Mapper(spn.URI())
605 loc, err := sm.Location(spn)
607 t.Fatalf("failed for %v: %v", spn, err)
609 fh, err := r.snapshot.GetFile(r.ctx, spn.URI())
613 locs, err := source.Implementation(r.ctx, r.snapshot, fh, loc.Range.Start)
615 t.Fatalf("failed for %v: %v", spn, err)
617 if len(locs) != len(impls) {
618 t.Fatalf("got %d locations for implementation, expected %d", len(locs), len(impls))
620 var results []span.Span
621 for i := range locs {
622 locURI := locs[i].URI.SpanURI()
623 lm, err := r.data.Mapper(locURI)
627 imp, err := lm.Span(locs[i])
629 t.Fatalf("failed for %v: %v", locs[i], err)
631 results = append(results, imp)
633 // Sort results and expected to make tests deterministic.
634 sort.SliceStable(results, func(i, j int) bool {
635 return span.Compare(results[i], results[j]) == -1
637 sort.SliceStable(impls, func(i, j int) bool {
638 return span.Compare(impls[i], impls[j]) == -1
640 for i := range results {
641 if results[i] != impls[i] {
642 t.Errorf("for %dth implementation of %v got %v want %v", i, spn, results[i], impls[i])
647 func (r *runner) Highlight(t *testing.T, src span.Span, locations []span.Span) {
649 m, srcRng, err := spanToRange(r.data, src)
653 fh, err := r.snapshot.GetFile(r.ctx, src.URI())
657 highlights, err := source.Highlight(ctx, r.snapshot, fh, srcRng.Start)
659 t.Errorf("highlight failed for %s: %v", src.URI(), err)
661 if len(highlights) != len(locations) {
662 t.Fatalf("got %d highlights for highlight at %v:%v:%v, expected %d", len(highlights), src.URI().Filename(), src.Start().Line(), src.Start().Column(), len(locations))
664 // Check to make sure highlights have a valid range.
665 var results []span.Span
666 for i := range highlights {
667 h, err := m.RangeSpan(highlights[i])
669 t.Fatalf("failed for %v: %v", highlights[i], err)
671 results = append(results, h)
673 // Sort results to make tests deterministic since DocumentHighlight uses a map.
674 sort.SliceStable(results, func(i, j int) bool {
675 return span.Compare(results[i], results[j]) == -1
677 // Check to make sure all the expected highlights are found.
678 for i := range results {
679 if results[i] != locations[i] {
680 t.Errorf("want %v, got %v\n", locations[i], results[i])
685 func (r *runner) References(t *testing.T, src span.Span, itemList []span.Span) {
687 _, srcRng, err := spanToRange(r.data, src)
691 snapshot := r.snapshot
692 fh, err := snapshot.GetFile(r.ctx, src.URI())
696 for _, includeDeclaration := range []bool{true, false} {
697 t.Run(fmt.Sprintf("refs-declaration-%v", includeDeclaration), func(t *testing.T) {
698 want := make(map[span.Span]bool)
699 for i, pos := range itemList {
700 // We don't want the first result if we aren't including the declaration.
701 if i == 0 && !includeDeclaration {
706 refs, err := source.References(ctx, snapshot, fh, srcRng.Start, includeDeclaration)
708 t.Fatalf("failed for %s: %v", src, err)
710 got := make(map[span.Span]bool)
711 for _, refInfo := range refs {
712 refSpan, err := refInfo.Span()
718 if len(got) != len(want) {
719 t.Errorf("references failed: different lengths got %v want %v", len(got), len(want))
721 for spn := range got {
723 t.Errorf("references failed: incorrect references got %v want locations %v", got, want)
730 func (r *runner) Rename(t *testing.T, spn span.Span, newText string) {
731 tag := fmt.Sprintf("%s-rename", newText)
733 _, srcRng, err := spanToRange(r.data, spn)
737 fh, err := r.snapshot.GetFile(r.ctx, spn.URI())
741 changes, err := source.Rename(r.ctx, r.snapshot, fh, srcRng.Start, newText)
743 renamed := string(r.data.Golden(tag, spn.URI().Filename(), func() ([]byte, error) {
744 return []byte(err.Error()), nil
746 if err.Error() != renamed {
747 t.Errorf("rename failed for %s, expected:\n%v\ngot:\n%v\n", newText, renamed, err)
753 for editURI, edits := range changes {
754 fh, err := r.snapshot.GetFile(r.ctx, editURI)
758 data, err := fh.Read()
762 m, err := r.data.Mapper(fh.URI())
766 diffEdits, err := source.FromProtocolEdits(m, edits)
770 contents := applyEdits(string(data), diffEdits)
771 if len(changes) > 1 {
772 filename := filepath.Base(editURI.Filename())
773 contents = fmt.Sprintf("%s:\n%s", filename, contents)
775 res = append(res, contents)
782 for i, val := range res {
789 renamed := string(r.data.Golden(tag, spn.URI().Filename(), func() ([]byte, error) {
790 return []byte(got), nil
794 t.Errorf("rename failed for %s, expected:\n%v\ngot:\n%v", newText, renamed, got)
798 func applyEdits(contents string, edits []diff.TextEdit) string {
801 // Apply the edits from the end of the file forward
802 // to preserve the offsets
803 for i := len(edits) - 1; i >= 0; i-- {
805 start := edit.Span.Start().Offset()
806 end := edit.Span.End().Offset()
807 tmp := res[0:start] + edit.NewText
808 res = tmp + res[end:]
813 func (r *runner) PrepareRename(t *testing.T, src span.Span, want *source.PrepareItem) {
814 _, srcRng, err := spanToRange(r.data, src)
818 // Find the identifier at the position.
819 fh, err := r.snapshot.GetFile(r.ctx, src.URI())
823 item, _, err := source.PrepareRename(r.ctx, r.snapshot, fh, srcRng.Start)
825 if want.Text != "" { // expected an ident.
826 t.Errorf("prepare rename failed for %v: got error: %v", src, err)
832 t.Errorf("prepare rename failed for %v: got nil", src)
837 t.Errorf("prepare rename failed for %v: expected nil, got %v", src, item)
840 if item.Range.Start == item.Range.End {
841 // Special case for 0-length ranges. Marks can't specify a 0-length range,
842 // so just compare the start.
843 if item.Range.Start != want.Range.Start {
844 t.Errorf("prepare rename failed: incorrect point, got %v want %v", item.Range.Start, want.Range.Start)
847 if protocol.CompareRange(item.Range, want.Range) != 0 {
848 t.Errorf("prepare rename failed: incorrect range got %v want %v", item.Range, want.Range)
853 func (r *runner) Symbols(t *testing.T, uri span.URI, expectedSymbols []protocol.DocumentSymbol) {
854 fh, err := r.snapshot.GetFile(r.ctx, uri)
858 symbols, err := source.DocumentSymbols(r.ctx, r.snapshot, fh)
860 t.Errorf("symbols failed for %s: %v", uri, err)
862 if len(symbols) != len(expectedSymbols) {
863 t.Errorf("want %d top-level symbols in %v, got %d", len(expectedSymbols), uri, len(symbols))
866 if diff := tests.DiffSymbols(t, uri, expectedSymbols, symbols); diff != "" {
871 func (r *runner) WorkspaceSymbols(t *testing.T, uri span.URI, query string, typ tests.WorkspaceSymbolsTestType) {
872 r.callWorkspaceSymbols(t, uri, query, typ)
875 func (r *runner) callWorkspaceSymbols(t *testing.T, uri span.URI, query string, typ tests.WorkspaceSymbolsTestType) {
878 matcher := tests.WorkspaceSymbolsTestTypeToMatcher(typ)
879 gotSymbols, err := source.WorkspaceSymbols(r.ctx, matcher, r.view.Options().SymbolStyle, []source.View{r.view}, query)
883 got, err := tests.WorkspaceSymbolsString(r.ctx, r.data, uri, gotSymbols)
887 got = filepath.ToSlash(tests.Normalize(got, r.normalizers))
888 want := string(r.data.Golden(fmt.Sprintf("workspace_symbol-%s-%s", strings.ToLower(string(matcher)), query), uri.Filename(), func() ([]byte, error) {
889 return []byte(got), nil
891 if diff := tests.Diff(t, want, got); diff != "" {
896 func (r *runner) SignatureHelp(t *testing.T, spn span.Span, want *protocol.SignatureHelp) {
897 _, rng, err := spanToRange(r.data, spn)
901 fh, err := r.snapshot.GetFile(r.ctx, spn.URI())
905 gotSignature, gotActiveParameter, err := source.SignatureHelp(r.ctx, r.snapshot, fh, rng.Start)
907 // Only fail if we got an error we did not expect.
909 t.Fatalf("failed for %v: %v", spn, err)
913 if gotSignature == nil {
915 t.Fatalf("got nil signature, but expected %v", want)
919 got := &protocol.SignatureHelp{
920 Signatures: []protocol.SignatureInformation{*gotSignature},
921 ActiveParameter: uint32(gotActiveParameter),
923 diff, err := tests.DiffSignatures(spn, want, got)
932 // These are pure LSP features, no source level functionality to be tested.
933 func (r *runner) Link(t *testing.T, uri span.URI, wantLinks []tests.Link) {}
934 func (r *runner) SuggestedFix(t *testing.T, spn span.Span, actionKinds []string, expectedActions int) {
936 func (r *runner) FunctionExtraction(t *testing.T, start span.Span, end span.Span) {}
937 func (r *runner) CodeLens(t *testing.T, uri span.URI, want []protocol.CodeLens) {}
939 func spanToRange(data *tests.Data, spn span.Span) (*protocol.ColumnMapper, protocol.Range, error) {
940 m, err := data.Mapper(spn.URI())
942 return nil, protocol.Range{}, err
944 srcRng, err := m.Range(spn)
946 return nil, protocol.Range{}, err
948 return m, srcRng, nil