Fix --host= triple mangling during cross-compilation

issue: #5887

I don't like you've to use nix to cross compile,
cabal should be able to do this.

Author: jappeace-sloth

Cabal/src/Distribution/Simple.hs

@@ -135,6 +135,7 @@ import Language.Haskell.Extension
 
 -- Base
 import Data.List (unionBy, (\\))
+import qualified Data.Map as Map
 import System.Directory (removePathForcibly)
 import System.Environment (getArgs, getProgName)
 import System.IO (hPutStr, hPutStrLn)
@@ -981,12 +982,14 @@ autoconfUserHooks =
         let common = configCommonFlags flags
             verbosity = mkVerbosity defaultVerbosityHandles (fromFlag $ setupVerbosity common)
             mbWorkDir = flagToMaybe $ setupWorkingDir common
+            targetTriple = Map.lookup "Target platform" (compilerProperties (compiler lbi))
         runConfigureScript
           defaultVerbosityHandles
           flags
           (flagAssignment lbi)
           (withPrograms lbi)
           (hostPlatform lbi)
+          targetTriple
         pbi <- getHookedBuildInfo verbosity mbWorkDir (buildDir lbi)
         sanityCheckHookedBuildInfo verbosity pkg_descr pbi
         let pkg_descr' = updatePackageDescription pbi pkg_descr
@@ -1055,9 +1058,12 @@ autoconfSetupHooks =
               { LBC.configFlags = cfg
               , LBC.flagAssignment = flags
               , LBC.hostPlatform = plat
+              , LBC.compiler = comp
               }
           }
-        ) = runConfigureScript defaultVerbosityHandles cfg flags progs plat
+        ) =
+        let targetTriple = Map.lookup "Target platform" (compilerProperties comp)
+         in runConfigureScript defaultVerbosityHandles cfg flags progs plat targetTriple
 
     pre_conf_comp
       :: SetupHooks.PreConfComponentInputs

Cabal/src/Distribution/Simple/ConfigureScript.hs

@@ -56,8 +56,11 @@ runConfigureScript
   -> ProgramDb
   -> Platform
   -- ^ host platform
+  -> Maybe String
+  -- ^ original target triple from compiler info (e.g. @"x86_64-w64-mingw32"@),
+  -- used for the @--host=@ flag instead of the pretty-printed 'Platform'
   -> IO ()
-runConfigureScript verbHandles cfg flags programDb hp = do
+runConfigureScript verbHandles cfg flags programDb hp targetTriple = do
   let commonCfg = configCommonFlags cfg
       verbosity = mkVerbosity verbHandles (fromFlag $ setupVerbosity commonCfg)
   dist_dir <- findDistPrefOrDefault $ setupDistPref commonCfg
@@ -183,7 +186,7 @@ runConfigureScript verbHandles cfg flags programDb hp = do
           : [("CXXFLAGS", Just (mkFlagsEnv cxxFlags "CXXFLAGS")) | Just cxxFlags <- [mcxxFlags]]
           ++ [("PATH", Just pathEnv) | not (null extraPath)]
           ++ cabalFlagEnv
-      maybeHostFlag = ["--host=" ++ show (pretty hp) | hp /= buildPlatform]
+      maybeHostFlag = ["--host=" ++ fromMaybe (show (pretty hp)) targetTriple | hp /= buildPlatform]
       args' =
         configureFile'
           : args

cabal-testsuite/PackageTests/ConfigureHostTriple/A.hs

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

cabal-testsuite/PackageTests/ConfigureHostTriple/Setup.hs

@@ -0,0 +1,6 @@
+module Main (main) where
+
+import Distribution.Simple
+
+main :: IO ()
+main = defaultMainWithHooks autoconfUserHooks

cabal-testsuite/PackageTests/ConfigureHostTriple/configure

@@ -0,0 +1,4 @@
+#!/bin/sh
+# Minimal configure script that records its arguments.
+# We write all args to configure-args.txt so the test can inspect them.
+echo "$@" > configure-args.txt

cabal-testsuite/PackageTests/ConfigureHostTriple/scripts/fake-ghc.sh

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+# A fake GHC that proxies the real GHC but overrides
+# "Target platform" to simulate cross-compilation
+# to x86_64-w64-mingw32.
+
+case "$*" in
+    *--info*)
+        ghc "$@" | sed 's/("Target platform","[^"]*")/("Target platform","x86_64-w64-mingw32")/'
+        ;;
+    *)
+        exec ghc "$@"
+        ;;
+esac

cabal-testsuite/PackageTests/ConfigureHostTriple/setup.test.hs

@@ -0,0 +1,42 @@
+import Test.Cabal.Prelude
+import Test.Cabal.Script (runghc)
+import Control.Monad.IO.Class
+import Data.List (isInfixOf)
+
+-- When cross-compiling, Cabal passes a --host= flag to configure scripts.
+-- The value should be the original GNU triple (e.g. x86_64-w64-mingw32),
+-- not Cabal's canonical platform string (e.g. x86_64-windows).
+--
+-- This test uses a fake GHC wrapper that reports "x86_64-w64-mingw32"
+-- as its Target platform (simulating a cross-compiler), then checks
+-- that the configure script receives --host=x86_64-w64-mingw32
+-- rather than the mangled --host=x86_64-windows.
+main = do
+    skipIfWindows "uses sh script as fake ghc"
+    setupTest $ recordMode DoNotRecord $ do
+        env <- getTestEnv
+        let cwd = testCurrentDir env
+            fakeGhc = cwd </> "scripts" </> "fake-ghc.sh"
+        -- Run Setup.hs configure with our fake cross-compiler.
+        -- We call runghc ourselves to bypass the test framework's
+        -- --with-ghc which would override ours.
+        _ <- liftIO $ runghc
+            (testScriptEnv env)
+            (Just $ testTmpDir env)
+            (testEnvironment env)
+            ("." </> "Setup.hs")
+            [ "configure"
+            , "--distdir", testDistDir env
+            , "--with-compiler", fakeGhc
+            ]
+        -- The configure script writes its arguments to configure-args.txt
+        -- in its working directory (dist/build/).
+        let argsFile = testDistDir env </> "build" </> "configure-args.txt"
+        args <- liftIO $ readFile argsFile
+        -- The configure script should receive --host=x86_64-w64-mingw32
+        -- (the original GNU triple), not --host=x86_64-windows.
+        unless ("--host=x86_64-w64-mingw32" `isInfixOf` args) $
+            error $ unlines
+                [ "Expected --host=x86_64-w64-mingw32 in configure arguments"
+                , "but got: " ++ args
+                ]

cabal-testsuite/PackageTests/ConfigureHostTriple/test.cabal

@@ -0,0 +1,9 @@
+cabal-version: 2.2
+name: test
+version: 0
+build-type: Configure
+
+library
+  exposed-modules: A
+  build-depends: base
+  default-language: Haskell2010

changelog.d/pr-11718.md

@@ -0,0 +1,10 @@
+---
+synopsis: Fix --host= triple mangling during cross-compilation#11718
+packages: [cabal-install]
+prs: 11718
+---
+
+repairs (hopefully): https://github.com/haskell/cabal/issues/5887
+
+Adds an integration test which fails
+on master and now succeeds.