import Data.Aeson
import Data.Default
import qualified Data.HashMap.Strict as HM
+import Data.Maybe
import qualified Data.Text as T
import Control.Applicative.Combinators
import Control.Concurrent
import Language.Haskell.LSP.Messages
import Language.Haskell.LSP.Test
import Language.Haskell.LSP.Test.Replay
-import Language.Haskell.LSP.Types.Capabilities
-import Language.Haskell.LSP.Types as LSP hiding (capabilities, message)
+import Language.Haskell.LSP.Types
+import Language.Haskell.LSP.Types.Lens as LSP hiding
+ (capabilities, message, rename, applyEdit)
+import Language.Haskell.LSP.Types.Capabilities as LSP
import System.Timeout
{-# ANN module ("HLint: ignore Reduce duplication" :: String) #-}
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" "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" "test/data/renamePass" $ do
+ in session `shouldThrow` anySessionException
+ it "initializeResponse" $ runSession "hie" fullCaps "test/data/renamePass" $ do
rsp <- initializeResponse
liftIO $ rsp ^. result `shouldNotBe` Nothing
it "runSessionWithConfig" $
- runSessionWithConfig (def { capabilities = didChangeCaps })
- "hie --lsp" "test/data/renamePass" $ return ()
+ runSession "hie" didChangeCaps "test/data/renamePass" $ return ()
describe "withTimeout" $ do
it "times out" $
- let sesh = runSession "hie --lsp" "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
in timeout 6000000 sesh `shouldThrow` anySessionException
it "doesn't time out" $
- let sesh = runSession "hie --lsp" "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" "test/data/renamePass" $ do
+ it "further timeout messages are ignored" $ runSession "hie" fullCaps "test/data/renamePass" $ do
doc <- openDoc "Desktop/simple.hs" "haskell"
+ -- warm up the cache
+ getDocumentSymbols doc
+ -- shouldn't timeout
withTimeout 3 $ getDocumentSymbols doc
- liftIO $ threadDelay 5000000
+ -- longer than the original timeout
+ liftIO $ threadDelay (5 * 10^6)
-- shouldn't throw an exception
getDocumentSymbols doc
return ()
it "overrides global message timeout" $
let sesh =
- runSessionWithConfig (def { messageTimeout = 5 }) "hie --lsp" "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
it "unoverrides global message timeout" $
let sesh =
- runSessionWithConfig (def { messageTimeout = 5 }) "hie --lsp" "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
describe "SessionException" $ do
it "throw on time out" $
- let sesh = runSessionWithConfig (def {messageTimeout = 10}) "hie --lsp" "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" "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
+ liftIO $ threadDelay $ 10 * 1000000
_ <- openDoc "Desktop/simple.hs" "haskell"
return ()
it "throws when there's an unexpected message" $
let selector (UnexpectedMessage "Publish diagnostics notification" (NotLogMessage _)) = True
selector _ = False
- in runSession "hie --lsp" "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
sesh = do
doc <- openDoc "Desktop/simple.hs" "haskell"
- sendRequest' TextDocumentDocumentSymbol (DocumentSymbolParams doc)
+ sendRequest TextDocumentDocumentSymbol (DocumentSymbolParams doc Nothing)
skipMany anyNotification
message :: Session RenameResponse -- the wrong type
- in runSession "hie --lsp" "test/data/renamePass" sesh
+ in runSession "hie" fullCaps "test/data/renamePass" sesh
`shouldThrow` selector
- describe "replaySession" $ do
- it "passes a test" $
- replaySession "hie --lsp" "test/data/renamePass"
+ describe "replaySession" $
+ -- This is too fickle at the moment
+ -- it "passes a test" $
+ -- 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" $
- runSession "javascript-typescript-stdio" "test/data/javascriptPass" $ do
+ runSession "javascript-typescript-stdio" fullCaps "test/data/javascriptPass" $ do
doc <- openDoc "test.js" "javascript"
noDiagnostics
- (fooSymbol:_) <- getDocumentSymbols doc
+ Right (fooSymbol:_) <- getDocumentSymbols doc
liftIO $ do
fooSymbol ^. name `shouldBe` "foo"
describe "text document VFS" $
it "sends back didChange notifications" $
- runSession "hie --lsp" "test/data/refactor" $ do
+ runSession "hie" def "test/data/refactor" $ do
doc <- openDoc "Main.hs" "haskell"
let args = toJSON $ AOP (doc ^. uri)
(Position 1 14)
"Redundant bracket"
- reqParams = ExecuteCommandParams "applyrefact:applyOne" (Just (List [args]))
- sendRequest_ WorkspaceExecuteCommand reqParams
+ reqParams = ExecuteCommandParams "applyrefact:applyOne" (Just (List [args])) Nothing
+ request_ WorkspaceExecuteCommand reqParams
editReq <- message :: Session ApplyWorkspaceEditRequest
liftIO $ do
describe "getDocumentEdit" $
it "automatically consumes applyedit requests" $
- runSession "hie --lsp" "test/data/refactor" $ do
+ runSession "hie" fullCaps "test/data/refactor" $ do
doc <- openDoc "Main.hs" "haskell"
let args = toJSON $ AOP (doc ^. uri)
(Position 1 14)
"Redundant bracket"
- reqParams = ExecuteCommandParams "applyrefact:applyOne" (Just (List [args]))
- sendRequest_ WorkspaceExecuteCommand reqParams
+ reqParams = ExecuteCommandParams "applyrefact:applyOne" (Just (List [args])) Nothing
+ request_ WorkspaceExecuteCommand reqParams
contents <- getDocumentEdit doc
liftIO $ contents `shouldBe` "main :: IO Int\nmain = return 42\n"
noDiagnostics
+ describe "getCodeActions" $
+ it "works" $ runSession "hie" fullCaps "test/data/refactor" $ do
+ doc <- openDoc "Main.hs" "haskell"
+ waitForDiagnostics
+ [CACodeAction action] <- getCodeActions doc (Range (Position 1 14) (Position 1 18))
+ liftIO $ action ^. title `shouldBe` "Apply hint:Redundant bracket"
+
describe "getAllCodeActions" $
- it "works" $ runSession "hie --lsp" "test/data/refactor" $ do
+ it "works" $ runSession "hie" fullCaps "test/data/refactor" $ do
doc <- openDoc "Main.hs" "haskell"
_ <- waitForDiagnostics
actions <- getAllCodeActions doc
liftIO $ do
- let [CommandOrCodeActionCommand action] = actions
+ let [CACodeAction action] = actions
action ^. title `shouldBe` "Apply hint:Redundant bracket"
- action ^. command `shouldSatisfy` T.isSuffixOf ":applyrefact:applyOne"
+ action ^. command . _Just . command `shouldSatisfy` T.isSuffixOf ":applyrefact:applyOne"
describe "getDocumentSymbols" $
- it "works" $ runSession "hie --lsp" "test/data/renamePass" $ do
+ it "works" $ runSession "hie" fullCaps "test/data/renamePass" $ do
doc <- openDoc "Desktop/simple.hs" "haskell"
skipMany loggingNotification
noDiagnostics
- (mainSymbol:_) <- getDocumentSymbols doc
+ Left (mainSymbol:_) <- getDocumentSymbols doc
liftIO $ do
mainSymbol ^. name `shouldBe` "main"
mainSymbol ^. kind `shouldBe` SkFunction
- mainSymbol ^. location . range `shouldBe` Range (Position 3 0) (Position 3 4)
- mainSymbol ^. containerName `shouldBe` Nothing
+ mainSymbol ^. range `shouldBe` Range (Position 3 0) (Position 5 30)
describe "applyEdit" $ do
- it "increments the version" $ runSessionWithConfig (def { capabilities = docChangesCaps }) "hie --lsp" "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" "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
liftIO $ contents `shouldSatisfy` T.isPrefixOf "foodule"
describe "getCompletions" $
- it "works" $ runSession "hie --lsp" "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)
+
+ -- wait for module to be loaded
+ skipMany loggingNotification
+ noDiagnostics
+ noDiagnostics
+
+ item:_ <- getCompletions doc (Position 5 5)
liftIO $ do
item ^. label `shouldBe` "interactWithUser"
item ^. kind `shouldBe` Just CiFunction
item ^. detail `shouldBe` Just "Items -> IO ()\nMain"
describe "getReferences" $
- it "works" $ runSession "hie --lsp" "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
, mkRange 71 6 71 22
]
+ describe "getDefinitions" $
+ 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 "getTypeDefinitions" $
+ it "works" $ runSession "hie" fullCaps "test/data/renamePass" $ do
+ doc <- openDoc "Desktop/simple.hs" "haskell"
+ let pos = Position 20 23 -- Quit value
+ defs <- getTypeDefinitions doc pos
+ liftIO $ defs `shouldBe` [Location (doc ^. uri) (mkRange 10 0 14 19)] -- Type definition
+
describe "waitForDiagnosticsSource" $
- it "works" $ runSession "hie --lsp" "test/data" $ do
+ it "works" $ runSession "hie" fullCaps "test/data" $ do
openDoc "Error.hs" "haskell"
[diag] <- waitForDiagnosticsSource "ghcmod"
liftIO $ do
diag ^. source `shouldBe` Just "ghcmod"
describe "rename" $
- it "works" $ runSession "hie --lsp" "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" fullCaps "test/data/renamePass" $ do
+ doc <- openDoc "Desktop/simple.hs" "haskell"
+ -- hover returns nothing until module is loaded
+ skipManyTill loggingNotification $ count 2 noDiagnostics
+ hover <- getHover doc (Position 45 9) -- putStrLn
+ liftIO $ hover `shouldSatisfy` isJust
+
+ describe "getHighlights" $
+ 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" 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" fullCaps "test/data" $ do
+ doc <- openDoc "Format.hs" "haskell"
+ oldContents <- documentContents doc
+ formatRange doc (FormattingOptions 4 True) (Range (Position 1 10) (Position 2 10))
+ documentContents doc >>= liftIO . (`shouldNotBe` oldContents)
+
+ describe "closeDoc" $
+ it "works" $
+ let sesh =
+ runSession "hie" fullCaps "test/data" $ do
+ doc <- openDoc "Format.hs" "haskell"
+ closeDoc doc
+ -- need to evaluate to throw
+ documentContents doc >>= liftIO . print
+ in sesh `shouldThrow` anyException
+
+ describe "satisfy" $
+ it "works" $ runSession "hie" fullCaps "test/data" $ do
+ openDoc "Format.hs" "haskell"
+ let pred (NotLogMessage _) = True
+ pred _ = False
+ void $ satisfy pred
+
mkRange sl sc el ec = Range (Position sl sc) (Position el ec)
didChangeCaps :: ClientCapabilities
projects / lsp-test.git / blobdiff