X-Git-Url: http://git.lukelau.me/?a=blobdiff_plain;f=src%2FLanguage%2FHaskell%2FLSP%2FTest.hs;h=4de02fe1324b184835fe09b3d8ba5e8c63997d67;hb=d8ce5332e9ac2dc24bf1490f03bd30abb17196e8;hp=f8f839460e56aefda12b0ae446c7b20ada70e9e1;hpb=df782ad008b840c0860173821226542e2e70f2e9;p=lsp-test.git diff --git a/src/Language/Haskell/LSP/Test.hs b/src/Language/Haskell/LSP/Test.hs index f8f8394..4de02fe 100644 --- a/src/Language/Haskell/LSP/Test.hs +++ b/src/Language/Haskell/LSP/Test.hs @@ -3,161 +3,222 @@ {-# 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 + , request + , response + , notification + , loggingNotification + -- * Combinators + , choice + , option + , optional + , skipOptional + , between + , some + , many + , sepBy + , sepBy1 + , sepByNonEmpty + , sepEndBy1 + , sepEndByNonEmpty + , sepEndBy + , endBy1 + , endByNonEmpty + , endBy + , count + , chainl + , chainr + , chainl1 + , chainr1 + , manyTill + , try + , () + , skipMany + , skipSome + , unexpected + , notFollowedBy + , (<|>) + , satisfy -- * Utilities , getDocItem , getDocUri ) where -import Control.Monad.Trans.Class +import Control.Applicative +import Control.Monad import Control.Monad.IO.Class -import Control.Monad.Trans.Reader -import Control.Monad.Trans.State import Control.Concurrent +import Control.Lens 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 Language.Haskell.LSP.Types +import qualified Language.Haskell.LSP.Types as LSP (error) +import Language.Haskell.LSP.Messages +import Language.Haskell.LSP.Test.Compat import System.IO import System.Directory import System.FilePath +import Language.Haskell.LSP.Test.Decoding import Language.Haskell.LSP.Test.Parsing +import Text.Parser.Combinators -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 () +-- | 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 + RspInitialize initRsp <- response + liftIO $ maybe (return ()) (putStrLn . ("Error while initializing: " ++) . show ) (initRsp ^. LSP.error) sendNotification Initialized InitializedParams - -- Run the actual thing + -- Run the actual test session sendNotification Exit ExitParams - forkIO $ listenServer context - _ <- runReaderT (runStateT fullSession initState) context +-- | An internal version of 'runSession' that allows for a custom handler to listen to the server. +-- It also does not automatically send initialize and exit messages. +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 + + reqMap <- newMVar newRequestMap + messageChan <- newChan + meaninglessChan <- newChan + + let context = SessionContext serverIn absRootDir messageChan reqMap + initState = SessionState (IdInt 9) + + forkIO $ void $ runSession' meaninglessChan context initState (serverHandler serverOut) + (result, _) <- runSession' messageChan context initState session 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 + msgBytes <- liftIO $ getNextMessage serverOut + + context <- ask + reqMap <- liftIO $ readMVar $ requestMap context - 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 + liftIO $ writeChan (messageChan context) $ decodeFromServerMsg reqMap 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 } + 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 :: 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 --- | Sends a notification to the server. -sendNotification :: ToJSON a => ClientMethod -> a -> Session () -sendNotification method params = do - h <- serverIn <$> lift ask +sendRequest' :: (ToJSON a, ToJSON b) => RequestMessage ClientMethod a b -> Session () +sendRequest' req = do + -- Update the request map + reqMap <- requestMap <$> ask + liftIO $ modifyMVar_ reqMap (return . flip updateRequestMap req) - let msg = NotificationMessage "2.0" method params - liftIO $ B.hPut h $ addHeader (encode msg) + sendMessage req --- | 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) +-- | 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) -- | 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 @@ -165,6 +226,6 @@ getDocItem file languageId = do -- | 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 \ No newline at end of file