X-Git-Url: http://git.lukelau.me/?a=blobdiff_plain;f=src%2FLanguage%2FHaskell%2FLSP%2FTest.hs;h=ce061e9fa33590c3c46d274f8907208a8feccf4c;hb=bf56f6dd8c0b0fc34770135819caa54a6410b1df;hp=f8f839460e56aefda12b0ae446c7b20ada70e9e1;hpb=df782ad008b840c0860173821226542e2e70f2e9;p=opengl.git diff --git a/src/Language/Haskell/LSP/Test.hs b/src/Language/Haskell/LSP/Test.hs index f8f8394..ce061e9 100644 --- a/src/Language/Haskell/LSP/Test.hs +++ b/src/Language/Haskell/LSP/Test.hs @@ -3,14 +3,26 @@ {-# 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 at the JSON level. + module Language.Haskell.LSP.Test ( -- * Sessions runSession + , runSessionWithHandler , Session -- * Sending , sendRequest , sendNotification + , sendRequest' + , sendNotification' + , sendResponse' -- * Receving , getMessage -- * Utilities @@ -18,6 +30,7 @@ module Language.Haskell.LSP.Test , getDocUri ) where +import Control.Monad import Control.Monad.Trans.Class import Control.Monad.IO.Class import Control.Monad.Trans.Reader @@ -32,7 +45,7 @@ import Data.Maybe import Data.Proxy import System.Process import Language.Haskell.LSP.Types hiding (error, id) -import Compat +import Language.Haskell.LSP.Test.Compat import System.IO import System.Directory import System.FilePath @@ -42,7 +55,6 @@ data SessionContext = SessionContext { messageSema :: MVar B.ByteString, serverIn :: Handle, - serverOut :: Handle, rootDir :: FilePath } @@ -50,60 +62,84 @@ newtype SessionState = SessionState { curReqId :: LspId } + +-- | A session representing one instance of launching and connecting to a server. +-- +-- You can send and receive messages to the server within 'Session' via 'getMessage', +-- 'sendRequest' and 'sendNotification'. +-- +-- @ +-- runSession \"path\/to\/root\/dir\" $ do +-- docItem <- getDocItem "Desktop/simple.hs" "haskell" +-- sendNotification TextDocumentDidOpen (DidOpenTextDocumentParams docItem) +-- diagnostics <- getMessage :: Session PublishDiagnosticsNotification +-- @ +-- type Session = StateT SessionState (ReaderT SessionContext IO) -runSession :: FilePath -> Session a -> IO () +-- | Starts a new session. +runSession :: FilePath -- ^ The filepath to the root directory for the session. + -> Session a -- ^ The session to run. + -> 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 - 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 (Just TraceOff) - context = SessionContext messageSema serverIn serverOut absRootDir - initState = SessionState (IdInt 9) - -- | The session wrapped around initialize and shutdown calls - fullSession = do + runSessionWithHandler listenServer rootDir $ do + + -- Wrap the session around initialize and shutdown calls sendRequest (Proxy :: Proxy InitializeRequest) Initialize initializeParams (ResponseMessage _ _ (Just (InitializeResponseCapabilities _)) e) <- getMessage liftIO $ maybe (return ()) (putStrLn . ("Error when initializing: " ++) . show ) e sendNotification Initialized InitializedParams - -- Run the actual thing + -- Run the actual test session sendNotification Exit ExitParams - forkIO $ listenServer context - _ <- runReaderT (runStateT fullSession initState) context +runSessionWithHandler :: (Handle -> Session ()) + -> FilePath + -> Session a + -> IO a +runSessionWithHandler serverHandler 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 + + messageSema <- newEmptyMVar + + let context = SessionContext messageSema serverIn absRootDir + initState = SessionState (IdInt 9) + + forkIO $ void $ runReaderT (runStateT (serverHandler serverOut) initState) context + (result, _) <- runReaderT (runStateT session initState) context terminateProcess serverProc - 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 + context <- lift ask + msgBytes <- liftIO $ getNextMessage serverOut - case decode msgBytes :: Maybe LogMessageNotification of + liftIO $ 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 @@ -111,36 +147,55 @@ listenServer context = do -- Give everything else for getMessage to handle _ -> putMVar (messageSema context) msgBytes - listenServer context + listenServer serverOut -- | 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 + => 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 - h <- serverIn <$> lift ask - id <- curReqId <$> get get >>= \c -> put c { curReqId = nextId id } - let msg = RequestMessage "2.0" id method params :: RequestMessage ClientMethod params resp + let req = RequestMessage "2.0" id method params :: RequestMessage ClientMethod params resp - liftIO $ B.hPut h $ addHeader (encode msg) + sendRequest' req return id where nextId (IdInt i) = IdInt (i + 1) nextId (IdString s) = IdString $ T.pack $ show $ read (T.unpack s) + 1 +sendRequest' :: (ToJSON a, ToJSON b, ToJSON c) => RequestMessage a b c -> Session () +sendRequest' = sendMessage + -- | Sends a notification to the server. -sendNotification :: ToJSON a => ClientMethod -> a -> Session () -sendNotification method params = do +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 <$> lift ask - - let msg = NotificationMessage "2.0" method params liftIO $ B.hPut h $ addHeader (encode msg) -- | Reads in a message from the server. @@ -151,10 +206,8 @@ getMessage = do return $ fromMaybe (error $ "Wrong type! Got: " ++ show bytes) (decode bytes) -- | 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