Merge pull request #10890 from haskell/mergify/bp/3.14/pr-10826

Backport #10826: Append paths in global config to progdb in configureCompiler v2

Author: mergify[bot]

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

@@ -470,6 +470,7 @@ configureCompiler
         { projectConfigHcFlavor
         , projectConfigHcPath
         , projectConfigHcPkg
+        , projectConfigProgPathExtra
         }
     , projectConfigLocalPackages =
       PackageConfig
@@ -493,25 +494,28 @@ configureCompiler
       )
       $ do
         liftIO $ info verbosity "Compiler settings changed, reconfiguring..."
-        let extraPath = fromNubList packageConfigProgramPathExtra
-        progdb <- liftIO $ prependProgramSearchPath verbosity extraPath [] defaultProgramDb
-        let progdb' = userSpecifyPaths (Map.toList (getMapLast packageConfigProgramPaths)) progdb
-        result@(_, _, progdb'') <-
+        progdb <-
+          liftIO $
+            -- Add paths in the global config
+            prependProgramSearchPath verbosity (fromNubList projectConfigProgPathExtra) [] defaultProgramDb
+              -- Add paths in the local config
+              >>= prependProgramSearchPath verbosity (fromNubList packageConfigProgramPathExtra) []
+              >>= pure . userSpecifyPaths (Map.toList (getMapLast packageConfigProgramPaths))
+        result@(_, _, progdb') <-
           liftIO $
             Cabal.configCompilerEx
               hcFlavor
               hcPath
               hcPkg
-              progdb'
+              progdb
               verbosity
-
         -- Note that we added the user-supplied program locations and args
         -- for /all/ programs, not just those for the compiler prog and
         -- compiler-related utils. In principle we don't know which programs
         -- the compiler will configure (and it does vary between compilers).
         -- We do know however that the compiler will only configure the
         -- programs it cares about, and those are the ones we monitor here.
-        monitorFiles (programsMonitorFiles progdb'')
+        monitorFiles (programsMonitorFiles progdb')
 
         -- Note: There is currently a bug here: we are dropping unconfigured
         -- programs from the 'ProgramDb' when we re-use the cache created by

cabal-testsuite/PackageTests/ExtraProgPathGlobal/MyLibrary.hs

@@ -0,0 +1 @@
+module MyLibrary () where

cabal-testsuite/PackageTests/ExtraProgPathGlobal/cabal.project

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

cabal-testsuite/PackageTests/ExtraProgPathGlobal/my.cabal

@@ -0,0 +1,20 @@
+name: CheckExtraProgPathGlobal
+version: 0.1
+license: BSD3
+license-file: LICENSE
+author: Yuto Takano
+maintainer: Yuto Takano
+synopsis: Check Extra Prog Path Global
+category: PackageTests
+build-type: Simple
+cabal-version: 2.0
+
+description:
+    Check that Cabal recognizes an override of the prog path.
+
+Library
+    pkgconfig-depends: zlib
+    default-language: Haskell2010
+    build-depends: base <5.0
+    exposed-modules:
+        MyLibrary

cabal-testsuite/PackageTests/ExtraProgPathGlobal/scripts-winpath/pkg-config

@@ -0,0 +1,49 @@
+#!/bin/sh
+
+set -eu
+
+# ugly, but "good enough" for this test
+# This will need to be updated whenever cabal invokes pkg-config
+# in new ways
+case "$*" in
+  '--version')
+    echo 2.1.0  # whatever
+    ;;
+
+  '--variable pc_path pkg-config')
+    echo '.'
+    ;;
+
+  '--list-all')
+    printf 'zlib   zlib - zlib compression library\n'
+    # \256 = \xAE is the iso-8859-1 (latin-1) encoded version of U+00AE,
+    # i.e. the "registered sign": ®
+    # This resulted in problems, see #9608
+    printf 'vpl    Intel\256 Video Processing Library - Accelerated video decode, encode, and frame processing capabilities on Intel\256 GPUs\n'
+    # \360 = \xF0 is latin-1 for ð; this is orð, Icelandic for "word"/"words".
+    printf 'or\360   Icelandic characters\n'
+    ;;
+
+  '--modversion '*)
+    shift  # drop the --modversion
+    for arg; do
+      case "$arg" in
+        zlib) echo 1.3; ;;  # whatever
+        vpl) echo 2.10; ;;  # whatever
+        # No entry for orð here; let's not even try to match on that
+        *)
+          echo >&2 "Package $arg was not found in the pkg-config search path."
+          exit 1
+      esac
+    done
+    ;;
+
+  # Ignore some stuff we're not implementing
+  '--cflags '*) ;;
+  '--libs '*) ;;
+
+  *)
+    echo >&2 "pkg-config: unrecognised arguments $* (this is an incomplete shim)"
+    exit 1
+    ;;
+esac

cabal-testsuite/PackageTests/ExtraProgPathGlobal/scripts-winpath/pkg-config.exe

@@ -0,0 +1,2 @@
+path = "FINDSH/sh.exe"
+args = "SCRIPTSWINPATHDIR/pkg-config"

cabal-testsuite/PackageTests/ExtraProgPathGlobal/scripts-winpath/pkg-config.shim

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+exit 1;

cabal-testsuite/PackageTests/ExtraProgPathGlobal/scripts/pkg-config

@@ -0,0 +1,2 @@
+path = "FINDSH/sh.exe"
+args = "SCRIPTSDIR/pkg-config"