Merge pull request #10800 from haskell/wip/t10772

cabal-install: Fix the directory the build folder is created in

Author: mergify[bot]

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

@@ -459,7 +459,7 @@ buildInplaceUnpackedPackage
     -- TODO: [code cleanup] there is duplication between the
     --      distdirlayout and the builddir here builddir is not
     --      enough, we also need the per-package cachedir
-    createDirectoryIfMissingVerbose verbosity True $ getSymbolicPath builddir
+    createDirectoryIfMissingVerbose verbosity True $ interpretSymbolicPath (Just srcdir) builddir
     createDirectoryIfMissingVerbose
       verbosity
       True

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

@@ -15,7 +15,7 @@ main = cabalTest $ recordMode DoNotRecord $ withProjectFile "cabal.project" $ do
           else "haddock-response*.txt"
 
   -- Check that there is a response file.
-  responseFiles <- assertGlobMatchesTestDir testTmpDir glob
+  responseFiles <- assertGlobMatchesTestDir testSystemTmpDir glob
 
   -- Check that the matched response file is not empty, and is indeed a Haddock
   -- response file.

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

@@ -22,7 +22,7 @@ main =
             else "haddock-response*.txt"
 
     -- Check that there is a response file.
-    responseFiles <- assertGlobMatchesTestDir testTmpDir glob
+    responseFiles <- assertGlobMatchesTestDir testSystemTmpDir glob
 
     -- Check that the matched response file is not empty, and is indeed a Haddock
     -- response file.

cabal-testsuite/PackageTests/NewBuild/CmdRun/NoContext/cabal.out

@@ -0,0 +1,7 @@
+# cabal v2-run
+Resolving dependencies...
+Build profile: -w ghc-<GHCVER> -O1
+In order, the following will be built:
+ - fake-package-0 (exe:script-script.hs) (first run)
+Configuring executable 'script-script.hs' for fake-package-0...
+Building executable 'script-script.hs' for fake-package-0...

cabal-testsuite/PackageTests/NewBuild/CmdRun/NoContext/cabal.test.hs

@@ -0,0 +1,17 @@
+import Test.Cabal.Prelude
+
+main = cabalTest $ do
+    -- NB: Uses cabal_raw' here to direct simulate what a user would write (#10772)
+    res <- defaultRecordMode RecordMarked $ do
+      recordHeader ["cabal", "v2-run"]
+      cabal_raw' ["v2-run", "script.hs", marked_verbose] Nothing
+    assertOutputContains "Hello World" res
+
+    env      <- getTestEnv
+    cacheDir <- getScriptCacheDirectory (testCurrentDir env </> "script.hs")
+    liftIO $ print (testTmpDir env </> "build")
+
+    shouldExist $ cacheDir </> "fake-package.cabal"
+    shouldExist $ cacheDir </> "scriptlocation"
+    shouldDirectoryNotExist $ testTmpDir env </> "build"
+    shouldDirectoryNotExist $ testTmpDir env </> "dist-newstyle"

cabal-testsuite/PackageTests/NewBuild/CmdRun/NoContext/script.hs

@@ -0,0 +1,10 @@
+#! /usr/bin/env cabal
+{- cabal:
+build-depends: base >= 4.3 && <5
+-}
+{-# LANGUAGE ScopedTypeVariables #-}
+
+import Prelude
+
+main :: IO ()
+main = putStrLn "Hello World"

cabal-testsuite/PackageTests/NewBuild/CmdRun/Script/cabal.test.hs

@@ -1,11 +1,19 @@
 import Test.Cabal.Prelude
 
 main = cabalTest $ do
-    res <- cabal' "v2-run" ["script.hs"]
+    -- NB: Uses cabal_raw' here to direct simulate what a user would write (#10772)
+    res <- defaultRecordMode RecordMarked $ do
+      recordHeader ["cabal", "v2-run"]
+      cabal_raw' ["v2-run", "script.hs", marked_verbose] Nothing
     assertOutputContains "Hello World" res
 
     env      <- getTestEnv
     cacheDir <- getScriptCacheDirectory (testCurrentDir env </> "script.hs")
+    liftIO $ print (testTmpDir env </> "build")
 
     shouldExist $ cacheDir </> "fake-package.cabal"
     shouldExist $ cacheDir </> "scriptlocation"
+    shouldDirectoryNotExist $ testTmpDir env </> "build"
+    -- "dist-newstyle" should exist, because the folder has a cabal.project in
+    -- so the v2-run command runs in that context.
+    shouldDirectoryExist $ testTmpDir env </> "dist-newstyle"

cabal-testsuite/src/Test/Cabal/Monad.hs

@@ -34,6 +34,7 @@ module Test.Cabal.Monad (
     testPrefixDir,
     testLibInstallDir,
     testDistDir,
+    testSystemTmpDir,
     testPackageDbDir,
     testRepoDir,
     testKeysDir,
@@ -407,9 +408,9 @@ runTestM mode m =
                         , ("CABAL_DIR", Just (testCabalDir env))
                         , ("CABAL_CONFIG", Just (testUserCabalConfigFile env))
                         -- Set `TMPDIR` so that temporary files aren't created in the global `TMPDIR`.
-                        , ("TMPDIR", Just tmp_dir)
+                        , ("TMPDIR", Just (testSystemTmpDir env))
                         -- Windows uses `TMP` for the `TMPDIR`.
-                        , ("TMP", Just tmp_dir)
+                        , ("TMP", Just (testSystemTmpDir env))
                         ],
                     testShouldFail = False,
                     testRelativeCurrentDir = ".",
@@ -548,6 +549,7 @@ initWorkDir :: TestM ()
 initWorkDir = do
     env <- getTestEnv
     liftIO $ createDirectoryIfMissing True (testWorkDir env)
+    liftIO $ createDirectoryIfMissing True (testSystemTmpDir env)
 
 
 
@@ -824,6 +826,11 @@ testName env = testSubName env <.> testMode env
 testWorkDir :: TestEnv -> FilePath
 testWorkDir env = testTmpDir env </> (testName env <.> "dist")
 
+-- The folder which TMPDIR is set to.
+-- This is different to testTmpDir, which is the folder which is the test is run from.
+testSystemTmpDir :: TestEnv -> FilePath
+testSystemTmpDir env = testWorkDir env </> "tmp"
+
 -- | The absolute prefix where installs go.
 testPrefixDir :: TestEnv -> FilePath
 testPrefixDir env = testWorkDir env </> "usr"

changelog.d/pr-10800

@@ -0,0 +1,12 @@
+synopsis: Fix regression where 'build' folder was created in CWD when running a standlone script.
+packages: cabal-install
+prs: #10800
+issues: #10772
+significance:
+
+description: {
+
+Fix a regression where the `build` folder was created in the current directory
+when running a standalone script.
+
+}