-
Notifications
You must be signed in to change notification settings - Fork 61
/
parse.go
364 lines (319 loc) · 8.76 KB
/
parse.go
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
//
// Copyright 2020 New Relic Corporation. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
//
package integration
import (
"bufio"
"bytes"
"errors"
"fmt"
"net/http"
"os"
"path/filepath"
"strings"
"unicode"
)
var (
Directives = map[string]func(*Test, []byte) error{
"ENVIRONMENT": parseEnv,
"HEADERS": parseHeaders,
"SKIPIF": parseRawSkipIf,
"INI": parseSettings,
"PHPMODULES": parsePHPModules,
"CONFIG": parseConfig,
"DESCRIPTION": parseDescription,
"EXPECT_ANALYTICS_EVENTS": parseAnalyticEvents,
"EXPECT_CUSTOM_EVENTS": parseCustomEvents,
"EXPECT_ERROR_EVENTS": parseErrorEvents,
"EXPECT_SPAN_EVENTS": parseSpanEvents,
"EXPECT_SPAN_EVENTS_LIKE": parseSpanEventsLike,
"EXPECT_LOG_EVENTS": parseLogEvents,
"EXPECT_METRICS": parseMetrics,
"EXPECT_METRICS_EXIST": parseMetricsExist,
"EXPECT_METRICS_DONT_EXIST": parseMetricsDontExist,
"EXPECT": parseExpect,
"EXPECT_REGEX": parseExpectRegex,
"EXPECT_SCRUBBED": parseExpectScrubbed,
"EXPECT_HARVEST": parseExpectHarvest,
"EXPECT_SLOW_SQLS": parseSlowSQLs,
"EXPECT_TRACED_ERRORS": parseTracedErrors,
"EXPECT_TXN_TRACES": parseTxnTraces,
"EXPECT_RESPONSE_HEADERS": parseResponseHeaders,
"EXPECT_PHP_PACKAGES": parsePhpPackages,
"XFAIL": parseXFail,
}
)
func ParseTestFile(name string) *Test {
test := NewTest(name)
test.Path, _ = filepath.Abs(name)
if test.IsC() {
return parseCTestFile(test)
} else if test.IsPHP() {
return parsePHPTestFile(test)
} else {
return nil
}
}
func parsePHPTestFile(test *Test) *Test {
f, err := os.Open(test.Name)
if err != nil {
test.Fatal(err)
return test
}
defer f.Close()
scanner := bufio.NewScanner(f)
buf := make([]byte, 0, 64*1024)
scanner.Buffer(buf, 1024*1024)
scanner.Split(splitDirectives)
for scanner.Scan() {
p := scanner.Text()
// First non-word character marks the end of the directive.
i := strings.IndexFunc(p, func(r rune) bool {
return r != '_' && !unicode.IsDigit(r) && !unicode.IsLetter(r)
})
if i < 1 {
continue // Ignore comments not starting with a directive.
}
keyword := p[:i]
content := []byte(p[i:])
parseFn := Directives[keyword]
if nil == parseFn {
test.Fatal(fmt.Errorf("directive '%s' not supported", keyword))
return test
}
if err := parseFn(test, content); err != nil {
test.Fatal(fmt.Errorf("parsing '%s' direction failure: %v", keyword, err))
return test
}
}
if err := scanner.Err(); err != nil {
test.Fatal(fmt.Errorf("parsing scanner failure: %v", err))
}
return test
}
func parseRawSkipIf(t *Test, content []byte) error {
trimmed := bytes.TrimSpace(content)
t.rawSkipIf = make([]byte, len(trimmed))
copy(t.rawSkipIf, trimmed)
return nil
}
func parseEnv(t *Test, content []byte) error {
env := make(map[string]string)
for _, line := range bytes.Split(content, []byte("\n")) {
trimmed := bytes.TrimSpace(line)
if len(trimmed) == 0 {
continue
}
var key, value string
kv := bytes.SplitN(trimmed, []byte("="), 2)
key = string(bytes.TrimSpace(kv[0]))
if len(kv) == 2 {
value = string(bytes.TrimSpace(kv[1]))
}
if key == "" {
return errors.New("invalid environment variable format")
}
env[key] = value
}
t.Env = env
return nil
}
func parseHeaders(t *Test, content []byte) error {
t.headers = make(http.Header)
trimmed := bytes.TrimSpace(content)
hs := strings.Fields(string(trimmed))
for _, h := range hs {
// must allow: X-Request-Start=t=1368811467146000
keyval := strings.SplitN(h, "=", 2)
if len(keyval) == 2 {
t.headers.Set(keyval[0], keyval[1])
}
}
return nil
}
func parseResponseHeaders(t *Test, content []byte) error {
t.expectResponseHeaders = make(http.Header)
trimmed := bytes.TrimSpace(content)
hs := strings.Fields(string(trimmed))
for _, h := range hs {
keyval := strings.SplitN(h, "=", 2)
if len(keyval) == 2 {
t.expectResponseHeaders.Add(keyval[0], keyval[1])
}
}
return nil
}
var errBadSetting = errors.New("settings must have format NAME=VALUE")
func parseSettings(t *Test, content []byte) error {
trimmed := bytes.TrimSpace(content)
settings := make(map[string]string)
scanner := bufio.NewScanner(bytes.NewReader(trimmed))
delim := []byte("=")
for scanner.Scan() {
parts := bytes.SplitN(scanner.Bytes(), delim, 2)
switch len(parts) {
case 2:
key, value := bytes.TrimSpace(parts[0]), bytes.TrimSpace(parts[1])
if len(key) > 0 {
settings[string(key)] = string(value)
} else {
return errBadSetting
}
case 1:
return errBadSetting
}
}
if err := scanner.Err(); err != nil {
return err
}
t.Settings = settings
return nil
}
func parsePHPModules(t *Test, content []byte) error {
trimmed := bytes.TrimSpace(content)
settings := make(map[string]string)
scanner := bufio.NewScanner(bytes.NewReader(trimmed))
delim := []byte("=")
for scanner.Scan() {
parts := bytes.SplitN(scanner.Bytes(), delim, 2)
switch len(parts) {
case 2:
key, value := bytes.TrimSpace(parts[0]), bytes.TrimSpace(parts[1])
if len(key) > 0 {
settings[string(key)] = string(value)
} else {
return errBadSetting
}
case 1:
return errBadSetting
}
}
if err := scanner.Err(); err != nil {
return err
}
t.PhpModules = settings
return nil
}
func parseAnalyticEvents(test *Test, content []byte) error {
test.analyticEvents = content
return nil
}
func parseCustomEvents(test *Test, content []byte) error {
test.customEvents = content
return nil
}
func parseErrorEvents(test *Test, content []byte) error {
test.errorEvents = content
return nil
}
func parseSpanEvents(test *Test, content []byte) error {
test.spanEvents = content
return nil
}
func parseSpanEventsLike(test *Test, content []byte) error {
test.spanEventsLike = content
return nil
}
func parseLogEvents(test *Test, content []byte) error {
test.logEvents = content
return nil
}
func parseMetrics(test *Test, content []byte) error {
test.metrics = content
return nil
}
func parseMetricsExist(test *Test, content []byte) error {
test.metricsExist = content
return nil
}
func parseMetricsDontExist(test *Test, content []byte) error {
test.metricsDontExist = content
return nil
}
func parseSlowSQLs(test *Test, content []byte) error {
test.slowSQLs = content
return nil
}
func parseTracedErrors(test *Test, content []byte) error {
test.tracedErrors = content
return nil
}
func parseTxnTraces(test *Test, content []byte) error {
test.txnTraces = content
return nil
}
func parseDescription(test *Test, content []byte) error {
test.Desc = string(bytes.TrimSpace(content))
return nil
}
func parseXFail(test *Test, content []byte) error {
test.Xfail = string(bytes.TrimSpace(content))
if test.Xfail == "" { // add a default comment incase test is missing a comment after XFAIL directive
test.Xfail = "expected failure"
}
return nil
}
func parseExpect(test *Test, content []byte) error {
test.expect = content
return nil
}
func parseExpectRegex(test *Test, content []byte) error {
test.expectRegex = bytes.TrimSpace(content)
return nil
}
func parseExpectScrubbed(test *Test, content []byte) error {
test.expectScrubbed = content
return nil
}
func parseExpectHarvest(test *Test, content []byte) error {
if "no" == strings.TrimSpace(string(content)) {
test.SetExpectHarvest(false)
}
return nil
}
func parseConfig(test *Test, content []byte) error {
test.Config = string(bytes.TrimSpace(content))
return nil
}
func parsePhpPackages(test *Test, content []byte) error {
// clean up provided string data if it is "null"
if "null" == strings.TrimSpace(string(content)) {
test.phpPackagesConfig = []byte("null")
return nil
}
test.phpPackagesConfig = content
return nil
}
var (
openComment = []byte("/*")
closeComment = []byte("*/")
)
// splitDirectives tokenizes the C-style comments which wrap the
// directives embedded in an integration test.
func splitDirectives(data []byte, atEOF bool) (advance int, token []byte, err error) {
if atEOF && len(data) == 0 {
return 0, nil, nil
}
openStart := bytes.Index(data, openComment)
if openStart == -1 {
// Check if a start delimiter may be straddling the buffer.
if data[len(data)-1] == '/' {
return len(data) - 1, nil, nil
}
return len(data), nil, nil
}
openStop := openStart + len(openComment)
commentLen := bytes.Index(data[openStop:], closeComment)
if commentLen == -1 {
if atEOF {
return len(data), nil, nil
}
// Not at EOF and end comment delimiter not found, advance to the
// start of the comment and request more data.
return openStart, nil, nil
}
closeStart := openStop + commentLen
closeStop := closeStart + len(closeComment)
return closeStop, data[openStop:closeStart], nil
}