aboutsummaryrefslogtreecommitdiffstats
path: root/cmd/evm/staterunner.go
blob: 6d5ff069f6c178e5f9c60c261c4555512266e2a5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
// Copyright 2017 The go-ethereum Authors
// This file is part of go-ethereum.
//
// go-ethereum is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// go-ethereum is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.

package main

import (
    "encoding/json"
    "errors"
    "fmt"
    "io/ioutil"
    "os"

    "github.com/ethereum/go-ethereum/core/state"
    "github.com/ethereum/go-ethereum/core/vm"
    "github.com/ethereum/go-ethereum/log"
    "github.com/ethereum/go-ethereum/tests"

    cli "gopkg.in/urfave/cli.v1"
)

var stateTestCommand = cli.Command{
    Action:    stateTestCmd,
    Name:      "statetest",
    Usage:     "executes the given state tests",
    ArgsUsage: "<file>",
}

// StatetestResult contains the execution status after running a state test, any
// error that might have occurred and a dump of the final state if requested.
type StatetestResult struct {
    Name  string      `json:"name"`
    Pass  bool        `json:"pass"`
    Fork  string      `json:"fork"`
    Error string      `json:"error,omitempty"`
    State *state.Dump `json:"state,omitempty"`
}

func stateTestCmd(ctx *cli.Context) error {
    if len(ctx.Args().First()) == 0 {
        return errors.New("path-to-test argument required")
    }
    // Configure the go-ethereum logger
    glogger := log.NewGlogHandler(log.StreamHandler(os.Stderr, log.TerminalFormat(false)))
    glogger.Verbosity(log.Lvl(ctx.GlobalInt(VerbosityFlag.Name)))
    log.Root().SetHandler(glogger)

    // Configure the EVM logger
    config := &vm.LogConfig{
        DisableMemory: ctx.GlobalBool(DisableMemoryFlag.Name),
        DisableStack:  ctx.GlobalBool(DisableStackFlag.Name),
    }
    var (
        tracer   vm.Tracer
        debugger *vm.StructLogger
    )
    switch {
    case ctx.GlobalBool(MachineFlag.Name):
        tracer = NewJSONLogger(config, os.Stderr)

    case ctx.GlobalBool(DebugFlag.Name):
        debugger = vm.NewStructLogger(config)
        tracer = debugger

    default:
        debugger = vm.NewStructLogger(config)
    }
    // Load the test content from the input file
    src, err := ioutil.ReadFile(ctx.Args().First())
    if err != nil {
        return err
    }
    var tests map[string]tests.StateTest
    if err = json.Unmarshal(src, &tests); err != nil {
        return err
    }
    // Iterate over all the tests, run them and aggregate the results
    cfg := vm.Config{
        Tracer: tracer,
        Debug:  ctx.GlobalBool(DebugFlag.Name) || ctx.GlobalBool(MachineFlag.Name),
    }
    results := make([]StatetestResult, 0, len(tests))
    for key, test := range tests {
        for _, st := range test.Subtests() {
            // Run the test and aggregate the result
            result := &StatetestResult{Name: key, Fork: st.Fork, Pass: true}
            state, err := test.Run(st, cfg)
            if err != nil {
                // Test failed, mark as so and dump any state to aid debugging
                result.Pass, result.Error = false, err.Error()
                if ctx.GlobalBool(DumpFlag.Name) && state != nil {
                    dump := state.RawDump()
                    result.State = &dump
                }
            }
            // print state root for evmlab tracing (already committed above, so no need to delete objects again
            if ctx.GlobalBool(MachineFlag.Name) && state != nil {
                fmt.Fprintf(os.Stderr, "{\"stateRoot\": \"%x\"}\n", state.IntermediateRoot(false))
            }

            results = append(results, *result)

            // Print any structured logs collected
            if ctx.GlobalBool(DebugFlag.Name) {
                if debugger != nil {
                    fmt.Fprintln(os.Stderr, "#### TRACE ####")
                    vm.WriteTrace(os.Stderr, debugger.StructLogs())
                }
            }
        }
    }
    out, _ := json.MarshalIndent(results, "", "  ")
    fmt.Println(string(out))
    return nil
}