{-# 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
runSession
+ , runSessionWithHandles
+ , runSessionWithCapabilities
, Session
-- * Sending
, sendRequest
, sendNotification
+ , sendRequest'
+ , sendNotification'
+ , sendResponse
-- * Receving
- , getMessage
+ , 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.Monad.Trans.Class
+import Control.Applicative
+import Control.Applicative.Combinators
+import Control.Monad
import Control.Monad.IO.Class
-import Control.Monad.Trans.Reader
-import Control.Monad.Trans.State
import Control.Concurrent
+import Control.Lens hiding ((.=), List)
import qualified Data.Text as T
import qualified Data.Text.IO as T
import Data.Aeson
import qualified Data.ByteString.Lazy.Char8 as B
import Data.Default
-import Data.Maybe
-import Data.Proxy
-import System.Process
-import Language.Haskell.LSP.Types hiding (error, id)
-import Compat
+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
-import Language.Haskell.LSP.Test.Parsing
-
-data SessionContext = SessionContext
- {
- messageSema :: MVar B.ByteString,
- serverIn :: Handle,
- serverOut :: Handle,
- rootDir :: FilePath
- }
-
-newtype SessionState = SessionState
- {
- curReqId :: LspId
- }
-type Session = StateT SessionState (ReaderT SessionContext IO)
-
-runSession :: FilePath -> Session a -> IO ()
-runSession rootDir session = do
-
- absRootDir <- canonicalizePath rootDir
-
- (Just serverIn, Just serverOut, Nothing, serverProc) <- createProcess
- (proc "hie" ["--lsp", "-d", "-l", "/tmp/hie-test.log"])
- { std_in = CreatePipe, std_out = CreatePipe }
- hSetBuffering serverIn NoBuffering
- hSetBuffering serverOut NoBuffering
+-- | 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
- messageSema <- newEmptyMVar
+ absRootDir <- canonicalizePath rootDir
- let initializeParams :: InitializeParams
- initializeParams = InitializeParams (Just pid)
+ let initializeParams = InitializeParams (Just pid)
(Just $ T.pack absRootDir)
(Just $ filePathToUri absRootDir)
Nothing
- def
+ caps
(Just TraceOff)
- context = SessionContext messageSema serverIn serverOut absRootDir
- initState = SessionState (IdInt 9)
- -- | The session wrapped around initialize and shutdown calls
- fullSession = do
- sendRequest (Proxy :: Proxy InitializeRequest) Initialize initializeParams
- (ResponseMessage _ _ (Just (InitializeResponseCapabilities _)) e) <- getMessage
- liftIO $ maybe (return ()) (putStrLn . ("Error when initializing: " ++) . show ) e
+ withServer serverExe $ \serverIn serverOut _ -> runSessionWithHandles serverIn serverOut listenServer rootDir $ do
- sendNotification Initialized InitializedParams
+ -- Wrap the session around initialize and shutdown calls
+ sendRequest Initialize initializeParams
+ initRspMsg <- response :: Session InitializeResponse
- -- Run the actual thing
- session
+ liftIO $ maybe (return ()) (putStrLn . ("Error while initializing: " ++) . show ) (initRspMsg ^. LSP.error)
- sendNotification Exit ExitParams
+ initRspVar <- initRsp <$> ask
+ liftIO $ putMVar initRspVar initRspMsg
+
+ sendNotification Initialized InitializedParams
- forkIO $ listenServer context
- _ <- runReaderT (runStateT fullSession initState) context
+ -- Run the actual test
+ result <- session
- terminateProcess serverProc
+ sendNotification Exit ExitParams
- return ()
+ return result
-- | Listens to the server output, makes sure it matches the record and
-- signals any semaphores
-listenServer :: SessionContext -> IO ()
-listenServer context = do
- msgBytes <- getNextMessage (serverOut context)
+listenServer :: Handle -> Session ()
+listenServer serverOut = do
+ msgBytes <- liftIO $ getNextMessage serverOut
+
+ context <- ask
+ reqMap <- liftIO $ readMVar $ requestMap context
+
+ let msg = decodeFromServerMsg reqMap msgBytes
+ processTextChanges msg
+ liftIO $ writeChan (messageChan context) msg
- case decode msgBytes :: Maybe LogMessageNotification of
- -- Just print log and show messages
- Just (NotificationMessage _ WindowLogMessage (LogMessageParams _ msg)) -> T.putStrLn msg
- _ -> case decode msgBytes :: Maybe ShowMessageNotification of
- Just (NotificationMessage _ WindowShowMessage (ShowMessageParams _ msg)) -> T.putStrLn msg
- -- Give everything else for getMessage to handle
- _ -> putMVar (messageSema context) msgBytes
+ listenServer serverOut
- listenServer context
+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 [])
+
+ let groupedParams = groupBy (\a b -> (a ^. textDocument == b ^. textDocument)) changeParams
+ mergedParams = map mergeParams groupedParams
+
+ 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)
+
+ 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
- :: forall params resp. (ToJSON params, ToJSON resp, FromJSON resp)
- => Proxy (RequestMessage ClientMethod params resp)
- -> ClientMethod
- -> params
- -> Session LspId
-sendRequest _ method params = do
- h <- serverIn <$> lift ask
-
+ :: (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
- get >>= \c -> put c { curReqId = nextId id }
+ modify $ \c -> c { curReqId = nextId id }
- let msg = RequestMessage "2.0" id method params :: RequestMessage ClientMethod params resp
+ let req = RequestMessage' "2.0" id method params
- liftIO $ B.hPut h $ addHeader (encode msg)
+ -- 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 -> a -> Session ()
-sendNotification method params = do
- h <- serverIn <$> lift ask
+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
- let msg = NotificationMessage "2.0" method params
+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)
--- | Reads in a message from the server.
-getMessage :: FromJSON a => Session a
-getMessage = do
- sema <- messageSema <$> lift ask
- bytes <- liftIO $ takeMVar sema
- return $ fromMaybe (error $ "Wrong type! Got: " ++ show bytes) (decode bytes)
+-- | 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.
+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 <- lift ask
+ context <- ask
let fp = rootDir context </> file
contents <- liftIO $ T.readFile fp
return $ TextDocumentItem (filePathToUri fp) (T.pack languageId) 0 contents
-- | Gets the Uri for the file corrected to the session directory.
getDocUri :: FilePath -> Session Uri
getDocUri file = do
- context <- lift ask
+ context <- ask
let fp = rootDir context </> file
return $ filePathToUri fp
projects / opengl.git / blobdiff