X-Git-Url: http://git.lukelau.me/?a=blobdiff_plain;f=src%2FLanguage%2FHaskell%2FLSP%2FTest.hs;h=fb928a4b9ccd0bfbec75cd4bae66af408e885242;hb=ac2553b38ed2228839cb72747f8c48b7c2fab488;hp=5883271d89bc57ab997530baa57721ad47a91ca0;hpb=1f4a12c49be0cb8640d60c21f6499c5567646fba;p=lsp-test.git diff --git a/src/Language/Haskell/LSP/Test.hs b/src/Language/Haskell/LSP/Test.hs index 5883271..fb928a4 100644 --- a/src/Language/Haskell/LSP/Test.hs +++ b/src/Language/Haskell/LSP/Test.hs @@ -1,122 +1,248 @@ {-# 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 at the JSON level. + module Language.Haskell.LSP.Test ( -- * Sessions - manualSession - -- * Documents - , openDocument - , documentSymbols + runSession + , runSessionWithHandler + , 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 + , 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 ((.=)) import qualified Data.Text as T import qualified Data.Text.IO as T -import Data.Maybe -import Data.Proxy +import Data.Aeson +import qualified Data.ByteString.Lazy.Char8 as B +import Data.Default import System.Process -import qualified Language.Haskell.LSP.Client as Client -import Language.Haskell.LSP.Messages -import qualified Language.Haskell.LSP.TH.DataTypesJSON as LSP -import Language.Haskell.LSP.Test.Recorded -import Capabilities -import Compat - -type Session = ReaderT Client.Client IO - -manualSession :: Session a -> IO () -manualSession 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 Language.Haskell.LSP.Types +import qualified Language.Haskell.LSP.Types as LSP (error, id) +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 + +-- | 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 pid <- getProcessID + absRootDir <- canonicalizePath rootDir - let initializeParams :: LSP.InitializeParams - initializeParams = LSP.InitializeParams (Just pid) - Nothing - Nothing + let initializeParams = InitializeParams (Just pid) + (Just $ T.pack absRootDir) + (Just $ filePathToUri absRootDir) Nothing - capabilities - Nothing - - Client.sendClientRequest client - (Proxy :: Proxy LSP.InitializeRequest) - LSP.Initialize initializeParams - Client.sendClientNotification client - LSP.Initialized - (Just LSP.InitializedParams) - - putStrLn "Session started" - - runReaderT f client + def + (Just TraceOff) - Client.sendClientRequest client - (Proxy :: Proxy LSP.ShutdownRequest) - LSP.Shutdown Nothing - Client.sendClientNotification client - LSP.Exit - (Just LSP.ExitParams) + runSessionWithHandler listenServer rootDir $ do - Client.stop client + -- Wrap the session around initialize and shutdown calls + sendRequest Initialize initializeParams + initRsp <- response :: Session InitializeResponse + liftIO $ maybe (return ()) (putStrLn . ("Error while initializing: " ++) . show ) (initRsp ^. LSP.error) - -- todo: this interrupts the test server process as well? - -- interruptProcessGroupOf serverProc - -- waitForProcess serverProc - terminateProcess serverProc - - putStrLn "Session ended" - -openDocument :: FilePath -> Session () -openDocument path = do - text <- liftIO $ T.readFile path - - let uri = LSP.filePathToUri path - - client <- ask - liftIO $ Client.sendClientNotification client LSP.TextDocumentDidOpen (Just (LSP.DidOpenTextDocumentParams (LSP.TextDocumentItem uri "haskell" 1 text))) + sendNotification Initialized InitializedParams -documentSymbols :: FilePath -> Session (LSP.List LSP.SymbolInformation) -documentSymbols path = do - let uri = LSP.filePathToUri path + -- Run the actual test + session - client <- ask + sendNotification Exit ExitParams - 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" +-- | 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 -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) + (Just serverIn, Just serverOut, Nothing, serverProc) <- createProcess + (proc "hie" ["--lsp", "-d", "-l", "/tmp/hie-test.log"]) + { std_in = CreatePipe, std_out = CreatePipe } - 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 + hSetBuffering serverIn NoBuffering + hSetBuffering serverOut NoBuffering + reqMap <- newMVar newRequestMap + messageChan <- newChan + meaninglessChan <- newChan + let context = SessionContext serverIn absRootDir messageChan reqMap + initState = SessionState (IdInt 9) -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 + threadId <- forkIO $ void $ runSession' meaninglessChan context initState (serverHandler serverOut) + (result, _) <- runSession' messageChan context initState session - lspIdToRspId (LSP.IdInt i) = LSP.IdRspInt i - lspIdToRspId (LSP.IdString i) = LSP.IdRspString i + terminateProcess serverProc + killThread threadId + + return result + +-- | 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 + + context <- ask + reqMap <- liftIO $ readMVar $ requestMap context + + liftIO $ writeChan (messageChan context) $ decodeFromServerMsg reqMap msgBytes + + listenServer serverOut + +-- | 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) + +-- | 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 + +-- | 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