lsp-test
Functional test framework for LSP servers.
https://github.com/haskell/lsp/blob/master/lsp-test/README.md
LTS Haskell 22.33: | 0.16.0.1 |
Stackage Nightly 2024-09-07: | 0.17.1.0 |
Latest on Hackage: | 0.17.1.0 |
lsp-test-0.17.1.0@sha256:f54757a564b46783cf67b13f4cb4ebc45e43f5afc3604d9757ee387c091b73e9,4406
Module documentation for 0.17.1.0
- Language
- Language.LSP
lsp-test
lsp-test is a functional testing framework for Language Server Protocol servers.
It is part of the lsp family of packages, along with lsp and lsp-types
import Language.LSP.Test
main = runSession "hie" fullLatestClientCaps "proj/dir" $ do
doc <- openDoc "Foo.hs" "haskell"
skipMany anyNotification
symbols <- getDocumentSymbols doc
Examples
Unit tests with HSpec
describe "diagnostics" $
it "report errors" $ runSession "hie" fullLatestClientCaps "test/data" $ do
openDoc "Error.hs" "haskell"
[diag] <- waitForDiagnosticsSource "ghcmod"
liftIO $ do
diag ^. severity `shouldBe` Just DsError
diag ^. source `shouldBe` Just "ghcmod"
Replaying captured session
replaySession "hie" "test/data/renamePass"
Parsing with combinators
skipManyTill loggingNotification publishDiagnosticsNotification
count 4 (message :: Session ApplyWorkspaceEditRequest)
anyRequest <|> anyResponse
Try out the example tests in the example
directory with cabal test
.
For more examples see this introductory blog post.
Whilst writing your tests you may want to debug them to see what’s going wrong.
You can set the logMessages
and logStdErr
options in SessionConfig
to see what the server is up to.
There are also corresponding environment variables so you can turn them on from the command line:
LSP_TEST_LOG_MESSAGES=1 LSP_TEST_LOG_STDERR=1 cabal test
Developing
The tests for lsp-test use a dummy server found in test/dummy-server/
.
Run the tests with cabal test
or stack test
.
Tip: If you want to filter the tests, use cabal run test:tests -- -m "foo"
Troubleshooting
Seeing funny stuff when running lsp-test via stack? If your server is built upon Haskell tooling, keep in mind that stack sets some environment variables related to GHC, and you may want to unset them.
Changes
Revision history for lsp-test
0.17.1.0 – 2024-06-06
- Add helpers for testing inlay hints.
0.17.0.2
- Support for newer versions of dependencies.
0.17.0.1
- Support for newer versions of dependencies.
0.17.0.0
ignoreRegistrationRequests
option to ignoreclient/registerCapability
requests, on by default.- New functions
setIgnoringRegistrationRequests
to change whether such messages are ignored during aSession
without having to change theSessionConfig
. lsp-test
will no longer sendworkspace/didChangConfiguration
notifications unless the server dynamically registers for them.
0.16.0.1
- Support newer versions of dependencies.
0.16.0.0
- The client configuration is now mandatory and is an
Object
rather than aValue
. lsp-test
now responds toworkspace/configuration
requests.lsp-test
does not send aworkspace/didChangeConfiguration
request on startup.- New functions for modifying the client configuration and notifying the server.
ignoreLogNotifications
is now on by default. Experience shows the norm is to ignore these and it is simpler to turn this on only when they are required.ignoreConfigurationRequests
option to ignoreworkspace/configuration
requests, also on by default.- New functions
setIgnoringLogNotifications
andsetIgnoringConfigurationRequests
to change whether such messages are ignored during aSession
without having to change theSessionConfig
.
0.15.0.1
- Adds helper functions to resolve code lens, code actions, and completion items.
0.15.0.0
- Support
lsp-types-2.0.0.0
andlsp-2.0.0.0
.
0.14.1.0
- Compatibility with new
lsp-types
major version. - Export
runSessionWithConfigCustomProcess
to allow modifying the CreateProcess used to start a server - Add
MonadThrow
instance forSession
0.14.0.3
- Compatibility with new
lsp-types
major version.
0.14.0.2
- Compatibility with new
lsp-types
major version.
0.14.0.1 – 2021-07-30
- Catch IO exception when sending messages to server (#317) (@berberman)
- Improve error messages on JSON decode failures (#320) (@strager)
- Add tests for satisfyMaybe (#325) (@strager)
- Add call hierarchy support (@July541)
- pass the lspConfig at initialization time as well (@pepeiborra)
- Semantic tokens support (@michaelpj)
0.13.0.0 – 2021-03-26
- Update for lsp-types-1.2 (@wz1000)
- Limit diagnostics by range in getCodeActions (@aufarg)
- Kill timeout thread to avoid building up thousands of old TimeoutMessages (@wz1000)
0.13.0.0 – 2021-02-14
- Add support for lsp-types-1.1 (@wz1000)
- Automatically respond to
workspace/applyEdit
andwindow/workDoneProgress/create
messages (@wz1000)
0.12.0.0 – 2021-01-25
- Add
getIncompleteProgressSessions
to track ongoing progress sessions (@wz1000)
0.11.0.0 – 2020-05-14
- Replace
openDoc'
withcreateDoc
which now sendsworkspace/didChangeWatchedFiles
notifications if the server has registered for it - Add
getRegisteredCapabilities
0.10.3.0 – 2020-05-04
- Build with new haskell-lsp-0.22
0.10.2.0 – 2020-03-21
- Bump constraints for new haskell-lsp
0.10.1.0 – 2020-02-04
- Bump constraints for new haskell-lsp
0.10.0.0 – 2019-12-29
- Account for messages received between the initialize request and response. (Though it will throw an exception if the message received is an illegal one)
0.9.0.0 – 2019-12-1
- Add
ignoreLogNotifications
config option - Add ability to override
logStdErr
andlogMessages
config options with theLSP_TEST_LOG_STDERR
andLOG_TEST_LOG_MESSAGES
environment variables - Update for haskell-lsp-0.19.0.0 (@mpickering)
0.8.2.0 – 2019-11-17
- Expose
satisfyMaybe
(@cocreature)
0.8.1.0 – 2019-11-17
- Update to haskell-lsp-0.18.0.0 (@mpickering, @alanz)
- Tests now require hie-bios based hie
0.8.0.0 – 2019-10-18
- Make
Session
a newtype - Update for haskell-lsp-0.17.0.0 (@cocreature)
0.7.0.0 – 2019-09-08
- Update for haskell-lsp-0.16.0.0
0.6.1.0 – 2019-08-24
- Add
satisfyMaybe
(@cocreature)
0.6.0.0 – 2019-07-04
- Update to haskell-lsp-0.15.0.0 (@lorenzo)
0.5.4.0 – 2019-06-13
- Fix
getDefinitions
for SingleLoc (@cocreature) - Add
getCodeLenses
(@cocreature)
0.5.3.0 – 2019-06-13
- Update to haskell-lsp-0.14.0.0 (@cocreature)
- Support
TextDocumentDidChange
(@cocreature) - Add non-file based
openDoc
(@cocreature)
0.5.2.0 – 2019-04-28
- Add
satisfy
parser combinator
0.5.1.0 – 2019-04-22
- Fix unhandled
window/progress
server notifications
0.5.1.0 – 2019-04-07
- Add getTypeDefinitions (@fendor)
0.5.0.2 – 2018-12-05
- Fix loose threads when exceptions are thrown
0.5.0.0 – 2018-11-13
- Add lspConfig option in config
- GHC 8.6.2 support
0.4.0.0 – 2018-09-08
- Update to haskell-lsp-0.8.0.0
0.3.0.0 – 2018-09-0t
- Update to haskell-lsp-0.7.0.0
0.2.1.0 – 2018-08-14
- Add getCodeActions
- Add getCurrentDiagnostics
0.2.0.0 – 2018-08-06
- Update to haskell-lsp 0.6.0.0