{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE RankNTypes #-}
+{-# LANGUAGE ScopedTypeVariables #-}
+{-# LANGUAGE ExistentialQuantification #-}
+
+-- |
+-- Module : Language.Haskell.LSP.Test
+-- Description : A functional testing framework for LSP servers.
+-- Maintainer : luke_lau@icloud.com
+-- Stability : experimental
+--
+-- A framework for testing <https://github.com/Microsoft/language-server-protocol Language Server Protocol servers> at the JSON level.
+
module Language.Haskell.LSP.Test
(
-- * Sessions
- session
- -- * Documents
- , openDocument
- , documentSymbols
+ runSession
+ , runSessionWithHandles
+ , runSessionWithCapabilities
+ , Session
+ -- * Sending
+ , sendRequest
+ , sendNotification
+ , sendRequest'
+ , sendNotification'
+ , sendResponse
+ -- * Receving
+ , anyRequest
+ , request
+ , anyResponse
+ , response
+ , anyNotification
+ , notification
+ , loggingNotification
+ , publishDiagnosticsNotification
+ -- * Combinators
+ , choice
+ , option
+ , optional
+ , between
+ , some
+ , many
+ , sepBy
+ , sepBy1
+ , sepEndBy1
+ , sepEndBy
+ , endBy1
+ , endBy
+ , count
+ , manyTill
+ , skipMany
+ , skipSome
+ , skipManyTill
+ , skipSomeTill
+ , (<|>)
+ , satisfy
+ -- * Utilities
+ , getInitializeResponse
+ , openDoc
+ , getDocItem
+ , getDocUri
) where
-import Control.Lens
+import Control.Applicative
+import Control.Applicative.Combinators
+import Control.Monad
import Control.Monad.IO.Class
-import Control.Monad.Trans.Reader
+import Control.Concurrent
+import Control.Lens hiding ((.=), List)
import qualified Data.Text as T
import qualified Data.Text.IO as T
-import Data.Maybe
-import Data.Proxy
-import System.Process
-import qualified Language.Haskell.LSP.Client as Client
-import qualified Language.Haskell.LSP.TH.DataTypesJSON as LSP
-import Capabilities
-import Compat
-
-type Session = ReaderT Client.Client IO
-
-session :: Session a -> IO ()
-session f = do
- (Just hin, Just hout, _, serverProc) <- createProcess (proc "hie" ["--lsp", "-l", "/tmp/hie.log"])
- { std_in = CreatePipe, std_out = CreatePipe }
- client <- Client.start $ Client.Config hin hout notificationHandler requestHandler
+import Data.Aeson
+import qualified Data.ByteString.Lazy.Char8 as B
+import Data.Default
+import Data.Foldable
+import qualified Data.HashMap.Strict as HashMap
+import Data.List
+import Language.Haskell.LSP.Types
+import qualified Language.Haskell.LSP.Types as LSP (error, id)
+import Language.Haskell.LSP.TH.ClientCapabilities
+import Language.Haskell.LSP.Messages
+import Language.Haskell.LSP.VFS
+import Language.Haskell.LSP.Test.Compat
+import Language.Haskell.LSP.Test.Decoding
+import Language.Haskell.LSP.Test.Parsing
+import Language.Haskell.LSP.Test.Session
+import Language.Haskell.LSP.Test.Server
+import System.IO
+import System.Directory
+import System.FilePath
+-- | Starts a new session.
+runSession :: String -- ^ The command to run the server.
+ -> FilePath -- ^ The filepath to the root directory for the session.
+ -> Session a -- ^ The session to run.
+ -> IO a
+runSession = runSessionWithCapabilities def
+
+-- | Starts a new sesion with a client with the specified capabilities.
+runSessionWithCapabilities :: ClientCapabilities -- ^ The capabilities the client should have.
+ -> String -- ^ The command to run the server.
+ -> FilePath -- ^ The filepath to the root directory for the session.
+ -> Session a -- ^ The session to run.
+ -> IO a
+runSessionWithCapabilities caps serverExe rootDir session = do
pid <- getProcessID
+ absRootDir <- canonicalizePath rootDir
- let initializeParams :: LSP.InitializeParams
- initializeParams = LSP.InitializeParams (Just pid)
- Nothing
- Nothing
- Nothing
- capabilities
+ let initializeParams = InitializeParams (Just pid)
+ (Just $ T.pack absRootDir)
+ (Just $ filePathToUri absRootDir)
Nothing
+ caps
+ (Just TraceOff)
- Client.sendClientRequest client
- (Proxy :: Proxy LSP.InitializeRequest)
- LSP.Initialize initializeParams
- Client.sendClientNotification client
- LSP.Initialized
- (Just LSP.InitializedParams)
+ withServer serverExe $ \serverIn serverOut _ -> runSessionWithHandles serverIn serverOut listenServer rootDir $ do
- putStrLn "Session started"
+ -- Wrap the session around initialize and shutdown calls
+ sendRequest Initialize initializeParams
+ initRspMsg <- response :: Session InitializeResponse
- runReaderT f client
+ liftIO $ maybe (return ()) (putStrLn . ("Error while initializing: " ++) . show ) (initRspMsg ^. LSP.error)
- Client.sendClientRequest client
- (Proxy :: Proxy LSP.ShutdownRequest)
- LSP.Shutdown Nothing
- Client.sendClientNotification client
- LSP.Exit
- (Just LSP.ExitParams)
+ initRspVar <- initRsp <$> ask
+ liftIO $ putMVar initRspVar initRspMsg
- Client.stop client
+ sendNotification Initialized InitializedParams
- -- todo: this interrupts the test server process as well?
- -- interruptProcessGroupOf serverProc
- -- waitForProcess serverProc
- terminateProcess serverProc
+ -- Run the actual test
+ result <- session
- putStrLn "Session ended"
+ sendNotification Exit ExitParams
-openDocument :: FilePath -> Session ()
-openDocument path = do
- text <- liftIO $ T.readFile path
+ return result
- let uri = LSP.filePathToUri path
+-- | Listens to the server output, makes sure it matches the record and
+-- signals any semaphores
+listenServer :: Handle -> Session ()
+listenServer serverOut = do
+ msgBytes <- liftIO $ getNextMessage serverOut
- client <- ask
- liftIO $ Client.sendClientNotification client LSP.TextDocumentDidOpen (Just (LSP.DidOpenTextDocumentParams (LSP.TextDocumentItem uri "haskell" 1 text)))
+ context <- ask
+ reqMap <- liftIO $ readMVar $ requestMap context
-documentSymbols :: FilePath -> Session (LSP.List LSP.SymbolInformation)
-documentSymbols path = do
- let uri = LSP.filePathToUri path
+ let msg = decodeFromServerMsg reqMap msgBytes
+ processTextChanges msg
+ liftIO $ writeChan (messageChan context) msg
- client <- ask
+ listenServer serverOut
- liftIO $ do
- res <- Client.sendClientRequest client
- (Proxy :: Proxy LSP.DocumentSymbolRequest)
- LSP.TextDocumentDocumentSymbol (LSP.DocumentSymbolParams (LSP.TextDocumentIdentifier uri))
- return $ case res of
- Just (Right syms) -> syms
- _ -> error "Failed to get document symbols"
+processTextChanges :: FromServerMessage -> Session ()
+processTextChanges (ReqApplyWorkspaceEdit r) = do
+ List changeParams <- case r ^. params . edit . documentChanges of
+ Just cs -> mapM applyTextDocumentEdit cs
+ Nothing -> case r ^. params . edit . changes of
+ Just cs -> mapM (uncurry applyTextEdit) (List (HashMap.toList cs))
+ Nothing -> return (List [])
-notificationHandler :: Client.NotificationMessageHandler
-notificationHandler = Client.NotificationMessageHandler
- (\(LSP.NotificationMessage _ _ (LSP.ShowMessageParams _ msg)) -> print msg)
- (\(LSP.NotificationMessage _ _ (LSP.LogMessageParams _ msg)) -> print msg)
- (\(LSP.NotificationMessage _ _ json) -> putStrLn $ "Telemetry: " ++ show json)
- (\(LSP.NotificationMessage _ _ (LSP.PublishDiagnosticsParams uri diags)) ->
- putStrLn $ "Diagnostics at " ++ showUri uri ++ ": " ++ showDiags diags)
+ let groupedParams = groupBy (\a b -> (a ^. textDocument == b ^. textDocument)) changeParams
+ mergedParams = map mergeParams groupedParams
- where showDiags :: LSP.List LSP.Diagnostic -> String
- showDiags (LSP.List diags) = unlines $ map (T.unpack . (^. LSP.message)) diags
- showUri :: LSP.Uri -> String
- showUri = fromMaybe "unknown path" . LSP.uriToFilePath
+ forM_ mergedParams (sendNotification TextDocumentDidChange)
+ where applyTextDocumentEdit (TextDocumentEdit docId (List edits)) = do
+ oldVFS <- vfs <$> get
+ let changeEvents = map (\e -> TextDocumentContentChangeEvent (Just (e ^. range)) Nothing (e ^. newText)) edits
+ params = DidChangeTextDocumentParams docId (List changeEvents)
+ newVFS <- liftIO $ changeVFS oldVFS (fmClientDidChangeTextDocumentNotification params)
+ modify (\s -> s { vfs = newVFS })
+ return params
+ applyTextEdit uri edits = applyTextDocumentEdit (TextDocumentEdit (VersionedTextDocumentIdentifier uri 0) edits)
-requestHandler :: Client.RequestMessageHandler
-requestHandler = Client.RequestMessageHandler
- (\m -> emptyRsp m <$ print m)
- (\m -> emptyRsp m <$ print m)
- (\m -> emptyRsp m <$ print m)
- (\m -> emptyRsp m <$ print m)
- where emptyRsp :: LSP.RequestMessage m req rsp -> LSP.ResponseMessage a
- emptyRsp m = LSP.ResponseMessage (m ^. LSP.jsonrpc)
- (lspIdToRspId $ m ^. LSP.id)
- Nothing
- Nothing
+ mergeParams :: [DidChangeTextDocumentParams] -> DidChangeTextDocumentParams
+ mergeParams params = let events = concat (toList (map (toList . (^. contentChanges)) params))
+ in DidChangeTextDocumentParams (head params ^. textDocument) (List events)
+processTextChanges _ = return ()
+
+-- | Sends a request to the server.
+--
+-- @
+-- sendRequest (Proxy :: Proxy DocumentSymbolRequest)
+-- TextDocumentDocumentSymbol
+-- (DocumentSymbolParams docId)
+-- @
+sendRequest
+ :: (ToJSON params)
+ => --Proxy (RequestMessage ClientMethod params resp) -- ^ A proxy to provide more type information about the request.
+ ClientMethod -- ^ The request method.
+ -> params -- ^ The request parameters.
+ -> Session LspId -- ^ The id of the request that was sent.
+sendRequest method params = do
+ id <- curReqId <$> get
+ modify $ \c -> c { curReqId = nextId id }
+
+ let req = RequestMessage' "2.0" id method params
+
+ -- Update the request map
+ reqMap <- requestMap <$> ask
+ liftIO $ modifyMVar_ reqMap $
+ \r -> return $ updateRequestMap r id method
+
+ sendMessage req
+
+ return id
+
+ where nextId (IdInt i) = IdInt (i + 1)
+ nextId (IdString s) = IdString $ T.pack $ show $ read (T.unpack s) + 1
+
+-- | A custom type for request message that doesn't
+-- need a response type, allows us to infer the request
+-- message type without using proxies.
+data RequestMessage' a = RequestMessage' T.Text LspId ClientMethod a
+
+instance ToJSON a => ToJSON (RequestMessage' a) where
+ toJSON (RequestMessage' rpc id method params) =
+ object ["jsonrpc" .= rpc, "id" .= id, "method" .= method, "params" .= params]
+
+
+sendRequest' :: (ToJSON a, ToJSON b) => RequestMessage ClientMethod a b -> Session ()
+sendRequest' req = do
+ -- Update the request map
+ reqMap <- requestMap <$> ask
+ liftIO $ modifyMVar_ reqMap $
+ \r -> return $ updateRequestMap r (req ^. LSP.id) (req ^. method)
+
+ sendMessage req
+
+-- | Sends a notification to the server.
+sendNotification :: ToJSON a
+ => ClientMethod -- ^ The notification method.
+ -> a -- ^ The notification parameters.
+ -> Session ()
+sendNotification method params =
+ let notif = NotificationMessage "2.0" method params
+ in sendNotification' notif
+
+sendNotification' :: (ToJSON a, ToJSON b) => NotificationMessage a b -> Session ()
+sendNotification' = sendMessage
+
+sendResponse :: ToJSON a => ResponseMessage a -> Session ()
+sendResponse = sendMessage
+
+sendMessage :: ToJSON a => a -> Session ()
+sendMessage msg = do
+ h <- serverIn <$> ask
+ liftIO $ B.hPut h $ addHeader (encode msg)
+
+-- | Returns the initialize response that was received from the server.
+-- The initialize requests and responses are not included the session,
+-- so if you need to test it use this.
+getInitializeResponse :: Session InitializeResponse
+getInitializeResponse = initRsp <$> ask >>= (liftIO . readMVar)
+
+-- | Opens a text document and sends a notification to the client.
+openDoc :: FilePath -> String -> Session TextDocumentIdentifier
+openDoc file languageId = do
+ item <- getDocItem file languageId
+ sendNotification TextDocumentDidOpen (DidOpenTextDocumentParams item)
+ TextDocumentIdentifier <$> getDocUri file
+
+-- | Reads in a text document as the first version.
+getDocItem :: FilePath -- ^ The path to the text document to read in.
+ -> String -- ^ The language ID, e.g "haskell" for .hs files.
+ -> Session TextDocumentItem
+getDocItem file languageId = do
+ context <- ask
+ let fp = rootDir context </> file
+ contents <- liftIO $ T.readFile fp
+ return $ TextDocumentItem (filePathToUri fp) (T.pack languageId) 0 contents
- lspIdToRspId (LSP.IdInt i) = LSP.IdRspInt i
- lspIdToRspId (LSP.IdString i) = LSP.IdRspString i
+-- | Gets the Uri for the file corrected to the session directory.
+getDocUri :: FilePath -> Session Uri
+getDocUri file = do
+ context <- ask
+ let fp = rootDir context </> file
+ return $ filePathToUri fp
projects / opengl.git / blobdiff