fix parseCabalProjectFileContents arguments, add test

Author: rm41339

haskell-language-server.cabal

@@ -397,6 +397,8 @@ test-suite hls-cabal-project-plugin-tests
     , lsp-types
     , text
     , hls-plugin-api
+    , cabal-install
+
 
 -----------------------------
 -- class plugin

plugins/hls-cabal-project-plugin/src/Ide/Plugin/CabalProject.hs

@@ -58,7 +58,7 @@ import           Language.LSP.Protocol.Types
 import qualified Language.LSP.VFS                              as VFS
 import           System.FilePath                               (takeFileName)
 import           Text.Regex.TDFA
-
+-- import           Ide.Plugin.Cabal.Orphans                    ()
 
 data Log
   = LogModificationTime NormalizedFilePath FileVersion
@@ -203,14 +203,16 @@ cabalRules recorder plId = do
       else do
         -- whenever this key is marked as dirty (e.g., when a user writes stuff to it),
         -- we rerun this rule because this rule *depends* on GetModificationTime.
-        (t, mRope) <- use_ GetFileContents file
+        (t, mCabalSource) <- use_ GetFileContents file
         log' Debug $ LogModificationTime file t
 
-        bytes <- case mRope of
-          Just sources -> pure (Encoding.encodeUtf8 (Rope.toText sources))
-          Nothing      -> liftIO $ BS.readFile (fromNormalizedFilePath file)
+        contents <- case mCabalSource of
+          Just sources ->
+            pure $ Encoding.encodeUtf8 $ Rope.toText sources
+          Nothing      ->
+            liftIO $ BS.readFile $ fromNormalizedFilePath file
 
-        (pWarnings, pResult) <- liftIO $ Parse.parseCabalProjectFileContents (fromNormalizedFilePath file) bytes
+        (pWarnings, pResult) <- liftIO $ Parse.parseCabalProjectFileContents (fromNormalizedFilePath file) contents
         let warnDiags = fmap (Diagnostics.warningDiagnostic file) pWarnings
 
         case pResult of

plugins/hls-cabal-project-plugin/src/Ide/Plugin/CabalProject/Parse.hs

@@ -32,10 +32,6 @@ import           System.Directory.Extra                   (XdgDirectory (..),
                                                            getXdgDirectory)
 import           System.FilePath                          (takeBaseName,
                                                            takeDirectory, (</>))
--- import  System.Directory.Extra               as SD
-
-
-
 
 parseCabalProjectFileContents
   :: FilePath

plugins/hls-cabal-project-plugin/test/Main.hs

@@ -6,20 +6,29 @@ module Main (
     main,
 ) where
 
-import           Control.Lens                  ((^.))
-import           Control.Lens.Fold             ((^?))
-import           Control.Monad                 (guard)
-import qualified Data.ByteString               as BS
-import           Data.Either                   (isRight)
-import           Data.List.Extra               (nubOrdOn)
-import qualified Data.Maybe                    as Maybe
-import qualified Data.Text                     as T
-import qualified Ide.Plugin.CabalProject.Parse as Lib
-import qualified Language.LSP.Protocol.Lens    as L
+import qualified Control.Exception                        as E
+import           Control.Lens                             ((^.))
+import           Control.Lens.Fold                        ((^?))
+import           Control.Monad                            (guard)
+import qualified Data.ByteString                          as BS
+import           Data.ByteString.Char8                    (pack)
+import           Data.Either                              (isRight)
+import           Data.List.Extra                          (nubOrdOn)
+import           Data.List.NonEmpty                       (NonEmpty (..))
+import qualified Data.List.NonEmpty                       as NE
+import qualified Data.Maybe                               as Maybe
+import qualified Data.Text                                as T
+import           Distribution.Client.ProjectConfig.Parsec (ProjectConfigSkeleton)
+import           Distribution.Fields                      (PError (..),
+                                                           PWarning (..))
+import           Distribution.Types.Version               (Version)
+import qualified Ide.Plugin.CabalProject.Parse            as Lib
+import qualified Language.LSP.Protocol.Lens               as L
 import           System.FilePath
 import           Test.Hls
 import           Utils
 
+
 main :: IO ()
 main = do
     defaultTestRunner $
@@ -45,10 +54,33 @@ cabalProjectParserUnitTests =
     testGroup
         "Parsing Cabal Project"
         [ testCase "Simple Parsing works" $ do
-            (warnings, pm) <- Lib.parseCabalProjectFileContents (testDataDir </> "cabal.project")
+            let fp    = testDataDir </> "cabal.project"
+            bytes <- BS.readFile fp
+            (warnings, pm) <- Lib.parseCabalProjectFileContents fp bytes
             liftIO $ do
                 null warnings @? "Found unexpected warnings"
                 isRight pm @? "Failed to parse base cabal.project file"
+          , testCase "Correct root directory" $ do
+              let root    = testDataDir </> "root-directory"
+              let cabalFp = root </> "cabal.project"
+              bytes <- BS.readFile cabalFp
+              result <- E.try @E.IOException (Lib.parseCabalProjectFileContents cabalFp bytes)
+                        :: IO ( Either
+                            E.IOException
+                            ( [PWarning]
+                            , Either (Maybe Version, NonEmpty PError)
+                                 ProjectConfigSkeleton
+                            )
+                    )
+              case result of
+                Left err ->
+                  let errStr = show err
+                  in  (pack root `BS.isInfixOf` pack errStr)
+                        @?  ("Expected missing file error to mention the test-dir:\n"
+                        ++ "  " ++ root ++ "\n"
+                        ++ "but got:\n" ++ errStr)
+                Right _ ->
+                  False @? "Expected parse to fail (missing import), but it succeeded"
         ]
 
 -- ------------------------ ------------------------------------------------

plugins/hls-cabal-project-plugin/test/testdata/root-directory/cabal.project

@@ -0,0 +1 @@
+import: missing-folder/nonexistent.config