Add end marker

This commit is contained in:
Bhargava Shastry 2025-10-06 09:59:38 +02:00
parent 2dfae90ccb
commit 94b4de0319
2 changed files with 67 additions and 2 deletions

View file

@ -25,8 +25,10 @@ import (
"regexp"
"slices"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/core"
"github.com/ethereum/go-ethereum/core/rawdb"
"github.com/ethereum/go-ethereum/log"
"github.com/ethereum/go-ethereum/tests"
"github.com/urfave/cli/v2"
)
@ -79,6 +81,42 @@ func blockTestCmd(ctx *cli.Context) error {
return nil
}
// blocktestEndMarker represents the final status of a blocktest execution.
// It is written as the last line of trace output in JSONL format (single-line JSON).
type blocktestEndMarker struct {
TestEnd blocktestEndDetails `json:"testEnd"`
}
type blocktestEndDetails struct {
Name string `json:"name"`
Pass bool `json:"pass"`
Fork string `json:"fork,omitempty"`
Root string `json:"root,omitempty"`
Error string `json:"error,omitempty"`
V int `json:"v"` // Version: 1
}
// writeEndMarker writes the blocktest end marker to stderr in JSONL format.
// This marker indicates the final outcome of the test as a single-line JSON object.
func writeEndMarker(result *testResult, fork string, root *common.Hash) {
details := blocktestEndDetails{
Name: result.Name,
Pass: result.Pass,
Fork: fork,
V: 1,
}
if !result.Pass && result.Error != "" {
details.Error = result.Error
}
if root != nil {
details.Root = root.Hex()
}
marker := blocktestEndMarker{TestEnd: details}
if data, err := json.Marshal(marker); err == nil {
fmt.Fprintf(os.Stderr, "%s\n", data)
}
}
func runBlockTest(ctx *cli.Context, fname string) ([]testResult, error) {
src, err := os.ReadFile(fname)
if err != nil {
@ -94,6 +132,11 @@ func runBlockTest(ctx *cli.Context, fname string) ([]testResult, error) {
}
tracer := tracerFromFlags(ctx)
// Suppress INFO logs when tracing to avoid polluting stderr
if tracer != nil {
log.SetDefault(log.NewLogger(log.DiscardHandler()))
}
// Pull out keys to sort and ensure tests are run in order.
keys := slices.Sorted(maps.Keys(tests))
@ -103,17 +146,30 @@ func runBlockTest(ctx *cli.Context, fname string) ([]testResult, error) {
if !re.MatchString(name) {
continue
}
test := tests[name]
result := &testResult{Name: name, Pass: true}
if err := tests[name].Run(false, rawdb.PathScheme, ctx.Bool(WitnessCrossCheckFlag.Name), tracer, func(res error, chain *core.BlockChain) {
var finalRoot *common.Hash
if err := test.Run(false, rawdb.PathScheme, ctx.Bool(WitnessCrossCheckFlag.Name), tracer, func(res error, chain *core.BlockChain) {
if ctx.Bool(DumpFlag.Name) {
if s, _ := chain.State(); s != nil {
result.State = dump(s)
}
}
// Capture final state root for end marker
if chain != nil {
root := chain.CurrentBlock().Root
finalRoot = &root
}
}); err != nil {
result.Pass, result.Error = false, err.Error()
}
results = append(results, *result)
// Write end marker when tracing is enabled
if tracer != nil {
fork := test.Network()
writeEndMarker(result, fork, finalRoot)
}
}
return results, nil
}

View file

@ -116,6 +116,15 @@ func (t *BlockTest) Run(snapshotter bool, scheme string, witness bool, tracer *t
if !ok {
return UnsupportedForkError{t.json.Network}
}
return t.run(config, snapshotter, scheme, witness, tracer, postCheck)
}
// Network returns the network/fork name for this test.
func (t *BlockTest) Network() string {
return t.json.Network
}
func (t *BlockTest) run(config *params.ChainConfig, snapshotter bool, scheme string, witness bool, tracer *tracing.Hooks, postCheck func(error, *core.BlockChain)) (result error) {
// import pre accounts & construct test genesis block & state root
var (
db = rawdb.NewMemoryDatabase()
@ -259,7 +268,7 @@ func (t *BlockTest) insertBlocks(blockchain *core.BlockChain) ([]btBlock, error)
}
if b.BlockHeader == nil {
if data, err := json.MarshalIndent(cb.Header(), "", " "); err == nil {
fmt.Fprintf(os.Stderr, "block (index %d) insertion should have failed due to: %v:\n%v\n",
fmt.Fprintf(os.Stdout, "block (index %d) insertion should have failed due to: %v:\n%v\n",
bi, b.ExpectException, string(data))
}
return nil, fmt.Errorf("block (index %d) insertion should have failed due to: %v",