1
0
mirror of https://github.com/golang/go synced 2024-11-18 17:04:41 -07:00
go/internal
Rob Findley f9587291b6 internal/lsp/fake: add fakes for testing editor interaction
A lot of bug reports originating from LSP clients are related to either
the timing or sequence of editor interactions with gopls (or at least
they're originally reported this way). For example: "when I open a
package and then create a new file, I lose diagnostics for existing
files".  These conditions are often hard to reproduce, and to isolate as
either a gopls bug or a bug in the editor.

Right now we're relying on govim integration tests to catch these
regressions, but it's important to also have a testing framework that
can exercise this functionality in-process.  As a starting point this CL
adds test fakes that implement a high level API for scripting editor
interactions. A fake workspace can be used to sandbox file operations; a
fake editor provides an interface for text editing operations; a fake
LSP client can be used to connect the fake editor to a gopls instance.
Some tests are added to the lsprpc package to demonstrate the API.

The primary goal of these fakes should be to simulate an client that
complies to the LSP spec. Put another way: if we have a bug report that
we can't reproduce with our regression tests, it should either be a bug
in our test fakes or a bug in the LSP client originating the report.

I did my best to comply with the spec in this implementation, but it
will certainly develop as we write more tests. We will also need to add
to the editor API in the future for testing more language features.

Updates golang/go#36879
Updates golang/go#34111

Change-Id: Ib81188683a7066184b8a254275ed5525191a2d68
Reviewed-on: https://go-review.googlesource.com/c/tools/+/217598
Run-TryBot: Robert Findley <rfindley@google.com>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Rebecca Stambler <rstambler@golang.org>
2020-02-10 17:44:19 +00:00
..
apidiff all: fix more typos 2019-09-11 15:13:14 +00:00
fastwalk all: fix some staticcheck errors 2020-01-29 04:53:41 +00:00
gopathwalk all: fix some staticcheck errors 2020-01-29 04:53:41 +00:00
imports internal/imports: prevent self-imports in the stdlib 2020-02-06 00:08:43 +00:00
jsonrpc2 internal/lsp: refactor LSP server instantiation 2020-02-06 23:12:37 +00:00
lsp internal/lsp/fake: add fakes for testing editor interaction 2020-02-10 17:44:19 +00:00
memoize internal/lsp/debug: serve cache entry counts 2020-02-03 22:21:18 +00:00
module
packagesinternal go/packages: internally expose ForTests in go/packages 2020-01-16 22:11:50 +00:00
semver
span internal/span, internal/lsp: fix URI escaping 2020-02-04 00:54:49 +00:00
telemetry all: fix some staticcheck errors 2020-01-29 04:53:41 +00:00
testenv internal/testenv: reject the resolved 'go' command if it does not match runtime.GOROOT 2019-11-11 19:22:22 +00:00
tool internal/lsp, internal/tool: clean up command line of gopls 2019-12-16 17:36:52 +00:00
xcontext internal/lsp: stop making background contexts everywhere 2019-07-11 16:38:52 +00:00