Improve "Cannot read .cabal file inside ..." errors #10647
Draft
+120
−29
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
geekosaur
requested changes
Dec 18, 2024
This error message was very confusing -- it doesn't tell you what `.cabal` file it's looking for or why it cannot read the `.cabal` file. (Did it fail to parse the `.tar` archive itself? Did parsing the `.cabal` file fail? If so, why?) This patch improves the error message to include the name of the `.cabal` file being searched for. Additionally, parse errors and warnings are printed, as are format failures in the tarball itself. I ran into this error while I was writing tests for Cabal and it confused the hell out of me; this is an expanded version of the changes I made to help debug that failure.
9999years
force-pushed
the
improve-tar-errors
branch
from
e7e04d9 to
35917bf
Compare
9999years
commented
Dec 18, 2024
| @@ -1615,7 +1616,7 @@ readSourcePackageCabalFile verbosity pkgfilename content = | |||
| case runParseResult (parseGenericPackageDescription content) of | |||
| (warnings, Right pkg) -> do | |||
| unless (null warnings) $ | |||
| info verbosity (formatWarnings warnings) | |||
| warn verbosity (formatWarnings warnings) | |||
There was a problem hiding this comment.
Does anyone know why this wasn't warn already?
9999years
commented
Dec 18, 2024
| assertFailure $ "unexpected: " ++ needle | ||
| where output = resultOutput result | ||
|
|
||
| assertOutputMatches :: MonadIO m => WithCallStack (String -> Result -> m ()) |
There was a problem hiding this comment.
Added a couple test helpers.
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.
This error message was very confusing -- it doesn't tell you what
.cabalfile it's looking for or why it cannot read the.cabalfile. (Did it fail to parse the.tararchive itself? Did parsing the.cabalfile fail? If so, why?)This patch improves the error message to include the name of the
.cabalfile being searched for. Additionally, parse errors and warnings are printed, as are format failures in the tarball itself.I ran into this error while I was writing tests for Cabal and it confused the hell out of me; this is an expanded version of the changes I made to help debug that failure.
changelog.d/pr-YOUR_PR_NUMBERbaseand third-party library imports use qualified imports or explicit import lists