@@ -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,29 +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.Aeson (Value)
16−import Data.Char (toLower)
17+import Data.Aeson (FromJSON, Value)
1718import Data.Foldable
18−import Data.List
19+import Data.List.Extra
1920import Data.Rope.UTF16 (Rope)
2021import qualified Data.Rope.UTF16 as Rope
2122import Development.IDE.Core.PositionMapping (fromCurrent, toCurrent)
2223import Development.IDE.GHC.Util
2324import qualified Data.Text as T
25+import Data.Typeable
2426import Development.IDE.Spans.Common
2527import Development.IDE.Test
2628import Development.IDE.Test.Runfiles
2729import Development.IDE.Types.Location
28−import qualified Language.Haskell.LSP.Test as LSPTest
29−import Language.Haskell.LSP.Test hiding (openDoc')
30+import Development.Shake (getDirectoryFilesIO)
31+import Language.Haskell.LSP.Test
3032import Language.Haskell.LSP.Messages
3133import Language.Haskell.LSP.Types
3234import Language.Haskell.LSP.Types.Capabilities
35+import qualified Language.Haskell.LSP.Types.Lens as Lsp (diagnostics, params, message)
3336import Language.Haskell.LSP.VFS (applyChange)
34−import System.Environment.Blank (setEnv)
37+import Network.URI
38+import System.Environment.Blank (getEnv, setEnv, unsetEnv)
3539import System.FilePath
3640import System.IO.Extra
3741import System.Directory
@@ -39,35 +43,41 @@ import Test.QuickCheck
3943import Test.QuickCheck.Instances ()
4044import Test.Tasty
4145import Test.Tasty.ExpectedFailure
46+import Test.Tasty.Ingredients.Rerun
4247import Test.Tasty.HUnit
4348import Test.Tasty.QuickCheck
4449import Data.Maybe
4550
4651main :: IO ()
47−main = defaultMain $ testGroup "HIE"
48− [ testSession "open close" $ do
49− doc <- openDoc' "Testing.hs" "haskell" ""
50− void (skipManyTill anyMessage message :: Session WorkDoneProgressCreateRequest)
51− void (skipManyTill anyMessage message :: Session WorkDoneProgressBeginNotification)
52− closeDoc doc
53− void (skipManyTill anyMessage message :: Session WorkDoneProgressEndNotification)
54− , initializeResponseTests
55− , completionTests
56− , cppTests
57− , diagnosticTests
58− , codeActionTests
59− , codeLensesTests
60− , outlineTests
61− , findDefinitionAndHoverTests
62− , pluginTests
63− , preprocessorTests
64− , thTests
65− , unitTests
66− , haddockTests
67− , positionMappingTests
68− , watchedFilesTests
69− , cradleTests
70− ]
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+ ]
7181
7282initializeResponseTests :: TestTree
7383initializeResponseTests = withResource acquire release tests where
@@ -102,7 +112,7 @@ initializeResponseTests = withResource acquire release tests where
102112 , chk "NO doc link" _documentLinkProvider Nothing
103113 , chk "NO color" _colorProvider (Just $ ColorOptionsStatic False)
104114 , chk "NO folding range" _foldingRangeProvider (Just $ FoldingRangeOptionsStatic False)
105− , chk " execute command" _executeCommandProvider (Just $ ExecuteCommandOptions $ List ["typesignature.add"])
115+ , che " execute command" _executeCommandProvider (Just $ ExecuteCommandOptions $ List ["typesignature.add"])
106116 , chk " workspace" _workspace (Just $ WorkspaceOptions (Just WorkspaceFolderOptions{_supported = Just True, _changeNotifications = Just ( WorkspaceFolderChangeNotificationsBool True )}))
107117 , chk "NO experimental" _experimental Nothing
108118 ] where
@@ -118,8 +128,17 @@ initializeResponseTests = withResource acquire release tests where
118128 chk title getActual expected =
119129 testCase title $ getInitializeResponse >>= \ir -> expected @=? (getActual . innerCaps) ir
120130
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+
121140 innerCaps :: InitializeResponse -> InitializeResponseCapabilitiesInner
122− innerCaps (ResponseMessage _ _ (Just (InitializeResponseCapabilities c)) _) = c
141+ innerCaps (ResponseMessage _ _ (Right (InitializeResponseCapabilities c))) = c
123142 innerCaps _ = error "this test only expects inner capabilities"
124143
125144 acquire :: IO InitializeResponse
@@ -133,7 +152,7 @@ diagnosticTests :: TestTree
133152diagnosticTests = testGroup "diagnostics"
134153 [ testSessionWait "fix syntax error" $ do
135154 let content = T.unlines [ "module Testing wher" ]
136− doc <- openDoc' "Testing.hs" "haskell" content
155+ doc <- createDoc "Testing.hs" "haskell" content
137156 expectDiagnostics [("Testing.hs", [(DsError, (0, 15), "parse error")])]
138157 let change = TextDocumentContentChangeEvent
139158 { _range = Just (Range (Position 0 15) (Position 0 19))
@@ -144,7 +163,7 @@ diagnosticTests = testGroup "diagnostics"
144163 expectDiagnostics [("Testing.hs", [])]
145164 , testSessionWait "introduce syntax error" $ do
146165 let content = T.unlines [ "module Testing where" ]
147− doc <- openDoc' "Testing.hs" "haskell" content
166+ doc <- createDoc "Testing.hs" "haskell" content
148167 void $ skipManyTill anyMessage (message :: Session WorkDoneProgressCreateRequest)
149168 void $ skipManyTill anyMessage (message :: Session WorkDoneProgressBeginNotification)
150169 let change = TextDocumentContentChangeEvent
@@ -162,7 +181,7 @@ diagnosticTests = testGroup "diagnostics"
162181 , "bar :: Int -> Int -> Int"
163182 , "bar a b = cd + b"
164183 ]
165− _ <- openDoc' "Testing.hs" "haskell" content
184+ _ <- createDoc "Testing.hs" "haskell" content
166185 expectDiagnostics
167186 [ ( "Testing.hs"
168187 , [ (DsError, (2, 14), "Variable not in scope: ab")
@@ -176,7 +195,7 @@ diagnosticTests = testGroup "diagnostics"
176195 , "foo :: Int -> String -> Int"
177196 , "foo a b = a + b"
178197 ]
179− _ <- openDoc' "Testing.hs" "haskell" content
198+ _ <- createDoc "Testing.hs" "haskell" content
180199 expectDiagnostics
181200 [ ( "Testing.hs"
182201 , [(DsError, (2, 14), "Couldn't match type '[Char]' with 'Int'")]
@@ -188,7 +207,7 @@ diagnosticTests = testGroup "diagnostics"
188207 , "foo :: Int -> String"
189208 , "foo a = _ a"
190209 ]
191− _ <- openDoc' "Testing.hs" "haskell" content
210+ _ <- createDoc "Testing.hs" "haskell" content
192211 expectDiagnostics
193212 [ ( "Testing.hs"
194213 , [(DsError, (2, 8), "Found hole: _ :: Int -> String")]
@@ -210,24 +229,23 @@ diagnosticTests = testGroup "diagnostics"
210229 [ ("A.hs", [(DsError, (2,4), aMessage)])
211230 , ("B.hs", [(DsError, (3,4), bMessage)])]
212231 deferralTest title binding msg = testSessionWait title $ do
213− _ <- openDoc' "A.hs" "haskell" $ sourceA binding
214− _ <- openDoc' "B.hs" "haskell" sourceB
232+ _ <- createDoc "A.hs" "haskell" $ sourceA binding
233+ _ <- createDoc "B.hs" "haskell" sourceB
215234 expectDiagnostics $ expectedDs msg
216235 in
217236 [ deferralTest "type error" "True" "Couldn't match expected type"
218237 , deferralTest "typed hole" "_" "Found hole"
219238 , deferralTest "out of scope var" "unbound" "Variable not in scope"
220− , deferralTest "message shows error" "True" "A.hs:3:5: error:"
221239 ]
222240
223241 , testSessionWait "remove required module" $ do
224242 let contentA = T.unlines [ "module ModuleA where" ]
225− docA <- openDoc' "ModuleA.hs" "haskell" contentA
243+ docA <- createDoc "ModuleA.hs" "haskell" contentA
226244 let contentB = T.unlines
227245 [ "module ModuleB where"
228246 , "import ModuleA"
229247 ]
230− _ <- openDoc' "ModuleB.hs" "haskell" contentB
248+ _ <- createDoc "ModuleB.hs" "haskell" contentB
231249 let change = TextDocumentContentChangeEvent
232250 { _range = Just (Range (Position 0 0) (Position 0 20))
233251 , _rangeLength = Nothing
@@ -240,20 +258,20 @@ diagnosticTests = testGroup "diagnostics"
240258 [ "module ModuleB where"
241259 , "import ModuleA"
242260 ]
243− _ <- openDoc' "ModuleB.hs" "haskell" contentB
261+ _ <- createDoc "ModuleB.hs" "haskell" contentB
244262 expectDiagnostics [("ModuleB.hs", [(DsError, (1, 7), "Could not find module")])]
245263 let contentA = T.unlines [ "module ModuleA where" ]
246− _ <- openDoc' "ModuleA.hs" "haskell" contentA
264+ _ <- createDoc "ModuleA.hs" "haskell" contentA
247265 expectDiagnostics [("ModuleB.hs", [])]
248266 , testSessionWait "add missing module (non workspace)" $ do
249267 let contentB = T.unlines
250268 [ "module ModuleB where"
251269 , "import ModuleA"
252270 ]
253− _ <- openDoc'' "/tmp/ModuleB.hs" "haskell" contentB
271+ _ <- createDoc "/tmp/ModuleB.hs" "haskell" contentB
254272 expectDiagnostics [("/tmp/ModuleB.hs", [(DsError, (1, 7), "Could not find module")])]
255273 let contentA = T.unlines [ "module ModuleA where" ]
256− _ <- openDoc'' "/tmp/ModuleA.hs" "haskell" contentA
274+ _ <- createDoc "/tmp/ModuleA.hs" "haskell" contentA
257275 expectDiagnostics [("/tmp/ModuleB.hs", [])]
258276 , testSessionWait "cyclic module dependency" $ do
259277 let contentA = T.unlines
@@ -264,8 +282,8 @@ diagnosticTests = testGroup "diagnostics"
264282 [ "module ModuleB where"
265283 , "import ModuleA"
266284 ]
267− _ <- openDoc' "ModuleA.hs" "haskell" contentA
268− _ <- openDoc' "ModuleB.hs" "haskell" contentB
285+ _ <- createDoc "ModuleA.hs" "haskell" contentA
286+ _ <- createDoc "ModuleB.hs" "haskell" contentB
269287 expectDiagnostics
270288 [ ( "ModuleA.hs"
271289 , [(DsError, (1, 7), "Cyclic module dependency between ModuleA, ModuleB")]
@@ -286,9 +304,9 @@ diagnosticTests = testGroup "diagnostics"
286304 let contentBboot = T.unlines
287305 [ "module ModuleB where"
288306 ]
289− _ <- openDoc' "ModuleA.hs" "haskell" contentA
290− _ <- openDoc' "ModuleB.hs" "haskell" contentB
291− _ <- 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
292310 expectDiagnostics []
293311 , testSessionWait "correct reference used with hs-boot" $ do
294312 let contentB = T.unlines
@@ -310,10 +328,10 @@ diagnosticTests = testGroup "diagnostics"
310328 -- resolved to the hs-boot file
311329 , "y = x"
312330 ]
313− _ <- openDoc' "ModuleB.hs" "haskell" contentB
314− _ <- openDoc' "ModuleA.hs" "haskell" contentA
315− _ <- openDoc' "ModuleA.hs-boot" "haskell" contentAboot
316− _ <- 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
317335 expectDiagnostics []
318336 , testSessionWait "redundant import" $ do
319337 let contentA = T.unlines ["module ModuleA where"]
@@ -322,8 +340,8 @@ diagnosticTests = testGroup "diagnostics"
322340 , "module ModuleB where"
323341 , "import ModuleA"
324342 ]
325− _ <- openDoc' "ModuleA.hs" "haskell" contentA
326− _ <- openDoc' "ModuleB.hs" "haskell" contentB
343+ _ <- createDoc "ModuleA.hs" "haskell" contentA
344+ _ <- createDoc "ModuleB.hs" "haskell" contentB
327345 expectDiagnostics
328346 [ ( "ModuleB.hs"
329347 , [(DsWarning, (2, 0), "The import of 'ModuleA' is redundant")]
@@ -345,8 +363,8 @@ diagnosticTests = testGroup "diagnostics"
345363 , "wrong1 = ThisList.map"
346364 , "wrong2 = BaseList.x"
347365 ]
348− _ <- openDoc' "Data/List.hs" "haskell" thisDataListContent
349− _ <- openDoc' "Main.hs" "haskell" mainContent
366+ _ <- createDoc "Data/List.hs" "haskell" thisDataListContent
367+ _ <- createDoc "Main.hs" "haskell" mainContent
350368 expectDiagnostics
351369 [ ( "Main.hs"
352370 , [(DsError, (6, 9), "Not in scope: \8216ThisList.map\8217")
@@ -361,7 +379,7 @@ diagnosticTests = testGroup "diagnostics"
361379 , "foo :: Ord a => a -> Int"
362380 , "foo a = 1"
363381 ]
364− _ <- openDoc' "Foo.hs" "haskell" fooContent
382+ _ <- createDoc "Foo.hs" "haskell" fooContent
365383 expectDiagnostics
366384 [ ( "Foo.hs"
367385 -- The test is to make sure that warnings contain unqualified names
@@ -386,18 +404,18 @@ diagnosticTests = testGroup "diagnostics"
386404 Just pathB <- pure $ uriToFilePath uriB
387405 uriB <- pure $
388406 let (drive, suffix) = splitDrive pathB
389− in filePathToUri (joinDrive (map toLower drive ) suffix)
407+ in filePathToUri (joinDrive (lower drive) suffix)
390408 liftIO $ createDirectoryIfMissing True (takeDirectory pathB)
391409 liftIO $ writeFileUTF8 pathB $ T.unpack bContent
392410 uriA <- getDocUri "A/A.hs"
393411 Just pathA <- pure $ uriToFilePath uriA
394412 uriA <- pure $
395413 let (drive, suffix) = splitDrive pathA
396− in filePathToUri (joinDrive (map toLower drive ) suffix)
414+ in filePathToUri (joinDrive (lower drive) suffix)
397415 let itemA = TextDocumentItem uriA "haskell" 0 aContent
398416 let a = TextDocumentIdentifier uriA
399417 sendNotification TextDocumentDidOpen (DidOpenTextDocumentParams itemA)
400− diagsNot <- skipManyTill anyMessage message :: Session PublishDiagnosticsNotification
418+ diagsNot <- skipManyTill anyMessage diagnostic
401419 let PublishDiagnosticsParams fileUri diags = _params (diagsNot :: PublishDiagnosticsNotification)
402420 -- Check that if we put a lower-case drive in for A.A
403421 -- the diagnostics for A.B will also be lower-case.
@@ -406,6 +424,38 @@ diagnosticTests = testGroup "diagnostics"
406424 liftIO $ unless ("redundant" `T.isInfixOf` msg) $
407425 assertFailure ("Expected redundant import but got " <> T.unpack msg)
408426 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
409459 ]
410460
411461codeActionTests :: TestTree
@@ -431,26 +481,26 @@ codeLensesTests = testGroup "code lenses"
431481watchedFilesTests :: TestTree
432482watchedFilesTests = testGroup "watched files"
433483 [ testSession' "workspace files" $ \sessionDir -> do
434− liftIO $ writeFile (sessionDir </> "hie.yaml") $ "cradle: {direct: {arguments: [\"-isrc\"]}}"
435− _ <- openDoc' "A.hs" "haskell" "{-#LANGUAGE NoImplicitPrelude #-}\nmodule A where\nimport B"
436− watchedFileRegs <- getWatchedFilesSubscriptionsUntilProgressEnd
437−
438− -- Expect 6 subscriptions (A does not get any because it's VFS):
439− -- - /path-to-workspace/B.hs
440− -- - /path-to-workspace/B.lhs
441− -- - B.hs
442− -- - B.lhs
443− -- - src/B.hs
444− -- - src/B.lhs
445− liftIO $ length watchedFileRegs @?= 6
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
446494
447495 , testSession' "non workspace file" $ \sessionDir -> do
448− liftIO $ writeFile (sessionDir </> "hie.yaml") $ "cradle: {direct: {arguments: [\"-i/tmp\"]}}"
449− _ <- openDoc' "A.hs" "haskell" "{-# LANGUAGE NoImplicitPrelude#-}\nmodule A where\nimport B"
450− watchedFileRegs <- getWatchedFilesSubscriptionsUntilProgressEnd
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
451499
452− -- Expect 4 subscriptions:
453− liftIO $ length watchedFileRegs @?= 4
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
454504
455505 -- TODO add a test for didChangeWorkspaceFolder
456506 ]
@@ -463,7 +513,7 @@ renameActionTests = testGroup "rename actions"
463513 , "foo :: Int -> Int"
464514 , "foo argName = argNme"
465515 ]
466− doc <- openDoc' "Testing.hs" "haskell" content
516+ doc <- createDoc "Testing.hs" "haskell" content
467517 _ <- waitForDiagnostics
468518 action <- findCodeAction doc (Range (Position 2 14) (Position 2 20)) "Replace with ‘argName’"
469519 executeCodeAction action
@@ -481,7 +531,7 @@ renameActionTests = testGroup "rename actions"
481531 , "foo :: Maybe a -> [a]"
482532 , "foo = maybToList"
483533 ]
484− doc <- openDoc' "Testing.hs" "haskell" content
534+ doc <- createDoc "Testing.hs" "haskell" content
485535 _ <- waitForDiagnostics
486536 action <- findCodeAction doc (Range (Position 3 6) (Position 3 16)) "Replace with ‘maybeToList’"
487537 executeCodeAction action
@@ -499,7 +549,7 @@ renameActionTests = testGroup "rename actions"
499549 , "foo :: Char -> Char -> Char -> Char"
500550 , "foo argument1 argument2 argument3 = argumentX"
501551 ]
502− doc <- openDoc' "Testing.hs" "haskell" content
552+ doc <- createDoc "Testing.hs" "haskell" content
503553 _ <- waitForDiagnostics
504554 _ <- findCodeActions doc (Range (Position 2 36) (Position 2 45))
505555 ["Replace with ‘argument1’", "Replace with ‘argument2’", "Replace with ‘argument3’"]
@@ -511,7 +561,7 @@ renameActionTests = testGroup "rename actions"
511561 , "monus x y = max 0 (x - y)"
512562 , "foo x y = x `monnus` y"
513563 ]
514− doc <- openDoc' "Testing.hs" "haskell" content
564+ doc <- createDoc "Testing.hs" "haskell" content
515565 _ <- waitForDiagnostics
516566 actionsOrCommands <- getCodeActions doc (Range (Position 3 12) (Position 3 20))
517567 [fixTypo] <- pure [action | CACodeAction action@CodeAction{ _title = actionTitle } <- actionsOrCommands, "monus" `T.isInfixOf` actionTitle ]
@@ -534,7 +584,7 @@ typeWildCardActionTests = testGroup "type wildcard actions"
534584 , "func :: _"
535585 , "func x = x"
536586 ]
537− doc <- openDoc' "Testing.hs" "haskell" content
587+ doc <- createDoc "Testing.hs" "haskell" content
538588 _ <- waitForDiagnostics
539589 actionsOrCommands <- getCodeActions doc (Range (Position 2 1) (Position 2 10))
540590 let [addSignature] = [action | CACodeAction action@CodeAction { _title = actionTitle } <- actionsOrCommands
@@ -554,7 +604,7 @@ typeWildCardActionTests = testGroup "type wildcard actions"
554604 , "func :: _"
555605 , "func x y = x + y"
556606 ]
557− doc <- openDoc' "Testing.hs" "haskell" content
607+ doc <- createDoc "Testing.hs" "haskell" content
558608 _ <- waitForDiagnostics
559609 actionsOrCommands <- getCodeActions doc (Range (Position 2 1) (Position 2 10))
560610 let [addSignature] = [action | CACodeAction action@CodeAction { _title = actionTitle } <- actionsOrCommands
@@ -577,7 +627,7 @@ typeWildCardActionTests = testGroup "type wildcard actions"
577627 , " y = x * 2"
578628 , " in y"
579629 ]
580− doc <- openDoc' "Testing.hs" "haskell" content
630+ doc <- createDoc "Testing.hs" "haskell" content
581631 _ <- waitForDiagnostics
582632 actionsOrCommands <- getCodeActions doc (Range (Position 4 1) (Position 4 10))
583633 let [addSignature] = [action | CACodeAction action@CodeAction { _title = actionTitle } <- actionsOrCommands
@@ -602,7 +652,7 @@ removeImportTests = testGroup "remove import actions"
602652 let contentA = T.unlines
603653 [ "module ModuleA where"
604654 ]
605− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
655+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
606656 let contentB = T.unlines
607657 [ "{-# OPTIONS_GHC -Wunused-imports #-}"
608658 , "module ModuleB where"
@@ -610,7 +660,7 @@ removeImportTests = testGroup "remove import actions"
610660 , "stuffB :: Integer"
611661 , "stuffB = 123"
612662 ]
613− docB <- openDoc' "ModuleB.hs" "haskell" contentB
663+ docB <- createDoc "ModuleB.hs" "haskell" contentB
614664 _ <- waitForDiagnostics
615665 [CACodeAction action@CodeAction { _title = actionTitle }]
616666 <- getCodeActions docB (Range (Position 2 0) (Position 2 5))
@@ -628,7 +678,7 @@ removeImportTests = testGroup "remove import actions"
628678 let contentA = T.unlines
629679 [ "module ModuleA where"
630680 ]
631− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
681+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
632682 let contentB = T.unlines
633683 [ "{-# OPTIONS_GHC -Wunused-imports #-}"
634684 , "module ModuleB where"
@@ -636,7 +686,7 @@ removeImportTests = testGroup "remove import actions"
636686 , "stuffB :: Integer"
637687 , "stuffB = 123"
638688 ]
639− docB <- openDoc' "ModuleB.hs" "haskell" contentB
689+ docB <- createDoc "ModuleB.hs" "haskell" contentB
640690 _ <- waitForDiagnostics
641691 [CACodeAction action@CodeAction { _title = actionTitle }]
642692 <- getCodeActions docB (Range (Position 2 0) (Position 2 5))
@@ -658,14 +708,14 @@ removeImportTests = testGroup "remove import actions"
658708 , "stuffB = 123"
659709 , "stuffC = ()"
660710 ]
661− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
711+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
662712 let contentB = T.unlines
663713 [ "{-# OPTIONS_GHC -Wunused-imports #-}"
664714 , "module ModuleB where"
665715 , "import ModuleA (stuffA, stuffB, stuffC, stuffA)"
666716 , "main = print stuffB"
667717 ]
668− docB <- openDoc' "ModuleB.hs" "haskell" contentB
718+ docB <- createDoc "ModuleB.hs" "haskell" contentB
669719 _ <- waitForDiagnostics
670720 [CACodeAction action@CodeAction { _title = actionTitle }]
671721 <- getCodeActions docB (Range (Position 2 0) (Position 2 5))
@@ -687,22 +737,18 @@ removeImportTests = testGroup "remove import actions"
687737 , "stuffB :: Integer"
688738 , "stuffB = 123"
689739 ]
690− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
740+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
691741 let contentB = T.unlines
692742 [ "{-# OPTIONS_GHC -Wunused-imports #-}"
693743 , "module ModuleB where"
694744 , "import qualified ModuleA as A ((<?>), stuffB, (!!))"
695745 , "main = print A.stuffB"
696746 ]
697− docB <- openDoc' "ModuleB.hs" "haskell" contentB
747+ docB <- createDoc "ModuleB.hs" "haskell" contentB
698748 _ <- waitForDiagnostics
699749 [CACodeAction action@CodeAction { _title = actionTitle }]
700750 <- getCodeActions docB (Range (Position 2 0) (Position 2 5))
701−#if MIN_GHC_API_VERSION(8,6,0)
702751 liftIO $ "Remove !!, <?> from import" @=? actionTitle
703−#else
704− liftIO $ "Remove A.!!, A.<?> from import" @=? actionTitle
705−#endif
706752 executeCodeAction action
707753 contentAfterAction <- documentContents docB
708754 let expectedContentAfterAction = T.unlines
@@ -719,14 +765,14 @@ removeImportTests = testGroup "remove import actions"
719765 , "stuffB :: Integer"
720766 , "stuffB = 123"
721767 ]
722− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
768+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
723769 let contentB = T.unlines
724770 [ "{-# OPTIONS_GHC -Wunused-imports #-}"
725771 , "module ModuleB where"
726772 , "import ModuleA (A(..), stuffB)"
727773 , "main = print stuffB"
728774 ]
729− docB <- openDoc' "ModuleB.hs" "haskell" contentB
775+ docB <- createDoc "ModuleB.hs" "haskell" contentB
730776 _ <- waitForDiagnostics
731777 [CACodeAction action@CodeAction { _title = actionTitle }]
732778 <- getCodeActions docB (Range (Position 2 0) (Position 2 5))
@@ -746,14 +792,14 @@ removeImportTests = testGroup "remove import actions"
746792 , "data D = A | B"
747793 , "data E = F"
748794 ]
749− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
795+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
750796 let contentB = T.unlines
751797 [ "{-# OPTIONS_GHC -Wunused-imports #-}"
752798 , "module ModuleB where"
753799 , "import ModuleA (D(A,B), E(F))"
754800 , "main = B"
755801 ]
756− docB <- openDoc' "ModuleB.hs" "haskell" contentB
802+ docB <- createDoc "ModuleB.hs" "haskell" contentB
757803 _ <- waitForDiagnostics
758804 [CACodeAction action@CodeAction { _title = actionTitle }]
759805 <- getCodeActions docB (Range (Position 2 0) (Position 2 5))
@@ -894,8 +940,8 @@ extendImportTests = testGroup "extend import actions"
894940 ]
895941 where
896942 template contentA contentB range expectedAction expectedContentB = do
897− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
898− docB <- openDoc' "ModuleB.hs" "haskell" contentB
943+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
944+ docB <- createDoc "ModuleB.hs" "haskell" contentB
899945 _ <- waitForDiagnostics
900946 CACodeAction action@CodeAction { _title = actionTitle } : _
901947 <- sortOn (\(CACodeAction CodeAction{_title=x}) -> x) <$>
@@ -935,6 +981,8 @@ suggestImportTests = testGroup "suggest import actions"
935981 , test True [] "f :: Typeable a => a" ["f = undefined"] "import Data.Typeable (Typeable)"
936982 , test True [] "f = pack" [] "import Data.Text (pack)"
937983 , 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 ((&))"
938986 ]
939987 ]
940988 where
@@ -943,19 +991,20 @@ suggestImportTests = testGroup "suggest import actions"
943991 after = T.unlines $ "module A where" : ["import " <> x | x <- imps] ++ [newImp] ++ def : other
944992 cradle = "cradle: {direct: {arguments: [-hide-all-packages, -package, base, -package, text, -package-env, -]}}"
945993 liftIO $ writeFileUTF8 (dir </> "hie.yaml") cradle
946− doc <- openDoc' "Test.hs" "haskell" before
994+ doc <- createDoc "Test.hs" "haskell" before
947995 _diags <- waitForDiagnostics
948996 let defLine = length imps + 1
949997 range = Range (Position defLine 0) (Position defLine maxBound)
950998 actions <- getCodeActions doc range
951− case wanted of
952− False ->
953− liftIO $ [_title | CACodeAction CodeAction{_title} <- actions, _title == newImp ] @?= []
954− True -> do
955− action <- liftIO $ pickActionWithTitle newImp actions
956− executeCodeAction action
957− contentAfterAction <- documentContents doc
958− 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+
9591008
9601009addExtensionTests :: TestTree
9611010addExtensionTests = testGroup "add language extension actions"
@@ -1002,7 +1051,7 @@ addExtensionTests = testGroup "add language extension actions"
10021051 ]
10031052 where
10041053 template initialContent range expectedAction expectedContents = do
1005− doc <- openDoc' "Module.hs" "haskell" initialContent
1054+ doc <- createDoc "Module.hs" "haskell" initialContent
10061055 _ <- waitForDiagnostics
10071056 CACodeAction action@CodeAction { _title = actionTitle } : _
10081057 <- sortOn (\(CACodeAction CodeAction{_title=x}) -> x) <$>
@@ -1025,7 +1074,7 @@ insertNewDefinitionTests = testGroup "insert new definition actions"
10251074 [""
10261075 ,"someOtherCode = ()"
10271076 ]
1028− docB <- openDoc' "ModuleB.hs" "haskell" (T.unlines $ txtB ++ txtB')
1077+ docB <- createDoc "ModuleB.hs" "haskell" (T.unlines $ txtB ++ txtB')
10291078 _ <- waitForDiagnostics
10301079 CACodeAction action@CodeAction { _title = actionTitle } : _
10311080 <- sortOn (\(CACodeAction CodeAction{_title=x}) -> x) <$>
@@ -1049,7 +1098,7 @@ insertNewDefinitionTests = testGroup "insert new definition actions"
10491098 [""
10501099 ,"someOtherCode = ()"
10511100 ]
1052− docB <- openDoc' "ModuleB.hs" "haskell" (T.unlines $ txtB ++ txtB')
1101+ docB <- createDoc "ModuleB.hs" "haskell" (T.unlines $ txtB ++ txtB')
10531102 _ <- waitForDiagnostics
10541103 CACodeAction action@CodeAction { _title = actionTitle } : _
10551104 <- sortOn (\(CACodeAction CodeAction{_title=x}) -> x) <$>
@@ -1088,8 +1137,8 @@ fixConstructorImportTests = testGroup "fix import actions"
10881137 ]
10891138 where
10901139 template contentA contentB range expectedAction expectedContentB = do
1091− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
1092− docB <- openDoc' "ModuleB.hs" "haskell" contentB
1140+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
1141+ docB <- createDoc "ModuleB.hs" "haskell" contentB
10931142 _diags <- waitForDiagnostics
10941143 CACodeAction action@CodeAction { _title = actionTitle } : _
10951144 <- sortOn (\(CACodeAction CodeAction{_title=x}) -> x) <$>
@@ -1108,7 +1157,7 @@ importRenameActionTests = testGroup "import rename actions"
11081157 [ "module Testing where"
11091158 , "import Data.Mape"
11101159 ]
1111− doc <- openDoc' "Testing.hs" "haskell" content
1160+ doc <- createDoc "Testing.hs" "haskell" content
11121161 _ <- waitForDiagnostics
11131162 actionsOrCommands <- getCodeActions doc (Range (Position 2 8) (Position 2 16))
11141163 let [changeToMap] = [action | CACodeAction action@CodeAction{ _title = actionTitle } <- actionsOrCommands, ("Data." <> modname) `T.isInfixOf` actionTitle ]
@@ -1145,7 +1194,7 @@ fillTypedHoleTests = let
11451194 newA newB newC = testSession (T.unpack actionTitle) $ do
11461195 let originalCode = sourceCode oldA oldB oldC
11471196 let expectedCode = sourceCode newA newB newC
1148− doc <- openDoc' "Testing.hs" "haskell" originalCode
1197+ doc <- createDoc "Testing.hs" "haskell" originalCode
11491198 _ <- waitForDiagnostics
11501199 actionsOrCommands <- getCodeActions doc (Range (Position 9 0) (Position 9 maxBound))
11511200 chosenAction <- liftIO $ pickActionWithTitle actionTitle actionsOrCommands
@@ -1193,7 +1242,7 @@ addSigActionTests = let
11931242 def >:: sig = testSession (T.unpack def) $ do
11941243 let originalCode = before def
11951244 let expectedCode = after' def sig
1196− doc <- openDoc' "Sigs.hs" "haskell" originalCode
1245+ doc <- createDoc "Sigs.hs" "haskell" originalCode
11971246 _ <- waitForDiagnostics
11981247 actionsOrCommands <- getCodeActions doc (Range (Position 3 1) (Position 3 maxBound))
11991248 chosenAction <- liftIO $ pickActionWithTitle ("add signature: " <> sig) actionsOrCommands
@@ -1225,7 +1274,7 @@ addSigLensesTests = let
12251274 sigSession withMissing def sig = testSession (T.unpack def) $ do
12261275 let originalCode = before withMissing def
12271276 let expectedCode = after' withMissing def sig
1228− doc <- openDoc' "Sigs.hs" "haskell" originalCode
1277+ doc <- createDoc "Sigs.hs" "haskell" originalCode
12291278 [CodeLens {_command = Just c}] <- getCodeLenses doc
12301279 executeCommand c
12311280 modifiedCode <- getDocumentEdit doc
@@ -1247,24 +1296,19 @@ addSigLensesTests = let
12471296 ]
12481297 ]
12491298
1250−findDefinitionAndHoverTests :: TestTree
1251−findDefinitionAndHoverTests = let
1252−
1253− tst (get, check) pos targetRange title = testSession title $ do
1254− doc <- openTestDataDoc sourceFilePath
1255− found <- get doc pos
1256− check found targetRange
1299+checkDefs :: [Location] -> Session [Expect] -> Session ()
1300+checkDefs defs mkExpectations = traverse_ check =<< mkExpectations where
12571301
1258− checkDefs :: [Location] -> [Expect] -> Session ()
1259− checkDefs defs expectations = traverse_ check expectations where
1260−
1261− check (ExpectRange expectedRange) = do
1262− assertNDefinitionsFound 1 defs
1263− assertRangeCorrect (head defs) expectedRange
1264− check ExpectNoDefinitions = do
1265− assertNDefinitionsFound 0 defs
1266− check ExpectExternFail = liftIO $ assertFailure "Expecting to fail to find in external file"
1267− 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
12681312
12691313 assertNDefinitionsFound :: Int -> [a] -> Session ()
12701314 assertNDefinitionsFound n defs = liftIO $ assertEqual "number of definitions" n (length defs)
@@ -1272,8 +1316,19 @@ findDefinitionAndHoverTests = let
12721316 assertRangeCorrect Location{_range = foundRange} expectedRange =
12731317 liftIO $ expectedRange @=? foundRange
12741318
1275− checkHover :: Maybe Hover -> [Expect] -> Session ()
1276− 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
12771332
12781333 check expected =
12791334 case hover of
@@ -1316,9 +1371,12 @@ findDefinitionAndHoverTests = let
13161371
13171372 mkFindTests tests = testGroup "get"
13181373 [ testGroup "definition" $ mapMaybe fst tests
1319− , 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)
13201378
1321− test runDef runHover look expect title =
1379+ testM runDef runHover look expect title =
13221380 ( runDef $ tst def look expect title
13231381 , runHover $ tst hover look expect title ) where
13241382 def = (getDefinitions, checkDefs)
@@ -1326,87 +1384,100 @@ findDefinitionAndHoverTests = let
13261384 --type_ = (getTypeDefinitions, checkTDefs) -- getTypeDefinitions always times out
13271385
13281386 -- search locations expectations on results
1329− fffL4 = _start fffR ; fffR = mkRange 4 4 4 7 ; fff = [ExpectRange fffR]
1330− fffL8 = Position 8 4 ;
1331− fffL14 = Position 14 7 ;
1332− aaaL14 = Position 14 20 ; aaa = [mkR 7 0 7 3]
1333− dcL7 = Position 7 11 ; tcDC = [mkR 3 23 5 16]
1334− dcL12 = Position 12 11 ;
1335− xtcL5 = Position 5 11 ; xtc = [ExpectExternFail, ExpectHoverText ["Int", "Defined in ‘GHC.Types’"]]
1336− tcL6 = Position 6 11 ; tcData = [mkR 3 0 5 16, ExpectHoverText ["TypeConstructor", "GotoHover.hs:4:1"]]
1337− vvL16 = Position 16 12 ; vv = [mkR 16 4 16 6]
1338− opL16 = Position 16 15 ; op = [mkR 17 2 17 4]
1339− opL18 = Position 18 22 ; opp = [mkR 18 13 18 17]
1340− aL18 = Position 18 20 ; apmp = [mkR 18 10 18 11]
1341− b'L19 = Position 19 13 ; bp = [mkR 19 6 19 7]
1342− xvL20 = Position 20 8 ; xvMsg = [ExpectExternFail, ExpectHoverText ["Data.Text.pack", ":: String -> Text"]]
1343− clL23 = Position 23 11 ; cls = [mkR 21 0 22 20, ExpectHoverText ["MyClass", "GotoHover.hs:22:1"]]
1344− clL25 = Position 25 9
1345− eclL15 = Position 15 8 ; ecls = [ExpectExternFail, ExpectHoverText ["Num", "Defined in ‘GHC.Num’"]]
1346− dnbL29 = Position 29 18 ; dnb = [ExpectHoverText [":: ()"], mkR 29 12 29 21]
1347− dnbL30 = Position 30 23
1348− lcbL33 = Position 33 26 ; lcb = [ExpectHoverText [":: Char"], mkR 33 26 33 27]
1349− lclL33 = Position 33 22
1350− mclL36 = Position 36 1 ; mcl = [mkR 36 0 36 14]
1351− mclL37 = Position 37 1
1352− spaceL37 = Position 37 24 ; space = [ExpectNoDefinitions, ExpectHoverText [":: Char"]]
1353− 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"]]
13541412 ; constr = [ExpectHoverText ["Monad m"]]
1355− eitL40 = Position 40 28 ; kindE = [ExpectHoverText [":: * -> * -> *\n"]]
1356− intL40 = Position 40 34 ; kindI = [ExpectHoverText [":: *\n"]]
1357− tvrL40 = Position 40 37 ; kindV = [ExpectHoverText [":: * -> *\n"]]
1358− intL41 = Position 41 20 ; litI = [ExpectHoverText ["7518"]]
1359− chrL36 = Position 37 24 ; litC = [ExpectHoverText ["'f'"]]
1360− txtL8 = Position 8 14 ; litT = [ExpectHoverText ["\"dfgy\""]]
1361− lstL43 = Position 43 12 ; litL = [ExpectHoverText ["[8391 :: Int, 6268]"]]
1362− outL45 = Position 45 3 ; outSig = [ExpectHoverText ["outer", "Bool"], mkR 46 0 46 5]
1363− 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]
13641424 in
13651425 mkFindTests
1366− -- def hover look expect
1367− [ test yes yes fffL4 fff "field in record definition"
1368− , test broken broken fffL8 fff "field in record construction #71"
1369− , test yes yes fffL14 fff "field name used as accessor" -- 120 in Calculate.hs
1370− , test yes yes aaaL14 aaa "top-level name" -- 120
1371− , test yes yes dcL7 tcDC "data constructor record #247"
1372− , test yes yes dcL12 tcDC "data constructor plain" -- 121
1373− , test yes yes tcL6 tcData "type constructor #248" -- 147
1374− , test broken yes xtcL5 xtc "type constructor external #248,249"
1375− , test broken yes xvL20 xvMsg "value external package #249" -- 120
1376− , test yes yes vvL16 vv "plain parameter" -- 120
1377− , test yes yes aL18 apmp "pattern match name" -- 120
1378− , test yes yes opL16 op "top-level operator" -- 120, 123
1379− , test yes yes opL18 opp "parameter operator" -- 120
1380− , test yes yes b'L19 bp "name in backticks" -- 120
1381− , test yes yes clL23 cls "class in instance declaration #250"
1382− , test yes yes clL25 cls "class in signature #250" -- 147
1383− , test broken yes eclL15 ecls "external class in signature #249,250"
1384− , test yes yes dnbL29 dnb "do-notation bind" -- 137
1385− , test yes yes dnbL30 dnb "do-notation lookup"
1386− , test yes yes lcbL33 lcb "listcomp bind" -- 137
1387− , test yes yes lclL33 lcb "listcomp lookup"
1388− , test yes yes mclL36 mcl "top-level fn 1st clause"
1389− , test yes yes mclL37 mcl "top-level fn 2nd clause #246"
1390− , test yes yes spaceL37 space "top-level fn on space #315"
1391− , test no broken docL41 doc "documentation #7"
1392− , test no yes eitL40 kindE "kind of Either #273"
1393− , test no yes intL40 kindI "kind of Int #273"
1394− , test no broken tvrL40 kindV "kind of (* -> *) type variable #273"
1395− , test no yes intL41 litI "literal Int in hover info #274"
1396− , test no yes chrL36 litC "literal Char in hover info #274"
1397− , test no yes txtL8 litT "literal Text in hover info #274"
1398− , test no yes lstL43 litL "literal List in hover info #274"
1399− , test no yes docL41 constr "type constraint in hover info #283"
1400− , test broken broken outL45 outSig "top-level signature #310"
1401− , 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)"
14021464 ]
14031465 where yes, broken :: (TestTree -> Maybe TestTree)
14041466 yes = Just -- test should run and pass
14051467 broken = Just . (`xfail` "known broken")
14061468 no = const Nothing -- don't run this test at all
14071469
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+
14081478pluginTests :: TestTree
1409−pluginTests = testSessionWait "plugins" $ do
1479+pluginTests = (`xfail8101` "known broken (#556)")
1480+ $ testSessionWait "plugins" $ do
14101481 let content =
14111482 T.unlines
14121483 [ "{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}"
@@ -1420,7 +1491,7 @@ pluginTests = testSessionWait "plugins" $ do
14201491 , "foo :: Int -> Int -> Int"
14211492 , "foo a b = a + c"
14221493 ]
1423− _ <- openDoc' "Testing.hs" "haskell" content
1494+ _ <- createDoc "Testing.hs" "haskell" content
14241495 expectDiagnostics
14251496 [ ( "Testing.hs",
14261497 [(DsError, (8, 14), "Variable not in scope: c")]
@@ -1447,7 +1518,7 @@ cppTests =
14471518 run $ expectError content (2, 1)
14481519 )
14491520 , testSessionWait "cpp-ghcide" $ do
1450− _ <- openDoc' "A.hs" "haskell" $ T.unlines
1521+ _ <- createDoc "A.hs" "haskell" $ T.unlines
14511522 ["{-# LANGUAGE CPP #-}"
14521523 ,"main ="
14531524 ,"#ifdef __GHCIDE__"
@@ -1461,7 +1532,7 @@ cppTests =
14611532 where
14621533 expectError :: T.Text -> Cursor -> Session ()
14631534 expectError content cursor = do
1464− _ <- openDoc' "Testing.hs" "haskell" content
1535+ _ <- createDoc "Testing.hs" "haskell" content
14651536 expectDiagnostics
14661537 [ ( "Testing.hs",
14671538 [(DsError, cursor, "error: unterminated")]
@@ -1477,13 +1548,43 @@ preprocessorTests = testSessionWait "preprocessor" $ do
14771548 , "module Testing where"
14781549 , "y = x + z" -- plugin replaces x with y, making this have only one diagnostic
14791550 ]
1480− _ <- openDoc' "Testing.hs" "haskell" content
1551+ _ <- createDoc "Testing.hs" "haskell" content
14811552 expectDiagnostics
14821553 [ ( "Testing.hs",
14831554 [(DsError, (2, 8), "Variable not in scope: z")]
14841555 )
14851556 ]
14861557
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+
14871588thTests :: TestTree
14881589thTests =
14891590 testGroup
@@ -1509,8 +1610,8 @@ thTests =
15091610 "b :: Integer",
15101611 "b = $(litE $ IntegerL $ a) + n"
15111612 ]
1512− _ <- openDoc' "A.hs" "haskell" sourceA
1513− _ <- openDoc' "B.hs" "haskell" sourceB
1613+ _ <- createDoc "A.hs" "haskell" sourceA
1614+ _ <- createDoc "B.hs" "haskell" sourceB
15141615 expectDiagnostics [ ( "B.hs", [(DsError, (6, 29), "Variable not in scope: n")] ) ]
15151616 , testSessionWait "newtype-closure" $ do
15161617 let sourceA =
@@ -1530,8 +1631,8 @@ thTests =
15301631 ,"import A"
15311632 ,"b :: Int"
15321633 ,"b = $( a )" ]
1533− _ <- openDoc' "A.hs" "haskell" sourceA
1534− _ <- openDoc' "B.hs" "haskell" sourceB
1634+ _ <- createDoc "A.hs" "haskell" sourceA
1635+ _ <- createDoc "B.hs" "haskell" sourceB
15351636 return ()
15361637 ]
15371638
@@ -1540,7 +1641,7 @@ completionTests
15401641 = testGroup "completion"
15411642 [ testSessionWait "variable" $ do
15421643 let source = T.unlines ["module A where", "f = hea"]
1543− docId <- openDoc' "A.hs" "haskell" source
1644+ docId <- createDoc "A.hs" "haskell" source
15441645 compls <- getCompletions docId (Position 1 7)
15451646 liftIO $ map dropDocs compls @?=
15461647 [complItem "head" (Just CiFunction) (Just "[a] -> a")]
@@ -1552,7 +1653,7 @@ completionTests
15521653 ]
15531654 , testSessionWait "constructor" $ do
15541655 let source = T.unlines ["module A where", "f = Tru"]
1555− docId <- openDoc' "A.hs" "haskell" source
1656+ docId <- createDoc "A.hs" "haskell" source
15561657 compls <- getCompletions docId (Position 1 7)
15571658 liftIO $ map dropDocs compls @?=
15581659 [ complItem "True" (Just CiConstructor) (Just "Bool")
@@ -1564,7 +1665,7 @@ completionTests
15641665 ]
15651666 , testSessionWait "type" $ do
15661667 let source = T.unlines ["{-# OPTIONS_GHC -Wall #-}", "module A () where", "f :: ()", "f = ()"]
1567− docId <- openDoc' "A.hs" "haskell" source
1668+ docId <- createDoc "A.hs" "haskell" source
15681669 expectDiagnostics [ ("A.hs", [(DsWarning, (3,0), "not used")]) ]
15691670 changeDoc docId [TextDocumentContentChangeEvent Nothing Nothing $ T.unlines ["{-# OPTIONS_GHC -Wall #-}", "module A () where", "f :: Bo", "f = True"]]
15701671 compls <- getCompletions docId (Position 2 7)
@@ -1581,7 +1682,7 @@ completionTests
15811682 checkDocText "Bool" boolDocs [ "Defined in 'Prelude'" ]
15821683 , testSessionWait "qualified" $ do
15831684 let source = T.unlines ["{-# OPTIONS_GHC -Wunused-binds #-}", "module A () where", "f = ()"]
1584− docId <- openDoc' "A.hs" "haskell" source
1685+ docId <- createDoc "A.hs" "haskell" source
15851686 expectDiagnostics [ ("A.hs", [(DsWarning, (2, 0), "not used")]) ]
15861687 changeDoc docId [TextDocumentContentChangeEvent Nothing Nothing $ T.unlines ["{-# OPTIONS_GHC -Wunused-binds #-}", "module A () where", "f = Prelude.hea"]]
15871688 compls <- getCompletions docId (Position 2 15)
@@ -1595,9 +1696,30 @@ completionTests
15951696 ]
15961697 , testSessionWait "keyword" $ do
15971698 let source = T.unlines ["module A where", "f = newty"]
1598− docId <- openDoc' "A.hs" "haskell" source
1699+ docId <- createDoc "A.hs" "haskell" source
15991700 compls <- getCompletions docId (Position 1 9)
16001701 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 "*")]
16011723 ]
16021724 where
16031725 dropDocs :: CompletionItem -> CompletionItem
@@ -1605,6 +1727,7 @@ completionTests
16051727 complItem label kind ty = CompletionItem
16061728 { _label = label
16071729 , _kind = kind
1730+ , _tags = List []
16081731 , _detail = (":: " <>) <$> ty
16091732 , _documentation = Nothing
16101733 , _deprecated = Nothing
@@ -1622,6 +1745,7 @@ completionTests
16221745 keywordItem label = CompletionItem
16231746 { _label = label
16241747 , _kind = Just CiKeyword
1748+ , _tags = List []
16251749 , _detail = Nothing
16261750 , _documentation = Nothing
16271751 , _deprecated = Nothing
@@ -1649,7 +1773,7 @@ outlineTests = testGroup
16491773 "outline"
16501774 [ testSessionWait "type class" $ do
16511775 let source = T.unlines ["module A where", "class A a where a :: a -> Bool"]
1652− docId <- openDoc' "A.hs" "haskell" source
1776+ docId <- createDoc "A.hs" "haskell" source
16531777 symbols <- getDocumentSymbols docId
16541778 liftIO $ symbols @?= Left
16551779 [ moduleSymbol
@@ -1662,7 +1786,7 @@ outlineTests = testGroup
16621786 ]
16631787 , testSessionWait "type class instance " $ do
16641788 let source = T.unlines ["class A a where", "instance A () where"]
1665− docId <- openDoc' "A.hs" "haskell" source
1789+ docId <- createDoc "A.hs" "haskell" source
16661790 symbols <- getDocumentSymbols docId
16671791 liftIO $ symbols @?= Left
16681792 [ classSymbol "A a" (R 0 0 0 15) []
@@ -1670,7 +1794,7 @@ outlineTests = testGroup
16701794 ]
16711795 , testSessionWait "type family" $ do
16721796 let source = T.unlines ["{-# language TypeFamilies #-}", "type family A"]
1673− docId <- openDoc' "A.hs" "haskell" source
1797+ docId <- createDoc "A.hs" "haskell" source
16741798 symbols <- getDocumentSymbols docId
16751799 liftIO $ symbols @?= Left [docSymbolD "A" "type family" SkClass (R 1 0 1 13)]
16761800 , testSessionWait "type family instance " $ do
@@ -1679,7 +1803,7 @@ outlineTests = testGroup
16791803 , "type family A a"
16801804 , "type instance A () = ()"
16811805 ]
1682− docId <- openDoc' "A.hs" "haskell" source
1806+ docId <- createDoc "A.hs" "haskell" source
16831807 symbols <- getDocumentSymbols docId
16841808 liftIO $ symbols @?= Left
16851809 [ docSymbolD "A a" "type family" SkClass (R 1 0 1 15)
@@ -1687,7 +1811,7 @@ outlineTests = testGroup
16871811 ]
16881812 , testSessionWait "data family" $ do
16891813 let source = T.unlines ["{-# language TypeFamilies #-}", "data family A"]
1690− docId <- openDoc' "A.hs" "haskell" source
1814+ docId <- createDoc "A.hs" "haskell" source
16911815 symbols <- getDocumentSymbols docId
16921816 liftIO $ symbols @?= Left [docSymbolD "A" "data family" SkClass (R 1 0 1 11)]
16931817 , testSessionWait "data family instance " $ do
@@ -1696,7 +1820,7 @@ outlineTests = testGroup
16961820 , "data family A a"
16971821 , "data instance A () = A ()"
16981822 ]
1699− docId <- openDoc' "A.hs" "haskell" source
1823+ docId <- createDoc "A.hs" "haskell" source
17001824 symbols <- getDocumentSymbols docId
17011825 liftIO $ symbols @?= Left
17021826 [ docSymbolD "A a" "data family" SkClass (R 1 0 1 11)
@@ -1704,36 +1828,36 @@ outlineTests = testGroup
17041828 ]
17051829 , testSessionWait "constant" $ do
17061830 let source = T.unlines ["a = ()"]
1707− docId <- openDoc' "A.hs" "haskell" source
1831+ docId <- createDoc "A.hs" "haskell" source
17081832 symbols <- getDocumentSymbols docId
17091833 liftIO $ symbols @?= Left
17101834 [docSymbol "a" SkFunction (R 0 0 0 6)]
17111835 , testSessionWait "pattern" $ do
17121836 let source = T.unlines ["Just foo = Just 21"]
1713− docId <- openDoc' "A.hs" "haskell" source
1837+ docId <- createDoc "A.hs" "haskell" source
17141838 symbols <- getDocumentSymbols docId
17151839 liftIO $ symbols @?= Left
17161840 [docSymbol "Just foo" SkFunction (R 0 0 0 18)]
17171841 , testSessionWait "pattern with type signature" $ do
17181842 let source = T.unlines ["{-# language ScopedTypeVariables #-}", "a :: () = ()"]
1719− docId <- openDoc' "A.hs" "haskell" source
1843+ docId <- createDoc "A.hs" "haskell" source
17201844 symbols <- getDocumentSymbols docId
17211845 liftIO $ symbols @?= Left
17221846 [docSymbol "a :: ()" SkFunction (R 1 0 1 12)]
17231847 , testSessionWait "function" $ do
17241848 let source = T.unlines ["a x = ()"]
1725− docId <- openDoc' "A.hs" "haskell" source
1849+ docId <- createDoc "A.hs" "haskell" source
17261850 symbols <- getDocumentSymbols docId
17271851 liftIO $ symbols @?= Left [docSymbol "a" SkFunction (R 0 0 0 8)]
17281852 , testSessionWait "type synonym" $ do
17291853 let source = T.unlines ["type A = Bool"]
1730− docId <- openDoc' "A.hs" "haskell" source
1854+ docId <- createDoc "A.hs" "haskell" source
17311855 symbols <- getDocumentSymbols docId
17321856 liftIO $ symbols @?= Left
17331857 [docSymbol' "A" SkTypeParameter (R 0 0 0 13) (R 0 5 0 6)]
17341858 , testSessionWait "datatype" $ do
17351859 let source = T.unlines ["data A = C"]
1736− docId <- openDoc' "A.hs" "haskell" source
1860+ docId <- createDoc "A.hs" "haskell" source
17371861 symbols <- getDocumentSymbols docId
17381862 liftIO $ symbols @?= Left
17391863 [ docSymbolWithChildren "A"
@@ -1741,9 +1865,21 @@ outlineTests = testGroup
17411865 (R 0 0 0 10)
17421866 [docSymbol "C" SkConstructor (R 0 9 0 10)]
17431867 ]
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+ ]
17441880 , testSessionWait "import" $ do
17451881 let source = T.unlines ["import Data.Maybe"]
1746− docId <- openDoc' "A.hs" "haskell" source
1882+ docId <- createDoc "A.hs" "haskell" source
17471883 symbols <- getDocumentSymbols docId
17481884 liftIO $ symbols @?= Left
17491885 [docSymbolWithChildren "imports"
@@ -1754,7 +1890,7 @@ outlineTests = testGroup
17541890 ]
17551891 , testSessionWait "multiple import" $ do
17561892 let source = T.unlines ["", "import Data.Maybe", "", "import Control.Exception", ""]
1757− docId <- openDoc' "A.hs" "haskell" source
1893+ docId <- createDoc "A.hs" "haskell" source
17581894 symbols <- getDocumentSymbols docId
17591895 liftIO $ symbols @?= Left
17601896 [docSymbolWithChildren "imports"
@@ -1769,7 +1905,7 @@ outlineTests = testGroup
17691905 [ "{-# language ForeignFunctionInterface #-}"
17701906 , "foreign import ccall \"a\" a :: Int"
17711907 ]
1772− docId <- openDoc' "A.hs" "haskell" source
1908+ docId <- createDoc "A.hs" "haskell" source
17731909 symbols <- getDocumentSymbols docId
17741910 liftIO $ symbols @?= Left [docSymbolD "a" "import" SkObject (R 1 0 1 33)]
17751911 , testSessionWait "foreign export" $ do
@@ -1777,7 +1913,7 @@ outlineTests = testGroup
17771913 [ "{-# language ForeignFunctionInterface #-}"
17781914 , "foreign export ccall odd :: Int -> Bool"
17791915 ]
1780− docId <- openDoc' "A.hs" "haskell" source
1916+ docId <- createDoc "A.hs" "haskell" source
17811917 symbols <- getDocumentSymbols docId
17821918 liftIO $ symbols @?= Left [docSymbolD "odd" "export" SkObject (R 1 0 1 39)]
17831919 ]
@@ -1790,6 +1926,8 @@ outlineTests = testGroup
17901926 DocumentSymbol name (Just detail) kind Nothing loc loc Nothing
17911927 docSymbolWithChildren name kind loc cc =
17921928 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)
17931931 moduleSymbol name loc cc = DocumentSymbol name
17941932 Nothing
17951933 SkFile
@@ -1811,8 +1949,16 @@ pattern R x y x' y' = Range (Position x y) (Position x' y')
18111949xfail :: TestTree -> String -> TestTree
18121950xfail = flip expectFailBecause
18131951
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+
18141959data Expect
18151960 = ExpectRange Range -- Both gotoDef and hover should report this range
1961+ | ExpectLocation Location
18161962-- | ExpectDefRange Range -- Only gotoDef should report this range
18171963 | ExpectHoverRange Range -- Only hover should report this range
18181964 | ExpectHoverText [T.Text] -- the hover message must contain these snippets
@@ -1825,6 +1971,9 @@ data Expect
18251971mkR :: Int -> Int -> Int -> Int -> Expect
18261972mkR startLine startColumn endLine endColumn = ExpectRange $ mkRange startLine startColumn endLine endColumn
18271973
1974+mkL :: Uri -> Int -> Int -> Int -> Int -> Expect
1975+mkL uri startLine startColumn endLine endColumn = ExpectLocation $ Location uri $ mkRange startLine startColumn endLine endColumn
1976+
18281977haddockTests :: TestTree
18291978haddockTests
18301979 = testGroup "haddock"
@@ -1884,6 +2033,7 @@ cradleTests :: TestTree
18842033cradleTests = testGroup "cradle"
18852034 [testGroup "dependencies" [sessionDepsArePickedUp]
18862035 ,testGroup "loading" [loadCradleOnlyonce]
2036+ ,testGroup "multi" [simpleMultiTest, simpleMultiTest2]
18872037 ]
18882038
18892039loadCradleOnlyonce :: TestTree
@@ -1898,17 +2048,53 @@ loadCradleOnlyonce = testGroup "load cradle only once"
18982048 test dir
18992049 implicit dir = test dir
19002050 test _dir = do
1901− doc <- openDoc' "B.hs" "haskell" "module B where\nimport Data.Foo"
2051+ doc <- createDoc "B.hs" "haskell" "module B where\nimport Data.Foo"
19022052 msgs <- someTill (skipManyTill anyMessage cradleLoadedMessage) (skipManyTill anyMessage (message @PublishDiagnosticsNotification))
19032053 liftIO $ length msgs @?= 1
19042054 changeDoc doc [TextDocumentContentChangeEvent Nothing Nothing "module B where\nimport Data.Maybe"]
19052055 msgs <- manyTill (skipManyTill anyMessage cradleLoadedMessage) (skipManyTill anyMessage (message @PublishDiagnosticsNotification))
19062056 liftIO $ length msgs @?= 0
1907− _ <- openDoc' "A.hs" "haskell" "module A where\nimport Bar"
2057+ _ <- createDoc "A.hs" "haskell" "module A where\nimport LoadCradleBar"
19082058 msgs <- manyTill (skipManyTill anyMessage cradleLoadedMessage) (skipManyTill anyMessage (message @PublishDiagnosticsNotification))
19092059 liftIO $ length msgs @?= 0
19102060
19112061
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+
19122098cradleLoadedMessage :: Session FromServerMessage
19132099cradleLoadedMessage = satisfy $ \case
19142100 NotCustomServer (NotificationMessage _ (CustomServerMethod m) _) -> m == cradleLoadedMethod
@@ -1917,6 +2103,56 @@ cradleLoadedMessage = satisfy $ \case
19172103cradleLoadedMethod :: T.Text
19182104cradleLoadedMethod = "ghcide/cradle/loaded"
19192105
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
2155+
19202156sessionDepsArePickedUp :: TestTree
19212157sessionDepsArePickedUp = testSession'
19222158 "session-deps-are-picked-up"
@@ -1926,7 +2162,7 @@ sessionDepsArePickedUp = testSession'
19262162 (dir </> "hie.yaml")
19272163 "cradle: {direct: {arguments: []}}"
19282164 -- Open without OverloadedStrings and expect an error.
1929− doc <- openDoc' "Foo.hs" "haskell" fooContent
2165+ doc <- createDoc "Foo.hs" "haskell" fooContent
19302166 expectDiagnostics
19312167 [("Foo.hs", [(DsError, (3, 6), "Couldn't match expected type")])]
19322168 -- Update hie.yaml to enable OverloadedStrings.
@@ -1961,6 +2197,9 @@ sessionDepsArePickedUp = testSession'
19612197testSession :: String -> Session () -> TestTree
19622198testSession name = testCase name . run
19632199
2200+testSessionWithExtraFiles :: FilePath -> String -> (FilePath -> Session ()) -> TestTree
2201+testSessionWithExtraFiles prefix name = testCase name . runWithExtraFiles prefix
2202+
19642203testSession' :: String -> (FilePath -> Session ()) -> TestTree
19652204testSession' name = testCase name . run'
19662205
@@ -1995,6 +2234,19 @@ mkRange a b c d = Range (Position a b) (Position c d)
19952234run :: Session a -> IO a
19962235run s = withTempDir $ \dir -> runInDir dir s
19972236
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+
19982250run' :: (FilePath -> Session a) -> IO a
19992251run' s = withTempDir $ \dir -> runInDir dir (s dir)
20002252
@@ -2006,6 +2258,7 @@ runInDir dir s = do
20062258 -- since the package import test creates "Data/List.hs", which otherwise has no physical home
20072259 createDirectoryIfMissing True $ dir ++ "/Data"
20082260
2261+
20092262 let cmd = unwords [ghcideExe, "--lsp", "--test", "--cwd", dir]
20102263 -- HIE calls getXgdDirectory which assumes that HOME is set.
20112264 -- Only sets HOME if it wasn't already set.
@@ -2023,7 +2276,7 @@ runInDir dir s = do
20232276openTestDataDoc :: FilePath -> Session TextDocumentIdentifier
20242277openTestDataDoc path = do
20252278 source <- liftIO $ readFileUtf8 $ "test/data" </> path
2026− openDoc' path "haskell" source
2279+ createDoc path "haskell" source
20272280
20282281findCodeActions :: TextDocumentIdentifier -> Range -> [T.Text] -> Session [CodeAction]
20292282findCodeActions doc range expectedTitles = do
@@ -2051,24 +2304,19 @@ findCodeAction doc range t = head <$> findCodeActions doc range [t]
20512304unitTests :: TestTree
20522305unitTests = do
20532306 testGroup "Unit"
2054− [ testCase "empty file path" $
2055− 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 ""
20562318 ]
20572319
2058−-- | Wrapper around 'LSPTest.openDoc'' that sends file creation events
2059−openDoc' :: FilePath -> String -> T.Text -> Session TextDocumentIdentifier
2060−openDoc' fp name contents = do
2061− res@(TextDocumentIdentifier uri) <- LSPTest.openDoc' fp name contents
2062− -- Needed as ghcide sets up and relies on WatchedFiles but lsp-test does not track them
2063− sendNotification WorkspaceDidChangeWatchedFiles (DidChangeWatchedFilesParams $ List [FileEvent uri FcCreated])
2064− return res
2065−
2066−-- | Version of 'LSPTest.openDoc'' that does not send WatchedFiles events for files outside the workspace
2067−openDoc'' :: FilePath -> String -> T.Text -> Session TextDocumentIdentifier
2068−-- At the moment this is just LSPTest.openDoc' but it may change in the future
2069−-- when/if lsp-test implements WatchedFiles
2070−openDoc'' = LSPTest.openDoc'
2071−
20722320positionMappingTests :: TestTree
20732321positionMappingTests =
20742322 testGroup "position mapping"
@@ -2238,11 +2486,11 @@ nthLine i r
22382486 | i >= Rope.rows r = error $ "Row number out of bounds: " <> show i <> "/" <> show (Rope.rows r)
22392487 | otherwise = Rope.takeWhile (/= '\n') $ fst $ Rope.splitAtLine 1 $ snd $ Rope.splitAtLine (i - 1) r
22402488
2241−getWatchedFilesSubscriptionsUntilProgressEnd :: Session [Maybe Value]
2242−getWatchedFilesSubscriptionsUntilProgressEnd = do
2243− msgs <- manyTill (Just <$> message @RegisterCapabilityRequest <|> Nothing <$ anyMessage) (message @WorkDoneProgressEndNotification)
2489+getWatchedFilesSubscriptionsUntil :: forall end . (FromJSON end, Typeable end) => Session [Maybe Value]
2490+getWatchedFilesSubscriptionsUntil = do
2491+ msgs <- manyTill (Just <$> message @RegisterCapabilityRequest <|> Nothing <$ anyMessage) (message @end)
22442492 return
22452493 [ args
2246− | Just (RequestMessage{_params = RegistrationParams (List regs)}) <- msgs
2494+ | Just RequestMessage{_params = RegistrationParams (List regs)} <- msgs
22472495 , Registration _id WorkspaceDidChangeWatchedFiles args <- regs
22482496 ]