Log package hash inputs file and contents / regression test for #6906 (…

…#7759)

* Debug package hash inputs

* Add test skeleton for #6906

* Improve output of hash inputs

* Add tests over pks hash inputs

* Correct typos and formatting

* Add missing do

* Add missing cabal result arg

* Make consistent log about hash.txt

* Update log msg creating file

* Change var name to hashFileName

cabal-install/src/Distribution/Client/ProjectBuilding.hs

@@ -97,6 +97,7 @@ import qualified Data.Map as Map
 import qualified Data.Set as Set
 import qualified Data.ByteString as BS
 import qualified Data.ByteString.Lazy as LBS
+import qualified Data.ByteString.Lazy.Char8 as LBS.Char8
 
 import Control.Exception (Handler (..), SomeAsyncException, assert, catches, handle)
 import System.Directory  (canonicalizePath, createDirectoryIfMissing, doesDirectoryExist, doesFileExist, removeFile, renameDirectory)
@@ -1016,9 +1017,18 @@ buildAndInstallUnpackedPackage verbosity
             -- https://github.com/haskell/cabal/issues/4130
             createDirectoryIfMissingVerbose verbosity True entryDir
 
-            LBS.writeFile
-              (entryDir </> "cabal-hash.txt")
-              (renderPackageHashInputs (packageHashInputs pkgshared pkg))
+            let hashFileName     = entryDir </> "cabal-hash.txt"
+                outPkgHashInputs = renderPackageHashInputs (packageHashInputs pkgshared pkg)
+
+            info verbosity $
+              "creating file with the inputs used to compute the package hash: " ++ hashFileName
+
+            LBS.writeFile hashFileName outPkgHashInputs
+
+            debug verbosity "Package hash inputs:"
+            traverse_
+              (debug verbosity . ("> " ++))
+              (lines $ LBS.Char8.unpack outPkgHashInputs)
 
             -- Ensure that there are no files in `tmpDir`, that are
             -- not in `entryDir`. While this breaks the

cabal-testsuite/PackageTests/Regression/T6906/cabal.config

@@ -0,0 +1,2 @@
+extra-include-dirs: foo
+extra-lib-dirs: bar

cabal-testsuite/PackageTests/Regression/T6906/cabal.project

@@ -0,0 +1 @@
+packages: .

cabal-testsuite/PackageTests/Regression/T6906/cabal.test.hs

@@ -0,0 +1,9 @@
+import Test.Cabal.Prelude
+
+main = cabalTest $ do
+   res <- cabalG' ["--config=cabal.config"] "v2-install" ["-v3"]
+   assertOutputContains "creating file with the inputs used to compute the package hash:" res
+   assertOutputContains "extra-lib-dirs: bar" res
+   expectBroken 6906 $ assertOutputDoesNotContain "extra-lib-dirs: bar bar" res
+   assertOutputContains "extra-include-dirs: foo" res
+   expectBroken 6906 $ assertOutputDoesNotContain "extra-include-dirs: foo foo" res

cabal-testsuite/PackageTests/Regression/T6906/issue6906.cabal

@@ -0,0 +1,12 @@
+cabal-version: 3.0
+name:          issue6906
+version:       0
+synopsis:      No duplicate entries for extra-*-dirs config options in the inputs used to compute the package hash
+description:   When informed in the global config
+author:        Javier Neira
+category:      Tests
+maintainer:    [email protected]
+
+executable issue6906
+  build-depends:    base
+  main-is:  main.hs

cabal-testsuite/PackageTests/Regression/T6906/main.hs

@@ -0,0 +1 @@
+main = putStrLn "Hello issue6906"