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

yutotakano · 2025-03-09T14:40:29Z

Supersedes #10790 by adding tests and fixing triple-prime variable naming.

Closes #9800.

QA Notes

Cabal should be able to resolve system packages using pkg-config when pkg-config doesn't exist in the system PATH but is provided in the path specified in ~/.cabal/config in the extra-prog-path.

On Mac/Unix and other systems where pkg-config exists in PATH, there should theoretically be no regressions due to this PR. Package dependency resolution and command line interface should be the same before and after.

On Windows where pkg-config does not exist on PATH by default, specifying one on extra-prog-path (like which is done by recent GHCup automatically) should now work for resolving dependencies, when previously it would not work. You should be able to QA this by:

do a fresh GHCup/Haskell/Cabal install on Windows
check that the mingw64 binary path had been added to the global cabal config file (wherever GHCup put it)
install pkg-config into the Mingw environment: ghcup run -m -- pacman -S mingw64/mingw-w64-x86_64-pkg-config
create a test cabal package that has a pkgconfig-depends on something
BEFORE this PR: building the package will fail with not being able to find pkg-config
AFTER this PR: pkg-config will be found by cabal, building failure/success is entirely on whether the dependency exists or not

Template Α: This PR modifies behaviour or interface

Include the following checklist in your PR:

Patches conform to the coding conventions.
Any changes that could be relevant to users have been recorded in the changelog.
- Is the change significant? If so, remember to add significance: significant in the changelog file.
The documentation has been updated, if necessary.
Manual QA notes have been included.
Tests have been added. (Ask for help if you don’t know how to write them! Ask for an exemption if tests are too complex for too little coverage!)

Mikolaj · 2025-03-17T11:18:43Z

Hi! Thank you for the fix. Does "UNEXPECTED FAIL: PackageTests/ExtraProgPathGlobal/setup.test.hs" sound reasonable or is this suspect of being an unrelated CI failure?

yutotakano · 2025-03-17T13:44:10Z

cHi! That's unexpected, and I've been meaning to fix it, but I haven't got my hands on a Linux/Mac machine yet to debug (the test passes on Windows but it's also supposed to pass on other OSes). Please wait a bit! Sorry, I should've marked this PR as a draft or something.

EDIT: in retrospect, I realised that I need this as a non-draft PR to run the CI checks on it. I'll write a message here once it's ready!

yutotakano · 2025-03-25T14:36:02Z

@Mikolaj This is ready for review! The failure reason was simple: the script I added in the repo didn't have +x permissions, which is why it failed to run on Mac and Linux.

Mikolaj · 2025-03-25T16:20:19Z

@yutotakano: thank you! Let me add a label to get the reviews started.

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

jasagredo

I think this looks very good. Thanks @yutotakano

ulysses4ever · 2025-03-28T13:03:14Z

This is subtle stuff. It'd be great to add QA notes https://github.com/haskell/cabal/blob/master/CONTRIBUTING.md#qa-notes.

yutotakano · 2025-03-28T13:35:58Z

@ulysses4ever I've added some notes on what my intended functionality was and how QA can test it. I hope I'm understanding correctly what you meant by QA notes?

I also realised that the changelog entry file has the superceded PR number, is that fine? I suspect changing it would invalidate existing approval reviews, which is fine by me but additional effort for cabal maintainers.

ulysses4ever · 2025-03-28T13:38:19Z

Fixing the changelog file shouldn't invalidate anything, so, please, go ahead and fix it.

QA notes look great, thank you! Next step is to find someone with access to a Windows machine :-)

yutotakano · 2025-03-28T13:46:20Z

Done re:changelog file! I'll await the reviews :)

Mikolaj

Thank you. LGTM

Let me take the liberty of setting the merge label myself, to make it possible to include this in 3.14.2 if it's so decided (should it be backported)?

Mikolaj · 2025-03-31T07:58:01Z

Hah, it seems @yutotakano 's "note to reviewers" is blocking the merge. Let me resolve it...

Mikolaj · 2025-03-31T08:03:25Z

And now it's waiting 2 days, so let me fix the confusion by adding the delay_passed label manually.

mergify · 2025-03-31T08:04:14Z

This pull request has been removed from the queue for the following reason: pull request branch update failed.

The pull request can't be updated

You should update or rebase your pull request manually. If you do, this pull request will automatically be requeued once the queue conditions match again.
If you think this was a flaky issue, you can requeue the pull request, without updating it, by posting a @mergifyio requeue comment.

Mikolaj · 2025-03-31T08:05:55Z

@mergify rebase

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.

mergify · 2025-03-31T08:06:09Z

rebase

✅ Branch has been successfully rebased

yutotakano · 2025-03-31T08:06:09Z

Apologies for the note, thank you for dealing with it!

Mikolaj · 2025-03-31T08:21:34Z

I'm going to default to backporting this for 3.14.2. Please object if this breaks API or requires other PRs we have not backported.

Mikolaj · 2025-03-31T16:41:11Z

@mergify backport 3.14

mergify · 2025-03-31T16:41:25Z

backport 3.14

✅ Backports have been created

#10890 Backport #10826: Append paths in global config to progdb in configureCompiler v2 has been created for branch 3.14

* Append paths in global config to progdb in `configureCompiler` * 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. * Refactor `configureCompiler` path addition for cleaner variable names * Remove unnecessary build target from ExtraProgPathGlobal test command * Fix ExtraProgPathGlobal test failing on Mac/Unix for missing +x perms * Rename pr-10790 changelog to pr-10826 as it superceded * Add hashtag before PR/issue numbers in changelog for 10826 --------- Co-authored-by: Javier Sagredo <[email protected]> (cherry picked from commit 74601f4)

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

yutotakano changed the title ~~Append paths in global config to progdb in configureCompiler~~ Append paths in global config to progdb in configureCompiler v2 Mar 9, 2025

yutotakano force-pushed the yt/fix-paths-windows branch 2 times, most recently from 2e768df to d20122d Compare March 9, 2025 14:46

Mikolaj added the attention: needs-review label Mar 25, 2025

Mikolaj requested review from mpickering, jasagredo and Kleidukos March 25, 2025 16:22

yutotakano commented Mar 25, 2025

View reviewed changes

cabal-testsuite/PackageTests/ExtraProgPathGlobal/scripts-winpath/pkg-config Show resolved Hide resolved

jasagredo approved these changes Mar 25, 2025

View reviewed changes

Mikolaj added attention: needs-review and removed attention: needs-review labels Mar 28, 2025

Mikolaj approved these changes Mar 29, 2025

View reviewed changes

Mikolaj added the squash+merge me Tell Mergify Bot to squash-merge label Mar 29, 2025

mergify bot added the ready and waiting Mergify is waiting out the cooldown period label Mar 29, 2025

Mikolaj added the merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days label Mar 31, 2025

jasagredo and others added 3 commits March 31, 2025 08:06

Append paths in global config to progdb in configureCompiler

697a808

Refactor configureCompiler path addition for cleaner variable names

29c2498

yutotakano added 4 commits March 31, 2025 08:06

Remove unnecessary build target from ExtraProgPathGlobal test command

b112c7a

Fix ExtraProgPathGlobal test failing on Mac/Unix for missing +x perms

7c9ab29

Rename pr-10790 changelog to pr-10826 as it superceded

dacc3d7

Add hashtag before PR/issue numbers in changelog for 10826

860dfab

Mikolaj force-pushed the yt/fix-paths-windows branch from b54adb5 to 860dfab Compare March 31, 2025 08:06

Mikolaj added the attention: needs-backport 3.14 label Mar 31, 2025

mergify bot merged commit 74601f4 into haskell:master Mar 31, 2025
53 checks passed

mergify bot mentioned this pull request Mar 31, 2025

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

Merged

6 tasks

mergify bot added a commit that referenced this pull request Mar 31, 2025

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

4c9e315

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

Mikolaj removed the attention: needs-backport 3.14 label Mar 31, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

yutotakano commented Mar 9, 2025 •

edited

Loading

Mikolaj commented Mar 17, 2025

yutotakano commented Mar 17, 2025 •

edited

Loading

yutotakano commented Mar 25, 2025

Mikolaj commented Mar 25, 2025

jasagredo left a comment

ulysses4ever commented Mar 28, 2025

yutotakano commented Mar 28, 2025

ulysses4ever commented Mar 28, 2025

yutotakano commented Mar 28, 2025

Mikolaj left a comment

Mikolaj commented Mar 31, 2025

Mikolaj commented Mar 31, 2025

mergify bot commented Mar 31, 2025

Mikolaj commented Mar 31, 2025

mergify bot commented Mar 31, 2025

yutotakano commented Mar 31, 2025

Mikolaj commented Mar 31, 2025

Mikolaj commented Mar 31, 2025

mergify bot commented Mar 31, 2025 •

edited

Loading

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

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

Conversation

yutotakano commented Mar 9, 2025 • edited Loading

QA Notes

Mikolaj commented Mar 17, 2025

yutotakano commented Mar 17, 2025 • edited Loading

yutotakano commented Mar 25, 2025

Mikolaj commented Mar 25, 2025

jasagredo left a comment

Choose a reason for hiding this comment

ulysses4ever commented Mar 28, 2025

yutotakano commented Mar 28, 2025

ulysses4ever commented Mar 28, 2025

yutotakano commented Mar 28, 2025

Mikolaj left a comment

Choose a reason for hiding this comment

Mikolaj commented Mar 31, 2025

Mikolaj commented Mar 31, 2025

mergify bot commented Mar 31, 2025

Mikolaj commented Mar 31, 2025

mergify bot commented Mar 31, 2025

✅ Branch has been successfully rebased

yutotakano commented Mar 31, 2025

Mikolaj commented Mar 31, 2025

Mikolaj commented Mar 31, 2025

mergify bot commented Mar 31, 2025 • edited Loading

✅ Backports have been created

yutotakano commented Mar 9, 2025 •

edited

Loading

yutotakano commented Mar 17, 2025 •

edited

Loading

mergify bot commented Mar 31, 2025 •

edited

Loading