X-Git-Url: http://git.lukelau.me/?a=blobdiff_plain;f=src%2FLanguage%2FHaskell%2FLSP%2FTest%2FRecorded.hs;h=c028478dc1e7411c3cea400d57d9dbee8e5e452e;hb=13928a9c66b4a352ae784660877d4fae57ac81d9;hp=a52c313c4bd6565073f1f2732faf6af2406cb2dc;hpb=37aa4a22ec691b45bbd1cd0dd23d70e90a0c4e40;p=lsp-test.git diff --git a/src/Language/Haskell/LSP/Test/Recorded.hs b/src/Language/Haskell/LSP/Test/Recorded.hs index a52c313..c028478 100644 --- a/src/Language/Haskell/LSP/Test/Recorded.hs +++ b/src/Language/Haskell/LSP/Test/Recorded.hs @@ -1,195 +1,237 @@ {-# 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.Trans.Class -import Control.Monad.Trans.Reader -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.Directory -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. - -> FilePath -- ^ The root directory of the project +replaySession :: FilePath -- ^ The recorded session directory. -> IO Bool -replay cfp sfp curRootDir = do - - -- need to keep hold of current directory since haskell-lsp changes it - prevDir <- getCurrentDirectory - - (Just serverIn, Just serverOut, _, serverProc) <- createProcess - (proc "hie" ["--lsp", "-l", "/tmp/hie.log"]) { std_in = CreatePipe , std_out = CreatePipe } - - hSetBuffering serverIn NoBuffering - hSetBuffering serverOut NoBuffering - - -- whether to send the next request - reqSema <- newEmptyMVar :: IO (MVar LSP.LspIdRsp) - -- whether to send the next response - rspSema <- newEmptyMVar :: IO (MVar LSP.LspId) - let semas = (reqSema, rspSema) - - didPass <- newEmptyMVar - - -- the recorded client input to the server - clientRecIn <- openFile cfp ReadMode - serverRecIn <- openFile sfp ReadMode - null <- openFile "/dev/null" WriteMode - +replaySession sessionDir = do - unswappedClientMsgs <- getAllMessages clientRecIn + entries <- B.lines <$> B.readFile (sessionDir "session.log") - let recRootDir = rootDir unswappedClientMsgs + -- decode session + let unswappedEvents = map (fromJust . decode) entries - (clientMsgs, fileMap) <- swapFiles emptyFileMap recRootDir curRootDir unswappedClientMsgs + events <- swapFiles sessionDir unswappedEvents - tmpDir <- getTemporaryDirectory - (mappedClientRecFp, mappedClientRecIn) <- openTempFile tmpDir "clientRecInMapped" - mapM_ (B.hPut mappedClientRecIn . addHeader) clientMsgs - hSeek mappedClientRecIn AbsoluteSeek 0 + let clientEvents = map (\(FromClient _ msg) -> msg) $ filter isClientMsg events + serverEvents = map (\(FromServer _ msg) -> msg) $ filter isServerMsg events + requestMap = getRequestMap clientEvents - (expectedMsgs, _) <- swapFiles fileMap recRootDir curRootDir =<< getAllMessages serverRecIn - -- listen to server - forkIO $ runReaderT (listenServer expectedMsgs serverOut semas) didPass + reqSema <- newEmptyMVar + rspSema <- newEmptyMVar + passVar <- newEmptyMVar :: IO (MVar Bool) - -- start client replay - forkIO $ do - Control.runWithHandles mappedClientRecIn - null - (const $ Right (), const $ return Nothing) - (handlers serverIn semas) - def - Nothing - Nothing + forkIO $ runSessionWithHandler (listenServer serverEvents requestMap reqSema rspSema passVar) sessionDir $ + sendMessages clientEvents reqSema rspSema - -- todo: we shouldn't do this, we should check all notifications were delivered first - putMVar didPass True + takeMVar passVar - result <- takeMVar didPass - terminateProcess serverProc - - -- restore directory - setCurrentDirectory prevDir + where + 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 + -- 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 - -- cleanup temp files - removeFile mappedClientRecFp - cleanupFiles + liftIO $ error "Done" - return result + notification msg@(NotificationMessage _ m _) = do + sendNotification' msg --- | The internal monad for tests that can fail or pass, --- ending execution early. -type Session = ReaderT (MVar Bool) IO + liftIO $ putStrLn $ "Sent a notification " ++ show m -failSession :: String -> Session () -failSession reason = do - lift $ putStrLn reason - passVar <- ask - lift $ putMVar passVar False + sendMessages remainingMsgs reqSema rspSema -passSession :: Session () -passSession = do - passVar <- ask - lift $ putMVar passVar True + request msg@(RequestMessage _ id m _) = do + liftIO $ print $ addHeader $ encode msg --- | Listens to the server output, makes sure it matches the record and --- signals any semaphores -listenServer :: [B.ByteString] -> Handle -> (MVar LSP.LspIdRsp, MVar LSP.LspId) -> Session () -listenServer [] _ _ = passSession -listenServer expectedMsgs h semas@(reqSema, rspSema) = do - msg <- lift $ getNextMessage h + sendRequest' msg + liftIO $ putStrLn $ "Sent a request id " ++ show id ++ ": " ++ show m ++ "\nWaiting for a response" - newExpectedMsgs <- case decode msg of - Just m -> request m - Nothing -> case decode msg of - Just m -> notification m - Nothing -> case decode msg of - Just m -> response m - Nothing -> failSession "Malformed message" >> return expectedMsgs + rsp <- liftIO $ takeMVar rspSema + when (responseId id /= rsp) $ + error $ "Expected id " ++ show id ++ ", got " ++ show rsp - listenServer newExpectedMsgs h semas + 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 :: LSP.ResponseMessage Value -> Session [B.ByteString] + where + response :: Show a => ResponseMessage a -> Session () response res = do - lift $ putStrLn $ "Got response for id " ++ show (res ^. LSP.id) - - lift $ print res + liftIO $ putStrLn $ "Got response for id " ++ show (res ^. id) - checkOrder res + liftIO $ print res - lift $ putMVar reqSema (res ^. LSP.id) -- unblock the handler waiting to send a request + liftIO $ putMVar rspSema (res ^. id) -- unblock the handler waiting to send a request - markReceived res - - request :: LSP.RequestMessage LSP.ServerMethod Value Value -> Session [B.ByteString] + request :: (Show a, Show b) => RequestMessage ServerMethod a b -> Session () request req = do - lift $ putStrLn $ "Got request for id " ++ show (req ^. LSP.id) ++ " " ++ show (req ^. LSP.method) - - lift $ print req + liftIO + $ putStrLn + $ "Got request for id " + ++ show (req ^. id) + ++ " " + ++ show (req ^. method) - checkOrder req + liftIO $ print req - lift $ putMVar rspSema (req ^. LSP.id) -- unblock the handler waiting for a response + liftIO $ putMVar reqSema (req ^. id) -- unblock the handler waiting for a response - markReceived req - - notification :: LSP.NotificationMessage LSP.ServerMethod Value -> Session [B.ByteString] + notification :: Show a => NotificationMessage ServerMethod a -> Session () notification n = do - lift $ putStrLn $ "Got notification " ++ show (n ^. LSP.method) - lift $ print n - - lift $ putStrLn $ (show ((length $ filter isNotification expectedMsgs) - 1)) ++ " notifications remaining" - - if n ^. LSP.method == LSP.WindowLogMessage - then return expectedMsgs - else markReceived n - - checkOrder msg = unless (inRightOrder msg expectedMsgs) $ do - let (Just expected) = decode firstExpected - _ = expected == msg -- make expected type same as res - failSession ("Out of order\nExpected\n" ++ show expected ++ "\nGot\n" ++ show msg ++ "\n") - - markReceived msg = do - let new = deleteFirstJson msg expectedMsgs - in if (new == expectedMsgs) - then failSession ("Unexpected message: " ++ show msg) >> return new - else return new - - deleteFirstJson _ [] = [] - deleteFirstJson msg (x:xs) - | (Just msg) == (decode x) = xs - | otherwise = x:deleteFirstJson msg xs + liftIO $ putStrLn $ "Got notification " ++ show (n ^. method) + liftIO $ print n - firstExpected = head $ filter (not . isNotification) expectedMsgs + liftIO + $ putStrLn + $ show (length (filter isNotification expectedMsgs) - 1) + ++ " notifications remaining" -isNotification :: B.ByteString -> Bool -isNotification msg = - isJust (decode msg :: Maybe (LSP.NotificationMessage Value Value)) - -- TODO: QuickCheck tests? -- | Checks wether or not the message appears in the right order -- @ N1 N2 N3 REQ1 N4 N5 REQ2 RES1 @ @@ -200,87 +242,12 @@ isNotification msg = -- given RES1 -- @ N1 N3 N4 N5 XXXX RES1 @ False! -- Order of requests and responses matter -inRightOrder :: (FromJSON a, Eq a) => a -> [B.ByteString] -> Bool +inRightOrder :: FromServerMessage -> [FromServerMessage] -> Bool inRightOrder _ [] = error "Why is this empty" -- inRightOrder (LSP.NotificationMessage _ _ _) _ = True inRightOrder received (expected : msgs) - | Just received == decode expected = True + | received == expected = True | isNotification expected = inRightOrder received msgs | otherwise = False \ No newline at end of file - - -handlers :: Handle -> (MVar LSP.LspIdRsp, MVar LSP.LspId) -> Handlers -handlers serverH (reqSema, rspSema) = 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 - , initializeRequestHandler = 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 - , exitNotificationHandler = Just notification - -- Responses - , responseHandler = Just response - } - where - - -- TODO: May need to prevent premature exit notification being sent - notification msg@(LSP.NotificationMessage _ LSP.Exit _) = do - putStrLn "Will send exit notification soon" - threadDelay 10000000 - B.hPut serverH $ addHeader (encode msg) - notification msg@(LSP.NotificationMessage _ m _) = do - B.hPut serverH $ addHeader (encode msg) - - putStrLn $ "Sent a notification " ++ show m - - request msg@(LSP.RequestMessage _ id m _) = do - - when (m == LSP.TextDocumentDocumentSymbol) $ threadDelay 5000000 - - B.hPut serverH $ addHeader (encode msg) - putStrLn $ "Sent a request id " ++ show id ++ ": " ++ show m ++ "\nWaiting for a response" - - rspId <- takeMVar reqSema - when (LSP.responseId id /= rspId) - $ error - $ "Expected id " - ++ show id - ++ ", got " - ++ show rspId - - response msg@(LSP.ResponseMessage _ id _ _) = do - putStrLn $ "Waiting for request id " ++ show id ++ " from the server" - reqId <- takeMVar rspSema - if LSP.responseId reqId /= id - then error $ "Expected id " ++ show reqId ++ ", got " ++ show reqId - else do - B.hPut serverH $ addHeader (encode msg) - putStrLn $ "Sent response to request id " ++ show id