Hackage :: [Package]

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.LSP.Test launches your server as a subprocess and allows you to simulate a session down to the wire. To see examples of it in action, check out haskell-ide-engine, haskell-language-server and ghcide.

[Skip to Readme]

Modules

[Index] [Quick Jump]

  • Control
    • Applicative
      • Control.Applicative.Combinators
  • Language
    • LSP
      • Protocol
        • Language.LSP.Protocol.Capabilities
        • Language.LSP.Protocol.Message
        • Language.LSP.Protocol.Types
      • Language.LSP.Test

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Versions [RSS] 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, 0.6.1.0, 0.7.0.0, 0.8.0.0, 0.8.1.0, 0.8.2.0, 0.9.0.0, 0.10.0.0, 0.10.1.0, 0.10.2.0, 0.10.3.0, 0.11.0.0, 0.11.0.1, 0.11.0.2, 0.11.0.3, 0.11.0.4, 0.11.0.5, 0.11.0.6, 0.11.0.7, 0.12.0.0, 0.13.0.0, 0.14.0.0, 0.14.0.1, 0.14.0.2, 0.14.0.3, 0.14.1.0, 0.15.0.0, 0.15.0.1, 0.16.0.0, 0.16.0.1, 0.17.0.0, 0.17.0.1, 0.17.0.2, 0.17.1.0
Change log ChangeLog.md
Dependencies aeson (>=2 && <2.3), aeson-pretty (>=0.8 && <0.9), ansi-terminal (>=0.10 && <1.2), async (>=2.2 && <2.3), base (>=4.10 && <5), bytestring (>=0.10 && <0.13), co-log-core (>=0.3 && <0.4), conduit (>=1.3 && <1.4), conduit-parse (>=0.2 && <0.3), containers (>=0.6 && <0.7), data-default (>=0.7 && <0.8), Diff (>=0.4 && <0.6), directory (>=1.3 && <1.4), exceptions (>=0.10 && <0.11), extra (>=1.7 && <1.8), filepath (>=1.4 && <1.6), Glob (>=0.9 && <0.11), lens (>=5.1 && <5.3), lens-aeson (>=1.2 && <1.3), lsp (>=2.4 && <2.5), lsp-types (>=2.1 && <2.2), mtl (>=2.2 && <2.4), parser-combinators (>=1.3 && <1.4), process (>=1.6 && <1.7), row-types (>=1.0 && <1.1), some (>=1.0 && <1.1), text (>=1 && <2.2), time (>=1.10 && <1.13), transformers (>=0.5 && <0.7), unix, Win32 [details]
License BSD-3-Clause
Copyright 2021 Luke Lau
Author Luke Lau
Maintainer luke_lau@icloud.com
Revised Revision 1 made by michaelpj at 2024-02-26T11:21:50Z
Category Testing
Home page https://github.com/haskell/lsp/blob/master/lsp-test/README.md
Bug tracker https://github.com/haskell/lsp/issues
Source repo head: git clone https://github.com/haskell/lsp
Uploaded by michaelpj at 2024-02-05T14:23:05Z
Distributions Arch:0.14.1.0, LTSHaskell:0.16.0.1, NixOS:0.17.1.0, Stackage:0.17.1.0
Reverse Dependencies 4 direct, 0 indirect [details]
Downloads 33104 total (210 in the last 30 days)
Rating 2.0 (votes: 1) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2024-02-05 [all 1 reports]

Readme for lsp-test-0.17.0.0

[back to package description]

lsp-test

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

It is part of the lsp family of packages, along with lsp and lsp-types

import Language.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 see this introductory blog post.

Whilst writing your tests you may want to debug them to see what's going wrong. You can set the logMessages and logStdErr options in SessionConfig to see what the server is up to. There are also corresponding environment variables so you can turn them on from the command line:

LSP_TEST_LOG_MESSAGES=1 LSP_TEST_LOG_STDERR=1 cabal test

Developing

The tests for lsp-test use a dummy server found in test/dummy-server/. Run the tests with cabal test or stack test. Tip: If you want to filter the tests, use cabal run test:tests -- -m "foo"

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.