-
Notifications
You must be signed in to change notification settings - Fork 501
Expand file tree
/
Copy pathsubmit_pr_review_footer_test.go
More file actions
737 lines (641 loc) · 26.1 KB
/
Copy pathsubmit_pr_review_footer_test.go
File metadata and controls
737 lines (641 loc) · 26.1 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
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
//go:build !integration
package workflow
import (
"encoding/json"
"strings"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestGetEffectiveFooterString(t *testing.T) {
t.Run("returns local footer when set", func(t *testing.T) {
local := "if-body"
result := getEffectiveFooterString(&local, nil)
require.NotNil(t, result, "Should return local footer")
assert.Equal(t, "if-body", *result, "Should return local footer value")
})
t.Run("local footer takes precedence over global", func(t *testing.T) {
local := "none"
globalTrue := true
result := getEffectiveFooterString(&local, &globalTrue)
require.NotNil(t, result, "Should return local footer")
assert.Equal(t, "none", *result, "Local should override global")
})
t.Run("converts global true to always", func(t *testing.T) {
globalTrue := true
result := getEffectiveFooterString(nil, &globalTrue)
require.NotNil(t, result, "Should convert global bool")
assert.Equal(t, "always", *result, "Global true should map to always")
})
t.Run("converts global false to none", func(t *testing.T) {
globalFalse := false
result := getEffectiveFooterString(nil, &globalFalse)
require.NotNil(t, result, "Should convert global bool")
assert.Equal(t, "none", *result, "Global false should map to none")
})
t.Run("returns nil when both are nil", func(t *testing.T) {
result := getEffectiveFooterString(nil, nil)
assert.Nil(t, result, "Should return nil when neither is set")
})
}
func TestSubmitPRReviewFooterConfig(t *testing.T) {
t.Run("parses footer string values", func(t *testing.T) {
testCases := []struct {
name string
value string
expected string
}{
{name: "always", value: "always", expected: "always"},
{name: "none", value: "none", expected: "none"},
{name: "if-body", value: "if-body", expected: "if-body"},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"submit-pull-request-review": map[string]any{
"footer": tc.value,
},
}
config := compiler.parseSubmitPullRequestReviewConfig(outputMap)
require.NotNil(t, config, "Config should be parsed")
require.NotNil(t, config.Footer, "Footer should be set")
assert.Equal(t, tc.expected, *config.Footer, "Footer value should match")
})
}
})
t.Run("parses footer boolean values", func(t *testing.T) {
testCases := []struct {
name string
value bool
expected string
}{
{name: "true maps to always", value: true, expected: "always"},
{name: "false maps to none", value: false, expected: "none"},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"submit-pull-request-review": map[string]any{
"footer": tc.value,
},
}
config := compiler.parseSubmitPullRequestReviewConfig(outputMap)
require.NotNil(t, config, "Config should be parsed")
require.NotNil(t, config.Footer, "Footer value should be set")
assert.Equal(t, tc.expected, *config.Footer, "Footer value should be mapped from boolean")
})
}
})
t.Run("ignores invalid footer values", func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"submit-pull-request-review": map[string]any{
"footer": "invalid-value",
},
}
config := compiler.parseSubmitPullRequestReviewConfig(outputMap)
require.NotNil(t, config, "Config should be parsed")
assert.Nil(t, config.Footer, "Invalid footer value should be ignored")
})
t.Run("footer not set when omitted", func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"submit-pull-request-review": map[string]any{
"max": 1,
},
}
config := compiler.parseSubmitPullRequestReviewConfig(outputMap)
require.NotNil(t, config, "Config should be parsed")
assert.Nil(t, config.Footer, "Footer should be nil when not configured")
})
t.Run("parses target field", func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"submit-pull-request-review": map[string]any{
"max": 1,
"target": "42",
},
}
config := compiler.parseSubmitPullRequestReviewConfig(outputMap)
require.NotNil(t, config, "Config should be parsed")
assert.Equal(t, "42", config.Target, "Target should be parsed")
})
t.Run("target empty when omitted", func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"submit-pull-request-review": map[string]any{
"max": 1,
},
}
config := compiler.parseSubmitPullRequestReviewConfig(outputMap)
require.NotNil(t, config, "Config should be parsed")
assert.Empty(t, config.Target, "Target should be empty when not configured")
})
t.Run("parses target-repo field", func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"submit-pull-request-review": map[string]any{
"max": 1,
"target-repo": "consumer-org/consumer-repo",
},
}
config := compiler.parseSubmitPullRequestReviewConfig(outputMap)
require.NotNil(t, config, "Config should be parsed")
assert.Equal(t, "consumer-org/consumer-repo", config.TargetRepoSlug, "TargetRepoSlug should be parsed")
})
t.Run("target-repo empty when omitted", func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"submit-pull-request-review": map[string]any{
"max": 1,
},
}
config := compiler.parseSubmitPullRequestReviewConfig(outputMap)
require.NotNil(t, config, "Config should be parsed")
assert.Empty(t, config.TargetRepoSlug, "TargetRepoSlug should be empty when not configured")
})
t.Run("parses allowed-repos field", func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"submit-pull-request-review": map[string]any{
"max": 1,
"target-repo": "consumer-org/consumer-repo",
"allowed-repos": []any{"consumer-org/other-repo", "consumer-org/another-repo"},
},
}
config := compiler.parseSubmitPullRequestReviewConfig(outputMap)
require.NotNil(t, config, "Config should be parsed")
assert.Equal(t, []string{"consumer-org/other-repo", "consumer-org/another-repo"}, config.AllowedRepos, "AllowedRepos should be parsed")
})
t.Run("parses allowed-events field", func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"submit-pull-request-review": map[string]any{
"max": 1,
"allowed-events": []any{"COMMENT", "REQUEST_CHANGES"},
},
}
config := compiler.parseSubmitPullRequestReviewConfig(outputMap)
require.NotNil(t, config, "Config should be parsed")
assert.Equal(t, []string{"COMMENT", "REQUEST_CHANGES"}, config.AllowedEvents, "AllowedEvents should be parsed")
})
t.Run("parses allowed-events and normalizes to uppercase", func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"submit-pull-request-review": map[string]any{
"max": 1,
"allowed-events": []any{"comment", "approve"},
},
}
config := compiler.parseSubmitPullRequestReviewConfig(outputMap)
require.NotNil(t, config, "Config should be parsed")
assert.Equal(t, []string{"COMMENT", "APPROVE"}, config.AllowedEvents, "AllowedEvents should be normalized to uppercase")
})
t.Run("ignores invalid values in allowed-events when mixed with valid values", func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"submit-pull-request-review": map[string]any{
"max": 1,
"allowed-events": []any{"COMMENT", "INVALID_EVENT", "APPROVE"},
},
}
config := compiler.parseSubmitPullRequestReviewConfig(outputMap)
require.NotNil(t, config, "Config should be parsed when at least one valid event remains")
assert.Equal(t, []string{"COMMENT", "APPROVE"}, config.AllowedEvents, "Invalid events should be ignored while valid ones remain")
})
t.Run("returns nil when allowed-events contains only invalid values (fail closed)", func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"submit-pull-request-review": map[string]any{
"max": 1,
"allowed-events": []any{"INVALID_EVENT", "ANOTHER_BAD_VALUE"},
},
}
config := compiler.parseSubmitPullRequestReviewConfig(outputMap)
assert.Nil(t, config, "Config should be nil when all allowed-events values are invalid (fail closed)")
})
t.Run("returns nil when allowed-events is not a list (fail closed)", func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"submit-pull-request-review": map[string]any{
"max": 1,
"allowed-events": "COMMENT",
},
}
config := compiler.parseSubmitPullRequestReviewConfig(outputMap)
assert.Nil(t, config, "Config should be nil when allowed-events is not a list (fail closed)")
})
t.Run("allowed-events empty when omitted", func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"submit-pull-request-review": map[string]any{
"max": 1,
},
}
config := compiler.parseSubmitPullRequestReviewConfig(outputMap)
require.NotNil(t, config, "Config should be parsed")
assert.Empty(t, config.AllowedEvents, "AllowedEvents should be empty when not configured")
})
t.Run("parses supersede-older-reviews field", func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"submit-pull-request-review": map[string]any{
"max": 1,
"supersede-older-reviews": true,
},
}
config := compiler.parseSubmitPullRequestReviewConfig(outputMap)
require.NotNil(t, config, "Config should be parsed")
assert.True(t, config.SupersedeOlderReviews, "SupersedeOlderReviews should be parsed")
})
t.Run("parses all three valid event types in allowed-events", func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"submit-pull-request-review": map[string]any{
"max": 1,
"allowed-events": []any{"APPROVE", "COMMENT", "REQUEST_CHANGES"},
},
}
config := compiler.parseSubmitPullRequestReviewConfig(outputMap)
require.NotNil(t, config, "Config should be parsed")
assert.Equal(t, []string{"APPROVE", "COMMENT", "REQUEST_CHANGES"}, config.AllowedEvents, "All three event types should be parsed")
})
t.Run("returns nil for wildcard target-repo", func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"submit-pull-request-review": map[string]any{
"max": 1,
"target-repo": "*",
},
}
config := compiler.parseSubmitPullRequestReviewConfig(outputMap)
assert.Nil(t, config, "Config should be nil for wildcard target-repo")
})
}
func TestCreatePRReviewCommentNoFooter(t *testing.T) {
t.Run("create-pull-request-review-comment does not have footer field", func(t *testing.T) {
compiler := NewCompiler()
outputMap := map[string]any{
"create-pull-request-review-comment": map[string]any{
"side": "RIGHT",
},
}
config := compiler.parsePullRequestReviewCommentsConfig(outputMap)
require.NotNil(t, config, "Config should be parsed")
// CreatePullRequestReviewCommentsConfig no longer has a Footer field;
// footer control belongs on submit-pull-request-review
})
}
func TestSubmitPRReviewFooterInHandlerConfig(t *testing.T) {
t.Run("footer included in submit_pull_request_review handler config", func(t *testing.T) {
compiler := NewCompiler()
footerValue := "if-body"
workflowData := &WorkflowData{
Name: "Test",
SafeOutputs: &SafeOutputsConfig{
SubmitPullRequestReview: &SubmitPullRequestReviewConfig{
BaseSafeOutputConfig: BaseSafeOutputConfig{
Max: strPtr("1"),
Footer: &footerValue,
},
},
CreatePullRequestReviewComments: &CreatePullRequestReviewCommentsConfig{
BaseSafeOutputConfig: BaseSafeOutputConfig{Max: strPtr("10")},
Side: "RIGHT",
},
},
}
var steps []string
compiler.addHandlerManagerConfigEnvVar(&steps, workflowData)
require.NotEmpty(t, steps, "Steps should not be empty")
stepsContent := strings.Join(steps, "")
require.Contains(t, stepsContent, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG")
for _, step := range steps {
if strings.Contains(step, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG") {
parts := strings.Split(step, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: ")
if len(parts) == 2 {
jsonStr := strings.TrimSpace(parts[1])
jsonStr = strings.Trim(jsonStr, "\"")
jsonStr = strings.ReplaceAll(jsonStr, "\\\"", "\"")
var handlerConfig map[string]any
err := json.Unmarshal([]byte(jsonStr), &handlerConfig)
require.NoError(t, err, "Should unmarshal handler config")
submitConfig, ok := handlerConfig["submit_pull_request_review"].(map[string]any)
require.True(t, ok, "submit_pull_request_review config should exist")
assert.Equal(t, "if-body", submitConfig["footer"], "Footer should be in submit handler config")
// create_pull_request_review_comment should NOT have footer
reviewCommentConfig, ok := handlerConfig["create_pull_request_review_comment"].(map[string]any)
require.True(t, ok, "create_pull_request_review_comment config should exist")
_, hasFooter := reviewCommentConfig["footer"]
assert.False(t, hasFooter, "Footer should not be in review comment handler config")
}
}
}
})
t.Run("footer not in handler config when not set", func(t *testing.T) {
compiler := NewCompiler()
workflowData := &WorkflowData{
Name: "Test",
SafeOutputs: &SafeOutputsConfig{
SubmitPullRequestReview: &SubmitPullRequestReviewConfig{
BaseSafeOutputConfig: BaseSafeOutputConfig{Max: strPtr("1")},
},
},
}
var steps []string
compiler.addHandlerManagerConfigEnvVar(&steps, workflowData)
require.NotEmpty(t, steps, "Steps should not be empty")
stepsContent := strings.Join(steps, "")
require.Contains(t, stepsContent, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG")
for _, step := range steps {
if strings.Contains(step, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG") {
parts := strings.Split(step, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: ")
if len(parts) == 2 {
jsonStr := strings.TrimSpace(parts[1])
jsonStr = strings.Trim(jsonStr, "\"")
jsonStr = strings.ReplaceAll(jsonStr, "\\\"", "\"")
var handlerConfig map[string]any
err := json.Unmarshal([]byte(jsonStr), &handlerConfig)
require.NoError(t, err, "Should unmarshal handler config")
submitConfig, ok := handlerConfig["submit_pull_request_review"].(map[string]any)
require.True(t, ok, "submit_pull_request_review config should exist")
_, hasFooter := submitConfig["footer"]
assert.False(t, hasFooter, "Footer should not be in handler config when not set")
}
}
}
})
t.Run("target included in submit_pull_request_review handler config when set", func(t *testing.T) {
compiler := NewCompiler()
targetValue := "123"
workflowData := &WorkflowData{
Name: "Test",
SafeOutputs: &SafeOutputsConfig{
SubmitPullRequestReview: &SubmitPullRequestReviewConfig{
BaseSafeOutputConfig: BaseSafeOutputConfig{Max: strPtr("1")},
SafeOutputTargetConfig: SafeOutputTargetConfig{Target: targetValue},
},
},
}
var steps []string
compiler.addHandlerManagerConfigEnvVar(&steps, workflowData)
require.NotEmpty(t, steps, "Steps should not be empty")
stepsContent := strings.Join(steps, "")
require.Contains(t, stepsContent, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG")
for _, step := range steps {
if strings.Contains(step, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG") {
parts := strings.Split(step, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: ")
if len(parts) == 2 {
jsonStr := strings.TrimSpace(parts[1])
jsonStr = strings.Trim(jsonStr, "\"")
jsonStr = strings.ReplaceAll(jsonStr, "\\\"", "\"")
var handlerConfig map[string]any
err := json.Unmarshal([]byte(jsonStr), &handlerConfig)
require.NoError(t, err, "Should unmarshal handler config")
submitConfig, ok := handlerConfig["submit_pull_request_review"].(map[string]any)
require.True(t, ok, "submit_pull_request_review config should exist")
assert.Equal(t, "123", submitConfig["target"], "Target should be in submit handler config")
}
}
}
})
t.Run("target-repo included in submit_pull_request_review handler config when set", func(t *testing.T) {
compiler := NewCompiler()
workflowData := &WorkflowData{
Name: "Test",
SafeOutputs: &SafeOutputsConfig{
SubmitPullRequestReview: &SubmitPullRequestReviewConfig{
BaseSafeOutputConfig: BaseSafeOutputConfig{Max: strPtr("1")},
SafeOutputTargetConfig: SafeOutputTargetConfig{TargetRepoSlug: "consumer-org/consumer-repo"},
},
},
}
var steps []string
compiler.addHandlerManagerConfigEnvVar(&steps, workflowData)
require.NotEmpty(t, steps, "Steps should not be empty")
stepsContent := strings.Join(steps, "")
require.Contains(t, stepsContent, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG")
for _, step := range steps {
if strings.Contains(step, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG") {
parts := strings.Split(step, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: ")
if len(parts) == 2 {
jsonStr := strings.TrimSpace(parts[1])
jsonStr = strings.Trim(jsonStr, "\"")
jsonStr = strings.ReplaceAll(jsonStr, "\\\"", "\"")
var handlerConfig map[string]any
err := json.Unmarshal([]byte(jsonStr), &handlerConfig)
require.NoError(t, err, "Should unmarshal handler config")
submitConfig, ok := handlerConfig["submit_pull_request_review"].(map[string]any)
require.True(t, ok, "submit_pull_request_review config should exist")
assert.Equal(t, "consumer-org/consumer-repo", submitConfig["target-repo"], "Target-repo should be in submit handler config")
}
}
}
})
t.Run("allowed_events included in submit_pull_request_review handler config when set", func(t *testing.T) {
compiler := NewCompiler()
workflowData := &WorkflowData{
Name: "Test",
SafeOutputs: &SafeOutputsConfig{
SubmitPullRequestReview: &SubmitPullRequestReviewConfig{
BaseSafeOutputConfig: BaseSafeOutputConfig{Max: strPtr("1")},
AllowedEvents: []string{"COMMENT", "REQUEST_CHANGES"},
},
},
}
var steps []string
compiler.addHandlerManagerConfigEnvVar(&steps, workflowData)
require.NotEmpty(t, steps, "Steps should not be empty")
stepsContent := strings.Join(steps, "")
require.Contains(t, stepsContent, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG")
for _, step := range steps {
if strings.Contains(step, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG") {
parts := strings.Split(step, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: ")
if len(parts) == 2 {
jsonStr := strings.TrimSpace(parts[1])
jsonStr = strings.Trim(jsonStr, "\"")
jsonStr = strings.ReplaceAll(jsonStr, "\\\"", "\"")
var handlerConfig map[string]any
err := json.Unmarshal([]byte(jsonStr), &handlerConfig)
require.NoError(t, err, "Should unmarshal handler config")
submitConfig, ok := handlerConfig["submit_pull_request_review"].(map[string]any)
require.True(t, ok, "submit_pull_request_review config should exist")
allowedEvents, ok := submitConfig["allowed_events"].([]any)
require.True(t, ok, "allowed_events should be present in handler config")
require.Len(t, allowedEvents, 2, "allowed_events should have 2 entries")
assert.Equal(t, "COMMENT", allowedEvents[0], "First allowed event should be COMMENT")
assert.Equal(t, "REQUEST_CHANGES", allowedEvents[1], "Second allowed event should be REQUEST_CHANGES")
}
}
}
})
t.Run("allowed_events not in handler config when not set", func(t *testing.T) {
compiler := NewCompiler()
workflowData := &WorkflowData{
Name: "Test",
SafeOutputs: &SafeOutputsConfig{
SubmitPullRequestReview: &SubmitPullRequestReviewConfig{
BaseSafeOutputConfig: BaseSafeOutputConfig{Max: strPtr("1")},
},
},
}
var steps []string
compiler.addHandlerManagerConfigEnvVar(&steps, workflowData)
require.NotEmpty(t, steps, "Steps should not be empty")
stepsContent := strings.Join(steps, "")
require.Contains(t, stepsContent, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG")
for _, step := range steps {
if strings.Contains(step, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG") {
parts := strings.Split(step, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: ")
if len(parts) == 2 {
jsonStr := strings.TrimSpace(parts[1])
jsonStr = strings.Trim(jsonStr, "\"")
jsonStr = strings.ReplaceAll(jsonStr, "\\\"", "\"")
var handlerConfig map[string]any
err := json.Unmarshal([]byte(jsonStr), &handlerConfig)
require.NoError(t, err, "Should unmarshal handler config")
submitConfig, ok := handlerConfig["submit_pull_request_review"].(map[string]any)
require.True(t, ok, "submit_pull_request_review config should exist")
_, hasAllowedEvents := submitConfig["allowed_events"]
assert.False(t, hasAllowedEvents, "allowed_events should not be in handler config when not set")
}
}
}
})
t.Run("supersede_older_reviews included in submit_pull_request_review handler config when true", func(t *testing.T) {
compiler := NewCompiler()
workflowData := &WorkflowData{
Name: "Test",
SafeOutputs: &SafeOutputsConfig{
SubmitPullRequestReview: &SubmitPullRequestReviewConfig{
BaseSafeOutputConfig: BaseSafeOutputConfig{Max: strPtr("1")},
SupersedeOlderReviews: true,
},
},
}
var steps []string
compiler.addHandlerManagerConfigEnvVar(&steps, workflowData)
require.NotEmpty(t, steps, "Steps should not be empty")
stepsContent := strings.Join(steps, "")
require.Contains(t, stepsContent, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG")
for _, step := range steps {
if strings.Contains(step, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG") {
parts := strings.Split(step, "GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: ")
if len(parts) == 2 {
jsonStr := strings.TrimSpace(parts[1])
jsonStr = strings.Trim(jsonStr, "\"")
jsonStr = strings.ReplaceAll(jsonStr, "\\\"", "\"")
var handlerConfig map[string]any
err := json.Unmarshal([]byte(jsonStr), &handlerConfig)
require.NoError(t, err, "Should unmarshal handler config")
submitConfig, ok := handlerConfig["submit_pull_request_review"].(map[string]any)
require.True(t, ok, "submit_pull_request_review config should exist")
supersedeOlderReviews, hasSupersedeOlderReviews := submitConfig["supersede_older_reviews"].(bool)
require.True(t, hasSupersedeOlderReviews, "supersede_older_reviews should be in handler config when true")
assert.True(t, supersedeOlderReviews, "supersede_older_reviews should be true")
}
}
}
})
}
func TestHeadSHAExpressionForTrigger(t *testing.T) {
t.Run("workflow_run map trigger returns workflow_run head_sha expression", func(t *testing.T) {
onField := map[string]any{
"workflow_run": map[string]any{"workflows": []any{"CI"}},
}
result := headSHAExpressionForTrigger(onField)
assert.Equal(t, "${{ github.event.workflow_run.head_sha }}", result)
})
t.Run("pull_request map trigger returns pull_request head sha expression", func(t *testing.T) {
onField := map[string]any{
"pull_request": map[string]any{"types": []any{"opened"}},
}
result := headSHAExpressionForTrigger(onField)
assert.Equal(t, "${{ github.event.pull_request.head.sha }}", result)
})
t.Run("pull_request_target map trigger returns pull_request head sha expression", func(t *testing.T) {
onField := map[string]any{
"pull_request_target": nil,
}
result := headSHAExpressionForTrigger(onField)
assert.Equal(t, "${{ github.event.pull_request.head.sha }}", result)
})
t.Run("workflow_run string trigger returns workflow_run head_sha expression", func(t *testing.T) {
result := headSHAExpressionForTrigger("workflow_run")
assert.Equal(t, "${{ github.event.workflow_run.head_sha }}", result)
})
t.Run("pull_request string trigger returns pull_request head sha expression", func(t *testing.T) {
result := headSHAExpressionForTrigger("pull_request")
assert.Equal(t, "${{ github.event.pull_request.head.sha }}", result)
})
t.Run("issues trigger returns empty string", func(t *testing.T) {
onField := map[string]any{
"issues": map[string]any{"types": []any{"opened"}},
}
result := headSHAExpressionForTrigger(onField)
assert.Empty(t, result)
})
t.Run("push trigger returns empty string", func(t *testing.T) {
onField := map[string]any{"push": nil}
result := headSHAExpressionForTrigger(onField)
assert.Empty(t, result)
})
t.Run("nil trigger returns empty string", func(t *testing.T) {
result := headSHAExpressionForTrigger(nil)
assert.Empty(t, result)
})
}
func TestBuildJobLevelSafeOutputEnvVarsHeadSHA(t *testing.T) {
t.Run("GH_AW_HEAD_SHA set for workflow_run trigger", func(t *testing.T) {
compiler := NewCompiler()
workflowData := &WorkflowData{
Name: "Test",
RawFrontmatter: map[string]any{
"on": map[string]any{
"workflow_run": map[string]any{"workflows": []any{"CI"}},
},
},
}
envVars := compiler.buildJobLevelSafeOutputEnvVars(workflowData, "test-workflow")
assert.Equal(t, "${{ github.event.workflow_run.head_sha }}", envVars["GH_AW_HEAD_SHA"])
})
t.Run("GH_AW_HEAD_SHA set for pull_request trigger", func(t *testing.T) {
compiler := NewCompiler()
workflowData := &WorkflowData{
Name: "Test",
RawFrontmatter: map[string]any{
"on": map[string]any{
"pull_request": map[string]any{"types": []any{"opened"}},
},
},
}
envVars := compiler.buildJobLevelSafeOutputEnvVars(workflowData, "test-workflow")
assert.Equal(t, "${{ github.event.pull_request.head.sha }}", envVars["GH_AW_HEAD_SHA"])
})
t.Run("GH_AW_HEAD_SHA not set for issues trigger", func(t *testing.T) {
compiler := NewCompiler()
workflowData := &WorkflowData{
Name: "Test",
RawFrontmatter: map[string]any{
"on": map[string]any{
"issues": map[string]any{"types": []any{"opened"}},
},
},
}
envVars := compiler.buildJobLevelSafeOutputEnvVars(workflowData, "test-workflow")
_, hasHeadSHA := envVars["GH_AW_HEAD_SHA"]
assert.False(t, hasHeadSHA, "GH_AW_HEAD_SHA should not be set for issues trigger")
})
t.Run("GH_AW_HEAD_SHA not set when no frontmatter on field", func(t *testing.T) {
compiler := NewCompiler()
workflowData := &WorkflowData{
Name: "Test",
RawFrontmatter: map[string]any{},
}
envVars := compiler.buildJobLevelSafeOutputEnvVars(workflowData, "test-workflow")
_, hasHeadSHA := envVars["GH_AW_HEAD_SHA"]
assert.False(t, hasHeadSHA, "GH_AW_HEAD_SHA should not be set when no on: field")
})
}