PackageTests: set dist prefix

Some package tests run multiple tests on the same package, causing the
build directory to be overwritten. For debugging, it is important to
keep the build directory contents, so in this case we run each test
with a different build directory.

Cabal/.gitignore

+/dist/
+/tests/PackageTests/TestSuiteExeV10/dist-*

Cabal/tests/PackageTests.hs

@@ -140,6 +140,7 @@ main = do
             , configOpts = [ "--package-db=" ++ dbFile
                            , "--constraint=Cabal == " ++ display cabalVersion
                            ]
+            , distPref = Nothing
             }
     putStrLn $ "Cabal test suite - testing cabal version " ++
         display cabalVersion

Cabal/tests/PackageTests/BenchmarkExeV10/Check.hs

@@ -11,6 +11,6 @@ dir = "PackageTests" </> "BenchmarkExeV10"
 
 checkBenchmark :: FilePath -> Test
 checkBenchmark ghcPath = TestCase $ do
-    let spec = PackageSpec dir ["--enable-benchmarks"]
+    let spec = PackageSpec dir Nothing ["--enable-benchmarks"]
     buildResult <- cabal_build spec ghcPath
     assertBuildSucceeded buildResult

Cabal/tests/PackageTests/BenchmarkOptions/Check.hs

@@ -6,8 +6,11 @@ import Test.HUnit
 
 suite :: FilePath -> Test
 suite ghcPath = TestCase $ do
-    let spec = PackageSpec ("PackageTests" </> "BenchmarkOptions")
-               ["--enable-benchmarks"]
+    let spec = PackageSpec
+            { directory = "PackageTests" </> "BenchmarkOptions"
+            , configOpts = ["--enable-benchmarks"]
+            , distPref = Nothing
+            }
     _ <- cabal_build spec ghcPath
     result <- cabal_bench spec ["--benchmark-options=1 2 3"] ghcPath
     let message = "\"cabal bench\" did not pass the correct options to the "

Cabal/tests/PackageTests/BenchmarkStanza/Check.hs

@@ -26,7 +26,7 @@ suite :: FilePath -> Test
 suite ghcPath = TestCase $ do
     let dir = "PackageTests" </> "BenchmarkStanza"
         pdFile = dir </> "my" <.> "cabal"
-        spec = PackageSpec dir []
+        spec = PackageSpec { directory = dir, configOpts = [], distPref = Nothing }
     result <- cabal_configure spec ghcPath
     assertOutputDoesNotContain "unknown section type" result
     genPD <- readPackageDescription silent pdFile

Cabal/tests/PackageTests/BuildDeps/InternalLibrary0/Check.hs

@@ -9,7 +9,11 @@ import Test.HUnit
 
 suite :: Version -> FilePath -> Test
 suite cabalVersion ghcPath = TestCase $ do
-    let spec = PackageSpec ("PackageTests" </> "BuildDeps" </> "InternalLibrary0") []
+    let spec = PackageSpec
+            { directory = "PackageTests" </> "BuildDeps" </> "InternalLibrary0"
+            , configOpts = []
+            , distPref = Nothing
+            }
     result <- cabal_build spec ghcPath
     assertBuildFailed result
     when (cabalVersion >= Version [1, 7] []) $ do

Cabal/tests/PackageTests/BuildDeps/InternalLibrary1/Check.hs

@@ -7,6 +7,10 @@ import Test.HUnit
 
 suite :: FilePath -> Test
 suite ghcPath = TestCase $ do
-    let spec = PackageSpec ("PackageTests" </> "BuildDeps" </> "InternalLibrary1") []
+    let spec = PackageSpec
+            { directory = "PackageTests" </> "BuildDeps" </> "InternalLibrary1"
+            , configOpts = []
+            , distPref = Nothing
+            }
     result <- cabal_build spec ghcPath
     assertBuildSucceeded result

Cabal/tests/PackageTests/BuildDeps/InternalLibrary2/Check.hs

@@ -8,8 +8,16 @@ import Test.HUnit
 
 suite :: FilePath -> FilePath -> Test
 suite ghcPath ghcPkgPath = TestCase $ do
-    let spec = PackageSpec ("PackageTests" </> "BuildDeps" </> "InternalLibrary2") []
-    let specTI = PackageSpec (directory spec </> "to-install") []
+    let spec = PackageSpec
+            { directory = "PackageTests" </> "BuildDeps" </> "InternalLibrary2"
+            , configOpts = []
+            , distPref = Nothing
+            }
+    let specTI = PackageSpec
+            { directory = directory spec </> "to-install"
+            , configOpts = []
+            , distPref = Nothing
+            }
 
     unregister "InternalLibrary2" ghcPkgPath
     iResult <- cabal_install specTI ghcPath

Cabal/tests/PackageTests/BuildDeps/InternalLibrary3/Check.hs

@@ -8,8 +8,16 @@ import Test.HUnit
 
 suite :: FilePath -> FilePath -> Test
 suite ghcPath ghcPkgPath = TestCase $ do
-    let spec = PackageSpec ("PackageTests" </> "BuildDeps" </> "InternalLibrary3") []
-    let specTI = PackageSpec (directory spec </> "to-install") []
+    let spec = PackageSpec
+            { directory = "PackageTests" </> "BuildDeps" </> "InternalLibrary3"
+            , configOpts = []
+            , distPref = Nothing
+            }
+    let specTI = PackageSpec
+            { directory = directory spec </> "to-install"
+            , configOpts = []
+            , distPref = Nothing
+            }
 
     unregister "InternalLibrary3" ghcPkgPath
     iResult <- cabal_install specTI ghcPath

Cabal/tests/PackageTests/BuildDeps/InternalLibrary4/Check.hs

@@ -8,8 +8,16 @@ import Test.HUnit
 
 suite :: FilePath -> FilePath -> Test
 suite ghcPath ghcPkgPath = TestCase $ do
-    let spec = PackageSpec ("PackageTests" </> "BuildDeps" </> "InternalLibrary4") []
-    let specTI = PackageSpec (directory spec </> "to-install") []
+    let spec = PackageSpec
+            { directory = "PackageTests" </> "BuildDeps" </> "InternalLibrary4"
+            , configOpts = []
+            , distPref = Nothing
+            }
+    let specTI = PackageSpec
+            { directory = directory spec </> "to-install"
+            , configOpts = []
+            , distPref = Nothing
+            }
 
     unregister "InternalLibrary4" ghcPkgPath
     iResult <- cabal_install specTI ghcPath

Cabal/tests/PackageTests/BuildDeps/SameDepsAllRound/Check.hs

@@ -8,7 +8,11 @@ import qualified Control.Exception as E
 
 suite :: FilePath -> Test
 suite ghcPath = TestCase $ do
-    let spec = PackageSpec ("PackageTests" </> "BuildDeps" </> "SameDepsAllRound") []
+    let spec = PackageSpec
+            { directory = "PackageTests" </> "BuildDeps" </> "SameDepsAllRound"
+            , configOpts = []
+            , distPref = Nothing
+            }
     result <- cabal_build spec ghcPath
     do
         assertEqual "cabal build should succeed - see test-log.txt" True (successful result)

Cabal/tests/PackageTests/BuildDeps/TargetSpecificDeps1/Check.hs

@@ -10,7 +10,11 @@ import Text.Regex.Posix
 
 suite :: FilePath -> Test
 suite ghcPath = TestCase $ do
-    let spec = PackageSpec ("PackageTests" </> "BuildDeps" </> "TargetSpecificDeps1") []
+    let spec = PackageSpec
+            { directory = "PackageTests" </> "BuildDeps" </> "TargetSpecificDeps1"
+            , configOpts = []
+            , distPref = Nothing
+            }
     result <- cabal_build spec ghcPath
     do
         assertEqual "cabal build should fail - see test-log.txt" False (successful result)

Cabal/tests/PackageTests/BuildDeps/TargetSpecificDeps2/Check.hs

@@ -8,7 +8,11 @@ import qualified Control.Exception as E
 
 suite :: FilePath -> Test
 suite ghcPath = TestCase $ do
-    let spec = PackageSpec ("PackageTests" </> "BuildDeps" </> "TargetSpecificDeps2") []
+    let spec = PackageSpec
+            { directory = "PackageTests" </> "BuildDeps" </> "TargetSpecificDeps2"
+            , configOpts = []
+            , distPref = Nothing
+            }
     result <- cabal_build spec ghcPath
     do
         assertEqual "cabal build should succeed - see test-log.txt" True (successful result)

Cabal/tests/PackageTests/BuildDeps/TargetSpecificDeps3/Check.hs

@@ -10,7 +10,11 @@ import Text.Regex.Posix
 
 suite :: FilePath -> Test
 suite ghcPath = TestCase $ do
-    let spec = PackageSpec ("PackageTests" </> "BuildDeps" </> "TargetSpecificDeps3") []
+    let spec = PackageSpec
+            { directory = "PackageTests" </> "BuildDeps" </> "TargetSpecificDeps3"
+            , configOpts = []
+            , distPref = Nothing
+            }
     result <- cabal_build spec ghcPath
     do
         assertEqual "cabal build should fail - see test-log.txt" False (successful result)

Cabal/tests/PackageTests/CMain/Check.hs

@@ -11,6 +11,10 @@ dir = "PackageTests" </> "CMain"
 
 checkBuild :: FilePath -> Test
 checkBuild ghcPath = TestCase $ do
-    let spec = PackageSpec dir []
+    let spec = PackageSpec
+            { directory = dir
+            , distPref = Nothing
+            , configOpts = []
+            }
     buildResult <- cabal_build spec ghcPath
     assertBuildSucceeded buildResult

Cabal/tests/PackageTests/DeterministicAr/Check.hs

@@ -51,7 +51,11 @@ this = "DeterministicAr"
 suite :: FilePath -> FilePath -> Test
 suite ghcPath ghcPkgPath = TestCase $ do
     let dir = "PackageTests" </> this
-    let spec = PackageSpec dir []
+    let spec = PackageSpec
+            { directory = dir
+            , configOpts = []
+            , distPref = Nothing
+            }
 
     unregister this ghcPkgPath
     iResult <- cabal_install spec ghcPath

Cabal/tests/PackageTests/EmptyLib/Check.hs

@@ -7,7 +7,10 @@ import Test.HUnit
 -- See https://github.com/haskell/cabal/issues/1241
 emptyLib :: FilePath -> Test
 emptyLib ghcPath = TestCase $ do
-   let spec = PackageSpec ("PackageTests" </> "EmptyLib"
-                           </> "empty") []
+   let spec = PackageSpec
+          { directory = "PackageTests" </> "EmptyLib" </> "empty"
+          , configOpts = []
+          , distPref = Nothing
+          }
    result <- cabal_build spec ghcPath
    assertBuildSucceeded result

Cabal/tests/PackageTests/Haddock/Check.hs

@@ -18,7 +18,11 @@ suite :: FilePath -> Test
 suite ghcPath = TestCase $ do
     let dir = "PackageTests" </> this
         haddocksDir = dir </> "dist" </> "doc" </> "html" </> "Haddock"
-        spec = PackageSpec dir []
+        spec = PackageSpec
+            { directory = dir
+            , configOpts = []
+            , distPref = Nothing
+            }
 
     haddocksDirExists <- doesDirectoryExist haddocksDir
     when haddocksDirExists (removeDirectoryRecursive haddocksDir)

Cabal/tests/PackageTests/OrderFlags/Check.hs

@@ -11,7 +11,11 @@ import Prelude hiding (catch)
 
 suite :: FilePath -> Test
 suite ghcPath = TestCase $ do
-    let spec = PackageSpec ("PackageTests" </> "OrderFlags") []
+    let spec = PackageSpec
+            { directory = "PackageTests" </> "OrderFlags"
+            , configOpts = []
+            , distPref = Nothing
+            }
     result <- cabal_build spec ghcPath
     do
         assertEqual "cabal build should succeed - see test-log.txt" True (successful result)

Cabal/tests/PackageTests/PackageTester.hs

@@ -51,6 +51,7 @@ import Distribution.Verbosity (Verbosity, flagToVerbosity, normal)
 
 data PackageSpec = PackageSpec
     { directory  :: FilePath
+    , distPref :: Maybe FilePath
     , configOpts :: [String]
     }
 
@@ -180,7 +181,10 @@ compileSetup packageDir ghcPath = do
 
 -- | Returns the command that was issued, the return code, and the output text.
 cabal :: PackageSpec -> [(String, Maybe String)] -> [String] -> FilePath -> IO (String, ExitCode, String)
-cabal spec envOverrides cabalArgs ghcPath = do
+cabal spec envOverrides cabalArgs_ ghcPath = do
+    let cabalArgs = case distPref spec of
+                       Nothing -> cabalArgs_
+                       Just dist -> ("--builddir=" ++ dist) : cabalArgs_
     customSetup <- doesFileExist (directory spec </> "Setup.hs")
     if customSetup
         then do