Documentation ¶
Overview ¶
Package tests exports functionality to be used across a variety of gopls tests.
Index ¶
- Constants
- Variables
- func CheckCompletionOrder(want, got []protocol.CompletionItem, strictScores bool) string
- func Context(t testing.TB) context.Context
- func CopyFolderToTempDir(folder string) (string, error)
- func DefaultOptions(o *source.Options)
- func Diff(want, got string) string
- func DiffCallHierarchyItems(gotCalls []protocol.CallHierarchyItem, ...) string
- func DiffCodeLens(uri span.URI, want, got []protocol.CodeLens) string
- func DiffCompletionItems(want, got []protocol.CompletionItem) string
- func DiffDiagnostics(uri span.URI, want, got []*source.Diagnostic) string
- func DiffLinks(mapper *protocol.ColumnMapper, wantLinks []Link, ...) string
- func DiffSignatures(spn span.Span, want, got *protocol.SignatureHelp) string
- func DiffSnippets(want string, got *protocol.CompletionItem) string
- func DiffSymbols(t *testing.T, uri span.URI, want, got []protocol.DocumentSymbol) string
- func DiffWorkspaceSymbols(want, got []protocol.SymbolInformation) string
- func EnableAllAnalyzers(view source.View, opts *source.Options)
- func FilterBuiltins(src span.Span, items []protocol.CompletionItem) []protocol.CompletionItem
- func FilterWorkspaceSymbols(got []protocol.SymbolInformation, dirs map[string]struct{}) []protocol.SymbolInformation
- func FindItem(list []protocol.CompletionItem, want completion.CompletionItem) *protocol.CompletionItem
- func Run(t *testing.T, tests Tests, data *Data)
- func RunTests(t *testing.T, dataDir string, includeMultiModule bool, ...)
- func SpanName(spn span.Span) string
- func ToProtocolCompletionItem(item completion.CompletionItem) protocol.CompletionItem
- func ToProtocolCompletionItems(items []completion.CompletionItem) []protocol.CompletionItem
- type CallHierarchy
- type CallHierarchyResult
- type CaseSensitiveCompletions
- type CodeLens
- type Completion
- type CompletionItems
- type CompletionSnippet
- type CompletionSnippets
- type CompletionTestType
- type Completions
- type Data
- type DeepCompletions
- type Definition
- type Definitions
- type Diagnostics
- type FoldingRanges
- type Formats
- type FunctionExtractions
- type FuzzyCompletions
- type Golden
- type Highlights
- type Implementations
- type Imports
- type Link
- type Links
- type PrepareRenames
- type RankCompletions
- type References
- type Renames
- type Signatures
- type SuggestedFixes
- type SymbolInformation
- type Symbols
- type SymbolsChildren
- type Tests
- type UnimportedCompletions
- type WorkspaceSymbols
- type WorkspaceSymbolsTestType
Constants ¶
const ( // Default runs the standard completion tests. CompletionDefault = CompletionTestType(iota) // Unimported tests the autocompletion of unimported packages. CompletionUnimported // Deep tests deep completion. CompletionDeep // Fuzzy tests deep completion and fuzzy matching. CompletionFuzzy // CaseSensitive tests case sensitive completion. CompletionCaseSensitive // CompletionRank candidates in test must be valid and in the right relative order. CompletionRank )
const ( // Default runs the standard workspace symbols tests. WorkspaceSymbolsDefault = WorkspaceSymbolsTestType(iota) // Fuzzy tests workspace symbols with fuzzy matching. WorkspaceSymbolsFuzzy // CaseSensitive tests workspace symbols with case sensitive. WorkspaceSymbolsCaseSensitive )
Variables ¶
var UpdateGolden = flag.Bool("golden", false, "Update golden files")
Functions ¶
func CheckCompletionOrder ¶
func CheckCompletionOrder(want, got []protocol.CompletionItem, strictScores bool) string
func CopyFolderToTempDir ¶
func DefaultOptions ¶
func DiffCallHierarchyItems ¶
func DiffCallHierarchyItems(gotCalls []protocol.CallHierarchyItem, expectedCalls []protocol.CallHierarchyItem) string
DiffCallHierarchyItems returns the diff between expected and actual call locations for incoming/outgoing call hierarchies
func DiffCompletionItems ¶
func DiffCompletionItems(want, got []protocol.CompletionItem) string
DiffCompletionItems prints the diff between expected and actual completion test results.
func DiffDiagnostics ¶
func DiffDiagnostics(uri span.URI, want, got []*source.Diagnostic) string
DiffDiagnostics prints the diff between expected and actual diagnostics test results.
func DiffLinks ¶
func DiffLinks(mapper *protocol.ColumnMapper, wantLinks []Link, gotLinks []protocol.DocumentLink) string
DiffLinks takes the links we got and checks if they are located within the source or a Note. If the link is within a Note, the link is removed. Returns an diff comment if there are differences and empty string if no diffs.
func DiffSignatures ¶
func DiffSignatures(spn span.Span, want, got *protocol.SignatureHelp) string
func DiffSnippets ¶
func DiffSnippets(want string, got *protocol.CompletionItem) string
func DiffSymbols ¶
DiffSymbols prints the diff between expected and actual symbols test results.
func DiffWorkspaceSymbols ¶
func DiffWorkspaceSymbols(want, got []protocol.SymbolInformation) string
DiffWorkspaceSymbols prints the diff between expected and actual workspace symbols test results.
func FilterBuiltins ¶
func FilterBuiltins(src span.Span, items []protocol.CompletionItem) []protocol.CompletionItem
func FilterWorkspaceSymbols ¶
func FilterWorkspaceSymbols(got []protocol.SymbolInformation, dirs map[string]struct{}) []protocol.SymbolInformation
FilterWorkspaceSymbols filters to got contained in the given dirs.
func FindItem ¶
func FindItem(list []protocol.CompletionItem, want completion.CompletionItem) *protocol.CompletionItem
func ToProtocolCompletionItem ¶
func ToProtocolCompletionItem(item completion.CompletionItem) protocol.CompletionItem
func ToProtocolCompletionItems ¶
func ToProtocolCompletionItems(items []completion.CompletionItem) []protocol.CompletionItem
Types ¶
type CallHierarchy ¶
type CallHierarchy map[span.Span]*CallHierarchyResult
type CallHierarchyResult ¶
type CallHierarchyResult struct {
IncomingCalls, OutgoingCalls []protocol.CallHierarchyItem
}
type CaseSensitiveCompletions ¶
type CaseSensitiveCompletions map[span.Span][]Completion
type Completion ¶
type CompletionItems ¶
type CompletionItems map[token.Pos]*completion.CompletionItem
type CompletionSnippet ¶
type CompletionSnippets ¶
type CompletionSnippets map[span.Span][]CompletionSnippet
type CompletionTestType ¶
type CompletionTestType int
type Completions ¶
type Completions map[span.Span][]Completion
type Data ¶
type Data struct { Config packages.Config Exported *packagestest.Exported CallHierarchy CallHierarchy CodeLens CodeLens Diagnostics Diagnostics CompletionItems CompletionItems Completions Completions CompletionSnippets CompletionSnippets UnimportedCompletions UnimportedCompletions DeepCompletions DeepCompletions FuzzyCompletions FuzzyCompletions CaseSensitiveCompletions CaseSensitiveCompletions RankCompletions RankCompletions FoldingRanges FoldingRanges Formats Formats Imports Imports SuggestedFixes SuggestedFixes FunctionExtractions FunctionExtractions Definitions Definitions Implementations Implementations Highlights Highlights References References Renames Renames PrepareRenames PrepareRenames Symbols Symbols WorkspaceSymbols WorkspaceSymbols FuzzyWorkspaceSymbols WorkspaceSymbols CaseSensitiveWorkspaceSymbols WorkspaceSymbols Signatures Signatures Links Links ModfileFlagAvailable bool // contains filtered or unexported fields }
type DeepCompletions ¶
type DeepCompletions map[span.Span][]Completion
type Definition ¶
type Definitions ¶
type Definitions map[span.Span]Definition
type Diagnostics ¶
type Diagnostics map[span.URI][]*source.Diagnostic
type FoldingRanges ¶
type FuzzyCompletions ¶
type FuzzyCompletions map[span.Span][]Completion
type PrepareRenames ¶
type PrepareRenames map[span.Span]*source.PrepareItem
type RankCompletions ¶
type RankCompletions map[span.Span][]Completion
type Signatures ¶
type Signatures map[span.Span]*protocol.SignatureHelp
type SuggestedFixes ¶
type SymbolInformation ¶
type SymbolInformation map[span.Span]protocol.SymbolInformation
type SymbolsChildren ¶
type SymbolsChildren map[string][]protocol.DocumentSymbol
type Tests ¶
type Tests interface { CallHierarchy(*testing.T, span.Span, *CallHierarchyResult) CodeLens(*testing.T, span.URI, []protocol.CodeLens) Diagnostics(*testing.T, span.URI, []*source.Diagnostic) Completion(*testing.T, span.Span, Completion, CompletionItems) CompletionSnippet(*testing.T, span.Span, CompletionSnippet, bool, CompletionItems) UnimportedCompletion(*testing.T, span.Span, Completion, CompletionItems) DeepCompletion(*testing.T, span.Span, Completion, CompletionItems) FuzzyCompletion(*testing.T, span.Span, Completion, CompletionItems) CaseSensitiveCompletion(*testing.T, span.Span, Completion, CompletionItems) RankCompletion(*testing.T, span.Span, Completion, CompletionItems) FoldingRanges(*testing.T, span.Span) Format(*testing.T, span.Span) Import(*testing.T, span.Span) SuggestedFix(*testing.T, span.Span, []string) FunctionExtraction(*testing.T, span.Span, span.Span) Definition(*testing.T, span.Span, Definition) Implementation(*testing.T, span.Span, []span.Span) Highlight(*testing.T, span.Span, []span.Span) References(*testing.T, span.Span, []span.Span) Rename(*testing.T, span.Span, string) PrepareRename(*testing.T, span.Span, *source.PrepareItem) Symbols(*testing.T, span.URI, []protocol.DocumentSymbol) WorkspaceSymbols(*testing.T, string, []protocol.SymbolInformation, map[string]struct{}) FuzzyWorkspaceSymbols(*testing.T, string, []protocol.SymbolInformation, map[string]struct{}) CaseSensitiveWorkspaceSymbols(*testing.T, string, []protocol.SymbolInformation, map[string]struct{}) SignatureHelp(*testing.T, span.Span, *protocol.SignatureHelp) Link(*testing.T, span.URI, []Link) }
type UnimportedCompletions ¶
type UnimportedCompletions map[span.Span][]Completion
type WorkspaceSymbols ¶
type WorkspaceSymbols map[string][]protocol.SymbolInformation
type WorkspaceSymbolsTestType ¶
type WorkspaceSymbolsTestType int