Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add test flags and clear cache between tests to fix deterministic failures. #124

Merged
merged 4 commits into from
Sep 23, 2023
Merged

Add test flags and clear cache between tests to fix deterministic failures. #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
148094c
tests: Allow specifying a tracer test with -file.
tyler-smith Sep 23, 2023
ed33548
tests: Allow setting log level in tracer tests.
tyler-smith Sep 23, 2023
1fd5854
tests: Cleanup tracer test failure output.
tyler-smith Sep 23, 2023
17941a5
tests,fix: Clear decoder cache between tests.
tyler-smith Sep 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions eth/tracers/blocknative/tracer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,12 @@ func finalizeCallFrame(call *CallFrame, output []byte, gasUsed uint64, err error
call.Output = bytesToHex(output)
}

// EmptyCache is for testing purposes. It clears the global cache so tests don't
// interfere with each other.
func EmptyCache() {
decoderCache = decoder.NewCaches()
}

//
// Unused interface methods.
//
Expand Down
78 changes: 59 additions & 19 deletions eth/tracers/internal/tracetest/blocknative_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package tracetest

import (
"encoding/json"
"flag"
"fmt"
"math/big"
"os"
Expand All @@ -23,6 +24,16 @@ import (
"github.com/ethereum/go-ethereum/tests"
)

var (
testFlagLogLevl = flag.String("loglevel", "info", "Log level to use")
testFlagFile = flag.String("file", "", "Name of the file to run the test for")
)

func TestMain(m *testing.M) {
flag.Parse()
os.Exit(m.Run())
}

type blocknativeTracerTest struct {
Genesis *core.Genesis `json:"genesis"`
Context *callContext `json:"context"`
Expand All @@ -43,9 +54,30 @@ type blocknativeTracerTest struct {
}

func TestBlocknativeTracer(t *testing.T) {
log.Root().SetHandler(log.StreamHandler(os.Stdout, log.TerminalFormat(true)))
testBlocknativeTracer("blocknative", t)
testBlocknativeTracer("blocknative/with_decoding", t)
setLogging(t)

testsCases, err := loadTestTxs("blocknative")
if err != nil {
t.Fatal(err)
}
decodingTestsCases, err := loadTestTxs("blocknative/with_decoding")
if err != nil {
t.Fatal(err)
}
testsCases = append(testsCases, decodingTestsCases...)

for _, test := range testsCases {
if *testFlagFile != "" {
a := strings.ToLower(*testFlagFile)
b := strings.ToLower(test.name)
if a != b {
continue
}
}
t.Run(test.name, func(t *testing.T) {
executeTestCase(test, t, true)
})
}
}

func BenchmarkBlocknativeTracerWithoutDecoding(b *testing.B) {
Expand Down Expand Up @@ -139,17 +171,17 @@ func benchmarkBlocknativeTracer(b *testing.B, decode bool, dirPaths ...string) {
}
}

func testBlocknativeTracer(dirPath string, t *testing.T) {
testsCases, err := loadTestTxs(dirPath)
if err != nil {
t.Fatal(err)
}

for _, test := range testsCases {
t.Run(test.name, func(t *testing.T) {
executeTestCase(test, t, true)
})
func setLogging(t testing.TB) {
logHandler := log.StreamHandler(os.Stdout, log.TerminalFormat(true))
level := log.LvlDebug
if *testFlagLogLevl != "" {
var err error
level, err = log.LvlFromString(*testFlagLogLevl)
if err != nil {
t.Fatal(err)
}
}
log.Root().SetHandler(log.LvlFilterHandler(level, logHandler))
}

func loadTestTxs(dirPath string) ([]*blocknativeTracerTest, error) {
Expand Down Expand Up @@ -213,7 +245,14 @@ func loadTestTxs(dirPath string) ([]*blocknativeTracerTest, error) {
return nil, err
}

test.name = camel(strings.TrimSuffix(file.Name(), ".json"))
name := strings.TrimPrefix(dirPath, "blocknative")
name = strings.TrimPrefix(name, "/")
if name != "" {
name = name + "/"
}
name = name + camel(strings.TrimSuffix(file.Name(), ".json"))

test.name = name
test.evm = evm
test.tx = tx
test.msg = msg
Expand All @@ -225,6 +264,8 @@ func loadTestTxs(dirPath string) ([]*blocknativeTracerTest, error) {
}

func executeTestCase(test *blocknativeTracerTest, t testing.TB, checkResult bool) {
blocknative.EmptyCache()

st := core.NewStateTransition(test.evm, test.msg, new(core.GasPool).AddGas(test.tx.Gas()))
if _, err := st.TransitionDb(); err != nil {
t.Fatalf("failed to execute transaction: %v", err)
Expand All @@ -241,15 +282,14 @@ func executeTestCase(test *blocknativeTracerTest, t testing.TB, checkResult bool

if checkResult && !tracesEqual(ret, test.Result) {
// Below are prints to show differences if we fail, can always just check against the specific test json files too!
fmt.Println("Trace return: ")
fmt.Println("Got Trace:")
x, _ := json.Marshal(ret)
// //x, _ := json.MarshalIndent(ret, "", " ")
// y, _ := json.Marshal(test.Result)
fmt.Println(string(x))
fmt.Println("test.Result")

// fmt.Println("Expected Trace:")
// y, _ := json.Marshal(test.Result)
// fmt.Println(string(y))
t.Fatal("traces mismatch")
// t.Fatalf("trace mismatch: \nhave %+v\nwant %+v", ret, test.Result)
}
}

Expand Down