Tweak Blocks Generator + Moar Tests + Better Coverage #50
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
By looking at the code coverage reports, I noticed that some parts of the code were left untested, which was weird because they should be part be when looking at the propery. Yet, I noticed we use 'Int' (n <- arbitrary) as the number of blocks to generate. Int is unsigned and therefore, doing 'take n' with n < 0 boils down to doing 'take 0'. As a consequence, our generators was very often generating empty list of blocks, and, in the remaining cases, didn't always generate sequences of blocks that would trigger certain parts of the tickingFunction. That is now fixed, and coverage constraints has been added to make sure of that
… bit imports in BlockSyncerSpec
| @@ -114,7 +117,7 @@ newtype Blocks = Blocks [[Block]] | |||
| instance Arbitrary Blocks where | |||
| -- No Shrinking | |||
| arbitrary = do | |||
| n <- arbitrary | |||
| n <- fromIntegral . (`mod` 42) <$> arbitrary @Word8 | |||
There was a problem hiding this comment.
To have a hard max bound. It's not more useful to generate list of 255 blocks than 42 blocks in practice. We aren't benchmarking anything here, so, we want the list to be big enough to generate enough entropy in the blocks groups, but not too big to not take 5 minutes to run.
42 turned out to be a good enough value :)
There was a problem hiding this comment.
sounds reasonable. thanks for the explanation 👍
paweljakubas
approved these changes
Mar 12, 2019
3 tasks
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.
Issue Number
#3
Overview
Comments
By looking at the code coverage reports, I noticed that some parts of the code were left
untested, which was weird because they should be when looking at the property.
Yet, I noticed we use 'Int' (n <- arbitrary) as the number of blocks to generate. Int
is unsigned and therefore, doing 'take n' with n < 0 boils down to doing 'take 0'. As
a consequence, our generators was very often generating empty list of blocks, and, in
the remaining cases, didn't always generate sequences of blocks that would trigger
certain parts of the tickingFunction. That is now fixed, and coverage constraints has
been added to make sure of that: