reporter: refactor reporter, datagen and fuzz tests on block handlers #95
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
vitsalis
approved these changes
Nov 1, 2022
reporter/utils_test.go
Outdated
| return mockBTCClient, mockBabylonClient, reporter | ||
| } | ||
|
|
||
| // FuzzProcessHeaders is a fuzz tests for ProcessHeaders() |
There was a problem hiding this comment.
Suggested change
| // FuzzProcessHeaders is a fuzz tests for ProcessHeaders() | |
| // FuzzProcessHeaders fuzz tests ProcessHeaders() |
| } | ||
|
|
||
| // FuzzProcessHeaders is a fuzz tests for ProcessHeaders() | ||
| // - Data: a number of random blocks, with or without Babylon txs |
There was a problem hiding this comment.
This test case seems to test the submission of only one block. We should also test this with multiple blocks. To make this realistic, once a block does not exist then all of its descendants won't exist as well. So we can do:
- Randomly identify the total number of blocks and generate them.
- Randomly identify the number of those blocks that exist on Babylon. Can be [0, N], where N is the total number of blocks. The first set of headers up to this number exist on Babylon, the rest do not.
- Verify that only the required headers were submitted.
reporter/utils_test.go
Outdated
| }) | ||
| } | ||
|
|
||
| // FuzzProcessCheckpoints is a fuzz tests for ProcessCheckpoints() |
There was a problem hiding this comment.
Suggested change
| // FuzzProcessCheckpoints is a fuzz tests for ProcessCheckpoints() | |
| // FuzzProcessCheckpoints fuzz tests ProcessCheckpoints() |
reporter/utils_test.go
Outdated
| mockBabylonClient.EXPECT().MustInsertBTCSpvProof(gomock.Any()).Return(&sdk.TxResponse{Code: 0}).AnyTimes() | ||
|
|
||
| containsCkpt := datagen.OneInN(2) | ||
| containsCkpt = true |
There was a problem hiding this comment.
My bad, it was from a debugging attempt. Good catch!
| } | ||
|
|
||
| // FuzzProcessCheckpoints is a fuzz tests for ProcessCheckpoints() | ||
| // - Data: a number of random blocks, with or without Babylon txs |
There was a problem hiding this comment.
This tests only a single block.
reporter/utils_test.go
Outdated
|
|
||
| containsCkpt := datagen.OneInN(2) | ||
| containsCkpt = true | ||
| block, _ := vdatagen.GenRandomBlock(containsCkpt, nil) |
There was a problem hiding this comment.
What happens if this only contains one half of the checkpoint? Maybe we should test for this case as well.
| @@ -68,6 +68,40 @@ func GenRandomTx() *wire.MsgTx { | |||
| return tx | |||
| } | |||
|
|
|||
| func GenRandomBabylonTxPair() ([]*wire.MsgTx, *btctxformatter.RawBtcCheckpoint) { | |||
SebastianElvis
changed the title
ProcessHeaders
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.
Partially fixes BM-156
This PR aims at implementing fuzz tests for reporter's
ProcessHeadersfunction. Along the way, it does some refactoring for mocking the reporter. Specifically, this PRReporterGenRandomBlockchainWithBabylonTxthat generates a blockchain in which blocks may contain some Babylon txsProcessHeaders, where given a block that may or may not be duplicated on Babylon BTCLightclient, check whether the reporter does the deduplication correctly or not.ProcessCheckpoints, where given a block that may or may not contain a pair of Babylon txs, check whether the reporter extracts correct checkpoint segments and matches checkpoint segments correctly.