| commit | 2b149ce94bddeffe0922f298a327f9f7fc5a4fce | [log] [tgz] |
|---|---|---|
| author | Robert Findley <rfindley@google.com> | Fri Feb 03 18:21:28 2023 -0500 |
| committer | Robert Findley <rfindley@google.com> | Tue Feb 07 20:32:51 2023 +0000 |
| tree | f3eb4e34d83afaeeb0c7f01d27c713793234ae8d | |
| parent | edddc5fc3223b7f12772f78079fcbcac3bd47d97 [diff] |
gopls/internal/regtest: add a regtest-based version of the marker tests Add a new implementation of the gopls marker tests that shares the same testing environment as the regression tests. Along the way, revisit the semantics of the marker framework, to address some problems we've identified over the years. Specifically: - Split tests into self-contained txtar encoded files. Each file determines an isolated set of markers, and is executed in a separate session. - Change the mechanisms for golden content, so that it is joined by identifiers, and passed to the test method as an argument. This makes it more apparent where golden content is used, and makes the identity of golden content stable under manipulations of the source (as opposed to some arbitrary munging of the note position) - Allow custom argument conversion that may be convenient for LSP-based test functions, by avoiding the packagestest framework and instead building directly on top of the x/tools/go/expect package. As an initial proof of concept, this allowed using a protocol.Location as a test method argument. - Add significant documentation and examples. - Deprecate the @hover marker in the old marker tests (gopls/internal/lsp). I believe that this lays the foundation to address the remaining concerns enumerated in golang/go#54845, as this new design solves the isolation problem, the problem of golden file naming, and the lack of clarity around the definition and construction of test annotations. For golang/go#54845 Change-Id: I796f35c14370b9651316baa1f86c21c63cec25c7 Reviewed-on: https://go-review.googlesource.com/c/tools/+/465255 TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Alan Donovan <adonovan@google.com> Run-TryBot: Robert Findley <rfindley@google.com> gopls-CI: kokoro <noreply+kokoro@google.com>
This repository provides the golang.org/x/tools module, comprising various tools and packages mostly for static analysis of Go programs, some of which are listed below. Use the “Go reference” link above for more information about any package.
It also contains the golang.org/x/tools/gopls module, whose root package is a language-server protocol (LSP) server for Go. An LSP server analyses the source code of a project and responds to requests from a wide range of editors such as VSCode and Vim, allowing them to support IDE-like functionality.
Selected commands:
cmd/goimports formats a Go program like go fmt and additionally inserts import statements for any packages required by the file after it is edited.cmd/callgraph prints the call graph of a Go program.cmd/digraph is a utility for manipulating directed graphs in textual notation.cmd/stringer generates declarations (including a String method) for “enum” types.cmd/toolstash is a utility to simplify working with multiple versions of the Go toolchain.These commands may be fetched with a command such as
go install golang.org/x/tools/cmd/goimports@latest
Selected packages:
go/ssa provides a static single-assignment form (SSA) intermediate representation (IR) for Go programs, similar to a typical compiler, for use by analysis tools.
go/packages provides a simple interface for loading, parsing, and type checking a complete Go program from source code.
go/analysis provides a framework for modular static analysis of Go programs.
go/callgraph provides call graphs of Go programs using a variety of algorithms with different trade-offs.
go/ast/inspector provides an optimized means of traversing a Go parse tree for use in analysis tools.
go/cfg provides a simple control-flow graph (CFG) for a Go function.
go/expect reads Go source files used as test inputs and interprets special comments within them as queries or assertions for testing.
go/gcexportdata and go/gccgoexportdata read and write the binary files containing type information used by the standard and gccgo compilers.
go/types/objectpath provides a stable naming scheme for named entities (“objects”) in the go/types API.
Numerous other packages provide more esoteric functionality.
This repository uses Gerrit for code changes. To learn how to submit changes, see https://golang.org/doc/contribute.html.
The main issue tracker for the tools repository is located at https://github.com/golang/go/issues. Prefix your issue with “x/tools/(your subdir):” in the subject line, so it is easy to find.
This repository uses prettier to format JS and CSS files.
The version of prettier used is 1.18.2.
It is encouraged that all JS and CSS code be run through this before submitting a change. However, it is not a strict requirement enforced by CI.