Rebuild test subsystems

[firelizzard18]

Go Companion

Go Companion provides an alternative test explorer implementation that uses gopls to discover tests and addresses multiple issues with my original test explorer implementation (which is what vscode-go uses currently).

If you wish to use Go Companion's test explorer, you must:

• Upgrade gopls. Either install from source or wait for v0.17 to be released.
• Install the Go Companion extension.
• Disable the old implementation by setting "go.testExplorer.enable": false.

---

I created this issue to track my work on rebuilding the test explorer and other test subsystems. This work will be done in a separate repository until it is sufficiently complete to merge.

Goals

• Move test discovery out of the extension into gopls.
• Improve code quality and robustness of VSCode's Testing API/provider.
• Unify all test support into a single system.

Non-goals

• Sophisticated subtest discovery. Test and subtest discovery will be handled by gopls instead of the extension, so no further work on the extension will be needed (barring unforeseen issues). Improvements to gopls's subtest discovery will be available as soon as they are released and the user updates gopls.

Tasks

• Implement gopls.modules command
• Implement gopls.packages command
• Add test discovery to gopls.packages
• Implement VSCode's Testing API using gopls for discovery.
• Implement legacy code lenses.
• Improved configurability
  • Include files in the tree.
  • Enable nesting of packages.
  • Disable nesting of subtests.
  • Disable automatic discovery of tests.
• Debug multiple tests (within the same package).
• Support profiling tests/benchmarks.

Nice to have

• Support continuous runs (Allow Test Explorer UI To Automatically Trigger Testing On Save #1952, Update test explorer when tests run from "go.testOnSave" #2483)
• Support files.exclude (Respecting vscode exclude directives. #1739)
• Add support for test coverage (Use the new Testing API to show coverage counts for files and "Run With Coverage" button #3331)
• Support build tags (src/goTestExplorer: improve handling of tests in files with build tags #1673)
• Address the backlog of testing issues.

[firelizzard18]

@hyangah VSCode has commands for running tests at the cursor:

And also commands for rerunning the last test run:

It seems like a number of vscode-go's test commands could be deprecated. Maybe for the time being we replace them with calls to the vscode command and show a deprecation notification? WDYT?

[firelizzard18]

I think this issue has served its purpose so I'm going to close it.

For future readers: once gopls v0.17 is prereleased and CL 613695 is merged, you can install Go Companion and vscode-go will automatically switch to the new implementation. Or you can install a bleeding edge version of gopls, install Go Companion, and manually disable vscode-go's test implementation.