Add test to check global extra-prog-path is used in configureCompiler

We add a new PackageTest for cabal-install, which makes sure that the
extra-prog-path in the global config is used when resolving pkg-config
instead of anything already on PATH. We do this by specifying a "bad"
pkg-config to extra-prog-path that returns exit code 1.

On Windows, Cabal logs are identical in the following two cases:
- the override didn't work, and pkg-config was not found on the system
- the override did work, and querying it failed (expectedly)
To work around this, we add a "good" pkg-config script to PATH before-
hand, so that cabal succeeds in the first case and the logs differ.

This test is a stripped down reproduction of what happens when a user on
Windows adds MSYS2 paths to extra-prog-path but not the system PATH.
This is a reasonable setup (often, adding MSYS2 to system PATH is not
good practice), and is even created automatically by GHCup.

Author: yutotakano

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"

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

@@ -0,0 +1,14 @@
+# cabal v2-build
+Configuration is affected by the following files:
+- cabal.project
+Warning: cannot determine version of <ROOT>/scripts/pkg-config :
+""
+Warning: cannot determine version of <ROOT>/scripts/pkg-config :
+""
+Resolving dependencies...
+Error: [Cabal-7107]
+Could not resolve dependencies:
+[__0] next goal: CheckExtraProgPathGlobal (user goal)
+[__0] rejecting: CheckExtraProgPathGlobal-0.1 (pkg-config package zlib-any is needed but no pkg-config executable was found or querying it failed)
+[__0] fail (backjumping, conflict set: CheckExtraProgPathGlobal)
+After searching the rest of the dependency tree exhaustively, these were the goals I've had most trouble fulfilling: CheckExtraProgPathGlobal (2)