Add boot dependency test (failing)

Author: nlander

ghcide/test/data/dependency-boot/Dependency.hs

@@ -0,0 +1,6 @@
+module Dependency where
+
+import           Data.Set (Set, empty)
+
+emptySet :: Set Int
+emptySet = empty

ghcide/test/data/dependency-boot/cabal.project

@@ -0,0 +1,3 @@
+packages: .
+package *
+  ghc-options: -fwrite-ide-info

ghcide/test/data/dependency-boot/dependency-boot.cabal

@@ -0,0 +1,10 @@
+name:          dependency-boot
+version:       0.1.0.0
+cabal-version: 2.0
+build-type:    Simple
+
+library
+  exposed-modules:  Dependency
+  default-language: Haskell2010
+  build-depends:    base
+                  , containers

ghcide/test/data/dependency-boot/hie.yaml

@@ -0,0 +1,2 @@
+cradle:
+  cabal:

ghcide/test/exe/Dependency.hs

@@ -36,6 +36,7 @@ tests =
         , dependencyTypeTest
         , transitiveDependencyTest
         , autogenDependencyTest
+        , bootDependencyTest
         ]
 
 fileDoneIndexing :: [String] -> Session FilePath
@@ -202,3 +203,35 @@ autogenDependencyTest = knownBrokenForGhcVersions [GHC810, GHC90] "stylish-haske
                     liftIO $
                         assertFailure $ "Wrong location for version: "
                             ++ show wrongLocation
+
+-- Tests that we can go to a definition in a boot library, that is,
+-- one of the libraries that ships with GHC. In this case we are
+-- going to a definition in containers. This does not currently work
+-- for available GHC versions but hopefully will for later versions
+-- of GHC.
+bootDependencyTest :: TestTree
+bootDependencyTest = knownBrokenForGhcVersions [GHC810, GHC90, GHC92, GHC94, GHC96] "HIE files are not generated by older GHCs" $
+    testSessionWithExtraFiles "dependency-boot" "gotoDefinition term in boot library containers" $
+        \dir -> do
+            doc <- openDoc (dir </> "Dependency" <.> "hs") "haskell"
+            _hieFile <- fileDoneIndexing ["Data", "Set", "Internal.hie"]
+            defs <- getDefinitions doc (Position 5 20)
+            -- The location of the definition of empty in Data.Set.Internal.
+            -- This will likely need to be updated when there is a GHC for
+            -- which this test can pass.
+            let expRange = Range (Position 513 0) (Position 513 11)
+            case defs of
+                InL (Definition (InR [Location fp actualRange])) ->
+                    liftIO $ do
+                        let locationDirectories :: [String]
+                            locationDirectories =
+                                maybe [] splitDirectories $
+                                    uriToFilePath fp
+                        assertBool "empty found in a module that is not Data.Set.Internal"
+                            $ ["Data", "Set", "Internal.hs"]
+                                `isSuffixOf` locationDirectories
+                        actualRange @?= expRange
+                wrongLocation ->
+                    liftIO $
+                        assertFailure $ "Wrong location for empty: "
+                            ++ show wrongLocation