, SessionException(..)
, anySessionException
, withTimeout
+ -- * Capabilities
+ , fullCaps
-- * Sending
, sendRequest
, sendRequest_
import qualified Language.Haskell.LSP.Types.Capabilities as LSP
import Language.Haskell.LSP.Messages
import Language.Haskell.LSP.VFS
+import Language.Haskell.LSP.Test.Capabilities
import Language.Haskell.LSP.Test.Compat
import Language.Haskell.LSP.Test.Decoding
import Language.Haskell.LSP.Test.Exceptions
-- | Starts a new session.
runSession :: String -- ^ The command to run the server.
+ -> LSP.ClientCapabilities -- ^ The capabilities that the client should declare.
-> FilePath -- ^ The filepath to the root directory for the session.
-> Session a -- ^ The session to run.
-> IO a
runSession = runSessionWithConfig def
-- | Starts a new sesion with a client with the specified capabilities.
-runSessionWithConfig :: SessionConfig -- ^ The capabilities the client should have.
+runSessionWithConfig :: SessionConfig -- ^ Configuration options for the session.
-> String -- ^ The command to run the server.
+ -> LSP.ClientCapabilities -- ^ The capabilities that the client should declare.
-> FilePath -- ^ The filepath to the root directory for the session.
-> Session a -- ^ The session to run.
-> IO a
-runSessionWithConfig config serverExe rootDir session = do
+runSessionWithConfig config serverExe caps rootDir session = do
pid <- getCurrentProcessID
absRootDir <- canonicalizePath rootDir
(Just $ T.pack absRootDir)
(Just $ filePathToUri absRootDir)
Nothing
- (capabilities config)
+ caps
(Just TraceOff)
withServer serverExe (logStdErr config) $ \serverIn serverOut _ ->
- runSessionWithHandles serverIn serverOut listenServer config rootDir $ do
+ runSessionWithHandles serverIn serverOut listenServer config caps rootDir $ do
-- Wrap the session around initialize and shutdown calls
initRspMsg <- sendRequest Initialize initializeParams :: Session InitializeResponse
verDoc <- getVersionedDoc doc
- caps <- asks (capabilities . config)
+ caps <- asks sessionCapabilities
let supportsDocChanges = fromMaybe False $ do
let LSP.ClientCapabilities mWorkspace _ _ = caps
--- /dev/null
+module Language.Haskell.LSP.Test.Capabilities where
+import Language.Haskell.LSP.Types
+import Language.Haskell.LSP.Types.Capabilities
+
+-- | Capabilities for full conformance to the LSP specification.
+-- The whole shebang.
+fullCaps :: ClientCapabilities
+fullCaps = ClientCapabilities (Just w) (Just td) Nothing
+ where
+ w = WorkspaceClientCapabilities
+ (Just True)
+ (Just (WorkspaceEditClientCapabilities (Just True)))
+ (Just (DidChangeConfigurationClientCapabilities (Just True)))
+ (Just (DidChangeWatchedFilesClientCapabilities (Just True)))
+ (Just (SymbolClientCapabilities (Just True)))
+ (Just (ExecuteClientCapabilities (Just True)))
+ td = TextDocumentClientCapabilities
+ (Just sync)
+ (Just (CompletionClientCapabilities
+ (Just True)
+ (Just (CompletionItemClientCapabilities (Just True)))))
+ (Just (HoverClientCapabilities (Just True)))
+ (Just (SignatureHelpClientCapabilities (Just True)))
+ (Just (ReferencesClientCapabilities (Just True)))
+ (Just (DocumentHighlightClientCapabilities (Just True)))
+ (Just (DocumentSymbolClientCapabilities (Just True)))
+ (Just (FormattingClientCapabilities (Just True)))
+ (Just (RangeFormattingClientCapabilities (Just True)))
+ (Just (OnTypeFormattingClientCapabilities (Just True)))
+ (Just (DefinitionClientCapabilities (Just True)))
+ (Just codeAction)
+ (Just (CodeLensClientCapabilities (Just True)))
+ (Just (DocumentLinkClientCapabilities (Just True)))
+ (Just (RenameClientCapabilities (Just True)))
+ sync = SynchronizationTextDocumentClientCapabilities
+ (Just True)
+ (Just True)
+ (Just True)
+ (Just True)
+ codeAction = CodeActionClientCapabilities
+ (Just True)
+ (Just (CodeActionLiteralSupport kinds))
+ kinds = CodeActionKindValueSet
+ (List [ CodeActionQuickFix
+ , CodeActionRefactor
+ , CodeActionRefactorExtract
+ , CodeActionRefactorInline
+ , CodeActionRefactorRewrite
+ , CodeActionSource
+ , CodeActionSourceOrganizeImports
+ ])
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 --lsp" 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
+ it "initializeResponse" $ runSession "hie --lsp" 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 --lsp" didChangeCaps "test/data/renamePass" $ return ()
describe "withTimeout" $ do
it "times out" $
- let sesh = runSession "hie --lsp" "test/data/renamePass" $ do
+ let sesh = runSession "hie --lsp" 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 --lsp" 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 --lsp" fullCaps "test/data/renamePass" $ do
doc <- openDoc "Desktop/simple.hs" "haskell"
withTimeout 3 $ getDocumentSymbols doc
liftIO $ threadDelay 5000000
it "overrides global message timeout" $
let sesh =
- runSessionWithConfig (def { messageTimeout = 5 }) "hie --lsp" "test/data/renamePass" $ do
+ runSessionWithConfig (def { messageTimeout = 5 }) "hie --lsp" 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 --lsp" 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 --lsp" 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 --lsp" fullCaps "test/data/renamePass" $ do
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
- in runSession "hie --lsp" "test/data/renamePass" publishDiagnosticsNotification `shouldThrow` selector
+ in runSession "hie --lsp" 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
sendRequest' TextDocumentDocumentSymbol (DocumentSymbolParams doc)
skipMany anyNotification
message :: Session RenameResponse -- the wrong type
- in runSession "hie --lsp" "test/data/renamePass" sesh
+ in runSession "hie --lsp" fullCaps "test/data/renamePass" sesh
`shouldThrow` selector
describe "replaySession" $ do
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
describe "text document VFS" $
it "sends back didChange notifications" $
- runSession "hie --lsp" "test/data/refactor" $ do
+ runSession "hie --lsp" def "test/data/refactor" $ do
doc <- openDoc "Main.hs" "haskell"
let args = toJSON $ AOP (doc ^. uri)
describe "getDocumentEdit" $
it "automatically consumes applyedit requests" $
- runSession "hie --lsp" "test/data/refactor" $ do
+ runSession "hie --lsp" fullCaps "test/data/refactor" $ do
doc <- openDoc "Main.hs" "haskell"
let args = toJSON $ AOP (doc ^. uri)
noDiagnostics
describe "getAllCodeActions" $
- it "works" $ runSession "hie --lsp" "test/data/refactor" $ do
+ it "works" $ runSession "hie --lsp" fullCaps "test/data/refactor" $ do
doc <- openDoc "Main.hs" "haskell"
_ <- waitForDiagnostics
actions <- getAllCodeActions doc
liftIO $ do
- let [CommandOrCodeActionCommand action] = actions
+ let [CommandOrCodeActionCodeAction 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 --lsp" fullCaps "test/data/renamePass" $ do
doc <- openDoc "Desktop/simple.hs" "haskell"
skipMany loggingNotification
mainSymbol ^. containerName `shouldBe` Nothing
describe "applyEdit" $ do
- it "increments the version" $ runSessionWithConfig (def { capabilities = docChangesCaps }) "hie --lsp" "test/data/renamePass" $ do
+ it "increments the version" $ runSession "hie --lsp" 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 --lsp" 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 --lsp" def "test/data/renamePass" $ do
doc <- openDoc "Desktop/simple.hs" "haskell"
- [item] <- getCompletions doc (Position 5 5)
+ 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 --lsp" fullCaps "test/data/renamePass" $ do
doc <- openDoc "Desktop/simple.hs" "haskell"
let pos = Position 40 3 -- interactWithUser
uri = doc ^. LSP.uri
]
describe "getDefinitions" $
- it "works" $ runSession "hie --lsp" "test/data/renamePass" $ do
+ it "works" $ runSession "hie --lsp" 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" "test/data" $ do
+ it "works" $ runSession "hie --lsp" 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 --lsp" 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" "test/data/renamePass" $ do
+ it "works" $ runSession "hie --lsp" fullCaps "test/data/renamePass" $ do
doc <- openDoc "Desktop/simple.hs" "haskell"
-- hover returns nothing until module is loaded
skipManyTill loggingNotification $ count 2 noDiagnostics
liftIO $ hover `shouldSatisfy` isJust
describe "getHighlights" $
- it "works" $ runSession "hie --lsp" "test/data/renamePass" $ do
+ it "works" $ runSession "hie --lsp" 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" "test/data" $ do
+ it "works" $ runSession "hie --lsp" 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" "test/data" $ do
+ it "works" $ runSession "hie --lsp" fullCaps "test/data" $ do
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 =
- runSession "hie --lsp" "test/data" $ do
+ runSession "hie --lsp" fullCaps "test/data" $ do
doc <- openDoc "Format.hs" "haskell"
closeDoc doc
-- need to evaluate to throw
{"tag":"FromClient","contents":["2018-06-03T04:08:38.856591Z",{"tag":"ReqInitialize","contents":{"jsonrpc":"2.0","params":{"rootUri":"file:///Users/luke","processId":7558,"rootPath":"/Users/luke","capabilities":{"textDocument":{"completion":{"completionItem":{"snippetSupport":false}}}},"trace":"off"},"method":"initialize","id":9}}]}
-{"tag":"FromServer","contents":["2018-06-03T04:08:38.873087Z",{"tag":"RspInitialize","contents":{"result":{"capabilities":{"textDocumentSync":{"openClose":true,"change":2,"willSave":false,"willSaveWaitUntil":false,"save":{"includeText":false}},"documentRangeFormattingProvider":true,"documentHighlightProvider":true,"executeCommandProvider":{"commands":["1234:applyrefact:applyOne","1234:hare:demote","16026:hie:applyWorkspaceEdit","16026:hsimport:import","16026:package:add"]},"renameProvider":true,"definitionProvider":true,"hoverProvider":true,"codeActionProvider":true,"completionProvider":{"triggerCharacters":["."],"resolveProvider":true},"documentSymbolProvider":true,"documentFormattingProvider":true,"referencesProvider":true}},"jsonrpc":"2.0","id":9}}]}
+{"tag":"FromServer","contents":["2018-06-03T04:08:38.873087Z",{"tag":"RspInitialize","contents":{"result":{"capabilities":{"textDocumentSync":{"openClose":true,"change":2,"willSave":false,"willSaveWaitUntil":false,"save":{"includeText":false}},"documentRangeFormattingProvider":true,"documentHighlightProvider":true,"executeCommandProvider":{"commands":["7796:applyrefact:applyOne","7796:applyrefact:applyAll","7796:applyrefact:lint","7796:base:version","7796:base:plugins","7796:base:commands","7796:base:commandDetail","7796:brittany:format","7796:build:prepare","7796:build:isConfigured","7796:build:configure","7796:build:listTargets","7796:build:listFlags","7796:build:buildDirectory","7796:build:buildTarget","7796:eg2:sayHello","7796:eg2:sayHelloTo ","7796:ghcmod:check","7796:ghcmod:lint","7796:ghcmod:info","7796:ghcmod:type","7796:ghcmod:casesplit","7796:hare:demote","7796:hare:dupdef","7796:hare:iftocase","7796:hare:liftonelevel","7796:hare:lifttotoplevel","7796:hare:rename","7796:hare:deletedef","7796:hare:genapplicative","7796:hoogle:info","7796:hoogle:lookup","7796:hsimport:import","7796:package:add"]},"renameProvider":true,"definitionProvider":true,"hoverProvider":true,"codeActionProvider":true,"completionProvider":{"triggerCharacters":["."],"resolveProvider":true},"documentSymbolProvider":true,"documentFormattingProvider":true,"referencesProvider":true}},"jsonrpc":"2.0","id":9}}]}
{"tag":"FromClient","contents":["2018-06-03T04:08:39.325465Z",{"tag":"NotInitialized","contents":{"jsonrpc":"2.0","params":{},"method":"initialized"}}]}
{"tag":"FromClient","contents":["2018-06-03T04:08:39.325807Z",{"tag":"NotDidChangeConfiguration","contents":{"jsonrpc":"2.0","params":{"settings":{}},"method":"workspace/didChangeConfiguration"}}]}
{"tag":"FromClient","contents":["2018-06-03T04:08:39.326177Z",{"tag":"NotDidOpenTextDocument","contents":{"jsonrpc":"2.0","params":{"textDocument":{"languageId":"haskell","text":"module Main where\n\nmain :: IO ()\nmain = do\n let initialList = []\n interactWithUser initialList\n\ntype Item = String\ntype Items = [Item]\n\ndata Command = Quit\n | DisplayItems\n | AddItem String\n | RemoveItem Int\n | Help\n\ntype Error = String\n\nparseCommand :: String -> Either Error Command\nparseCommand line = case words line of\n [\"quit\"] -> Right Quit\n [\"items\"] -> Right DisplayItems\n \"add\" : item -> Right $ AddItem $ unwords item\n \"remove\" : i -> Right $ RemoveItem $ read $ unwords i\n [\"help\"] -> Right Help\n _ -> Left \"Unknown command\"\n\naddItem :: Item -> Items -> Items\naddItem = (:)\n\ndisplayItems :: Items -> String\ndisplayItems = unlines . map (\"- \" ++)\n\nremoveItem :: Int -> Items -> Either Error Items\nremoveItem i items\n | i < 0 || i >= length items = Left \"Out of range\"\n | otherwise = Right result\n where (front, back) = splitAt (i + 1) items\n result = init front ++ back\n\ninteractWithUser :: Items -> IO ()\ninteractWithUser items = do\n line <- getLine\n case parseCommand line of\n Right DisplayItems -> do\n putStrLn $ displayItems items\n interactWithUser items\n\n Right (AddItem item) -> do\n let newItems = addItem item items\n putStrLn \"Added\"\n interactWithUser newItems\n\n Right (RemoveItem i) ->\n case removeItem i items of\n Right newItems -> do\n putStrLn $ \"Removed \" ++ items !! i\n interactWithUser newItems\n Left err -> do\n putStrLn err\n interactWithUser items\n\n\n Right Quit -> return ()\n\n Right Help -> do\n putStrLn \"Commands:\"\n putStrLn \"help\"\n putStrLn \"items\"\n putStrLn \"add\"\n putStrLn \"quit\"\n interactWithUser items\n\n Left err -> do\n putStrLn $ \"Error: \" ++ err\n interactWithUser items\n","uri":"file:///Users/luke/Desktop/simple.hs","version":0}},"method":"textDocument/didOpen"}}]}
projects / opengl.git / commitdiff