X-Git-Url: http://git.lukelau.me/?a=blobdiff_plain;f=src%2FLanguage%2FHaskell%2FLSP%2FTest%2FRecorded.hs;h=e2dce5c811f1b4104f801ce985df3479d3a19ec1;hb=806ff76a624f4aa9b3b57d57bcc725727698505d;hp=746ff0bf7323ca2ce01690d985c569bed481862d;hpb=35925b4a5a5e24e1611431106fd8ddd7c89a4436;p=lsp-test.git diff --git a/src/Language/Haskell/LSP/Test/Recorded.hs b/src/Language/Haskell/LSP/Test/Recorded.hs index 746ff0b..e2dce5c 100644 --- a/src/Language/Haskell/LSP/Test/Recorded.hs +++ b/src/Language/Haskell/LSP/Test/Recorded.hs @@ -1,44 +1,48 @@ {-# 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.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.List 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. -> FilePath -- ^ The expected response from the server. + -> FilePath -- ^ The root directory of the project -> IO Bool -replay cfp sfp = do +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", "-d"]) { 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 - -- todo: use qsem -- whether to send the next request reqSema <- newEmptyMVar :: IO (MVar LSP.LspIdRsp) -- whether to send the next response @@ -53,14 +57,25 @@ replay cfp sfp = do null <- openFile "/dev/null" WriteMode - expectedMsgs <- getAllMessages serverRecIn + 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 $ listenServer expectedMsgs serverOut semas didPass + forkIO $ runReaderT (listenServer expectedMsgs serverOut semas) didPass -- start client replay forkIO $ do - Control.runWithHandles clientRecIn + Control.runWithHandles mappedClientRecIn null (const $ Right (), const $ return Nothing) (handlers serverIn semas) @@ -77,58 +92,102 @@ replay cfp sfp = do -- restore directory setCurrentDirectory prevDir + -- cleanup temp files + removeFile mappedClientRecFp + return result --- todo: Maybe make a reader monad and a fail function for it? -listenServer - :: [B.ByteString] - -> Handle - -> (MVar LSP.LspIdRsp, MVar LSP.LspId) - -> MVar Bool - -> IO () -listenServer [] _ _ passVar = putMVar passVar True -listenServer expectedMsgs h semas@(reqSema, rspSema) passVar = do - msg <- getNextMessage h - putStrLn $ "Remaining messages " ++ show (length expectedMsgs) - if inRightOrder msg expectedMsgs - then do - - whenResponse msg $ \res -> do - putStrLn $ "Got response for id " ++ show (res ^. LSP.id) - putMVar reqSema (res ^. LSP.id) -- unblock the handler waiting to send a request - - whenRequest msg $ \req -> do - putStrLn $ "Got request for id " ++ show (req ^. LSP.id) ++ " " ++ show (req ^. LSP.method) - putMVar rspSema (req ^. LSP.id) -- unblock the handler waiting for a response - - whenNotification msg $ \n -> putStrLn $ "Got notification " ++ (show (n ^. LSP.method)) - - when (not (msg `elem` expectedMsgs)) $ do - putStrLn "Got an unexpected message" - putMVar passVar False - - listenServer (delete msg expectedMsgs) h semas passVar - else do - putStrLn $ "Got: " ++ show msg ++ "\n Expected: " ++ show - (head (filter (not . isNotification) expectedMsgs)) - putMVar passVar False +-- | The internal monad for tests that can fail or pass, +-- ending execution early. +type Session = ReaderT (MVar Bool) IO -isNotification :: B.ByteString -> Bool -isNotification msg = - isJust (decode msg :: Maybe (LSP.NotificationMessage Value Value)) +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 -whenResponse :: B.ByteString -> (LSP.ResponseMessage Value -> IO ()) -> IO () -whenResponse msg f = case decode msg :: Maybe (LSP.ResponseMessage Value) of - Just msg' -> when (isJust (msg' ^. LSP.result)) (f msg') - _ -> return () + checkOrder req -whenRequest - :: B.ByteString -> (LSP.RequestMessage Value Value Value -> IO ()) -> IO () -whenRequest msg = - forM_ (decode msg :: (Maybe (LSP.RequestMessage Value Value Value))) + lift $ putMVar rspSema (req ^. LSP.id) -- unblock the handler waiting for a response -whenNotification :: B.ByteString -> (LSP.NotificationMessage Value Value -> IO ()) -> IO () -whenNotification msg = forM_ (decode msg :: (Maybe (LSP.NotificationMessage Value Value))) + 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 = 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 + + 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 @@ -140,34 +199,15 @@ whenNotification msg = forM_ (decode msg :: (Maybe (LSP.NotificationMessage Valu -- given RES1 -- @ N1 N3 N4 N5 XXXX RES1 @ False! -- Order of requests and responses matter -inRightOrder :: B.ByteString -> [B.ByteString] -> Bool -inRightOrder _ [] = error "why is this empty" -inRightOrder received msgs = received `elem` valid - where - valid = takeWhile canSkip msgs ++ firstNonSkip - -- we don't care about the order of notifications - canSkip = isNotification - nonSkip = dropWhile canSkip msgs - firstNonSkip | null nonSkip = [] - | otherwise = [head nonSkip] - -getAllMessages :: Handle -> IO [B.ByteString] -getAllMessages h = do - done <- hIsEOF h - if done - then return [] - else do - msg <- getNextMessage h - (msg :) <$> getAllMessages h +inRightOrder :: (FromJSON a, Eq a) => a -> [B.ByteString] -> Bool + +inRightOrder _ [] = error "Why is this empty" +-- inRightOrder (LSP.NotificationMessage _ _ _) _ = True --- | 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 +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 @@ -209,17 +249,21 @@ handlers serverH (reqSema, rspSema) = def , 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 _ 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" @@ -239,18 +283,3 @@ handlers serverH (reqSema, rspSema) = def else do B.hPut serverH $ addHeader (encode msg) putStrLn $ "Sent response to request id " ++ show id - -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