Discover tests via LSP if available #767
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
plemarquand
requested review from
adam-fowler,
daveyc123,
matthewbastien and
award999
|
Note: This will only work with the latest sourcekit-lsp. To test you can clone the sourcekit-lsp repo, |
award999
reviewed
Apr 25, 2024
award999
reviewed
Apr 26, 2024
adam-fowler
reviewed
Apr 29, 2024
If the LSP is available and supports the two requests for listing tests then use those to discover tests in the workspace/document. If these requests are unsupported or if they fail, fall back to the existing methods. This patch uses the existing code to leverage the LSP's workspace/tests method and adds the textDocument/tests for listing tests within documents as they change. These requests produce a collection of TestClass structures, which are hierarchical. These are passed to one of the methods in TestDiscovery.ts which diffs against the existing tree and adds/removes tests. This is similar to how it already worked, but now supports arbitrary levels of nesting in the TestClass structure. This patch also adds preliminary support for listing swift-testing tests through the LSP methods, as well as through `swift test --list-tests`. It does not support finding swift-testing tests through the document symbols. Another small improvement is if listing tests fails via `swift test --list-tests` we'll attempt a `swift build --build-tests` before trying again. If the user was on the 5.10 toolchain and no build had yet been performed they would get an error. Swift-testing tests are filtered out of the list of available tests until code is added to run them. This will be added with swiftlang#757. - Adds tests for parsing the results of `swift test --list-tests` - Adds tests for parsing tests via document symbols This patch addresses both swiftlang#761 and swiftlang#762.
plemarquand
force-pushed
the
lsp-test-discovery
branch
from
f391a56 to
d587d81
Compare
adam-fowler
approved these changes
Apr 29, 2024
|
Before merging this I thought I'd test swift 5.10 and it looks like the document symbols loading isn't working |
|
Ah I see what you have done. By converting to the |
plemarquand
added a commit
that referenced
this pull request
Apr 29, 2024
This reverts commit 0f21573.
plemarquand
added a commit
to plemarquand/vscode-swift
that referenced
this pull request
Apr 29, 2024
If the LSP is unavailable `swift test list` will be used to enumerate the tests. This method cannot attach a location to the TestClasses. The code pre swiftlang#767 took this in to account, but swiftlang#767 introduced a regression that would overwrite an existing item enumerated by document symbols which had a location with one that didn't.
plemarquand
added a commit
that referenced
this pull request
Apr 30, 2024
If the LSP is unavailable `swift test list` will be used to enumerate the tests. This method cannot attach a location to the TestClasses. The code pre #767 took this in to account, but #767 introduced a regression that would overwrite an existing item enumerated by document symbols which had a location with one that didn't.
This was referenced Apr 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If the LSP is available and supports the two requests for listing tests then use those to discover tests in the workspace/document. If these requests are unsupported or if they fail, fall back to the existing methods.
This patch uses the existing code to leverage the LSP's workspace/tests method and adds the textDocument/tests for listing tests within documents as they change.
These requests produce a collection of TestClass structures, which are hierarchical. These are passed to one of the methods in TestDiscovery.ts which diffs against the existing tree and adds/removes tests. This is similar to how it already worked, but now supports arbitrary levels of nesting in the TestClass structure.
This patch also adds preliminary support for listing swift-testing tests through the LSP methods, as well as through
swift test --list-tests. It does not support finding swift-testing tests through the document symbols.Another small improvement is if listing tests fails via
swift test --list-testswe'll attempt aswift build --build-testsbefore trying again. Today, if the user was on the 5.10 toolchain and no build had yet been performed they would get a somewhat cryptic error in the test explorer.Swift-testing tests are filtered out of the list of available tests until code is added to run them. This will be added with #757.
swift test --list-testsThis patch addresses both #761 and #762.