Merge pull request #10990 from sergv/fix-cabal-exec

Make ‘cabal exec’ not pass -package-env to called executable

Author: mergify[bot]

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

@@ -200,16 +200,13 @@ execAction flags extraArgs globalFlags = do
 
       ( if envFilesSupported
           then withTempEnvFile verbosity baseCtx buildCtx buildStatus
-          else \f ->
-            if programIsConfiguredCompiler
-              then f environmentPackageArgs []
-              else f [] []
+          else \f -> f environmentPackageArgs []
         )
         $ \argOverrides envOverrides -> do
           let program' =
                 withOverrides
                   envOverrides
-                  argOverrides
+                  (if programIsConfiguredCompiler then argOverrides else [])
                   program
               invocation = programInvocation program' args
               dryRun =

cabal-testsuite/PackageTests/ExecCommand/Main.hs

@@ -0,0 +1,13 @@
+
+module Main (main) where
+
+import System.Environment
+import System.Exit
+import System.IO
+
+main :: IO ()
+main = do
+  args <- getArgs
+  case args of
+    ["--required", "foo"] -> pure ()
+    other -> die $ "Unexpected arguments: " ++ show other

cabal-testsuite/PackageTests/ExecCommand/cabal.out

@@ -0,0 +1,9 @@
+# cabal v2-build
+Resolving dependencies...
+Build profile: -w ghc-<GHCVER> -O1
+In order, the following will be built:
+ - my-0.1 (exe:my-executable) (first run)
+Configuring executable 'my-executable' for my-0.1...
+Preprocessing executable 'my-executable' for my-0.1...
+Building executable 'my-executable' for my-0.1...
+# cabal v2-exec

cabal-testsuite/PackageTests/ExecCommand/cabal.project

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

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

@@ -0,0 +1,18 @@
+
+import Test.Cabal.Prelude
+
+main :: IO ()
+main = cabalTest $ do
+  cabal "v2-build" ["my:exe:my-executable"]
+
+  withPlan $ do
+    exePath <- planExePath "my" "my-executable"
+
+    -- The test is to check that we’re not acceidentally passing more
+    -- than expected.
+    --
+    -- Target executable may not accept any extra option cabal may pass.
+    -- Or it may and it would lead to incorrect results and lengthy
+    -- debugging, which is worse.
+    cabal "v2-exec" [exePath, "--", "--required", "foo"]
+

cabal-testsuite/PackageTests/ExecCommand/my.cabal

@@ -0,0 +1,10 @@
+cabal-version:  3.0
+name:           my
+version:        0.1
+license:        BSD-3-Clause
+build-type:     Simple
+
+executable my-executable
+  main-is:            Main.hs
+  build-depends:      base
+  default-language:   Haskell2010

changelog.d/pr-10828.md

@@ -0,0 +1,15 @@
+---
+synopsis: "Isolate Cabal from the GHC_ENVIRONMENT variable"
+packages: [Cabal]
+prs: 10828 10990
+
+issues: 10759
+---
+
+For GHC 8.4.4 and later, Cabal now passes the `-package-env=-` flag to GHC.
+This prevents the `GHC_ENVIRONMENT` variable or any package environment files
+from affecting Cabal builds.
+
+This change eliminates unexpected build behavior that could occur when users
+had GHC environment files configured in their system that Cabal wasn't aware
+of.

changelog.d/pr-10830.md

@@ -1,7 +1,7 @@
 ---
 synopsis: Set <pkgname>_datadir to an absolute path when running tests
 packages: [Cabal]
-prs: 10828
+prs: 10830
 issues: [10717]
 ---
 

release-notes/Cabal-3.14.2.0.md

@@ -19,7 +19,7 @@ Cabal and Cabal-syntax 3.14.2.0 changelog and release notes
   environment for these processes, Cabal would append the overridden environment
   to the existing environment, creating duplicates of the same variable.
 
-- Set `<pkgname>_datadir` to an absolute path when running tests [#10717](https://github.com/haskell/cabal/issues/10717) [#10828](https://github.com/haskell/cabal/pull/10828)
+- Set `<pkgname>_datadir` to an absolute path when running tests [#10717](https://github.com/haskell/cabal/issues/10717) [#10830](https://github.com/haskell/cabal/pull/10830)
 
   Fix a regression where `<pkgname>_datadir` was set to a relative path. This
   caused issues when running testsuites which changed the working directory and