diff --git a/Cabal/src/Distribution/Simple/Program/Builtin.hs b/Cabal/src/Distribution/Simple/Program/Builtin.hs index 65501111a7e..c47b72f9c7d 100644 --- a/Cabal/src/Distribution/Simple/Program/Builtin.hs +++ b/Cabal/src/Distribution/Simple/Program/Builtin.hs @@ -104,32 +104,44 @@ ghcProgram :: Program ghcProgram = (simpleProgram "ghc") { programFindVersion = findProgramVersion "--numeric-version" id - , -- Workaround for https://gitlab.haskell.org/ghc/ghc/-/issues/8825 - -- (spurious warning on non-english locales) - programPostConf = \_verbosity ghcProg -> - do - let ghcProg' = - ghcProg - { programOverrideEnv = - ("LANGUAGE", Just "en") - : programOverrideEnv ghcProg - } - -- Only the 7.8 branch seems to be affected. Fixed in 7.8.4. - affectedVersionRange = - intersectVersionRanges - (laterVersion $ mkVersion [7, 8, 0]) - (earlierVersion $ mkVersion [7, 8, 4]) - return $ - maybe - ghcProg - ( \v -> - if withinRange v affectedVersionRange - then ghcProg' - else ghcProg - ) - (programVersion ghcProg) + , programPostConf = ghcPostConf , programNormaliseArgs = normaliseGhcArgs } + where + ghcPostConf _verbosity ghcProg = do + let setLanguageEnv prog = + prog + { programOverrideEnv = + ("LANGUAGE", Just "en") + : programOverrideEnv ghcProg + } + + ignorePackageEnv prog = prog{programDefaultArgs = "-package-env=-" : programDefaultArgs prog} + + -- Only the 7.8 branch seems to be affected. Fixed in 7.8.4. + affectedVersionRange = + intersectVersionRanges + (laterVersion $ mkVersion [7, 8, 0]) + (earlierVersion $ mkVersion [7, 8, 4]) + + canIgnorePackageEnv = orLaterVersion $ mkVersion [8, 4, 4] + + applyWhen cond f prog = if cond then f prog else prog + + return $ + maybe + ghcProg + ( \v -> + -- By default, ignore GHC_ENVIRONMENT variable of any package environmnet + -- files. See #10759 + applyWhen (withinRange v canIgnorePackageEnv) ignorePackageEnv + -- Workaround for https://gitlab.haskell.org/ghc/ghc/-/issues/8825 + -- (spurious warning on non-english locales) + $ + applyWhen (withinRange v affectedVersionRange) setLanguageEnv $ + ghcProg + ) + (programVersion ghcProg) runghcProgram :: Program runghcProgram = diff --git a/cabal-install/src/Distribution/Client/CmdExec.hs b/cabal-install/src/Distribution/Client/CmdExec.hs index caa680a3a3a..bdf392d0a78 100644 --- a/cabal-install/src/Distribution/Client/CmdExec.hs +++ b/cabal-install/src/Distribution/Client/CmdExec.hs @@ -46,7 +46,7 @@ import Distribution.Client.ProjectOrchestration import Distribution.Client.ProjectPlanOutput ( PostBuildProjectStatus , argsEquivalentOfGhcEnvironmentFile - , createPackageEnvironment + , createPackageEnvironmentAndArgs , updatePostBuildProjectStatus ) import Distribution.Client.ProjectPlanning @@ -191,7 +191,7 @@ execAction flags@NixStyleFlags{..} extraArgs globalFlags = do [] -> dieWithException verbosity SpecifyAnExecutable exe : args -> do (program, _) <- requireProgram verbosity (simpleProgram exe) programDb - let argOverrides = + let environmentPackageArgs = argsEquivalentOfGhcEnvironmentFile compiler (distDirLayout baseCtx) @@ -201,21 +201,19 @@ execAction flags@NixStyleFlags{..} extraArgs globalFlags = do matchCompilerPath (elaboratedShared buildCtx) program - argOverrides' = - if envFilesSupported - || not programIsConfiguredCompiler - then [] - else argOverrides ( if envFilesSupported then withTempEnvFile verbosity baseCtx buildCtx buildStatus - else \f -> f [] + else \f -> + if programIsConfiguredCompiler + then f environmentPackageArgs [] + else f [] [] ) - $ \envOverrides -> do + $ \argOverrides envOverrides -> do let program' = withOverrides envOverrides - argOverrides' + argOverrides program invocation = programInvocation program' args dryRun = @@ -253,7 +251,7 @@ withTempEnvFile -> ProjectBaseContext -> ProjectBuildContext -> PostBuildProjectStatus - -> ([(String, Maybe String)] -> IO a) + -> ([String] -> [(String, Maybe String)] -> IO a) -> IO a withTempEnvFile verbosity baseCtx buildCtx buildStatus action = do let tmpDirTemplate = distTempDirectory (distDirLayout baseCtx) @@ -263,14 +261,14 @@ withTempEnvFile verbosity baseCtx buildCtx buildStatus action = do tmpDirTemplate "environment." ( \tmpDir -> do - envOverrides <- - createPackageEnvironment + (argOverrides, envOverrides) <- + createPackageEnvironmentAndArgs verbosity tmpDir (elaboratedPlanToExecute buildCtx) (elaboratedShared buildCtx) buildStatus - action envOverrides + action argOverrides envOverrides ) -- | Get paths to all dependency executables to be included in PATH. diff --git a/cabal-install/src/Distribution/Client/ProjectPlanOutput.hs b/cabal-install/src/Distribution/Client/ProjectPlanOutput.hs index b6b5dc8dd79..454f9f18878 100644 --- a/cabal-install/src/Distribution/Client/ProjectPlanOutput.hs +++ b/cabal-install/src/Distribution/Client/ProjectPlanOutput.hs @@ -12,7 +12,7 @@ module Distribution.Client.ProjectPlanOutput -- | Several outputs rely on having a general overview of , PostBuildProjectStatus (..) , updatePostBuildProjectStatus - , createPackageEnvironment + , createPackageEnvironmentAndArgs , writePlanGhcEnvironment , argsEquivalentOfGhcEnvironmentFile ) where @@ -777,7 +777,7 @@ writePackagesUpToDateCacheFile DistDirLayout{distProjectCacheFile} upToDate = writeFileAtomic (distProjectCacheFile "up-to-date") $ Binary.encode upToDate --- | Prepare a package environment that includes all the library dependencies +-- | Prepare a package environment and args that includes all the library dependencies -- for a plan. -- -- When running cabal new-exec, we want to set things up so that the compiler @@ -786,14 +786,17 @@ writePackagesUpToDateCacheFile DistDirLayout{distProjectCacheFile} upToDate = -- temporarily, in case the compiler wants to learn this information via the -- filesystem, and returns any environment variable overrides the compiler -- needs. -createPackageEnvironment +-- +-- The function returns both the arguments you need to pass to the compiler and +-- the environment variables you need to set. +createPackageEnvironmentAndArgs :: Verbosity -> FilePath -> ElaboratedInstallPlan -> ElaboratedSharedConfig -> PostBuildProjectStatus - -> IO [(String, Maybe String)] -createPackageEnvironment + -> IO ([String], [(String, Maybe String)]) +createPackageEnvironmentAndArgs verbosity path elaboratedPlan @@ -808,14 +811,14 @@ createPackageEnvironment elaboratedShared buildStatus case envFileM of - Just envFile -> return [("GHC_ENVIRONMENT", Just envFile)] + Just envFile -> return (["-package-env=" ++ envFile], [("GHC_ENVIRONMENT", Just envFile)]) Nothing -> do warn verbosity "the configured version of GHC does not support reading package lists from the environment; commands that need the current project's package database are likely to fail" - return [] + return ([], []) | otherwise = do warn verbosity "package environment configuration is not supported for the currently configured compiler; commands that need the current project's package database are likely to fail" - return [] + return ([], []) -- Writing .ghc.environment files -- diff --git a/cabal-testsuite/PackageTests/EnvironmentFile/CHANGELOG.md b/cabal-testsuite/PackageTests/EnvironmentFile/CHANGELOG.md new file mode 100644 index 00000000000..bd96eeb69a6 --- /dev/null +++ b/cabal-testsuite/PackageTests/EnvironmentFile/CHANGELOG.md @@ -0,0 +1,5 @@ +# Revision history for EnvironmentFile + +## 0.1.0.0 -- YYYY-mm-dd + +* First version. Released on an unsuspecting world. diff --git a/cabal-testsuite/PackageTests/EnvironmentFile/EnvironmentFile.cabal b/cabal-testsuite/PackageTests/EnvironmentFile/EnvironmentFile.cabal new file mode 100644 index 00000000000..b88ab3021ac --- /dev/null +++ b/cabal-testsuite/PackageTests/EnvironmentFile/EnvironmentFile.cabal @@ -0,0 +1,18 @@ +cabal-version: 3.14 +name: EnvironmentFile +version: 0.1.0.0 +license: NONE +author: Matthew Pickering +maintainer: matthewtpickering@gmail.com +build-type: Simple +extra-doc-files: CHANGELOG.md + +common warnings + ghc-options: -Wall + +executable EnvironmentFile + import: warnings + main-is: Main.hs + build-depends: base < 5, + hs-source-dirs: app + default-language: Haskell2010 diff --git a/cabal-testsuite/PackageTests/EnvironmentFile/app/Main.hs b/cabal-testsuite/PackageTests/EnvironmentFile/app/Main.hs new file mode 100644 index 00000000000..65ae4a05d5d --- /dev/null +++ b/cabal-testsuite/PackageTests/EnvironmentFile/app/Main.hs @@ -0,0 +1,4 @@ +module Main where + +main :: IO () +main = putStrLn "Hello, Haskell!" diff --git a/cabal-testsuite/PackageTests/EnvironmentFile/cabal.test.hs b/cabal-testsuite/PackageTests/EnvironmentFile/cabal.test.hs new file mode 100644 index 00000000000..97899a99471 --- /dev/null +++ b/cabal-testsuite/PackageTests/EnvironmentFile/cabal.test.hs @@ -0,0 +1,8 @@ +import Test.Cabal.Prelude +import System.FilePath +main = cabalTest $ recordMode DoNotRecord $ do + env <- getTestEnv + let cur_dir = testCurrentDir env + -- Set GHC_ENVIRONMENT to a file which contains garbage + withEnv [("GHC_ENVIRONMENT", Just (cur_dir "ghc.environment"))] $ do + cabal "build" ["all"] diff --git a/cabal-testsuite/PackageTests/EnvironmentFile/ghc.environment b/cabal-testsuite/PackageTests/EnvironmentFile/ghc.environment new file mode 100644 index 00000000000..be7ddea52cf --- /dev/null +++ b/cabal-testsuite/PackageTests/EnvironmentFile/ghc.environment @@ -0,0 +1 @@ +this-file-(ghc.environment)-contains-garbage-it-should-not-be-read diff --git a/changelog.d/pr-10828.md b/changelog.d/pr-10828.md new file mode 100644 index 00000000000..8b77a00ae5e --- /dev/null +++ b/changelog.d/pr-10828.md @@ -0,0 +1,15 @@ +--- +synopsis: "Isolate Cabal from the GHC_ENVIRONMENT variable" +packages: [Cabal] +prs: 10828 + +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.