X-Git-Url: http://git.lukelau.me/?a=blobdiff_plain;f=src%2FLanguage%2FHaskell%2FLSP%2FTest.hs;h=8e5f21f445e5ae1a4ce8f1f42f2b7909324e57c6;hb=22df37c703e39fa5ebeb130be5785b3a9713c520;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..8e5f21f 100644 --- a/src/Language/Haskell/LSP/Test.hs +++ b/src/Language/Haskell/LSP/Test.hs @@ -3,161 +3,298 @@ {-# 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 + , runSessionWithHandles + , runSessionWithConfig , Session + , SessionConfig(..) + , MonadSessionConfig(..) + , SessionException(..) + , anySessionException -- * 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 - , getDocItem + , initializeResponse + , openDoc + , documentContents + , documentEdit , getDocUri + , noDiagnostics + , documentSymbols + , ) where -import Control.Monad.Trans.Class -import Control.Monad.IO.Class -import Control.Monad.Trans.Reader -import Control.Monad.Trans.State +import Control.Applicative +import Control.Applicative.Combinators import Control.Concurrent +import Control.Monad +import Control.Monad.IO.Class +import Control.Exception +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 qualified Data.HashMap.Strict as HashMap +import qualified Data.Map as Map import Data.Maybe -import Data.Proxy -import System.Process -import Language.Haskell.LSP.Types hiding (error, id) -import Compat +import Language.Haskell.LSP.Types hiding (id, capabilities) +import qualified Language.Haskell.LSP.Types as LSP +import Language.Haskell.LSP.VFS +import Language.Haskell.LSP.Test.Compat +import Language.Haskell.LSP.Test.Decoding +import Language.Haskell.LSP.Test.Exceptions +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 +import qualified Yi.Rope as Rope -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 +-- | 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 = runSessionWithConfig def +-- | Starts a new sesion with a client with the specified capabilities. +runSessionWithConfig :: SessionConfig -- ^ 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 +runSessionWithConfig config serverExe rootDir session = do + pid <- getCurrentProcessID 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 - - let initializeParams :: InitializeParams - initializeParams = InitializeParams (Just pid) + let initializeParams = InitializeParams (Just pid) (Just $ T.pack absRootDir) (Just $ filePathToUri absRootDir) Nothing - def + (capabilities config) (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 config 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 - forkIO $ listenServer context - _ <- runReaderT (runStateT fullSession initState) context + sendNotification Initialized InitializedParams - terminateProcess serverProc + -- Run the actual test + result <- session - return () + sendNotification Exit ExitParams + + 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 + liftIO $ writeChan (messageChan context) msg + + listenServer serverOut - 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 +-- | The current text contents of a document. +documentContents :: TextDocumentIdentifier -> Session T.Text +documentContents doc = do + vfs <- vfs <$> get + let file = vfs Map.! (doc ^. uri) + return $ Rope.toText $ Language.Haskell.LSP.VFS._text file - listenServer context +-- | Parses an ApplyEditRequest, checks that it is for the passed document +-- and returns the new content +documentEdit :: TextDocumentIdentifier -> Session T.Text +documentEdit doc = do + req <- request :: Session ApplyWorkspaceEditRequest + + unless (checkDocumentChanges req || checkChanges req) $ + liftIO $ throw (IncorrectApplyEditRequestException (show req)) + + documentContents doc + where + checkDocumentChanges :: ApplyWorkspaceEditRequest -> Bool + checkDocumentChanges req = + let changes = req ^. params . edit . documentChanges + maybeDocs = fmap (fmap (^. textDocument . uri)) changes + in case maybeDocs of + Just docs -> (doc ^. uri) `elem` docs + Nothing -> False + checkChanges :: ApplyWorkspaceEditRequest -> Bool + checkChanges req = + let mMap = req ^. params . edit . changes + in maybe False (HashMap.member (doc ^. uri)) mMap -- | 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 () + +-- | Open a virtual file if we send a did open text document notification +sendNotification TextDocumentDidOpen params = do + let params' = fromJust $ decode $ encode params + n :: DidOpenTextDocumentNotification + n = NotificationMessage "2.0" TextDocumentDidOpen params' + oldVFS <- vfs <$> get + newVFS <- liftIO $ openVFS oldVFS n + modify (\s -> s { vfs = newVFS }) + sendNotification' n + +-- | Close a virtual file if we send a close text document notification +sendNotification TextDocumentDidClose params = do + let params' = fromJust $ decode $ encode params + n :: DidCloseTextDocumentNotification + n = NotificationMessage "2.0" TextDocumentDidClose params' + oldVFS <- vfs <$> get + newVFS <- liftIO $ closeVFS oldVFS n + modify (\s -> s { vfs = newVFS }) + sendNotification' n + +sendNotification method params = sendNotification' (NotificationMessage "2.0" method params) - let msg = NotificationMessage "2.0" method params +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 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. +initializeResponse :: Session InitializeResponse +initializeResponse = 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 + where -- | 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 +302,20 @@ 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 + +-- | Expects a 'PublishDiagnosticsNotification' and throws an +-- 'UnexpectedDiagnosticsException' if there are any diagnostics +-- returned. +noDiagnostics :: Session () +noDiagnostics = do + diagsNot <- notification :: Session PublishDiagnosticsNotification + when (diagsNot ^. params . diagnostics /= List []) $ liftIO $ throw UnexpectedDiagnosticsException + +-- | Returns the symbols in a document. +documentSymbols :: TextDocumentIdentifier -> Session DocumentSymbolsResponse +documentSymbols doc = do + sendRequest TextDocumentDocumentSymbol (DocumentSymbolParams doc) + response \ No newline at end of file