lsp-test: Functional test framework for LSP servers.

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

A test framework for writing tests against Language Server Protocol servers. Language.Haskell.LSP.Test launches your server as a subprocess and allows you to simulate a session down to the wire, and Language.Haskell.LSP.Test can replay captured sessions from It's currently used for testing in haskell-ide-engine.

[Skip to Readme]


Change log
Dependencies aeson, aeson-pretty, ansi-terminal, async, base (>=4.10 && <5), bytestring, conduit, conduit-parse (>=0.2 && <0.3), containers (>=0.5.9), data-default, Diff, directory, filepath, haskell-lsp (>=0.19 && <0.22), lens, mtl, parser-combinators (>=1.2), process (>=1.6), text, transformers, unix, unordered-containers, Win32 [details]
License BSD-3-Clause
Copyright 2019 Luke Lau
Author Luke Lau
Category Testing
Home page
Bug tracker
Source repo head: git clone
Uploaded by luke_ at 2020-03-21T16:58:33Z


[Index] [Quick Jump]


Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Readme for lsp-test-

[back to package description]

lsp-test Actions Status Hackage

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


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


The tests are integration tests, so make sure you have the following language servers installed and on your PATH:



npm i -g javascript-typescript-langserver

Then run the tests with cabal test or stack test.


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.