@@ -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,51 +10,74 @@
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
20+import Data.Rope.UTF16 (Rope)
21+import qualified Data.Rope.UTF16 as Rope
22+import Development.IDE.Core.PositionMapping (fromCurrent, toCurrent)
1823import Development.IDE.GHC.Util
1924import qualified Data.Text as T
25+import Data.Typeable
26+import Development.IDE.Spans.Common
2027import Development.IDE.Test
2128import Development.IDE.Test.Runfiles
2229import Development.IDE.Types.Location
23−import qualified Language.Haskell.LSP.Test as LSPTest
24−import Language.Haskell.LSP.Test hiding (openDoc')
30+import Development.Shake (getDirectoryFilesIO)
31+import Language.Haskell.LSP.Test
32+import Language.Haskell.LSP.Messages
2533import Language.Haskell.LSP.Types
2634import Language.Haskell.LSP.Types.Capabilities
27−import System.Environment.Blank (setEnv)
35+import qualified Language.Haskell.LSP.Types.Lens as Lsp (diagnostics, params, message)
36+import Language.Haskell.LSP.VFS (applyChange)
37+import Network.URI
38+import System.Environment.Blank (getEnv, setEnv, unsetEnv)
2839import System.FilePath
2940import System.IO.Extra
3041import System.Directory
42+import Test.QuickCheck
43+import Test.QuickCheck.Instances ()
3144import Test.Tasty
32−import Test.Tasty.HUnit
3345import Test.Tasty.ExpectedFailure
46+import Test.Tasty.Ingredients.Rerun
47+import Test.Tasty.HUnit
48+import Test.Tasty.QuickCheck
3449import Data.Maybe
3550
3651main :: IO ()
37−main = defaultMain $ testGroup "HIE"
38− [ testSession "open close" $ do
39− doc <- openDoc' "Testing.hs" "haskell" ""
40− void (message :: Session WorkDoneProgressCreateRequest)
41− void (message :: Session WorkDoneProgressBeginNotification)
42− closeDoc doc
43− void (message :: Session WorkDoneProgressEndNotification)
44− , initializeResponseTests
45− , completionTests
46− , cppTests
47− , diagnosticTests
48− , codeActionTests
49− , codeLensesTests
50− , outlineTests
51− , findDefinitionAndHoverTests
52− , pluginTests
53− , preprocessorTests
54− , thTests
55− , unitTests
56− ]
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+ ]
5781
5882initializeResponseTests :: TestTree
5983initializeResponseTests = withResource acquire release tests where
@@ -88,8 +112,8 @@ initializeResponseTests = withResource acquire release tests where
88112 , chk "NO doc link" _documentLinkProvider Nothing
89113 , chk "NO color" _colorProvider (Just $ ColorOptionsStatic False)
90114 , chk "NO folding range" _foldingRangeProvider (Just $ FoldingRangeOptionsStatic False)
91− , chk " execute command" _executeCommandProvider (Just $ ExecuteCommandOptions $ List ["typesignature.add"])
92− , chk "NO workspace" _workspace nothingWorkspace
115+ , che " execute command" _executeCommandProvider (Just $ ExecuteCommandOptions $ List ["typesignature.add"])
116+ , chk " workspace" _workspace (Just $ WorkspaceOptions (Just WorkspaceFolderOptions{_supported = Just True, _changeNotifications = Just ( WorkspaceFolderChangeNotificationsBool True )}))
93117 , chk "NO experimental" _experimental Nothing
94118 ] where
95119
@@ -100,14 +124,21 @@ initializeResponseTests = withResource acquire release tests where
100124 , _willSaveWaitUntil = Nothing
101125 , _save = Just (SaveOptions {_includeText = Nothing})}))
102126
103− nothingWorkspace = Just (WorkspaceOptions {_workspaceFolders = Nothing})
104−
105127 chk :: (Eq a, Show a) => TestName -> (InitializeResponseCapabilitiesInner -> a) -> a -> TestTree
106128 chk title getActual expected =
107129 testCase title $ getInitializeResponse >>= \ir -> expected @=? (getActual . innerCaps) ir
108130
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+
109140 innerCaps :: InitializeResponse -> InitializeResponseCapabilitiesInner
110− innerCaps (ResponseMessage _ _ (Just (InitializeResponseCapabilities c)) _) = c
141+ innerCaps (ResponseMessage _ _ (Right (InitializeResponseCapabilities c))) = c
111142 innerCaps _ = error "this test only expects inner capabilities"
112143
113144 acquire :: IO InitializeResponse
@@ -121,7 +152,7 @@ diagnosticTests :: TestTree
121152diagnosticTests = testGroup "diagnostics"
122153 [ testSessionWait "fix syntax error" $ do
123154 let content = T.unlines [ "module Testing wher" ]
124− doc <- openDoc' "Testing.hs" "haskell" content
155+ doc <- createDoc "Testing.hs" "haskell" content
125156 expectDiagnostics [("Testing.hs", [(DsError, (0, 15), "parse error")])]
126157 let change = TextDocumentContentChangeEvent
127158 { _range = Just (Range (Position 0 15) (Position 0 19))
@@ -132,9 +163,9 @@ diagnosticTests = testGroup "diagnostics"
132163 expectDiagnostics [("Testing.hs", [])]
133164 , testSessionWait "introduce syntax error" $ do
134165 let content = T.unlines [ "module Testing where" ]
135− doc <- openDoc' "Testing.hs" "haskell" content
136− void (message :: Session WorkDoneProgressCreateRequest)
137− 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)
138169 let change = TextDocumentContentChangeEvent
139170 { _range = Just (Range (Position 0 15) (Position 0 18))
140171 , _rangeLength = Nothing
@@ -150,7 +181,7 @@ diagnosticTests = testGroup "diagnostics"
150181 , "bar :: Int -> Int -> Int"
151182 , "bar a b = cd + b"
152183 ]
153− _ <- openDoc' "Testing.hs" "haskell" content
184+ _ <- createDoc "Testing.hs" "haskell" content
154185 expectDiagnostics
155186 [ ( "Testing.hs"
156187 , [ (DsError, (2, 14), "Variable not in scope: ab")
@@ -164,7 +195,7 @@ diagnosticTests = testGroup "diagnostics"
164195 , "foo :: Int -> String -> Int"
165196 , "foo a b = a + b"
166197 ]
167− _ <- openDoc' "Testing.hs" "haskell" content
198+ _ <- createDoc "Testing.hs" "haskell" content
168199 expectDiagnostics
169200 [ ( "Testing.hs"
170201 , [(DsError, (2, 14), "Couldn't match type '[Char]' with 'Int'")]
@@ -176,7 +207,7 @@ diagnosticTests = testGroup "diagnostics"
176207 , "foo :: Int -> String"
177208 , "foo a = _ a"
178209 ]
179− _ <- openDoc' "Testing.hs" "haskell" content
210+ _ <- createDoc "Testing.hs" "haskell" content
180211 expectDiagnostics
181212 [ ( "Testing.hs"
182213 , [(DsError, (2, 8), "Found hole: _ :: Int -> String")]
@@ -198,24 +229,23 @@ diagnosticTests = testGroup "diagnostics"
198229 [ ("A.hs", [(DsError, (2,4), aMessage)])
199230 , ("B.hs", [(DsError, (3,4), bMessage)])]
200231 deferralTest title binding msg = testSessionWait title $ do
201− _ <- openDoc' "A.hs" "haskell" $ sourceA binding
202− _ <- openDoc' "B.hs" "haskell" sourceB
232+ _ <- createDoc "A.hs" "haskell" $ sourceA binding
233+ _ <- createDoc "B.hs" "haskell" sourceB
203234 expectDiagnostics $ expectedDs msg
204235 in
205236 [ deferralTest "type error" "True" "Couldn't match expected type"
206237 , deferralTest "typed hole" "_" "Found hole"
207238 , deferralTest "out of scope var" "unbound" "Variable not in scope"
208− , deferralTest "message shows error" "True" "A.hs:3:5: error:"
209239 ]
210240
211241 , testSessionWait "remove required module" $ do
212242 let contentA = T.unlines [ "module ModuleA where" ]
213− docA <- openDoc' "ModuleA.hs" "haskell" contentA
243+ docA <- createDoc "ModuleA.hs" "haskell" contentA
214244 let contentB = T.unlines
215245 [ "module ModuleB where"
216246 , "import ModuleA"
217247 ]
218− _ <- openDoc' "ModuleB.hs" "haskell" contentB
248+ _ <- createDoc "ModuleB.hs" "haskell" contentB
219249 let change = TextDocumentContentChangeEvent
220250 { _range = Just (Range (Position 0 0) (Position 0 20))
221251 , _rangeLength = Nothing
@@ -228,11 +258,21 @@ diagnosticTests = testGroup "diagnostics"
228258 [ "module ModuleB where"
229259 , "import ModuleA"
230260 ]
231− _ <- openDoc' "ModuleB.hs" "haskell" contentB
261+ _ <- createDoc "ModuleB.hs" "haskell" contentB
232262 expectDiagnostics [("ModuleB.hs", [(DsError, (1, 7), "Could not find module")])]
233263 let contentA = T.unlines [ "module ModuleA where" ]
234− _ <- openDoc' "ModuleA.hs" "haskell" contentA
264+ _ <- createDoc "ModuleA.hs" "haskell" contentA
235265 expectDiagnostics [("ModuleB.hs", [])]
266+ , testSessionWait "add missing module (non workspace)" $ do
267+ let contentB = T.unlines
268+ [ "module ModuleB where"
269+ , "import ModuleA"
270+ ]
271+ _ <- createDoc "/tmp/ModuleB.hs" "haskell" contentB
272+ expectDiagnostics [("/tmp/ModuleB.hs", [(DsError, (1, 7), "Could not find module")])]
273+ let contentA = T.unlines [ "module ModuleA where" ]
274+ _ <- createDoc "/tmp/ModuleA.hs" "haskell" contentA
275+ expectDiagnostics [("/tmp/ModuleB.hs", [])]
236276 , testSessionWait "cyclic module dependency" $ do
237277 let contentA = T.unlines
238278 [ "module ModuleA where"
@@ -242,8 +282,8 @@ diagnosticTests = testGroup "diagnostics"
242282 [ "module ModuleB where"
243283 , "import ModuleA"
244284 ]
245− _ <- openDoc' "ModuleA.hs" "haskell" contentA
246− _ <- openDoc' "ModuleB.hs" "haskell" contentB
285+ _ <- createDoc "ModuleA.hs" "haskell" contentA
286+ _ <- createDoc "ModuleB.hs" "haskell" contentB
247287 expectDiagnostics
248288 [ ( "ModuleA.hs"
249289 , [(DsError, (1, 7), "Cyclic module dependency between ModuleA, ModuleB")]
@@ -264,9 +304,9 @@ diagnosticTests = testGroup "diagnostics"
264304 let contentBboot = T.unlines
265305 [ "module ModuleB where"
266306 ]
267− _ <- openDoc' "ModuleA.hs" "haskell" contentA
268− _ <- openDoc' "ModuleB.hs" "haskell" contentB
269− _ <- 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
270310 expectDiagnostics []
271311 , testSessionWait "correct reference used with hs-boot" $ do
272312 let contentB = T.unlines
@@ -288,10 +328,10 @@ diagnosticTests = testGroup "diagnostics"
288328 -- resolved to the hs-boot file
289329 , "y = x"
290330 ]
291− _ <- openDoc' "ModuleB.hs" "haskell" contentB
292− _ <- openDoc' "ModuleA.hs" "haskell" contentA
293− _ <- openDoc' "ModuleA.hs-boot" "haskell" contentAboot
294− _ <- 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
295335 expectDiagnostics []
296336 , testSessionWait "redundant import" $ do
297337 let contentA = T.unlines ["module ModuleA where"]
@@ -300,8 +340,8 @@ diagnosticTests = testGroup "diagnostics"
300340 , "module ModuleB where"
301341 , "import ModuleA"
302342 ]
303− _ <- openDoc' "ModuleA.hs" "haskell" contentA
304− _ <- openDoc' "ModuleB.hs" "haskell" contentB
343+ _ <- createDoc "ModuleA.hs" "haskell" contentA
344+ _ <- createDoc "ModuleB.hs" "haskell" contentB
305345 expectDiagnostics
306346 [ ( "ModuleB.hs"
307347 , [(DsWarning, (2, 0), "The import of 'ModuleA' is redundant")]
@@ -323,8 +363,8 @@ diagnosticTests = testGroup "diagnostics"
323363 , "wrong1 = ThisList.map"
324364 , "wrong2 = BaseList.x"
325365 ]
326− _ <- openDoc' "Data/List.hs" "haskell" thisDataListContent
327− _ <- openDoc' "Main.hs" "haskell" mainContent
366+ _ <- createDoc "Data/List.hs" "haskell" thisDataListContent
367+ _ <- createDoc "Main.hs" "haskell" mainContent
328368 expectDiagnostics
329369 [ ( "Main.hs"
330370 , [(DsError, (6, 9), "Not in scope: \8216ThisList.map\8217")
@@ -339,7 +379,7 @@ diagnosticTests = testGroup "diagnostics"
339379 , "foo :: Ord a => a -> Int"
340380 , "foo a = 1"
341381 ]
342− _ <- openDoc' "Foo.hs" "haskell" fooContent
382+ _ <- createDoc "Foo.hs" "haskell" fooContent
343383 expectDiagnostics
344384 [ ( "Foo.hs"
345385 -- The test is to make sure that warnings contain unqualified names
@@ -364,18 +404,18 @@ diagnosticTests = testGroup "diagnostics"
364404 Just pathB <- pure $ uriToFilePath uriB
365405 uriB <- pure $
366406 let (drive, suffix) = splitDrive pathB
367− in filePathToUri (joinDrive (map toLower drive ) suffix)
407+ in filePathToUri (joinDrive (lower drive) suffix)
368408 liftIO $ createDirectoryIfMissing True (takeDirectory pathB)
369409 liftIO $ writeFileUTF8 pathB $ T.unpack bContent
370410 uriA <- getDocUri "A/A.hs"
371411 Just pathA <- pure $ uriToFilePath uriA
372412 uriA <- pure $
373413 let (drive, suffix) = splitDrive pathA
374− in filePathToUri (joinDrive (map toLower drive ) suffix)
414+ in filePathToUri (joinDrive (lower drive) suffix)
375415 let itemA = TextDocumentItem uriA "haskell" 0 aContent
376416 let a = TextDocumentIdentifier uriA
377417 sendNotification TextDocumentDidOpen (DidOpenTextDocumentParams itemA)
378− diagsNot <- skipManyTill anyMessage message :: Session PublishDiagnosticsNotification
418+ diagsNot <- skipManyTill anyMessage diagnostic
379419 let PublishDiagnosticsParams fileUri diags = _params (diagsNot :: PublishDiagnosticsNotification)
380420 -- Check that if we put a lower-case drive in for A.A
381421 -- the diagnostics for A.B will also be lower-case.
@@ -384,6 +424,38 @@ diagnosticTests = testGroup "diagnostics"
384424 liftIO $ unless ("redundant" `T.isInfixOf` msg) $
385425 assertFailure ("Expected redundant import but got " <> T.unpack msg)
386426 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
387459 ]
388460
389461codeActionTests :: TestTree
@@ -392,6 +464,7 @@ codeActionTests = testGroup "code actions"
392464 , typeWildCardActionTests
393465 , removeImportTests
394466 , extendImportTests
467+ , suggestImportTests
395468 , addExtensionTests
396469 , fixConstructorImportTests
397470 , importRenameActionTests
@@ -405,6 +478,33 @@ codeLensesTests = testGroup "code lenses"
405478 [ addSigLensesTests
406479 ]
407480
481+watchedFilesTests :: TestTree
482+watchedFilesTests = testGroup "watched files"
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+
505+ -- TODO add a test for didChangeWorkspaceFolder
506+ ]
507+
408508renameActionTests :: TestTree
409509renameActionTests = testGroup "rename actions"
410510 [ testSession "change to local variable name" $ do
@@ -413,7 +513,7 @@ renameActionTests = testGroup "rename actions"
413513 , "foo :: Int -> Int"
414514 , "foo argName = argNme"
415515 ]
416− doc <- openDoc' "Testing.hs" "haskell" content
516+ doc <- createDoc "Testing.hs" "haskell" content
417517 _ <- waitForDiagnostics
418518 action <- findCodeAction doc (Range (Position 2 14) (Position 2 20)) "Replace with ‘argName’"
419519 executeCodeAction action
@@ -431,7 +531,7 @@ renameActionTests = testGroup "rename actions"
431531 , "foo :: Maybe a -> [a]"
432532 , "foo = maybToList"
433533 ]
434− doc <- openDoc' "Testing.hs" "haskell" content
534+ doc <- createDoc "Testing.hs" "haskell" content
435535 _ <- waitForDiagnostics
436536 action <- findCodeAction doc (Range (Position 3 6) (Position 3 16)) "Replace with ‘maybeToList’"
437537 executeCodeAction action
@@ -449,7 +549,7 @@ renameActionTests = testGroup "rename actions"
449549 , "foo :: Char -> Char -> Char -> Char"
450550 , "foo argument1 argument2 argument3 = argumentX"
451551 ]
452− doc <- openDoc' "Testing.hs" "haskell" content
552+ doc <- createDoc "Testing.hs" "haskell" content
453553 _ <- waitForDiagnostics
454554 _ <- findCodeActions doc (Range (Position 2 36) (Position 2 45))
455555 ["Replace with ‘argument1’", "Replace with ‘argument2’", "Replace with ‘argument3’"]
@@ -461,7 +561,7 @@ renameActionTests = testGroup "rename actions"
461561 , "monus x y = max 0 (x - y)"
462562 , "foo x y = x `monnus` y"
463563 ]
464− doc <- openDoc' "Testing.hs" "haskell" content
564+ doc <- createDoc "Testing.hs" "haskell" content
465565 _ <- waitForDiagnostics
466566 actionsOrCommands <- getCodeActions doc (Range (Position 3 12) (Position 3 20))
467567 [fixTypo] <- pure [action | CACodeAction action@CodeAction{ _title = actionTitle } <- actionsOrCommands, "monus" `T.isInfixOf` actionTitle ]
@@ -484,7 +584,7 @@ typeWildCardActionTests = testGroup "type wildcard actions"
484584 , "func :: _"
485585 , "func x = x"
486586 ]
487− doc <- openDoc' "Testing.hs" "haskell" content
587+ doc <- createDoc "Testing.hs" "haskell" content
488588 _ <- waitForDiagnostics
489589 actionsOrCommands <- getCodeActions doc (Range (Position 2 1) (Position 2 10))
490590 let [addSignature] = [action | CACodeAction action@CodeAction { _title = actionTitle } <- actionsOrCommands
@@ -504,7 +604,7 @@ typeWildCardActionTests = testGroup "type wildcard actions"
504604 , "func :: _"
505605 , "func x y = x + y"
506606 ]
507− doc <- openDoc' "Testing.hs" "haskell" content
607+ doc <- createDoc "Testing.hs" "haskell" content
508608 _ <- waitForDiagnostics
509609 actionsOrCommands <- getCodeActions doc (Range (Position 2 1) (Position 2 10))
510610 let [addSignature] = [action | CACodeAction action@CodeAction { _title = actionTitle } <- actionsOrCommands
@@ -527,7 +627,7 @@ typeWildCardActionTests = testGroup "type wildcard actions"
527627 , " y = x * 2"
528628 , " in y"
529629 ]
530− doc <- openDoc' "Testing.hs" "haskell" content
630+ doc <- createDoc "Testing.hs" "haskell" content
531631 _ <- waitForDiagnostics
532632 actionsOrCommands <- getCodeActions doc (Range (Position 4 1) (Position 4 10))
533633 let [addSignature] = [action | CACodeAction action@CodeAction { _title = actionTitle } <- actionsOrCommands
@@ -552,7 +652,7 @@ removeImportTests = testGroup "remove import actions"
552652 let contentA = T.unlines
553653 [ "module ModuleA where"
554654 ]
555− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
655+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
556656 let contentB = T.unlines
557657 [ "{-# OPTIONS_GHC -Wunused-imports #-}"
558658 , "module ModuleB where"
@@ -560,7 +660,7 @@ removeImportTests = testGroup "remove import actions"
560660 , "stuffB :: Integer"
561661 , "stuffB = 123"
562662 ]
563− docB <- openDoc' "ModuleB.hs" "haskell" contentB
663+ docB <- createDoc "ModuleB.hs" "haskell" contentB
564664 _ <- waitForDiagnostics
565665 [CACodeAction action@CodeAction { _title = actionTitle }]
566666 <- getCodeActions docB (Range (Position 2 0) (Position 2 5))
@@ -578,7 +678,7 @@ removeImportTests = testGroup "remove import actions"
578678 let contentA = T.unlines
579679 [ "module ModuleA where"
580680 ]
581− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
681+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
582682 let contentB = T.unlines
583683 [ "{-# OPTIONS_GHC -Wunused-imports #-}"
584684 , "module ModuleB where"
@@ -586,7 +686,7 @@ removeImportTests = testGroup "remove import actions"
586686 , "stuffB :: Integer"
587687 , "stuffB = 123"
588688 ]
589− docB <- openDoc' "ModuleB.hs" "haskell" contentB
689+ docB <- createDoc "ModuleB.hs" "haskell" contentB
590690 _ <- waitForDiagnostics
591691 [CACodeAction action@CodeAction { _title = actionTitle }]
592692 <- getCodeActions docB (Range (Position 2 0) (Position 2 5))
@@ -608,14 +708,14 @@ removeImportTests = testGroup "remove import actions"
608708 , "stuffB = 123"
609709 , "stuffC = ()"
610710 ]
611− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
711+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
612712 let contentB = T.unlines
613713 [ "{-# OPTIONS_GHC -Wunused-imports #-}"
614714 , "module ModuleB where"
615715 , "import ModuleA (stuffA, stuffB, stuffC, stuffA)"
616716 , "main = print stuffB"
617717 ]
618− docB <- openDoc' "ModuleB.hs" "haskell" contentB
718+ docB <- createDoc "ModuleB.hs" "haskell" contentB
619719 _ <- waitForDiagnostics
620720 [CACodeAction action@CodeAction { _title = actionTitle }]
621721 <- getCodeActions docB (Range (Position 2 0) (Position 2 5))
@@ -629,29 +729,26 @@ removeImportTests = testGroup "remove import actions"
629729 , "main = print stuffB"
630730 ]
631731 liftIO $ expectedContentAfterAction @=? contentAfterAction
632− , testSession "redundant symbol binding" $ do
732+ , testSession "redundant operator" $ do
633733 let contentA = T.unlines
634734 [ "module ModuleA where"
635735 , "a !! b = a"
736+ , "a <?> b = a"
636737 , "stuffB :: Integer"
637738 , "stuffB = 123"
638739 ]
639− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
740+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
640741 let contentB = T.unlines
641742 [ "{-# OPTIONS_GHC -Wunused-imports #-}"
642743 , "module ModuleB where"
643− , "import qualified ModuleA as A ((!!), stuffB, (!!))"
744+ , "import qualified ModuleA as A ((<?>), stuffB, (!!))"
644745 , "main = print A.stuffB"
645746 ]
646− docB <- openDoc' "ModuleB.hs" "haskell" contentB
747+ docB <- createDoc "ModuleB.hs" "haskell" contentB
647748 _ <- waitForDiagnostics
648749 [CACodeAction action@CodeAction { _title = actionTitle }]
649750 <- getCodeActions docB (Range (Position 2 0) (Position 2 5))
650−#if MIN_GHC_API_VERSION(8,6,0)
651− liftIO $ "Remove !! from import" @=? actionTitle
652−#else
653− liftIO $ "Remove A.!! from import" @=? actionTitle
654−#endif
751+ liftIO $ "Remove !!, <?> from import" @=? actionTitle
655752 executeCodeAction action
656753 contentAfterAction <- documentContents docB
657754 let expectedContentAfterAction = T.unlines
@@ -661,21 +758,21 @@ removeImportTests = testGroup "remove import actions"
661758 , "main = print A.stuffB"
662759 ]
663760 liftIO $ expectedContentAfterAction @=? contentAfterAction
664− , (`xfail` "known broken (#299)") $ testSession "redundant hierarchical import" $ do
761+ , testSession "redundant all import" $ do
665762 let contentA = T.unlines
666763 [ "module ModuleA where"
667764 , "data A = A"
668765 , "stuffB :: Integer"
669766 , "stuffB = 123"
670767 ]
671− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
768+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
672769 let contentB = T.unlines
673770 [ "{-# OPTIONS_GHC -Wunused-imports #-}"
674771 , "module ModuleB where"
675772 , "import ModuleA (A(..), stuffB)"
676773 , "main = print stuffB"
677774 ]
678− docB <- openDoc' "ModuleB.hs" "haskell" contentB
775+ docB <- createDoc "ModuleB.hs" "haskell" contentB
679776 _ <- waitForDiagnostics
680777 [CACodeAction action@CodeAction { _title = actionTitle }]
681778 <- getCodeActions docB (Range (Position 2 0) (Position 2 5))
@@ -689,6 +786,33 @@ removeImportTests = testGroup "remove import actions"
689786 , "main = print stuffB"
690787 ]
691788 liftIO $ expectedContentAfterAction @=? contentAfterAction
789+ , testSession "redundant constructor import" $ do
790+ let contentA = T.unlines
791+ [ "module ModuleA where"
792+ , "data D = A | B"
793+ , "data E = F"
794+ ]
795+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
796+ let contentB = T.unlines
797+ [ "{-# OPTIONS_GHC -Wunused-imports #-}"
798+ , "module ModuleB where"
799+ , "import ModuleA (D(A,B), E(F))"
800+ , "main = B"
801+ ]
802+ docB <- createDoc "ModuleB.hs" "haskell" contentB
803+ _ <- waitForDiagnostics
804+ [CACodeAction action@CodeAction { _title = actionTitle }]
805+ <- getCodeActions docB (Range (Position 2 0) (Position 2 5))
806+ liftIO $ "Remove A, E, F from import" @=? actionTitle
807+ executeCodeAction action
808+ contentAfterAction <- documentContents docB
809+ let expectedContentAfterAction = T.unlines
810+ [ "{-# OPTIONS_GHC -Wunused-imports #-}"
811+ , "module ModuleB where"
812+ , "import ModuleA (D(B))"
813+ , "main = B"
814+ ]
815+ liftIO $ expectedContentAfterAction @=? contentAfterAction
692816 ]
693817
694818extendImportTests :: TestTree
@@ -713,6 +837,26 @@ extendImportTests = testGroup "extend import actions"
713837 , "import ModuleA as A (stuffA, stuffB)"
714838 , "main = print (stuffA, stuffB)"
715839 ])
840+ , testSession "extend single line import with operator" $ template
841+ (T.unlines
842+ [ "module ModuleA where"
843+ , "(.*) :: Integer -> Integer -> Integer"
844+ , "x .* y = x * y"
845+ , "stuffB :: Integer"
846+ , "stuffB = 123"
847+ ])
848+ (T.unlines
849+ [ "module ModuleB where"
850+ , "import ModuleA as A (stuffB)"
851+ , "main = print (stuffB .* stuffB)"
852+ ])
853+ (Range (Position 3 17) (Position 3 18))
854+ "Add .* to the import list of ModuleA"
855+ (T.unlines
856+ [ "module ModuleB where"
857+ , "import ModuleA as A ((.*), stuffB)"
858+ , "main = print (stuffB .* stuffB)"
859+ ])
716860 , testSession "extend single line import with type" $ template
717861 (T.unlines
718862 [ "module ModuleA where"
@@ -796,8 +940,8 @@ extendImportTests = testGroup "extend import actions"
796940 ]
797941 where
798942 template contentA contentB range expectedAction expectedContentB = do
799− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
800− docB <- openDoc' "ModuleB.hs" "haskell" contentB
943+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
944+ docB <- createDoc "ModuleB.hs" "haskell" contentB
801945 _ <- waitForDiagnostics
802946 CACodeAction action@CodeAction { _title = actionTitle } : _
803947 <- sortOn (\(CACodeAction CodeAction{_title=x}) -> x) <$>
@@ -807,6 +951,61 @@ extendImportTests = testGroup "extend import actions"
807951 contentAfterAction <- documentContents docB
808952 liftIO $ expectedContentB @=? contentAfterAction
809953
954+suggestImportTests :: TestTree
955+suggestImportTests = testGroup "suggest import actions"
956+ [ testGroup "Dont want suggestion"
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)"
965+ ]
966+ , testGroup "want suggestion"
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 ((&))"
986+ ]
987+ ]
988+ where
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
995+ _diags <- waitForDiagnostics
996+ let defLine = length imps + 1
997+ range = Range (Position defLine 0) (Position defLine maxBound)
998+ actions <- getCodeActions doc range
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+
1008+
8101009addExtensionTests :: TestTree
8111010addExtensionTests = testGroup "add language extension actions"
8121011 [ testSession "add NamedFieldPuns language extension" $ template
@@ -852,7 +1051,7 @@ addExtensionTests = testGroup "add language extension actions"
8521051 ]
8531052 where
8541053 template initialContent range expectedAction expectedContents = do
855− doc <- openDoc' "Module.hs" "haskell" initialContent
1054+ doc <- createDoc "Module.hs" "haskell" initialContent
8561055 _ <- waitForDiagnostics
8571056 CACodeAction action@CodeAction { _title = actionTitle } : _
8581057 <- sortOn (\(CACodeAction CodeAction{_title=x}) -> x) <$>
@@ -875,7 +1074,7 @@ insertNewDefinitionTests = testGroup "insert new definition actions"
8751074 [""
8761075 ,"someOtherCode = ()"
8771076 ]
878− docB <- openDoc' "ModuleB.hs" "haskell" (T.unlines $ txtB ++ txtB')
1077+ docB <- createDoc "ModuleB.hs" "haskell" (T.unlines $ txtB ++ txtB')
8791078 _ <- waitForDiagnostics
8801079 CACodeAction action@CodeAction { _title = actionTitle } : _
8811080 <- sortOn (\(CACodeAction CodeAction{_title=x}) -> x) <$>
@@ -899,7 +1098,7 @@ insertNewDefinitionTests = testGroup "insert new definition actions"
8991098 [""
9001099 ,"someOtherCode = ()"
9011100 ]
902− docB <- openDoc' "ModuleB.hs" "haskell" (T.unlines $ txtB ++ txtB')
1101+ docB <- createDoc "ModuleB.hs" "haskell" (T.unlines $ txtB ++ txtB')
9031102 _ <- waitForDiagnostics
9041103 CACodeAction action@CodeAction { _title = actionTitle } : _
9051104 <- sortOn (\(CACodeAction CodeAction{_title=x}) -> x) <$>
@@ -938,8 +1137,8 @@ fixConstructorImportTests = testGroup "fix import actions"
9381137 ]
9391138 where
9401139 template contentA contentB range expectedAction expectedContentB = do
941− _docA <- openDoc' "ModuleA.hs" "haskell" contentA
942− docB <- openDoc' "ModuleB.hs" "haskell" contentB
1140+ _docA <- createDoc "ModuleA.hs" "haskell" contentA
1141+ docB <- createDoc "ModuleB.hs" "haskell" contentB
9431142 _diags <- waitForDiagnostics
9441143 CACodeAction action@CodeAction { _title = actionTitle } : _
9451144 <- sortOn (\(CACodeAction CodeAction{_title=x}) -> x) <$>
@@ -958,7 +1157,7 @@ importRenameActionTests = testGroup "import rename actions"
9581157 [ "module Testing where"
9591158 , "import Data.Mape"
9601159 ]
961− doc <- openDoc' "Testing.hs" "haskell" content
1160+ doc <- createDoc "Testing.hs" "haskell" content
9621161 _ <- waitForDiagnostics
9631162 actionsOrCommands <- getCodeActions doc (Range (Position 2 8) (Position 2 16))
9641163 let [changeToMap] = [action | CACodeAction action@CodeAction{ _title = actionTitle } <- actionsOrCommands, ("Data." <> modname) `T.isInfixOf` actionTitle ]
@@ -995,10 +1194,10 @@ fillTypedHoleTests = let
9951194 newA newB newC = testSession (T.unpack actionTitle) $ do
9961195 let originalCode = sourceCode oldA oldB oldC
9971196 let expectedCode = sourceCode newA newB newC
998− doc <- openDoc' "Testing.hs" "haskell" originalCode
1197+ doc <- createDoc "Testing.hs" "haskell" originalCode
9991198 _ <- waitForDiagnostics
10001199 actionsOrCommands <- getCodeActions doc (Range (Position 9 0) (Position 9 maxBound))
1001− let chosenAction = pickActionWithTitle actionTitle actionsOrCommands
1200+ chosenAction <- liftIO $ pickActionWithTitle actionTitle actionsOrCommands
10021201 executeCodeAction chosenAction
10031202 modifiedCode <- documentContents doc
10041203 liftIO $ expectedCode @=? modifiedCode
@@ -1035,36 +1234,37 @@ fillTypedHoleTests = let
10351234
10361235addSigActionTests :: TestTree
10371236addSigActionTests = let
1038− header = "{-# OPTIONS_GHC -Wmissing-signatures #-}"
1039− moduleH = "module Sigs where"
1237+ header = "{-# OPTIONS_GHC -Wmissing-signatures -Wmissing-pattern-synonym-signatures #-}"
1238+ moduleH = "{-# LANGUAGE PatternSynonyms #-}\nmodule Sigs where"
10401239 before def = T.unlines [header, moduleH, def]
10411240 after' def sig = T.unlines [header, moduleH, sig, def]
10421241
10431242 def >:: sig = testSession (T.unpack def) $ do
10441243 let originalCode = before def
10451244 let expectedCode = after' def sig
1046− doc <- openDoc' "Sigs.hs" "haskell" originalCode
1245+ doc <- createDoc "Sigs.hs" "haskell" originalCode
10471246 _ <- waitForDiagnostics
10481247 actionsOrCommands <- getCodeActions doc (Range (Position 3 1) (Position 3 maxBound))
1049− let chosenAction = pickActionWithTitle ("add signature: " <> sig) actionsOrCommands
1248+ chosenAction <- liftIO $ pickActionWithTitle ("add signature: " <> sig) actionsOrCommands
10501249 executeCodeAction chosenAction
10511250 modifiedCode <- documentContents doc
10521251 liftIO $ expectedCode @=? modifiedCode
10531252 in
10541253 testGroup "add signature"
1055− [ "abc = True" >:: "abc :: Bool"
1056− , "foo a b = a + b" >:: "foo :: Num a => a -> a -> a"
1057− , "bar a b = show $ a + b" >:: "bar :: (Show a, Num a) => a -> a -> String"
1058− , "(!!!) a b = a > b" >:: "(!!!) :: Ord a => a -> a -> Bool"
1059− , "a >>>> b = a + b" >:: "(>>>>) :: Num a => a -> a -> a"
1060− , "a `haha` b = a b" >:: "haha :: (t1 -> t2) -> t1 -> t2"
1254+ [ "abc = True" >:: "abc :: Bool"
1255+ , "foo a b = a + b" >:: "foo :: Num a => a -> a -> a"
1256+ , "bar a b = show $ a + b" >:: "bar :: (Show a, Num a) => a -> a -> String"
1257+ , "(!!!) a b = a > b" >:: "(!!!) :: Ord a => a -> a -> Bool"
1258+ , "a >>>> b = a + b" >:: "(>>>>) :: Num a => a -> a -> a"
1259+ , "a `haha` b = a b" >:: "haha :: (t1 -> t2) -> t1 -> t2"
1260+ , "pattern Some a = Just a" >:: "pattern Some :: a -> Maybe a"
10611261 ]
10621262
10631263addSigLensesTests :: TestTree
10641264addSigLensesTests = let
1065− missing = "{-# OPTIONS_GHC -Wmissing-signatures -Wunused-matches #-}"
1265+ missing = "{-# OPTIONS_GHC -Wmissing-signatures -Wmissing-pattern-synonym-signatures -Wunused-matches #-}"
10661266 notMissing = "{-# OPTIONS_GHC -Wunused-matches #-}"
1067− moduleH = "module Sigs where"
1267+ moduleH = "{-# LANGUAGE PatternSynonyms #-}\nmodule Sigs where"
10681268 other = T.unlines ["f :: Integer -> Integer", "f x = 3"]
10691269 before withMissing def
10701270 = T.unlines $ (if withMissing then (missing :) else (notMissing :)) [moduleH, def, other]
@@ -1074,49 +1274,41 @@ addSigLensesTests = let
10741274 sigSession withMissing def sig = testSession (T.unpack def) $ do
10751275 let originalCode = before withMissing def
10761276 let expectedCode = after' withMissing def sig
1077− doc <- openDoc' "Sigs.hs" "haskell" originalCode
1277+ doc <- createDoc "Sigs.hs" "haskell" originalCode
10781278 [CodeLens {_command = Just c}] <- getCodeLenses doc
10791279 executeCommand c
10801280 modifiedCode <- getDocumentEdit doc
10811281 liftIO $ expectedCode @=? modifiedCode
10821282 in
10831283 testGroup "add signature"
1084− [ testGroup "with warnings enabled"
1085− [ sigSession True "abc = True" "abc :: Bool"
1086− , sigSession True "foo a b = a + b" "foo :: Num a => a -> a -> a"
1087− , sigSession True "bar a b = show $ a + b" "bar :: (Show a, Num a) => a -> a -> String"
1088− , sigSession True "(!!!) a b = a > b" "(!!!) :: Ord a => a -> a -> Bool"
1089− , sigSession True "a >>>> b = a + b" "(>>>>) :: Num a => a -> a -> a"
1090− , sigSession True "a `haha` b = a b" "haha :: (t1 -> t2) -> t1 -> t2"
1091− ]
1092− , testGroup "with warnings disabled"
1093− [ sigSession False "abc = True" "abc :: Bool"
1094− , sigSession False "foo a b = a + b" "foo :: Num a => a -> a -> a"
1095− , sigSession False "bar a b = show $ a + b" "bar :: (Show a, Num a) => a -> a -> String"
1096− , sigSession False "(!!!) a b = a > b" "(!!!) :: Ord a => a -> a -> Bool"
1097− , sigSession False "a >>>> b = a + b" "(>>>>) :: Num a => a -> a -> a"
1098− , sigSession False "a `haha` b = a b" "haha :: (t1 -> t2) -> t1 -> t2"
1284+ [ testGroup title
1285+ [ sigSession enableWarnings "abc = True" "abc :: Bool"
1286+ , sigSession enableWarnings "foo a b = a + b" "foo :: Num a => a -> a -> a"
1287+ , sigSession enableWarnings "bar a b = show $ a + b" "bar :: (Show a, Num a) => a -> a -> String"
1288+ , sigSession enableWarnings "(!!!) a b = a > b" "(!!!) :: Ord a => a -> a -> Bool"
1289+ , sigSession enableWarnings "a >>>> b = a + b" "(>>>>) :: Num a => a -> a -> a"
1290+ , sigSession enableWarnings "a `haha` b = a b" "haha :: (t1 -> t2) -> t1 -> t2"
1291+ , sigSession enableWarnings "pattern Some a = Just a" "pattern Some :: a -> Maybe a"
10991292 ]
1293+ | (title, enableWarnings) <-
1294+ [("with warnings enabled", True)
1295+ ,("with warnings disabled", False)
1296+ ]
11001297 ]
11011298
1102−findDefinitionAndHoverTests :: TestTree
1103−findDefinitionAndHoverTests = let
1104−
1105− tst (get, check) pos targetRange title = testSession title $ do
1106− doc <- openTestDataDoc sourceFilePath
1107− found <- get doc pos
1108− check found targetRange
1109−
1110− checkDefs :: [Location] -> [Expect] -> Session ()
1111− checkDefs defs expectations = traverse_ check expectations where
1299+checkDefs :: [Location] -> Session [Expect] -> Session ()
1300+checkDefs defs mkExpectations = traverse_ check =<< mkExpectations where
11121301
1113− check (ExpectRange expectedRange) = do
1114− assertNDefinitionsFound 1 defs
1115− assertRangeCorrect (head defs) expectedRange
1116− check ExpectNoDefinitions = do
1117− assertNDefinitionsFound 0 defs
1118− check ExpectExternFail = liftIO $ assertFailure "Expecting to fail to find in external file"
1119− 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
11201312
11211313 assertNDefinitionsFound :: Int -> [a] -> Session ()
11221314 assertNDefinitionsFound n defs = liftIO $ assertEqual "number of definitions" n (length defs)
@@ -1124,8 +1316,19 @@ findDefinitionAndHoverTests = let
11241316 assertRangeCorrect Location{_range = foundRange} expectedRange =
11251317 liftIO $ expectedRange @=? foundRange
11261318
1127− checkHover :: Maybe Hover -> [Expect] -> Session ()
1128− 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
11291332
11301333 check expected =
11311334 case hover of
@@ -1168,9 +1371,12 @@ findDefinitionAndHoverTests = let
11681371
11691372 mkFindTests tests = testGroup "get"
11701373 [ testGroup "definition" $ mapMaybe fst tests
1171− , testGroup "hover" $ mapMaybe snd tests ]
1374+ , testGroup "hover" $ mapMaybe snd tests
1375+ , checkFileCompiles sourceFilePath ]
11721376
1173− test runDef runHover look expect title =
1377+ test runDef runHover look expect = testM runDef runHover look (return expect)
1378+
1379+ testM runDef runHover look expect title =
11741380 ( runDef $ tst def look expect title
11751381 , runHover $ tst hover look expect title ) where
11761382 def = (getDefinitions, checkDefs)
@@ -1178,87 +1384,100 @@ findDefinitionAndHoverTests = let
11781384 --type_ = (getTypeDefinitions, checkTDefs) -- getTypeDefinitions always times out
11791385
11801386 -- search locations expectations on results
1181− fffL4 = _start fffR ; fffR = mkRange 4 4 4 7 ; fff = [ExpectRange fffR]
1182− fffL8 = Position 8 4 ;
1183− fffL14 = Position 14 7 ;
1184− aaaL14 = Position 14 20 ; aaa = [mkR 7 0 7 3]
1185− dcL7 = Position 7 11 ; tcDC = [mkR 3 23 5 16]
1186− dcL12 = Position 12 11 ;
1187− xtcL5 = Position 5 11 ; xtc = [ExpectExternFail, ExpectHoverText ["Int", "Defined in ‘GHC.Types’"]]
1188− tcL6 = Position 6 11 ; tcData = [mkR 3 0 5 16, ExpectHoverText ["TypeConstructor", "GotoHover.hs:4:1"]]
1189− vvL16 = Position 16 12 ; vv = [mkR 16 4 16 6]
1190− opL16 = Position 16 15 ; op = [mkR 17 2 17 4]
1191− opL18 = Position 18 22 ; opp = [mkR 18 13 18 17]
1192− aL18 = Position 18 20 ; apmp = [mkR 18 10 18 11]
1193− b'L19 = Position 19 13 ; bp = [mkR 19 6 19 7]
1194− xvL20 = Position 20 8 ; xvMsg = [ExpectExternFail, ExpectHoverText ["Data.Text.pack", ":: String -> Text"]]
1195− clL23 = Position 23 11 ; cls = [mkR 21 0 22 20, ExpectHoverText ["MyClass", "GotoHover.hs:22:1"]]
1196− clL25 = Position 25 9
1197− eclL15 = Position 15 8 ; ecls = [ExpectExternFail, ExpectHoverText ["Num", "Defined in ‘GHC.Num’"]]
1198− dnbL29 = Position 29 18 ; dnb = [ExpectHoverText [":: ()"], mkR 29 12 29 21]
1199− dnbL30 = Position 30 23
1200− lcbL33 = Position 33 26 ; lcb = [ExpectHoverText [":: Char"], mkR 33 26 33 27]
1201− lclL33 = Position 33 22
1202− mclL36 = Position 36 1 ; mcl = [mkR 36 0 36 14]
1203− mclL37 = Position 37 1
1204− spaceL37 = Position 37 24 ; space = [ExpectNoDefinitions, ExpectHoverText [":: Char"]]
1205− 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"]]
12061412 ; constr = [ExpectHoverText ["Monad m"]]
1207− eitL40 = Position 40 28 ; kindE = [ExpectHoverText [":: * -> * -> *\n"]]
1208− intL40 = Position 40 34 ; kindI = [ExpectHoverText [":: *\n"]]
1209− tvrL40 = Position 40 37 ; kindV = [ExpectHoverText [":: * -> *\n"]]
1210− intL41 = Position 41 20 ; litI = [ExpectHoverText ["7518"]]
1211− chrL36 = Position 37 24 ; litC = [ExpectHoverText ["'f'"]]
1212− txtL8 = Position 8 14 ; litT = [ExpectHoverText ["\"dfgy\""]]
1213− lstL43 = Position 43 12 ; litL = [ExpectHoverText ["[8391 :: Int, 6268]"]]
1214− outL45 = Position 45 3 ; outSig = [ExpectHoverText ["outer", "Bool"], mkR 46 0 46 5]
1215− 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]
12161424 in
12171425 mkFindTests
1218− -- def hover look expect
1219− [ test yes yes fffL4 fff "field in record definition"
1220− , test broken broken fffL8 fff "field in record construction #71"
1221− , test yes yes fffL14 fff "field name used as accessor" -- 120 in Calculate.hs
1222− , test yes yes aaaL14 aaa "top-level name" -- 120
1223− , test yes yes dcL7 tcDC "data constructor record #247"
1224− , test yes yes dcL12 tcDC "data constructor plain" -- 121
1225− , test yes yes tcL6 tcData "type constructor #248" -- 147
1226− , test broken yes xtcL5 xtc "type constructor external #248,249"
1227− , test broken yes xvL20 xvMsg "value external package #249" -- 120
1228− , test yes yes vvL16 vv "plain parameter" -- 120
1229− , test yes yes aL18 apmp "pattern match name" -- 120
1230− , test yes yes opL16 op "top-level operator" -- 120, 123
1231− , test yes yes opL18 opp "parameter operator" -- 120
1232− , test yes yes b'L19 bp "name in backticks" -- 120
1233− , test yes yes clL23 cls "class in instance declaration #250"
1234− , test yes yes clL25 cls "class in signature #250" -- 147
1235− , test broken yes eclL15 ecls "external class in signature #249,250"
1236− , test yes yes dnbL29 dnb "do-notation bind" -- 137
1237− , test yes yes dnbL30 dnb "do-notation lookup"
1238− , test yes yes lcbL33 lcb "listcomp bind" -- 137
1239− , test yes yes lclL33 lcb "listcomp lookup"
1240− , test yes yes mclL36 mcl "top-level fn 1st clause"
1241− , test yes yes mclL37 mcl "top-level fn 2nd clause #246"
1242− , test yes yes spaceL37 space "top-level fn on space #315"
1243− , test no broken docL41 doc "documentation #7"
1244− , test no yes eitL40 kindE "kind of Either #273"
1245− , test no yes intL40 kindI "kind of Int #273"
1246− , test no broken tvrL40 kindV "kind of (* -> *) type variable #273"
1247− , test no yes intL41 litI "literal Int in hover info #274"
1248− , test no yes chrL36 litC "literal Char in hover info #274"
1249− , test no yes txtL8 litT "literal Text in hover info #274"
1250− , test no yes lstL43 litL "literal List in hover info #274"
1251− , test no yes docL41 constr "type constraint in hover info #283"
1252− , test broken broken outL45 outSig "top-level signature #310"
1253− , 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)"
12541464 ]
12551465 where yes, broken :: (TestTree -> Maybe TestTree)
12561466 yes = Just -- test should run and pass
12571467 broken = Just . (`xfail` "known broken")
12581468 no = const Nothing -- don't run this test at all
12591469
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+
12601478pluginTests :: TestTree
1261−pluginTests = testSessionWait "plugins" $ do
1479+pluginTests = (`xfail8101` "known broken (#556)")
1480+ $ testSessionWait "plugins" $ do
12621481 let content =
12631482 T.unlines
12641483 [ "{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}"
@@ -1272,7 +1491,7 @@ pluginTests = testSessionWait "plugins" $ do
12721491 , "foo :: Int -> Int -> Int"
12731492 , "foo a b = a + c"
12741493 ]
1275− _ <- openDoc' "Testing.hs" "haskell" content
1494+ _ <- createDoc "Testing.hs" "haskell" content
12761495 expectDiagnostics
12771496 [ ( "Testing.hs",
12781497 [(DsError, (8, 14), "Variable not in scope: c")]
@@ -1299,7 +1518,7 @@ cppTests =
12991518 run $ expectError content (2, 1)
13001519 )
13011520 , testSessionWait "cpp-ghcide" $ do
1302− _ <- openDoc' "A.hs" "haskell" $ T.unlines
1521+ _ <- createDoc "A.hs" "haskell" $ T.unlines
13031522 ["{-# LANGUAGE CPP #-}"
13041523 ,"main ="
13051524 ,"#ifdef __GHCIDE__"
@@ -1313,7 +1532,7 @@ cppTests =
13131532 where
13141533 expectError :: T.Text -> Cursor -> Session ()
13151534 expectError content cursor = do
1316− _ <- openDoc' "Testing.hs" "haskell" content
1535+ _ <- createDoc "Testing.hs" "haskell" content
13171536 expectDiagnostics
13181537 [ ( "Testing.hs",
13191538 [(DsError, cursor, "error: unterminated")]
@@ -1329,13 +1548,43 @@ preprocessorTests = testSessionWait "preprocessor" $ do
13291548 , "module Testing where"
13301549 , "y = x + z" -- plugin replaces x with y, making this have only one diagnostic
13311550 ]
1332− _ <- openDoc' "Testing.hs" "haskell" content
1551+ _ <- createDoc "Testing.hs" "haskell" content
13331552 expectDiagnostics
13341553 [ ( "Testing.hs",
13351554 [(DsError, (2, 8), "Variable not in scope: z")]
13361555 )
13371556 ]
13381557
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+
13391588thTests :: TestTree
13401589thTests =
13411590 testGroup
@@ -1361,9 +1610,30 @@ thTests =
13611610 "b :: Integer",
13621611 "b = $(litE $ IntegerL $ a) + n"
13631612 ]
1364− _ <- openDoc' "A.hs" "haskell" sourceA
1365− _ <- openDoc' "B.hs" "haskell" sourceB
1613+ _ <- createDoc "A.hs" "haskell" sourceA
1614+ _ <- createDoc "B.hs" "haskell" sourceB
13661615 expectDiagnostics [ ( "B.hs", [(DsError, (6, 29), "Variable not in scope: n")] ) ]
1616+ , testSessionWait "newtype-closure" $ do
1617+ let sourceA =
1618+ T.unlines
1619+ [ "{-# LANGUAGE DeriveDataTypeable #-}"
1620+ ,"{-# LANGUAGE TemplateHaskell #-}"
1621+ ,"module A (a) where"
1622+ ,"import Data.Data"
1623+ ,"import Language.Haskell.TH"
1624+ ,"newtype A = A () deriving (Data)"
1625+ ,"a :: ExpQ"
1626+ ,"a = [| 0 |]"]
1627+ let sourceB =
1628+ T.unlines
1629+ [ "{-# LANGUAGE TemplateHaskell #-}"
1630+ ,"module B where"
1631+ ,"import A"
1632+ ,"b :: Int"
1633+ ,"b = $( a )" ]
1634+ _ <- createDoc "A.hs" "haskell" sourceA
1635+ _ <- createDoc "B.hs" "haskell" sourceB
1636+ return ()
13671637 ]
13681638
13691639completionTests :: TestTree
@@ -1371,19 +1641,19 @@ completionTests
13711641 = testGroup "completion"
13721642 [ testSessionWait "variable" $ do
13731643 let source = T.unlines ["module A where", "f = hea"]
1374− docId <- openDoc' "A.hs" "haskell" source
1644+ docId <- createDoc "A.hs" "haskell" source
13751645 compls <- getCompletions docId (Position 1 7)
13761646 liftIO $ map dropDocs compls @?=
13771647 [complItem "head" (Just CiFunction) (Just "[a] -> a")]
13781648 let [CompletionItem { _documentation = headDocs}] = compls
13791649 checkDocText "head" headDocs [ "Defined in 'Prelude'"
1380−#if MIN_GHC_API_VERSION(8,6,0)
1650+#if MIN_GHC_API_VERSION(8,6,5)
13811651 , "Extract the first element of a list"
13821652#endif
13831653 ]
13841654 , testSessionWait "constructor" $ do
13851655 let source = T.unlines ["module A where", "f = Tru"]
1386− docId <- openDoc' "A.hs" "haskell" source
1656+ docId <- createDoc "A.hs" "haskell" source
13871657 compls <- getCompletions docId (Position 1 7)
13881658 liftIO $ map dropDocs compls @?=
13891659 [ complItem "True" (Just CiConstructor) (Just "Bool")
@@ -1395,7 +1665,7 @@ completionTests
13951665 ]
13961666 , testSessionWait "type" $ do
13971667 let source = T.unlines ["{-# OPTIONS_GHC -Wall #-}", "module A () where", "f :: ()", "f = ()"]
1398− docId <- openDoc' "A.hs" "haskell" source
1668+ docId <- createDoc "A.hs" "haskell" source
13991669 expectDiagnostics [ ("A.hs", [(DsWarning, (3,0), "not used")]) ]
14001670 changeDoc docId [TextDocumentContentChangeEvent Nothing Nothing $ T.unlines ["{-# OPTIONS_GHC -Wall #-}", "module A () where", "f :: Bo", "f = True"]]
14011671 compls <- getCompletions docId (Position 2 7)
@@ -1405,14 +1675,14 @@ completionTests
14051675 let [ CompletionItem { _documentation = boundedDocs},
14061676 CompletionItem { _documentation = boolDocs } ] = compls
14071677 checkDocText "Bounded" boundedDocs [ "Defined in 'Prelude'"
1408−#if MIN_GHC_API_VERSION(8,6,0)
1678+#if MIN_GHC_API_VERSION(8,6,5)
14091679 , "name the upper and lower limits"
14101680#endif
14111681 ]
14121682 checkDocText "Bool" boolDocs [ "Defined in 'Prelude'" ]
14131683 , testSessionWait "qualified" $ do
14141684 let source = T.unlines ["{-# OPTIONS_GHC -Wunused-binds #-}", "module A () where", "f = ()"]
1415− docId <- openDoc' "A.hs" "haskell" source
1685+ docId <- createDoc "A.hs" "haskell" source
14161686 expectDiagnostics [ ("A.hs", [(DsWarning, (2, 0), "not used")]) ]
14171687 changeDoc docId [TextDocumentContentChangeEvent Nothing Nothing $ T.unlines ["{-# OPTIONS_GHC -Wunused-binds #-}", "module A () where", "f = Prelude.hea"]]
14181688 compls <- getCompletions docId (Position 2 15)
@@ -1420,15 +1690,36 @@ completionTests
14201690 [complItem "head" (Just CiFunction) (Just "[a] -> a")]
14211691 let [CompletionItem { _documentation = headDocs}] = compls
14221692 checkDocText "head" headDocs [ "Defined in 'Prelude'"
1423−#if MIN_GHC_API_VERSION(8,6,0)
1693+#if MIN_GHC_API_VERSION(8,6,5)
14241694 , "Extract the first element of a list"
14251695#endif
14261696 ]
14271697 , testSessionWait "keyword" $ do
14281698 let source = T.unlines ["module A where", "f = newty"]
1429− docId <- openDoc' "A.hs" "haskell" source
1699+ docId <- createDoc "A.hs" "haskell" source
14301700 compls <- getCompletions docId (Position 1 9)
14311701 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 "*")]
14321723 ]
14331724 where
14341725 dropDocs :: CompletionItem -> CompletionItem
@@ -1436,6 +1727,7 @@ completionTests
14361727 complItem label kind ty = CompletionItem
14371728 { _label = label
14381729 , _kind = kind
1730+ , _tags = List []
14391731 , _detail = (":: " <>) <$> ty
14401732 , _documentation = Nothing
14411733 , _deprecated = Nothing
@@ -1453,6 +1745,7 @@ completionTests
14531745 keywordItem label = CompletionItem
14541746 { _label = label
14551747 , _kind = Just CiKeyword
1748+ , _tags = List []
14561749 , _detail = Nothing
14571750 , _documentation = Nothing
14581751 , _deprecated = Nothing
@@ -1480,7 +1773,7 @@ outlineTests = testGroup
14801773 "outline"
14811774 [ testSessionWait "type class" $ do
14821775 let source = T.unlines ["module A where", "class A a where a :: a -> Bool"]
1483− docId <- openDoc' "A.hs" "haskell" source
1776+ docId <- createDoc "A.hs" "haskell" source
14841777 symbols <- getDocumentSymbols docId
14851778 liftIO $ symbols @?= Left
14861779 [ moduleSymbol
@@ -1493,7 +1786,7 @@ outlineTests = testGroup
14931786 ]
14941787 , testSessionWait "type class instance " $ do
14951788 let source = T.unlines ["class A a where", "instance A () where"]
1496− docId <- openDoc' "A.hs" "haskell" source
1789+ docId <- createDoc "A.hs" "haskell" source
14971790 symbols <- getDocumentSymbols docId
14981791 liftIO $ symbols @?= Left
14991792 [ classSymbol "A a" (R 0 0 0 15) []
@@ -1501,7 +1794,7 @@ outlineTests = testGroup
15011794 ]
15021795 , testSessionWait "type family" $ do
15031796 let source = T.unlines ["{-# language TypeFamilies #-}", "type family A"]
1504− docId <- openDoc' "A.hs" "haskell" source
1797+ docId <- createDoc "A.hs" "haskell" source
15051798 symbols <- getDocumentSymbols docId
15061799 liftIO $ symbols @?= Left [docSymbolD "A" "type family" SkClass (R 1 0 1 13)]
15071800 , testSessionWait "type family instance " $ do
@@ -1510,7 +1803,7 @@ outlineTests = testGroup
15101803 , "type family A a"
15111804 , "type instance A () = ()"
15121805 ]
1513− docId <- openDoc' "A.hs" "haskell" source
1806+ docId <- createDoc "A.hs" "haskell" source
15141807 symbols <- getDocumentSymbols docId
15151808 liftIO $ symbols @?= Left
15161809 [ docSymbolD "A a" "type family" SkClass (R 1 0 1 15)
@@ -1518,7 +1811,7 @@ outlineTests = testGroup
15181811 ]
15191812 , testSessionWait "data family" $ do
15201813 let source = T.unlines ["{-# language TypeFamilies #-}", "data family A"]
1521− docId <- openDoc' "A.hs" "haskell" source
1814+ docId <- createDoc "A.hs" "haskell" source
15221815 symbols <- getDocumentSymbols docId
15231816 liftIO $ symbols @?= Left [docSymbolD "A" "data family" SkClass (R 1 0 1 11)]
15241817 , testSessionWait "data family instance " $ do
@@ -1527,7 +1820,7 @@ outlineTests = testGroup
15271820 , "data family A a"
15281821 , "data instance A () = A ()"
15291822 ]
1530− docId <- openDoc' "A.hs" "haskell" source
1823+ docId <- createDoc "A.hs" "haskell" source
15311824 symbols <- getDocumentSymbols docId
15321825 liftIO $ symbols @?= Left
15331826 [ docSymbolD "A a" "data family" SkClass (R 1 0 1 11)
@@ -1535,36 +1828,36 @@ outlineTests = testGroup
15351828 ]
15361829 , testSessionWait "constant" $ do
15371830 let source = T.unlines ["a = ()"]
1538− docId <- openDoc' "A.hs" "haskell" source
1831+ docId <- createDoc "A.hs" "haskell" source
15391832 symbols <- getDocumentSymbols docId
15401833 liftIO $ symbols @?= Left
15411834 [docSymbol "a" SkFunction (R 0 0 0 6)]
15421835 , testSessionWait "pattern" $ do
15431836 let source = T.unlines ["Just foo = Just 21"]
1544− docId <- openDoc' "A.hs" "haskell" source
1837+ docId <- createDoc "A.hs" "haskell" source
15451838 symbols <- getDocumentSymbols docId
15461839 liftIO $ symbols @?= Left
15471840 [docSymbol "Just foo" SkFunction (R 0 0 0 18)]
15481841 , testSessionWait "pattern with type signature" $ do
15491842 let source = T.unlines ["{-# language ScopedTypeVariables #-}", "a :: () = ()"]
1550− docId <- openDoc' "A.hs" "haskell" source
1843+ docId <- createDoc "A.hs" "haskell" source
15511844 symbols <- getDocumentSymbols docId
15521845 liftIO $ symbols @?= Left
15531846 [docSymbol "a :: ()" SkFunction (R 1 0 1 12)]
15541847 , testSessionWait "function" $ do
15551848 let source = T.unlines ["a x = ()"]
1556− docId <- openDoc' "A.hs" "haskell" source
1849+ docId <- createDoc "A.hs" "haskell" source
15571850 symbols <- getDocumentSymbols docId
15581851 liftIO $ symbols @?= Left [docSymbol "a" SkFunction (R 0 0 0 8)]
15591852 , testSessionWait "type synonym" $ do
15601853 let source = T.unlines ["type A = Bool"]
1561− docId <- openDoc' "A.hs" "haskell" source
1854+ docId <- createDoc "A.hs" "haskell" source
15621855 symbols <- getDocumentSymbols docId
15631856 liftIO $ symbols @?= Left
15641857 [docSymbol' "A" SkTypeParameter (R 0 0 0 13) (R 0 5 0 6)]
15651858 , testSessionWait "datatype" $ do
15661859 let source = T.unlines ["data A = C"]
1567− docId <- openDoc' "A.hs" "haskell" source
1860+ docId <- createDoc "A.hs" "haskell" source
15681861 symbols <- getDocumentSymbols docId
15691862 liftIO $ symbols @?= Left
15701863 [ docSymbolWithChildren "A"
@@ -1572,18 +1865,47 @@ outlineTests = testGroup
15721865 (R 0 0 0 10)
15731866 [docSymbol "C" SkConstructor (R 0 9 0 10)]
15741867 ]
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+ ]
15751880 , testSessionWait "import" $ do
15761881 let source = T.unlines ["import Data.Maybe"]
1577− docId <- openDoc' "A.hs" "haskell" source
1882+ docId <- createDoc "A.hs" "haskell" source
1883+ symbols <- getDocumentSymbols docId
1884+ liftIO $ symbols @?= Left
1885+ [docSymbolWithChildren "imports"
1886+ SkModule
1887+ (R 0 0 0 17)
1888+ [ docSymbol "import Data.Maybe" SkModule (R 0 0 0 17)
1889+ ]
1890+ ]
1891+ , testSessionWait "multiple import" $ do
1892+ let source = T.unlines ["", "import Data.Maybe", "", "import Control.Exception", ""]
1893+ docId <- createDoc "A.hs" "haskell" source
15781894 symbols <- getDocumentSymbols docId
15791895 liftIO $ symbols @?= Left
1580− [docSymbol "import Data.Maybe" SkModule (R 0 0 0 17)]
1896+ [docSymbolWithChildren "imports"
1897+ SkModule
1898+ (R 1 0 3 24)
1899+ [ docSymbol "import Data.Maybe" SkModule (R 1 0 1 17)
1900+ , docSymbol "import Control.Exception" SkModule (R 3 0 3 24)
1901+ ]
1902+ ]
15811903 , testSessionWait "foreign import" $ do
15821904 let source = T.unlines
15831905 [ "{-# language ForeignFunctionInterface #-}"
15841906 , "foreign import ccall \"a\" a :: Int"
15851907 ]
1586− docId <- openDoc' "A.hs" "haskell" source
1908+ docId <- createDoc "A.hs" "haskell" source
15871909 symbols <- getDocumentSymbols docId
15881910 liftIO $ symbols @?= Left [docSymbolD "a" "import" SkObject (R 1 0 1 33)]
15891911 , testSessionWait "foreign export" $ do
@@ -1591,7 +1913,7 @@ outlineTests = testGroup
15911913 [ "{-# language ForeignFunctionInterface #-}"
15921914 , "foreign export ccall odd :: Int -> Bool"
15931915 ]
1594− docId <- openDoc' "A.hs" "haskell" source
1916+ docId <- createDoc "A.hs" "haskell" source
15951917 symbols <- getDocumentSymbols docId
15961918 liftIO $ symbols @?= Left [docSymbolD "odd" "export" SkObject (R 1 0 1 39)]
15971919 ]
@@ -1604,6 +1926,8 @@ outlineTests = testGroup
16041926 DocumentSymbol name (Just detail) kind Nothing loc loc Nothing
16051927 docSymbolWithChildren name kind loc cc =
16061928 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)
16071931 moduleSymbol name loc cc = DocumentSymbol name
16081932 Nothing
16091933 SkFile
@@ -1625,8 +1949,16 @@ pattern R x y x' y' = Range (Position x y) (Position x' y')
16251949xfail :: TestTree -> String -> TestTree
16261950xfail = flip expectFailBecause
16271951
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+
16281959data Expect
16291960 = ExpectRange Range -- Both gotoDef and hover should report this range
1961+ | ExpectLocation Location
16301962-- | ExpectDefRange Range -- Only gotoDef should report this range
16311963 | ExpectHoverRange Range -- Only hover should report this range
16321964 | ExpectHoverText [T.Text] -- the hover message must contain these snippets
@@ -1638,6 +1970,226 @@ data Expect
16381970
16391971mkR :: Int -> Int -> Int -> Int -> Expect
16401972mkR startLine startColumn endLine endColumn = ExpectRange $ mkRange startLine startColumn endLine endColumn
1973+
1974+mkL :: Uri -> Int -> Int -> Int -> Int -> Expect
1975+mkL uri startLine startColumn endLine endColumn = ExpectLocation $ Location uri $ mkRange startLine startColumn endLine endColumn
1976+
1977+haddockTests :: TestTree
1978+haddockTests
1979+ = testGroup "haddock"
1980+ [ testCase "Num" $ checkHaddock
1981+ (unlines
1982+ [ "However, '(+)' and '(*)' are"
1983+ , "customarily expected to define a ring and have the following properties:"
1984+ , ""
1985+ , "[__Associativity of (+)__]: @(x + y) + z@ = @x + (y + z)@"
1986+ , "[__Commutativity of (+)__]: @x + y@ = @y + x@"
1987+ , "[__@fromInteger 0@ is the additive identity__]: @x + fromInteger 0@ = @x@"
1988+ ]
1989+ )
1990+ (unlines
1991+ [ ""
1992+ , ""
1993+ , "However, `(+)` and `(*)` are"
1994+ , "customarily expected to define a ring and have the following properties: "
1995+ , "+ ****Associativity of (+)****: `(x + y) + z` = `x + (y + z)`"
1996+ , "+ ****Commutativity of (+)****: `x + y` = `y + x`"
1997+ , "+ ****`fromInteger 0` is the additive identity****: `x + fromInteger 0` = `x`"
1998+ ]
1999+ )
2000+ , testCase "unsafePerformIO" $ checkHaddock
2001+ (unlines
2002+ [ "may require"
2003+ , "different precautions:"
2004+ , ""
2005+ , " * Use @{\\-\\# NOINLINE foo \\#-\\}@ as a pragma on any function @foo@"
2006+ , " that calls 'unsafePerformIO'. If the call is inlined,"
2007+ , " the I\\/O may be performed more than once."
2008+ , ""
2009+ , " * Use the compiler flag @-fno-cse@ to prevent common sub-expression"
2010+ , " elimination being performed on the module."
2011+ , ""
2012+ ]
2013+ )
2014+ (unlines
2015+ [ ""
2016+ , ""
2017+ , "may require"
2018+ , "different precautions: "
2019+ , "+ Use `{-# NOINLINE foo #-}` as a pragma on any function `foo` "
2020+ , " that calls `unsafePerformIO` . If the call is inlined,"
2021+ , " the I/O may be performed more than once."
2022+ , ""
2023+ , "+ Use the compiler flag `-fno-cse` to prevent common sub-expression"
2024+ , " elimination being performed on the module."
2025+ , ""
2026+ ]
2027+ )
2028+ ]
2029+ where
2030+ checkHaddock s txt = spanDocToMarkdownForTest s @?= txt
2031+
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
2155+
2156+sessionDepsArePickedUp :: TestTree
2157+sessionDepsArePickedUp = testSession'
2158+ "session-deps-are-picked-up"
2159+ $ \dir -> do
2160+ liftIO $
2161+ writeFileUTF8
2162+ (dir </> "hie.yaml")
2163+ "cradle: {direct: {arguments: []}}"
2164+ -- Open without OverloadedStrings and expect an error.
2165+ doc <- createDoc "Foo.hs" "haskell" fooContent
2166+ expectDiagnostics
2167+ [("Foo.hs", [(DsError, (3, 6), "Couldn't match expected type")])]
2168+ -- Update hie.yaml to enable OverloadedStrings.
2169+ liftIO $
2170+ writeFileUTF8
2171+ (dir </> "hie.yaml")
2172+ "cradle: {direct: {arguments: [-XOverloadedStrings]}}"
2173+ -- Send change event.
2174+ let change =
2175+ TextDocumentContentChangeEvent
2176+ { _range = Just (Range (Position 4 0) (Position 4 0)),
2177+ _rangeLength = Nothing,
2178+ _text = "\n"
2179+ }
2180+ changeDoc doc [change]
2181+ -- Now no errors.
2182+ expectDiagnostics [("Foo.hs", [])]
2183+ where
2184+ fooContent =
2185+ T.unlines
2186+ [ "module Foo where",
2187+ "import Data.Text",
2188+ "foo :: Text",
2189+ "foo = \"hello\""
2190+ ]
2191+
2192+
16412193----------------------------------------------------------------------
16422194-- Utils
16432195
@@ -1645,6 +2197,12 @@ mkR startLine startColumn endLine endColumn = ExpectRange $ mkRange startLine st
16452197testSession :: String -> Session () -> TestTree
16462198testSession name = testCase name . run
16472199
2200+testSessionWithExtraFiles :: FilePath -> String -> (FilePath -> Session ()) -> TestTree
2201+testSessionWithExtraFiles prefix name = testCase name . runWithExtraFiles prefix
2202+
2203+testSession' :: String -> (FilePath -> Session ()) -> TestTree
2204+testSession' name = testCase name . run'
2205+
16482206testSessionWait :: String -> Session () -> TestTree
16492207testSessionWait name = testSession name .
16502208 -- Check that any diagnostics produced were already consumed by the test case.
@@ -1655,24 +2213,53 @@ testSessionWait name = testSession name .
16552213 -- Experimentally, 0.5s seems to be long enough to wait for any final diagnostics to appear.
16562214 ( >> expectNoMoreDiagnostics 0.5)
16572215
1658−pickActionWithTitle :: T.Text -> [CAResult] -> CodeAction
1659−pickActionWithTitle title actions = head
1660− [ action
1661− | CACodeAction action@CodeAction{ _title = actionTitle } <- actions
1662− , 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+ ]
16632230
16642231mkRange :: Int -> Int -> Int -> Int -> Range
16652232mkRange a b c d = Range (Position a b) (Position c d)
16662233
16672234run :: Session a -> IO a
1668−run s = withTempDir $ \dir -> do
2235+run s = withTempDir $ \dir -> runInDir dir s
2236+
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+
2250+run' :: (FilePath -> Session a) -> IO a
2251+run' s = withTempDir $ \dir -> runInDir dir (s dir)
2252+
2253+runInDir :: FilePath -> Session a -> IO a
2254+runInDir dir s = do
16692255 ghcideExe <- locateGhcideExecutable
16702256
16712257 -- Temporarily hack around https://github.com/mpickering/hie-bios/pull/56
16722258 -- since the package import test creates "Data/List.hs", which otherwise has no physical home
16732259 createDirectoryIfMissing True $ dir ++ "/Data"
16742260
1675− let cmd = unwords [ghcideExe, "--lsp", "--cwd", dir]
2261+
2262+ let cmd = unwords [ghcideExe, "--lsp", "--test", "--cwd", dir]
16762263 -- HIE calls getXgdDirectory which assumes that HOME is set.
16772264 -- Only sets HOME if it wasn't already set.
16782265 setEnv "HOME" "/homeless-shelter" False
@@ -1689,7 +2276,7 @@ run s = withTempDir $ \dir -> do
16892276openTestDataDoc :: FilePath -> Session TextDocumentIdentifier
16902277openTestDataDoc path = do
16912278 source <- liftIO $ readFileUtf8 $ "test/data" </> path
1692− openDoc' path "haskell" source
2279+ createDoc path "haskell" source
16932280
16942281findCodeActions :: TextDocumentIdentifier -> Range -> [T.Text] -> Session [CodeAction]
16952282findCodeActions doc range expectedTitles = do
@@ -1704,7 +2291,7 @@ findCodeActions doc range expectedTitles = do
17042291 [ actionTitle
17052292 | CACodeAction CodeAction { _title = actionTitle } <- actions
17062293 ]
1707− ++ "is not a superset of "
2294+ ++ " is not a superset of "
17082295 ++ show expectedTitles
17092296 liftIO $ case matches of
17102297 Nothing -> assertFailure msg
@@ -1717,13 +2304,193 @@ findCodeAction doc range t = head <$> findCodeActions doc range [t]
17172304unitTests :: TestTree
17182305unitTests = do
17192306 testGroup "Unit"
1720− [ testCase "empty file path" $
1721− 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 ""
17222318 ]
17232319
1724−-- | Wrapper around 'LSPTest.openDoc'' that sends file creation events
1725−openDoc' :: FilePath -> String -> T.Text -> Session TextDocumentIdentifier
1726−openDoc' fp name contents = do
1727− res@(TextDocumentIdentifier uri) <- LSPTest.openDoc' fp name contents
1728− sendNotification WorkspaceDidChangeWatchedFiles (DidChangeWatchedFilesParams $ List [FileEvent uri FcCreated])
1729− return res
2320+positionMappingTests :: TestTree
2321+positionMappingTests =
2322+ testGroup "position mapping"
2323+ [ testGroup "toCurrent"
2324+ [ testCase "before" $
2325+ toCurrent
2326+ (Range (Position 0 1) (Position 0 3))
2327+ "ab"
2328+ (Position 0 0) @?= Just (Position 0 0)
2329+ , testCase "after, same line, same length" $
2330+ toCurrent
2331+ (Range (Position 0 1) (Position 0 3))
2332+ "ab"
2333+ (Position 0 3) @?= Just (Position 0 3)
2334+ , testCase "after, same line, increased length" $
2335+ toCurrent
2336+ (Range (Position 0 1) (Position 0 3))
2337+ "abc"
2338+ (Position 0 3) @?= Just (Position 0 4)
2339+ , testCase "after, same line, decreased length" $
2340+ toCurrent
2341+ (Range (Position 0 1) (Position 0 3))
2342+ "a"
2343+ (Position 0 3) @?= Just (Position 0 2)
2344+ , testCase "after, next line, no newline" $
2345+ toCurrent
2346+ (Range (Position 0 1) (Position 0 3))
2347+ "abc"
2348+ (Position 1 3) @?= Just (Position 1 3)
2349+ , testCase "after, next line, newline" $
2350+ toCurrent
2351+ (Range (Position 0 1) (Position 0 3))
2352+ "abc\ndef"
2353+ (Position 1 0) @?= Just (Position 2 0)
2354+ , testCase "after, same line, newline" $
2355+ toCurrent
2356+ (Range (Position 0 1) (Position 0 3))
2357+ "abc\nd"
2358+ (Position 0 4) @?= Just (Position 1 2)
2359+ , testCase "after, same line, newline + newline at end" $
2360+ toCurrent
2361+ (Range (Position 0 1) (Position 0 3))
2362+ "abc\nd\n"
2363+ (Position 0 4) @?= Just (Position 2 1)
2364+ , testCase "after, same line, newline + newline at end" $
2365+ toCurrent
2366+ (Range (Position 0 1) (Position 0 1))
2367+ "abc"
2368+ (Position 0 1) @?= Just (Position 0 4)
2369+ ]
2370+ , testGroup "fromCurrent"
2371+ [ testCase "before" $
2372+ fromCurrent
2373+ (Range (Position 0 1) (Position 0 3))
2374+ "ab"
2375+ (Position 0 0) @?= Just (Position 0 0)
2376+ , testCase "after, same line, same length" $
2377+ fromCurrent
2378+ (Range (Position 0 1) (Position 0 3))
2379+ "ab"
2380+ (Position 0 3) @?= Just (Position 0 3)
2381+ , testCase "after, same line, increased length" $
2382+ fromCurrent
2383+ (Range (Position 0 1) (Position 0 3))
2384+ "abc"
2385+ (Position 0 4) @?= Just (Position 0 3)
2386+ , testCase "after, same line, decreased length" $
2387+ fromCurrent
2388+ (Range (Position 0 1) (Position 0 3))
2389+ "a"
2390+ (Position 0 2) @?= Just (Position 0 3)
2391+ , testCase "after, next line, no newline" $
2392+ fromCurrent
2393+ (Range (Position 0 1) (Position 0 3))
2394+ "abc"
2395+ (Position 1 3) @?= Just (Position 1 3)
2396+ , testCase "after, next line, newline" $
2397+ fromCurrent
2398+ (Range (Position 0 1) (Position 0 3))
2399+ "abc\ndef"
2400+ (Position 2 0) @?= Just (Position 1 0)
2401+ , testCase "after, same line, newline" $
2402+ fromCurrent
2403+ (Range (Position 0 1) (Position 0 3))
2404+ "abc\nd"
2405+ (Position 1 2) @?= Just (Position 0 4)
2406+ , testCase "after, same line, newline + newline at end" $
2407+ fromCurrent
2408+ (Range (Position 0 1) (Position 0 3))
2409+ "abc\nd\n"
2410+ (Position 2 1) @?= Just (Position 0 4)
2411+ , testCase "after, same line, newline + newline at end" $
2412+ fromCurrent
2413+ (Range (Position 0 1) (Position 0 1))
2414+ "abc"
2415+ (Position 0 4) @?= Just (Position 0 1)
2416+ ]
2417+ , adjustOption (\(QuickCheckTests i) -> QuickCheckTests (max 1000 i)) $ testGroup "properties"
2418+ [ testProperty "fromCurrent r t <=< toCurrent r t" $ do
2419+ -- Note that it is important to use suchThatMap on all values at once
2420+ -- instead of only using it on the position. Otherwise you can get
2421+ -- into situations where there is no position that can be mapped back
2422+ -- for the edit which will result in QuickCheck looping forever.
2423+ let gen = do
2424+ rope <- genRope
2425+ range <- genRange rope
2426+ PrintableText replacement <- arbitrary
2427+ oldPos <- genPosition rope
2428+ pure (range, replacement, oldPos)
2429+ forAll
2430+ (suchThatMap gen
2431+ (\(range, replacement, oldPos) -> (range, replacement, oldPos,) <$> toCurrent range replacement oldPos)) $
2432+ \(range, replacement, oldPos, newPos) ->
2433+ fromCurrent range replacement newPos === Just oldPos
2434+ , testProperty "toCurrent r t <=< fromCurrent r t" $ do
2435+ let gen = do
2436+ rope <- genRope
2437+ range <- genRange rope
2438+ PrintableText replacement <- arbitrary
2439+ let newRope = applyChange rope (TextDocumentContentChangeEvent (Just range) Nothing replacement)
2440+ newPos <- genPosition newRope
2441+ pure (range, replacement, newPos)
2442+ forAll
2443+ (suchThatMap gen
2444+ (\(range, replacement, newPos) -> (range, replacement, newPos,) <$> fromCurrent range replacement newPos)) $
2445+ \(range, replacement, newPos, oldPos) ->
2446+ toCurrent range replacement oldPos === Just newPos
2447+ ]
2448+ ]
2449+
2450+newtype PrintableText = PrintableText { getPrintableText :: T.Text }
2451+ deriving Show
2452+
2453+instance Arbitrary PrintableText where
2454+ arbitrary = PrintableText . T.pack . getPrintableString <$> arbitrary
2455+
2456+
2457+genRope :: Gen Rope
2458+genRope = Rope.fromText . getPrintableText <$> arbitrary
2459+
2460+genPosition :: Rope -> Gen Position
2461+genPosition r = do
2462+ row <- choose (0, max 0 $ rows - 1)
2463+ let columns = Rope.columns (nthLine row r)
2464+ column <- choose (0, max 0 $ columns - 1)
2465+ pure $ Position row column
2466+ where rows = Rope.rows r
2467+
2468+genRange :: Rope -> Gen Range
2469+genRange r = do
2470+ startPos@(Position startLine startColumn) <- genPosition r
2471+ let maxLineDiff = max 0 $ rows - 1 - startLine
2472+ endLine <- choose (startLine, startLine + maxLineDiff)
2473+ let columns = Rope.columns (nthLine endLine r)
2474+ endColumn <-
2475+ if startLine == endLine
2476+ then choose (startColumn, columns)
2477+ else choose (0, max 0 $ columns - 1)
2478+ pure $ Range startPos (Position endLine endColumn)
2479+ where rows = Rope.rows r
2480+
2481+-- | Get the ith line of a rope, starting from 0. Trailing newline not included.
2482+nthLine :: Int -> Rope -> Rope
2483+nthLine i r
2484+ | i < 0 = error $ "Negative line number: " <> show i
2485+ | i == 0 && Rope.rows r == 0 = r
2486+ | i >= Rope.rows r = error $ "Row number out of bounds: " <> show i <> "/" <> show (Rope.rows r)
2487+ | 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+ ]