X-Git-Url: http://git.lukelau.me/?a=blobdiff_plain;f=src%2FLanguage%2FHaskell%2FLSP%2FTest%2FRecorded.hs;h=36a55fafd5adf579365b2c612b40ae1010e0dfd5;hb=refs%2Fheads%2FfileSwap;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..36a55fa 100644 --- a/src/Language/Haskell/LSP/Test/Recorded.hs +++ b/src/Language/Haskell/LSP/Test/Recorded.hs @@ -1,5 +1,6 @@ {-# 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 @@ -10,10 +11,10 @@ where import Control.Concurrent import Control.Monad.Trans.Class import Control.Monad.Trans.Reader -import Data.Default -import Language.Haskell.LSP.Control as Control import qualified Data.ByteString.Lazy.Char8 as B -import Language.Haskell.LSP.Core +import Data.List +import Language.Haskell.LSP.Capture +import Language.Haskell.LSP.Messages import qualified Language.Haskell.LSP.Types as LSP import Data.Aeson import Data.Maybe @@ -28,17 +29,18 @@ 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 recorded session file. -> FilePath -- ^ The root directory of the project -> IO Bool -replay cfp sfp curRootDir = do +replay sessionFp 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 } + (proc "hie" ["--lsp", "-l", "/tmp/hie.log"]) { std_in = CreatePipe + , std_out = CreatePipe + } hSetBuffering serverIn NoBuffering hSetBuffering serverOut NoBuffering @@ -51,40 +53,24 @@ replay cfp sfp curRootDir = do didPass <- newEmptyMVar - -- the recorded client input to the server - clientRecIn <- openFile cfp ReadMode - serverRecIn <- openFile sfp ReadMode - null <- openFile "/dev/null" WriteMode - - - unswappedClientMsgs <- getAllMessages clientRecIn + entries <- B.lines <$> B.readFile sessionFp - let recRootDir = rootDir unswappedClientMsgs + -- decode session + let unswappedEvents = map (fromJust . decode) entries - (clientMsgs, fileMap) <- swapFiles emptyFileMap recRootDir curRootDir unswappedClientMsgs + events <- swapFiles curRootDir unswappedEvents - tmpDir <- getTemporaryDirectory - (mappedClientRecFp, mappedClientRecIn) <- openTempFile tmpDir "clientRecInMapped" - mapM_ (B.hPut mappedClientRecIn . addHeader) clientMsgs - hSeek mappedClientRecIn AbsoluteSeek 0 - - (expectedMsgs, _) <- swapFiles fileMap recRootDir curRootDir =<< getAllMessages serverRecIn + let clientEvents = + map (\(FromClient _ msg) -> msg) $ filter isClientMsg events + serverEvents = + map (\(FromServer _ msg) -> msg) $ filter isServerMsg events + requestMap = getRequestMap clientEvents -- listen to server - forkIO $ runReaderT (listenServer expectedMsgs serverOut semas) didPass - - -- start client replay - forkIO $ do - Control.runWithHandles mappedClientRecIn - null - (const $ Right (), const $ return Nothing) - (handlers serverIn semas) - def - Nothing - Nothing + forkIO $ runReaderT (listenServer serverEvents serverOut requestMap semas) + didPass - -- todo: we shouldn't do this, we should check all notifications were delivered first - putMVar didPass True + forM_ clientEvents (processClient serverIn rspSema reqSema) result <- takeMVar didPass terminateProcess serverProc @@ -92,16 +78,98 @@ replay cfp sfp curRootDir = do -- restore directory setCurrentDirectory prevDir - -- cleanup temp files - removeFile mappedClientRecFp - cleanupFiles - return result + where + isClientMsg (FromClient _ _) = True + isClientMsg _ = False + + isServerMsg (FromServer _ _) = True + isServerMsg _ = False + +processClient + :: Handle -> MVar LSP.LspId -> MVar LSP.LspIdRsp -> FromClientMessage -> IO () +processClient serverH rspSema reqSema msg = case msg 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 + 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 -- | 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 @@ -115,80 +183,134 @@ passSession = do -- | 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 - - 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 - - listenServer newExpectedMsgs h semas - - - where response :: LSP.ResponseMessage Value -> Session [B.ByteString] - response res = do +listenServer + :: [FromServerMessage] + -> Handle + -> RequestMap + -> (MVar LSP.LspIdRsp, MVar LSP.LspId) + -> Session () +listenServer [] _ _ _ = passSession +listenServer expectedMsgs h reqMap semas@(reqSema, rspSema) = do + msgBytes <- lift $ getNextMessage h + + let actualMsg = decodeFromServerMsg reqMap msgBytes + + lift $ print actualMsg + + newExpectedMsgs <- case actualMsg of + ReqRegisterCapability m -> request actualMsg m + ReqApplyWorkspaceEdit m -> request actualMsg m + ReqShowMessage m -> request actualMsg m + ReqUnregisterCapability m -> request actualMsg m + RspInitialize m -> response actualMsg m + RspShutdown m -> response actualMsg m + RspHover m -> response actualMsg m + RspCompletion m -> response actualMsg m + RspCompletionItemResolve m -> response actualMsg m + RspSignatureHelp m -> response actualMsg m + RspDefinition m -> response actualMsg m + RspFindReferences m -> response actualMsg m + RspDocumentHighlights m -> response actualMsg m + RspDocumentSymbols m -> response actualMsg m + RspWorkspaceSymbols m -> response actualMsg m + RspCodeAction m -> response actualMsg m + RspCodeLens m -> response actualMsg m + RspCodeLensResolve m -> response actualMsg m + RspDocumentFormatting m -> response actualMsg m + RspDocumentRangeFormatting m -> response actualMsg m + RspDocumentOnTypeFormatting m -> response actualMsg m + RspRename m -> response actualMsg m + RspExecuteCommand m -> response actualMsg m + RspError m -> response actualMsg m + RspDocumentLink m -> response actualMsg m + RspDocumentLinkResolve m -> response actualMsg m + RspWillSaveWaitUntil m -> response actualMsg m + NotPublishDiagnostics m -> notification actualMsg m + NotLogMessage m -> notification actualMsg m + NotShowMessage m -> notification actualMsg m + NotTelemetry m -> notification actualMsg m + NotCancelRequestFromServer m -> notification actualMsg m + + listenServer newExpectedMsgs h reqMap semas + where + response + :: Show a + => FromServerMessage + -> LSP.ResponseMessage a + -> Session [FromServerMessage] + response msg res = do lift $ putStrLn $ "Got response for id " ++ show (res ^. LSP.id) lift $ print res - checkOrder res + checkOrder msg lift $ putMVar reqSema (res ^. LSP.id) -- unblock the handler waiting to send a request - markReceived res - - request :: LSP.RequestMessage LSP.ServerMethod Value Value -> Session [B.ByteString] - request req = do - lift $ putStrLn $ "Got request for id " ++ show (req ^. LSP.id) ++ " " ++ show (req ^. LSP.method) + markReceived msg + + request + :: (Show a, Show b) + => FromServerMessage + -> LSP.RequestMessage LSP.ServerMethod a b + -> Session [FromServerMessage] + request msg req = do + lift + $ putStrLn + $ "Got request for id " + ++ show (req ^. LSP.id) + ++ " " + ++ show (req ^. LSP.method) lift $ print req - checkOrder req + checkOrder msg lift $ putMVar rspSema (req ^. LSP.id) -- unblock the handler waiting for a response - markReceived req + markReceived msg - notification :: LSP.NotificationMessage LSP.ServerMethod Value -> Session [B.ByteString] - notification n = do + notification + :: Show a + => FromServerMessage + -> LSP.NotificationMessage LSP.ServerMethod a + -> Session [FromServerMessage] + notification msg n = do lift $ putStrLn $ "Got notification " ++ show (n ^. LSP.method) lift $ print n - lift $ putStrLn $ (show ((length $ filter isNotification expectedMsgs) - 1)) ++ " notifications remaining" + 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") + else markReceived msg + + checkOrder msg = unless (inRightOrder msg expectedMsgs) $ failSession + ( "Out of order\nExpected\n" + ++ show firstExpected + ++ "\nGot\n" + ++ show msg + ++ "\n" + ) - markReceived msg = do - let new = deleteFirstJson msg expectedMsgs - in if (new == expectedMsgs) + 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 - deleteFirstJson _ [] = [] - deleteFirstJson msg (x:xs) - | (Just msg) == (decode x) = xs - | otherwise = x:deleteFirstJson msg xs - firstExpected = head $ filter (not . isNotification) expectedMsgs - - -isNotification :: B.ByteString -> Bool -isNotification msg = - isJust (decode msg :: Maybe (LSP.NotificationMessage Value Value)) +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 @@ -200,87 +322,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 - - -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