From: Luke Lau <luke_lau@icloud.com>
Date: Mon, 12 Nov 2018 17:40:41 +0000 (+0000)
Subject: Add lspConfig option
X-Git-Tag: 0.5.0.0~3
X-Git-Url: http://git.lukelau.me/?p=lsp-test.git;a=commitdiff_plain;h=c11f5798ff6f9634e24c6521eb01d03a27e718ac

Add lspConfig option

Bump version and update version constraints
---

diff --git a/example/Test.hs b/example/Test.hs
index 0f5cdb4..52ba45c 100644
--- a/example/Test.hs
+++ b/example/Test.hs
@@ -3,7 +3,7 @@ import Control.Monad.IO.Class
 import Language.Haskell.LSP.Test
 import Language.Haskell.LSP.Types
 
-main = runSession "hie --lsp" fullCaps "../test/data/" $ do
+main = runSession "hie" fullCaps "../test/data/" $ do
   docItem <- openDoc "Rename.hs" "haskell"
   
   -- Use your favourite favourite combinators.
diff --git a/lsp-test.cabal b/lsp-test.cabal
index 287e6a4..319cc8a 100644
--- a/lsp-test.cabal
+++ b/lsp-test.cabal
@@ -1,5 +1,5 @@
 name:                lsp-test
-version:             0.4.0.0
+version:             0.5.0.0
 synopsis:            Functional test framework for LSP servers.
 description:
   A test framework for writing tests against 
@@ -36,7 +36,7 @@ library
                      , parser-combinators:Control.Applicative.Combinators
   default-language:    Haskell2010
   build-depends:       base >= 4.7 && < 5
-                     , haskell-lsp == 0.8.*
+                     , haskell-lsp >= 0.8 && < 0.9
                      , aeson
                      , aeson-pretty
                      , ansi-terminal
@@ -78,7 +78,7 @@ test-suite tests
   build-depends:       base >= 4.7 && < 5
                      , hspec
                      , lens
-                     , haskell-lsp == 0.8.*
+                     , haskell-lsp >= 0.8 && < 0.9
                      , lsp-test
                      , data-default
                      , aeson
diff --git a/src/Language/Haskell/LSP/Test.hs b/src/Language/Haskell/LSP/Test.hs
index e4c3aea..1765c1f 100644
--- a/src/Language/Haskell/LSP/Test.hs
+++ b/src/Language/Haskell/LSP/Test.hs
@@ -155,6 +155,10 @@ runSessionWithConfig config serverExe caps rootDir session = do
 
       sendNotification Initialized InitializedParams
 
+      case lspConfig config of
+        Just cfg -> sendNotification WorkspaceDidChangeConfiguration (DidChangeConfigurationParams cfg)
+        Nothing -> return ()
+
       -- Run the actual test
       result <- session
 
diff --git a/src/Language/Haskell/LSP/Test/Session.hs b/src/Language/Haskell/LSP/Test/Session.hs
index 5948ed0..f0d410a 100644
--- a/src/Language/Haskell/LSP/Test/Session.hs
+++ b/src/Language/Haskell/LSP/Test/Session.hs
@@ -2,6 +2,7 @@
 {-# LANGUAGE FlexibleInstances #-}
 {-# LANGUAGE MultiParamTypeClasses #-}
 {-# LANGUAGE FlexibleContexts #-}
+{-# LANGUAGE RankNTypes #-}
 
 module Language.Haskell.LSP.Test.Session
   ( Session
@@ -30,6 +31,7 @@ import Control.Concurrent hiding (yield)
 import Control.Exception
 import Control.Lens hiding (List)
 import Control.Monad
+import Control.Monad.Fail
 import Control.Monad.IO.Class
 import Control.Monad.Except
 import Control.Monad.Trans.Reader (ReaderT, runReaderT)
@@ -69,17 +71,23 @@ import System.IO
 
 type Session = ParserStateReader FromServerMessage SessionState SessionContext IO
 
+instance MonadFail Session where
+  fail s = do
+    lastMsg <- fromJust . lastReceivedMessage <$> get
+    liftIO $ throw (UnexpectedMessage s lastMsg)
+
 -- | Stuff you can configure for a 'Session'.
 data SessionConfig = SessionConfig
   { messageTimeout :: Int  -- ^ Maximum time to wait for a message in seconds, defaults to 60.
   , logStdErr      :: Bool -- ^ Redirect the server's stderr to this stdout, defaults to False.
   , logMessages    :: Bool -- ^ Trace the messages sent and received to stdout, defaults to True.
   , logColor       :: Bool -- ^ Add ANSI color to the logged messages, defaults to True.
+  , lspConfig      :: Maybe Value -- ^ The initial LSP config as JSON value, defaults to Nothing.
   }
 
 -- | The configuration used in 'Language.Haskell.LSP.Test.runSession'.
 defaultConfig :: SessionConfig
-defaultConfig = SessionConfig 60 False False True
+defaultConfig = SessionConfig 60 False True True Nothing
 
 instance Default SessionConfig where
   def = defaultConfig
diff --git a/stack.yaml b/stack.yaml
index b229bb8..67d3be5 100644
--- a/stack.yaml
+++ b/stack.yaml
@@ -1,7 +1,3 @@
-resolver: lts-12.9
+resolver: lts-12.17
 packages:
   - .
-
-extra-deps:
-  - haskell-lsp-0.8.0.0
-  - haskell-lsp-types-0.8.0.0
diff --git a/test/Test.hs b/test/Test.hs
index 73a7b45..11114d9 100644
--- a/test/Test.hs
+++ b/test/Test.hs
@@ -31,21 +31,21 @@ main = hspec $ do
   describe "Session" $ do
     it "fails a test" $
       -- TODO: Catch the exception in haskell-lsp-test and provide nicer output
-      let session = runSession "hie --lsp" fullCaps "test/data/renamePass" $ do
+      let session = runSession "hie" fullCaps "test/data/renamePass" $ do
                       openDoc "Desktop/simple.hs" "haskell"
                       skipMany loggingNotification
                       anyRequest
         in session `shouldThrow` anyException
-    it "initializeResponse" $ runSession "hie --lsp" fullCaps "test/data/renamePass" $ do
+    it "initializeResponse" $ runSession "hie" fullCaps "test/data/renamePass" $ do
       rsp <- initializeResponse
       liftIO $ rsp ^. result `shouldNotBe` Nothing
 
     it "runSessionWithConfig" $
-      runSession "hie --lsp" didChangeCaps "test/data/renamePass" $ return ()
+      runSession "hie" didChangeCaps "test/data/renamePass" $ return ()
 
     describe "withTimeout" $ do
       it "times out" $
-        let sesh = runSession "hie --lsp" fullCaps "test/data/renamePass" $ do
+        let sesh = runSession "hie" fullCaps "test/data/renamePass" $ do
                     openDoc "Desktop/simple.hs" "haskell"
                     -- won't receive a request - will timeout
                     -- incoming logging requests shouldn't increase the
@@ -56,12 +56,12 @@ main = hspec $ do
           in timeout 6000000 sesh `shouldThrow` anySessionException
           
       it "doesn't time out" $
-        let sesh = runSession "hie --lsp" fullCaps "test/data/renamePass" $ do
+        let sesh = runSession "hie" fullCaps "test/data/renamePass" $ do
                     openDoc "Desktop/simple.hs" "haskell"
                     withTimeout 5 $ skipManyTill anyMessage publishDiagnosticsNotification
           in void $ timeout 6000000 sesh
 
-      it "further timeout messages are ignored" $ runSession "hie --lsp" fullCaps "test/data/renamePass" $ do
+      it "further timeout messages are ignored" $ runSession "hie" fullCaps "test/data/renamePass" $ do
         doc <- openDoc "Desktop/simple.hs" "haskell"
         withTimeout 3 $ getDocumentSymbols doc
         liftIO $ threadDelay 5000000
@@ -71,7 +71,7 @@ main = hspec $ do
 
       it "overrides global message timeout" $
         let sesh =
-              runSessionWithConfig (def { messageTimeout = 5 }) "hie --lsp" fullCaps "test/data/renamePass" $ do
+              runSessionWithConfig (def { messageTimeout = 5 }) "hie" fullCaps "test/data/renamePass" $ do
                 doc <- openDoc "Desktop/simple.hs" "haskell"
                 -- shouldn't time out in here since we are overriding it
                 withTimeout 10 $ liftIO $ threadDelay 7000000
@@ -81,7 +81,7 @@ main = hspec $ do
 
       it "unoverrides global message timeout" $
         let sesh =
-              runSessionWithConfig (def { messageTimeout = 5 }) "hie --lsp" fullCaps "test/data/renamePass" $ do
+              runSessionWithConfig (def { messageTimeout = 5 }) "hie" fullCaps "test/data/renamePass" $ do
                 doc <- openDoc "Desktop/simple.hs" "haskell"
                 -- shouldn't time out in here since we are overriding it
                 withTimeout 10 $ liftIO $ threadDelay 7000000
@@ -93,13 +93,13 @@ main = hspec $ do
 
     describe "SessionException" $ do
       it "throw on time out" $
-        let sesh = runSessionWithConfig (def {messageTimeout = 10}) "hie --lsp" fullCaps "test/data/renamePass" $ do
+        let sesh = runSessionWithConfig (def {messageTimeout = 10}) "hie" fullCaps "test/data/renamePass" $ do
                 skipMany loggingNotification
                 _ <- message :: Session ApplyWorkspaceEditRequest
                 return ()
         in sesh `shouldThrow` anySessionException
 
-      it "don't throw when no time out" $ runSessionWithConfig (def {messageTimeout = 5}) "hie --lsp" fullCaps "test/data/renamePass" $ do
+      it "don't throw when no time out" $ runSessionWithConfig (def {messageTimeout = 5}) "hie" fullCaps "test/data/renamePass" $ do
         loggingNotification
         liftIO $ threadDelay 10
         _ <- openDoc "Desktop/simple.hs" "haskell"
@@ -109,7 +109,7 @@ main = hspec $ do
         it "throws when there's an unexpected message" $
           let selector (UnexpectedMessage "Publish diagnostics notification" (NotLogMessage _)) = True
               selector _ = False
-            in runSession "hie --lsp" fullCaps "test/data/renamePass" publishDiagnosticsNotification `shouldThrow` selector
+            in runSession "hie" fullCaps "test/data/renamePass" publishDiagnosticsNotification `shouldThrow` selector
         it "provides the correct types that were expected and received" $
           let selector (UnexpectedMessage "ResponseMessage WorkspaceEdit" (RspDocumentSymbols _)) = True
               selector _ = False
@@ -118,17 +118,17 @@ main = hspec $ do
                 sendRequest TextDocumentDocumentSymbol (DocumentSymbolParams doc)
                 skipMany anyNotification
                 message :: Session RenameResponse -- the wrong type
-            in runSession "hie --lsp" fullCaps "test/data/renamePass" sesh
+            in runSession "hie" fullCaps "test/data/renamePass" sesh
               `shouldThrow` selector
 
   describe "replaySession" $
     -- This is too fickle at the moment
     -- it "passes a test" $
-    --   replaySession "hie --lsp" "test/data/renamePass"
+    --   replaySession "hie" "test/data/renamePass"
     it "fails a test" $
       let selector (ReplayOutOfOrder _ _) = True
           selector _ = False
-        in replaySession "hie --lsp" "test/data/renameFail" `shouldThrow` selector
+        in replaySession "hie" "test/data/renameFail" `shouldThrow` selector
 
   describe "manual javascript session" $
     it "passes a test" $
@@ -145,7 +145,7 @@ main = hspec $ do
 
   describe "text document VFS" $
     it "sends back didChange notifications" $
-      runSession "hie --lsp" def "test/data/refactor" $ do
+      runSession "hie" def "test/data/refactor" $ do
         doc <- openDoc "Main.hs" "haskell"
 
         let args = toJSON $ AOP (doc ^. uri)
@@ -168,7 +168,7 @@ main = hspec $ do
 
   describe "getDocumentEdit" $
     it "automatically consumes applyedit requests" $
-      runSession "hie --lsp" fullCaps "test/data/refactor" $ do
+      runSession "hie" fullCaps "test/data/refactor" $ do
         doc <- openDoc "Main.hs" "haskell"
 
         let args = toJSON $ AOP (doc ^. uri)
@@ -188,7 +188,7 @@ main = hspec $ do
       liftIO $ action ^. title `shouldBe` "Apply hint:Redundant bracket"
 
   describe "getAllCodeActions" $
-    it "works" $ runSession "hie --lsp" fullCaps "test/data/refactor" $ do
+    it "works" $ runSession "hie" fullCaps "test/data/refactor" $ do
       doc <- openDoc "Main.hs" "haskell"
       _ <- waitForDiagnostics
       actions <- getAllCodeActions doc
@@ -198,7 +198,7 @@ main = hspec $ do
         action ^. command . _Just . command `shouldSatisfy` T.isSuffixOf ":applyrefact:applyOne"
 
   describe "getDocumentSymbols" $
-    it "works" $ runSession "hie --lsp" fullCaps "test/data/renamePass" $ do
+    it "works" $ runSession "hie" fullCaps "test/data/renamePass" $ do
       doc <- openDoc "Desktop/simple.hs" "haskell"
 
       skipMany loggingNotification
@@ -213,13 +213,13 @@ main = hspec $ do
         mainSymbol ^. range `shouldBe` Range (Position 3 0) (Position 5 30)
 
   describe "applyEdit" $ do
-    it "increments the version" $ runSession "hie --lsp" docChangesCaps "test/data/renamePass" $ do
+    it "increments the version" $ runSession "hie" docChangesCaps "test/data/renamePass" $ do
       doc <- openDoc "Desktop/simple.hs" "haskell"
       VersionedTextDocumentIdentifier _ (Just oldVersion) <- getVersionedDoc doc
       let edit = TextEdit (Range (Position 1 1) (Position 1 3)) "foo" 
       VersionedTextDocumentIdentifier _ (Just newVersion) <- applyEdit doc edit
       liftIO $ newVersion `shouldBe` oldVersion + 1
-    it "changes the document contents" $ runSession "hie --lsp" fullCaps "test/data/renamePass" $ do
+    it "changes the document contents" $ runSession "hie" fullCaps "test/data/renamePass" $ do
       doc <- openDoc "Desktop/simple.hs" "haskell"
       let edit = TextEdit (Range (Position 0 0) (Position 0 2)) "foo" 
       applyEdit doc edit
@@ -227,7 +227,7 @@ main = hspec $ do
       liftIO $ contents `shouldSatisfy` T.isPrefixOf "foodule"
 
   describe "getCompletions" $
-    it "works" $ runSession "hie --lsp" def "test/data/renamePass" $ do
+    it "works" $ runSession "hie" def "test/data/renamePass" $ do
       doc <- openDoc "Desktop/simple.hs" "haskell"
       item:_ <- getCompletions doc (Position 5 5)
       liftIO $ do
@@ -236,7 +236,7 @@ main = hspec $ do
         item ^. detail `shouldBe` Just "Items -> IO ()\nMain"
 
   describe "getReferences" $
-    it "works" $ runSession "hie --lsp" fullCaps "test/data/renamePass" $ do
+    it "works" $ runSession "hie" fullCaps "test/data/renamePass" $ do
       doc <- openDoc "Desktop/simple.hs" "haskell"
       let pos = Position 40 3 -- interactWithUser
           uri = doc ^. LSP.uri
@@ -248,14 +248,14 @@ main = hspec $ do
         ]
 
   describe "getDefinitions" $
-    it "works" $ runSession "hie --lsp" fullCaps "test/data/renamePass" $ do
+    it "works" $ runSession "hie" fullCaps "test/data/renamePass" $ do
       doc <- openDoc "Desktop/simple.hs" "haskell"
       let pos = Position 49 25 -- addItem
       defs <- getDefinitions doc pos
       liftIO $ defs `shouldBe` [Location (doc ^. uri) (mkRange 28 0 28 7)]
 
   describe "waitForDiagnosticsSource" $
-    it "works" $ runSession "hie --lsp" fullCaps "test/data" $ do
+    it "works" $ runSession "hie" fullCaps "test/data" $ do
       openDoc "Error.hs" "haskell"
       [diag] <- waitForDiagnosticsSource "ghcmod"
       liftIO $ do
@@ -263,13 +263,13 @@ main = hspec $ do
         diag ^. source `shouldBe` Just "ghcmod"
 
   describe "rename" $
-    it "works" $ runSession "hie --lsp" fullCaps "test/data" $ do
+    it "works" $ runSession "hie" fullCaps "test/data" $ do
       doc <- openDoc "Rename.hs" "haskell"
       rename doc (Position 1 0) "bar"
       documentContents doc >>= liftIO . shouldBe "main = bar\nbar = return 42\n"
 
   describe "getHover" $
-    it "works" $ runSession "hie --lsp" fullCaps "test/data/renamePass" $ do
+    it "works" $ runSession "hie" fullCaps "test/data/renamePass" $ do
       doc <- openDoc "Desktop/simple.hs" "haskell"
       -- hover returns nothing until module is loaded
       skipManyTill loggingNotification $ count 2 noDiagnostics
@@ -277,21 +277,21 @@ main = hspec $ do
       liftIO $ hover `shouldSatisfy` isJust
 
   describe "getHighlights" $
-    it "works" $ runSession "hie --lsp" fullCaps "test/data/renamePass" $ do
+    it "works" $ runSession "hie" fullCaps "test/data/renamePass" $ do
       doc <- openDoc "Desktop/simple.hs" "haskell"
       skipManyTill loggingNotification $ count 2 noDiagnostics
       highlights <- getHighlights doc (Position 27 4) -- addItem
       liftIO $ length highlights `shouldBe` 4
 
   describe "formatDoc" $
-    it "works" $ runSession "hie --lsp" fullCaps "test/data" $ do
+    it "works" $ runSession "hie" fullCaps "test/data" $ do
       doc <- openDoc "Format.hs" "haskell"
       oldContents <- documentContents doc
       formatDoc doc (FormattingOptions 4 True)
       documentContents doc >>= liftIO . (`shouldNotBe` oldContents)
 
   describe "formatRange" $
-    it "works" $ runSession "hie --lsp" fullCaps "test/data" $ do
+    it "works" $ runSession "hie" fullCaps "test/data" $ do
       doc <- openDoc "Format.hs" "haskell"
       oldContents <- documentContents doc
       formatRange doc (FormattingOptions 4 True) (Range (Position 1 10) (Position 2 10))
@@ -300,7 +300,7 @@ main = hspec $ do
   describe "closeDoc" $
     it "works" $
       let sesh =
-            runSession "hie --lsp" fullCaps "test/data" $ do
+            runSession "hie" fullCaps "test/data" $ do
               doc <- openDoc "Format.hs" "haskell"
               closeDoc doc
               -- need to evaluate to throw