History

Michael Matloob be40034de7 internal/lsp: add support for formatting go.work files Wired through support for calling x/mod's go.work formatter on go.work files into LSP. Tested it by hand in editor using the "Format Document" command. Added a test case to workspace_test regtest, though I'm not totally sure the test is correct. For golang/go#50930 Change-Id: Ied052ded514bb36f561737698f0e2d7b488158e7 Reviewed-on: https://go-review.googlesource.com/c/tools/+/383774 Trust: Michael Matloob <matloob@golang.org> Run-TryBot: Michael Matloob <matloob@golang.org> gopls-CI: kokoro <noreply+kokoro@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Robert Findley <rfindley@google.com>		2022-02-15 17:15:32 +00:00
..
README.md	internal/lsp/semantic: fix some type definitions	2021-03-30 15:15:52 +00:00
normalizer.go	internal/lsp: rewrite the workspace symbol marker tests	2020-11-24 17:38:01 +00:00
tests.go	internal/lsp: add support for formatting go.work files	2022-02-15 17:15:32 +00:00
util.go	internal/lsp: normalize interface{} to any in test comparisons	2021-12-09 13:40:01 +00:00

README.md

Testing

LSP has "marker tests" defined in internal/lsp/testdata, as well as traditional tests.

Marker tests

Marker tests have a standard input file, like internal/lsp/testdata/foo/bar.go, and some may have a corresponding golden file, like internal/lsp/testdata/foo/bar.go.golden. The former is the "input" and the latter is the expected output.

Each input file contains annotations like //@suggestedfix("}", "refactor.rewrite"). These annotations are interpreted by test runners to perform certain actions. The expected output after those actions is encoded in the golden file.

When tests are run, each annotation results in a new subtest, which is encoded in the golden file with a heading like,

-- suggestedfix_bar_11_21 --
// expected contents go here
-- suggestedfix_bar_13_20 --
// expected contents go here

The format of these headings vary: they are defined by the Golden function for each annotation. In the case above, the format is: annotation name, file name, annotation line location, annotation character location.

So, if internal/lsp/testdata/foo/bar.go has three suggestedfix annotations, the golden file should have three headers with suggestedfix_bar_xx_yy headings.

To see a list of all available annotations, see the exported "expectations" in tests.go.

To run marker tests,

cd /path/to/tools

# The marker tests are located in "internal/lsp", "internal/lsp/cmd, and
# "internal/lsp/source".
go test ./internal/lsp/...

There are quite a lot of marker tests, so to run one individually, pass the test path and heading into a -run argument:

cd /path/to/tools
go test ./internal/lsp/... -v -run TestLSP/Modules/SuggestedFix/bar_11_21

Resetting marker tests

Sometimes, a change is made to lsp that requires a change to multiple golden files. When this happens, you can run,

cd /path/to/tools
./internal/lsp/reset_golden.sh