X-Git-Url: http://git.lukelau.me/?a=blobdiff_plain;f=src%2FLanguage%2FHaskell%2FLSP%2FTest%2FRecorded.hs;h=9c89a78d8d12710de7ded927f8723c7fdccad5e8;hb=1f4a12c49be0cb8640d60c21f6499c5567646fba;hp=10aebe3ac85e71d40587df71094ce85180631658;hpb=9db776483f617de170b6798d5ea8a9f997c0d098;p=lsp-test.git diff --git a/src/Language/Haskell/LSP/Test/Recorded.hs b/src/Language/Haskell/LSP/Test/Recorded.hs index 10aebe3..9c89a78 100644 --- a/src/Language/Haskell/LSP/Test/Recorded.hs +++ b/src/Language/Haskell/LSP/Test/Recorded.hs @@ -1,25 +1,56 @@ {-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE RankNTypes #-} +-- | A testing tool for replaying recorded client logs back to a server, +-- and validating that the server output matches up with another log. module Language.Haskell.LSP.Test.Recorded - ( replay + ( replay, + sendNextRequest ) where import Control.Concurrent -import Control.Monad -import Data.Default -import Language.Haskell.LSP.Control as Control +import Control.Monad.Trans.Class +import Control.Monad.Trans.Reader +import Control.Monad.Trans.State +import Control.Monad.IO.Class import qualified Data.ByteString.Lazy.Char8 as B -import Language.Haskell.LSP.Core +import Language.Haskell.LSP.Capture +import Language.Haskell.LSP.Messages import qualified Language.Haskell.LSP.Types as LSP import Data.Aeson +import Data.Maybe +import Control.Lens +import Control.Monad import System.IO +import System.Directory +import System.FilePath import System.Process +import Language.Haskell.LSP.Test.Files +import Language.Haskell.LSP.Test.Parsing + +data SessionContext = SessionContext + { + reqSema :: MVar LSP.LspId, + rspSema :: MVar LSP.LspIdRsp, + serverIn :: Handle + } +type Session = StateT [FromClientMessage] (ReaderT SessionContext IO) + +-- | Replays a recorded client output and +-- makes sure it matches up with an expected response. +replay :: FilePath -- ^ The recorded session directory. + -> Session a + -> IO () +replay sessionDir session = do + + let sessionFp = sessionDir "session.log" -replay :: FilePath -> IO Int -replay fp = do + -- need to keep hold of current directory since haskell-lsp changes it + prevRootDir <- getCurrentDirectory - (Just serverIn, Just serverOut, _, _) <- createProcess - (proc "hie" ["--lsp", "-l", "/tmp/hie.log", "-d"]) { std_in = CreatePipe + (Just serverIn, Just serverOut, _, serverProc) <- createProcess + (proc "hie" ["--lsp", "-l", "/tmp/hie.log"]) { std_in = CreatePipe , std_out = CreatePipe } @@ -27,102 +58,259 @@ replay fp = do hSetBuffering serverOut NoBuffering -- whether to send the next request - semaphore <- newEmptyMVar + reqSema <- newEmptyMVar :: IO (MVar LSP.LspIdRsp) + -- whether to send the next response + rspSema <- newEmptyMVar :: IO (MVar LSP.LspId) + let semas = (reqSema, rspSema) + + entries <- B.lines <$> B.readFile sessionFp + + -- decode session + let unswappedEvents = map (fromJust . decode) entries + + events <- swapFiles sessionDir unswappedEvents + + let clientEvents = map (\(FromClient _ msg) -> msg) $ filter isClientMsg events + requestMap = getRequestMap clientEvents -- listen to server - forkIO $ forever $ do - headers <- getHeaders serverOut - case read . init <$> lookup "Content-Length" headers of - Nothing -> error "Couldn't read Content-Length header" - Just size -> do - message <- B.hGet serverOut size - case decode message :: Maybe (LSP.ResponseMessage Value) of - Just _ -> putMVar semaphore () - Nothing -> return () -- might be a notification or something, that's ok - - -- the recorded client input to the server - clientRecIn <- openFile fp ReadMode - null <- openFile "/dev/null" WriteMode - - -- send inialize request ourselves since haskell-lsp consumes it - -- rest are handled via `handlers` - sendInitialize clientRecIn serverIn - - Control.runWithHandles clientRecIn - null - (const $ Right (), const $ return Nothing) - (handlers serverIn semaphore) - def - Nothing - Nothing + forkIO $ listenServer serverOut requestMap semas + + runReaderT (runStateT session clientEvents) (SessionContext rspSema reqSema serverIn) + + terminateProcess serverProc + + -- restore directory + setCurrentDirectory prevRootDir + where - sendInitialize recH serverH = do - headers <- getHeaders recH - case read . init <$> lookup "Content-Length" headers of - Nothing -> error "Failed to read the read the initialize request" - Just size -> do - message <- B.hGet recH size - B.hPut serverH (addHeader message) - -- bring the file back to the start for haskell-lsp - hSeek recH AbsoluteSeek 0 - - -handlers :: Handle -> MVar () -> Handlers -handlers serverH flag = def - { - -- Requests - hoverHandler = Just request - , completionHandler = Just request - , completionResolveHandler = Just request - , signatureHelpHandler = Just request - , definitionHandler = Just request - , referencesHandler = Just request - , documentHighlightHandler = Just request - , documentSymbolHandler = Just request - , workspaceSymbolHandler = Just request - , codeActionHandler = Just request - , codeLensHandler = Just request - , codeLensResolveHandler = Just request - , documentFormattingHandler = Just request - , documentRangeFormattingHandler = Just request - , documentTypeFormattingHandler = Just request - , renameHandler = Just request - , documentLinkHandler = Just request - , documentLinkResolveHandler = Just request - , executeCommandHandler = Just request - -- Notifications - , didChangeConfigurationParamsHandler = Just notification - , didOpenTextDocumentNotificationHandler = Just notification - , didChangeTextDocumentNotificationHandler = Just notification - , didCloseTextDocumentNotificationHandler = Just notification - , didSaveTextDocumentNotificationHandler = Just notification - , didChangeWatchedFilesNotificationHandler = Just notification - , initializedHandler = Just notification - , willSaveTextDocumentNotificationHandler = Just notification - , cancelNotificationHandler = Just notification - , responseHandler = Just notification - } + isClientMsg (FromClient _ _) = True + isClientMsg _ = False + + isServerMsg (FromServer _ _) = True + isServerMsg _ = False + +sendNextRequest :: Session () +sendNextRequest = do + (nextMsg:remainingMsgs) <- get + put remainingMsgs + case nextMsg of + ReqInitialize m -> request m + ReqShutdown m -> request m + ReqHover m -> request m + ReqCompletion m -> request m + ReqCompletionItemResolve m -> request m + ReqSignatureHelp m -> request m + ReqDefinition m -> request m + ReqFindReferences m -> request m + ReqDocumentHighlights m -> request m + ReqDocumentSymbols m -> request m + ReqWorkspaceSymbols m -> request m + ReqCodeAction m -> request m + ReqCodeLens m -> request m + ReqCodeLensResolve m -> request m + ReqDocumentFormatting m -> request m + ReqDocumentRangeFormatting m -> request m + ReqDocumentOnTypeFormatting m -> request m + ReqRename m -> request m + ReqExecuteCommand m -> request m + ReqDocumentLink m -> request m + ReqDocumentLinkResolve m -> request m + ReqWillSaveWaitUntil m -> request m + RspApplyWorkspaceEdit m -> response m + RspFromClient m -> response m + NotInitialized m -> notification m + NotExit m -> notification m + NotCancelRequestFromClient m -> notification m + NotDidChangeConfiguration m -> notification m + NotDidOpenTextDocument m -> notification m + NotDidChangeTextDocument m -> notification m + NotDidCloseTextDocument m -> notification m + NotWillSaveTextDocument m -> notification m + NotDidSaveTextDocument m -> notification m + NotDidChangeWatchedFiles m -> notification m + UnknownFromClientMessage m -> + error $ "Unknown message was recorded from the client" ++ show m + where + -- TODO: May need to prevent premature exit notification being sent + notification msg@(LSP.NotificationMessage _ LSP.Exit _) = do + context <- lift ask + + liftIO $ do + putStrLn "Will send exit notification soon" + threadDelay 10000000 + B.hPut (serverIn context) $ addHeader (encode msg) + + notification msg@(LSP.NotificationMessage _ m _) = do + context <- lift ask + + liftIO $ B.hPut (serverIn context) $ addHeader (encode msg) + + liftIO $ putStrLn $ "Sent a notification " ++ show m + + sendNextRequest + + request msg@(LSP.RequestMessage _ id m _) = do + context <- lift ask + + liftIO $ do + when (m == LSP.TextDocumentDocumentSymbol) $ threadDelay 5000000 + + B.hPut (serverIn context) $ addHeader (encode msg) + putStrLn $ "Sent a request id " ++ show id ++ ": " ++ show m ++ "\nWaiting for a response" + + rspId <- takeMVar (rspSema context) + when (LSP.responseId id /= rspId) $ + error $ "Expected id " ++ show id ++ ", got " ++ show rspId + + response msg@(LSP.ResponseMessage _ id _ _) = do + context <- lift ask + + liftIO $ do + putStrLn $ "Waiting for request id " ++ show id ++ " from the server" + reqId <- takeMVar (reqSema context) + if LSP.responseId reqId /= id + then error $ "Expected id " ++ show reqId ++ ", got " ++ show reqId + else do + B.hPut (serverIn context) $ addHeader (encode msg) + putStrLn $ "Sent response to request id " ++ show id + + sendNextRequest + + +-- | Listens to the server output, makes sure it matches the record and +-- signals any semaphores +listenServer :: Handle -> RequestMap -> (MVar LSP.LspIdRsp, MVar LSP.LspId) -> IO () +listenServer h reqMap semas@(reqSema, rspSema) = do + msgBytes <- getNextMessage h + + let msg = decodeFromServerMsg reqMap msgBytes + + print msg + + case msg of + ReqRegisterCapability m -> request m + ReqApplyWorkspaceEdit m -> request m + ReqShowMessage m -> request m + ReqUnregisterCapability m -> request m + RspInitialize m -> response m + RspShutdown m -> response m + RspHover m -> response m + RspCompletion m -> response m + RspCompletionItemResolve m -> response m + RspSignatureHelp m -> response m + RspDefinition m -> response m + RspFindReferences m -> response m + RspDocumentHighlights m -> response m + RspDocumentSymbols m -> response m + RspWorkspaceSymbols m -> response m + RspCodeAction m -> response m + RspCodeLens m -> response m + RspCodeLensResolve m -> response m + RspDocumentFormatting m -> response m + RspDocumentRangeFormatting m -> response m + RspDocumentOnTypeFormatting m -> response m + RspRename m -> response m + RspExecuteCommand m -> response m + RspError m -> response m + RspDocumentLink m -> response m + RspDocumentLinkResolve m -> response m + RspWillSaveWaitUntil m -> response m + NotPublishDiagnostics m -> notification m + NotLogMessage m -> notification m + NotShowMessage m -> notification m + NotTelemetry m -> notification m + NotCancelRequestFromServer m -> notification m + + listenServer h reqMap semas + where - notification m = do - B.hPut serverH $ addHeader (encode m) - putStrLn "sent a notification" - request m = do - B.hPut serverH $ addHeader (encode m) - putStrLn "sent a request, waiting for a response" - takeMVar flag - putStrLn "got a response" - -addHeader :: B.ByteString -> B.ByteString -addHeader content = B.concat - [ "Content-Length: " - , B.pack $ show $ B.length content - , "\r\n" - , "\r\n" - , content - ] - -getHeaders :: Handle -> IO [(String, String)] -getHeaders h = do - l <- hGetLine h - let (name, val) = span (/= ':') l - if null val then return [] else ((name, drop 2 val) :) <$> getHeaders h + response :: Show a => LSP.ResponseMessage a -> IO () + response res = do + putStrLn $ "Got response for id " ++ show (res ^. LSP.id) + + print res + + putMVar reqSema (res ^. LSP.id) -- unblock the handler waiting to send a request + + request :: Show a => LSP.RequestMessage LSP.ServerMethod a b -> IO () + request req = do + putStrLn + $ "Got request for id " + ++ show (req ^. LSP.id) + ++ " " + ++ show (req ^. LSP.method) + + print req + + putMVar rspSema (req ^. LSP.id) -- unblock the handler waiting for a response + + notification :: Show a => LSP.NotificationMessage LSP.ServerMethod a -> IO () + notification n = do + putStrLn $ "Got notification " ++ show (n ^. LSP.method) + print n + + -- lift + -- $ putStrLn + -- $ show (length (filter isNotification expectedMsgs) - 1) + -- ++ " notifications remaining" + + -- checkOrder msg = unless (inRightOrder msg expectedMsgs) $ failSession + -- ( "Out of order\nExpected\n" + -- ++ show firstExpected + -- ++ "\nGot\n" + -- ++ show msg + -- ++ "\n" + -- ) + + -- markReceived :: FromServerMessage -> Session [FromServerMessage] + -- markReceived msg = + -- let new = delete msg expectedMsgs + -- in if new == expectedMsgs + -- then failSession ("Unexpected message: " ++ show msg) >> return new + -- else return new + + -- firstExpected = head $ filter (not . isNotification) expectedMsgs + +isNotification :: FromServerMessage -> Bool +isNotification (NotPublishDiagnostics _) = True +isNotification (NotLogMessage _) = True +isNotification (NotShowMessage _) = True +isNotification (NotCancelRequestFromServer _) = True +isNotification _ = False + +-- TODO: QuickCheck tests? +-- | Checks wether or not the message appears in the right order +-- @ N1 N2 N3 REQ1 N4 N5 REQ2 RES1 @ +-- given N2, notification order doesn't matter. +-- @ N1 N3 REQ1 N4 N5 REQ2 RES1 @ +-- given REQ1 +-- @ N1 N3 N4 N5 REQ2 RES1 @ +-- given RES1 +-- @ N1 N3 N4 N5 XXXX RES1 @ False! +-- Order of requests and responses matter +inRightOrder :: FromServerMessage -> [FromServerMessage] -> Bool + +inRightOrder _ [] = error "Why is this empty" +-- inRightOrder (LSP.NotificationMessage _ _ _) _ = True + +inRightOrder received (expected : msgs) + | received == expected = True + | isNotification expected = inRightOrder received msgs + | otherwise = False + +-- | The internal monad for tests that can fail or pass, +-- ending execution early. +-- type Session = ReaderT (MVar Bool) IO + +-- -- TODO: Make return type polymoprhic more like error +-- failSession :: String -> Session () +-- failSession reason = do +-- lift $ putStrLn reason +-- passVar <- ask +-- lift $ putMVar passVar False + +-- passSession :: Session () +-- passSession = do +-- passVar <- ask +-- lift $ putMVar passVar True \ No newline at end of file