lsp-test: Functional test framework for LSP servers.

[ bsd3, library, testing ] [ Propose Tags ]

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 https://hackage.haskell.org/package/haskell-lsp. It's currently used for testing in haskell-ide-engine.


[Skip to Readme]
Versions [faq] 0.1.0.0, 0.2.0.0, 0.2.1.0, 0.3.0.0, 0.4.0.0, 0.5.0.0, 0.5.0.1, 0.5.0.2, 0.5.1.0, 0.5.1.1, 0.5.1.2, 0.5.1.3, 0.5.1.4, 0.5.2.0, 0.5.2.1, 0.5.2.2, 0.5.2.3, 0.5.3.0, 0.5.4.0, 0.6.0.0
Change log ChangeLog.md
Dependencies aeson, aeson-pretty, ansi-terminal, async, base (>=4.10 && <5), bytestring, conduit, conduit-parse, containers, data-default, Diff, directory, filepath, haskell-lsp (==0.15.*), lens, mtl, parser-combinators, process, rope-utf16-splay, text, transformers, unix, unordered-containers, Win32 [details]
License BSD-3-Clause
Copyright 2019 Luke Lau
Author Luke Lau
Maintainer luke_lau@icloud.com
Category Testing
Home page https://github.com/bubba/lsp-test#readme
Bug tracker https://github.com/bubba/lsp-test/issues
Source repo head: git clone https://github.com/bubba/lsp-test/
Uploaded by luke_ at Thu Jul 4 00:29:30 UTC 2019
Distributions LTSHaskell:0.5.1.2, NixOS:0.6.0.0, Stackage:0.5.4.0
Downloads 2076 total (152 in the last 30 days)
Rating 2.0 (votes: 1) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2019-07-04 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for lsp-test-0.6.0.0

[back to package description]

lsp-test Build Status Hackage

lsp-test is a functional testing framework for Language Server Protocol servers.

import Language.Haskell.LSP.Test
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 new-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.yml to get the exact commit used for CI.
  • stack install

javascript-typescript-langserver

npm i -g javascript-typescript-langserver

Then run the tests with stack test or cabal new-test.