X-Git-Url: http://git.lukelau.me/?a=blobdiff_plain;f=src%2FLanguage%2FHaskell%2FLSP%2FTest%2FRecorded.hs;h=c028478dc1e7411c3cea400d57d9dbee8e5e452e;hb=13928a9c66b4a352ae784660877d4fae57ac81d9;hp=6bf23198ead14d93b718f61f326107dffa81cc9b;hpb=311e9ea018ce1721cd79341243b79afdda85e2f1;p=lsp-test.git diff --git a/src/Language/Haskell/LSP/Test/Recorded.hs b/src/Language/Haskell/LSP/Test/Recorded.hs index 6bf2319..c028478 100644 --- a/src/Language/Haskell/LSP/Test/Recorded.hs +++ b/src/Language/Haskell/LSP/Test/Recorded.hs @@ -1,140 +1,253 @@ {-# 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 + ( replaySession ) where +import Prelude hiding (id) import Control.Concurrent -import Control.Monad -import Data.Default -import Language.Haskell.LSP.Control as Control +import Control.Monad.IO.Class import qualified Data.ByteString.Lazy.Char8 as B -import Language.Haskell.LSP.Core -import qualified Language.Haskell.LSP.Types as LSP +import Language.Haskell.LSP.Capture +import Language.Haskell.LSP.Messages +import Language.Haskell.LSP.Types hiding (error) import Data.Aeson +import Data.List +import Data.Maybe +import Control.Lens +import Control.Monad import System.IO -import System.Process +import System.FilePath +import Language.Haskell.LSP.Test +import Language.Haskell.LSP.Test.Files +import Language.Haskell.LSP.Test.Parsing + -- | Replays a recorded client output and -- makes sure it matches up with an expected response. -replay :: FilePath -- ^ The client output to replay to the server. - -> FilePath -- ^ The expected response from the server. - -> IO Int -replay cfp sfp = do - - (Just serverIn, Just serverOut, _, _) <- createProcess - (proc "hie" ["--lsp", "-l", "/tmp/hie.log", "-d"]) { std_in = CreatePipe - , std_out = CreatePipe - } - - hSetBuffering serverIn NoBuffering - hSetBuffering serverOut NoBuffering - - -- whether to send the next request - semaphore <- newEmptyMVar - - -- the recorded client input to the server - clientRecIn <- openFile cfp ReadMode - serverRecIn <- openFile sfp ReadMode - null <- openFile "/dev/null" WriteMode - - -- listen to server - forkIO $ forever $ do - msg <- getNextMessage serverOut - expectedMsg <- getNextMessage serverRecIn - putStrLn $ "received: " ++ (show msg) - putStrLn $ "next expected: " ++ (show expectedMsg) - case decode msg :: Maybe (LSP.RequestMessage Value Value Value) of - Just _ -> putStrLn "ignoring request" >> return () - Nothing -> when (msg /= expectedMsg) $ error ("Expected " ++ show expectedMsg ++ " but got " ++ show msg) - case decode msg :: Maybe (LSP.ResponseMessage Value) of - Just _ -> putMVar semaphore () - Nothing -> return () -- might be a notification or something, that's ok - - -- 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 +replaySession :: FilePath -- ^ The recorded session directory. + -> IO Bool +replaySession sessionDir = do + + entries <- B.lines <$> B.readFile (sessionDir "session.log") + + -- decode session + let unswappedEvents = map (fromJust . decode) entries + + events <- swapFiles sessionDir unswappedEvents + + let clientEvents = map (\(FromClient _ msg) -> msg) $ filter isClientMsg events + serverEvents = map (\(FromServer _ msg) -> msg) $ filter isServerMsg events + requestMap = getRequestMap clientEvents + + + reqSema <- newEmptyMVar + rspSema <- newEmptyMVar + passVar <- newEmptyMVar :: IO (MVar Bool) + + forkIO $ runSessionWithHandler (listenServer serverEvents requestMap reqSema rspSema passVar) sessionDir $ + sendMessages clientEvents reqSema rspSema + + takeMVar passVar + where - sendInitialize recH serverH = do - message <- getNextMessage recH - B.hPut serverH (addHeader message) - -- bring the file back to the start for haskell-lsp - hSeek recH AbsoluteSeek 0 - --- | Fetches the next message bytes based on --- the Content-Length header -getNextMessage :: Handle -> IO B.ByteString -getNextMessage h = do - headers <- getHeaders h - case read . init <$> lookup "Content-Length" headers of - Nothing -> error "Couldn't read Content-Length header" - Just size -> B.hGet h size - - -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 + +sendMessages :: [FromClientMessage] -> MVar LspId -> MVar LspIdRsp -> Session () +sendMessages [] _ _ = return () +sendMessages (nextMsg:remainingMsgs) reqSema rspSema = + 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 -> liftIO $ error $ "Unknown message was recorded from the client" ++ show m 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 + -- TODO: May need to prevent premature exit notification being sent + notification msg@(NotificationMessage _ Exit _) = do + liftIO $ putStrLn "Will send exit notification soon" + liftIO $ threadDelay 10000000 + sendNotification' msg + + liftIO $ error "Done" + + notification msg@(NotificationMessage _ m _) = do + sendNotification' msg + + liftIO $ putStrLn $ "Sent a notification " ++ show m + + sendMessages remainingMsgs reqSema rspSema + + request msg@(RequestMessage _ id m _) = do + liftIO $ print $ addHeader $ encode msg + + sendRequest' msg + liftIO $ putStrLn $ "Sent a request id " ++ show id ++ ": " ++ show m ++ "\nWaiting for a response" + + rsp <- liftIO $ takeMVar rspSema + when (responseId id /= rsp) $ + error $ "Expected id " ++ show id ++ ", got " ++ show rsp + + sendMessages remainingMsgs reqSema rspSema + + response msg@(ResponseMessage _ id _ _) = do + liftIO $ putStrLn $ "Waiting for request id " ++ show id ++ " from the server" + reqId <- liftIO $ takeMVar reqSema + if responseId reqId /= id + then error $ "Expected id " ++ show reqId ++ ", got " ++ show reqId + else do + sendResponse' msg + liftIO $ putStrLn $ "Sent response to request id " ++ show id + + sendMessages remainingMsgs reqSema rspSema + + +isNotification :: FromServerMessage -> Bool +isNotification (NotPublishDiagnostics _) = True +isNotification (NotLogMessage _) = True +isNotification (NotShowMessage _) = True +isNotification (NotCancelRequestFromServer _) = True +isNotification _ = False + +listenServer :: [FromServerMessage] -> RequestMap -> MVar LspId -> MVar LspIdRsp -> MVar Bool -> Handle -> Session () +listenServer [] _ _ _ passVar _ = liftIO $ putMVar passVar True +listenServer expectedMsgs reqMap reqSema rspSema passVar serverOut = do + msgBytes <- liftIO $ getNextMessage serverOut + let msg = decodeFromServerMsg reqMap msgBytes + + 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 + + if inRightOrder msg expectedMsgs + then listenServer (delete msg expectedMsgs) reqMap reqSema rspSema passVar serverOut + else liftIO $ do + putStrLn "Out of order" + putStrLn "Got:" + print msg + putStrLn "Expected one of:" + mapM_ print $ takeWhile (not . isNotification) expectedMsgs + print $ head $ dropWhile (not . isNotification) expectedMsgs + putMVar passVar False + + where + response :: Show a => ResponseMessage a -> Session () + response res = do + liftIO $ putStrLn $ "Got response for id " ++ show (res ^. id) + + liftIO $ print res + + liftIO $ putMVar rspSema (res ^. id) -- unblock the handler waiting to send a request + + request :: (Show a, Show b) => RequestMessage ServerMethod a b -> Session () + request req = do + liftIO + $ putStrLn + $ "Got request for id " + ++ show (req ^. id) + ++ " " + ++ show (req ^. method) + + liftIO $ print req + + liftIO $ putMVar reqSema (req ^. id) -- unblock the handler waiting for a response + + notification :: Show a => NotificationMessage ServerMethod a -> Session () + notification n = do + liftIO $ putStrLn $ "Got notification " ++ show (n ^. method) + liftIO $ print n + + liftIO + $ putStrLn + $ show (length (filter isNotification expectedMsgs) - 1) + ++ " notifications remaining" + + + +-- 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 \ No newline at end of file