add indexer client unit tests #2000
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,43 +9,54 @@ import ( | |
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/ava-labs/avalanchego/database" | ||
| "github.com/ava-labs/avalanchego/ids" | ||
| "github.com/ava-labs/avalanchego/trace" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/ava-labs/hypersdk/api" | ||
| "github.com/ava-labs/hypersdk/chain" | ||
| "github.com/ava-labs/hypersdk/chain/chaintest" | ||
| "github.com/ava-labs/hypersdk/codec" | ||
| ) | ||
|
|
||
| func TestIndexerClientBlocks(t *testing.T) { | ||
| const ( | ||
| blockWindow = 2 | ||
| numTxs = 3 | ||
| ) | ||
|
|
||
| testCases := []struct { | ||
| name string | ||
| blkHeight uint64 | ||
| blkHeightErr error | ||
| numExecutedBlocks int | ||
| }{ | ||
| { | ||
| name: "success", | ||
| blkHeight: 3, | ||
| blkHeightErr: nil, | ||
| numExecutedBlocks: 4, | ||
| }, | ||
| { | ||
| name: "missing block", | ||
| blkHeight: 0, | ||
| blkHeightErr: errBlockNotFound, | ||
| numExecutedBlocks: 4, | ||
| }, | ||
| { | ||
| name: "no blocks", | ||
| blkHeight: 0, | ||
| blkHeightErr: errBlockNotFound, | ||
| numExecutedBlocks: 0, | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range testCases { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| r := require.New(t) | ||
| ctx := context.Background() | ||
| indexer, executedBlocks, _ := createTestIndexer(t, ctx, tt.numExecutedBlocks, blockWindow, numTxs) | ||
|
|
||
| jsonHandler, err := api.NewJSONRPCHandler(Name, NewServer(trace.Noop, indexer)) | ||
| r.NoError(err) | ||
|
|
@@ -59,26 +70,36 @@ func TestIndexerClientBlocks(t *testing.T) { | |
|
|
||
| client := NewClient(httpServer.URL) | ||
|
|
||
| executedBlock, err := client.GetBlockByHeight(ctx, tt.blkHeight, parser) | ||
| if tt.blkHeightErr == nil { | ||
|
There was a problem hiding this comment. Could we simplify this if-condition? I think it's sufficient to check that the errors are "equal" before invoking the if-condition rather than doing an if-else: r.ErrorIs(tt.blkHeightErr, err)
if tt.blkHeightErr == nil {
expectedBlock := executedBlocks[tt.blkHeight-1]
r.Equal(expectedBlock.Block, executedBlock.Block)
}There was a problem hiding this comment. Unfortunately, that won't work ( as is.. ). The returned error is an rpc error that contains a string representing the internal server error. Hence, we need to compare it by string ( We do have a PR to update this and create RPC specific error codes, which would resolve this issue (#1942) There was a problem hiding this comment. Ah understood, thanks for the clarification! |
||
| r.NoError(err) | ||
| expectedBlock := executedBlocks[tt.blkHeight-1] | ||
| r.Equal(expectedBlock.Block, executedBlock.Block) | ||
| } else { | ||
| r.ErrorContains(err, tt.blkHeightErr.Error()) | ||
| } | ||
|
|
||
| expectedBlkID := ids.Empty | ||
| if tt.blkHeight > 0 { | ||
| expectedBlock := executedBlocks[tt.blkHeight-1] | ||
| expectedBlkID = expectedBlock.Block.GetID() | ||
| } | ||
|
|
||
| executedBlock, err = client.GetBlock(ctx, expectedBlkID, parser) | ||
| if tt.blkHeightErr == nil { | ||
RodrigoVillar marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| r.NoError(err) | ||
| r.Equal(executedBlocks[tt.blkHeight-1].Block, executedBlock.Block) | ||
| } else { | ||
| r.ErrorContains(err, tt.blkHeightErr.Error()) | ||
| } | ||
|
|
||
| executedBlock, err = client.GetLatestBlock(ctx, parser) | ||
| if tt.numExecutedBlocks == 0 { | ||
| r.ErrorContains(err, database.ErrNotFound.Error()) | ||
|
Comment on lines
+97
to
+98
There was a problem hiding this comment. Handling the special case this way makes it seem like we default to not including the genesis. Could we include at least the genesis block (we should receive a notification of at least the genesis block on startup) There was a problem hiding this comment. this is not intended to cover the genesis block; it's really about covering the no-blocks-of-any-kind usecaswe. |
||
| } else { | ||
| r.NoError(err) | ||
| r.Equal(executedBlocks[tt.numExecutedBlocks-1].Block, executedBlock.Block) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
@@ -90,26 +111,61 @@ func TestIndexerClientTransactions(t *testing.T) { | |
| numTxs = 3 | ||
| ) | ||
|
|
||
| parser := chaintest.NewTestParser() | ||
| badParser := &chain.TxTypeParser{ | ||
| ActionRegistry: codec.NewTypeParser[chain.Action](), | ||
| AuthRegistry: codec.NewTypeParser[chain.Auth](), | ||
| } | ||
|
|
||
| testCases := []struct { | ||
| name string | ||
| blockIndex int | ||
| txIndex int | ||
| getTxResultsErr error | ||
| getTxErr error | ||
| found bool | ||
| parser *chain.TxTypeParser | ||
| malformedBlock bool | ||
| }{ | ||
| { | ||
| name: "success", | ||
| blockIndex: numExecutedBlocks - 1, | ||
| txIndex: 0, | ||
| found: true, | ||
| getTxResultsErr: nil, | ||
| getTxErr: nil, | ||
| parser: parser, | ||
| malformedBlock: false, | ||
| }, | ||
| { | ||
| name: "missing transaction", | ||
| blockIndex: 0, | ||
| txIndex: 0, | ||
| found: false, | ||
| getTxResultsErr: nil, | ||
| getTxErr: nil, | ||
| parser: parser, | ||
| malformedBlock: false, | ||
| }, | ||
| { | ||
| name: "badParser", | ||
| blockIndex: numExecutedBlocks - 1, | ||
| txIndex: numTxs - 1, | ||
| found: true, | ||
| getTxResultsErr: nil, | ||
| getTxErr: errTxUnmarshalingFailed, | ||
| parser: badParser, | ||
| malformedBlock: false, | ||
| }, | ||
| { | ||
| name: "malformed block", | ||
| blockIndex: numExecutedBlocks - 1, | ||
| txIndex: numTxs - 1, | ||
| found: false, | ||
| getTxResultsErr: errTxResultNotFound, | ||
| getTxErr: errTxResultNotFound, | ||
| parser: parser, | ||
| malformedBlock: true, | ||
| }, | ||
| } | ||
|
|
||
|
|
@@ -127,14 +183,24 @@ func TestIndexerClientTransactions(t *testing.T) { | |
| httpServer.Close() | ||
| }) | ||
|
|
||
| client := NewClient(httpServer.URL) | ||
|
|
||
| executedBlock := executedBlocks[tt.blockIndex] | ||
| executedTx := executedBlock.Block.Txs[tt.txIndex] | ||
|
|
||
| if tt.malformedBlock { | ||
| // create a malformed block and have the indexer add it. | ||
| // removing of the first result makes the length of the ExecutionResults differ from the | ||
| // transaction index within the block. | ||
| executedBlock.ExecutionResults.Results = executedBlock.ExecutionResults.Results[1:] | ||
| r.NoError(indexer.Notify(ctx, executedBlock)) | ||
| } | ||
|
|
||
| txResponse, found, err := client.GetTxResults(ctx, executedTx.GetID()) | ||
| if tt.getTxResultsErr != nil || err != nil { | ||
| r.ErrorContains(err, tt.getTxResultsErr.Error()) | ||
| } | ||
|
|
||
| r.Equal(tt.found, found) | ||
| if tt.found { | ||
| r.Equal(GetTxResponse{ | ||
|
|
@@ -144,17 +210,22 @@ func TestIndexerClientTransactions(t *testing.T) { | |
| }, txResponse) | ||
| } | ||
|
|
||
| txResponse, tx, found, err := client.GetTx(ctx, executedTx.GetID(), tt.parser) | ||
| if tt.getTxErr != nil || err != nil { | ||
| r.ErrorContains(err, tt.getTxErr.Error()) | ||
| return | ||
| } | ||
| r.Equal(tt.found, found) | ||
| if !tt.found { | ||
| return | ||
| } | ||
|
|
||
| r.Equal(GetTxResponse{ | ||
| TxBytes: executedTx.Bytes(), | ||
| Timestamp: executedBlock.Block.Tmstmp, | ||
| Result: executedBlock.ExecutionResults.Results[tt.txIndex], | ||
| }, txResponse) | ||
| r.Equal(executedTx, tx) | ||
| }) | ||
| } | ||
| } | ||
|
|
@@ -167,7 +238,7 @@ func TestIndexerClientWaitForTransaction(t *testing.T) { | |
| ) | ||
| r := require.New(t) | ||
| ctx := context.Background() | ||
| indexer, executedBlocks, _ := createTestIndexer(t, ctx, numExecutedBlocks, blockWindow, numTxs) | ||
|
|
||
| jsonHandler, err := api.NewJSONRPCHandler(Name, NewServer(trace.Noop, indexer)) | ||
| r.NoError(err) | ||
|
|
@@ -183,4 +254,13 @@ func TestIndexerClientWaitForTransaction(t *testing.T) { | |
| defer ctxCancel() | ||
| _, _, err = client.WaitForTransaction(timeoutCtx, 1*time.Millisecond, ids.GenerateTestID()) | ||
| r.ErrorIs(err, context.DeadlineExceeded) | ||
|
|
||
| // wait for a past transaction. | ||
| lastExecutedBlock := executedBlocks[numExecutedBlocks-1] | ||
| lastTx := lastExecutedBlock.Block.Txs[numTxs-1] | ||
| lastTxResult := lastExecutedBlock.ExecutionResults.Results[numTxs-1] | ||
| success, fee, err := client.WaitForTransaction(ctx, 1*time.Millisecond, lastTx.GetID()) | ||
| r.NoError(err) | ||
| r.Equal(lastTxResult.Success, success) | ||
| r.Equal(lastTxResult.Fee, fee) | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In production, we should be able to serve the genesis block, should we generate a sequence of blocks that includes a genesis block?