1 # lsp-test [![Actions Status](https://github.com/bubba/lsp-test/workflows/Haskell%20CI/badge.svg)](https://github.com/bubba/lsp-test/actions) [![Hackage](https://img.shields.io/hackage/v/lsp-test.svg)](https://hackage.haskell.org/package/lsp-test-0.1.0.0)
2 lsp-test is a functional testing framework for Language Server Protocol servers.
5 import Language.Haskell.LSP.Test
6 main = runSession "hie" fullCaps "proj/dir" $ do
7 doc <- openDoc "Foo.hs" "haskell"
8 skipMany anyNotification
9 symbols <- getDocumentSymbols doc
14 ### Unit tests with HSpec
16 describe "diagnostics" $
17 it "report errors" $ runSession "hie" fullCaps "test/data" $ do
18 openDoc "Error.hs" "haskell"
19 [diag] <- waitForDiagnosticsSource "ghcmod"
21 diag ^. severity `shouldBe` Just DsError
22 diag ^. source `shouldBe` Just "ghcmod"
25 ### Replaying captured session
27 replaySession "hie" "test/data/renamePass"
30 ### Parsing with combinators
32 skipManyTill loggingNotification publishDiagnosticsNotification
33 count 4 (message :: Session ApplyWorkspaceEditRequest)
34 anyRequest <|> anyResponse
37 Try out the example tests in the `example` directory with `cabal test`.
38 For more examples check the [Wiki](https://github.com/bubba/lsp-test/wiki/Introduction)
41 The tests are integration tests, so make sure you have the following language servers installed and on your PATH:
42 ### [haskell-ide-engine](https://github.com/haskell/haskell-ide-engine)
43 - Check out a relatively recent version of the repo, or see `.travis.yml` to get the exact commit used for CI.
45 ### [javascript-typescript-langserver](https://github.com/sourcegraph/javascript-typescript-langserver)
46 `npm i -g javascript-typescript-langserver`
48 Then run the tests with `cabal test` or `stack test`.
51 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.](https://github.com/alanz/haskell-ide-engine/blob/bfb16324d396da71000ef81d51acbebbdaa854ab/test/utils/TestUtils.hs#L290-L298)