Catch exception if git is not installed #10486

noiioiu · 2024-10-28T21:04:56Z

This is a trivial pr that should fix a bug in cabal init when git is not installed.

Patches conform to the coding conventions.
Any changes that could be relevant to users have been recorded in the changelog.
The documentation has been updated, if necessary.
Manual QA notes have been included.
Tests have been added.

QA Notes

cabal init should work correctly even if git is not installed. This can be tested by running the following commands in an empty directory and answering the prompts:

mkdir /tmp/bin
ln -s "$(which ghc)" "$(which cabal)" /tmp/bin/
PATH=/tmp/bin/ cabal init

geekosaur · 2024-10-28T21:10:15Z

Could you fill out one of the templates, please? I don't think this needs a changelog fragment, though.

ffaf1 · 2024-10-28T21:12:08Z

I wonder if there is a way to test this automatically (if not, just user testing will do).

geekosaur · 2024-10-28T21:14:39Z

Yes, I think for this one we want (very simple) manual QA notes. I wouldn't trust trying to hide or remove git from a runner environment.

noiioiu · 2024-10-28T21:16:17Z

Could you fill out one of the templates, please? I don't think this needs a changelog fragment, though.

Yes, do you have a link to the templates? I can't find them.

geekosaur · 2024-10-28T21:17:34Z

https://github.com/haskell/cabal/blob/master/.github/pull_request_template.md

geekosaur · 2024-10-28T21:21:50Z

Hm, building is failing https://github.com/haskell/cabal/actions/runs/11562678296/job/32184393856?pr=10486#step:6:1363

geekosaur · 2024-10-28T21:40:53Z

That's not going to work because m isn't guaranteed to have access to Exception (cabal init -n doesn't). I think you will have to arrange to run something like "sh", ["-c", "git … || exit 0"] and deal with the output being empty.

noiioiu · 2024-10-28T21:52:05Z

Right, I don't think it's possible to define a MonadCatch instance for PurePrompt.

ulysses4ever · 2024-10-31T00:29:23Z

Yes, I think for this one we want (very simple) manual QA notes. I wouldn't trust trying to hide or remove git from a runner environment.

Why not? It should be as simple as the description of this PR shows: "simply" resetting the PATH. I think the testsuite might have a combinator for manipulating PATH.

I don't want to block it for this reason, but having a regression test would be very valuable in this case.

noiioiu · 2024-10-31T01:23:42Z

Added tests to the checklist. I'm not sure how or where to add the test though.

ulysses4ever

Thanks for reporting and taking this on!

An integration test manipulating PATH can be found here: https://github.com/haskell/cabal/blob/63c486a1a65de599fa435c0cbf11ad85725f3c6c/cabal-testsuite/PackageTests/BuildTools/Foreign/setup.test.hs

General setup for integration tests is described here: https://github.com/haskell/cabal/blob/63c486a1a65de599fa435c0cbf11ad85725f3c6c/cabal-testsuite/README.md

Good luck!

cabal-install/src/Distribution/Client/Init/Types.hs

geekosaur · 2024-10-31T01:28:05Z

My worry with $PATH is that, on Linux at least, the part that needs to be removed is /usr/bin.

ulysses4ever · 2024-10-31T01:30:14Z

@geekosaur that's fair. Since it's very local (ideally, just for a single test), it might work.

ulysses4ever

Brilliant!

Have you tried to run the test without your patch? That would be a good sanity check to see that it fails since it's a somewhat non-trivial test.

noiioiu · 2024-10-31T15:14:21Z

Brilliant!

Have you tried to run the test without your patch? That would be a good sanity check to see that it fails since it's a somewhat non-trivial test.

I ran it without the patch on a different branch (forked from 3.10) since I couldn't build master on my computer. It failed with the posix_spawnp error.

geekosaur · 2024-10-31T15:16:07Z

since I couldn't build master on my computer.

Uh, what happened? Is this something likely to affect other people?

ulysses4ever · 2024-10-31T15:29:42Z

I assume the posix_spawn is what we expect to see without the patch (as reported in #10484) --- that's great!

While failing to build master is concerning, it shouldn't block the current patch. Please feel free to open a new issue explaining the trouble with master.

Kleidukos · 2024-10-31T15:32:54Z

Assigning myself for manual QA once this lands on master

noiioiu · 2024-10-31T15:39:03Z

since I couldn't build master on my computer.

Uh, what happened? Is this something likely to affect other people?

I think it might be because I was using cabal 3.10.3.0.

I assume the posix_spawn is what we expect to see without the patch (as reported in #10484) --- that's great!

Yes, it's the same error.

geekosaur · 2024-10-31T15:47:07Z

Older cabal-install should be able to install newer ones, so that sounds like a bug. Please file a new issue including as many details about what you did and what happened as you can.

ulysses4ever · 2024-11-06T03:34:15Z

@mergify backport 3.14

mergify · 2024-11-06T03:34:24Z

backport 3.14

✅ Backports have been created

#10531 Backport #10486: Catch exception if git is not installed has been created for branch 3.14

* Catch exception if git is not installed * fix formatting * change type from IO to m * add maybeReadProcessWithExitCode * use maybeReadProcessWithExitCode * disambiguate P.catch * add TypeApplications pragma * add missing arguments * Add changelog entry * Add test for `cabal init` when `git` is not installed * Remove withSourceCopyDir from test * Remove withSourceCopyDir from test * Remove configure and build from test * Remove assert * Skip test on windows --------- Co-authored-by: noiioiu <[email protected]> (cherry picked from commit e7bc62b)

Backport #10486: Catch exception if git is not installed

geekosaur · 2024-11-06T16:29:27Z

@mergify backport 3.12

mergify · 2024-11-06T16:29:33Z

backport 3.12

✅ Backports have been created

#10533 Backport #10486: Catch exception if git is not installed has been created for branch 3.12 but encountered conflicts

* Catch exception if git is not installed * fix formatting * change type from IO to m * add maybeReadProcessWithExitCode * use maybeReadProcessWithExitCode * disambiguate P.catch * add TypeApplications pragma * add missing arguments * Add changelog entry * Add test for `cabal init` when `git` is not installed * Remove withSourceCopyDir from test * Remove withSourceCopyDir from test * Remove configure and build from test * Remove assert * Skip test on windows --------- Co-authored-by: noiioiu <[email protected]> (cherry picked from commit e7bc62b) # Conflicts: # cabal-install/src/Distribution/Client/Init/Types.hs

noiioiu added 2 commits October 28, 2024 16:02

Catch exception if git is not installed

f54b807

fix formatting

cbfae50

noiioiu mentioned this pull request Oct 28, 2024

cabal init crashes if git is not installed #10484

Closed

change type from IO to m

e7b20d0

noiioiu added 5 commits October 28, 2024 17:10

add maybeReadProcessWithExitCode

3838dfa

use maybeReadProcessWithExitCode

121be52

disambiguate P.catch

a4953f4

add TypeApplications pragma

fe8cb2a

add missing arguments

0689e02

noiioiu marked this pull request as ready for review October 29, 2024 04:08

Add changelog entry

3797793

ulysses4ever linked an issue Oct 31, 2024 that may be closed by this pull request

cabal init crashes if git is not installed #10484

Closed

ulysses4ever requested changes Oct 31, 2024

View reviewed changes

cabal-install/src/Distribution/Client/Init/Types.hs Show resolved Hide resolved

noiioiu added 5 commits October 30, 2024 23:11

Add test for cabal init when git is not installed

7af9628

Merge remote-tracking branch 'origin/master' into fix-git-bug

bee43d4

Remove withSourceCopyDir from test

032f5b1

Remove withSourceCopyDir from test

380aa65

Remove configure and build from test

c5e22b9

noiioiu added 2 commits October 31, 2024 01:36

Remove assert

84cdecf

Skip test on windows

7f17904

noiioiu requested a review from ulysses4ever October 31, 2024 11:32

ulysses4ever approved these changes Oct 31, 2024

View reviewed changes

ulysses4ever added attention: needs-review cabal-install: cmd/init labels Oct 31, 2024

geekosaur approved these changes Oct 31, 2024

View reviewed changes

Kleidukos added the attention: needs-manual-qa PR is destined for manual QA label Oct 31, 2024

Kleidukos self-assigned this Oct 31, 2024

ulysses4ever removed the attention: needs-review label Oct 31, 2024

ulysses4ever added the squash+merge me Tell Mergify Bot to squash-merge label Nov 2, 2024

mergify bot added ready and waiting Mergify is waiting out the cooldown period merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days labels Nov 2, 2024

Merge branch 'master' into fix-git-bug

f38858a

mergify bot merged commit e7bc62b into haskell:master Nov 6, 2024
42 checks passed

ulysses4ever added the attention: needs-backport 3.14 label Nov 6, 2024

mergify bot added a commit that referenced this pull request Nov 6, 2024

Merge pull request #10531 from haskell/mergify/bp/3.14/pr-10486

cc3ccda

Backport #10486: Catch exception if git is not installed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Catch exception if git is not installed #10486

Catch exception if git is not installed #10486

noiioiu commented Oct 28, 2024 •

edited

Loading

geekosaur commented Oct 28, 2024

ffaf1 commented Oct 28, 2024

geekosaur commented Oct 28, 2024 •

edited

Loading

noiioiu commented Oct 28, 2024 •

edited

Loading

geekosaur commented Oct 28, 2024

geekosaur commented Oct 28, 2024

geekosaur commented Oct 28, 2024

noiioiu commented Oct 28, 2024 •

edited

Loading

ulysses4ever commented Oct 31, 2024

noiioiu commented Oct 31, 2024

ulysses4ever left a comment

geekosaur commented Oct 31, 2024

ulysses4ever commented Oct 31, 2024

ulysses4ever left a comment

noiioiu commented Oct 31, 2024

geekosaur commented Oct 31, 2024

ulysses4ever commented Oct 31, 2024

Kleidukos commented Oct 31, 2024

noiioiu commented Oct 31, 2024

geekosaur commented Oct 31, 2024

ulysses4ever commented Nov 6, 2024

mergify bot commented Nov 6, 2024 •

edited

Loading

geekosaur commented Nov 6, 2024

mergify bot commented Nov 6, 2024 •

edited

Loading

Catch exception if git is not installed #10486

Catch exception if git is not installed #10486

Conversation

noiioiu commented Oct 28, 2024 • edited Loading

QA Notes

geekosaur commented Oct 28, 2024

ffaf1 commented Oct 28, 2024

geekosaur commented Oct 28, 2024 • edited Loading

noiioiu commented Oct 28, 2024 • edited Loading

geekosaur commented Oct 28, 2024

geekosaur commented Oct 28, 2024

geekosaur commented Oct 28, 2024

noiioiu commented Oct 28, 2024 • edited Loading

ulysses4ever commented Oct 31, 2024

noiioiu commented Oct 31, 2024

ulysses4ever left a comment

Choose a reason for hiding this comment

geekosaur commented Oct 31, 2024

ulysses4ever commented Oct 31, 2024

ulysses4ever left a comment

Choose a reason for hiding this comment

noiioiu commented Oct 31, 2024

geekosaur commented Oct 31, 2024

ulysses4ever commented Oct 31, 2024

Kleidukos commented Oct 31, 2024

noiioiu commented Oct 31, 2024

geekosaur commented Oct 31, 2024

ulysses4ever commented Nov 6, 2024

mergify bot commented Nov 6, 2024 • edited Loading

✅ Backports have been created

geekosaur commented Nov 6, 2024

mergify bot commented Nov 6, 2024 • edited Loading

✅ Backports have been created

noiioiu commented Oct 28, 2024 •

edited

Loading

geekosaur commented Oct 28, 2024 •

edited

Loading

noiioiu commented Oct 28, 2024 •

edited

Loading

noiioiu commented Oct 28, 2024 •

edited

Loading

mergify bot commented Nov 6, 2024 •

edited

Loading

mergify bot commented Nov 6, 2024 •

edited

Loading