haskell · alanz · Feb 28, 2021 · Sep 8, 2018 · Sep 9, 2018 · Sep 9, 2018
diff --git a/.github/workflows/haskell.yml b/.github/workflows/haskell.yml
@@ -9,15 +9,15 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ghc: ['8.10.2', '8.8.3', '8.6.5', '8.4.4']
+        ghc: ['8.10.4', '8.8.3', '8.6.5', '8.4.4']
         os: [ubuntu-latest, macOS-latest, windows-latest]
         exclude:
           - os: windows-latest
             ghc: '8.8.3' # fails due to segfault
 
     steps:
     - uses: actions/checkout@v2
-    - uses: actions/setup-haskell@v1
+    - uses: haskell/actions/setup@v1
       with:
         ghc-version: ${{ matrix.ghc }}
         cabal-version: '3.2'
@@ -38,5 +38,7 @@ jobs:
       run: cabal build
     - name: Test
       run: cabal test
-    - name: Func tests
-      run: cabal run func-test
+    - name: Func test
+      run: cabal test func-test
+    - name: Test lsp-test
+      run: cabal test lsp-test
diff --git a/cabal.project b/cabal.project
@@ -1,16 +1,14 @@
 packages:
          ./
          ./lsp-types/
-         ./func-test
+         ./lsp-test/
+         ./lsp-test/example
+         ./func-test/
          ./bench/
 
 package lsp
   flags: +demo
 
-source-repository-package
-    type: git
-    location: https://github.com/bubba/lsp-test.git
-    tag: 55ae6885312a90117aab35acdfc470790f30cfca
-
 tests: True
 test-show-details: direct
+haddock-quickjump: True
diff --git a/hie.yaml b/hie.yaml
@@ -7,6 +7,10 @@
 #          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-types"
         component: "lsp-types"
       - path: "./src"

diff --git a/lsp-test/.gitignore b/lsp-test/.gitignore
@@ -0,0 +1,22 @@
+.stack-work
+stack.yaml.lock
+dist
+.cabal-sandbox
+cabal.sandbox.config
+dist-newstyle
+cabal.project.local*
+.ghc.environment.*
+**/.DS_Store
+*.swp
+
+example/dist
+example/dist-newstyle
+example/cabal.project.local
+example/.ghc.environment.*
+
+# used for rerunning failed hspec tests
+.hspec-failures
+
+# downloaded by .download-hie.sh on travis
+hie
+.hie
diff --git a/lsp-test/ChangeLog.md b/lsp-test/ChangeLog.md
@@ -0,0 +1,117 @@
+# Revision history for lsp-test
+
+## 0.13.0.0 -- 2021-02-14
+
+* Add support for lsp-types-1.1 (@wz1000)
+* Automatically respond to `workspace/applyEdit` and
+  `window/workDoneProgress/create` messages (@wz1000)
+
+## 0.12.0.0 -- 2021-01-25
+* Add `getIncompleteProgressSessions` to track ongoing progress sessions
+  (@wz1000)
+
+## 0.11.0.0 -- 2020-05-14
+
+* Replace `openDoc'` with `createDoc` which now sends
+  `workspace/didChangeWatchedFiles` notifications if the server has registered
+  for it
+* Add `getRegisteredCapabilities`
+
+## 0.10.3.0 -- 2020-05-04
+
+* Build with new haskell-lsp-0.22
+
+## 0.10.2.0 -- 2020-03-21
+
+* Bump constraints for new haskell-lsp
+
+## 0.10.1.0 -- 2020-02-04
+
+* Bump constraints for new haskell-lsp
+
+## 0.10.0.0 -- 2019-12-29
+
+* Account for messages received between the initialize request and response.
+  (Though it will throw an exception if the message received is an illegal one)
+
+## 0.9.0.0 -- 2019-12-1
+
+* Add `ignoreLogNotifications` config option
+* Add ability to override `logStdErr` and `logMessages` config options with
+  the `LSP_TEST_LOG_STDERR` and `LOG_TEST_LOG_MESSAGES` environment variables
+* Update for haskell-lsp-0.19.0.0 (@mpickering)
+
+## 0.8.2.0 -- 2019-11-17
+
+* Expose `satisfyMaybe` (@cocreature)
+
+## 0.8.1.0 -- 2019-11-17
+
+* Update to haskell-lsp-0.18.0.0 (@mpickering, @alanz)
+* Tests now require hie-bios based hie
+
+## 0.8.0.0 -- 2019-10-18
+
+* Make `Session` a newtype
+* Update for haskell-lsp-0.17.0.0 (@cocreature)
+
+## 0.7.0.0 -- 2019-09-08
+
+* Update for haskell-lsp-0.16.0.0
+
+## 0.6.1.0 -- 2019-08-24
+
+* Add `satisfyMaybe` (@cocreature)
+
+## 0.6.0.0 -- 2019-07-04
+
+* Update to haskell-lsp-0.15.0.0 (@lorenzo)
+
+## 0.5.4.0 -- 2019-06-13
+
+* Fix `getDefinitions` for SingleLoc (@cocreature)
+* Add `getCodeLenses` (@cocreature)
+
+## 0.5.3.0 -- 2019-06-13
+
+* Update to haskell-lsp-0.14.0.0 (@cocreature)
+* Support `TextDocumentDidChange` (@cocreature)
+* Add non-file based `openDoc` (@cocreature)
+
+## 0.5.2.0 -- 2019-04-28
+
+* Add `satisfy` parser combinator
+
+## 0.5.1.0 -- 2019-04-22
+
+* Fix unhandled `window/progress` server notifications
+
+## 0.5.1.0 -- 2019-04-07
+
+* Add getTypeDefinitions (@fendor)
+
+## 0.5.0.2 -- 2018-12-05
+
+* Fix loose threads when exceptions are thrown
+
+## 0.5.0.0 -- 2018-11-13
+
+* Add lspConfig option in config
+* GHC 8.6.2 support
+
+## 0.4.0.0 -- 2018-09-08
+
+* Update to haskell-lsp-0.8.0.0
+
+## 0.3.0.0 -- 2018-09-0t
+
+* Update to haskell-lsp-0.7.0.0
+
+## 0.2.1.0 -- 2018-08-14
+
+* Add getCodeActions
+* Add getCurrentDiagnostics
+
+## 0.2.0.0 -- 2018-08-06
+
+* Update to haskell-lsp 0.6.0.0
diff --git a/lsp-test/LICENSE b/lsp-test/LICENSE
@@ -0,0 +1,29 @@
+Copyright Luke Lau 2018-2020.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of Luke Lau nor the names of other
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/lsp-test/README.md b/lsp-test/README.md
@@ -0,0 +1,53 @@
+# lsp-test [![Actions Status](https://github.com/bubba/lsp-test/workflows/Haskell%20CI/badge.svg)](https://github.com/bubba/lsp-test/actions) [![Hackage](https://img.shields.io/hackage/v/lsp-test.svg)](https://hackage.haskell.org/package/lsp-test)
+lsp-test is a functional testing framework for Language Server Protocol servers.
+
+```haskell
+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
+```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 `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
+```
+
+## 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.](https://github.com/alanz/haskell-ide-engine/blob/bfb16324d396da71000ef81d51acbebbdaa854ab/test/utils/TestUtils.hs#L290-L298)
diff --git a/lsp-test/example/Test.hs b/lsp-test/example/Test.hs
@@ -0,0 +1,19 @@
+import Control.Applicative.Combinators
+import Control.Monad.IO.Class
+import Language.LSP.Test
+import Language.LSP.Types
+
+main = runSession "haskell-language-server" fullCaps "../test/data/" $ do
+  doc <- openDoc "Rename.hs" "haskell"
+
+  -- Use your favourite favourite combinators.
+  skipManyTill loggingNotification (count 2 publishDiagnosticsNotification)
+
+  -- Send requests and notifications and receive responses
+  rsp <- request STextDocumentDocumentSymbol $
+          DocumentSymbolParams Nothing Nothing doc
+  liftIO $ print rsp
+
+  -- Or use one of the helper functions
+  getDocumentSymbols doc >>= liftIO . print
+
diff --git a/lsp-test/example/cabal.project b/lsp-test/example/cabal.project
@@ -0,0 +1,2 @@
+packages: .
+          ../
diff --git a/lsp-test/example/example.cabal b/lsp-test/example/example.cabal
@@ -0,0 +1,11 @@
+name:          example
+version:       0.0.0.0
+cabal-version: >= 1.22
+build-type:    Simple
+
+test-suite tests
+  type:          exitcode-stdio-1.0
+  main-is:       Test.hs
+  build-depends: base
+               , lsp-test
+               , parser-combinators
diff --git a/lsp-test/hie.yaml b/lsp-test/hie.yaml
@@ -0,0 +1,16 @@
+cradle:
+  multi:
+    - path: "./test/data/"
+      config: { cradle: { none:  } }
+    - path: "./example/"
+      config: { cradle: { none:  } }
+    - path: "./"
+      config:
+        cradle:
+          cabal:
+            - path: "src"
+              component: "lib:lsp-test"
+            - path: "test/dummy-server"
+              component: "exe:dummy-server"
+            - path: "test"
+              component: "test:tests"