aboutsummaryrefslogtreecommitdiffstats
path: root/common/natspec/natspec_test.go
blob: 654e3a62d0bc835983a88c2811c82e2f9db4d8d2 (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
157
158
// Copyright 2015 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 Lesser 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with go-ethereum.  If not, see <http://www.gnu.org/licenses/>.

package natspec

import (
    "testing"
)

func makeInfoDoc(desc string) []byte {
    return []byte(`
{
  "source": "contract test { }",
  "language": "Solidity",
  "compilerVersion": "1",
  "userDoc": {
    "methods": {
      "multiply(uint256)": {
        "notice":  "` + desc + `"
      },
      "balance(address)": {
        "notice": "` + "`(balanceInmGAV / 1000).fixed(0,3)`" + ` GAV is the total funds available to ` + "`who.address()`." + `"
      }
    },
    "invariants": [
      { "notice": "The sum total amount of GAV in the system is 1 million." }
    ],
    "construction": [
      { "notice": "Endows ` + "`message.caller.address()`" + ` with 1m GAV." }
    ]
  },
  "abiDefinition": [{
    "name": "multiply",
    "constant": false,
    "type": "function",
    "inputs": [{
      "name": "a",
      "type": "uint256"
    }],
    "outputs": [{
      "name": "d",
      "type": "uint256"
    }]
  }]
}`)
}

var data = "0xc6888fa1000000000000000000000000000000000000000000000000000000000000007a"

var tx = `
{
  "params": [{
      "to": "0x8521742d3f456bd237e312d6e30724960f72517a",
      "data": "0xc6888fa1000000000000000000000000000000000000000000000000000000000000007a"
  }],
}
`

func TestNotice(t *testing.T) {

    desc := "Will multiply `a` by 7 and return `a * 7`."
    expected := "Will multiply 122 by 7 and return 854."

    infodoc := makeInfoDoc(desc)
    ns, err := NewWithDocs(infodoc, tx, data)
    if err != nil {
        t.Errorf("New: error: %v", err)
        return
    }

    notice, err := ns.Notice()

    if err != nil {
        t.Errorf("expected no error, got %v", err)
    }

    if notice != expected {
        t.Errorf("incorrect notice. expected %v, got %v", expected, notice)
    }
}

// test missing method
func TestMissingMethod(t *testing.T) {

    desc := "Will multiply `a` by 7 and return `a * 7`."
    expected := "natspec.js error evaluating expression: Natspec evaluation failed, method does not exist"

    infodoc := makeInfoDoc(desc)
    ns, err := NewWithDocs(infodoc, tx, data)
    if err != nil {
        t.Errorf("New: error: %v", err)
    }

    notice, err := ns.noticeForMethod(tx, "missing_method", "")

    if err == nil {
        t.Errorf("expected error, got nothing (notice: '%v')", notice)
    } else {
        if err.Error() != expected {
            t.Errorf("expected error '%s' got '%v' (notice: '%v')", expected, err, notice)
        }
    }
}

// test invalid desc

func TestInvalidDesc(t *testing.T) {

    desc := "Will multiply 122 by \"7\" and return 854."
    expected := "invalid character '7' after object key:value pair"

    infodoc := makeInfoDoc(desc)
    _, err := NewWithDocs(infodoc, tx, data)
    if err == nil {
        t.Errorf("expected error, got nothing", err)
    } else {
        if err.Error() != expected {
            t.Errorf("expected error '%s' got '%v'", expected, err)
        }
    }
}

// test wrong input params
func TestWrongInputParams(t *testing.T) {

    desc := "Will multiply `e` by 7 and return `a * 7`."
    expected := "natspec.js error evaluating expression: Natspec evaluation failed, wrong input params"

    infodoc := makeInfoDoc(desc)
    ns, err := NewWithDocs(infodoc, tx, data)
    if err != nil {
        t.Errorf("New: error: %v", err)
    }

    notice, err := ns.Notice()

    if err == nil {
        t.Errorf("expected error, got nothing (notice: '%v')", notice)
    } else {
        if err.Error() != expected {
            t.Errorf("expected error '%s' got '%v' (notice: '%v')", expected, err, notice)
        }
    }

}