Cabal plugin: implement check for package.yaml in a stack project (#4422)

* added guardAgainstHpack function

Revert "added guardAgainstHpack function"

This reverts commit f7fb00c.

added guardAgainstHpack function

* added test for guardAgainstHPack

* better documentation for findResponsibleCabalFile

* Update plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/CabalAdd.hs

Co-authored-by: VeryMilkyJoe <jana.chadt@nets.at>

---------

Co-authored-by: ASnd-dev <184600539+ASnd-dev@users.noreply.github.com>
Co-authored-by: fendor <fendor@users.noreply.github.com>
Co-authored-by: VeryMilkyJoe <jana.chadt@nets.at>

Author: 4 people

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/CabalAdd.hs

@@ -278,6 +278,8 @@ getDependencyEdit recorder env cabalFilePath buildTarget dependency = do
       pure edit
 
 -- | Given a path to a haskell file, returns the closest cabal file.
+--   If a package.yaml is present in same directory as the .cabal file, returns nothing, because adding a dependency to a generated cabal file
+--   will break propagation of changes from package.yaml to cabal files in stack projects.
 --   If cabal file wasn't found, gives Nothing.
 findResponsibleCabalFile :: FilePath -> IO (Maybe FilePath)
 findResponsibleCabalFile haskellFilePath = do
@@ -293,7 +295,12 @@ findResponsibleCabalFile haskellFilePath = do
       cabalFiles <- filterM (\c -> doesFileExist c) objectsCabalExtension
       case safeHead cabalFiles of
         Nothing        -> go ps
-        Just cabalFile -> pure $ Just cabalFile
+        Just cabalFile -> guardAgainstHpack path cabalFile
+          where
+            guardAgainstHpack :: FilePath -> FilePath -> IO (Maybe FilePath)
+            guardAgainstHpack path cabalFile = do
+              exists <- doesFileExist $ path </> "package.yaml"
+              if exists then pure Nothing else pure $ Just cabalFile
 
 -- | Gives cabal file's contents or throws error.
 --   Inspired by @readCabalFile@ in cabal-add,

plugins/hls-cabal-plugin/test/CabalAdd.hs

@@ -29,6 +29,8 @@ cabalAddTests =
     "CabalAdd Tests"
     [ runHaskellTestCaseSession "Code Actions - Can add hidden package" ("cabal-add-testdata" </> "cabal-add-exe")
         (generateAddDependencyTestSession "cabal-add-exe.cabal" ("src" </> "Main.hs") "split" [253])
+    , runHaskellTestCaseSession "Code Actions - Guard against HPack" ("cabal-add-testdata" </> "cabal-add-packageYaml")
+        (generatePackageYAMLTestSession ("src" </> "Main.hs"))
     , runHaskellTestCaseSession "Code Actions - Can add hidden package to a library" ("cabal-add-testdata" </> "cabal-add-lib")
         (generateAddDependencyTestSession "cabal-add-lib.cabal" ("src" </> "MyLib.hs") "split" [348])
     , runHaskellTestCaseSession "Code Actions - Can add hidden package to a test" ("cabal-add-testdata" </> "cabal-add-tests")
@@ -139,3 +141,12 @@ cabalAddTests =
           , _codeDescription = Nothing
           , _data_ = Nothing
         }
+
+
+    generatePackageYAMLTestSession :: FilePath -> Session ()
+    generatePackageYAMLTestSession haskellFile  = do
+        hsdoc <- openDoc haskellFile "haskell"
+        _ <- waitForDiagnosticsFrom hsdoc
+        cas <- Maybe.mapMaybe (^? _R) <$> getAllCodeActions hsdoc
+        let selectedCas = filter (\ca -> "Add dependency" `T.isPrefixOf` (ca ^. L.title)) cas
+        liftIO $ assertEqual "PackageYAML" [] selectedCas

plugins/hls-cabal-plugin/test/testdata/cabal-add-testdata/cabal-add-packageYaml/cabal-add-bench.cabal

@@ -0,0 +1,17 @@
+cabal-version:      2.4
+name:               cabal-add-bench
+version:            0.1.0.0
+license:            NONE
+author:             George Gerasev
+maintainer:         george30032002@gmail.com
+build-type:         Simple
+
+common warnings
+    ghc-options: -Wall
+
+benchmark benchmark
+    type: exitcode-stdio-1.0
+    ghc-options: -threaded
+    main-is: Main.hs
+    hs-source-dirs: bench
+    build-depends: base

plugins/hls-cabal-plugin/test/testdata/cabal-add-testdata/cabal-add-packageYaml/package.yaml

@@ -0,0 +1,6 @@
+module Main (main) where
+
+import Data.List.Split
+
+main :: IO ()
+main = putStrLn "Test suite not yet implemented."

plugins/hls-cabal-plugin/test/testdata/cabal-add-testdata/cabal-add-packageYaml/src/Main.hs

@@ -2,3 +2,4 @@ packages: cabal-add-exe
           cabal-add-lib
           cabal-add-tests
           cabal-add-bench
+          cabal-add-packageYaml