callCabal2nix: detect invalid names and print a good error #119123
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A friend used an invalid haskell package name, which resulted in a very
bad error message from callCabal2nix, on account of them calling
`cabal init` from their project directory, `bad_name`, which generated a
`bad-name.cabal` file. They didn't notice and did something like
`callCabal2nix "bad_name" ./. {};` in their overlay, generating an
*atrocious* error message on the file not existing:
```
building '/nix/store/00000000000000000000000000000000-cabal2nix-bad_name.drv'...
installing
cabal2nix: nix-prefetch-url: createProcess: runInteractiveProcess: exec: does not exist (No such file or directory)
builder for '/nix/store/00000000000000000000000000000000-cabal2nix-bad_name.drv' failed with exit code 1
error: build of '/nix/store/00000000000000000000000000000000-cabal2nix-bad_name.drv' failed
```
We can and should detect this and throw an assertion explaining what
went wrong on our side.
|
Related, NixOS/cabal2nix#472 But we should stop this happening at all because it could probably allow further frustrating to debug breakages if we allow bad names. |
|
I'd prefer to resolve this in |
11 tasks
|
Fixed by NixOS/cabal2nix#489. Hoping to have a |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation for this change
A friend used an invalid haskell package name, which resulted in a very
bad error message from callCabal2nix, on account of them calling
cabal initfrom their project directory,bad_name, which generated abad-name.cabalfile. They didn't notice and did something likecallCabal2nix "bad_name" ./. {};in their overlay, generating anatrocious error message on the file not existing:
We can and should detect this and throw an assertion explaining what
went wrong on our side.
Things done
sandboxinnix.confon non-NixOS linux)nix-shell -p nixpkgs-review --run "nixpkgs-review wip"./result/bin/)nix path-info -Sbefore and after)