testsuite: Run tests in temporary system directories

1. Working directory is not contaminated with results of the testsuite.
   Tests can be written in a more liberal way (creating/writing files
   etc).
2. The tests are more hermetic.. for example it was basically impossible
   to write a test which run outside of a project context.
3. The overall path lengths will be much shorter, which has been a
   consistent issue on windows. We can remove hacks like
   `withShorterPathForNewBuildStore`.

Fixes #9711

Author: mpickering

Cabal/src/Distribution/Simple/Configure.hs

@@ -2587,7 +2587,12 @@ checkRelocatable verbosity pkg lbi =
                 -- @shortRelativePath prefix pkgroot@ will return a path with
                 -- @..@s and following check will fail without @canonicalizePath@.
                 canonicalized <- canonicalizePath libdir
-                unless (p `isPrefixOf` canonicalized) $
+                -- The @prefix@ itself must also be canonicalized because
+                -- canonicalizing @libdir@ may expand symlinks which would make
+                -- @prefix@ no longer being a prefix of @canonical libdir@,
+                -- while @canonical p@ could be a prefix of @canonical libdir@
+                p' <- canonicalizePath p
+                unless (p' `isPrefixOf` canonicalized) $
                   dieWithException verbosity $
                     LibDirDepsPrefixNotRelative libdir p
           | otherwise =

cabal-testsuite/PackageTests/AutoconfBadPaths/cabal.out

@@ -1,82 +1,82 @@
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo bar/configure', contains the character ' ' (space). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo bar/configure', contains the character ' ' (space). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo	bar/configure', contains the character '	' (tab). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo	bar/configure', contains the character '	' (tab). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo
+Warning: The path to the './configure' script, '/<ROOT>/foo
 bar/configure', contains the character '
 ' (newline). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo"bar/configure', contains the character '"' (double quote). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo"bar/configure', contains the character '"' (double quote). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo#bar/configure', contains the character '#' (hash). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo#bar/configure', contains the character '#' (hash). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo$bar/configure', contains the character '$' (dollar sign). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo$bar/configure', contains the character '$' (dollar sign). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo&bar/configure', contains the character '&' (ampersand). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo&bar/configure', contains the character '&' (ampersand). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo'bar/configure', contains the character ''' (single quote). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo'bar/configure', contains the character ''' (single quote). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo(bar/configure', contains the character '(' (left bracket). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo(bar/configure', contains the character '(' (left bracket). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo)bar/configure', contains the character ')' (right bracket). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo)bar/configure', contains the character ')' (right bracket). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo*bar/configure', contains the character '*' (star). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo*bar/configure', contains the character '*' (star). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo;bar/configure', contains the character ';' (semicolon). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo;bar/configure', contains the character ';' (semicolon). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo<bar/configure', contains the character '<' (less-than sign). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo<bar/configure', contains the character '<' (less-than sign). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo=bar/configure', contains the character '=' (equals sign). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo=bar/configure', contains the character '=' (equals sign). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo>bar/configure', contains the character '>' (greater-than sign). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo>bar/configure', contains the character '>' (greater-than sign). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo?bar/configure', contains the character '?' (question mark). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo?bar/configure', contains the character '?' (question mark). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo[bar/configure', contains the character '[' (left square bracket). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo[bar/configure', contains the character '[' (left square bracket). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo/bar/configure', contains the character '/' (backslash). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo/bar/configure', contains the character '/' (backslash). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo`bar/configure', contains the character '`' (backtick). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo`bar/configure', contains the character '`' (backtick). This may cause the script to fail with an obscure error, or for building the package to fail later.
 # cabal v1-configure
 Resolving dependencies...
 Configuring test-0...
-Warning: The path to the './configure' script, '/<ROOT>/cabal.dist/foo|bar/configure', contains the character '|' (pipe). This may cause the script to fail with an obscure error, or for building the package to fail later.
+Warning: The path to the './configure' script, '/<ROOT>/foo|bar/configure', contains the character '|' (pipe). This may cause the script to fail with an obscure error, or for building the package to fail later.

cabal-testsuite/PackageTests/AutoconfBadPaths/cabal.test.hs

@@ -1,5 +1,7 @@
 import Test.Cabal.Prelude
 import Data.Foldable (traverse_)
+import Distribution.Simple.Utils
+import System.Directory
 main = cabalTest $ do
   -- Test the forbidden characters except NUL. Reference:
   -- https://www.gnu.org/software/autoconf/manual/autoconf.html#File-System-Conventions
@@ -31,11 +33,21 @@ main = cabalTest $ do
     , "foo|bar"
     ]
   where
+    setup dir = do
+      env <- getTestEnv
+      let cwd = testCurrentDir env
+      liftIO $ createDirectory (testCurrentDir env </> dir)
+      liftIO $ copyFiles minBound (testCurrentDir env </> dir)
+                [ (cwd, "configure")
+                , (cwd, "Setup.hs")
+                , (cwd, "test.cabal")
+                ]
     -- 'cabal' from the prelude requires the command to succeed; we
     -- don't mind if it fails, so long as we get the warning. This is
     -- an inlined+specialised version of 'cabal' for v1-configure.
-    check dir = withSourceCopyDir dir $
+    check dir =
       defaultRecordMode RecordMarked $ do
+        setup dir
         recordHeader ["cabal", "v1-configure"]
         env <- getTestEnv
         let args =
@@ -46,7 +58,7 @@ main = cabalTest $ do
               ]
         configured_prog <- requireProgramM cabalProgram
         r <- liftIO $ run (testVerbosity env)
-                      (Just (testCurrentDir env))
+                      (Just (testCurrentDir env </> dir))
                       (testEnvironment env)
                       (programPath configured_prog)
                       args Nothing

cabal-testsuite/PackageTests/Check/ConfiguredPackage/Paths/InvalidWin/cabal.test.hs

@@ -3,7 +3,7 @@ import Test.Cabal.Prelude
 import System.Directory (createDirectoryIfMissing)
 
 -- Invalid Windows filepath.
-main = cabalTest . withSourceCopy $ do
+main = cabalTest $ do
   skipIfWindows
   cwd <- testCurrentDir <$> getTestEnv
   liftIO $ createDirectoryIfMissing False $ cwd </> "n?ul"

cabal-testsuite/PackageTests/Check/ConfiguredPackage/Paths/RecursiveGlobInRoot/a.hs

@@ -0,0 +1 @@
+module Main where

cabal-testsuite/PackageTests/Check/ConfiguredPackage/Paths/RelativeOutside/RelativeOutsideInner/cabal.out renamed to cabal-testsuite/PackageTests/Check/ConfiguredPackage/Paths/RelativeOutside/cabal.out

@@ -2,4 +2,4 @@ import Test.Cabal.Prelude
 
 -- Relative filepath outside source tree.
 main = cabalTest $
-  fails $ cabal "check" []
+  fails $ withDirectory "RelativeOutsideInner" $ cabal "check" []

cabal-testsuite/PackageTests/Check/ConfiguredPackage/Paths/RelativeOutside/RelativeOutsideInner/cabal.test.hs renamed to cabal-testsuite/PackageTests/Check/ConfiguredPackage/Paths/RelativeOutside/cabal.test.hs

@@ -1,6 +1,6 @@
 import Test.Cabal.Prelude
 main = cabalTest $ do
-    withRepo "repo" . withSourceCopy $ do
+    withRepo "repo" $ do
         cabal "v1-freeze" ["--disable-benchmarks"]
         cwd <- fmap testCurrentDir getTestEnv
         assertFileDoesNotContain (cwd </> "cabal.config") "criterion"

cabal-testsuite/PackageTests/Freeze/disable-benchmarks.test.hs

@@ -1,6 +1,6 @@
 import Test.Cabal.Prelude
 main = cabalTest $ do
-    withRepo "repo" . withSourceCopy $ do
+    withRepo "repo" $ do
         cabal "v1-freeze" ["--disable-tests"]
         cwd <- fmap testCurrentDir getTestEnv
         assertFileDoesNotContain (cwd </> "cabal.config") "test-framework"

cabal-testsuite/PackageTests/Freeze/disable-tests.test.hs

@@ -1,6 +1,6 @@
 import Test.Cabal.Prelude
 main = cabalTest $ do
-    withRepo "repo" . withSourceCopy $ do
+    withRepo "repo" $ do
         recordMode DoNotRecord $ cabal "v1-freeze" ["--dry-run"]
         cwd <- fmap testCurrentDir getTestEnv
         shouldNotExist (cwd </> "cabal.config")