{{ message }}
Repository navigation
Expand file tree
/
Copy pathaction_pins_test.go
More file actions
2210 lines (2025 loc) · 65.5 KB
/
Copy pathaction_pins_test.go
File metadata and controls
2210 lines (2025 loc) · 65.5 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
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//go:build !integration
package workflow
import (
"bytes"
"fmt"
"os"
"regexp"
"strings"
"testing"
"github.com/github/gh-aw/pkg/semverutil"
"github.com/github/gh-aw/pkg/testutil"
"github.com/stretchr/testify/require"
)
const setupNodeV6ExpectedUsesPlaceholder = "__setup_node_v6__"
const checkoutV6ExpectedUsesPlaceholder = "__checkout_v6__"
const checkoutSHAExpectedUsesPlaceholder = "__checkout_sha__"
const checkoutLatestExpectedUsesPlaceholder = "__checkout_latest__"
func expectedPinnedUses(t *testing.T, repo, version string) string {
t.Helper()
result, err := getActionPinWithData(repo, version, &WorkflowData{})
if err != nil {
t.Fatalf("getActionPinWithData(%s, %s) returned error: %v", repo, version, err)
}
if result == "" {
t.Fatalf("getActionPinWithData(%s, %s) returned empty result", repo, version)
}
return result
}
func latestPinnedUsesForRepo(t *testing.T, repo string) string {
t.Helper()
result := getCachedActionPin(repo, &WorkflowData{})
if result == "" {
t.Fatalf("getCachedActionPin(%s) returned empty", repo)
}
return result
}
func latestActionVersionForRepo(t *testing.T, repo string) string {
t.Helper()
pin, ok := getLatestActionPinByRepo(repo)
if !ok || pin.Version == "" {
t.Fatalf("getLatestActionPinByRepo(%s) returned no latest pin", repo)
}
return pin.Version
}
func captureStderrOutput(t *testing.T, fn func()) string {
t.Helper()
oldStderr := os.Stderr
r, w, err := os.Pipe()
if err != nil {
t.Fatalf("os.Pipe() failed: %v", err)
}
os.Stderr = w
t.Cleanup(func() {
_ = w.Close()
os.Stderr = oldStderr
})
fn()
_ = w.Close()
os.Stderr = oldStderr
var buf bytes.Buffer
_, _ = buf.ReadFrom(r)
return buf.String()
}
// TestGetActionPinFallback tests that getActionPin returns empty string for unknown actions
func TestGetActionPinFallback(t *testing.T) {
result := getActionPin("unknown/action")
expected := ""
if result != expected {
t.Errorf("getActionPin(unknown/action) = %s, want %s (empty string)", result, expected)
}
}
// isValidSHA checks if a string is a valid 40-character hexadecimal SHA
func isValidSHA(s string) bool {
if len(s) != 40 {
return false
}
matched, _ := regexp.MatchString("^[0-9a-f]{40}$", s)
return matched
}
// TestExtractActionRepo tests the extractActionRepo function
func TestExtractActionRepo(t *testing.T) {
tests := []struct {
name string
uses string
expected string
}{
{
name: "action with version tag",
uses: "actions/checkout@v4",
expected: "actions/checkout",
},
{
name: "action with SHA",
uses: "actions/setup-node@93cb6efe18208431cddfb8368fd83d5badbf9bfd",
expected: "actions/setup-node",
},
{
name: "action with subpath and version",
uses: "github/codeql-action/upload-sarif@v3",
expected: "github/codeql-action/upload-sarif",
},
{
name: "action without version",
uses: "actions/checkout",
expected: "actions/checkout",
},
{
name: "action with branch ref",
uses: "actions/setup-python@main",
expected: "actions/setup-python",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result := extractActionRepo(tt.uses)
if result != tt.expected {
t.Errorf("extractActionRepo(%q) = %q, want %q", tt.uses, result, tt.expected)
}
})
}
}
// TestExtractActionVersion tests the extractActionVersion function
func TestExtractActionVersion(t *testing.T) {
tests := []struct {
name string
uses string
expected string
}{
{
name: "action with version tag",
uses: "actions/checkout@v4",
expected: "v4",
},
{
name: "action with SHA",
uses: "actions/setup-node@93cb6efe18208431cddfb8368fd83d5badbf9bfd",
expected: "93cb6efe18208431cddfb8368fd83d5badbf9bfd",
},
{
name: "action with subpath and version",
uses: "github/codeql-action/upload-sarif@v3",
expected: "v3",
},
{
name: "action without version",
uses: "actions/checkout",
expected: "",
},
{
name: "action with branch ref",
uses: "actions/setup-python@main",
expected: "main",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result := extractActionVersion(tt.uses)
if result != tt.expected {
t.Errorf("extractActionVersion(%q) = %q, want %q", tt.uses, result, tt.expected)
}
})
}
}
// TestApplyActionPinToStep tests the ApplyActionPinToStep function
func TestApplyActionPinToStep(t *testing.T) {
tests := []struct {
name string
stepMap map[string]any
expectPinned bool
expectedUses string
}{
{
name: "step with pinned action (checkout)",
stepMap: map[string]any{
"name": "Checkout code",
"uses": "actions/checkout@v6",
},
expectPinned: true,
expectedUses: checkoutV6ExpectedUsesPlaceholder,
},
{
name: "step with pinned action (setup-node)",
stepMap: map[string]any{
"name": "Setup Node",
"uses": "actions/setup-node@v6",
"with": map[string]any{
"node-version": "24",
},
},
expectPinned: true,
expectedUses: setupNodeV6ExpectedUsesPlaceholder,
},
{
name: "step with unpinned action",
stepMap: map[string]any{
"name": "Custom action",
"uses": "my-org/my-action@v1",
},
expectPinned: false,
expectedUses: "my-org/my-action@v1",
},
{
name: "step with unversioned action",
stepMap: map[string]any{
"name": "Checkout",
"uses": "actions/checkout",
},
expectPinned: true,
expectedUses: checkoutLatestExpectedUsesPlaceholder,
},
{
name: "step without uses field",
stepMap: map[string]any{
"name": "Run command",
"run": "echo hello",
},
expectPinned: false,
expectedUses: "",
},
{
name: "step with already pinned SHA",
stepMap: map[string]any{
"name": "Checkout",
"uses": "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd",
},
expectPinned: true,
expectedUses: checkoutSHAExpectedUsesPlaceholder,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Create a minimal WorkflowData for testing
data := &WorkflowData{}
// Convert to typed step
typedStep, err := MapToStep(tt.stepMap)
if err != nil {
t.Fatalf("Failed to convert step to typed step: %v", err)
}
// Apply action pinning using typed version
pinnedStep, pinErr := applyActionPinToTypedStep(typedStep, data)
if pinErr != nil {
t.Fatalf("applyActionPinToTypedStep() returned error: %v", pinErr)
}
if pinnedStep == nil {
t.Fatal("applyActionPinToTypedStep returned nil")
}
// Convert back to map for comparison
result := pinnedStep.ToMap()
// Check if uses field exists in result
if uses, hasUses := result["uses"]; hasUses {
usesStr, ok := uses.(string)
if !ok {
t.Errorf("applyActionPinToTypedStep returned non-string uses field")
return
}
expectedUses := tt.expectedUses
if expectedUses == setupNodeV6ExpectedUsesPlaceholder {
expectedUses = expectedPinnedUses(t, "actions/setup-node", "v6")
}
if expectedUses == checkoutV6ExpectedUsesPlaceholder {
expectedUses = expectedPinnedUses(t, "actions/checkout", "v6")
}
if expectedUses == checkoutSHAExpectedUsesPlaceholder {
expectedUses = expectedPinnedUses(t, "actions/checkout", "de0fac2e4500dabe0009e67214ff5f5447ce83dd")
}
if expectedUses == checkoutLatestExpectedUsesPlaceholder {
expectedUses = latestPinnedUsesForRepo(t, "actions/checkout")
}
if usesStr != expectedUses {
t.Errorf("applyActionPinToTypedStep uses = %q, want %q", usesStr, expectedUses)
}
// Verify other fields are preserved (check length and keys)
if len(result) != len(tt.stepMap) {
t.Errorf("applyActionPinToTypedStep changed number of fields: got %d, want %d", len(result), len(tt.stepMap))
}
for k := range tt.stepMap {
if _, exists := result[k]; !exists {
t.Errorf("applyActionPinToTypedStep lost field %q", k)
}
}
} else if tt.expectedUses != "" {
t.Errorf("applyActionPinToTypedStep removed uses field when it should be %q", tt.expectedUses)
}
})
}
}
// TestGetLatestActionPinByRepo tests the getLatestActionPinByRepo function
func TestGetLatestActionPinByRepo(t *testing.T) {
tests := []struct {
repo string
expectExists bool
expectRepo string
expectVersion string
expectVersionPrefix string
}{
{
repo: "actions/checkout",
expectExists: true,
expectRepo: "actions/checkout",
expectVersionPrefix: "v",
},
{
repo: "actions/setup-node",
expectExists: true,
expectRepo: "actions/setup-node",
expectVersionPrefix: "v",
},
{
repo: "unknown/action",
expectExists: false,
},
{
repo: "",
expectExists: false,
},
}
for _, tt := range tests {
t.Run(tt.repo, func(t *testing.T) {
if tt.expectVersion != "" && tt.expectVersionPrefix != "" {
t.Fatalf("invalid test case: expectVersion and expectVersionPrefix are mutually exclusive")
}
pin, exists := getLatestActionPinByRepo(tt.repo)
if exists != tt.expectExists {
t.Errorf("getLatestActionPinByRepo(%s) exists = %v, want %v", tt.repo, exists, tt.expectExists)
}
if tt.expectExists {
if pin.Repo != tt.expectRepo {
t.Errorf("getLatestActionPinByRepo(%s) repo = %s, want %s", tt.repo, pin.Repo, tt.expectRepo)
}
if tt.expectVersion != "" && pin.Version != tt.expectVersion {
t.Errorf("getLatestActionPinByRepo(%s) version = %s, want %s", tt.repo, pin.Version, tt.expectVersion)
}
if tt.expectVersionPrefix != "" && !strings.HasPrefix(pin.Version, tt.expectVersionPrefix) {
t.Errorf("getLatestActionPinByRepo(%s) version = %s, want prefix %s", tt.repo, pin.Version, tt.expectVersionPrefix)
}
if !isValidSHA(pin.SHA) {
t.Errorf("getLatestActionPinByRepo(%s) has invalid SHA: %s", tt.repo, pin.SHA)
}
}
})
}
}
// TestApplyActionPinToTypedStep tests the applyActionPinToTypedStep function with typed steps
func TestApplyActionPinToTypedStep(t *testing.T) {
tests := []struct {
name string
step *WorkflowStep
expectPinned bool
expectedUses string
wantErr bool
}{
{
name: "step with pinned action (checkout)",
step: &WorkflowStep{
Name: "Checkout code",
Uses: "actions/checkout@v6",
},
expectPinned: true,
expectedUses: checkoutV6ExpectedUsesPlaceholder,
},
{
name: "step with pinned action (setup-node)",
step: &WorkflowStep{
Name: "Setup Node",
Uses: "actions/setup-node@v6",
With: map[string]any{
"node-version": "24",
},
},
expectPinned: true,
expectedUses: setupNodeV6ExpectedUsesPlaceholder,
},
{
name: "step with unpinned action",
step: &WorkflowStep{
Name: "Custom action",
Uses: "my-org/my-action@v1",
},
expectPinned: false,
expectedUses: "my-org/my-action@v1",
},
{
name: "step with unversioned action in embedded pins",
step: &WorkflowStep{
Name: "Checkout",
Uses: "actions/checkout",
},
expectPinned: true,
expectedUses: checkoutLatestExpectedUsesPlaceholder,
},
{
name: "step with unversioned action not in pins returns error",
step: &WorkflowStep{
Name: "Custom action",
Uses: "my-org/my-unpinned-action",
},
wantErr: true,
},
{
name: "local action ref (./) is passed through unchanged",
step: &WorkflowStep{
Name: "Local action",
Uses: "./.github/actions/my-setup",
},
expectPinned: false,
expectedUses: "./.github/actions/my-setup",
},
{
name: "local action ref (../) returns error",
step: &WorkflowStep{
Name: "Parent local action",
Uses: "../other-repo/.github/actions/shared",
},
wantErr: true,
},
{
name: "docker image ref is passed through unchanged",
step: &WorkflowStep{
Name: "Docker action",
Uses: "docker://alpine:3.20",
},
expectPinned: false,
expectedUses: "docker://alpine:3.20",
},
{
name: "docker image ref with digest is passed through unchanged",
step: &WorkflowStep{
Name: "Docker action with digest",
Uses: "docker://alpine@sha256:abc123",
},
expectPinned: false,
expectedUses: "docker://alpine@sha256:abc123",
},
{
name: "step without uses field",
step: &WorkflowStep{
Name: "Run command",
Run: "echo hello",
},
expectPinned: false,
expectedUses: "",
},
{
name: "nil step",
step: nil,
expectPinned: false,
expectedUses: "",
},
{
name: "step preserves other fields",
step: &WorkflowStep{
Name: "Complex step",
ID: "test-id",
Uses: "actions/checkout@v6",
With: map[string]any{
"fetch-depth": "0",
},
Env: map[string]string{
"TEST": "value",
},
},
expectPinned: true,
expectedUses: checkoutV6ExpectedUsesPlaceholder,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Create a test WorkflowData
data := &WorkflowData{}
result, err := applyActionPinToTypedStep(tt.step, data)
if tt.step == nil {
if err != nil {
t.Errorf("applyActionPinToTypedStep(nil) returned error: %v", err)
}
if result != nil {
t.Errorf("applyActionPinToTypedStep(nil) = %v, want nil", result)
}
return
}
if tt.wantErr {
if err == nil {
t.Errorf("applyActionPinToTypedStep() expected error, got nil")
}
return
}
if err != nil {
t.Fatalf("applyActionPinToTypedStep() returned error: %v", err)
}
if result == nil {
t.Fatalf("applyActionPinToTypedStep() returned nil")
}
// Check uses field
expectedUses := tt.expectedUses
if expectedUses == setupNodeV6ExpectedUsesPlaceholder {
expectedUses = expectedPinnedUses(t, "actions/setup-node", "v6")
}
if expectedUses == checkoutV6ExpectedUsesPlaceholder {
expectedUses = expectedPinnedUses(t, "actions/checkout", "v6")
}
if expectedUses == checkoutLatestExpectedUsesPlaceholder {
expectedUses = latestPinnedUsesForRepo(t, "actions/checkout")
}
if result.Uses != expectedUses {
t.Errorf("applyActionPinToTypedStep() uses = %q, want %q", result.Uses, expectedUses)
}
// Verify other fields are preserved
if result.Name != tt.step.Name {
t.Errorf("applyActionPinToTypedStep() changed name from %q to %q", tt.step.Name, result.Name)
}
if result.ID != tt.step.ID {
t.Errorf("applyActionPinToTypedStep() changed id from %q to %q", tt.step.ID, result.ID)
}
if result.Run != tt.step.Run {
t.Errorf("applyActionPinToTypedStep() changed run from %q to %q", tt.step.Run, result.Run)
}
// Verify original step is not modified
if tt.expectPinned && tt.step.Uses == result.Uses {
// For pinned actions, the uses should be different
// But this doesn't apply if the step is already pinned or doesn't have uses
if tt.step.Uses != "" && !isValidSHA(extractActionVersion(tt.step.Uses)) {
// Original uses is not a SHA, so it should be different from pinned result
if tt.step.Uses == result.Uses {
t.Errorf("applyActionPinToTypedStep() did not create a copy, original uses still %q", tt.step.Uses)
}
}
}
})
}
}
// TestApplyActionPinToTypedStep_Immutability verifies that the original step is not modified
func TestApplyActionPinToTypedStep_Immutability(t *testing.T) {
originalStep := &WorkflowStep{
Name: "Test step",
Uses: "actions/checkout@v5",
With: map[string]any{
"fetch-depth": "0",
},
}
// Keep a copy of the original uses value
originalUses := originalStep.Uses
data := &WorkflowData{}
result, err := applyActionPinToTypedStep(originalStep, data)
if err != nil {
t.Fatalf("applyActionPinToTypedStep() returned error: %v", err)
}
// Verify the original step was not modified
if originalStep.Uses != originalUses {
t.Errorf("applyActionPinToTypedStep() modified original step uses: %q -> %q", originalUses, originalStep.Uses)
}
// Verify the result is different
if result.Uses == originalUses {
t.Errorf("applyActionPinToTypedStep() did not pin the action")
}
// Verify modifying result doesn't affect original
result.Name = "Modified name"
if originalStep.Name == "Modified name" {
t.Errorf("applyActionPinToTypedStep() did not return an independent copy")
}
}
// TestGetActionPinWithData_SemverPreference tests that getActionPinWithData
// resolves actions using the exact version tag specified, and only falls back
// to compatible versions when the exact tag doesn't exist in hardcoded pins
func TestGetActionPinWithData_SemverPreference(t *testing.T) {
tests := []struct {
name string
repo string
requestedVer string
expectedVer string
strictMode bool
shouldFallback bool // Whether we expect to fall back to highest version
}{
{
name: "fallback for setup-go v6.2.0 resolves to latest pinned version",
repo: "actions/setup-go",
requestedVer: "v6.2.0",
strictMode: false,
shouldFallback: true,
},
{
name: "fallback for setup-go v6.2.0 from hardcoded pins resolves to latest pinned version",
repo: "actions/setup-go",
requestedVer: "v6.2.0",
strictMode: false,
shouldFallback: true,
},
{
name: "fallback to highest semver-compatible version for upload-artifact when requesting v4",
repo: "actions/upload-artifact",
requestedVer: "v4",
expectedVer: "v7.0.1",
strictMode: false,
shouldFallback: true,
},
{
name: "fallback to highest semver-compatible version for upload-artifact when requesting v5",
repo: "actions/upload-artifact",
requestedVer: "v5",
expectedVer: "v7.0.1",
strictMode: false,
shouldFallback: true,
},
{
name: "fallback for upload-artifact v4.6.2 resolves to latest pinned version",
repo: "actions/upload-artifact",
requestedVer: "v4.6.2",
strictMode: false,
shouldFallback: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if !tt.shouldFallback && tt.expectedVer == "" {
t.Fatalf("invalid test case %q: expectedVer must be set when shouldFallback is false", tt.name)
}
data := &WorkflowData{
StrictMode: tt.strictMode,
}
result, err := getActionPinWithData(tt.repo, tt.requestedVer, data)
if err != nil {
t.Fatalf("getActionPinWithData(%s, %s) returned error: %v", tt.repo, tt.requestedVer, err)
}
if result == "" {
t.Fatalf("getActionPinWithData(%s, %s) returned empty string", tt.repo, tt.requestedVer)
}
expectedVersion := tt.expectedVer
if tt.shouldFallback {
latestPin, ok := getLatestActionPinByRepo(tt.repo)
if !ok {
t.Fatalf("expected latest pinned version to exist for %s", tt.repo)
}
expectedVersion = latestPin.Version
}
// Check that the result contains the expected version in the comment
if !strings.Contains(result, "# "+expectedVersion) {
t.Errorf("getActionPinWithData(%s, %s) = %s, expected version %s in comment",
tt.repo, tt.requestedVer, result, expectedVersion)
}
// Verify the result format is correct (repo@sha # version)
if !strings.Contains(result, "@") || !strings.Contains(result, " # ") {
t.Errorf("getActionPinWithData(%s, %s) = %s, expected format 'repo@sha # version'",
tt.repo, tt.requestedVer, result)
}
if tt.shouldFallback && !strings.HasSuffix(result, "# "+expectedVersion) {
t.Errorf("getActionPinWithData(%s, %s) = %s, expected a single fallback version comment",
tt.repo, tt.requestedVer, result)
}
})
}
}
// TestGetActionPinWithData_AlreadySHA tests that no warnings are issued when
// the version is already a full 40-character SHA
func TestGetActionPinWithData_AlreadySHA(t *testing.T) {
tests := []struct {
name string
repo string
sha string
expectError bool
}{
{
name: "actions/checkout with full SHA",
repo: "actions/checkout",
sha: "93cb6efe18208431cddfb9bfd000000000000000", // 40-char SHA
},
{
name: "actions/setup-node with full SHA",
repo: "actions/setup-node",
sha: "395ad3262231945c25e8478fd5baf05154b1d79f", // 40-char SHA from the issue
},
{
name: "different action with full SHA",
repo: "actions/upload-artifact",
sha: "1234567890abcdef1234567890abcdef12345678", // 40-char SHA
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
data := &WorkflowData{
StrictMode: false,
}
// Capture stderr to verify no warnings are issued
oldStderr := os.Stderr
r, w, _ := os.Pipe()
os.Stderr = w
result, err := getActionPinWithData(tt.repo, tt.sha, data)
w.Close()
os.Stderr = oldStderr
var buf bytes.Buffer
buf.ReadFrom(r)
stderr := buf.String()
// Should not error for full SHAs
if err != nil {
t.Errorf("getActionPinWithData() unexpected error = %v", err)
return
}
// Should return the SHA as-is
if result == "" {
t.Errorf("getActionPinWithData() returned empty result")
return
}
// Result should contain the original SHA
if !strings.Contains(result, tt.sha) {
t.Errorf("getActionPinWithData() = %s, expected to contain SHA %s", result, tt.sha)
}
// IMPORTANT: Should NOT emit any warnings for actions already pinned to SHAs
if strings.Contains(stderr, "⚠") || strings.Contains(stderr, "Unable to resolve") {
t.Errorf("Expected NO warnings for action already pinned to SHA, but got: %s", stderr)
}
// Log the resolution for debugging
t.Logf("Resolution: %s@%s → %s", tt.repo, tt.sha, result)
if stderr != "" {
t.Logf("Stderr (should be empty): %s", strings.TrimSpace(stderr))
}
})
}
}
func TestApplyActionPinsToTypedSteps(t *testing.T) {
// Create a minimal WorkflowData for testing
data := &WorkflowData{
StrictMode: false,
}
tests := []struct {
name string
steps []*WorkflowStep
want []*WorkflowStep
wantErr bool
}{
{
name: "nil steps",
steps: nil,
want: nil,
},
{
name: "empty steps",
steps: []*WorkflowStep{},
want: []*WorkflowStep{},
},
{
name: "step with uses - should be pinned",
steps: []*WorkflowStep{
{
Name: "Checkout",
Uses: "actions/checkout@v4",
},
},
want: []*WorkflowStep{
{
Name: "Checkout",
// SHA will be pinned by the function, we just check structure
Uses: "actions/checkout@",
},
},
},
{
name: "step with run - should not change",
steps: []*WorkflowStep{
{
Name: "Run tests",
Run: "npm test",
},
},
want: []*WorkflowStep{
{
Name: "Run tests",
Run: "npm test",
},
},
},
{
name: "mixed steps",
steps: []*WorkflowStep{
{
Name: "Checkout",
Uses: "actions/checkout@v4",
},
{
Name: "Run tests",
Run: "npm test",
},
{
Name: "Setup Node",
Uses: "actions/setup-node@v4",
},
},
want: []*WorkflowStep{
{
Name: "Checkout",
Uses: "actions/checkout@",
},
{
Name: "Run tests",
Run: "npm test",
},
{
Name: "Setup Node",
Uses: "actions/setup-node@",
},
},
},
{
name: "unversioned action not in pins returns error",
steps: []*WorkflowStep{
{
Name: "Unknown action",
Uses: "my-org/my-unpinned-action",
},
},
wantErr: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := applyActionPinsToTypedSteps(tt.steps, data)
if tt.wantErr {
if err == nil {
t.Errorf("applyActionPinsToTypedSteps() expected error, got nil")
}
return
}
if err != nil {
t.Fatalf("applyActionPinsToTypedSteps() returned unexpected error: %v", err)
}
if len(got) != len(tt.want) {
t.Errorf("applyActionPinsToTypedSteps() returned %d steps, want %d", len(got), len(tt.want))
return
}
for i := range got {
if got[i] == nil && tt.want[i] == nil {
continue
}
if got[i] == nil || tt.want[i] == nil {
t.Errorf("applyActionPinsToTypedSteps() step %d: got nil=%v, want nil=%v",
i, got[i] == nil, tt.want[i] == nil)
continue
}
// Check basic fields
if got[i].Name != tt.want[i].Name {
t.Errorf("applyActionPinsToTypedSteps() step %d name = %s, want %s",
i, got[i].Name, tt.want[i].Name)
}
if got[i].Run != tt.want[i].Run {
t.Errorf("applyActionPinsToTypedSteps() step %d run = %s, want %s",
i, got[i].Run, tt.want[i].Run)
}
// For uses steps, check that pinning occurred (contains @ symbol and SHA)
if tt.want[i].Uses != "" {
if !strings.Contains(got[i].Uses, "@") {
t.Errorf("applyActionPinsToTypedSteps() step %d uses = %s, expected to contain @",
i, got[i].Uses)
}
// If the original step had a known action, verify it was pinned
if strings.HasPrefix(tt.want[i].Uses, "actions/checkout@") ||
strings.HasPrefix(tt.want[i].Uses, "actions/setup-node@") {
// Verify the result has a SHA (40 hex chars after @)
parts := strings.Split(got[i].Uses, "@")
if len(parts) == 2 {
shaAndComment := parts[1]
before, _, ok := strings.Cut(shaAndComment, " # ")
if ok {
sha := before
if len(sha) != 40 {
t.Errorf("applyActionPinsToTypedSteps() step %d uses SHA length = %d, want 40",
i, len(sha))
}
}
}
}
}
}
})
}
}
// TestGetActionPinWithData_V7Fallback verifies fallback uses the resolved version.
func TestGetActionPinWithData_V7Fallback(t *testing.T) {
data := &WorkflowData{
StrictMode: false,
}
result, err := getActionPinWithData("actions/upload-artifact", "v7", data)
if err != nil {
t.Fatalf("getActionPinWithData returned error: %v", err)
}
if result == "" {
t.Fatalf("getActionPinWithData returned empty string")
}
t.Logf("Result: %s", result)
if !strings.HasSuffix(result, "# v7.0.2") {
t.Errorf("Expected single resolved version comment in result, got: %s", result)
}
// Check the SHA matches the resolved v7.0.2 pin.
expectedSHA := "cf430e030ddbb5b0abf93d22962f4752f3646cd9"
if !strings.Contains(result, expectedSHA) {
t.Errorf("Expected SHA %s in result, got: %s", expectedSHA, result)
}
}
// TestGetActionPinWithData_ExactVersionResolution verifies that when resolving
// a version tag like "v4", the system returns exactly "v4" in the comment,
// not a more precise version like "v4.6.2". This ensures we respect the
// user's specified version tag precisely.
func TestGetActionPinWithData_ExactVersionResolution(t *testing.T) {
tests := []struct {
name string
repo string
requestedVer string
expectedComment string
}{
{
name: "v4 resolves to exactly v4, not v4.6.2",
repo: "actions/upload-artifact",
requestedVer: "v4",
expectedComment: "# v4",
},
{
name: "v5 resolves to exactly v5, not v5.0.0",
You can’t perform that action at this time.