aboutsummaryrefslogtreecommitdiffstats
path: root/tests/rlp_test_util.go
blob: d7042eef754acc25414da397484dbc5e96a9588a (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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
package tests

import (
    "bytes"
    "encoding/hex"
    "errors"
    "fmt"
    "io"
    "math/big"
    "os"
    "strings"

    "github.com/ethereum/go-ethereum/rlp"
)

type RLPTest struct {
    In  interface{}
    Out string
}

func RunRLPTest(file string, skip []string) error {
    f, err := os.Open(file)
    if err != nil {
        return err
    }
    defer f.Close()
    return RunRLPTestWithReader(f, skip)
}

func RunRLPTestWithReader(r io.Reader, skip []string) error {
    var tests map[string]*RLPTest
    if err := readJson(r, &tests); err != nil {
        return err
    }
    for _, s := range skip {
        delete(tests, s)
    }
    for name, test := range tests {
        if err := test.Run(); err != nil {
            return fmt.Errorf("test %q failed: %v", name, err)
        }
    }
    return nil
}

// Run executes the test.
func (t *RLPTest) Run() error {
    outb, err := hex.DecodeString(t.Out)
    if err != nil {
        return fmt.Errorf("invalid hex in Out")
    }
    if t.In == "VALID" || t.In == "INVALID" {
        return checkDecodeInterface(outb, t.In == "VALID")
    }

    // Check whether encoding the value produces the same bytes.
    in := translateJSON(t.In)
    b, err := rlp.EncodeToBytes(in)
    if err != nil {
        return fmt.Errorf("encode failed: %v", err)
    }
    if !bytes.Equal(b, outb) {
        return fmt.Errorf("encode produced %x, want %x", b, outb)
    }
    // Test decoding from a stream.
    s := rlp.NewStream(bytes.NewReader(outb), 0)
    return checkDecodeFromJSON(s, in)
}

func checkDecodeInterface(b []byte, isValid bool) error {
    err := rlp.DecodeBytes(b, new(interface{}))
    switch {
    case isValid && err != nil:
        return fmt.Errorf("decoding failed: %v", err)
    case !isValid && err == nil:
        return fmt.Errorf("decoding of invalid value succeeded")
    }
    return nil
}

// translateJSON makes test json values encodable with RLP.
func translateJSON(v interface{}) interface{} {
    switch v := v.(type) {
    case float64:
        return uint64(v)
    case string:
        if len(v) > 0 && v[0] == '#' { // # starts a faux big int.
            big, ok := new(big.Int).SetString(v[1:], 10)
            if !ok {
                panic(fmt.Errorf("bad test: bad big int: %q", v))
            }
            return big
        }
        return []byte(v)
    case []interface{}:
        new := make([]interface{}, len(v))
        for i := range v {
            new[i] = translateJSON(v[i])
        }
        return new
    default:
        panic(fmt.Errorf("can't handle %T", v))
    }
}

// checkDecodeFromJSON decodes from s guided by exp. For each JSON
// value, the value decoded from the RLP stream must match.
func checkDecodeFromJSON(s *rlp.Stream, exp interface{}) error {
    switch exp := exp.(type) {
    case uint64:
        i, err := s.Uint()
        if err != nil {
            return addStack("Uint", exp, err)
        }
        if i != exp {
            return addStack("Uint", exp, fmt.Errorf("result mismatch: got %d", i))
        }
    case *big.Int:
        big := new(big.Int)
        if err := s.Decode(&big); err != nil {
            return addStack("Big", exp, err)
        }
        if big.Cmp(exp) != 0 {
            return addStack("Big", exp, fmt.Errorf("result mismatch: got %d", big))
        }
    case []byte:
        b, err := s.Bytes()
        if err != nil {
            return addStack("Bytes", exp, err)
        }
        if !bytes.Equal(b, exp) {
            return addStack("Bytes", exp, fmt.Errorf("result mismatch: got %x", b))
        }
    case []interface{}:
        if _, err := s.List(); err != nil {
            return addStack("List", exp, err)
        }
        for i, v := range exp {
            if err := checkDecodeFromJSON(s, v); err != nil {
                return addStack(fmt.Sprintf("[%d]", i), exp, err)
            }
        }
        if err := s.ListEnd(); err != nil {
            return addStack("ListEnd", exp, err)
        }
    default:
        panic(fmt.Errorf("unhandled type: %T", exp))
    }
    return nil
}

func addStack(op string, val interface{}, err error) error {
    lines := strings.Split(err.Error(), "\n")
    lines = append(lines, fmt.Sprintf("\t%s: %v", op, val))
    return errors.New(strings.Join(lines, "\n"))
}