lsp-test
Functional test framework for LSP servers.
https://github.com/bubba/lsp-test#readme
| Version on this page: | 0.10.3.0 |
| LTS Haskell 23.0: | 0.17.1.0 |
| Stackage Nightly 2024-12-09: | 0.17.1.0 |
| Latest on Hackage: | 0.17.1.0 |
Maintained by [email protected]
This version can be pinned in stack with:
lsp-test-0.10.3.0@sha256:29acbf365bdc4b1de0824ca915cb9e3b584fb615a57bf7126b312567a0ed10ad,3487Module documentation for 0.10.3.0
- Language
- Language.Haskell
- Language.Haskell.LSP
- Language.Haskell
Depends on 22 packages(full list with versions):
lsp-test 
lsp-test is a functional testing framework for Language Server Protocol servers.
import Language.Haskell.LSP.Test
main = runSession "hie" fullCaps "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" fullCaps "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 check the Wiki
Developing
The tests are integration tests, so make sure you have the following language servers installed and on your PATH:
haskell-ide-engine
- Check out a relatively recent version of the repo, or see
.travis.ymlto get the exact commit used for CI. stack install
javascript-typescript-langserver
npm i -g javascript-typescript-langserver
Then run the tests with cabal test or stack test.
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.