Bump version and update version constraints
import Language.Haskell.LSP.Test
import Language.Haskell.LSP.Types
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.
docItem <- openDoc "Rename.hs" "haskell"
-- Use your favourite favourite combinators.
synopsis: Functional test framework for LSP servers.
description:
A test framework for writing tests against
synopsis: Functional test framework for LSP servers.
description:
A test framework for writing tests against
, parser-combinators:Control.Applicative.Combinators
default-language: Haskell2010
build-depends: base >= 4.7 && < 5
, parser-combinators:Control.Applicative.Combinators
default-language: Haskell2010
build-depends: base >= 4.7 && < 5
+ , haskell-lsp >= 0.8 && < 0.9
, aeson
, aeson-pretty
, ansi-terminal
, aeson
, aeson-pretty
, ansi-terminal
build-depends: base >= 4.7 && < 5
, hspec
, lens
build-depends: base >= 4.7 && < 5
, hspec
, lens
+ , haskell-lsp >= 0.8 && < 0.9
, lsp-test
, data-default
, aeson
, lsp-test
, data-default
, aeson
sendNotification Initialized InitializedParams
sendNotification Initialized InitializedParams
+ case lspConfig config of
+ Just cfg -> sendNotification WorkspaceDidChangeConfiguration (DidChangeConfigurationParams cfg)
+ Nothing -> return ()
+
-- Run the actual test
result <- session
-- Run the actual test
result <- session
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE FlexibleContexts #-}
+{-# LANGUAGE RankNTypes #-}
module Language.Haskell.LSP.Test.Session
( Session
module Language.Haskell.LSP.Test.Session
( Session
import Control.Exception
import Control.Lens hiding (List)
import Control.Monad
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)
import Control.Monad.IO.Class
import Control.Monad.Except
import Control.Monad.Trans.Reader (ReaderT, runReaderT)
type Session = ParserStateReader FromServerMessage SessionState SessionContext 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.
-- | 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
}
-- | 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
instance Default SessionConfig where
def = defaultConfig
-
-extra-deps:
- - haskell-lsp-0.8.0.0
- - haskell-lsp-types-0.8.0.0
describe "Session" $ do
it "fails a test" $
-- TODO: Catch the exception in haskell-lsp-test and provide nicer output
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
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" $
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" $
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
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" $
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
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
doc <- openDoc "Desktop/simple.hs" "haskell"
withTimeout 3 $ getDocumentSymbols doc
liftIO $ threadDelay 5000000
it "overrides global message timeout" $
let sesh =
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
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 =
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
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" $
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
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"
loggingNotification
liftIO $ threadDelay 10
_ <- openDoc "Desktop/simple.hs" "haskell"
it "throws when there's an unexpected message" $
let selector (UnexpectedMessage "Publish diagnostics notification" (NotLogMessage _)) = True
selector _ = False
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
it "provides the correct types that were expected and received" $
let selector (UnexpectedMessage "ResponseMessage WorkspaceEdit" (RspDocumentSymbols _)) = True
selector _ = False
sendRequest TextDocumentDocumentSymbol (DocumentSymbolParams doc)
skipMany anyNotification
message :: Session RenameResponse -- the wrong type
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" $
`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
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" $
describe "manual javascript session" $
it "passes a test" $
describe "text document VFS" $
it "sends back didChange notifications" $
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)
doc <- openDoc "Main.hs" "haskell"
let args = toJSON $ AOP (doc ^. uri)
describe "getDocumentEdit" $
it "automatically consumes applyedit requests" $
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)
doc <- openDoc "Main.hs" "haskell"
let args = toJSON $ AOP (doc ^. uri)
liftIO $ action ^. title `shouldBe` "Apply hint:Redundant bracket"
describe "getAllCodeActions" $
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
doc <- openDoc "Main.hs" "haskell"
_ <- waitForDiagnostics
actions <- getAllCodeActions doc
action ^. command . _Just . command `shouldSatisfy` T.isSuffixOf ":applyrefact:applyOne"
describe "getDocumentSymbols" $
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
doc <- openDoc "Desktop/simple.hs" "haskell"
skipMany loggingNotification
mainSymbol ^. range `shouldBe` Range (Position 3 0) (Position 5 30)
describe "applyEdit" $ 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
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
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" $
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
doc <- openDoc "Desktop/simple.hs" "haskell"
item:_ <- getCompletions doc (Position 5 5)
liftIO $ do
item ^. detail `shouldBe` Just "Items -> IO ()\nMain"
describe "getReferences" $
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
doc <- openDoc "Desktop/simple.hs" "haskell"
let pos = Position 40 3 -- interactWithUser
uri = doc ^. LSP.uri
]
describe "getDefinitions" $
]
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" $
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
openDoc "Error.hs" "haskell"
[diag] <- waitForDiagnosticsSource "ghcmod"
liftIO $ do
diag ^. source `shouldBe` Just "ghcmod"
describe "rename" $
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" $
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
doc <- openDoc "Desktop/simple.hs" "haskell"
-- hover returns nothing until module is loaded
skipManyTill loggingNotification $ count 2 noDiagnostics
liftIO $ hover `shouldSatisfy` isJust
describe "getHighlights" $
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" $
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" $
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))
doc <- openDoc "Format.hs" "haskell"
oldContents <- documentContents doc
formatRange doc (FormattingOptions 4 True) (Range (Position 1 10) (Position 2 10))
describe "closeDoc" $
it "works" $
let sesh =
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
doc <- openDoc "Format.hs" "haskell"
closeDoc doc
-- need to evaluate to throw