{{ message }}
Repository navigation
Expand file tree
/
Copy pathjson_path_locator_improvements_test.go
More file actions
570 lines (525 loc) · 15.3 KB
/
Copy pathjson_path_locator_improvements_test.go
File metadata and controls
570 lines (525 loc) · 15.3 KB
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
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
//go:build !integration
package parser
import (
"strings"
"testing"
"github.com/santhosh-tekuri/jsonschema/v6"
"github.com/santhosh-tekuri/jsonschema/v6/kind"
)
func TestExtractAdditionalPropertyNames(t *testing.T) {
tests := []struct {
name string
errorMessage string
expected []string
}{
{
name: "single additional property",
errorMessage: "at '': additional properties 'invalid_key' not allowed",
expected: []string{"invalid_key"},
},
{
name: "multiple additional properties",
errorMessage: "at '': additional properties 'invalid_prop', 'another_invalid' not allowed",
expected: []string{"invalid_prop", "another_invalid"},
},
{
name: "single property with different format",
errorMessage: "additional property 'bad_field' not allowed",
expected: []string{"bad_field"},
},
{
name: "no additional properties in message",
errorMessage: "at '/age': got string, want number",
expected: []string{},
},
{
name: "empty message",
errorMessage: "",
expected: []string{},
},
{
name: "complex property names",
errorMessage: "additional properties 'invalid-prop', 'another_bad_one', 'third.prop' not allowed",
expected: []string{"invalid-prop", "another_bad_one", "third.prop"},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result := extractAdditionalPropertyNames(tt.errorMessage)
if len(result) != len(tt.expected) {
t.Errorf("Expected %d properties, got %d: %v", len(tt.expected), len(result), result)
return
}
for i, expected := range tt.expected {
if i >= len(result) || result[i] != expected {
t.Errorf("Expected property %d to be '%s', got '%s'", i, expected, result[i])
}
}
})
}
}
func TestFindFirstAdditionalProperty(t *testing.T) {
yamlContent := `name: John Doe
age: 30
invalid_prop: value
tools:
- name: tool1
another_bad: value2
permissions:
read: true
invalid_perm: write`
tests := []struct {
name string
propertyNames []string
expectedLine int
expectedCol int
shouldFind bool
}{
{
name: "find first property",
propertyNames: []string{"invalid_prop", "another_bad"},
expectedLine: 3,
expectedCol: 1,
shouldFind: true,
},
{
name: "find second property when first not found",
propertyNames: []string{"not_exist", "another_bad"},
expectedLine: 6,
expectedCol: 1,
shouldFind: true,
},
{
name: "property not found",
propertyNames: []string{"nonexistent", "also_missing"},
expectedLine: 1,
expectedCol: 1,
shouldFind: false,
},
{
name: "nested property found",
propertyNames: []string{"invalid_perm"},
expectedLine: 9,
expectedCol: 3, // Indented
shouldFind: true,
},
{
name: "empty property list",
propertyNames: []string{},
expectedLine: 1,
expectedCol: 1,
shouldFind: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
location := findFirstAdditionalProperty(yamlContent, tt.propertyNames)
if location.Found != tt.shouldFind {
t.Errorf("Expected Found=%v, got Found=%v", tt.shouldFind, location.Found)
}
if location.Line != tt.expectedLine {
t.Errorf("Expected Line=%d, got Line=%d", tt.expectedLine, location.Line)
}
if location.Column != tt.expectedCol {
t.Errorf("Expected Column=%d, got Column=%d", tt.expectedCol, location.Column)
}
})
}
}
func TestLocateJSONPathForPathInfoUsesAdditionalPropertiesErrorKind(t *testing.T) {
yamlContent := `on:
push:
branches: [main]
foobar: invalid`
info := JSONPathInfo{
Path: "/on",
Message: "this message is intentionally not parseable",
ErrorKind: &kind.AdditionalProperties{Properties: []string{"foobar"}},
}
location := LocateJSONPathForPathInfo(yamlContent, info)
if !location.Found {
t.Fatal("expected location to be found")
}
if location.Line != 4 || location.Column != 3 {
t.Fatalf("expected additional property location at line 4, col 3; got line %d, col %d", location.Line, location.Column)
}
}
func TestLocateJSONPathForPathInfoSkipsRegexForNonAdditionalPropertiesErrorKind(t *testing.T) {
yamlContent := `on:
push:
branches: [main]
foobar: invalid`
info := JSONPathInfo{
Path: "/on",
Message: "at '/on': additional properties 'foobar' not allowed",
ErrorKind: &kind.Type{},
}
location := LocateJSONPathForPathInfo(yamlContent, info)
expected := LocateJSONPathInYAML(yamlContent, "/on")
if location != expected {
t.Fatalf("expected fallback to LocateJSONPathInYAML location %+v, got %+v", expected, location)
}
}
func TestLocateJSONPathForPathInfoUsesGroupCausesForAdditionalProperties(t *testing.T) {
yamlContent := `on:
push:
branches: [main]
foobar: invalid`
info := JSONPathInfo{
Path: "/on",
Message: "this message is intentionally not parseable",
ErrorKind: &kind.Group{},
Causes: []*jsonschema.ValidationError{
{ErrorKind: &kind.AdditionalProperties{Properties: []string{"foobar"}}},
},
}
location := LocateJSONPathForPathInfo(yamlContent, info)
if !location.Found {
t.Fatal("expected location to be found")
}
if location.Line != 4 || location.Column != 3 {
t.Fatalf("expected additional property location at line 4, col 3; got line %d, col %d", location.Line, location.Column)
}
}
func TestLocateJSONPathForPathInfoDoesNotRegexCompositeErrorKind(t *testing.T) {
yamlContent := `on:
push:
branches: [main]
foobar: invalid`
info := JSONPathInfo{
Path: "/on",
Message: "at '/on': additional properties 'foobar' not allowed",
ErrorKind: &kind.Group{},
}
location := LocateJSONPathForPathInfo(yamlContent, info)
expected := LocateJSONPathInYAML(yamlContent, "/on")
if location != expected {
t.Fatalf("expected fallback to LocateJSONPathInYAML location %+v, got %+v", expected, location)
}
}
func TestLocateJSONPathForPathInfoUsesNestedAdditionalPropertiesErrorKind(t *testing.T) {
yamlContent := `on:
push:
branches: [main]
foobar: invalid`
info := JSONPathInfo{
Path: "/on",
Message: "this message is intentionally not parseable",
ErrorKind: &kind.OneOf{},
Causes: []*jsonschema.ValidationError{
{
ErrorKind: &kind.Group{},
Causes: []*jsonschema.ValidationError{
{ErrorKind: &kind.AdditionalProperties{Properties: []string{"foobar"}}},
},
},
{ErrorKind: &kind.Type{}},
},
}
location := LocateJSONPathForPathInfo(yamlContent, info)
if !location.Found {
t.Fatal("expected location to be found")
}
if location.Line != 4 || location.Column != 3 {
t.Fatalf("expected additional property location at line 4, col 3; got line %d, col %d", location.Line, location.Column)
}
}
func TestLocateJSONPathForPathInfoUsesReferencedAdditionalPropertiesErrorKind(t *testing.T) {
yamlContent := `safe-outputs:
create-discussion:
missing-tool:
create-discussion: true`
info := JSONPathInfo{
Path: "/safe-outputs/missing-tool",
Message: "this message is intentionally not parseable",
ErrorKind: &kind.Reference{Keyword: "$ref"},
Causes: []*jsonschema.ValidationError{{
ErrorKind: &kind.OneOf{},
Causes: []*jsonschema.ValidationError{{
ErrorKind: &kind.AdditionalProperties{Properties: []string{"create-discussion"}},
}},
}},
}
location := LocateJSONPathForPathInfo(yamlContent, info)
if !location.Found || location.Line != 4 || location.Column != 5 {
t.Fatalf("expected referenced additional property at line 4, col 5; got %+v", location)
}
}
// TestNestedSearchOptimization demonstrates the improved approach of searching within sub-YAML content
func TestNestedSearchOptimization(t *testing.T) {
// Create a complex YAML with many sections to demonstrate the optimization benefit
yamlContent := `name: Complex Workflow
version: "1.0"
# Many top-level properties that should be ignored when searching in nested contexts
global_prop1: value1
global_prop2: value2
global_prop3: value3
global_prop4: value4
global_prop5: value5
on:
push:
branches: [main, develop]
pull_request:
branches: [main]
# This is the problematic additional property within the 'on' context
invalid_trigger: not_allowed
workflow_dispatch: {}
permissions:
contents: read
issues: write
# Another additional property within the 'permissions' context
invalid_permission: write
workflow:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
deeply:
nested:
structure:
with:
many: levels
# Additional property deep in the structure
bad_prop: invalid
valid_prop: good
# More global properties that should be ignored
footer_prop1: value1
footer_prop2: value2`
tests := []struct {
name string
jsonPath string
errorMessage string
expectedLine int
expectedCol int
shouldFind bool
}{
{
name: "find additional property in 'on' section - should not find global properties",
jsonPath: "/on",
errorMessage: "at '/on': additional properties 'invalid_trigger' not allowed",
expectedLine: 15, // Line where 'invalid_trigger' is located
expectedCol: 3, // Column position of 'invalid_trigger' (indented)
shouldFind: true,
},
{
name: "find additional property in 'permissions' section - should not find on.invalid_trigger",
jsonPath: "/permissions",
errorMessage: "at '/permissions': additional properties 'invalid_permission' not allowed",
expectedLine: 21, // Line where 'invalid_permission' is located
expectedCol: 3, // Column position of 'invalid_permission' (indented)
shouldFind: true,
},
{
name: "find additional property in deeply nested structure",
jsonPath: "/deeply/nested/structure/with",
errorMessage: "at '/deeply/nested/structure/with': additional properties 'bad_prop' not allowed",
expectedLine: 32, // Line where 'bad_prop' is located
expectedCol: 9, // Column position accounting for deep indentation (4 levels * 2 spaces + 1)
shouldFind: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
location := LocateJSONPathForPathInfo(yamlContent, JSONPathInfo{Path: tt.jsonPath, Message: tt.errorMessage})
if location.Found != tt.shouldFind {
t.Errorf("Expected Found=%v, got Found=%v", tt.shouldFind, location.Found)
}
if location.Line != tt.expectedLine {
t.Errorf("Expected Line=%d, got Line=%d", tt.expectedLine, location.Line)
}
if location.Column != tt.expectedCol {
t.Errorf("Expected Column=%d, got Column=%d", tt.expectedCol, location.Column)
}
// Verify that the optimization correctly identified the target property
// by checking that the found location actually contains the expected property name
lines := strings.Split(yamlContent, "\n")
if location.Found && location.Line > 0 && location.Line <= len(lines) {
foundLine := lines[location.Line-1] // Convert to 0-based index
propertyNames := extractAdditionalPropertyNames(tt.errorMessage)
if len(propertyNames) > 0 {
expectedProperty := propertyNames[0]
if !strings.Contains(foundLine, expectedProperty) {
t.Errorf("Found line '%s' does not contain expected property '%s'",
strings.TrimSpace(foundLine), expectedProperty)
}
}
}
})
}
}
func TestFindFrontmatterBounds(t *testing.T) {
tests := []struct {
name string
lines []string
expectedStartIdx int
expectedEndIdx int
expectedFrontmatterLines int
}{
{
name: "normal frontmatter",
lines: []string{
"---",
"name: test",
"age: 30",
"---",
"# Markdown content",
},
expectedStartIdx: 0,
expectedEndIdx: 3,
expectedFrontmatterLines: 2,
},
{
name: "frontmatter with comments before",
lines: []string{
"# Comment at top",
"",
"---",
"name: test",
"---",
"Content",
},
expectedStartIdx: 2,
expectedEndIdx: 4,
expectedFrontmatterLines: 1,
},
{
name: "no frontmatter",
lines: []string{
"# Just a markdown file",
"Some content",
},
expectedStartIdx: -1,
expectedEndIdx: -1,
expectedFrontmatterLines: 0,
},
{
name: "incomplete frontmatter (no closing)",
lines: []string{
"---",
"name: test",
"Some content without closing",
},
expectedStartIdx: -1,
expectedEndIdx: -1,
expectedFrontmatterLines: 0,
},
{
name: "empty frontmatter",
lines: []string{
"---",
"---",
"Content",
},
expectedStartIdx: 0,
expectedEndIdx: 1,
expectedFrontmatterLines: 0,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
startIdx, endIdx, frontmatterContent := findFrontmatterBounds(tt.lines)
if startIdx != tt.expectedStartIdx {
t.Errorf("Expected startIdx=%d, got startIdx=%d", tt.expectedStartIdx, startIdx)
}
if endIdx != tt.expectedEndIdx {
t.Errorf("Expected endIdx=%d, got endIdx=%d", tt.expectedEndIdx, endIdx)
}
// Count the lines in frontmatterContent
actualLines := 0
if frontmatterContent != "" {
actualLines = len(strings.Split(frontmatterContent, "\n"))
}
if actualLines != tt.expectedFrontmatterLines {
t.Errorf("Expected %d frontmatter lines, got %d", tt.expectedFrontmatterLines, actualLines)
}
})
}
}
func TestMatchesPathSegmentKey(t *testing.T) {
tests := []struct {
name string
trimmedLine string
key string
expected bool
}{
{
name: "exact match with colon",
trimmedLine: "engine: copilot",
key: "engine",
expected: true,
},
{
name: "match with space before colon",
trimmedLine: "engine :",
key: "engine",
expected: true,
},
{
name: "match with tab before colon",
trimmedLine: "engine\t: value",
key: "engine",
expected: true,
},
{
name: "prefix collision - longer key must not match",
trimmedLine: "engine-type: fast",
key: "engine",
expected: false,
},
{
name: "different key",
trimmedLine: "other: value",
key: "engine",
expected: false,
},
{
name: "empty trimmedLine",
trimmedLine: "",
key: "engine",
expected: false,
},
{
name: "key with dot (regex metacharacter) matches literal dot",
trimmedLine: "on.push: value",
key: "on.push",
expected: true,
},
{
name: "key with dot does not match different separator",
trimmedLine: "onXpush: value",
key: "on.push",
expected: false,
},
{
name: "key with plus (regex metacharacter)",
trimmedLine: "a+b: value",
key: "a+b",
expected: true,
},
{
name: "key with brackets (regex metacharacter)",
trimmedLine: "items[0]: value",
key: "items[0]",
expected: true,
},
{
name: "colon-only line after key",
trimmedLine: "engine:",
key: "engine",
expected: true,
},
{
name: "no colon at all",
trimmedLine: "engine value",
key: "engine",
expected: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result := matchesPathSegmentKey(tt.trimmedLine, tt.key)
if result != tt.expected {
t.Errorf("matchesPathSegmentKey(%q, %q) = %v, want %v", tt.trimmedLine, tt.key, result, tt.expected)
}
})
}
}
You can’t perform that action at this time.