Backport: Set <pkgname_datadir> to an absolute path

Ticket #10717 points out that the <pkgname>_datadir environment variable
should be set to an absolute path since the test executables may
change directory during their invocation.

This is easily fixed by using the absoluteWorkingDirLBI
function, which was introduced in 027bddf,

However, in order to perform the fix in a PVP compliant manner, you have
to write it in this horrible way of adding a new function and leaving
the old broken function in it's place.

Fixes #10717

Author: mpickering

Cabal/src/Distribution/Simple/Bench.hs

@@ -26,7 +26,7 @@ import Prelude ()
 import Distribution.Compat.Environment
 import qualified Distribution.PackageDescription as PD
 import Distribution.Pretty
-import Distribution.Simple.Build (addInternalBuildTools)
+import Distribution.Simple.Build (addInternalBuildToolsFixed)
 import Distribution.Simple.BuildPaths
 import Distribution.Simple.Compiler
 import Distribution.Simple.Errors
@@ -58,6 +58,7 @@ bench
   -- ^ flags sent to benchmark
   -> IO ()
 bench args pkg_descr lbi flags = do
+  curDir <- LBI.absoluteWorkingDirLBI lbi
   let verbosity = fromFlag $ benchmarkVerbosity flags
       benchmarkNames = args
       pkgBenchmarks = PD.benchmarks pkg_descr
@@ -72,7 +73,8 @@ bench args pkg_descr lbi flags = do
               lbi
                 { -- Include any build-tool-depends on build tools internal to the current package.
                   LBI.withPrograms =
-                    addInternalBuildTools
+                    addInternalBuildToolsFixed
+                      (Just curDir)
                       pkg_descr
                       lbi
                       (benchmarkBuildInfo bm)

Cabal/src/Distribution/Simple/Build.hs

@@ -48,6 +48,7 @@ module Distribution.Simple.Build
 
     -- * Handling of internal build tools
   , addInternalBuildTools
+  , addInternalBuildToolsFixed
   ) where
 
 import Distribution.Compat.Prelude
@@ -188,13 +189,15 @@ build_setupHooks
     -- dumped.
     dumpBuildInfo verbosity distPref (configDumpBuildInfo (configFlags lbi)) pkg_descr lbi flags
 
+    curDir <- absoluteWorkingDirLBI lbi
+
     -- Now do the actual building
     (\f -> foldM_ f (installedPkgs lbi) componentsToBuild) $ \index target -> do
       let comp = targetComponent target
           clbi = targetCLBI target
           bi = componentBuildInfo comp
           -- Include any build-tool-depends on build tools internal to the current package.
-          progs' = addInternalBuildTools pkg_descr lbi bi (withPrograms lbi)
+          progs' = addInternalBuildToolsFixed (Just curDir) pkg_descr lbi bi (withPrograms lbi)
           lbi' =
             lbi
               { withPrograms = progs'
@@ -376,17 +379,20 @@ repl_setupHooks
 
     internalPackageDB <- createInternalPackageDB verbosity lbi distPref
 
-    let lbiForComponent comp lbi' =
-          lbi'
-            { withPackageDB = withPackageDB lbi ++ [internalPackageDB]
-            , withPrograms =
-                -- Include any build-tool-depends on build tools internal to the current package.
-                addInternalBuildTools
-                  pkg_descr
-                  lbi'
-                  (componentBuildInfo comp)
-                  (withPrograms lbi')
-            }
+    let lbiForComponent comp lbi' = do
+          curDir <- absoluteWorkingDirLBI lbi'
+          return $
+            lbi'
+              { withPackageDB = withPackageDB lbi' ++ [internalPackageDB]
+              , withPrograms =
+                  -- Include any build-tool-depends on build tools internal to the current package.
+                  addInternalBuildToolsFixed
+                    (Just curDir)
+                    pkg_descr
+                    lbi'
+                    (componentBuildInfo comp)
+                    (withPrograms lbi')
+              }
         runPreBuildHooks :: LocalBuildInfo -> TargetInfo -> IO ()
         runPreBuildHooks lbi2 tgt =
           let inputs =
@@ -404,7 +410,7 @@ repl_setupHooks
       [ do
         let clbi = targetCLBI subtarget
             comp = targetComponent subtarget
-            lbi' = lbiForComponent comp lbi
+        lbi' <- lbiForComponent comp lbi
         preBuildComponent runPreBuildHooks verbosity lbi' subtarget
         buildComponent
           (mempty{buildCommonFlags = mempty{setupVerbosity = toFlag verbosity}})
@@ -421,7 +427,7 @@ repl_setupHooks
     -- REPL for target components
     let clbi = targetCLBI target
         comp = targetComponent target
-        lbi' = lbiForComponent comp lbi
+    lbi' <- lbiForComponent comp lbi
     preBuildComponent runPreBuildHooks verbosity lbi' target
     replComponent flags verbosity pkg_descr lbi' suffixHandlers comp clbi distPref
 
@@ -925,13 +931,18 @@ createInternalPackageDB verbosity lbi distPref = do
 --    directory environment variable for the current package to the current
 --    'progOverrideEnv', so that any programs configured from now on will be
 --    able to invoke these build tools.
-addInternalBuildTools
-  :: PackageDescription
+--
+--  NB: This function will be removed in the next Cabal major version
+--  (use addInternalBuildTools instead). This function is introduced solely for
+--  backporting in a PVP compliant way.
+addInternalBuildToolsFixed
+  :: Maybe (AbsolutePath (Dir Pkg))
+  -> PackageDescription
   -> LocalBuildInfo
   -> BuildInfo
   -> ProgramDb
   -> ProgramDb
-addInternalBuildTools pkg lbi bi progs =
+addInternalBuildToolsFixed mpwd pkg lbi bi progs =
   prependProgramSearchPathNoLogging
     internalToolPaths
     [pkgDataDirVar]
@@ -950,13 +961,27 @@ addInternalBuildTools pkg lbi bi progs =
                 buildDir lbi
                   </> makeRelativePathEx (toolName' </> toolName' <.> exeExtension (hostPlatform lbi))
       ]
-    mbWorkDir = mbWorkDirLBI lbi
-    rawDataDir = dataDir pkg
-    dataDirPath
-      | null $ getSymbolicPath rawDataDir =
-          interpretSymbolicPath mbWorkDir sameDirectory
-      | otherwise =
-          interpretSymbolicPath mbWorkDir rawDataDir
+
+    dataDirPath :: FilePath
+    dataDirPath =
+      case mpwd of
+        -- This is an absolute path, so if a process changes directory, it can still
+        -- find the datadir (#10717)
+        Just pwd -> interpretSymbolicPathAbsolute pwd (dataDir pkg)
+        -- This is just wrong, but implemented for PVP compliance..
+        Nothing  -> interpretSymbolicPathCWD (dataDir pkg)
+
+
+{-# WARNING addInternalBuildTools "This function is broken, use addInternalBuildToolsFixed instead" #-}
+-- | A backwards compatible (broken) version of `addInternalBuildTools`, do not
+-- use this function. Use 'addInternalBuildToolsFixed' instead.
+addInternalBuildTools
+  :: PackageDescription
+  -> LocalBuildInfo
+  -> BuildInfo
+  -> ProgramDb
+  -> ProgramDb
+addInternalBuildTools = addInternalBuildToolsFixed Nothing
 
 -- TODO: build separate libs in separate dirs so that we can build
 -- multiple libs, e.g. for 'LibTest' library-style test suites

Cabal/src/Distribution/Simple/Haddock.hs

@@ -336,12 +336,13 @@ haddock_setupHooks
       createInternalPackageDB verbosity lbi (flag $ setupDistPref . haddockCommonFlags)
 
     (\f -> foldM_ f (installedPkgs lbi) targets') $ \index target -> do
+      curDir <- absoluteWorkingDirLBI lbi
       let
         component = targetComponent target
         clbi = targetCLBI target
         bi = componentBuildInfo component
         -- Include any build-tool-depends on build tools internal to the current package.
-        progs' = addInternalBuildTools pkg_descr lbi bi (withPrograms lbi)
+        progs' = addInternalBuildToolsFixed (Just curDir) pkg_descr lbi bi (withPrograms lbi)
         lbi' =
           lbi
             { withPrograms = progs'

Cabal/src/Distribution/Simple/Test.hs

@@ -27,7 +27,7 @@ import Prelude ()
 
 import qualified Distribution.PackageDescription as PD
 import Distribution.Pretty
-import Distribution.Simple.Build (addInternalBuildTools)
+import Distribution.Simple.Build (addInternalBuildToolsFixed)
 import Distribution.Simple.Compiler
 import Distribution.Simple.Hpc
 import Distribution.Simple.InstallDirs
@@ -70,6 +70,7 @@ test
   -- ^ flags sent to test
   -> IO ()
 test args pkg_descr lbi0 flags = do
+  curDir <- LBI.absoluteWorkingDirLBI lbi0
   let common = testCommonFlags flags
       verbosity = fromFlag $ setupVerbosity common
       distPref = fromFlag $ setupDistPref common
@@ -95,7 +96,8 @@ test args pkg_descr lbi0 flags = do
               lbi
                 { withPrograms =
                     -- Include any build-tool-depends on build tools internal to the current package.
-                    addInternalBuildTools
+                    addInternalBuildToolsFixed
+                      (Just curDir)
                       pkg_descr
                       lbi
                       (PD.testBuildInfo suite)

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

@@ -28,13 +28,14 @@ import Distribution.PackageDescription
   , TestSuite (..)
   )
 import Distribution.Simple (PackageDBX (..))
-import Distribution.Simple.Build (addInternalBuildTools)
+import Distribution.Simple.Build (addInternalBuildToolsFixed)
 import Distribution.Simple.BuildPaths (exeExtension)
 import Distribution.Simple.Compiler (CompilerFlavor (..), compilerFlavor)
 import Distribution.Simple.Flag (fromFlag)
 import Distribution.Simple.LocalBuildInfo
   ( ComponentName (..)
   , LocalBuildInfo (..)
+  , absoluteWorkingDirLBI
   , buildDir
   , depLibraryPaths
   , interpretSymbolicPathLBI
@@ -143,6 +144,7 @@ splitRunArgs verbosity lbi args =
 -- | Run a given executable.
 run :: Verbosity -> LocalBuildInfo -> Executable -> [String] -> IO ()
 run verbosity lbi exe exeArgs = do
+  curDir <- absoluteWorkingDirLBI lbi
   let distPref = fromFlag $ configDistPref $ configFlags lbi
       buildPref = buildDir lbi
       pkg_descr = localPkgDescr lbi
@@ -154,7 +156,8 @@ run verbosity lbi exe exeArgs = do
           { withPackageDB = withPackageDB lbi ++ [SpecificPackageDB internalPkgDb]
           , -- Include any build-tool-depends on build tools internal to the current package.
             withPrograms =
-              addInternalBuildTools
+              addInternalBuildToolsFixed
+                (Just curDir)
                 pkg_descr
                 lbi
                 (buildInfo exe)

cabal-testsuite/PackageTests/DataDirSetupTest/cabal.cabal.out

@@ -0,0 +1,13 @@
+# Setup configure
+Configuring datadir-test-0.1.0.0...
+# Setup build
+Preprocessing library for datadir-test-0.1.0.0...
+Building library for datadir-test-0.1.0.0...
+Preprocessing test suite 'datadir-test' for datadir-test-0.1.0.0...
+Building test suite 'datadir-test' for datadir-test-0.1.0.0...
+# Setup test
+Running 1 test suites...
+Test suite datadir-test: RUNNING...
+Test suite datadir-test: PASS
+Test suite logged to: cabal.cabal.dist/work/dist/test/datadir-test-0.1.0.0-datadir-test.log
+1 of 1 test suites (1 of 1 test cases) passed.

cabal-testsuite/PackageTests/DataDirSetupTest/cabal.out

@@ -0,0 +1,13 @@
+# Setup configure
+Configuring datadir-test-0.1.0.0...
+# Setup build
+Preprocessing library for datadir-test-0.1.0.0...
+Building library for datadir-test-0.1.0.0...
+Preprocessing test suite 'datadir-test' for datadir-test-0.1.0.0...
+Building test suite 'datadir-test' for datadir-test-0.1.0.0...
+# Setup test
+Running 1 test suites...
+Test suite datadir-test: RUNNING...
+Test suite datadir-test: PASS
+Test suite logged to: cabal.dist/work/dist/test/datadir-test-0.1.0.0-datadir-test.log
+1 of 1 test suites (1 of 1 test cases) passed.

changelog.d/pr-10828.md

@@ -0,0 +1,10 @@
+---
+synopsis: Set <pkgname>_datadir to an absolute path when running tests
+packages: [Cabal]
+prs: 10828
+issues: [10717]
+---
+
+Fix a regression where `<pkgname>_datadir` was set to a relative path. This
+caused issues when running testsuites which changed the working directory and
+accessed datafiles.