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]

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]

Properties

Versions0.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.0.2
Change logChangeLog.md
Dependenciesaeson, aeson-pretty, ansi-terminal, base (>=4.7 && <5), bytestring, conduit, conduit-parse, containers, data-default, Diff, directory, filepath, haskell-lsp (==0.8.*), lens, mtl, parser-combinators, process, text, transformers, unix, unordered-containers, Win32, yi-rope [details]
LicenseBSD-3-Clause
Copyright2018 Luke Lau
AuthorLuke Lau
Maintainerluke_lau@icloud.com
CategoryTesting
Home pagehttps://github.com/Bubba/haskell-lsp-test#readme
Bug trackerhttps://github.com/Bubba/haskell-lsp-test/issues
Source repositoryhead: git clone https://github.com/Bubba/haskell-lsp-test/
UploadedWed Dec 5 01:29:53 UTC 2018 by luke_

Modules

[Index]

Downloads

Maintainers' corner

For package maintainers and hackage trustees


Readme for lsp-test-0.5.0.2

[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

To test make sure you have the following language servers installed: