Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 1 | // Copyright 2017 The Bazel Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style |
| 3 | // license that can be found in the LICENSE file. |
| 4 | |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 5 | package starlark_test |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 6 | |
| 7 | import ( |
| 8 | "bytes" |
| 9 | "fmt" |
| 10 | "math" |
| 11 | "path/filepath" |
Alessandro Arzilli | 5846440 | 2018-12-13 17:43:18 +0100 | [diff] [blame] | 12 | "strings" |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 13 | "testing" |
| 14 | |
Alan Donovan | 6beab7e | 2018-10-31 17:53:09 -0400 | [diff] [blame] | 15 | "go.starlark.net/internal/chunkedfile" |
| 16 | "go.starlark.net/resolve" |
alandonovan | 7a86632 | 2018-11-21 14:57:52 -0500 | [diff] [blame] | 17 | "go.starlark.net/starlark" |
Alan Donovan | 6beab7e | 2018-10-31 17:53:09 -0400 | [diff] [blame] | 18 | "go.starlark.net/starlarktest" |
| 19 | "go.starlark.net/syntax" |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 20 | ) |
| 21 | |
Alan Donovan | c0b6b76 | 2018-12-18 13:09:56 -0500 | [diff] [blame] | 22 | // A test may enable non-standard options by containing (e.g.) "option:recursion". |
| 23 | func setOptions(src string) { |
| 24 | resolve.AllowBitwise = option(src, "bitwise") |
| 25 | resolve.AllowFloat = option(src, "float") |
| 26 | resolve.AllowGlobalReassign = option(src, "globalreassign") |
| 27 | resolve.AllowLambda = option(src, "lambda") |
| 28 | resolve.AllowNestedDef = option(src, "nesteddef") |
| 29 | resolve.AllowRecursion = option(src, "recursion") |
| 30 | resolve.AllowSet = option(src, "set") |
| 31 | } |
| 32 | |
| 33 | func option(chunk, name string) bool { |
| 34 | return strings.Contains(chunk, "option:"+name) |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 35 | } |
| 36 | |
| 37 | func TestEvalExpr(t *testing.T) { |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 38 | // This is mostly redundant with the new *.star tests. |
| 39 | // TODO(adonovan): move checks into *.star files and |
| 40 | // reduce this to a mere unit test of starlark.Eval. |
| 41 | thread := new(starlark.Thread) |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 42 | for _, test := range []struct{ src, want string }{ |
| 43 | {`123`, `123`}, |
| 44 | {`-1`, `-1`}, |
| 45 | {`"a"+"b"`, `"ab"`}, |
| 46 | {`1+2`, `3`}, |
| 47 | |
| 48 | // lists |
| 49 | {`[]`, `[]`}, |
| 50 | {`[1]`, `[1]`}, |
| 51 | {`[1,]`, `[1]`}, |
| 52 | {`[1, 2]`, `[1, 2]`}, |
| 53 | {`[2 * x for x in [1, 2, 3]]`, `[2, 4, 6]`}, |
| 54 | {`[2 * x for x in [1, 2, 3] if x > 1]`, `[4, 6]`}, |
| 55 | {`[(x, y) for x in [1, 2] for y in [3, 4]]`, |
| 56 | `[(1, 3), (1, 4), (2, 3), (2, 4)]`}, |
| 57 | {`[(x, y) for x in [1, 2] if x == 2 for y in [3, 4]]`, |
| 58 | `[(2, 3), (2, 4)]`}, |
| 59 | // tuples |
| 60 | {`()`, `()`}, |
| 61 | {`(1)`, `1`}, |
| 62 | {`(1,)`, `(1,)`}, |
| 63 | {`(1, 2)`, `(1, 2)`}, |
| 64 | {`(1, 2, 3, 4, 5)`, `(1, 2, 3, 4, 5)`}, |
| 65 | // dicts |
| 66 | {`{}`, `{}`}, |
| 67 | {`{"a": 1}`, `{"a": 1}`}, |
| 68 | {`{"a": 1,}`, `{"a": 1}`}, |
| 69 | |
| 70 | // conditional |
| 71 | {`1 if 3 > 2 else 0`, `1`}, |
| 72 | {`1 if "foo" else 0`, `1`}, |
| 73 | {`1 if "" else 0`, `0`}, |
| 74 | |
| 75 | // indexing |
| 76 | {`["a", "b"][0]`, `"a"`}, |
| 77 | {`["a", "b"][1]`, `"b"`}, |
| 78 | {`("a", "b")[0]`, `"a"`}, |
| 79 | {`("a", "b")[1]`, `"b"`}, |
| 80 | {`"aΩb"[0]`, `"a"`}, |
| 81 | {`"aΩb"[1]`, `"\xce"`}, |
| 82 | {`"aΩb"[3]`, `"b"`}, |
| 83 | {`{"a": 1}["a"]`, `1`}, |
| 84 | {`{"a": 1}["b"]`, `key "b" not in dict`}, |
| 85 | {`{}[[]]`, `unhashable type: list`}, |
| 86 | {`{"a": 1}[[]]`, `unhashable type: list`}, |
| 87 | {`[x for x in range(3)]`, "[0, 1, 2]"}, |
| 88 | } { |
| 89 | var got string |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 90 | if v, err := starlark.Eval(thread, "<expr>", test.src, nil); err != nil { |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 91 | got = err.Error() |
| 92 | } else { |
| 93 | got = v.String() |
| 94 | } |
| 95 | if got != test.want { |
| 96 | t.Errorf("eval %s = %s, want %s", test.src, got, test.want) |
| 97 | } |
| 98 | } |
| 99 | } |
| 100 | |
| 101 | func TestExecFile(t *testing.T) { |
Alan Donovan | c0b6b76 | 2018-12-18 13:09:56 -0500 | [diff] [blame] | 102 | defer setOptions("") |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 103 | testdata := starlarktest.DataFile("starlark", ".") |
| 104 | thread := &starlark.Thread{Load: load} |
| 105 | starlarktest.SetReporter(thread, t) |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 106 | for _, file := range []string{ |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 107 | "testdata/assign.star", |
| 108 | "testdata/bool.star", |
| 109 | "testdata/builtins.star", |
| 110 | "testdata/control.star", |
| 111 | "testdata/dict.star", |
| 112 | "testdata/float.star", |
| 113 | "testdata/function.star", |
| 114 | "testdata/int.star", |
| 115 | "testdata/list.star", |
| 116 | "testdata/misc.star", |
| 117 | "testdata/set.star", |
| 118 | "testdata/string.star", |
| 119 | "testdata/tuple.star", |
Alessandro Arzilli | 5846440 | 2018-12-13 17:43:18 +0100 | [diff] [blame] | 120 | "testdata/recursion.star", |
alandonovan | 9d97771 | 2019-01-04 13:04:59 -0500 | [diff] [blame^] | 121 | "testdata/module.star", |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 122 | } { |
| 123 | filename := filepath.Join(testdata, file) |
| 124 | for _, chunk := range chunkedfile.Read(filename, t) { |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 125 | predeclared := starlark.StringDict{ |
| 126 | "hasfields": starlark.NewBuiltin("hasfields", newHasFields), |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 127 | "fibonacci": fib{}, |
| 128 | } |
Alessandro Arzilli | 5846440 | 2018-12-13 17:43:18 +0100 | [diff] [blame] | 129 | |
Alan Donovan | c0b6b76 | 2018-12-18 13:09:56 -0500 | [diff] [blame] | 130 | setOptions(chunk.Source) |
| 131 | resolve.AllowLambda = true // used extensively |
Alessandro Arzilli | 5846440 | 2018-12-13 17:43:18 +0100 | [diff] [blame] | 132 | |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 133 | _, err := starlark.ExecFile(thread, filename, chunk.Source, predeclared) |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 134 | switch err := err.(type) { |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 135 | case *starlark.EvalError: |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 136 | found := false |
| 137 | for _, fr := range err.Stack() { |
| 138 | posn := fr.Position() |
| 139 | if posn.Filename() == filename { |
| 140 | chunk.GotError(int(posn.Line), err.Error()) |
| 141 | found = true |
| 142 | break |
| 143 | } |
| 144 | } |
| 145 | if !found { |
| 146 | t.Error(err.Backtrace()) |
| 147 | } |
| 148 | case nil: |
| 149 | // success |
| 150 | default: |
Alan Donovan | c0b6b76 | 2018-12-18 13:09:56 -0500 | [diff] [blame] | 151 | t.Errorf("\n%s", err) |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 152 | } |
| 153 | chunk.Done() |
| 154 | } |
| 155 | } |
| 156 | } |
| 157 | |
| 158 | // A fib is an iterable value representing the infinite Fibonacci sequence. |
| 159 | type fib struct{} |
| 160 | |
alandonovan | 7a86632 | 2018-11-21 14:57:52 -0500 | [diff] [blame] | 161 | func (t fib) Freeze() {} |
| 162 | func (t fib) String() string { return "fib" } |
| 163 | func (t fib) Type() string { return "fib" } |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 164 | func (t fib) Truth() starlark.Bool { return true } |
alandonovan | 7a86632 | 2018-11-21 14:57:52 -0500 | [diff] [blame] | 165 | func (t fib) Hash() (uint32, error) { return 0, fmt.Errorf("fib is unhashable") } |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 166 | func (t fib) Iterate() starlark.Iterator { return &fibIterator{0, 1} } |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 167 | |
| 168 | type fibIterator struct{ x, y int } |
| 169 | |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 170 | func (it *fibIterator) Next(p *starlark.Value) bool { |
| 171 | *p = starlark.MakeInt(it.x) |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 172 | it.x, it.y = it.y, it.x+it.y |
| 173 | return true |
| 174 | } |
| 175 | func (it *fibIterator) Done() {} |
| 176 | |
| 177 | // load implements the 'load' operation as used in the evaluator tests. |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 178 | func load(thread *starlark.Thread, module string) (starlark.StringDict, error) { |
| 179 | if module == "assert.star" { |
| 180 | return starlarktest.LoadAssertModule() |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 181 | } |
| 182 | |
| 183 | // TODO(adonovan): test load() using this execution path. |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 184 | filename := filepath.Join(filepath.Dir(thread.Caller().Position().Filename()), module) |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 185 | return starlark.ExecFile(thread, filename, nil, nil) |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 186 | } |
| 187 | |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 188 | func newHasFields(thread *starlark.Thread, _ *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) { |
| 189 | return &hasfields{attrs: make(map[string]starlark.Value)}, nil |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 190 | } |
| 191 | |
| 192 | // hasfields is a test-only implementation of HasAttrs. |
| 193 | // It permits any field to be set. |
| 194 | // Clients will likely want to provide their own implementation, |
| 195 | // so we don't have any public implementation. |
| 196 | type hasfields struct { |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 197 | attrs starlark.StringDict |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 198 | frozen bool |
| 199 | } |
| 200 | |
alandonovan | 15b1cb9 | 2018-02-26 14:38:20 -0500 | [diff] [blame] | 201 | var ( |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 202 | _ starlark.HasAttrs = (*hasfields)(nil) |
| 203 | _ starlark.HasBinary = (*hasfields)(nil) |
alandonovan | 15b1cb9 | 2018-02-26 14:38:20 -0500 | [diff] [blame] | 204 | ) |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 205 | |
| 206 | func (hf *hasfields) String() string { return "hasfields" } |
| 207 | func (hf *hasfields) Type() string { return "hasfields" } |
alandonovan | 7a86632 | 2018-11-21 14:57:52 -0500 | [diff] [blame] | 208 | func (hf *hasfields) Truth() starlark.Bool { return true } |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 209 | func (hf *hasfields) Hash() (uint32, error) { return 42, nil } |
| 210 | |
| 211 | func (hf *hasfields) Freeze() { |
| 212 | if !hf.frozen { |
| 213 | hf.frozen = true |
| 214 | for _, v := range hf.attrs { |
| 215 | v.Freeze() |
| 216 | } |
| 217 | } |
| 218 | } |
| 219 | |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 220 | func (hf *hasfields) Attr(name string) (starlark.Value, error) { return hf.attrs[name], nil } |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 221 | |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 222 | func (hf *hasfields) SetField(name string, val starlark.Value) error { |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 223 | if hf.frozen { |
| 224 | return fmt.Errorf("cannot set field on a frozen hasfields") |
| 225 | } |
| 226 | hf.attrs[name] = val |
| 227 | return nil |
| 228 | } |
| 229 | |
| 230 | func (hf *hasfields) AttrNames() []string { |
| 231 | names := make([]string, 0, len(hf.attrs)) |
| 232 | for key := range hf.attrs { |
| 233 | names = append(names, key) |
| 234 | } |
| 235 | return names |
| 236 | } |
| 237 | |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 238 | func (hf *hasfields) Binary(op syntax.Token, y starlark.Value, side starlark.Side) (starlark.Value, error) { |
alandonovan | 15b1cb9 | 2018-02-26 14:38:20 -0500 | [diff] [blame] | 239 | // This method exists so we can exercise 'list += x' |
| 240 | // where x is not Iterable but defines list+x. |
| 241 | if op == syntax.PLUS { |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 242 | if _, ok := y.(*starlark.List); ok { |
| 243 | return starlark.MakeInt(42), nil // list+hasfields is 42 |
alandonovan | 15b1cb9 | 2018-02-26 14:38:20 -0500 | [diff] [blame] | 244 | } |
| 245 | } |
| 246 | return nil, nil |
| 247 | } |
| 248 | |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 249 | func TestParameterPassing(t *testing.T) { |
| 250 | const filename = "parameters.go" |
| 251 | const src = ` |
| 252 | def a(): |
| 253 | return |
| 254 | def b(a, b): |
| 255 | return a, b |
| 256 | def c(a, b=42): |
| 257 | return a, b |
| 258 | def d(*args): |
| 259 | return args |
| 260 | def e(**kwargs): |
| 261 | return kwargs |
| 262 | def f(a, b=42, *args, **kwargs): |
| 263 | return a, b, args, kwargs |
| 264 | ` |
| 265 | |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 266 | thread := new(starlark.Thread) |
| 267 | globals, err := starlark.ExecFile(thread, filename, src, nil) |
alandonovan | a1b28d8 | 2018-03-13 10:59:24 -0400 | [diff] [blame] | 268 | if err != nil { |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 269 | t.Fatal(err) |
| 270 | } |
| 271 | |
| 272 | for _, test := range []struct{ src, want string }{ |
| 273 | {`a()`, `None`}, |
| 274 | {`a(1)`, `function a takes no arguments (1 given)`}, |
alandonovan | b7e3b1f | 2018-12-12 17:14:58 -0500 | [diff] [blame] | 275 | {`b()`, `function b takes exactly 2 positional arguments (0 given)`}, |
| 276 | {`b(1)`, `function b takes exactly 2 positional arguments (1 given)`}, |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 277 | {`b(1, 2)`, `(1, 2)`}, |
| 278 | {`b`, `<function b>`}, // asserts that b's parameter b was treated as a local variable |
alandonovan | b7e3b1f | 2018-12-12 17:14:58 -0500 | [diff] [blame] | 279 | {`b(1, 2, 3)`, `function b takes exactly 2 positional arguments (3 given)`}, |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 280 | {`b(1, b=2)`, `(1, 2)`}, |
| 281 | {`b(1, a=2)`, `function b got multiple values for keyword argument "a"`}, |
| 282 | {`b(1, x=2)`, `function b got an unexpected keyword argument "x"`}, |
| 283 | {`b(a=1, b=2)`, `(1, 2)`}, |
| 284 | {`b(b=1, a=2)`, `(2, 1)`}, |
| 285 | {`b(b=1, a=2, x=1)`, `function b got an unexpected keyword argument "x"`}, |
| 286 | {`b(x=1, b=1, a=2)`, `function b got an unexpected keyword argument "x"`}, |
alandonovan | b7e3b1f | 2018-12-12 17:14:58 -0500 | [diff] [blame] | 287 | {`c()`, `function c takes at least 1 positional argument (0 given)`}, |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 288 | {`c(1)`, `(1, 42)`}, |
| 289 | {`c(1, 2)`, `(1, 2)`}, |
alandonovan | b7e3b1f | 2018-12-12 17:14:58 -0500 | [diff] [blame] | 290 | {`c(1, 2, 3)`, `function c takes at most 2 positional arguments (3 given)`}, |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 291 | {`c(1, b=2)`, `(1, 2)`}, |
| 292 | {`c(1, a=2)`, `function c got multiple values for keyword argument "a"`}, |
| 293 | {`c(a=1, b=2)`, `(1, 2)`}, |
| 294 | {`c(b=1, a=2)`, `(2, 1)`}, |
| 295 | {`d()`, `()`}, |
| 296 | {`d(1)`, `(1,)`}, |
| 297 | {`d(1, 2)`, `(1, 2)`}, |
| 298 | {`d(1, 2, k=3)`, `function d got an unexpected keyword argument "k"`}, |
| 299 | {`d(args=[])`, `function d got an unexpected keyword argument "args"`}, |
| 300 | {`e()`, `{}`}, |
alandonovan | b7e3b1f | 2018-12-12 17:14:58 -0500 | [diff] [blame] | 301 | {`e(1)`, `function e takes exactly 0 positional arguments (1 given)`}, |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 302 | {`e(k=1)`, `{"k": 1}`}, |
| 303 | {`e(kwargs={})`, `{"kwargs": {}}`}, |
alandonovan | b7e3b1f | 2018-12-12 17:14:58 -0500 | [diff] [blame] | 304 | {`f()`, `function f takes at least 1 positional argument (0 given)`}, |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 305 | {`f(0)`, `(0, 42, (), {})`}, |
| 306 | {`f(0)`, `(0, 42, (), {})`}, |
| 307 | {`f(0, 1)`, `(0, 1, (), {})`}, |
| 308 | {`f(0, 1, 2)`, `(0, 1, (2,), {})`}, |
| 309 | {`f(0, 1, 2, 3)`, `(0, 1, (2, 3), {})`}, |
| 310 | {`f(a=0)`, `(0, 42, (), {})`}, |
| 311 | {`f(0, b=1)`, `(0, 1, (), {})`}, |
| 312 | {`f(0, a=1)`, `function f got multiple values for keyword argument "a"`}, |
| 313 | {`f(0, b=1, c=2)`, `(0, 1, (), {"c": 2})`}, |
alandonovan | 7a86632 | 2018-11-21 14:57:52 -0500 | [diff] [blame] | 314 | {`f(0, 1, x=2, *[3, 4], y=5, **dict(z=6))`, // github.com/google/skylark/issues/135 |
alandonovan | 8160121 | 2018-10-22 13:41:53 -0400 | [diff] [blame] | 315 | `(0, 1, (3, 4), {"x": 2, "y": 5, "z": 6})`}, |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 316 | } { |
| 317 | var got string |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 318 | if v, err := starlark.Eval(thread, "<expr>", test.src, globals); err != nil { |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 319 | got = err.Error() |
| 320 | } else { |
| 321 | got = v.String() |
| 322 | } |
| 323 | if got != test.want { |
| 324 | t.Errorf("eval %s = %s, want %s", test.src, got, test.want) |
| 325 | } |
| 326 | } |
| 327 | } |
| 328 | |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 329 | // TestPrint ensures that the Starlark print function calls |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 330 | // Thread.Print, if provided. |
| 331 | func TestPrint(t *testing.T) { |
| 332 | const src = ` |
| 333 | print("hello") |
alandonovan | 88085a4 | 2018-12-14 19:09:49 -0500 | [diff] [blame] | 334 | def f(): print("hello", "world", sep=", ") |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 335 | f() |
| 336 | ` |
| 337 | buf := new(bytes.Buffer) |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 338 | print := func(thread *starlark.Thread, msg string) { |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 339 | caller := thread.Caller() |
alandonovan | 93f3e0c | 2018-03-30 10:42:28 -0400 | [diff] [blame] | 340 | fmt.Fprintf(buf, "%s: %s: %s\n", |
alandonovan | cc7dbc2 | 2018-07-02 12:30:24 -0400 | [diff] [blame] | 341 | caller.Position(), caller.Callable().Name(), msg) |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 342 | } |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 343 | thread := &starlark.Thread{Print: print} |
alandonovan | 2c1f362 | 2018-12-17 13:10:16 -0500 | [diff] [blame] | 344 | if _, err := starlark.ExecFile(thread, "foo.star", src, nil); err != nil { |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 345 | t.Fatal(err) |
| 346 | } |
alandonovan | 2c1f362 | 2018-12-17 13:10:16 -0500 | [diff] [blame] | 347 | want := "foo.star:2: <toplevel>: hello\n" + |
| 348 | "foo.star:3: f: hello, world\n" |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 349 | if got := buf.String(); got != want { |
| 350 | t.Errorf("output was %s, want %s", got, want) |
| 351 | } |
| 352 | } |
| 353 | |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 354 | func reportEvalError(tb testing.TB, err error) { |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 355 | if err, ok := err.(*starlark.EvalError); ok { |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 356 | tb.Fatal(err.Backtrace()) |
| 357 | } |
| 358 | tb.Fatal(err) |
| 359 | } |
| 360 | |
| 361 | // TestInt exercises the Int.Int64 and Int.Uint64 methods. |
| 362 | // If we can move their logic into math/big, delete this test. |
| 363 | func TestInt(t *testing.T) { |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 364 | one := starlark.MakeInt(1) |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 365 | |
| 366 | for _, test := range []struct { |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 367 | i starlark.Int |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 368 | wantInt64 string |
| 369 | wantUint64 string |
| 370 | }{ |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 371 | {starlark.MakeInt64(math.MinInt64).Sub(one), "error", "error"}, |
| 372 | {starlark.MakeInt64(math.MinInt64), "-9223372036854775808", "error"}, |
| 373 | {starlark.MakeInt64(-1), "-1", "error"}, |
| 374 | {starlark.MakeInt64(0), "0", "0"}, |
| 375 | {starlark.MakeInt64(1), "1", "1"}, |
| 376 | {starlark.MakeInt64(math.MaxInt64), "9223372036854775807", "9223372036854775807"}, |
| 377 | {starlark.MakeUint64(math.MaxUint64), "error", "18446744073709551615"}, |
| 378 | {starlark.MakeUint64(math.MaxUint64).Add(one), "error", "error"}, |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 379 | } { |
| 380 | gotInt64, gotUint64 := "error", "error" |
| 381 | if i, ok := test.i.Int64(); ok { |
| 382 | gotInt64 = fmt.Sprint(i) |
| 383 | } |
| 384 | if u, ok := test.i.Uint64(); ok { |
| 385 | gotUint64 = fmt.Sprint(u) |
| 386 | } |
| 387 | if gotInt64 != test.wantInt64 { |
| 388 | t.Errorf("(%s).Int64() = %s, want %s", test.i, gotInt64, test.wantInt64) |
| 389 | } |
| 390 | if gotUint64 != test.wantUint64 { |
| 391 | t.Errorf("(%s).Uint64() = %s, want %s", test.i, gotUint64, test.wantUint64) |
| 392 | } |
| 393 | } |
| 394 | } |
| 395 | |
| 396 | func TestBacktrace(t *testing.T) { |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 397 | // This test ensures continuity of the stack of active Starlark |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 398 | // functions, including propagation through built-ins such as 'min' |
| 399 | // (though min does not itself appear in the stack). |
| 400 | const src = ` |
| 401 | def f(x): return 1//x |
| 402 | def g(x): f(x) |
| 403 | def h(): return min([1, 2, 0], key=g) |
| 404 | def i(): return h() |
| 405 | i() |
| 406 | ` |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 407 | thread := new(starlark.Thread) |
| 408 | _, err := starlark.ExecFile(thread, "crash.star", src, nil) |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 409 | switch err := err.(type) { |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 410 | case *starlark.EvalError: |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 411 | got := err.Backtrace() |
alandonovan | 93f3e0c | 2018-03-30 10:42:28 -0400 | [diff] [blame] | 412 | // Compiled code currently has no column information. |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 413 | const want = `Traceback (most recent call last): |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 414 | crash.star:6: in <toplevel> |
| 415 | crash.star:5: in i |
| 416 | crash.star:4: in h |
alandonovan | cc7dbc2 | 2018-07-02 12:30:24 -0400 | [diff] [blame] | 417 | <builtin>:1: in min |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 418 | crash.star:3: in g |
| 419 | crash.star:2: in f |
Alan Donovan | 312d1a5 | 2017-10-02 10:10:28 -0400 | [diff] [blame] | 420 | Error: floored division by zero` |
| 421 | if got != want { |
| 422 | t.Errorf("error was %s, want %s", got, want) |
| 423 | } |
| 424 | case nil: |
| 425 | t.Error("ExecFile succeeded unexpectedly") |
| 426 | default: |
| 427 | t.Errorf("ExecFile failed with %v, wanted *EvalError", err) |
| 428 | } |
| 429 | } |
Alan Donovan | 7b0e4c3 | 2017-10-09 11:03:36 -0400 | [diff] [blame] | 430 | |
| 431 | // TestRepeatedExec parses and resolves a file syntax tree once then |
alandonovan | a1b28d8 | 2018-03-13 10:59:24 -0400 | [diff] [blame] | 432 | // executes it repeatedly with different values of its predeclared variables. |
Alan Donovan | 7b0e4c3 | 2017-10-09 11:03:36 -0400 | [diff] [blame] | 433 | func TestRepeatedExec(t *testing.T) { |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 434 | predeclared := starlark.StringDict{"x": starlark.None} |
| 435 | _, prog, err := starlark.SourceProgram("repeat.star", "y = 2 * x", predeclared.Has) |
Alan Donovan | 7b0e4c3 | 2017-10-09 11:03:36 -0400 | [diff] [blame] | 436 | if err != nil { |
alandonovan | 93f3e0c | 2018-03-30 10:42:28 -0400 | [diff] [blame] | 437 | t.Fatal(err) |
Alan Donovan | 7b0e4c3 | 2017-10-09 11:03:36 -0400 | [diff] [blame] | 438 | } |
| 439 | |
Alan Donovan | 7b0e4c3 | 2017-10-09 11:03:36 -0400 | [diff] [blame] | 440 | for _, test := range []struct { |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 441 | x, want starlark.Value |
Alan Donovan | 7b0e4c3 | 2017-10-09 11:03:36 -0400 | [diff] [blame] | 442 | }{ |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 443 | {x: starlark.MakeInt(42), want: starlark.MakeInt(84)}, |
| 444 | {x: starlark.String("mur"), want: starlark.String("murmur")}, |
| 445 | {x: starlark.Tuple{starlark.None}, want: starlark.Tuple{starlark.None, starlark.None}}, |
Alan Donovan | 7b0e4c3 | 2017-10-09 11:03:36 -0400 | [diff] [blame] | 446 | } { |
alandonovan | 93f3e0c | 2018-03-30 10:42:28 -0400 | [diff] [blame] | 447 | predeclared["x"] = test.x // update the values in dictionary |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 448 | thread := new(starlark.Thread) |
alandonovan | 93f3e0c | 2018-03-30 10:42:28 -0400 | [diff] [blame] | 449 | if globals, err := prog.Init(thread, predeclared); err != nil { |
Alan Donovan | 7b0e4c3 | 2017-10-09 11:03:36 -0400 | [diff] [blame] | 450 | t.Errorf("x=%v: %v", test.x, err) // exec error |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 451 | } else if eq, err := starlark.Equal(globals["y"], test.want); err != nil { |
Jay Conrod | 7761e75 | 2017-10-11 22:13:56 -0400 | [diff] [blame] | 452 | t.Errorf("x=%v: %v", test.x, err) // comparison error |
Alan Donovan | 7b0e4c3 | 2017-10-09 11:03:36 -0400 | [diff] [blame] | 453 | } else if !eq { |
alandonovan | 93f3e0c | 2018-03-30 10:42:28 -0400 | [diff] [blame] | 454 | t.Errorf("x=%v: got y=%v, want %v", test.x, globals["y"], test.want) |
Alan Donovan | 7b0e4c3 | 2017-10-09 11:03:36 -0400 | [diff] [blame] | 455 | } |
Alan Donovan | 7b0e4c3 | 2017-10-09 11:03:36 -0400 | [diff] [blame] | 456 | } |
| 457 | } |
alandonovan | 04850cb | 2017-10-11 14:16:28 -0400 | [diff] [blame] | 458 | |
alandonovan | 2c1f362 | 2018-12-17 13:10:16 -0500 | [diff] [blame] | 459 | // TestEmptyFilePosition ensures that even Programs |
| 460 | // from empty files have a valid position. |
| 461 | func TestEmptyPosition(t *testing.T) { |
| 462 | var predeclared starlark.StringDict |
| 463 | for _, content := range []string{"", "empty = False"} { |
| 464 | _, prog, err := starlark.SourceProgram("hello.star", content, predeclared.Has) |
| 465 | if err != nil { |
| 466 | t.Fatal(err) |
| 467 | } |
| 468 | if got, want := prog.Filename(), "hello.star"; got != want { |
| 469 | t.Errorf("Program.Filename() = %q, want %q", got, want) |
| 470 | } |
| 471 | } |
| 472 | } |
| 473 | |
alandonovan | 04850cb | 2017-10-11 14:16:28 -0400 | [diff] [blame] | 474 | // TestUnpackUserDefined tests that user-defined |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 475 | // implementations of starlark.Value may be unpacked. |
alandonovan | 04850cb | 2017-10-11 14:16:28 -0400 | [diff] [blame] | 476 | func TestUnpackUserDefined(t *testing.T) { |
| 477 | // success |
| 478 | want := new(hasfields) |
| 479 | var x *hasfields |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 480 | if err := starlark.UnpackArgs("unpack", starlark.Tuple{want}, nil, "x", &x); err != nil { |
alandonovan | 04850cb | 2017-10-11 14:16:28 -0400 | [diff] [blame] | 481 | t.Errorf("UnpackArgs failed: %v", err) |
| 482 | } |
| 483 | if x != want { |
| 484 | t.Errorf("for x, got %v, want %v", x, want) |
| 485 | } |
| 486 | |
| 487 | // failure |
Alan Donovan | e3deafe | 2018-10-23 11:05:09 -0400 | [diff] [blame] | 488 | err := starlark.UnpackArgs("unpack", starlark.Tuple{starlark.MakeInt(42)}, nil, "x", &x) |
alandonovan | 04850cb | 2017-10-11 14:16:28 -0400 | [diff] [blame] | 489 | if want := "unpack: for parameter 1: got int, want hasfields"; fmt.Sprint(err) != want { |
| 490 | t.Errorf("unpack args error = %q, want %q", err, want) |
| 491 | } |
| 492 | } |
Alessandro Arzilli | 3b628ff | 2018-12-05 15:04:35 +0100 | [diff] [blame] | 493 | |
| 494 | func TestDocstring(t *testing.T) { |
| 495 | globals, _ := starlark.ExecFile(&starlark.Thread{}, "doc.star", ` |
| 496 | def somefunc(): |
| 497 | "somefunc doc" |
| 498 | return 0 |
| 499 | `, nil) |
| 500 | |
| 501 | if globals["somefunc"].(*starlark.Function).Doc() != "somefunc doc" { |
| 502 | t.Fatal("docstring not found") |
| 503 | } |
| 504 | } |
alandonovan | 2c1f362 | 2018-12-17 13:10:16 -0500 | [diff] [blame] | 505 | |
| 506 | func TestFrameLocals(t *testing.T) { |
| 507 | // trace prints a nice stack trace including argument |
| 508 | // values of calls to Starlark functions. |
| 509 | trace := func(thread *starlark.Thread) string { |
| 510 | buf := new(bytes.Buffer) |
| 511 | for fr := thread.TopFrame(); fr != nil; fr = fr.Parent() { |
| 512 | fmt.Fprintf(buf, "%s(", fr.Callable().Name()) |
| 513 | if fn, ok := fr.Callable().(*starlark.Function); ok { |
| 514 | for i := 0; i < fn.NumParams(); i++ { |
| 515 | if i > 0 { |
| 516 | buf.WriteString(", ") |
| 517 | } |
| 518 | name, _ := fn.Param(i) |
| 519 | fmt.Fprintf(buf, "%s=%s", name, fr.Local(i)) |
| 520 | } |
| 521 | } else { |
| 522 | buf.WriteString("...") // a built-in function |
| 523 | } |
| 524 | buf.WriteString(")\n") |
| 525 | } |
| 526 | return buf.String() |
| 527 | } |
| 528 | |
| 529 | var got string |
| 530 | builtin := func(thread *starlark.Thread, _ *starlark.Builtin, _ starlark.Tuple, _ []starlark.Tuple) (starlark.Value, error) { |
| 531 | got = trace(thread) |
| 532 | return starlark.None, nil |
| 533 | } |
| 534 | predeclared := starlark.StringDict{ |
| 535 | "builtin": starlark.NewBuiltin("builtin", builtin), |
| 536 | } |
| 537 | _, err := starlark.ExecFile(&starlark.Thread{}, "foo.star", ` |
| 538 | def f(x, y): builtin() |
| 539 | def g(z): f(z, z*z) |
| 540 | g(7) |
| 541 | `, predeclared) |
| 542 | if err != nil { |
| 543 | t.Errorf("ExecFile failed: %v", err) |
| 544 | } |
| 545 | |
| 546 | var want = ` |
| 547 | builtin(...) |
| 548 | f(x=7, y=49) |
| 549 | g(z=7) |
| 550 | <toplevel>() |
| 551 | `[1:] |
| 552 | if got != want { |
| 553 | t.Errorf("got <<%s>>, want <<%s>>", got, want) |
| 554 | } |
| 555 | } |
alandonovan | c122e65 | 2019-01-03 18:11:01 -0500 | [diff] [blame] | 556 | |
| 557 | type badType string |
| 558 | |
| 559 | func (b *badType) String() string { return "badType" } |
| 560 | func (b *badType) Type() string { return "badType:" + string(*b) } // panics if b==nil |
| 561 | func (b *badType) Truth() starlark.Bool { return true } |
| 562 | func (b *badType) Hash() (uint32, error) { return 0, nil } |
| 563 | func (b *badType) Freeze() {} |
| 564 | |
| 565 | var _ starlark.Value = new(badType) |
| 566 | |
| 567 | // TestUnpackErrorBadType verifies that the Unpack functions fail |
| 568 | // gracefully when a parameter's default value's Type method panics. |
| 569 | func TestUnpackErrorBadType(t *testing.T) { |
| 570 | for _, test := range []struct { |
| 571 | x *badType |
| 572 | want string |
| 573 | }{ |
| 574 | {new(badType), "got NoneType, want badType"}, // Starlark type name |
| 575 | {nil, "got NoneType, want *starlark_test.badType"}, // Go type name |
| 576 | } { |
| 577 | err := starlark.UnpackArgs("f", starlark.Tuple{starlark.None}, nil, "x", &test.x) |
| 578 | if err == nil { |
| 579 | t.Errorf("UnpackArgs succeeded unexpectedly") |
| 580 | continue |
| 581 | } |
| 582 | if !strings.Contains(err.Error(), test.want) { |
| 583 | t.Errorf("UnpackArgs error %q does not contain %q", err, test.want) |
| 584 | } |
| 585 | } |
| 586 | } |