@@ -1,6 +1,7 @@
11-- Copyright (c) 2019 The DAML Authors. All rights reserved.
22-- SPDX-License-Identifier: Apache-2.0
33
4+{-# LANGUAGE AllowAmbiguousTypes #-}
45{-# LANGUAGE DuplicateRecordFields #-}
56{-# LANGUAGE PatternSynonyms #-}
67{-# LANGUAGE CPP #-}
@@ -9,27 +10,32 @@
910module Main (main) where
1011
1112import Control.Applicative.Combinators
12−import Control.Exception (catch)
13+import Control.Exception (bracket, catch)
14+import qualified Control.Lens as Lens
1315import Control.Monad
1416import Control.Monad.IO.Class (liftIO)
15−import Data.Char (toLower)
17+import Data.Aeson (FromJSON, Value)
1618import Data.Foldable
17−import Data.List
19+import Data.List.Extra
1820import Data.Rope.UTF16 (Rope)
1921import qualified Data.Rope.UTF16 as Rope
2022import Development.IDE.Core.PositionMapping (fromCurrent, toCurrent)
2123import Development.IDE.GHC.Util
2224import qualified Data.Text as T
25+import Data.Typeable
2326import Development.IDE.Spans.Common
2427import Development.IDE.Test
2528import Development.IDE.Test.Runfiles
2629import Development.IDE.Types.Location
27−import qualified Language.Haskell.LSP.Test as LSPTest
28−import Language.Haskell.LSP.Test hiding (openDoc')
30+import Development.Shake (getDirectoryFilesIO)
31+import Language.Haskell.LSP.Test
32+import Language.Haskell.LSP.Messages
2933import Language.Haskell.LSP.Types
3034import Language.Haskell.LSP.Types.Capabilities
35+import qualified Language.Haskell.LSP.Types.Lens as Lsp (diagnostics, params, message)
3136import Language.Haskell.LSP.VFS (applyChange)
32−import System.Environment.Blank (setEnv)
37+import Network.URI
38+import System.Environment.Blank (getEnv, setEnv, unsetEnv)
3339import System.FilePath
3440import System.IO.Extra
3541import System.Directory
@@ -37,35 +43,41 @@ import Test.QuickCheck
3743import Test.QuickCheck.Instances ()
3844import Test.Tasty
3945import Test.Tasty.ExpectedFailure
46+import Test.Tasty.Ingredients.Rerun
4047import Test.Tasty.HUnit
4148import Test.Tasty.QuickCheck
4249import Data.Maybe
4350
4451main :: IO ()
45−main = defaultMain $ testGroup "HIE"
46− [ testSession "open close" $ do
47− doc <- openDoc' "Testing.hs" "haskell" ""
48− void (message :: Session WorkDoneProgressCreateRequest)
49− void (message :: Session WorkDoneProgressBeginNotification)
50− closeDoc doc
51− void (message :: Session WorkDoneProgressEndNotification)
52− , initializeResponseTests
53− , completionTests
54− , cppTests
55− , diagnosticTests
56− , codeActionTests
57− , codeLensesTests
58− , outlineTests
59− , findDefinitionAndHoverTests
60− , pluginTests
61− , preprocessorTests
62− , thTests
63− , unitTests
64− , haddockTests
65− , positionMappingTests
66− , watchedFilesTests
67− , sessionDepsArePickedUp
68− ]
52+main = do
53+ -- We mess with env vars so run single-threaded.
54+ setEnv "TASTY_NUM_THREADS" "1" True
55+ defaultMainWithRerun $ testGroup "HIE"
56+ [ testSession "open close" $ do
57+ doc <- createDoc "Testing.hs" "haskell" ""
58+ void (skipManyTill anyMessage message :: Session WorkDoneProgressCreateRequest)
59+ void (skipManyTill anyMessage message :: Session WorkDoneProgressBeginNotification)
60+ closeDoc doc
61+ void (skipManyTill anyMessage message :: Session WorkDoneProgressEndNotification)
62+ , initializeResponseTests
63+ , completionTests
64+ , cppTests
65+ , diagnosticTests
66+ , codeActionTests
67+ , codeLensesTests
68+ , outlineTests
69+ , findDefinitionAndHoverTests
70+ , pluginTests
71+ , preprocessorTests
72+ , thTests
73+ , safeTests
74+ , unitTests
75+ , haddockTests
76+ , positionMappingTests
77+ , watchedFilesTests
78+ , cradleTests
79+ , dependentFileTest
80+ ]
6981
7082initializeResponseTests :: TestTree
7183initializeResponseTests = withResource acquire release tests where
@@ -100,7 +112,7 @@ initializeResponseTests = withResource acquire release tests where
100112 , chk "NO doc link" _documentLinkProvider Nothing
101113 , chk "NO color" _colorProvider (Just $ ColorOptionsStatic False)
102114 , chk "NO folding range" _foldingRangeProvider (Just $ FoldingRangeOptionsStatic False)
103− , chk " execute command" _executeCommandProvider (Just $ ExecuteCommandOptions $ List ["typesignature.add"])
115+ , che " execute command" _executeCommandProvider (Just $ ExecuteCommandOptions $ List ["typesignature.add"])
104116 , chk " workspace" _workspace (Just $ WorkspaceOptions (Just WorkspaceFolderOptions{_supported = Just True, _changeNotifications = Just ( WorkspaceFolderChangeNotificationsBool True )}))
105117 , chk "NO experimental" _experimental Nothing
106118 ] where
@@ -116,8 +128,17 @@ initializeResponseTests = withResource acquire release tests where
116128 chk title getActual expected =
117129 testCase title $ getInitializeResponse >>= \ir -> expected @=? (getActual . innerCaps) ir
118130
131+ che :: TestName -> (InitializeResponseCapabilitiesInner -> Maybe ExecuteCommandOptions) -> Maybe ExecuteCommandOptions -> TestTree
132+ che title getActual _expected = testCase title doTest
133+ where
134+ doTest = do
135+ ir <- getInitializeResponse
136+ let Just ExecuteCommandOptions {_commands = List [command]} = getActual $ innerCaps ir
137+ True @=? T.isSuffixOf "typesignature.add" command
138+
139+
119140 innerCaps :: InitializeResponse -> InitializeResponseCapabilitiesInner
120− innerCaps (ResponseMessage _ _ (Just (InitializeResponseCapabilities c)) _) = c
141+ innerCaps (ResponseMessage _ _ (Right (InitializeResponseCapabilities c))) = c
121142 innerCaps _ = error "this test only expects inner capabilities"
122143
123144 acquire :: IO InitializeResponse
@@ -131,7 +152,7 @@ diagnosticTests :: TestTree
131152diagnosticTests = testGroup "diagnostics"
132153 [ testSessionWait "fix syntax error" $ do
133154 let content = T.unlines [ "module Testing wher" ]
134− doc <- openDoc' "Testing.hs" "haskell" content
155+ doc <- createDoc "Testing.hs" "haskell" content
135156 expectDiagnostics [("Testing.hs", [(DsError, (0, 15), "parse error")])]
136157 let change = TextDocumentContentChangeEvent
137158 { _range = Just (Range (Position 0 15) (Position 0 19))
@@ -142,9 +163,9 @@ diagnosticTests = testGroup "diagnostics"
142163 expectDiagnostics [("Testing.hs", [])]
143164 , testSessionWait "introduce syntax error" $ do
144165 let content = T.unlines [ "module Testing where" ]
145− doc <- openDoc' "Testing.hs" "haskell" content
146− void (message :: Session WorkDoneProgressCreateRequest)
147− void (message :: Session WorkDoneProgressBeginNotification)
166+ doc <- createDoc "Testing.hs" "haskell" content
167+ void $ skipManyTill anyMessage (message :: Session WorkDoneProgressCreateRequest)
168+ void $ skipManyTill anyMessage (message :: Session WorkDoneProgressBeginNotification)
148169 let change = TextDocumentContentChangeEvent
149170 { _range = Just (Range (Position 0 15) (Position 0 18))
150171 , _rangeLength = Nothing
@@ -160,7 +181,7 @@ diagnosticTests = testGroup "diagnostics"
160181 , "bar :: Int -> Int -> Int"
161182 , "bar a b = cd + b"
162183 ]
163− _ <- openDoc' "Testing.hs" "haskell" content
184+ _ <- createDoc "Testing.hs" "haskell" content
164185 expectDiagnostics
165186 [ ( "Testing.hs"
166187 , [ (DsError, (2, 14), "Variable not in scope: ab")
@@ -174,7 +195,7 @@ diagnosticTests = testGroup "diagnostics"
174195 , "foo :: Int -> String -> Int"
175196 , "foo a b = a + b"
176197 ]
177− _ <- openDoc' "Testing.hs" "haskell" content
198+ _ <- createDoc "Testing.hs" "haskell" content
178199 expectDiagnostics
179200 [ ( "Testing.hs"
180201 , [(DsError, (2, 14), "Couldn't match type '[Char]' with 'Int'")]
@@ -186,7 +207,7 @@ diagnosticTests = testGroup "diagnostics"
186207 , "foo :: Int -> String"
187208 , "foo a = _ a"
188209 ]
189− _ <- openDoc' "Testing.hs" "haskell" content
210+ _ <- createDoc "Testing.hs" "haskell" content
190211 expectDiagnostics
191212 [ ( "Testing.hs"
192213 , [(DsError, (2, 8), "Found hole: _ :: Int -> String")]
@@ -208,24 +229,23 @@ diagnosticTests = testGroup "diagnostics"
208229 [ ("A.hs", [(DsError, (2,4), aMessage)])
209230 , ("B.hs", [(DsError, (3,4), bMessage)])]
210231 deferralTest title binding msg = testSessionWait title $ do
211− _ <- openDoc' "A.hs" "haskell" $ sourceA binding
212− _ <- openDoc' "B.hs" "haskell" sourceB
232+ _ <- createDoc "A.hs" "haskell" $ sourceA binding
233+ _ <- createDoc "B.hs" "haskell" sourceB
213234 expectDiagnostics $ expectedDs msg
214235 in
215236 [ deferralTest "type error" "True" "Couldn't match expected type"
216237 , deferralTest "typed hole" "_" "Found hole"
217238 , deferralTest "out of scope var" "unbound" "Variable not in scope"
218− , deferralTest "message shows error" "True" "A.hs:3:5: error:"
219239 ]
220240
221241 , testSessionWait "remove required module" $ do
222242 let contentA = T.unlines [ "module ModuleA where" ]
223− docA <- openDoc' "ModuleA.hs" "haskell" contentA
243+ docA <- createDoc "ModuleA.hs" "haskell" contentA
224244 let contentB = T.unlines
225245 [ "module ModuleB where"
226246 , "import ModuleA"
227247 ]
228− _ <- openDoc' "ModuleB.hs" "haskell" contentB
248+ _ <- createDoc "ModuleB.hs" "haskell" contentB
229249 let change = TextDocumentContentChangeEvent
230250 { _range = Just (Range (Position 0 0) (Position 0 20))
231251 , _rangeLength = Nothing
@@ -238,20 +258,20 @@ diagnosticTests = testGroup "diagnostics"
238258 [ "module ModuleB where"
239259 , "import ModuleA"
240260 ]
241− _ <- openDoc' "ModuleB.hs" "haskell" contentB
261+ _ <- createDoc "ModuleB.hs" "haskell" contentB
242262 expectDiagnostics [("ModuleB.hs", [(DsError, (1, 7), "Could not find module")])]
243263 let contentA = T.unlines [ "module ModuleA where" ]
244− _ <- openDoc' "ModuleA.hs" "haskell" contentA
264+ _ <- createDoc "ModuleA.hs" "haskell" contentA
245265 expectDiagnostics [("ModuleB.hs", [])]
246266 , testSessionWait "add missing module (non workspace)" $ do
247267 let contentB = T.unlines
248268 [ "module ModuleB where"
249269 , "import ModuleA"
250270 ]
251− _ <- openDoc'' "/tmp/ModuleB.hs" "haskell" contentB
271+ _ <- createDoc "/tmp/ModuleB.hs" "haskell" contentB
252272 expectDiagnostics [("/tmp/ModuleB.hs", [(DsError, (1, 7), "Could not find module")])]
253273 let contentA = T.unlines [ "module ModuleA where" ]
254− _ <- openDoc'' "/tmp/ModuleA.hs" "haskell" contentA
274+ _ <- createDoc "/tmp/ModuleA.hs" "haskell" contentA
255275 expectDiagnostics [("/tmp/ModuleB.hs", [])]
256276 , testSessionWait "cyclic module dependency" $ do
257277 let contentA = T.unlines
@@ -262,8 +282,8 @@ diagnosticTests = testGroup "diagnostics"
262282 [ "module ModuleB where"
263283 , "import ModuleA"
264284 ]
265− _ <- openDoc' "ModuleA.hs" "haskell" contentA
266− _ <- openDoc' "ModuleB.hs" "haskell" contentB
285+ _ <- createDoc "ModuleA.hs" "haskell" contentA
286+ _ <- createDoc "ModuleB.hs" "haskell" contentB
267287 expectDiagnostics
268288 [ ( "ModuleA.hs"
269289 , [(DsError, (1, 7), "Cyclic module dependency between ModuleA, ModuleB")]
@@ -284,9 +304,9 @@ diagnosticTests = testGroup "diagnostics"
284304 let contentBboot = T.unlines
285305 [ "module ModuleB where"
286306 ]
287− _ <- openDoc' "ModuleA.hs" "haskell" contentA
288− _ <- openDoc' "ModuleB.hs" "haskell" contentB
289− _ <- openDoc' "ModuleB.hs-boot" "haskell" contentBboot
307+ _ <- createDoc "ModuleA.hs" "haskell" contentA
308+ _ <- createDoc "ModuleB.hs" "haskell" contentB
309+ _ <- createDoc "ModuleB.hs-boot" "haskell" contentBboot
290310 expectDiagnostics []
291311 , testSessionWait "correct reference used with hs-boot" $ do
292312 let contentB = T.unlines
@@ -308,10 +328,10 @@ diagnosticTests = testGroup "diagnostics"
308328 -- resolved to the hs-boot file
309329 , "y = x"
310330 ]
311− _ <- openDoc' "ModuleB.hs" "haskell" contentB
312− _ <- openDoc' "ModuleA.hs" "haskell" contentA
313− _ <- openDoc' "ModuleA.hs-boot" "haskell" contentAboot
314− _ <- openDoc' "ModuleC.hs" "haskell" contentC
331+ _ <- createDoc "ModuleB.hs" "haskell" contentB
332+ _ <- createDoc "ModuleA.hs" "haskell" contentA
333+ _ <- createDoc "ModuleA.hs-boot" "haskell" contentAboot
334+ _ <- createDoc "ModuleC.hs" "haskell" contentC
315335 expectDiagnostics []
316336 , testSessionWait "redundant import" $ do
317337 let contentA = T.unlines ["module ModuleA where"]
@@ -320,8 +340,8 @@ diagnosticTests = testGroup "diagnostics"
320340 , "module ModuleB where"
321341 , "import ModuleA"
322342 ]
323− _ <- openDoc' "ModuleA.hs" "haskell" contentA
324− _ <- openDoc' "ModuleB.hs" "haskell" contentB
343+ _ <- createDoc "ModuleA.hs" "haskell" contentA
344+ _ <- createDoc "ModuleB.hs" "haskell" contentB
325345 expectDiagnostics
326346 [ ( "ModuleB.hs"
327347 , [(DsWarning, (2, 0), "The import of 'ModuleA' is redundant")]
@@ -343,8 +363,8 @@ diagnosticTests = testGroup "diagnostics"
343363 , "wrong1 = ThisList.map"
344364 , "wrong2 = BaseList.x"
345365 ]
346− _ <- openDoc' "Data/List.hs" "haskell" thisDataListContent
347− _ <- openDoc' "Main.hs" "haskell" mainContent
366+ _ <- createDoc "Data/List.hs" "haskell" thisDataListContent
367+ _ <- createDoc "Main.hs" "haskell" mainContent
348368 expectDiagnostics
349369 [ ( "Main.hs"
350370 , [(DsError, (6, 9), "Not in scope: \8216ThisList.map\8217")
@@ -359,7 +379,7 @@ diagnosticTests = testGroup "diagnostics"
359379 , "foo :: Ord a => a -> Int"
360380 , "foo a = 1"
361381 ]
362− _ <- openDoc' "Foo.hs" "haskell" fooContent
382+ _ <- createDoc "Foo.hs" "haskell" fooContent
363383 expectDiagnostics
364384 [ ( "Foo.hs"
365385 -- The test is to make sure that warnings contain unqualified names
@@ -384,18 +404,18 @@ diagnosticTests = testGroup "diagnostics"
384404 Just pathB <- pure $ uriToFilePath uriB
385405 uriB <- pure $
386406 let (drive, suffix) = splitDrive pathB
387− in filePathToUri (joinDrive (map toLower drive ) suffix)
407+ in filePathToUri (joinDrive (lower drive) suffix)
388408 liftIO $ createDirectoryIfMissing True (takeDirectory pathB)
389409 liftIO $ writeFileUTF8 pathB $ T.unpack bContent
390410 uriA <- getDocUri "A/A.hs"
391411 Just pathA <- pure $ uriToFilePath uriA
392412 uriA <- pure $
393413 let (drive, suffix) = splitDrive pathA
394− in filePathToUri (joinDrive (map toLower drive ) suffix)
414+ in filePathToUri (joinDrive (lower drive) suffix)
395415 let itemA = TextDocumentItem uriA "haskell" 0 aContent
396416 let a = TextDocumentIdentifier uriA
397417 sendNotification TextDocumentDidOpen (DidOpenTextDocumentParams itemA)
398− diagsNot <- skipManyTill anyMessage message :: Session PublishDiagnosticsNotification
418+ diagsNot <- skipManyTill anyMessage diagnostic
399419 let PublishDiagnosticsParams fileUri diags = _params (diagsNot :: PublishDiagnosticsNotification)
400420 -- Check that if we put a lower-case drive in for A.A
401421 -- the diagnostics for A.B will also be lower-case.
@@ -404,6 +424,38 @@ diagnosticTests = testGroup "diagnostics"
404424 liftIO $ unless ("redundant" `T.isInfixOf` msg) $
405425 assertFailure ("Expected redundant import but got " <> T.unpack msg)
406426 closeDoc a
427+ , testSessionWait "haddock parse error" $ do
428+ let fooContent = T.unlines
429+ [ "module Foo where"
430+ , "foo :: Int"
431+ , "foo = 1 {-|-}"
432+ ]
433+ _ <- createDoc "Foo.hs" "haskell" fooContent
434+ expectDiagnostics
435+ [ ( "Foo.hs"
436+ , [(DsError, (2, 8), "Parse error on input")
437+ ]
438+ )
439+ ]
440+ , testSessionWait "strip file path" $ do
441+ let
442+ name = "Testing"
443+ content = T.unlines
444+ [ "module " <> name <> " where"
445+ , "value :: Maybe ()"
446+ , "value = [()]"
447+ ]
448+ _ <- createDoc (T.unpack name <> ".hs") "haskell" content
449+ notification <- skipManyTill anyMessage diagnostic
450+ let
451+ offenders =
452+ Lsp.params .
453+ Lsp.diagnostics .
454+ Lens.folded .
455+ Lsp.message .
456+ Lens.filtered (T.isInfixOf ("/" <> name <> ".hs:"))
457+ failure msg = liftIO $ assertFailure $ "Expected file path to be stripped but got " <> T.unpack msg
458+ Lens.mapMOf_ offenders failure notification
407459 ]
408460
409461codeActionTests :: TestTree
@@ -428,21 +480,28 @@ codeLensesTests = testGroup "code lenses"
428480
429481watchedFilesTests :: TestTree
430482watchedFilesTests = testGroup "watched files"
431− [ testSession "workspace file" $ do
432− _ <- openDoc' "A.hs" "haskell" "module A where"
433− RequestMessage{_params = RegistrationParams (List regs)} <- skipManyTill anyMessage (message @RegisterCapabilityRequest)
434− let watchedFileRegs =
435− [ args | Registration _id WorkspaceDidChangeWatchedFiles args <- regs ]
436− liftIO $ assertBool "watches workspace files" $ not $ null watchedFileRegs
437− , testSession "non workspace file" $ do
438− _ <- openDoc' "/tmp/A.hs" "haskell" "module A where"
439− msgs <- manyTill (Just <$> message @RegisterCapabilityRequest <|> Nothing <$ anyMessage) (message @WorkDoneProgressEndNotification)
440− let watchedFileRegs =
441− [ args
442− | Just (RequestMessage{_params = RegistrationParams (List regs)}) <- msgs
443− , Registration _id WorkspaceDidChangeWatchedFiles args <- regs
444− ]
445− liftIO $ watchedFileRegs @?= []
483+ [ testSession' "workspace files" $ \sessionDir -> do
484+ liftIO $ writeFile (sessionDir </> "hie.yaml") "cradle: {direct: {arguments: [\"-isrc\"]}}"
485+ _doc <- createDoc "A.hs" "haskell" "{-#LANGUAGE NoImplicitPrelude #-}\nmodule A where\nimport WatchedFilesMissingModule"
486+ watchedFileRegs <- getWatchedFilesSubscriptionsUntil @PublishDiagnosticsNotification
487+
488+ -- Expect 4 subscriptions (A does not get any because it's VFS):
489+ -- - /path-to-workspace/WatchedFilesMissingModule.hs
490+ -- - /path-to-workspace/WatchedFilesMissingModule.lhs
491+ -- - /path-to-workspace/src/WatchedFilesMissingModule.hs
492+ -- - /path-to-workspace/src/WatchedFilesMissingModule.lhs
493+ liftIO $ length watchedFileRegs @?= 4
494+
495+ , testSession' "non workspace file" $ \sessionDir -> do
496+ liftIO $ writeFile (sessionDir </> "hie.yaml") "cradle: {direct: {arguments: [\"-i/tmp\"]}}"
497+ _doc <- createDoc "A.hs" "haskell" "{-# LANGUAGE NoImplicitPrelude#-}\nmodule A where\nimport WatchedFilesMissingModule"
498+ watchedFileRegs <- getWatchedFilesSubscriptionsUntil @PublishDiagnosticsNotification
499+
500+ -- Expect 2 subscriptions (/tmp does not get any as it is out of the workspace):
501+ -- - /path-to-workspace/WatchedFilesMissingModule.hs
502+ -- - /path-to-workspace/WatchedFilesMissingModule.lhs
503+ liftIO $ length watchedFileRegs @?= 2
504+
446505 -- TODO add a test for didChangeWorkspaceFolder
447506 ]
448507
@@ -454,7 +513,7 @@ renameActionTests = testGroup "rename actions"
454513 , "foo :: Int -> Int"
455514 , "foo argName = argNme"
456515 ]
457− doc <- openDoc' "Testing.hs" "haskell" content
516+ doc <- createDoc "Testing.hs" "haskell" content
458517 _ <- waitForDiagnostics
459518 action <- findCodeAction doc (Range (Position 2 14) (Position 2 20)) "Replace with ‘argName’"
460519 executeCodeAction action
@@ -472,7 +531,7 @@ renameActionTests = testGroup "rename actions"
472531 , "foo :: Maybe a -> [a]"
473532 , "foo = maybToList"
474533 ]
475− doc <- openDoc' "Testing.hs" "haskell" content
534+ doc <- createDoc "Testing.hs" "haskell" content
476535 _ <- waitForDiagnostics
477536 action <- findCodeAction doc (Range (Position 3 6) (Position 3 16)) "Replace with ‘maybeToList’"
478537 executeCodeAction action
@@ -490,7 +549,7 @@ renameActionTests = testGroup "rename actions"
490549 , "foo :: Char -> Char -> Char -> Char"
491550 , "foo argument1 argument2 argument3 = argumentX"
492551 ]
493− doc <- openDoc' "Testing.hs" "haskell" content
552+ doc <- createDoc "Testing.hs" "haskell" content
494553 _ <- waitForDiagnostics
495554 _ <- findCodeActions doc (Range (Position 2 36) (Position 2 45))
496555 ["Replace with ‘argument1’", "Replace with ‘argument2’", "Replace with ‘argument3’"]
@@ -502,7 +561,7 @@ renameActionTests = testGroup "rename actions"
502561 , "monus x y = max 0 (x - y)"
503562 , "foo x y = x `monnus` y"
504563 ]
505− doc <- openDoc' "Testing.hs" "haskell" content
564+ doc <- createDoc "Testing.hs" "haskell" content
506565 _ <- waitForDiagnostics
507566 actionsOrCommands <- getCodeActions doc (Range (Position 3 12) (Position 3 20))
508567 [fixTypo] <- pure [action | CACodeAction action@CodeAction{ _title = actionTitle } <- actionsOrCommands, "monus" `T.isInfixOf` actionTitle ]
@@ -525,7 +584,7 @@ typeWildCardActionTests = testGroup "type wildcard actions"
525584 , "func :: _"
526585 , "func x = x"
527586 ]
528− doc <- openDoc' "Testing.hs" "haskell" content
587+ doc <- createDoc "Testing.hs" "haskell" content
529588 _ <- waitForDiagnostics
530589 actionsOrCommands <- getCodeActions doc (Range (Position 2 1) (Position 2 10))
531590 let [addSignature] = [action | CACodeAction action@CodeAction { _title = actionTitle } <- actionsOrCommands
@@ -545,7 +604,7 @@ typeWildCardActionTests = testGroup "type wildcard actions"
545604 , "func :: _"
546605 , "func x y = x + y"
547606 ]
548− doc <- openDoc' "Testing.hs" "haskell" content
607+ doc <- createDoc "Testing.hs" "haskell" content
549608 _ <- waitForDiagnostics
550609 actionsOrCommands <- getCodeActions doc (Range (Position 2 1) (Position 2 10))
551610 let [addSignature] = [action | CACodeAction action@CodeAction { _title = actionTitle } <- actionsOrCommands
@@ -568,7 +627,7 @@ typeWildCardActionTests = testGroup "type wildcard actions"
568627 , " y = x * 2"
569628 , " in y"
570629 ]
571− doc <- openDoc' "Testing.hs" "haskell" content
630+ doc <- createDoc "Testing.hs" "haskell" content
572631 _ <- waitForDiagnostics
573632 actionsOrCommands <- getCodeActions doc (Range (Position 4 1) (Position 4 10))
574633 let [addSignature] = [action | CACodeAction action@CodeAction { _title = actionTitle } <- actionsOrCommands
@@ -593,7 +652,7 @@ removeImportTests = testGroup "remove import actions"
593652 let contentA = T.unlines
594653 [ "module ModuleA where"
595654 ]
596− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
655+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
597656 let contentB = T.unlines
598657 [ "{-# OPTIONS_GHC -Wunused-imports #-}"
599658 , "module ModuleB where"
@@ -601,7 +660,7 @@ removeImportTests = testGroup "remove import actions"
601660 , "stuffB :: Integer"
602661 , "stuffB = 123"
603662 ]
604− docB <- openDoc' "ModuleB.hs" "haskell" contentB
663+ docB <- createDoc "ModuleB.hs" "haskell" contentB
605664 _ <- waitForDiagnostics
606665 [CACodeAction action@CodeAction { _title = actionTitle }]
607666 <- getCodeActions docB (Range (Position 2 0) (Position 2 5))
@@ -619,7 +678,7 @@ removeImportTests = testGroup "remove import actions"
619678 let contentA = T.unlines
620679 [ "module ModuleA where"
621680 ]
622− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
681+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
623682 let contentB = T.unlines
624683 [ "{-# OPTIONS_GHC -Wunused-imports #-}"
625684 , "module ModuleB where"
@@ -627,7 +686,7 @@ removeImportTests = testGroup "remove import actions"
627686 , "stuffB :: Integer"
628687 , "stuffB = 123"
629688 ]
630− docB <- openDoc' "ModuleB.hs" "haskell" contentB
689+ docB <- createDoc "ModuleB.hs" "haskell" contentB
631690 _ <- waitForDiagnostics
632691 [CACodeAction action@CodeAction { _title = actionTitle }]
633692 <- getCodeActions docB (Range (Position 2 0) (Position 2 5))
@@ -649,14 +708,14 @@ removeImportTests = testGroup "remove import actions"
649708 , "stuffB = 123"
650709 , "stuffC = ()"
651710 ]
652− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
711+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
653712 let contentB = T.unlines
654713 [ "{-# OPTIONS_GHC -Wunused-imports #-}"
655714 , "module ModuleB where"
656715 , "import ModuleA (stuffA, stuffB, stuffC, stuffA)"
657716 , "main = print stuffB"
658717 ]
659− docB <- openDoc' "ModuleB.hs" "haskell" contentB
718+ docB <- createDoc "ModuleB.hs" "haskell" contentB
660719 _ <- waitForDiagnostics
661720 [CACodeAction action@CodeAction { _title = actionTitle }]
662721 <- getCodeActions docB (Range (Position 2 0) (Position 2 5))
@@ -678,22 +737,18 @@ removeImportTests = testGroup "remove import actions"
678737 , "stuffB :: Integer"
679738 , "stuffB = 123"
680739 ]
681− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
740+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
682741 let contentB = T.unlines
683742 [ "{-# OPTIONS_GHC -Wunused-imports #-}"
684743 , "module ModuleB where"
685744 , "import qualified ModuleA as A ((<?>), stuffB, (!!))"
686745 , "main = print A.stuffB"
687746 ]
688− docB <- openDoc' "ModuleB.hs" "haskell" contentB
747+ docB <- createDoc "ModuleB.hs" "haskell" contentB
689748 _ <- waitForDiagnostics
690749 [CACodeAction action@CodeAction { _title = actionTitle }]
691750 <- getCodeActions docB (Range (Position 2 0) (Position 2 5))
692−#if MIN_GHC_API_VERSION(8,6,0)
693751 liftIO $ "Remove !!, <?> from import" @=? actionTitle
694−#else
695− liftIO $ "Remove A.!!, A.<?> from import" @=? actionTitle
696−#endif
697752 executeCodeAction action
698753 contentAfterAction <- documentContents docB
699754 let expectedContentAfterAction = T.unlines
@@ -710,14 +765,14 @@ removeImportTests = testGroup "remove import actions"
710765 , "stuffB :: Integer"
711766 , "stuffB = 123"
712767 ]
713− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
768+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
714769 let contentB = T.unlines
715770 [ "{-# OPTIONS_GHC -Wunused-imports #-}"
716771 , "module ModuleB where"
717772 , "import ModuleA (A(..), stuffB)"
718773 , "main = print stuffB"
719774 ]
720− docB <- openDoc' "ModuleB.hs" "haskell" contentB
775+ docB <- createDoc "ModuleB.hs" "haskell" contentB
721776 _ <- waitForDiagnostics
722777 [CACodeAction action@CodeAction { _title = actionTitle }]
723778 <- getCodeActions docB (Range (Position 2 0) (Position 2 5))
@@ -737,14 +792,14 @@ removeImportTests = testGroup "remove import actions"
737792 , "data D = A | B"
738793 , "data E = F"
739794 ]
740− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
795+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
741796 let contentB = T.unlines
742797 [ "{-# OPTIONS_GHC -Wunused-imports #-}"
743798 , "module ModuleB where"
744799 , "import ModuleA (D(A,B), E(F))"
745800 , "main = B"
746801 ]
747− docB <- openDoc' "ModuleB.hs" "haskell" contentB
802+ docB <- createDoc "ModuleB.hs" "haskell" contentB
748803 _ <- waitForDiagnostics
749804 [CACodeAction action@CodeAction { _title = actionTitle }]
750805 <- getCodeActions docB (Range (Position 2 0) (Position 2 5))
@@ -885,8 +940,8 @@ extendImportTests = testGroup "extend import actions"
885940 ]
886941 where
887942 template contentA contentB range expectedAction expectedContentB = do
888− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
889− docB <- openDoc' "ModuleB.hs" "haskell" contentB
943+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
944+ docB <- createDoc "ModuleB.hs" "haskell" contentB
890945 _ <- waitForDiagnostics
891946 CACodeAction action@CodeAction { _title = actionTitle } : _
892947 <- sortOn (\(CACodeAction CodeAction{_title=x}) -> x) <$>
@@ -899,34 +954,57 @@ extendImportTests = testGroup "extend import actions"
899954suggestImportTests :: TestTree
900955suggestImportTests = testGroup "suggest import actions"
901956 [ testGroup "Dont want suggestion"
902− [ test False ["Data.List.NonEmpty ()"] "f = nonEmpty" "import Data.List.NonEmpty (nonEmpty)"
957+ [ -- extend import
958+ test False ["Data.List.NonEmpty ()"] "f = nonEmpty" [] "import Data.List.NonEmpty (nonEmpty)"
959+ -- data constructor
960+ , test False [] "f = First" [] "import Data.Monoid (First)"
961+ -- internal module
962+ , test False [] "f :: Typeable a => a" ["f = undefined"] "import Data.Typeable.Internal (Typeable)"
963+ -- package not in scope
964+ , test False [] "f = quickCheck" [] "import Test.QuickCheck (quickCheck)"
903965 ]
904966 , testGroup "want suggestion"
905− [ test True [] "f = nonEmpty" "import Data.List.NonEmpty (nonEmpty)"
906− , test True ["Prelude"] "f = nonEmpty" "import Data.List.NonEmpty (nonEmpty)"
967+ [ test True [] "f = nonEmpty" [] "import Data.List.NonEmpty (nonEmpty)"
968+ , test True [] "f = (:|)" [] "import Data.List.NonEmpty (NonEmpty((:|)))"
969+ , test True [] "f :: Natural" ["f = undefined"] "import Numeric.Natural (Natural)"
970+ , test True [] "f :: NonEmpty ()" ["f = () :| []"] "import Data.List.NonEmpty (NonEmpty)"
971+ , test True [] "f = First" [] "import Data.Monoid (First(First))"
972+ , test True [] "f = Endo" [] "import Data.Monoid (Endo(Endo))"
973+ , test True [] "f = Version" [] "import Data.Version (Version(Version))"
974+ , test True [] "f ExitSuccess = ()" [] "import System.Exit (ExitCode(ExitSuccess))"
975+ , test True [] "f = AssertionFailed" [] "import Control.Exception (AssertionFailed(AssertionFailed))"
976+ , test True ["Prelude"] "f = nonEmpty" [] "import Data.List.NonEmpty (nonEmpty)"
977+ , test True [] "f :: Alternative f => f ()" ["f = undefined"] "import Control.Applicative (Alternative)"
978+ , test True [] "f = empty" [] "import Control.Applicative (Alternative(empty))"
979+ , test True [] "f = (&)" [] "import Data.Function ((&))"
980+ , test True [] "f = NE.nonEmpty" [] "import qualified Data.List.NonEmpty as NE"
981+ , test True [] "f :: Typeable a => a" ["f = undefined"] "import Data.Typeable (Typeable)"
982+ , test True [] "f = pack" [] "import Data.Text (pack)"
983+ , test True [] "f :: Text" ["f = undefined"] "import Data.Text (Text)"
984+ , test True [] "f = [] & id" [] "import Data.Function ((&))"
985+ , test True [] "f = (&) [] id" [] "import Data.Function ((&))"
907986 ]
908987 ]
909988 where
910− test wanted imps def newImp = testSession (T.unpack def) $ do
911− let before = T.unlines $ "module A where" : ["import " <> x | x <- imps] ++ [def]
912− after = T.unlines $ "module A where" : ["import " <> x | x <- imps] ++ [newImp, def]
913− doc <- openDoc' "Test.hs" "haskell" before
914− -- load another module in the session to exercise the package cache
915− _ <- openDoc' "Other.hs" "haskell" after
989+ test wanted imps def other newImp = testSession' (T.unpack def) $ \dir -> do
990+ let before = T.unlines $ "module A where" : ["import " <> x | x <- imps] ++ def : other
991+ after = T.unlines $ "module A where" : ["import " <> x | x <- imps] ++ [newImp] ++ def : other
992+ cradle = "cradle: {direct: {arguments: [-hide-all-packages, -package, base, -package, text, -package-env, -]}}"
993+ liftIO $ writeFileUTF8 (dir </> "hie.yaml") cradle
994+ doc <- createDoc "Test.hs" "haskell" before
916995 _diags <- waitForDiagnostics
917− liftIO $ print _diags
918996 let defLine = length imps + 1
919997 range = Range (Position defLine 0) (Position defLine maxBound)
920998 actions <- getCodeActions doc range
921− case wanted of
922− False ->
923− liftIO $ [_title | CACodeAction CodeAction{_title} <- actions, _title == newImp ] @?= []
924− True -> do
925− liftIO $ print [_title | CACodeAction CodeAction{_title} <- actions]
926− let action = pickActionWithTitle newImp actions
927− executeCodeAction action
928− contentAfterAction <- documentContents doc
929− liftIO $ after @=? contentAfterAction
999+ if wanted
1000+ then do
1001+ action <- liftIO $ pickActionWithTitle newImp actions
1002+ executeCodeAction action
1003+ contentAfterAction <- documentContents doc
1004+ liftIO $ after @=? contentAfterAction
1005+ else
1006+ liftIO $ [_title | CACodeAction CodeAction{_title} <- actions, _title == newImp ] @?= []
1007+
9301008
9311009addExtensionTests :: TestTree
9321010addExtensionTests = testGroup "add language extension actions"
@@ -973,7 +1051,7 @@ addExtensionTests = testGroup "add language extension actions"
9731051 ]
9741052 where
9751053 template initialContent range expectedAction expectedContents = do
976− doc <- openDoc' "Module.hs" "haskell" initialContent
1054+ doc <- createDoc "Module.hs" "haskell" initialContent
9771055 _ <- waitForDiagnostics
9781056 CACodeAction action@CodeAction { _title = actionTitle } : _
9791057 <- sortOn (\(CACodeAction CodeAction{_title=x}) -> x) <$>
@@ -996,7 +1074,7 @@ insertNewDefinitionTests = testGroup "insert new definition actions"
9961074 [""
9971075 ,"someOtherCode = ()"
9981076 ]
999− docB <- openDoc' "ModuleB.hs" "haskell" (T.unlines $ txtB ++ txtB')
1077+ docB <- createDoc "ModuleB.hs" "haskell" (T.unlines $ txtB ++ txtB')
10001078 _ <- waitForDiagnostics
10011079 CACodeAction action@CodeAction { _title = actionTitle } : _
10021080 <- sortOn (\(CACodeAction CodeAction{_title=x}) -> x) <$>
@@ -1020,7 +1098,7 @@ insertNewDefinitionTests = testGroup "insert new definition actions"
10201098 [""
10211099 ,"someOtherCode = ()"
10221100 ]
1023− docB <- openDoc' "ModuleB.hs" "haskell" (T.unlines $ txtB ++ txtB')
1101+ docB <- createDoc "ModuleB.hs" "haskell" (T.unlines $ txtB ++ txtB')
10241102 _ <- waitForDiagnostics
10251103 CACodeAction action@CodeAction { _title = actionTitle } : _
10261104 <- sortOn (\(CACodeAction CodeAction{_title=x}) -> x) <$>
@@ -1059,8 +1137,8 @@ fixConstructorImportTests = testGroup "fix import actions"
10591137 ]
10601138 where
10611139 template contentA contentB range expectedAction expectedContentB = do
1062− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
1063− docB <- openDoc' "ModuleB.hs" "haskell" contentB
1140+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
1141+ docB <- createDoc "ModuleB.hs" "haskell" contentB
10641142 _diags <- waitForDiagnostics
10651143 CACodeAction action@CodeAction { _title = actionTitle } : _
10661144 <- sortOn (\(CACodeAction CodeAction{_title=x}) -> x) <$>
@@ -1079,7 +1157,7 @@ importRenameActionTests = testGroup "import rename actions"
10791157 [ "module Testing where"
10801158 , "import Data.Mape"
10811159 ]
1082− doc <- openDoc' "Testing.hs" "haskell" content
1160+ doc <- createDoc "Testing.hs" "haskell" content
10831161 _ <- waitForDiagnostics
10841162 actionsOrCommands <- getCodeActions doc (Range (Position 2 8) (Position 2 16))
10851163 let [changeToMap] = [action | CACodeAction action@CodeAction{ _title = actionTitle } <- actionsOrCommands, ("Data." <> modname) `T.isInfixOf` actionTitle ]
@@ -1116,10 +1194,10 @@ fillTypedHoleTests = let
11161194 newA newB newC = testSession (T.unpack actionTitle) $ do
11171195 let originalCode = sourceCode oldA oldB oldC
11181196 let expectedCode = sourceCode newA newB newC
1119− doc <- openDoc' "Testing.hs" "haskell" originalCode
1197+ doc <- createDoc "Testing.hs" "haskell" originalCode
11201198 _ <- waitForDiagnostics
11211199 actionsOrCommands <- getCodeActions doc (Range (Position 9 0) (Position 9 maxBound))
1122− let chosenAction = pickActionWithTitle actionTitle actionsOrCommands
1200+ chosenAction <- liftIO $ pickActionWithTitle actionTitle actionsOrCommands
11231201 executeCodeAction chosenAction
11241202 modifiedCode <- documentContents doc
11251203 liftIO $ expectedCode @=? modifiedCode
@@ -1164,10 +1242,10 @@ addSigActionTests = let
11641242 def >:: sig = testSession (T.unpack def) $ do
11651243 let originalCode = before def
11661244 let expectedCode = after' def sig
1167− doc <- openDoc' "Sigs.hs" "haskell" originalCode
1245+ doc <- createDoc "Sigs.hs" "haskell" originalCode
11681246 _ <- waitForDiagnostics
11691247 actionsOrCommands <- getCodeActions doc (Range (Position 3 1) (Position 3 maxBound))
1170− let chosenAction = pickActionWithTitle ("add signature: " <> sig) actionsOrCommands
1248+ chosenAction <- liftIO $ pickActionWithTitle ("add signature: " <> sig) actionsOrCommands
11711249 executeCodeAction chosenAction
11721250 modifiedCode <- documentContents doc
11731251 liftIO $ expectedCode @=? modifiedCode
@@ -1196,7 +1274,7 @@ addSigLensesTests = let
11961274 sigSession withMissing def sig = testSession (T.unpack def) $ do
11971275 let originalCode = before withMissing def
11981276 let expectedCode = after' withMissing def sig
1199− doc <- openDoc' "Sigs.hs" "haskell" originalCode
1277+ doc <- createDoc "Sigs.hs" "haskell" originalCode
12001278 [CodeLens {_command = Just c}] <- getCodeLenses doc
12011279 executeCommand c
12021280 modifiedCode <- getDocumentEdit doc
@@ -1218,24 +1296,19 @@ addSigLensesTests = let
12181296 ]
12191297 ]
12201298
1221−findDefinitionAndHoverTests :: TestTree
1222−findDefinitionAndHoverTests = let
1223−
1224− tst (get, check) pos targetRange title = testSession title $ do
1225− doc <- openTestDataDoc sourceFilePath
1226− found <- get doc pos
1227− check found targetRange
1228−
1229− checkDefs :: [Location] -> [Expect] -> Session ()
1230− checkDefs defs expectations = traverse_ check expectations where
1299+checkDefs :: [Location] -> Session [Expect] -> Session ()
1300+checkDefs defs mkExpectations = traverse_ check =<< mkExpectations where
12311301
1232− check (ExpectRange expectedRange) = do
1233− assertNDefinitionsFound 1 defs
1234− assertRangeCorrect (head defs) expectedRange
1235− check ExpectNoDefinitions = do
1236− assertNDefinitionsFound 0 defs
1237− check ExpectExternFail = liftIO $ assertFailure "Expecting to fail to find in external file"
1238− check _ = pure () -- all other expectations not relevant to getDefinition
1302+ check (ExpectRange expectedRange) = do
1303+ assertNDefinitionsFound 1 defs
1304+ assertRangeCorrect (head defs) expectedRange
1305+ check (ExpectLocation expectedLocation) = do
1306+ assertNDefinitionsFound 1 defs
1307+ liftIO $ head defs @?= expectedLocation
1308+ check ExpectNoDefinitions = do
1309+ assertNDefinitionsFound 0 defs
1310+ check ExpectExternFail = liftIO $ assertFailure "Expecting to fail to find in external file"
1311+ check _ = pure () -- all other expectations not relevant to getDefinition
12391312
12401313 assertNDefinitionsFound :: Int -> [a] -> Session ()
12411314 assertNDefinitionsFound n defs = liftIO $ assertEqual "number of definitions" n (length defs)
@@ -1243,8 +1316,19 @@ findDefinitionAndHoverTests = let
12431316 assertRangeCorrect Location{_range = foundRange} expectedRange =
12441317 liftIO $ expectedRange @=? foundRange
12451318
1246− checkHover :: Maybe Hover -> [Expect] -> Session ()
1247− checkHover hover expectations = traverse_ check expectations where
1319+
1320+findDefinitionAndHoverTests :: TestTree
1321+findDefinitionAndHoverTests = let
1322+
1323+ tst (get, check) pos targetRange title = testSessionWithExtraFiles "hover" title $ \dir -> do
1324+ doc <- openTestDataDoc (dir </> sourceFilePath)
1325+ found <- get doc pos
1326+ check found targetRange
1327+
1328+
1329+
1330+ checkHover :: Maybe Hover -> Session [Expect] -> Session ()
1331+ checkHover hover expectations = traverse_ check =<< expectations where
12481332
12491333 check expected =
12501334 case hover of
@@ -1287,9 +1371,12 @@ findDefinitionAndHoverTests = let
12871371
12881372 mkFindTests tests = testGroup "get"
12891373 [ testGroup "definition" $ mapMaybe fst tests
1290− , testGroup "hover" $ mapMaybe snd tests ]
1374+ , testGroup "hover" $ mapMaybe snd tests
1375+ , checkFileCompiles sourceFilePath ]
1376+
1377+ test runDef runHover look expect = testM runDef runHover look (return expect)
12911378
1292− test runDef runHover look expect title =
1379+ testM runDef runHover look expect title =
12931380 ( runDef $ tst def look expect title
12941381 , runHover $ tst hover look expect title ) where
12951382 def = (getDefinitions, checkDefs)
@@ -1297,87 +1384,100 @@ findDefinitionAndHoverTests = let
12971384 --type_ = (getTypeDefinitions, checkTDefs) -- getTypeDefinitions always times out
12981385
12991386 -- search locations expectations on results
1300− fffL4 = _start fffR ; fffR = mkRange 4 4 4 7 ; fff = [ExpectRange fffR]
1301− fffL8 = Position 8 4 ;
1302− fffL14 = Position 14 7 ;
1303− aaaL14 = Position 14 20 ; aaa = [mkR 7 0 7 3]
1304− dcL7 = Position 7 11 ; tcDC = [mkR 3 23 5 16]
1305− dcL12 = Position 12 11 ;
1306− xtcL5 = Position 5 11 ; xtc = [ExpectExternFail, ExpectHoverText ["Int", "Defined in ‘GHC.Types’"]]
1307− tcL6 = Position 6 11 ; tcData = [mkR 3 0 5 16, ExpectHoverText ["TypeConstructor", "GotoHover.hs:4:1"]]
1308− vvL16 = Position 16 12 ; vv = [mkR 16 4 16 6]
1309− opL16 = Position 16 15 ; op = [mkR 17 2 17 4]
1310− opL18 = Position 18 22 ; opp = [mkR 18 13 18 17]
1311− aL18 = Position 18 20 ; apmp = [mkR 18 10 18 11]
1312− b'L19 = Position 19 13 ; bp = [mkR 19 6 19 7]
1313− xvL20 = Position 20 8 ; xvMsg = [ExpectExternFail, ExpectHoverText ["Data.Text.pack", ":: String -> Text"]]
1314− clL23 = Position 23 11 ; cls = [mkR 21 0 22 20, ExpectHoverText ["MyClass", "GotoHover.hs:22:1"]]
1315− clL25 = Position 25 9
1316− eclL15 = Position 15 8 ; ecls = [ExpectExternFail, ExpectHoverText ["Num", "Defined in ‘GHC.Num’"]]
1317− dnbL29 = Position 29 18 ; dnb = [ExpectHoverText [":: ()"], mkR 29 12 29 21]
1318− dnbL30 = Position 30 23
1319− lcbL33 = Position 33 26 ; lcb = [ExpectHoverText [":: Char"], mkR 33 26 33 27]
1320− lclL33 = Position 33 22
1321− mclL36 = Position 36 1 ; mcl = [mkR 36 0 36 14]
1322− mclL37 = Position 37 1
1323− spaceL37 = Position 37 24 ; space = [ExpectNoDefinitions, ExpectHoverText [":: Char"]]
1324− docL41 = Position 41 1 ; doc = [ExpectHoverText ["Recognizable docs: kpqz"]]
1387+ fffL4 = _start fffR ; fffR = mkRange 8 4 8 7 ; fff = [ExpectRange fffR]
1388+ fffL8 = Position 12 4 ;
1389+ fffL14 = Position 18 7 ;
1390+ aaaL14 = Position 18 20 ; aaa = [mkR 11 0 11 3]
1391+ dcL7 = Position 11 11 ; tcDC = [mkR 7 23 9 16]
1392+ dcL12 = Position 16 11 ;
1393+ xtcL5 = Position 9 11 ; xtc = [ExpectExternFail, ExpectHoverText ["Int", "Defined in ‘GHC.Types’"]]
1394+ tcL6 = Position 10 11 ; tcData = [mkR 7 0 9 16, ExpectHoverText ["TypeConstructor", "GotoHover.hs:8:1"]]
1395+ vvL16 = Position 20 12 ; vv = [mkR 20 4 20 6]
1396+ opL16 = Position 20 15 ; op = [mkR 21 2 21 4]
1397+ opL18 = Position 22 22 ; opp = [mkR 22 13 22 17]
1398+ aL18 = Position 22 20 ; apmp = [mkR 22 10 22 11]
1399+ b'L19 = Position 23 13 ; bp = [mkR 23 6 23 7]
1400+ xvL20 = Position 24 8 ; xvMsg = [ExpectExternFail, ExpectHoverText ["Data.Text.pack", ":: String -> Text"]]
1401+ clL23 = Position 27 11 ; cls = [mkR 25 0 26 20, ExpectHoverText ["MyClass", "GotoHover.hs:26:1"]]
1402+ clL25 = Position 29 9
1403+ eclL15 = Position 19 8 ; ecls = [ExpectExternFail, ExpectHoverText ["Num", "Defined in ‘GHC.Num’"]]
1404+ dnbL29 = Position 33 18 ; dnb = [ExpectHoverText [":: ()"], mkR 33 12 33 21]
1405+ dnbL30 = Position 34 23
1406+ lcbL33 = Position 37 26 ; lcb = [ExpectHoverText [":: Char"], mkR 37 26 37 27]
1407+ lclL33 = Position 37 22
1408+ mclL36 = Position 40 1 ; mcl = [mkR 40 0 40 14]
1409+ mclL37 = Position 41 1
1410+ spaceL37 = Position 41 24 ; space = [ExpectNoDefinitions, ExpectHoverText [":: Char"]]
1411+ docL41 = Position 45 1 ; doc = [ExpectHoverText ["Recognizable docs: kpqz"]]
13251412 ; constr = [ExpectHoverText ["Monad m"]]
1326− eitL40 = Position 40 28 ; kindE = [ExpectHoverText [":: * -> * -> *\n"]]
1327− intL40 = Position 40 34 ; kindI = [ExpectHoverText [":: *\n"]]
1328− tvrL40 = Position 40 37 ; kindV = [ExpectHoverText [":: * -> *\n"]]
1329− intL41 = Position 41 20 ; litI = [ExpectHoverText ["7518"]]
1330− chrL36 = Position 37 24 ; litC = [ExpectHoverText ["'f'"]]
1331− txtL8 = Position 8 14 ; litT = [ExpectHoverText ["\"dfgy\""]]
1332− lstL43 = Position 43 12 ; litL = [ExpectHoverText ["[8391 :: Int, 6268]"]]
1333− outL45 = Position 45 3 ; outSig = [ExpectHoverText ["outer", "Bool"], mkR 46 0 46 5]
1334− innL48 = Position 48 5 ; innSig = [ExpectHoverText ["inner", "Char"], mkR 49 2 49 7]
1413+ eitL40 = Position 44 28 ; kindE = [ExpectHoverText [":: * -> * -> *\n"]]
1414+ intL40 = Position 44 34 ; kindI = [ExpectHoverText [":: *\n"]]
1415+ tvrL40 = Position 44 37 ; kindV = [ExpectHoverText [":: * -> *\n"]]
1416+ intL41 = Position 45 20 ; litI = [ExpectHoverText ["7518"]]
1417+ chrL36 = Position 41 24 ; litC = [ExpectHoverText ["'f'"]]
1418+ txtL8 = Position 12 14 ; litT = [ExpectHoverText ["\"dfgy\""]]
1419+ lstL43 = Position 47 12 ; litL = [ExpectHoverText ["[8391 :: Int, 6268]"]]
1420+ outL45 = Position 49 3 ; outSig = [ExpectHoverText ["outer", "Bool"], mkR 46 0 46 5]
1421+ innL48 = Position 52 5 ; innSig = [ExpectHoverText ["inner", "Char"], mkR 49 2 49 7]
1422+ imported = Position 56 13 ; importedSig = getDocUri "Foo.hs" >>= \foo -> return [ExpectHoverText ["foo", "Foo"], mkL foo 4 0 4 3]
1423+ reexported = Position 55 14 ; reexportedSig = getDocUri "Bar.hs" >>= \bar -> return [ExpectHoverText ["Bar", "Bar"], mkL bar 2 0 2 14]
13351424 in
13361425 mkFindTests
1337− -- def hover look expect
1338− [ test yes yes fffL4 fff "field in record definition"
1339− , test broken broken fffL8 fff "field in record construction #71"
1340− , test yes yes fffL14 fff "field name used as accessor" -- 120 in Calculate.hs
1341− , test yes yes aaaL14 aaa "top-level name" -- 120
1342− , test yes yes dcL7 tcDC "data constructor record #247"
1343− , test yes yes dcL12 tcDC "data constructor plain" -- 121
1344− , test yes yes tcL6 tcData "type constructor #248" -- 147
1345− , test broken yes xtcL5 xtc "type constructor external #248,249"
1346− , test broken yes xvL20 xvMsg "value external package #249" -- 120
1347− , test yes yes vvL16 vv "plain parameter" -- 120
1348− , test yes yes aL18 apmp "pattern match name" -- 120
1349− , test yes yes opL16 op "top-level operator" -- 120, 123
1350− , test yes yes opL18 opp "parameter operator" -- 120
1351− , test yes yes b'L19 bp "name in backticks" -- 120
1352− , test yes yes clL23 cls "class in instance declaration #250"
1353− , test yes yes clL25 cls "class in signature #250" -- 147
1354− , test broken yes eclL15 ecls "external class in signature #249,250"
1355− , test yes yes dnbL29 dnb "do-notation bind" -- 137
1356− , test yes yes dnbL30 dnb "do-notation lookup"
1357− , test yes yes lcbL33 lcb "listcomp bind" -- 137
1358− , test yes yes lclL33 lcb "listcomp lookup"
1359− , test yes yes mclL36 mcl "top-level fn 1st clause"
1360− , test yes yes mclL37 mcl "top-level fn 2nd clause #246"
1361− , test yes yes spaceL37 space "top-level fn on space #315"
1362− , test no broken docL41 doc "documentation #7"
1363− , test no yes eitL40 kindE "kind of Either #273"
1364− , test no yes intL40 kindI "kind of Int #273"
1365− , test no broken tvrL40 kindV "kind of (* -> *) type variable #273"
1366− , test no yes intL41 litI "literal Int in hover info #274"
1367− , test no yes chrL36 litC "literal Char in hover info #274"
1368− , test no yes txtL8 litT "literal Text in hover info #274"
1369− , test no yes lstL43 litL "literal List in hover info #274"
1370− , test no yes docL41 constr "type constraint in hover info #283"
1371− , test broken broken outL45 outSig "top-level signature #310"
1372− , test broken broken innL48 innSig "inner signature #310"
1426+ -- def hover look expect
1427+ [ test yes yes fffL4 fff "field in record definition"
1428+ , test broken broken fffL8 fff "field in record construction #71"
1429+ , test yes yes fffL14 fff "field name used as accessor" -- 120 in Calculate.hs
1430+ , test yes yes aaaL14 aaa "top-level name" -- 120
1431+ , test yes yes dcL7 tcDC "data constructor record #247"
1432+ , test yes yes dcL12 tcDC "data constructor plain" -- 121
1433+ , test yes yes tcL6 tcData "type constructor #248" -- 147
1434+ , test broken yes xtcL5 xtc "type constructor external #248,249"
1435+ , test broken yes xvL20 xvMsg "value external package #249" -- 120
1436+ , test yes yes vvL16 vv "plain parameter" -- 120
1437+ , test yes yes aL18 apmp "pattern match name" -- 120
1438+ , test yes yes opL16 op "top-level operator" -- 120, 123
1439+ , test yes yes opL18 opp "parameter operator" -- 120
1440+ , test yes yes b'L19 bp "name in backticks" -- 120
1441+ , test yes yes clL23 cls "class in instance declaration #250"
1442+ , test yes yes clL25 cls "class in signature #250" -- 147
1443+ , test broken yes eclL15 ecls "external class in signature #249,250"
1444+ , test yes yes dnbL29 dnb "do-notation bind" -- 137
1445+ , test yes yes dnbL30 dnb "do-notation lookup"
1446+ , test yes yes lcbL33 lcb "listcomp bind" -- 137
1447+ , test yes yes lclL33 lcb "listcomp lookup"
1448+ , test yes yes mclL36 mcl "top-level fn 1st clause"
1449+ , test yes yes mclL37 mcl "top-level fn 2nd clause #246"
1450+ , test yes yes spaceL37 space "top-level fn on space #315"
1451+ , test no broken docL41 doc "documentation #7"
1452+ , test no yes eitL40 kindE "kind of Either #273"
1453+ , test no yes intL40 kindI "kind of Int #273"
1454+ , test no broken tvrL40 kindV "kind of (* -> *) type variable #273"
1455+ , test no yes intL41 litI "literal Int in hover info #274"
1456+ , test no yes chrL36 litC "literal Char in hover info #274"
1457+ , test no yes txtL8 litT "literal Text in hover info #274"
1458+ , test no yes lstL43 litL "literal List in hover info #274"
1459+ , test no yes docL41 constr "type constraint in hover info #283"
1460+ , test broken broken outL45 outSig "top-level signature #310"
1461+ , test broken broken innL48 innSig "inner signature #310"
1462+ , testM yes yes imported importedSig "Imported symbol"
1463+ , testM yes yes reexported reexportedSig "Imported symbol (reexported)"
13731464 ]
13741465 where yes, broken :: (TestTree -> Maybe TestTree)
13751466 yes = Just -- test should run and pass
13761467 broken = Just . (`xfail` "known broken")
13771468 no = const Nothing -- don't run this test at all
13781469
1470+checkFileCompiles :: FilePath -> TestTree
1471+checkFileCompiles fp =
1472+ testSessionWithExtraFiles "hover" ("Does " ++ fp ++ " compile") $ \dir -> do
1473+ void (openTestDataDoc (dir </> fp))
1474+ expectNoMoreDiagnostics 0.5
1475+
1476+
1477+
13791478pluginTests :: TestTree
1380−pluginTests = testSessionWait "plugins" $ do
1479+pluginTests = (`xfail8101` "known broken (#556)")
1480+ $ testSessionWait "plugins" $ do
13811481 let content =
13821482 T.unlines
13831483 [ "{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}"
@@ -1391,7 +1491,7 @@ pluginTests = testSessionWait "plugins" $ do
13911491 , "foo :: Int -> Int -> Int"
13921492 , "foo a b = a + c"
13931493 ]
1394− _ <- openDoc' "Testing.hs" "haskell" content
1494+ _ <- createDoc "Testing.hs" "haskell" content
13951495 expectDiagnostics
13961496 [ ( "Testing.hs",
13971497 [(DsError, (8, 14), "Variable not in scope: c")]
@@ -1418,7 +1518,7 @@ cppTests =
14181518 run $ expectError content (2, 1)
14191519 )
14201520 , testSessionWait "cpp-ghcide" $ do
1421− _ <- openDoc' "A.hs" "haskell" $ T.unlines
1521+ _ <- createDoc "A.hs" "haskell" $ T.unlines
14221522 ["{-# LANGUAGE CPP #-}"
14231523 ,"main ="
14241524 ,"#ifdef __GHCIDE__"
@@ -1432,7 +1532,7 @@ cppTests =
14321532 where
14331533 expectError :: T.Text -> Cursor -> Session ()
14341534 expectError content cursor = do
1435− _ <- openDoc' "Testing.hs" "haskell" content
1535+ _ <- createDoc "Testing.hs" "haskell" content
14361536 expectDiagnostics
14371537 [ ( "Testing.hs",
14381538 [(DsError, cursor, "error: unterminated")]
@@ -1448,13 +1548,43 @@ preprocessorTests = testSessionWait "preprocessor" $ do
14481548 , "module Testing where"
14491549 , "y = x + z" -- plugin replaces x with y, making this have only one diagnostic
14501550 ]
1451− _ <- openDoc' "Testing.hs" "haskell" content
1551+ _ <- createDoc "Testing.hs" "haskell" content
14521552 expectDiagnostics
14531553 [ ( "Testing.hs",
14541554 [(DsError, (2, 8), "Variable not in scope: z")]
14551555 )
14561556 ]
14571557
1558+
1559+safeTests :: TestTree
1560+safeTests =
1561+ testGroup
1562+ "SafeHaskell"
1563+ [ -- Test for https://github.com/digital-asset/ghcide/issues/424
1564+ testSessionWait "load" $ do
1565+ let sourceA =
1566+ T.unlines
1567+ ["{-# LANGUAGE Trustworthy #-}"
1568+ ,"module A where"
1569+ ,"import System.IO.Unsafe"
1570+ ,"import System.IO"
1571+ ,"trustWorthyId :: a -> a"
1572+ ,"trustWorthyId i = unsafePerformIO $ do"
1573+ ," putStrLn \"I'm safe\""
1574+ ," return i"]
1575+ sourceB =
1576+ T.unlines
1577+ ["{-# LANGUAGE Safe #-}"
1578+ ,"module B where"
1579+ ,"import A"
1580+ ,"safeId :: a -> a"
1581+ ,"safeId = trustWorthyId"
1582+ ]
1583+
1584+ _ <- createDoc "A.hs" "haskell" sourceA
1585+ _ <- createDoc "B.hs" "haskell" sourceB
1586+ expectNoMoreDiagnostics 1 ]
1587+
14581588thTests :: TestTree
14591589thTests =
14601590 testGroup
@@ -1480,8 +1610,8 @@ thTests =
14801610 "b :: Integer",
14811611 "b = $(litE $ IntegerL $ a) + n"
14821612 ]
1483− _ <- openDoc' "A.hs" "haskell" sourceA
1484− _ <- openDoc' "B.hs" "haskell" sourceB
1613+ _ <- createDoc "A.hs" "haskell" sourceA
1614+ _ <- createDoc "B.hs" "haskell" sourceB
14851615 expectDiagnostics [ ( "B.hs", [(DsError, (6, 29), "Variable not in scope: n")] ) ]
14861616 , testSessionWait "newtype-closure" $ do
14871617 let sourceA =
@@ -1501,8 +1631,8 @@ thTests =
15011631 ,"import A"
15021632 ,"b :: Int"
15031633 ,"b = $( a )" ]
1504− _ <- openDoc' "A.hs" "haskell" sourceA
1505− _ <- openDoc' "B.hs" "haskell" sourceB
1634+ _ <- createDoc "A.hs" "haskell" sourceA
1635+ _ <- createDoc "B.hs" "haskell" sourceB
15061636 return ()
15071637 ]
15081638
@@ -1511,7 +1641,7 @@ completionTests
15111641 = testGroup "completion"
15121642 [ testSessionWait "variable" $ do
15131643 let source = T.unlines ["module A where", "f = hea"]
1514− docId <- openDoc' "A.hs" "haskell" source
1644+ docId <- createDoc "A.hs" "haskell" source
15151645 compls <- getCompletions docId (Position 1 7)
15161646 liftIO $ map dropDocs compls @?=
15171647 [complItem "head" (Just CiFunction) (Just "[a] -> a")]
@@ -1523,7 +1653,7 @@ completionTests
15231653 ]
15241654 , testSessionWait "constructor" $ do
15251655 let source = T.unlines ["module A where", "f = Tru"]
1526− docId <- openDoc' "A.hs" "haskell" source
1656+ docId <- createDoc "A.hs" "haskell" source
15271657 compls <- getCompletions docId (Position 1 7)
15281658 liftIO $ map dropDocs compls @?=
15291659 [ complItem "True" (Just CiConstructor) (Just "Bool")
@@ -1535,7 +1665,7 @@ completionTests
15351665 ]
15361666 , testSessionWait "type" $ do
15371667 let source = T.unlines ["{-# OPTIONS_GHC -Wall #-}", "module A () where", "f :: ()", "f = ()"]
1538− docId <- openDoc' "A.hs" "haskell" source
1668+ docId <- createDoc "A.hs" "haskell" source
15391669 expectDiagnostics [ ("A.hs", [(DsWarning, (3,0), "not used")]) ]
15401670 changeDoc docId [TextDocumentContentChangeEvent Nothing Nothing $ T.unlines ["{-# OPTIONS_GHC -Wall #-}", "module A () where", "f :: Bo", "f = True"]]
15411671 compls <- getCompletions docId (Position 2 7)
@@ -1552,7 +1682,7 @@ completionTests
15521682 checkDocText "Bool" boolDocs [ "Defined in 'Prelude'" ]
15531683 , testSessionWait "qualified" $ do
15541684 let source = T.unlines ["{-# OPTIONS_GHC -Wunused-binds #-}", "module A () where", "f = ()"]
1555− docId <- openDoc' "A.hs" "haskell" source
1685+ docId <- createDoc "A.hs" "haskell" source
15561686 expectDiagnostics [ ("A.hs", [(DsWarning, (2, 0), "not used")]) ]
15571687 changeDoc docId [TextDocumentContentChangeEvent Nothing Nothing $ T.unlines ["{-# OPTIONS_GHC -Wunused-binds #-}", "module A () where", "f = Prelude.hea"]]
15581688 compls <- getCompletions docId (Position 2 15)
@@ -1566,9 +1696,30 @@ completionTests
15661696 ]
15671697 , testSessionWait "keyword" $ do
15681698 let source = T.unlines ["module A where", "f = newty"]
1569− docId <- openDoc' "A.hs" "haskell" source
1699+ docId <- createDoc "A.hs" "haskell" source
15701700 compls <- getCompletions docId (Position 1 9)
15711701 liftIO $ compls @?= [keywordItem "newtype"]
1702+ , testSessionWait "type context" $ do
1703+ let source = T.unlines
1704+ [ "{-# OPTIONS_GHC -Wunused-binds #-}"
1705+ , "module A () where"
1706+ , "f = f"
1707+ ]
1708+ docId <- createDoc "A.hs" "haskell" source
1709+ expectDiagnostics [("A.hs", [(DsWarning, (2, 0), "not used")])]
1710+ changeDoc docId
1711+ [ TextDocumentContentChangeEvent Nothing Nothing $ T.unlines
1712+ [ "{-# OPTIONS_GHC -Wunused-binds #-}"
1713+ , "module A () where"
1714+ , "f = f"
1715+ , "g :: Intege"
1716+ ]
1717+ ]
1718+ -- At this point the module parses but does not typecheck.
1719+ -- This should be sufficient to detect that we are in a
1720+ -- type context and only show the completion to the type.
1721+ compls <- getCompletions docId (Position 3 11)
1722+ liftIO $ map dropDocs compls @?= [complItem "Integer"(Just CiStruct) (Just "*")]
15721723 ]
15731724 where
15741725 dropDocs :: CompletionItem -> CompletionItem
@@ -1576,6 +1727,7 @@ completionTests
15761727 complItem label kind ty = CompletionItem
15771728 { _label = label
15781729 , _kind = kind
1730+ , _tags = List []
15791731 , _detail = (":: " <>) <$> ty
15801732 , _documentation = Nothing
15811733 , _deprecated = Nothing
@@ -1593,6 +1745,7 @@ completionTests
15931745 keywordItem label = CompletionItem
15941746 { _label = label
15951747 , _kind = Just CiKeyword
1748+ , _tags = List []
15961749 , _detail = Nothing
15971750 , _documentation = Nothing
15981751 , _deprecated = Nothing
@@ -1620,7 +1773,7 @@ outlineTests = testGroup
16201773 "outline"
16211774 [ testSessionWait "type class" $ do
16221775 let source = T.unlines ["module A where", "class A a where a :: a -> Bool"]
1623− docId <- openDoc' "A.hs" "haskell" source
1776+ docId <- createDoc "A.hs" "haskell" source
16241777 symbols <- getDocumentSymbols docId
16251778 liftIO $ symbols @?= Left
16261779 [ moduleSymbol
@@ -1633,7 +1786,7 @@ outlineTests = testGroup
16331786 ]
16341787 , testSessionWait "type class instance " $ do
16351788 let source = T.unlines ["class A a where", "instance A () where"]
1636− docId <- openDoc' "A.hs" "haskell" source
1789+ docId <- createDoc "A.hs" "haskell" source
16371790 symbols <- getDocumentSymbols docId
16381791 liftIO $ symbols @?= Left
16391792 [ classSymbol "A a" (R 0 0 0 15) []
@@ -1641,7 +1794,7 @@ outlineTests = testGroup
16411794 ]
16421795 , testSessionWait "type family" $ do
16431796 let source = T.unlines ["{-# language TypeFamilies #-}", "type family A"]
1644− docId <- openDoc' "A.hs" "haskell" source
1797+ docId <- createDoc "A.hs" "haskell" source
16451798 symbols <- getDocumentSymbols docId
16461799 liftIO $ symbols @?= Left [docSymbolD "A" "type family" SkClass (R 1 0 1 13)]
16471800 , testSessionWait "type family instance " $ do
@@ -1650,7 +1803,7 @@ outlineTests = testGroup
16501803 , "type family A a"
16511804 , "type instance A () = ()"
16521805 ]
1653− docId <- openDoc' "A.hs" "haskell" source
1806+ docId <- createDoc "A.hs" "haskell" source
16541807 symbols <- getDocumentSymbols docId
16551808 liftIO $ symbols @?= Left
16561809 [ docSymbolD "A a" "type family" SkClass (R 1 0 1 15)
@@ -1658,7 +1811,7 @@ outlineTests = testGroup
16581811 ]
16591812 , testSessionWait "data family" $ do
16601813 let source = T.unlines ["{-# language TypeFamilies #-}", "data family A"]
1661− docId <- openDoc' "A.hs" "haskell" source
1814+ docId <- createDoc "A.hs" "haskell" source
16621815 symbols <- getDocumentSymbols docId
16631816 liftIO $ symbols @?= Left [docSymbolD "A" "data family" SkClass (R 1 0 1 11)]
16641817 , testSessionWait "data family instance " $ do
@@ -1667,7 +1820,7 @@ outlineTests = testGroup
16671820 , "data family A a"
16681821 , "data instance A () = A ()"
16691822 ]
1670− docId <- openDoc' "A.hs" "haskell" source
1823+ docId <- createDoc "A.hs" "haskell" source
16711824 symbols <- getDocumentSymbols docId
16721825 liftIO $ symbols @?= Left
16731826 [ docSymbolD "A a" "data family" SkClass (R 1 0 1 11)
@@ -1675,36 +1828,36 @@ outlineTests = testGroup
16751828 ]
16761829 , testSessionWait "constant" $ do
16771830 let source = T.unlines ["a = ()"]
1678− docId <- openDoc' "A.hs" "haskell" source
1831+ docId <- createDoc "A.hs" "haskell" source
16791832 symbols <- getDocumentSymbols docId
16801833 liftIO $ symbols @?= Left
16811834 [docSymbol "a" SkFunction (R 0 0 0 6)]
16821835 , testSessionWait "pattern" $ do
16831836 let source = T.unlines ["Just foo = Just 21"]
1684− docId <- openDoc' "A.hs" "haskell" source
1837+ docId <- createDoc "A.hs" "haskell" source
16851838 symbols <- getDocumentSymbols docId
16861839 liftIO $ symbols @?= Left
16871840 [docSymbol "Just foo" SkFunction (R 0 0 0 18)]
16881841 , testSessionWait "pattern with type signature" $ do
16891842 let source = T.unlines ["{-# language ScopedTypeVariables #-}", "a :: () = ()"]
1690− docId <- openDoc' "A.hs" "haskell" source
1843+ docId <- createDoc "A.hs" "haskell" source
16911844 symbols <- getDocumentSymbols docId
16921845 liftIO $ symbols @?= Left
16931846 [docSymbol "a :: ()" SkFunction (R 1 0 1 12)]
16941847 , testSessionWait "function" $ do
16951848 let source = T.unlines ["a x = ()"]
1696− docId <- openDoc' "A.hs" "haskell" source
1849+ docId <- createDoc "A.hs" "haskell" source
16971850 symbols <- getDocumentSymbols docId
16981851 liftIO $ symbols @?= Left [docSymbol "a" SkFunction (R 0 0 0 8)]
16991852 , testSessionWait "type synonym" $ do
17001853 let source = T.unlines ["type A = Bool"]
1701− docId <- openDoc' "A.hs" "haskell" source
1854+ docId <- createDoc "A.hs" "haskell" source
17021855 symbols <- getDocumentSymbols docId
17031856 liftIO $ symbols @?= Left
17041857 [docSymbol' "A" SkTypeParameter (R 0 0 0 13) (R 0 5 0 6)]
17051858 , testSessionWait "datatype" $ do
17061859 let source = T.unlines ["data A = C"]
1707− docId <- openDoc' "A.hs" "haskell" source
1860+ docId <- createDoc "A.hs" "haskell" source
17081861 symbols <- getDocumentSymbols docId
17091862 liftIO $ symbols @?= Left
17101863 [ docSymbolWithChildren "A"
@@ -1712,27 +1865,39 @@ outlineTests = testGroup
17121865 (R 0 0 0 10)
17131866 [docSymbol "C" SkConstructor (R 0 9 0 10)]
17141867 ]
1868+ , testSessionWait "record fields" $ do
1869+ let source = T.unlines ["data A = B {", " x :: Int", " , y :: Int}"]
1870+ docId <- createDoc "A.hs" "haskell" source
1871+ symbols <- getDocumentSymbols docId
1872+ liftIO $ symbols @=? Left
1873+ [ docSymbolWithChildren "A" SkStruct (R 0 0 2 13)
1874+ [ docSymbolWithChildren' "B" SkConstructor (R 0 9 2 13) (R 0 9 0 10)
1875+ [ docSymbol "x" SkField (R 1 2 1 3)
1876+ , docSymbol "y" SkField (R 2 4 2 5)
1877+ ]
1878+ ]
1879+ ]
17151880 , testSessionWait "import" $ do
17161881 let source = T.unlines ["import Data.Maybe"]
1717− docId <- openDoc' "A.hs" "haskell" source
1882+ docId <- createDoc "A.hs" "haskell" source
17181883 symbols <- getDocumentSymbols docId
17191884 liftIO $ symbols @?= Left
1720− [docSymbolWithChildren "imports"
1721− SkModule
1885+ [docSymbolWithChildren "imports"
1886+ SkModule
17221887 (R 0 0 0 17)
1723− [ docSymbol "import Data.Maybe" SkModule (R 0 0 0 17)
1888+ [ docSymbol "import Data.Maybe" SkModule (R 0 0 0 17)
17241889 ]
17251890 ]
17261891 , testSessionWait "multiple import" $ do
17271892 let source = T.unlines ["", "import Data.Maybe", "", "import Control.Exception", ""]
1728− docId <- openDoc' "A.hs" "haskell" source
1893+ docId <- createDoc "A.hs" "haskell" source
17291894 symbols <- getDocumentSymbols docId
17301895 liftIO $ symbols @?= Left
1731− [docSymbolWithChildren "imports"
1732− SkModule
1896+ [docSymbolWithChildren "imports"
1897+ SkModule
17331898 (R 1 0 3 24)
17341899 [ docSymbol "import Data.Maybe" SkModule (R 1 0 1 17)
1735− , docSymbol "import Control.Exception" SkModule (R 3 0 3 24)
1900+ , docSymbol "import Control.Exception" SkModule (R 3 0 3 24)
17361901 ]
17371902 ]
17381903 , testSessionWait "foreign import" $ do
@@ -1740,7 +1905,7 @@ outlineTests = testGroup
17401905 [ "{-# language ForeignFunctionInterface #-}"
17411906 , "foreign import ccall \"a\" a :: Int"
17421907 ]
1743− docId <- openDoc' "A.hs" "haskell" source
1908+ docId <- createDoc "A.hs" "haskell" source
17441909 symbols <- getDocumentSymbols docId
17451910 liftIO $ symbols @?= Left [docSymbolD "a" "import" SkObject (R 1 0 1 33)]
17461911 , testSessionWait "foreign export" $ do
@@ -1748,7 +1913,7 @@ outlineTests = testGroup
17481913 [ "{-# language ForeignFunctionInterface #-}"
17491914 , "foreign export ccall odd :: Int -> Bool"
17501915 ]
1751− docId <- openDoc' "A.hs" "haskell" source
1916+ docId <- createDoc "A.hs" "haskell" source
17521917 symbols <- getDocumentSymbols docId
17531918 liftIO $ symbols @?= Left [docSymbolD "odd" "export" SkObject (R 1 0 1 39)]
17541919 ]
@@ -1761,6 +1926,8 @@ outlineTests = testGroup
17611926 DocumentSymbol name (Just detail) kind Nothing loc loc Nothing
17621927 docSymbolWithChildren name kind loc cc =
17631928 DocumentSymbol name Nothing kind Nothing loc loc (Just $ List cc)
1929+ docSymbolWithChildren' name kind loc selectionLoc cc =
1930+ DocumentSymbol name Nothing kind Nothing loc selectionLoc (Just $ List cc)
17641931 moduleSymbol name loc cc = DocumentSymbol name
17651932 Nothing
17661933 SkFile
@@ -1782,8 +1949,16 @@ pattern R x y x' y' = Range (Position x y) (Position x' y')
17821949xfail :: TestTree -> String -> TestTree
17831950xfail = flip expectFailBecause
17841951
1952+xfail8101 :: TestTree -> String -> TestTree
1953+#if MIN_GHC_API_VERSION(8,10,0)
1954+xfail8101 = flip expectFailBecause
1955+#else
1956+xfail8101 t _ = t
1957+#endif
1958+
17851959data Expect
17861960 = ExpectRange Range -- Both gotoDef and hover should report this range
1961+ | ExpectLocation Location
17871962-- | ExpectDefRange Range -- Only gotoDef should report this range
17881963 | ExpectHoverRange Range -- Only hover should report this range
17891964 | ExpectHoverText [T.Text] -- the hover message must contain these snippets
@@ -1796,6 +1971,9 @@ data Expect
17961971mkR :: Int -> Int -> Int -> Int -> Expect
17971972mkR startLine startColumn endLine endColumn = ExpectRange $ mkRange startLine startColumn endLine endColumn
17981973
1974+mkL :: Uri -> Int -> Int -> Int -> Int -> Expect
1975+mkL uri startLine startColumn endLine endColumn = ExpectLocation $ Location uri $ mkRange startLine startColumn endLine endColumn
1976+
17991977haddockTests :: TestTree
18001978haddockTests
18011979 = testGroup "haddock"
@@ -1851,6 +2029,129 @@ haddockTests
18512029 where
18522030 checkHaddock s txt = spanDocToMarkdownForTest s @?= txt
18532031
2032+cradleTests :: TestTree
2033+cradleTests = testGroup "cradle"
2034+ [testGroup "dependencies" [sessionDepsArePickedUp]
2035+ ,testGroup "loading" [loadCradleOnlyonce]
2036+ ,testGroup "multi" [simpleMultiTest, simpleMultiTest2]
2037+ ]
2038+
2039+loadCradleOnlyonce :: TestTree
2040+loadCradleOnlyonce = testGroup "load cradle only once"
2041+ [ testSession' "implicit" implicit
2042+ , testSession' "direct" direct
2043+ ]
2044+ where
2045+ direct dir = do
2046+ liftIO $ writeFileUTF8 (dir </> "hie.yaml")
2047+ "cradle: {direct: {arguments: []}}"
2048+ test dir
2049+ implicit dir = test dir
2050+ test _dir = do
2051+ doc <- createDoc "B.hs" "haskell" "module B where\nimport Data.Foo"
2052+ msgs <- someTill (skipManyTill anyMessage cradleLoadedMessage) (skipManyTill anyMessage (message @PublishDiagnosticsNotification))
2053+ liftIO $ length msgs @?= 1
2054+ changeDoc doc [TextDocumentContentChangeEvent Nothing Nothing "module B where\nimport Data.Maybe"]
2055+ msgs <- manyTill (skipManyTill anyMessage cradleLoadedMessage) (skipManyTill anyMessage (message @PublishDiagnosticsNotification))
2056+ liftIO $ length msgs @?= 0
2057+ _ <- createDoc "A.hs" "haskell" "module A where\nimport LoadCradleBar"
2058+ msgs <- manyTill (skipManyTill anyMessage cradleLoadedMessage) (skipManyTill anyMessage (message @PublishDiagnosticsNotification))
2059+ liftIO $ length msgs @?= 0
2060+
2061+
2062+dependentFileTest :: TestTree
2063+dependentFileTest = testGroup "addDependentFile"
2064+ [testGroup "file-changed" [testSession' "test" test]
2065+ ]
2066+ where
2067+ test dir = do
2068+ -- If the file contains B then no type error
2069+ -- otherwise type error
2070+ liftIO $ writeFile (dir </> "dep-file.txt") "A"
2071+ let fooContent = T.unlines
2072+ [ "{-# LANGUAGE TemplateHaskell #-}"
2073+ , "module Foo where"
2074+ , "import Language.Haskell.TH.Syntax"
2075+ , "foo :: Int"
2076+ , "foo = 1 + $(do"
2077+ , " qAddDependentFile \"dep-file.txt\""
2078+ , " f <- qRunIO (readFile \"dep-file.txt\")"
2079+ , " if f == \"B\" then [| 1 |] else lift f)"
2080+ ]
2081+ let bazContent = T.unlines ["module Baz where", "import Foo"]
2082+ _ <-createDoc "Foo.hs" "haskell" fooContent
2083+ doc <- createDoc "Baz.hs" "haskell" bazContent
2084+ expectDiagnostics
2085+ [("Foo.hs", [(DsError, (4, 6), "Couldn't match expected type")])]
2086+ -- Now modify the dependent file
2087+ liftIO $ writeFile (dir </> "dep-file.txt") "B"
2088+ let change = TextDocumentContentChangeEvent
2089+ { _range = Just (Range (Position 2 0) (Position 2 6))
2090+ , _rangeLength = Nothing
2091+ , _text = "f = ()"
2092+ }
2093+ -- Modifying Baz will now trigger Foo to be rebuilt as well
2094+ changeDoc doc [change]
2095+ expectDiagnostics [("Foo.hs", [])]
2096+
2097+
2098+cradleLoadedMessage :: Session FromServerMessage
2099+cradleLoadedMessage = satisfy $ \case
2100+ NotCustomServer (NotificationMessage _ (CustomServerMethod m) _) -> m == cradleLoadedMethod
2101+ _ -> False
2102+
2103+cradleLoadedMethod :: T.Text
2104+cradleLoadedMethod = "ghcide/cradle/loaded"
2105+
2106+-- Stack sets this which trips up cabal in the multi-component tests.
2107+-- However, our plugin tests rely on those env vars so we unset it locally.
2108+withoutStackEnv :: IO a -> IO a
2109+withoutStackEnv s =
2110+ bracket
2111+ (mapM getEnv vars >>= \prevState -> mapM_ unsetEnv vars >> pure prevState)
2112+ (\prevState -> mapM_ (\(var, value) -> restore var value) (zip vars prevState))
2113+ (const s)
2114+ where vars =
2115+ [ "GHC_PACKAGE_PATH"
2116+ , "GHC_ENVIRONMENT"
2117+ , "HASKELL_DIST_DIR"
2118+ , "HASKELL_PACKAGE_SANDBOX"
2119+ , "HASKELL_PACKAGE_SANDBOXES"
2120+ ]
2121+ restore var Nothing = unsetEnv var
2122+ restore var (Just val) = setEnv var val True
2123+
2124+simpleMultiTest :: TestTree
2125+simpleMultiTest = testCase "simple-multi-test" $ withoutStackEnv $ runWithExtraFiles "multi" $ \dir -> do
2126+ let aPath = dir </> "a/A.hs"
2127+ bPath = dir </> "b/B.hs"
2128+ aSource <- liftIO $ readFileUtf8 aPath
2129+ (TextDocumentIdentifier adoc) <- createDoc aPath "haskell" aSource
2130+ expectNoMoreDiagnostics 0.5
2131+ bSource <- liftIO $ readFileUtf8 bPath
2132+ bdoc <- createDoc bPath "haskell" bSource
2133+ expectNoMoreDiagnostics 0.5
2134+ locs <- getDefinitions bdoc (Position 2 7)
2135+ let fooL = mkL adoc 2 0 2 3
2136+ checkDefs locs (pure [fooL])
2137+ expectNoMoreDiagnostics 0.5
2138+
2139+-- Like simpleMultiTest but open the files in the other order
2140+simpleMultiTest2 :: TestTree
2141+simpleMultiTest2 = testCase "simple-multi-test2" $ withoutStackEnv $ runWithExtraFiles "multi" $ \dir -> do
2142+ let aPath = dir </> "a/A.hs"
2143+ bPath = dir </> "b/B.hs"
2144+ bSource <- liftIO $ readFileUtf8 bPath
2145+ bdoc <- createDoc bPath "haskell" bSource
2146+ expectNoMoreDiagnostics 5
2147+ aSource <- liftIO $ readFileUtf8 aPath
2148+ (TextDocumentIdentifier adoc) <- createDoc aPath "haskell" aSource
2149+ -- Need to have some delay here or the test fails
2150+ expectNoMoreDiagnostics 5
2151+ locs <- getDefinitions bdoc (Position 2 7)
2152+ let fooL = mkL adoc 2 0 2 3
2153+ checkDefs locs (pure [fooL])
2154+ expectNoMoreDiagnostics 0.5
18542155
18552156sessionDepsArePickedUp :: TestTree
18562157sessionDepsArePickedUp = testSession'
@@ -1861,7 +2162,7 @@ sessionDepsArePickedUp = testSession'
18612162 (dir </> "hie.yaml")
18622163 "cradle: {direct: {arguments: []}}"
18632164 -- Open without OverloadedStrings and expect an error.
1864− doc <- openDoc' "Foo.hs" "haskell" fooContent
2165+ doc <- createDoc "Foo.hs" "haskell" fooContent
18652166 expectDiagnostics
18662167 [("Foo.hs", [(DsError, (3, 6), "Couldn't match expected type")])]
18672168 -- Update hie.yaml to enable OverloadedStrings.
@@ -1896,6 +2197,9 @@ sessionDepsArePickedUp = testSession'
18962197testSession :: String -> Session () -> TestTree
18972198testSession name = testCase name . run
18982199
2200+testSessionWithExtraFiles :: FilePath -> String -> (FilePath -> Session ()) -> TestTree
2201+testSessionWithExtraFiles prefix name = testCase name . runWithExtraFiles prefix
2202+
18992203testSession' :: String -> (FilePath -> Session ()) -> TestTree
19002204testSession' name = testCase name . run'
19012205
@@ -1909,11 +2213,20 @@ testSessionWait name = testSession name .
19092213 -- Experimentally, 0.5s seems to be long enough to wait for any final diagnostics to appear.
19102214 ( >> expectNoMoreDiagnostics 0.5)
19112215
1912−pickActionWithTitle :: T.Text -> [CAResult] -> CodeAction
1913−pickActionWithTitle title actions = head
1914− [ action
1915− | CACodeAction action@CodeAction{ _title = actionTitle } <- actions
1916− , title == actionTitle ]
2216+pickActionWithTitle :: T.Text -> [CAResult] -> IO CodeAction
2217+pickActionWithTitle title actions = do
2218+ assertBool ("Found no matching actions: " <> show titles) (not $ null matches)
2219+ return $ head matches
2220+ where
2221+ titles =
2222+ [ actionTitle
2223+ | CACodeAction CodeAction { _title = actionTitle } <- actions
2224+ ]
2225+ matches =
2226+ [ action
2227+ | CACodeAction action@CodeAction { _title = actionTitle } <- actions
2228+ , title == actionTitle
2229+ ]
19172230
19182231mkRange :: Int -> Int -> Int -> Int -> Range
19192232mkRange a b c d = Range (Position a b) (Position c d)
@@ -1921,6 +2234,19 @@ mkRange a b c d = Range (Position a b) (Position c d)
19212234run :: Session a -> IO a
19222235run s = withTempDir $ \dir -> runInDir dir s
19232236
2237+runWithExtraFiles :: FilePath -> (FilePath -> Session a) -> IO a
2238+runWithExtraFiles prefix s = withTempDir $ \dir -> do
2239+ copyTestDataFiles dir prefix
2240+ runInDir dir (s dir)
2241+
2242+copyTestDataFiles :: FilePath -> FilePath -> IO ()
2243+copyTestDataFiles dir prefix = do
2244+ -- Copy all the test data files to the temporary workspace
2245+ testDataFiles <- getDirectoryFilesIO ("test/data" </> prefix) ["//*"]
2246+ for_ testDataFiles $ \f -> do
2247+ createDirectoryIfMissing True $ dir </> takeDirectory f
2248+ copyFile ("test/data" </> prefix </> f) (dir </> f)
2249+
19242250run' :: (FilePath -> Session a) -> IO a
19252251run' s = withTempDir $ \dir -> runInDir dir (s dir)
19262252
@@ -1932,7 +2258,8 @@ runInDir dir s = do
19322258 -- since the package import test creates "Data/List.hs", which otherwise has no physical home
19332259 createDirectoryIfMissing True $ dir ++ "/Data"
19342260
1935− let cmd = unwords [ghcideExe, "--lsp", "--cwd", dir]
2261+
2262+ let cmd = unwords [ghcideExe, "--lsp", "--test", "--cwd", dir]
19362263 -- HIE calls getXgdDirectory which assumes that HOME is set.
19372264 -- Only sets HOME if it wasn't already set.
19382265 setEnv "HOME" "/homeless-shelter" False
@@ -1949,7 +2276,7 @@ runInDir dir s = do
19492276openTestDataDoc :: FilePath -> Session TextDocumentIdentifier
19502277openTestDataDoc path = do
19512278 source <- liftIO $ readFileUtf8 $ "test/data" </> path
1952− openDoc' path "haskell" source
2279+ createDoc path "haskell" source
19532280
19542281findCodeActions :: TextDocumentIdentifier -> Range -> [T.Text] -> Session [CodeAction]
19552282findCodeActions doc range expectedTitles = do
@@ -1977,24 +2304,19 @@ findCodeAction doc range t = head <$> findCodeActions doc range [t]
19772304unitTests :: TestTree
19782305unitTests = do
19792306 testGroup "Unit"
1980− [ testCase "empty file path" $
1981− uriToFilePath' (fromNormalizedUri $ filePathToUri' "") @?= Just ""
2307+ [ testCase "empty file path does NOT work with the empty String literal" $
2308+ uriToFilePath' (fromNormalizedUri $ filePathToUri' "") @?= Just "."
2309+ , testCase "empty file path works using toNormalizedFilePath'" $
2310+ uriToFilePath' (fromNormalizedUri $ filePathToUri' (toNormalizedFilePath' "")) @?= Just ""
2311+ , testCase "empty path URI" $ do
2312+ Just URI{..} <- pure $ parseURI (T.unpack $ getUri $ fromNormalizedUri emptyPathUri)
2313+ uriScheme @?= "file:"
2314+ uriPath @?= ""
2315+ , testCase "from empty path URI" $ do
2316+ let uri = Uri "file://"
2317+ uriToFilePath' uri @?= Just ""
19822318 ]
19832319
1984−-- | Wrapper around 'LSPTest.openDoc'' that sends file creation events
1985−openDoc' :: FilePath -> String -> T.Text -> Session TextDocumentIdentifier
1986−openDoc' fp name contents = do
1987− res@(TextDocumentIdentifier uri) <- LSPTest.openDoc' fp name contents
1988− -- Needed as ghcide sets up and relies on WatchedFiles but lsp-test does not track them
1989− sendNotification WorkspaceDidChangeWatchedFiles (DidChangeWatchedFilesParams $ List [FileEvent uri FcCreated])
1990− return res
1991−
1992−-- | Version of 'LSPTest.openDoc'' that does not send WatchedFiles events for files outside the workspace
1993−openDoc'' :: FilePath -> String -> T.Text -> Session TextDocumentIdentifier
1994−-- At the moment this is just LSPTest.openDoc' but it may change in the future
1995−-- when/if lsp-test implements WatchedFiles
1996−openDoc'' = LSPTest.openDoc'
1997−
19982320positionMappingTests :: TestTree
19992321positionMappingTests =
20002322 testGroup "position mapping"
@@ -2163,3 +2485,12 @@ nthLine i r
21632485 | i == 0 && Rope.rows r == 0 = r
21642486 | i >= Rope.rows r = error $ "Row number out of bounds: " <> show i <> "/" <> show (Rope.rows r)
21652487 | otherwise = Rope.takeWhile (/= '\n') $ fst $ Rope.splitAtLine 1 $ snd $ Rope.splitAtLine (i - 1) r
2488+
2489+getWatchedFilesSubscriptionsUntil :: forall end . (FromJSON end, Typeable end) => Session [Maybe Value]
2490+getWatchedFilesSubscriptionsUntil = do
2491+ msgs <- manyTill (Just <$> message @RegisterCapabilityRequest <|> Nothing <$ anyMessage) (message @end)
2492+ return
2493+ [ args
2494+ | Just RequestMessage{_params = RegistrationParams (List regs)} <- msgs
2495+ , Registration _id WorkspaceDidChangeWatchedFiles args <- regs
2496+ ]