This repository was archived by the owner on Aug 18, 2020. It is now read-only.
{DO NOT MERGE} [CDEC-512] Create JSON round-trip and golden tests for GenesisData, GenesisProtocolConstants, and GenesisConfiguration #3458
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
intricate
force-pushed
the
intricate/CDEC-512
branch
4 times, most recently
from
58f2229 to
88198d6
Compare
Jimbo4350
suggested changes
Aug 23, 2018
| @@ -38,6 +43,35 @@ goldenTestJSON x path = withFrozenCallStack $ do | |||
| Left err -> failWith Nothing $ "could not decode: " <> show err | |||
| Right x' -> x === x' | |||
|
|
|||
| -- | Only check that the datatype equals the decoding of the file | |||
There was a problem hiding this comment.
Shouldn't we also be checking the encoding?
#3415
There was a problem hiding this comment.
The reason for these functions is to ensure backwards compatibility with existing serialized datatstructures, with default values for missing fields. We want to demonstrate that when the PR is merged, the tests for “deserialize this bytestring and check that the value is equal to a target value” still pass (once the given datatype is modified, in the source code, to have the default value in the newly added record field)
| => a | ||
| -> FilePath | ||
| -> Property | ||
| goldenTestCanonicalJSONDec x path = withFrozenCallStack $ do |
There was a problem hiding this comment.
See above comment. These should be used sparingly, only to ensure backwards compatibility.
The To/FromJSON instances for Microsecond store the value as an integer denoting the # of Seconds. So they are rounded to the nearest 10^6.
Luke hit some weird type errors and I got them to go away by adding a type signature. This commit uses `roundTripsCanonicalJSONShow` to test `GenesisData`.
intricate
force-pushed
the
intricate/CDEC-512
branch
from
88198d6 to
6ef8619
Compare
Jimbo4350
previously approved these changes
Aug 23, 2018
Jimbo4350
dismissed
their stale review
Conflicting files on present on this branch.
parsonsmatt
approved these changes
Aug 24, 2018
mhuesch
changed the title
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
We have to create and expand upon existing round-trip and golden tests for the aforementioned data types in order to ensure that the upcoming implementation of CO-354 doesn't break configuration backwards compatibility.
Linked issue
https://iohk.myjetbrains.com/youtrack/issue/CDEC-512
Type of change
Developer checklist
Testing checklist
QA Steps
Screenshots (if available)