haskell · lukel97 · Mar 22, 2021 · Mar 6, 2021 · Mar 6, 2021 · Mar 6, 2021
diff --git a/.gitignore b/.gitignore
@@ -5,21 +5,16 @@
 /tags
 /cabal.project.local
 /cabal.project.local~
+cabal.sandbox.config
 .stack-work
 stack*.yaml.lock
 /.dir-locals.el
 /.vscode
 /.ghc.environment*
-/lsp-types/cabal.project.local
-/lsp-types/cabal.project.local~
 *.swp
 *.swo
 *.orig
 *.DS_Store
 .hspec-failures
-/lsp-types/dist/
-/lsp-types/dist-newstyle/
-/lsp-types/TAGS
-/lsp-types/tags
-/lsp-types/ctags
+hie
 .hie
diff --git a/.gitmodules b/.gitmodules
diff --git a/README.md b/README.md
@@ -1,12 +1,13 @@
 ![CI](https://github.com/alanz/lsp/workflows/Haskell%20CI/badge.svg)
 [![Hackage](https://img.shields.io/hackage/v/lsp?label=lsp)](https://hackage.haskell.org/package/lsp)
 [![Hackage](https://img.shields.io/hackage/v/lsp?label=lsp-types)](https://hackage.haskell.org/package/lsp-types)
+[![Hackage](https://img.shields.io/hackage/v/lsp?label=lsp-test)](https://hackage.haskell.org/package/lsp-test)
 
 # lsp
 Haskell library for the Microsoft Language Server Protocol.
 It currently implements all of the [3.15 specification](https://microsoft.github.io/language-server-protocol/specifications/specification-3-15/).
 
-It is split into two separate packages, `lsp` and `lsp-types`
+It is split into three separate packages, `lsp`, `lsp-types`, and `lsp-test`:
 - `lsp-types` provides *type-safe* definitions that match up with the
 typescript definitions laid out in the specification
 - `lsp` is a library for building language servers, handling:
@@ -17,14 +18,14 @@ typescript definitions laid out in the specification
   - Dynamic registration of capabilities
   - Cancellable requests and progress notifications
   - Publishing and flushing of diagnostics
+- `lsp-test` is a functional testing framework for Language Server Protocol servers.
 
 ## Language servers built on lsp
-- [ghcide](https://github.com/haskell/ghcide)
 - [haskell-language-server](https://github.com/haskell/haskell-language-server)
 - [dhall-lsp-server](https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-lsp-server#readme)
 
 ## Example language servers
-There are two example language servers in the `example/` folder. `Simple.hs` provides a minimal example:
+There are two example language servers in the `lsp/example/` folder. `Simple.hs` provides a minimal example:
 
 ```haskell
 {-# LANGUAGE OverloadedStrings #-}
@@ -80,12 +81,61 @@ from source with
 
     cabal install lsp-demo-simple-server lsp-demo-reactor-server
     stack install :lsp-demo-simple-server :lsp-demo-reactor-server --flag haskell-lsp:demo
+
+## Examples of using lsp-test
+
+### Setting up a session
+
+```haskell
+import Language.LSP.Test
+main = runSession "hie" fullCaps "proj/dir" $ do
+  doc <- openDoc "Foo.hs" "haskell"
+  skipMany anyNotification
+  symbols <- getDocumentSymbols doc
+```
+
+### Unit tests with HSpec
+
+```haskell
+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
+```haskell
+replaySession "hie" "test/data/renamePass"
+```
+
+### Parsing with combinators
+```haskell
+skipManyTill loggingNotification publishDiagnosticsNotification
+count 4 (message :: Session ApplyWorkspaceEditRequest)
+anyRequest <|> anyResponse
+```
+
+Try out the example tests in the `lsp-test/example` directory with `cabal test`.
+For more examples check the [Wiki](https://github.com/bubba/lsp-test/wiki/Introduction), or see this [introductory blog post](https://lukelau.me/haskell/posts/lsp-test/).
+
+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
+```
+
+## 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.](https://github.com/alanz/haskell-ide-engine/blob/bfb16324d396da71000ef81d51acbebbdaa854ab/test/utils/TestUtils.hs#L290-L298)
 
 ## Useful links
 
-- https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md
+- [Language Server Protocol Specification](https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md)
 
 ## Other resources
 
-See #haskell-ide-engine on IRC freenode
+See #haskell-language-server  on IRC freenode.
 
diff --git a/Setup.hs b/Setup.hs
diff --git a/bench/simple-bench.cabal b/bench/simple-bench.cabal
diff --git a/cabal.project b/cabal.project
@@ -1,14 +1,12 @@
 packages:
-         ./
+         ./lsp
          ./lsp-types/
          ./lsp-test/
-         ./lsp-test/example
-         ./func-test/
-         ./bench/
 
 package lsp
   flags: +demo
 
 tests: True
+benchmarks: True
 test-show-details: direct
 haddock-quickjump: True
diff --git a/hie.yaml b/hie.yaml
@@ -7,19 +7,21 @@
 #          https://github.com/digital-asset/ghcide/issues/113
 cradle:
   cabal:
-      - path: "./lsp-test/test"
-        component: "lsp-test:test:tests"
       - path: "./lsp-test"
         component: "lsp-test"
+      - path: "./lsp-test/test"
+        component: "lsp-test:test:tests"
+      - path: "./lsp-test/func-test"
+        component: "lsp-test:test:func-test"
+      - path: "./lsp-test/bench"
+        component: "lsp-test:bench:simple-bench"
       - path: "./lsp-types"
         component: "lsp-types"
-      - path: "./src"
+      - path: "./lsp"
         component: "lsp"
-      - path: "./test"
+      - path: "./lsp/test"
         component: "unit-test"
-      - path: "./func-test"
-        component: "func-test"
-      - path: "./example/Reactor.hs"
+      - path: "./lsp/example/Reactor.hs"
         component: "lsp-demo-reactor-server"
-      - path: "./example/Simple.hs"
+      - path: "./lsp/example/Simple.hs"
         component: "lsp-demo-simple-server"
diff --git a/lsp-test/.gitignore b/lsp-test/.gitignore
diff --git a/lsp-test/README.md b/lsp-test/README.md
diff --git a/bench/SimpleBench.hs → lsp-test/bench/SimpleBench.hs b/bench/SimpleBench.hs → lsp-test/bench/SimpleBench.hs
diff --git a/lsp-test/example/Test.hs b/lsp-test/example/Test.hs
@@ -4,7 +4,7 @@ import Control.Monad.IO.Class
 import Language.LSP.Test
 import Language.LSP.Types
 
-main = runSession "lsp-demo-reactor-server" fullCaps "../test/data/" $ do
+main = runSession "lsp-demo-reactor-server" fullCaps "test/data/" $ do
   doc <- openDoc "Rename.hs" "haskell"
 
   -- Use your favourite favourite combinators.

diff --git a/lsp-test/example/cabal.project b/lsp-test/example/cabal.project
diff --git a/lsp-test/example/example.cabal b/lsp-test/example/example.cabal
diff --git a/func-test/FuncTest.hs → lsp-test/func-test/FuncTest.hs b/func-test/FuncTest.hs → lsp-test/func-test/FuncTest.hs
diff --git a/func-test/func-test.cabal → lsp-test/func-test/func-test.cabal b/func-test/func-test.cabal → lsp-test/func-test/func-test.cabal
diff --git a/lsp-test/hie.yaml b/lsp-test/hie.yaml
diff --git a/lsp-test/lsp-test.cabal b/lsp-test/lsp-test.cabal
@@ -94,3 +94,39 @@ test-suite tests
                      , mtl
                      , aeson
   default-language:    Haskell2010
+
+test-suite func-test
+  main-is:             FuncTest.hs
+  hs-source-dirs:      func-test
+  type:                exitcode-stdio-1.0
+  build-depends:       base <4.15
+                     , lsp-test
+                     , lsp
+                     , data-default
+                     , process
+                     , lens
+                     , unliftio
+                     , hspec
+                     , async
+  default-language:    Haskell2010
+
+test-suite example 
+  main-is:             Test.hs
+  hs-source-dirs:      example
+  type:                exitcode-stdio-1.0
+  build-depends:       base
+                     , lsp-test
+                     , parser-combinators
+  build-tool-depends:  lsp:lsp-demo-reactor-server
+
+benchmark simple-bench
+  main-is:             SimpleBench.hs
+  hs-source-dirs:      bench
+  type:                exitcode-stdio-1.0
+  build-depends:       base <4.15
+                     , lsp-test
+                     , lsp
+                     , process
+                     , extra
+  default-language:    Haskell2010
+  ghc-options: -Wall -O2 -eventlog -rtsopts
diff --git a/lsp-types/.hlint.yaml b/lsp-types/.hlint.yaml
diff --git a/lsp-types/ChangeLog.md b/lsp-types/ChangeLog.md
@@ -1,4 +1,4 @@
-# Revision history for haskell-lsp-types
+# Revision history for lsp-types
 
 ## 1.1.0.0
 

diff --git a/lsp-types/README.md b/lsp-types/README.md
diff --git a/lsp-types/Setup.hs b/lsp-types/Setup.hs
diff --git a/ChangeLog.md → lsp/ChangeLog.md b/ChangeLog.md → lsp/ChangeLog.md
diff --git a/LICENSE → lsp/LICENSE b/LICENSE → lsp/LICENSE
diff --git a/example/Reactor.hs → lsp/example/Reactor.hs b/example/Reactor.hs → lsp/example/Reactor.hs
diff --git a/example/Simple.hs → lsp/example/Simple.hs b/example/Simple.hs → lsp/example/Simple.hs
diff --git a/lsp.cabal → lsp/lsp.cabal b/lsp.cabal → lsp/lsp.cabal
diff --git a/src/Language/LSP/Diagnostics.hs → lsp/src/Language/LSP/Diagnostics.hs b/src/Language/LSP/Diagnostics.hs → lsp/src/Language/LSP/Diagnostics.hs
diff --git a/src/Language/LSP/Server.hs → lsp/src/Language/LSP/Server.hs b/src/Language/LSP/Server.hs → lsp/src/Language/LSP/Server.hs
diff --git a/src/Language/LSP/Server/Control.hs → lsp/src/Language/LSP/Server/Control.hs b/src/Language/LSP/Server/Control.hs → lsp/src/Language/LSP/Server/Control.hs
diff --git a/src/Language/LSP/Server/Core.hs → lsp/src/Language/LSP/Server/Core.hs b/src/Language/LSP/Server/Core.hs → lsp/src/Language/LSP/Server/Core.hs
diff --git a/src/Language/LSP/Server/Processing.hs → lsp/src/Language/LSP/Server/Processing.hs b/src/Language/LSP/Server/Processing.hs → lsp/src/Language/LSP/Server/Processing.hs
diff --git a/test/CapabilitiesSpec.hs → lsp/test/CapabilitiesSpec.hs b/test/CapabilitiesSpec.hs → lsp/test/CapabilitiesSpec.hs
diff --git a/test/DiagnosticsSpec.hs → lsp/test/DiagnosticsSpec.hs b/test/DiagnosticsSpec.hs → lsp/test/DiagnosticsSpec.hs
diff --git a/test/JsonSpec.hs → lsp/test/JsonSpec.hs b/test/JsonSpec.hs → lsp/test/JsonSpec.hs
diff --git a/test/Main.hs → lsp/test/Main.hs b/test/Main.hs → lsp/test/Main.hs
diff --git a/test/MethodSpec.hs → lsp/test/MethodSpec.hs b/test/MethodSpec.hs → lsp/test/MethodSpec.hs
diff --git a/test/ServerCapabilitiesSpec.hs → lsp/test/ServerCapabilitiesSpec.hs b/test/ServerCapabilitiesSpec.hs → lsp/test/ServerCapabilitiesSpec.hs
diff --git a/test/Spec.hs → lsp/test/Spec.hs b/test/Spec.hs → lsp/test/Spec.hs
diff --git a/test/TypesSpec.hs → lsp/test/TypesSpec.hs b/test/TypesSpec.hs → lsp/test/TypesSpec.hs
diff --git a/test/URIFilePathSpec.hs → lsp/test/URIFilePathSpec.hs b/test/URIFilePathSpec.hs → lsp/test/URIFilePathSpec.hs
diff --git a/test/VspSpec.hs → lsp/test/VspSpec.hs b/test/VspSpec.hs → lsp/test/VspSpec.hs
diff --git a/test/WorkspaceEditSpec.hs → lsp/test/WorkspaceEditSpec.hs b/test/WorkspaceEditSpec.hs → lsp/test/WorkspaceEditSpec.hs
diff --git a/stack-8.4.2.yaml b/stack-8.4.2.yaml
@@ -1,9 +1,9 @@
 resolver: nightly-2018-05-30 # last nightly for GHC 8.4.2
 
 packages:
-- '.'
+- ./lsp
 - ./lsp-types
-- ./func-test
+- ./lsp-test
 
 extra-deps:
 - rope-utf16-splay-0.3.1.0

diff --git a/stack-8.4.3.yaml b/stack-8.4.3.yaml
@@ -1,9 +1,9 @@
 resolver: lts-12.5 # GHC 8.4.3
 
 packages:
-- '.'
+- ./lsp
 - ./lsp-types
-- ./func-test
+- ./lsp-test
 
 extra-deps:
 - rope-utf16-splay-0.3.1.0