[Migrate DependentFileTest] part of #4173 Migrate ghcide tests to hls test utils

ghcide/test/exe/DependentFileTest.hs

@@ -4,9 +4,11 @@
 
 module DependentFileTest (tests) where
 
+import           Config
 import           Control.Monad.IO.Class         (liftIO)
 import           Data.Row
 import qualified Data.Text                      as T
+import           Debug.Trace                    (traceShowM)
 import           Development.IDE.Test           (expectDiagnostics)
 import           Development.IDE.Types.Location
 import           Language.LSP.Protocol.Message
@@ -16,19 +18,20 @@
                                                  SemanticTokensEdit (..),
                                                  mkRange)
 import           Language.LSP.Test
-import           System.FilePath
+import           Test.Hls.FileSystem            (FileSystem, toAbsFp)
 import           Test.Tasty
-import           TestUtils
 
 tests :: TestTree
 tests = testGroup "addDependentFile"
-    [testGroup "file-changed" [testSession' "test" test]
+    [testGroup "file-changed" [testWithDummyPlugin' "test" (mkIdeTestFs []) test]
     ]
     where
+      test :: FileSystem -> Session ()
       test dir = do
         -- If the file contains B then no type error
         -- otherwise type error
-        let depFilePath = dir </> "dep-file.txt"
+        traceShowM "beginning test"
+        let depFilePath = toAbsFp dir "dep-file.txt"
         liftIO $ writeFile depFilePath "A"
         let fooContent = T.unlines
               [ "{-# LANGUAGE TemplateHaskell #-}"
@@ -40,11 +43,14 @@
               , "               f <- qRunIO (readFile \"dep-file.txt\")"
               , "               if f == \"B\" then [| 1 |] else lift f)"
               ]
+        traceShowM "before create Foo.hs"
         let bazContent = T.unlines ["module Baz where", "import Foo ()"]
-        _ <- createDoc "Foo.hs" "haskell" fooContent
+        _fooDoc <- createDoc "Foo.hs" "haskell" fooContent
+        traceShowM "created foo"
         doc <- createDoc "Baz.hs" "haskell" bazContent
         expectDiagnostics
             [("Foo.hs", [(DiagnosticSeverity_Error, (4,11), "Couldn't match type")])]
+        traceShowM "after expectDiagnostics"
         -- Now modify the dependent file
         liftIO $ writeFile depFilePath "B"
         sendNotification SMethod_WorkspaceDidChangeWatchedFiles $ DidChangeWatchedFilesParams
@@ -55,4 +61,5 @@
                                                          .+ #rangeLength .== Nothing
                                                          .+ #text .== "f = ()"
         changeDoc doc [change]
+        traceShowM "before last expectDiagnostics"
         expectDiagnostics [("Foo.hs", [])]

ghcide/test/src/Development/IDE/Test.hs

@@ -45,6 +45,7 @@
 import           Data.Proxy
 import           Data.Text                       (Text)
 import qualified Data.Text                       as T
+import           Debug.Trace                     (traceShowM)
 import           Development.IDE.Plugin.Test     (TestRequest (..),
                                                   WaitForIdeRuleResult,
                                                   ideResultSuccess)
@@ -124,7 +125,9 @@
 expectDiagnosticsWithTags expected = do
     let f = getDocUri >=> liftIO . canonicalizeUri >=> pure . toNormalizedUri
         next = unwrapDiagnostic <$> skipManyTill anyMessage diagnostic
+    traceShowM $ "Trace: " <> show expected
     expected' <- Map.fromListWith (<>) <$> traverseOf (traverse . _1) f expected
+    traceShowM $ "Trace: " <> show expected'
     expectDiagnosticsWithTags' next expected'
 
 expectDiagnosticsWithTags' ::
@@ -134,18 +137,20 @@
   m ()
 expectDiagnosticsWithTags' next m | null m = do
     (_,actual) <- next
+    traceShowM $ "Trace: " <> show actual
     case actual of
         [] ->
             return ()
         _ ->
             liftIO $ assertFailure $ "Got unexpected diagnostics:" <> show actual
-
+-- get the next diagnostic message and check and remove the expected diagnostics from the map
 expectDiagnosticsWithTags' next expected = go expected
   where
     go m
       | Map.null m = pure ()
       | otherwise = do
         (fileUri, actual) <- next
+        traceShowM $ "Trace: " <> show actual
         canonUri <- liftIO $ toNormalizedUri <$> canonicalizeUri fileUri
         case Map.lookup canonUri m of
           Nothing -> do