Configurable testutil's BeaconState #8407
Merged
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
rkapka
commented
Feb 8, 2021
Comment on lines
+14
to
+17
| BlockRoots: filledByteSlice2D(params.MainnetConfig().SlotsPerHistoricalRoot, 32), | ||
| StateRoots: filledByteSlice2D(params.MainnetConfig().SlotsPerHistoricalRoot, 32), | ||
| Slashings: make([]uint64, params.MainnetConfig().EpochsPerSlashingsVector), | ||
| RandaoMixes: filledByteSlice2D(params.MainnetConfig().EpochsPerHistoricalVector, 32), |
There was a problem hiding this comment.
This changed from BeaconConfig to MainnetConfig. This is because minimal values cannot be encoded properly when saving to the database (I guess it's an ssz thing). If other values are really required, they can be passed in through ...options.
rauljordan
approved these changes
Feb 8, 2021
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.
What type of PR is this?
Testing
What does this PR do? Why is it needed?
Using
NewBeaconStatefromshared/testutilis very unwelcoming when one wants to work with a state with non-default values. This is because each call toNewBeaconStateinitializes a new state from package-level "seed" data. Changing the seed data inside one test breaks other tests. This is bad as tests are not isolated from each other.This PR decouples tests by creating new seed data every time
NewBeaconStateis called. The function allows passing one or more options which modify the desired state.Which issues(s) does this PR fix?
Part of #7510. This PR is a prerequisite for some API unit tests.
Other notes for review
Main file to look at:
shared/testutil/state.go. The...optionsargument idea comes from https://dave.cheney.net/2014/10/17/functional-options-for-friendly-apis. The main benefit is not having to declare a big config object and passnilvalues everywhere where the default is sufficient (meaning everywhere at this point).Example usage: