name: haskell-lsp-test
version: 0.1.0.0
- -- synopsis:
+ synopsis: Functional test framework for LSP servers.
-- description:
homepage: https://github.com/Bubba/haskell-lsp-test#readme
license: BSD3
license-file: LICENSE
author: Luke Lau
maintainer: luke_lau@icloud.com
+ stability: experimental
+ bug-reports: https://github.com/Bubba/haskell-lsp-test/issues
copyright: 2018 Luke Lau
category: Testing
build-type: Simple
-cabal-version: >=1.10
+cabal-version: >=2.0
extra-source-files: README.md
library
- hs-source-dirs: src
+ hs-source-dirs: lib
exposed-modules: Language.Haskell.LSP.Test
, Language.Haskell.LSP.Test.Replay
+ , Language.Haskell.LSP.Test.Machine
+ reexported-modules: haskell-lsp:Language.Haskell.LSP.Types
+ , haskell-lsp:Language.Haskell.LSP.Types.Capabilities
+ , parser-combinators:Control.Applicative.Combinators
default-language: Haskell2010
build-depends: base >= 4.7 && < 5
- , haskell-lsp >= 0.3
+ , haskell-lsp-types
- ghc-options: -W
-
+ , haskell-lsp >= 0.4
+ , haskell-lsp-test-internal
+ , aeson
+ , bytestring
+ , containers
+ , data-default
+ , directory
+ , filepath
+ , lens
+ , parser-combinators
+ , text
+ , unordered-containers
+ , yi-rope
+
+library haskell-lsp-test-internal
+ hs-source-dirs: src
+ default-language: Haskell2010
+ exposed-modules: Language.Haskell.LSP.Test.Compat
+ Language.Haskell.LSP.Test.Decoding
+ Language.Haskell.LSP.Test.Exceptions
+ Language.Haskell.LSP.Test.Files
+ Language.Haskell.LSP.Test.Messages
+ Language.Haskell.LSP.Test.Parsing
+ Language.Haskell.LSP.Test.Script
+ Language.Haskell.LSP.Test.Server
+ Language.Haskell.LSP.Test.Session
+ build-depends: base
+ , haskell-lsp-types
+ , haskell-lsp >= 0.3
, aeson
, ansi-terminal
+ , async
, bytestring
, conduit
, conduit-parse
, filepath
, lens
, mtl
+ , scientific
, parser-combinators
, process
, text
build-depends: Win32
else
build-depends: unix
- other-modules: Language.Haskell.LSP.Test.Compat
- Language.Haskell.LSP.Test.Decoding
- Language.Haskell.LSP.Test.Exceptions
- Language.Haskell.LSP.Test.Files
- Language.Haskell.LSP.Test.Messages
- Language.Haskell.LSP.Test.Parsing
- Language.Haskell.LSP.Test.Server
- Language.Haskell.LSP.Test.Session
ghc-options: -W
-
+executable lsp-test
+ hs-source-dirs: lsp-test
+ main-is: Main.hs
+ default-language: Haskell2010
+ build-depends: base >= 4.7 && < 5
+ , haskell-lsp-types
- , haskell-lsp >= 0.3
++ , haskell-lsp >= 0.4
+ , haskell-lsp-test-internal
+ , haskell-lsp-test
+ , aeson
+ , bytestring
+ , directory
+ , filepath
+ , text
+ , unordered-containers
+ , scientific
+
test-suite tests
type: exitcode-stdio-1.0
main-is: Test.hs
, hspec
, lens
, data-default
- , directory
+ , haskell-lsp >= 0.4
, haskell-lsp-test
- , haskell-lsp-test-internal
- , haskell-lsp
- , haskell-lsp-types
- , conduit
- , conduit-parse
, aeson
, unordered-containers
, text
default-language: Haskell2010
build-depends: base >= 4.7 && < 5
, haskell-lsp-test
- , haskell-lsp-types
- , lens
- , text
- , directory
, loggingNotification
, publishDiagnosticsNotification
-- * Combinators
- , choice
- , option
- , optional
- , between
- , some
- , many
- , sepBy
- , sepBy1
- , sepEndBy1
- , sepEndBy
- , endBy1
- , endBy
- , count
- , manyTill
- , skipMany
- , skipSome
- , skipManyTill
- , skipSomeTill
- , (<|>)
, satisfy
-- * Utilities
, initializeResponse
, documentContents
, getDocumentEdit
, getDocUri
+ , getVersionedDoc
-- ** Symbols
, getDocumentSymbols
-- ** Diagnostics
, waitForDiagnostics
+ , waitForDiagnosticsSource
, noDiagnostics
-- ** Commands
, executeCommand
-- ** Code Actions
, getAllCodeActions
, executeCodeAction
+ -- ** Completions
+ , getCompletions
+ -- ** References
+ , getReferences
+ -- ** Renaming
+ , rename
+ -- ** Edits
+ , applyEdit
) where
- import Control.Applicative
import Control.Applicative.Combinators
import Control.Concurrent
import Control.Monad
import Data.Maybe
import Language.Haskell.LSP.Types hiding (id, capabilities, message)
import qualified Language.Haskell.LSP.Types as LSP
+ import qualified Language.Haskell.LSP.Types.Capabilities as LSP
import Language.Haskell.LSP.Messages
import Language.Haskell.LSP.VFS
import Language.Haskell.LSP.Test.Compat
req <- message :: Session ApplyWorkspaceEditRequest
unless (checkDocumentChanges req || checkChanges req) $
- liftIO $ throw (IncorrectApplyEditRequestException (show req))
+ liftIO $ throw (IncorrectApplyEditRequest (show req))
documentContents doc
where
let fp = rootDir context </> file
return $ filePathToUri fp
+ -- | Waits for diagnostics to be published and returns them.
waitForDiagnostics :: Session [Diagnostic]
waitForDiagnostics = do
diagsNot <- skipManyTill anyMessage message :: Session PublishDiagnosticsNotification
let (List diags) = diagsNot ^. params . LSP.diagnostics
return diags
+ waitForDiagnosticsSource :: String -> Session [Diagnostic]
+ waitForDiagnosticsSource src = do
+ diags <- waitForDiagnostics
+ let res = filter matches diags
+ if null res
+ then waitForDiagnosticsSource src
+ else return res
+ where
+ matches :: Diagnostic -> Bool
+ matches d = d ^. source == Just (T.pack src)
+
-- | Expects a 'PublishDiagnosticsNotification' and throws an
-- 'UnexpectedDiagnosticsException' if there are any diagnostics
-- returned.
noDiagnostics :: Session ()
noDiagnostics = do
diagsNot <- message :: Session PublishDiagnosticsNotification
- when (diagsNot ^. params . LSP.diagnostics /= List []) $ liftIO $ throw UnexpectedDiagnosticsException
+ when (diagsNot ^. params . LSP.diagnostics /= List []) $ liftIO $ throw UnexpectedDiagnostics
-- | Returns the symbols in a document.
getDocumentSymbols :: TextDocumentIdentifier -> Session [SymbolInformation]
let (Just (List symbols)) = mRes
return symbols
+ -- | Returns all the code actions in a document by
+ -- querying the code actions at each of the current
+ -- diagnostics' positions.
getAllCodeActions :: TextDocumentIdentifier -> Session [CommandOrCodeAction]
getAllCodeActions doc = do
curDiags <- fromMaybe [] . Map.lookup (doc ^. uri) . curDiagnostics <$> get
let Just (List cmdOrCAs) = mRes
in return (acc ++ cmdOrCAs)
+ -- | Executes a command.
executeCommand :: Command -> Session ()
executeCommand cmd = do
let args = decode $ encode $ fromJust $ cmd ^. arguments
execParams = ExecuteCommandParams (cmd ^. command) args
sendRequest_ WorkspaceExecuteCommand execParams
+ -- | Executes a code action.
+ -- Matching with the specification, if a code action
+ -- contains both an edit and a command, the edit will
+ -- be applied first.
executeCodeAction :: CodeAction -> Session ()
executeCodeAction action = do
maybe (return ()) handleEdit $ action ^. edit
where handleEdit :: WorkspaceEdit -> Session ()
handleEdit e =
+ -- Its ok to pass in dummy parameters here as they aren't used
let req = RequestMessage "" (IdInt 0) WorkspaceApplyEdit (ApplyWorkspaceEditParams e)
in updateState (ReqApplyWorkspaceEdit req)
+
+ -- | Adds the current version to the document, as tracked by the session.
+ getVersionedDoc :: TextDocumentIdentifier -> Session VersionedTextDocumentIdentifier
+ getVersionedDoc (TextDocumentIdentifier uri) = do
+ fs <- vfs <$> get
+ let ver =
+ case fs Map.!? uri of
+ Just (VirtualFile v _) -> Just v
+ _ -> Nothing
+ return (VersionedTextDocumentIdentifier uri ver)
+
+ -- | Applys an edit to the document and returns the updated document version.
+ applyEdit :: TextDocumentIdentifier -> TextEdit -> Session VersionedTextDocumentIdentifier
+ applyEdit doc edit = do
+
+ verDoc <- getVersionedDoc doc
+
+ caps <- asks (capabilities . config)
+
+ let supportsDocChanges = fromMaybe False $ do
+ let LSP.ClientCapabilities mWorkspace _ _ = caps
+ LSP.WorkspaceClientCapabilities _ mEdit _ _ _ _ <- mWorkspace
+ LSP.WorkspaceEditClientCapabilities mDocChanges <- mEdit
+ mDocChanges
+
+ let wEdit = if supportsDocChanges
+ then
+ let docEdit = TextDocumentEdit verDoc (List [edit])
+ in WorkspaceEdit Nothing (Just (List [docEdit]))
+ else
+ let changes = HashMap.singleton (doc ^. uri) (List [edit])
+ in WorkspaceEdit (Just changes) Nothing
+
+ let req = RequestMessage "" (IdInt 0) WorkspaceApplyEdit (ApplyWorkspaceEditParams wEdit)
+ updateState (ReqApplyWorkspaceEdit req)
+
+ -- version may have changed
+ getVersionedDoc doc
+
+ -- | Returns the completions for the position in the document.
+ getCompletions :: TextDocumentIdentifier -> Position -> Session [CompletionItem]
+ getCompletions doc pos = do
+ rsp <- sendRequest TextDocumentCompletion (TextDocumentPositionParams doc pos)
+
+ case getResponseResult rsp of
+ Completions (List items) -> return items
+ CompletionList (CompletionListType _ (List items)) -> return items
+
+ -- | Returns the references for the position in the document.
+ getReferences :: TextDocumentIdentifier -- ^ The document to lookup in.
+ -> Position -- ^ The position to lookup.
+ -> Bool -- ^ Whether to include declarations as references.
+ -> Session [Location] -- ^ The locations of the references.
+ getReferences doc pos inclDecl =
+ let ctx = ReferenceContext inclDecl
+ params = ReferenceParams doc pos ctx
+ in fromMaybe [] . (^. result) <$> sendRequest TextDocumentReferences params
+
+ -- ^ Renames the term at the specified position.
+ rename :: TextDocumentIdentifier -> Position -> String -> Session ()
+ rename doc pos newName = do
+ let params = RenameParams doc pos (T.pack newName)
+ rsp <- sendRequest TextDocumentRename params :: Session RenameResponse
+ let wEdit = getResponseResult rsp
+ req = RequestMessage "" (IdInt 0) WorkspaceApplyEdit (ApplyWorkspaceEditParams wEdit)
+ updateState (ReqApplyWorkspaceEdit req)
+
+ -- | Checks the response for errors and throws an exception if needed.
+ -- Returns the result if successful.
+ getResponseResult :: ResponseMessage a -> a
+ getResponseResult rsp = fromMaybe exc (rsp ^. result)
+ where exc = throw $ UnexpectedResponseError (rsp ^. LSP.id)
+ (fromJust $ rsp ^. LSP.error)
+