X-Git-Url: http://git.lukelau.me/?a=blobdiff_plain;f=src%2FLanguage%2FHaskell%2FLSP%2FTest%2FRecorded.hs;h=504f3ff1f74fb68fd810d88fff1061c80abc7353;hb=0c8e8f8436125b79e91a51267ca581d2e352e702;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..504f3ff 100644 --- a/src/Language/Haskell/LSP/Test/Recorded.hs +++ b/src/Language/Haskell/LSP/Test/Recorded.hs @@ -1,86 +1,217 @@ {-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE FlexibleContexts #-} +-- | 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 ) where import Control.Concurrent -import Control.Monad +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 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.Process +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. +replay + :: FilePath -- ^ The client output to replay to the server. -> FilePath -- ^ The expected response from the server. - -> IO Int -replay cfp sfp = do + -> FilePath -- ^ The root directory of the project + -> IO Bool +replay cfp sfp curRootDir = do - (Just serverIn, Just serverOut, _, _) <- createProcess - (proc "hie" ["--lsp", "-l", "/tmp/hie.log", "-d"]) { std_in = CreatePipe - , std_out = CreatePipe - } + -- 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 - semaphore <- newEmptyMVar + 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 + + unswappedClientMsgs <- getAllMessages clientRecIn + + let recRootDir = rootDir unswappedClientMsgs + + (clientMsgs, fileMap) <- swapFiles emptyFileMap recRootDir curRootDir unswappedClientMsgs + + tmpDir <- getTemporaryDirectory + (mappedClientRecFp, mappedClientRecIn) <- openTempFile tmpDir "clientRecInMapped" + mapM_ (B.hPut mappedClientRecIn . addHeader) clientMsgs + hSeek mappedClientRecIn AbsoluteSeek 0 + + (expectedMsgs, _) <- swapFiles fileMap recRootDir curRootDir =<< getAllMessages serverRecIn + -- 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 + forkIO $ runReaderT (listenServer expectedMsgs serverOut semas) didPass + + -- start client replay + forkIO $ do + Control.runWithHandles mappedClientRecIn null (const $ Right (), const $ return Nothing) - (handlers serverIn semaphore) + (handlers serverIn semas) def Nothing Nothing - 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 + + -- todo: we shouldn't do this, we should check all notifications were delivered first + putMVar didPass True + + result <- takeMVar didPass + terminateProcess serverProc + + -- restore directory + setCurrentDirectory prevDir + + -- cleanup temp files + removeFile mappedClientRecFp + + return result + +-- | The internal monad for tests that can fail or pass, +-- ending execution early. +type Session = ReaderT (MVar Bool) IO + +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 + +-- | 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 + lift $ putStrLn $ "Got response for id " ++ show (res ^. LSP.id) + + lift $ print res + + checkOrder res + + 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) + + lift $ print req + + checkOrder req + + lift $ putMVar rspSema (req ^. LSP.id) -- unblock the handler waiting for a response + + markReceived req + + notification :: LSP.NotificationMessage LSP.ServerMethod Value -> Session [B.ByteString] + 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 = + 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 + + firstExpected = head $ filter (not . isNotification) expectedMsgs + + + +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 @ +-- 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 :: (FromJSON a, Eq a) => a -> [B.ByteString] -> Bool + +inRightOrder _ [] = error "Why is this empty" +-- inRightOrder (LSP.NotificationMessage _ _ _) _ = True + +inRightOrder received (expected:msgs) + | Just received == decode 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 @@ -102,6 +233,7 @@ handlers serverH flag = def , documentLinkHandler = Just request , documentLinkResolveHandler = Just request , executeCommandHandler = Just request + , initializeRequestHandler = Just request -- Notifications , didChangeConfigurationParamsHandler = Just notification , didOpenTextDocumentNotificationHandler = Just notification @@ -112,29 +244,42 @@ handlers serverH flag = def , initializedHandler = Just notification , willSaveTextDocumentNotificationHandler = Just notification , cancelNotificationHandler = Just notification - , responseHandler = Just notification + , exitNotificationHandler = Just notification + -- Responses + , responseHandler = Just response } 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@(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