Per-field GenericPackageDescription golden test
#11285
Open
+23,448
−23,495
Conversation
This file contains hidden or 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
Bodigrim
reviewed
Nov 13, 2025
Cabal-tests/tests/ParserTests.hs
Outdated
| import Distribution.PackageDescription (GenericPackageDescription) | ||
| import Distribution.PackageDescription | ||
| ( GenericPackageDescription | ||
| ( packageDescription |
Collaborator
There was a problem hiding this comment.
In general it's more robust to import Distribution.PackageDescription (GenericPackageDescription, fooField, bazField) than import Distribution.PackageDescription (GenericPackageDescription (fooField, bazField)). If in future the fields of GPD are changed and old accessors become simple functions (retained for backwards compatibility), the first form survives without a change, while the second would have to be amended.
Author
There was a problem hiding this comment.
I didn't know this is possible, I'll change this :)
Cabal-tests/tests/ParserTests.hs
Outdated
| let y' = y | ||
|
|
||
| let checkField field = | ||
| unless (field x == field y) $ |
Collaborator
There was a problem hiding this comment.
While at it, could you possible use (@?) or assertBool instead of raw assertFailure?
6 tasks
leana8959
changed the title
GenericPackageDescription golden test
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
We are making changes to the internal representation of
GenericPackageDescriptionin #11277 in order to retain common stanzas. Our current approach with the common stanza retention is done by adding aMap ImportName (CondTree ConfVar [Dependency] BuildInfo)intoGenericPackageDescription, and merging on demand withPatternSynonymsaccessors.The current golden test test suite doesn't handle this change well — we have one single golden file per
GenericPackageDescriptiondata. Adding fields to this data type creates huge amount of diffs, making bugs harder to spot for both me and the reviewers.To get out of this diff hell, we have split the golden tests of
GenericPackageDescriptionto write eachGenericPackageDescriptionfield into its own file. This way, we can quickly identify which behaviour has changed and for which file. New fields will simply be in new files.This is a separate PR because the diff is very big, which is caused by the golden test files changes. After merging this, #11277's diff would roughly drop from 24kloc to 1.8kloc. This would make the actual behaviour changes more reviewable.
This PR does not modify behaviour or interface
E.g. the PR only touches documentation or tests, does refactorings, etc.
Include the following checklist in your PR: