File: grammar_test.go

package info (click to toggle)
golang-github-hashicorp-go-bexpr 0.1.2-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 356 kB
  • sloc: makefile: 50
file content (436 lines) | stat: -rw-r--r-- 16,626 bytes parent folder | download | duplicates (2)
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
package bexpr

import (
	"testing"

	"github.com/stretchr/testify/require"
)

func TestExpressionParsing(t *testing.T) {
	t.Parallel()
	type testCase struct {
		input    string
		expected Expression
		err      string
	}

	tests := map[string]testCase{
		"Match Equality": {
			input:    "foo == 3",
			expected: &MatchExpression{Selector: Selector{"foo"}, Operator: MatchEqual, Value: &MatchValue{Raw: "3"}},
			err:      "",
		},
		"Match Inequality": {
			input:    "foo != xyz",
			expected: &MatchExpression{Selector: Selector{"foo"}, Operator: MatchNotEqual, Value: &MatchValue{Raw: "xyz"}},
			err:      "",
		},
		"Match Is Empty": {
			input:    "list is empty",
			expected: &MatchExpression{Selector: Selector{"list"}, Operator: MatchIsEmpty, Value: nil},
			err:      "",
		},
		"Match Is Not Empty": {
			input:    "list is not empty",
			expected: &MatchExpression{Selector: Selector{"list"}, Operator: MatchIsNotEmpty, Value: nil},
			err:      "",
		},
		"Match In": {
			input:    "foo in bar",
			expected: &MatchExpression{Selector: Selector{"bar"}, Operator: MatchIn, Value: &MatchValue{Raw: "foo"}},
			err:      "",
		},
		"Match Not In": {
			input:    "foo not in bar",
			expected: &MatchExpression{Selector: Selector{"bar"}, Operator: MatchNotIn, Value: &MatchValue{Raw: "foo"}},
			err:      "",
		},
		"Match Contains": {
			input:    "bar contains foo",
			expected: &MatchExpression{Selector: Selector{"bar"}, Operator: MatchIn, Value: &MatchValue{Raw: "foo"}},
			err:      "",
		},
		"Match Not Contains": {
			input:    "bar not contains foo",
			expected: &MatchExpression{Selector: Selector{"bar"}, Operator: MatchNotIn, Value: &MatchValue{Raw: "foo"}},
			err:      "",
		},
		"Match Matches": {
			input:    "foo matches bar",
			expected: &MatchExpression{Selector: Selector{"foo"}, Operator: MatchMatches, Value: &MatchValue{Raw: "bar"}},
			err:      "",
		},
		"Match Not Matches": {
			input:    "foo not matches bar",
			expected: &MatchExpression{Selector: Selector{"foo"}, Operator: MatchNotMatches, Value: &MatchValue{Raw: "bar"}},
			err:      "",
		},
		"Logical Not": {
			input: "not prod in tags",
			expected: &UnaryExpression{
				Operator: UnaryOpNot,
				Operand:  &MatchExpression{Selector: Selector{"tags"}, Operator: MatchIn, Value: &MatchValue{Raw: "prod"}},
			},
			err: "",
		},
		"Logical And": {
			input: "port != 80 and port != 8080",
			expected: &BinaryExpression{
				Operator: BinaryOpAnd,
				Left:     &MatchExpression{Selector: Selector{"port"}, Operator: MatchNotEqual, Value: &MatchValue{Raw: "80"}},
				Right:    &MatchExpression{Selector: Selector{"port"}, Operator: MatchNotEqual, Value: &MatchValue{Raw: "8080"}},
			},
			err: "",
		},
		"Logical Or": {
			input: "port == 80 or port == 443",
			expected: &BinaryExpression{
				Operator: BinaryOpOr,
				Left:     &MatchExpression{Selector: Selector{"port"}, Operator: MatchEqual, Value: &MatchValue{Raw: "80"}},
				Right:    &MatchExpression{Selector: Selector{"port"}, Operator: MatchEqual, Value: &MatchValue{Raw: "443"}},
			},
			err: "",
		},
		"Double Quoted Value (Equal)": {
			input:    "foo == \"bar\"",
			expected: &MatchExpression{Selector: Selector{"foo"}, Operator: MatchEqual, Value: &MatchValue{Raw: "bar"}},
			err:      "",
		},
		"Double Quoted Value (Not Equal)": {
			input:    "foo != \"bar\"",
			expected: &MatchExpression{Selector: Selector{"foo"}, Operator: MatchNotEqual, Value: &MatchValue{Raw: "bar"}},
			err:      "",
		},
		"Double Quoted Value (In)": {
			input:    "\"foo\" in bar",
			expected: &MatchExpression{Selector: Selector{"bar"}, Operator: MatchIn, Value: &MatchValue{Raw: "foo"}},
			err:      "",
		},
		"Double Quoted Value (Not In)": {
			input:    "\"foo\" not in bar",
			expected: &MatchExpression{Selector: Selector{"bar"}, Operator: MatchNotIn, Value: &MatchValue{Raw: "foo"}},
			err:      "",
		},
		"Backtick Quoted Value (Equal)": {
			input:    "foo == `bar`",
			expected: &MatchExpression{Selector: Selector{"foo"}, Operator: MatchEqual, Value: &MatchValue{Raw: "bar"}},
			err:      "",
		},
		"Backtick Quoted Value (Not Equal)": {
			input:    "foo != `bar`",
			expected: &MatchExpression{Selector: Selector{"foo"}, Operator: MatchNotEqual, Value: &MatchValue{Raw: "bar"}},
			err:      "",
		},
		"Backtick Quoted Value (In)": {
			input:    "`foo` in bar",
			expected: &MatchExpression{Selector: Selector{"bar"}, Operator: MatchIn, Value: &MatchValue{Raw: "foo"}},
			err:      "",
		},
		"Backtick Quoted Value (Not In)": {
			input:    "`foo` not in bar",
			expected: &MatchExpression{Selector: Selector{"bar"}, Operator: MatchNotIn, Value: &MatchValue{Raw: "foo"}},
			err:      "",
		},
		// This is standard boolean expression precedence
		//
		// 1 - not
		// 2 - and
		// 3 - or
		"Logical Operator Precedence": {
			input: "x in foo and not str == something or list is empty",
			expected: &BinaryExpression{
				Operator: BinaryOpOr,
				Left: &BinaryExpression{
					Operator: BinaryOpAnd,
					Left:     &MatchExpression{Selector: Selector{"foo"}, Operator: MatchIn, Value: &MatchValue{Raw: "x"}},
					Right: &UnaryExpression{
						Operator: UnaryOpNot,
						Operand:  &MatchExpression{Selector: Selector{"str"}, Operator: MatchEqual, Value: &MatchValue{Raw: "something"}},
					},
				},
				Right: &MatchExpression{Selector: Selector{"list"}, Operator: MatchIsEmpty, Value: nil},
			},
			err: "",
		},
		// not in the absence of parentheses would normally get applied
		// to a MatchExpr
		//
		// or operators normal are the last to be applied but here they
		// happen earlier
		"Logical Operator Precedence (Parenthesized)": {
			input: "x in foo and not (str == something or list is empty)",
			expected: &BinaryExpression{
				Operator: BinaryOpAnd,
				Left:     &MatchExpression{Selector: Selector{"foo"}, Operator: MatchIn, Value: &MatchValue{Raw: "x"}},
				Right: &UnaryExpression{
					Operator: UnaryOpNot,
					Operand: &BinaryExpression{
						Operator: BinaryOpOr,
						Left:     &MatchExpression{Selector: Selector{"str"}, Operator: MatchEqual, Value: &MatchValue{Raw: "something"}},
						Right:    &MatchExpression{Selector: Selector{"list"}, Operator: MatchIsEmpty, Value: nil},
					},
				},
			},
			err: "",
		},
		"Extra Whitespace (Equal)": {
			input:    "\t\r\n  foo \t\r\n == \t\r\n x \t\r\n",
			expected: &MatchExpression{Selector: Selector{"foo"}, Operator: MatchEqual, Value: &MatchValue{Raw: "x"}},
			err:      "",
		},
		"Extra Whitespace (Not Equal)": {
			input:    "\t\r\n  foo \t\r\n != \t\r\n x \t\r\n",
			expected: &MatchExpression{Selector: Selector{"foo"}, Operator: MatchNotEqual, Value: &MatchValue{Raw: "x"}},
			err:      "",
		},
		"Extra Whitespace (In)": {
			input:    "\t\r\n  foo \t\r\n in \t\r\n x \t\r\n",
			expected: &MatchExpression{Selector: Selector{"x"}, Operator: MatchIn, Value: &MatchValue{Raw: "foo"}},
			err:      "",
		},
		"Extra Whitespace (Not In)": {
			input:    "\t\r\n  foo \t\r\n not \t\r\n in \t\r\n x \t\r\n",
			expected: &MatchExpression{Selector: Selector{"x"}, Operator: MatchNotIn, Value: &MatchValue{Raw: "foo"}},
			err:      "",
		},
		"Extra Whitespace (Is Empty)": {
			input:    "\t\r\n  foo \t\r\n is \t\r\n empty \t\r\n",
			expected: &MatchExpression{Selector: Selector{"foo"}, Operator: MatchIsEmpty, Value: nil},
			err:      "",
		},
		"Extra Whitespace (Is Not Empty)": {
			input:    "\t\r\n  foo \t\r\n is \t\r\n not \t\r\n empty \t\r\n",
			expected: &MatchExpression{Selector: Selector{"foo"}, Operator: MatchIsNotEmpty, Value: nil},
			err:      "",
		},
		"Extra Whitespace (Not)": {
			input: "\t\r\n not \t\r\n  foo \t\r\n in \t\r\n x \t\r\n",
			expected: &UnaryExpression{
				Operator: UnaryOpNot,
				Operand:  &MatchExpression{Selector: Selector{"x"}, Operator: MatchIn, Value: &MatchValue{Raw: "foo"}},
			},
			err: "",
		},
		"Extra Whitespace (And)": {
			input: "\t\r\n foo \t\r\n == \t\r\n x \t\r\n and \t\r\n y \t\r\n is \t\r\n empty \t\r\n",
			expected: &BinaryExpression{
				Operator: BinaryOpAnd,
				Left:     &MatchExpression{Selector: Selector{"foo"}, Operator: MatchEqual, Value: &MatchValue{Raw: "x"}},
				Right:    &MatchExpression{Selector: Selector{"y"}, Operator: MatchIsEmpty, Value: nil},
			},
			err: "",
		},
		"Extra Whitespace (Or)": {
			input: "\t\r\n foo \t\r\n == \t\r\n x \t\r\n or \t\r\n y \t\r\n is \t\r\n empty \t\r\n",
			expected: &BinaryExpression{
				Operator: BinaryOpOr,
				Left:     &MatchExpression{Selector: Selector{"foo"}, Operator: MatchEqual, Value: &MatchValue{Raw: "x"}},
				Right:    &MatchExpression{Selector: Selector{"y"}, Operator: MatchIsEmpty, Value: nil},
			},
			err: "",
		},
		"Extra Whitespace (Parentheses)": {
			input:    "\t\r\n ( \t\r\n foo \t\r\n == \t\r\n x \t\r\n ) \t\r\n",
			expected: &MatchExpression{Selector: Selector{"foo"}, Operator: MatchEqual, Value: &MatchValue{Raw: "x"}},
			err:      "",
		},
		"Selector Path": {
			input:    "`environment` in foo.bar[\"meta\"].tags[\t`ENV` ]",
			expected: &MatchExpression{Selector: Selector{"foo", "bar", "meta", "tags", "ENV"}, Operator: MatchIn, Value: &MatchValue{Raw: "environment"}},
			err:      "",
		},
		"Selector All Indexes": {
			input:    `environment in foo["bar"]["meta"]["tags"]["ENV"]`,
			expected: &MatchExpression{Selector: Selector{"foo", "bar", "meta", "tags", "ENV"}, Operator: MatchIn, Value: &MatchValue{Raw: "environment"}},
			err:      "",
		},
		"Selector All Dotted": {
			input:    "environment in foo.bar.meta.tags.ENV",
			expected: &MatchExpression{Selector: Selector{"foo", "bar", "meta", "tags", "ENV"}, Operator: MatchIn, Value: &MatchValue{Raw: "environment"}},
			err:      "",
		},
		// selectors can contain almost any character set when index expressions are used
		// This includes whitespace, hyphens, unicode, etc.
		"Selector Index Chars": {
			input:    "environment in foo[\"abc-def ghi åß∂ƒ\"]",
			expected: &MatchExpression{Selector: Selector{"foo", "abc-def ghi åß∂ƒ"}, Operator: MatchIn, Value: &MatchValue{Raw: "environment"}},
			err:      "",
		},
		"Unterminated String Literal 1": {
			input:    "foo == \"12x",
			expected: nil,
			err:      "1:12 (11): rule \"string\": Unterminated string literal",
		},
		"Unterminated String Literal 2": {
			input:    "foo == `12x",
			expected: nil,
			err:      "1:12 (11): rule \"string\": Unterminated string literal",
		},
		"Invalid Number": {
			input:    "foo == 3x",
			expected: nil,
			err:      "1:9 (8): rule \"number\": Invalid number literal",
		},
		"Invalid Index Key": {
			input:    "foo[3] == abc",
			expected: nil,
			err:      "1:5 (4): rule \"index\": Invalid index",
		},
		"Unclosed Index Expression 1": {
			input:    "x in foo[\"abc\"",
			expected: nil,
			err:      "1:15 (14): rule \"index\": Unclosed index expression",
		},
		"Unclosed Index Expression 2": {
			input:    "foo[\"abc\" == 3",
			expected: nil,
			err:      "1:11 (10): rule \"index\": Unclosed index expression",
		},
		"Invalid Selector 1": {
			input:    "x in 32",
			expected: nil,
			err:      "1:6 (5): rule \"match\": Invalid selector",
		},
		"Invalid Selector 2": {
			input:    "32 == 32",
			expected: nil,
			err:      `1:4 (3): no match found, expected: "in", "not" or [ \t\r\n]`,
		},
		"Invalid Selector 3": {
			input:    "32 is empty",
			expected: nil,
			err:      `1:4 (3): no match found, expected: "in", "not" or [ \t\r\n]`,
		},
		"Junk at the end 1": {
			input:    "x in foo abc",
			expected: nil,
			err:      `1:10 (9): no match found, expected: "and", "or", [ \t\r\n] or EOF`,
		},
		"Junk at the end 2": {
			input:    "x in foo and ",
			expected: nil,
			err:      "1:14 (13): no match found, expected: \"(\", \"-\", \"0\", \"\\\"\", \"`\", \"not\", [ \\t\\r\\n], [1-9] or [a-zA-Z]",
		},
		"Junk at the end 3": {
			input:    "x in foo or ",
			expected: nil,
			err:      "1:13 (12): no match found, expected: \"(\", \"-\", \"0\", \"\\\"\", \"`\", \"not\", [ \\t\\r\\n], [1-9] or [a-zA-Z]",
		},
		"Junk at the end 4": {
			input:    "x in foo or not ",
			expected: nil,
			err:      "1:17 (16): no match found, expected: \"!=\", \"(\", \"-\", \"0\", \"==\", \"\\\"\", \"`\", \"contains\", \"in\", \"is\", \"matches\", \"not\", [ \\t\\r\\n], [1-9] or [a-zA-Z]",
		},
		"Float Literal 1": {
			input:    "foo == 0.2",
			expected: &MatchExpression{Selector: Selector{"foo"}, Operator: MatchEqual, Value: &MatchValue{Raw: "0.2"}},
			err:      "",
		},
		"Float Literal 2": {
			input:    "foo == 11.11",
			expected: &MatchExpression{Selector: Selector{"foo"}, Operator: MatchEqual, Value: &MatchValue{Raw: "11.11"}},
			err:      "",
		},
		"Negative Float": {
			input:    "foo == -0.2",
			expected: &MatchExpression{Selector: Selector{"foo"}, Operator: MatchEqual, Value: &MatchValue{Raw: "-0.2"}},
			err:      "",
		},
		"Unmatched Parentheses": {
			input:    "(foo == 4",
			expected: nil,
			err:      "1:10 (9): rule \"grouping\": Unmatched parentheses",
		},
		"Double Not": {
			input:    "not not foo == 3",
			expected: &MatchExpression{Selector: Selector{"foo"}, Operator: MatchEqual, Value: &MatchValue{Raw: "3"}},
			err:      "",
		},
		"Complex": {
			input: "(((foo == 3) and (not ((bar in baz) and (not (one != two))))) or (((next is empty) and (not (foo is not empty))) and (bar not in foo)))",
			expected: &BinaryExpression{
				Operator: BinaryOpOr,
				Left: &BinaryExpression{
					Operator: BinaryOpAnd,
					Left:     &MatchExpression{Selector: Selector{"foo"}, Operator: MatchEqual, Value: &MatchValue{Raw: "3"}},
					Right: &UnaryExpression{
						Operator: UnaryOpNot,
						Operand: &BinaryExpression{
							Operator: BinaryOpAnd,
							Left:     &MatchExpression{Selector: Selector{"baz"}, Operator: MatchIn, Value: &MatchValue{Raw: "bar"}},
							Right: &UnaryExpression{
								Operator: UnaryOpNot,
								Operand:  &MatchExpression{Selector: Selector{"one"}, Operator: MatchNotEqual, Value: &MatchValue{Raw: "two"}},
							},
						},
					},
				},
				Right: &BinaryExpression{
					Operator: BinaryOpAnd,
					Left: &BinaryExpression{
						Operator: BinaryOpAnd,
						Left:     &MatchExpression{Selector: Selector{"next"}, Operator: MatchIsEmpty, Value: nil},
						Right: &UnaryExpression{
							Operator: UnaryOpNot,
							Operand:  &MatchExpression{Selector: Selector{"foo"}, Operator: MatchIsNotEmpty, Value: nil},
						},
					},
					Right: &MatchExpression{Selector: Selector{"foo"}, Operator: MatchNotIn, Value: &MatchValue{Raw: "bar"}},
				},
			},
			err: "",
		},
	}

	for name, tcase := range tests {
		tcase := tcase
		name := name
		t.Run(name, func(t *testing.T) {
			t.Parallel()

			raw, err := Parse("", []byte(tcase.input))
			if tcase.err != "" {
				require.Error(t, err)
				require.EqualError(t, err, tcase.err)
				require.Nil(t, raw)
			} else {
				require.NoError(t, err)
				require.NotNil(t, raw)
				require.Equal(t, tcase.expected, raw)
			}
		})
	}
}

func BenchmarkExpressionParsing(b *testing.B) {
	benchmarks := map[string]string{
		"Equals":                "foo == 3",
		"Not Equals":            "foo != 3",
		"In":                    "foo in bar",
		"Not In":                "foo not in bar",
		"Contains":              "bar not contains foo",
		"Not Contains":          "bar not contains foo",
		"Is Empty":              "foo is empty",
		"Is Not Empty":          "foo is not empty",
		"Not In Or Equals":      "foo not in bar or bar.foo == 3",
		"In And Not Equals":     "foo in bar and bar.foo != \"\"",
		"Not Equals And Equals": "not (foo == 3 and bar == 4)",
		"Matches":               "foo matches bar",
		"Not Matches":           "foo not matches bar",
		"Big Selectors":         "abcdefghijklmnopqrstuvwxyz.foo.bar.baz.one.two.three.four.five.six.seven.eight.nine.ten == 42",
		"Many Ors":              "foo == 3 or bar in baz or one != two or next is empty or other is not empty or name == \"\"",
		"Lots of Ops":           "foo == 3 and not bar in baz and not one != two or next is empty and not foo is not empty and bar not in foo",
		"Lots of Parens":        "(((foo == 3) and (not ((bar in baz) and (not (one != two))))) or (((next is empty) and (not (foo is not empty))) and (bar not in foo)))",
	}
	for name, bm := range benchmarks {
		b.Run(name, func(b *testing.B) {
			for i := 0; i < b.N; i++ {
				expr, err := Parse("", []byte(bm))
				// this extra verification does add roughly 2k-3k ns/op to each iteration
				// we could disable it but its good to also have these checks to ensure the parser is working for some of the crazier inputs here
				require.NoError(b, err)
				require.NotNil(b, expr)
			}
		})
	}
}