-
Notifications
You must be signed in to change notification settings - Fork 532
Expand file tree
/
Copy pathrelease_workflow_test.go
More file actions
778 lines (707 loc) · 26 KB
/
Copy pathrelease_workflow_test.go
File metadata and controls
778 lines (707 loc) · 26 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
package main
import (
"crypto/sha256"
"fmt"
"os"
"os/exec"
"path/filepath"
"regexp"
"strings"
"testing"
"github.com/rudrankriyam/App-Store-Connect-CLI/internal/rootfs"
)
func readReleaseWorkflow() ([]byte, error) {
repositoryRoot, err := rootfs.New(".")
if err != nil {
return nil, err
}
return repositoryRoot.ReadFile(filepath.Join(".github", "workflows", "release.yml"))
}
var (
releaseWorkflowJobsPattern = regexp.MustCompile(`(?m)^jobs:\s*$`)
releaseWorkflowTopLevelPattern = regexp.MustCompile(`(?m)^[A-Za-z0-9_-]+:\s*$`)
releaseWorkflowJobPattern = regexp.MustCompile(`(?m)^ [A-Za-z0-9_-]+:\s*$`)
)
func releaseWorkflowJobsBlock(t *testing.T, workflow string) string {
t.Helper()
jobsMatch := releaseWorkflowJobsPattern.FindStringIndex(workflow)
if jobsMatch == nil {
t.Fatal("release workflow missing jobs mapping")
}
jobsBlock := workflow[jobsMatch[1]:]
if nextTopLevel := releaseWorkflowTopLevelPattern.FindStringIndex(jobsBlock); nextTopLevel != nil {
jobsBlock = jobsBlock[:nextTopLevel[0]]
}
return jobsBlock
}
func releaseWorkflowJobBlock(t *testing.T, workflow, jobName string) string {
t.Helper()
jobsBlock := releaseWorkflowJobsBlock(t, workflow)
jobHeader := " " + jobName + ":"
jobMatches := releaseWorkflowJobPattern.FindAllStringIndex(jobsBlock, -1)
for index, match := range jobMatches {
if jobsBlock[match[0]:match[1]] != jobHeader {
continue
}
end := len(jobsBlock)
if index+1 < len(jobMatches) {
end = jobMatches[index+1][0]
}
return jobsBlock[match[0]:end]
}
t.Fatalf("release workflow missing %s job", jobName)
return ""
}
func TestReleaseWorkflowJobBlockStopsAtNextJob(t *testing.T) {
tests := []struct {
name string
workflow string
unexpected []string
}{
{
name: "next job",
workflow: "jobs:\n winget:\n name: Submit WinGet package\n later:\n name: Later job\n",
unexpected: []string{"later"},
},
{
name: "outside jobs mapping",
workflow: "jobs:\n winget:\n name: Submit WinGet package\non:\n workflow_dispatch:\n",
unexpected: []string{"on:", "workflow_dispatch"},
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
block := releaseWorkflowJobBlock(t, test.workflow, "winget")
for _, unexpected := range test.unexpected {
if strings.Contains(block, unexpected) {
t.Fatalf("winget block included content outside the job: %q", block)
}
}
})
}
}
func TestReleaseWorkflowExportsHomebrewChecksumsBeforeFormulaGeneration(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
assignAMD64 := "SHA256_AMD64=$(shasum"
assignArm64 := "SHA256=$(shasum"
exportChecksums := "export SHA256_AMD64 SHA256"
pythonStep := "python3 - <<'PY'"
assignAMD64Index := strings.Index(workflow, assignAMD64)
if assignAMD64Index == -1 {
t.Fatalf("release workflow missing %q", assignAMD64)
}
assignArm64Index := strings.Index(workflow, assignArm64)
if assignArm64Index == -1 {
t.Fatalf("release workflow missing %q", assignArm64)
}
exportIndex := strings.Index(workflow, exportChecksums)
if exportIndex == -1 {
t.Fatalf("release workflow missing %q", exportChecksums)
}
pythonIndex := strings.Index(workflow, pythonStep)
if pythonIndex == -1 {
t.Fatalf("release workflow missing %q", pythonStep)
}
if assignAMD64Index > exportIndex || exportIndex > pythonIndex {
t.Fatalf("%q must be assigned and exported before %q", assignAMD64, pythonStep)
}
if assignArm64Index > exportIndex || exportIndex > pythonIndex {
t.Fatalf("%q must be assigned and exported before %q", assignArm64, pythonStep)
}
}
func TestReleaseWorkflowTestsHomebrewFormulaUsingVersionStdout(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
want := `assert_match version.to_s, shell_output("#{{bin}}/asc --version")`
if !strings.Contains(workflow, want) {
t.Fatalf("release workflow missing stdout-based Homebrew formula test %q", want)
}
unwanted := `shell_output("#{{bin}}/asc --help")`
if strings.Contains(workflow, unwanted) {
t.Fatalf("release workflow still tests help output from stderr with %q", unwanted)
}
}
func TestReleaseWorkflowKeepsHistoricalGuardrailsInline(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
for _, want := range []string{
`python3 scripts/test_check_docs.py`,
`make format-check`,
`make check-docs`,
`make check-wall-of-apps`,
`make lint`,
`ASC_BYPASS_KEYCHAIN=1 make test`,
} {
if !strings.Contains(workflow, want) {
t.Errorf("release workflow missing historical guardrail %q", want)
}
}
if strings.Contains(workflow, "make release-guardrails") {
t.Fatal("release workflow cannot call a target absent from historical tags")
}
}
func TestReleaseRehearsalGuardrailsIncludeDocsValidatorSelfTest(t *testing.T) {
data, err := os.ReadFile("Makefile")
if err != nil {
t.Fatalf("read Makefile: %v", err)
}
makefile := string(data)
start := strings.Index(makefile, "release-guardrails:\n")
if start == -1 {
t.Fatal("Makefile missing release-guardrails target")
}
end := strings.Index(makefile[start:], "\n# Show help")
if end == -1 {
t.Fatal("could not find end of release-guardrails target")
}
guardrails := makefile[start : start+end]
if !strings.Contains(guardrails, "python3 scripts/test_check_docs.py") {
t.Fatal("release-guardrails must run the docs-validator self-test")
}
}
func TestReleaseWorkflowBuildsStrippedTrimmedBinaries(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
buildLines := 0
for _, line := range strings.Split(string(data), "\n") {
if !strings.Contains(line, "go build") {
continue
}
buildLines++
if !strings.Contains(line, "-trimpath") {
t.Errorf("release build line missing -trimpath: %s", strings.TrimSpace(line))
}
if !strings.Contains(line, "-s -w") {
t.Errorf("release build line missing -s -w: %s", strings.TrimSpace(line))
}
}
if buildLines == 0 {
t.Fatal("release workflow contains no go build lines")
}
}
func TestReleaseWorkflowEnablesCGOForEveryMacOSArchitecture(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
for _, arch := range []string{"amd64", "arm64"} {
want := "CGO_ENABLED=1 GOOS=darwin GOARCH=" + arch + " go build"
if !strings.Contains(workflow, want) {
t.Fatalf("release workflow missing cgo-enabled macOS %s build: %q", arch, want)
}
}
}
func TestReleaseWorkflowDisablesCGOForNonDarwinBuilds(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
for _, target := range []string{
"GOOS=linux GOARCH=amd64",
"GOOS=linux GOARCH=arm64",
"GOOS=windows GOARCH=amd64",
} {
want := "CGO_ENABLED=0 " + target + " go build"
if !strings.Contains(workflow, want) {
t.Fatalf("release workflow missing Cgo-disabled %s build: %q", target, want)
}
}
}
func TestReleaseWorkflowDoesNotInterpolateDispatchInputIntoShell(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
if strings.Contains(workflow, `TAG="${{ github.event_name == 'workflow_dispatch'`) {
t.Fatal("release workflow interpolates dispatch input directly into shell")
}
for _, want := range []string{
`RELEASE_TAG: ${{ github.event_name == 'workflow_dispatch' && inputs.version || github.ref_name }}`,
`TAG="${RELEASE_TAG}"`,
} {
if !strings.Contains(workflow, want) {
t.Fatalf("release workflow missing safe dispatch handling %q", want)
}
}
}
func TestReleaseWorkflowNotarizesMacOSBinariesBeforePublishing(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
releaseStart := strings.Index(workflow, "\n build:\n")
if releaseStart == -1 {
t.Fatal("release workflow missing build job")
}
releaseJob := workflow[releaseStart:]
for _, want := range []string{
`ASC_KEY_ID: ${{ secrets.ASC_KEY_ID }}`,
`ASC_ISSUER_ID: ${{ secrets.ASC_ISSUER_ID }}`,
`ASC_PRIVATE_KEY_B64: ${{ secrets.ASC_PRIVATE_KEY_B64 }}`,
`ASC_PRIVATE_KEY_PATH: ${{ runner.temp }}/AuthKey.p8`,
`ASC_BYPASS_KEYCHAIN: "1"`,
`notarization list --limit 1 --output json`,
`notarization submit`,
`--wait`,
`--timeout 1h`,
`notarization log --id`,
`codesign -vvvv -R="notarized" --check-notarization`,
} {
if !strings.Contains(releaseJob, want) {
t.Errorf("release workflow missing notarization contract %q", want)
}
}
if strings.Contains(releaseJob, `auth status --validate`) {
t.Fatal("release workflow must validate the environment credentials with a Notary API request")
}
if strings.Contains(releaseJob, `spctl --assess`) {
t.Fatal("release workflow must not assess standalone binaries with spctl")
}
notarizeIndex := strings.Index(workflow, "- name: Notarize macOS binaries")
checksumIndex := strings.Index(workflow, "- name: Create checksums")
publishIndex := strings.Index(workflow, "- name: Create, resume, or verify GitHub Release")
if notarizeIndex == -1 || checksumIndex == -1 || publishIndex == -1 {
t.Fatalf("release workflow must contain notarization, checksum, and publish steps")
}
if notarizeIndex >= checksumIndex || checksumIndex >= publishIndex {
t.Fatalf("release workflow must notarize before checksums and publish: notarize=%d checksum=%d publish=%d", notarizeIndex, checksumIndex, publishIndex)
}
}
func TestReleaseWorkflowCanRepairExistingNotarizationWithoutReplacingAssets(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
if !strings.Contains(workflow, "notarize_existing:") {
t.Fatal("release workflow missing notarize_existing dispatch input")
}
start := strings.Index(workflow, "\n repair-notarization:\n")
end := strings.Index(workflow, "\n prepare:\n")
if start == -1 || end == -1 || start >= end {
t.Fatal("release workflow must define repair-notarization before release")
}
repairJob := workflow[start:end]
for _, want := range []string{
`persist-credentials: false`,
`gh release download "${VERSION}"`,
`python3 workflow-source/scripts/verify_release_assets.py --release-dir existing-release --version "${VERSION}"`,
`codesign --verify --deep --strict --verbose=2`,
`is signed by an unexpected Developer ID`,
`ASC_KEY_ID: ${{ secrets.ASC_KEY_ID }}`,
`ASC_ISSUER_ID: ${{ secrets.ASC_ISSUER_ID }}`,
`ASC_PRIVATE_KEY_B64: ${{ secrets.ASC_PRIVATE_KEY_B64 }}`,
`ASC_PRIVATE_KEY_PATH: ${{ runner.temp }}/AuthKey.p8`,
`ASC_BYPASS_KEYCHAIN: "1"`,
`notarization list --limit 1 --output json`,
`notarization submit`,
`codesign -vvvv -R="notarized" --check-notarization`,
} {
if !strings.Contains(repairJob, want) {
t.Errorf("repair-notarization job missing %q", want)
}
}
for _, unwanted := range []string{
`auth status --validate`,
`spctl --assess`,
} {
if strings.Contains(repairJob, unwanted) {
t.Errorf("repair-notarization job contains invalid verification %q", unwanted)
}
}
for _, unwanted := range []string{
`gh release upload`,
`gh release create`,
`codesign --force`,
`--clobber`,
} {
if strings.Contains(repairJob, unwanted) {
t.Errorf("repair-notarization job must not replace release assets; found %q", unwanted)
}
}
}
func TestReleaseWorkflowCreatesPrivateKeyWithRestrictedModeInRunnerTemp(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
if got := strings.Count(workflow, `install -m 600 /dev/null "$RUNNER_TEMP/AuthKey.p8"`); got != 2 {
t.Fatalf("release workflow must securely create both temporary keys, got %d sites", got)
}
cleanup := "- name: Remove notarization credentials\n if: always()\n run: rm -f \"$RUNNER_TEMP/AuthKey.p8\""
if got := strings.Count(workflow, cleanup); got != 2 {
t.Fatalf("release workflow must unconditionally clean up both temporary keys, got %d sites", got)
}
if strings.Contains(workflow, "/tmp/AuthKey.p8") {
t.Fatal("release workflow must not store private keys in shared /tmp")
}
}
func TestReleaseWorkflowReusesOneBuildArtifactForEveryPublisher(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
for _, want := range []string{
"\n prepare:\n",
"\n build:\n",
"\n publish:\n",
"\n homebrew:\n",
"\n winget:\n",
"outputs:\n version: ${{ steps.version.outputs.version }}",
"actions/upload-artifact@",
"actions/download-artifact@",
"name: candidate-release-${{ needs.prepare.outputs.version }}",
"name: published-release-${{ needs.publish.outputs.version }}",
`tar -cf "workflow-artifact/candidate-release-${VERSION}.tar" release`,
`tar -cf "workflow-artifact/published-release-${VERSION}.tar" release`,
} {
if !strings.Contains(workflow, want) {
t.Errorf("release workflow missing split-job contract %q", want)
}
}
if got := strings.Count(workflow, "name: candidate-release-${{ needs.prepare.outputs.version }}"); got != 3 {
t.Fatalf("release workflow must define two mutually exclusive uploads and one download for the candidate artifact, got %d references", got)
}
if got := strings.Count(workflow, "actions/download-artifact@"); got != 3 {
t.Fatalf("publishers must consume the candidate and published artifacts in three downloads, got %d", got)
}
}
func TestReleaseWorkflowUsesValidSecureReleaseSteps(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
if strings.Contains(workflow, "- parallel:") {
t.Fatal("release workflow must use valid run or uses steps")
}
if !strings.Contains(workflow, "go-version-file: go.mod\n cache: false") {
t.Fatal("release build must not restore a shared Go build cache")
}
if !strings.Contains(workflow, `gh release download "${VERSION}" --repo "${GH_REPO}" --dir published-release`) {
t.Fatal("published-release recovery must select the repository explicitly")
}
}
func TestReleaseWorkflowReusesArtifactsAcrossRerunAttempts(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
for _, want := range []string{
`actions/runs/${GITHUB_RUN_ID}/artifacts`,
`repos/${GH_REPO}/actions/artifacts`,
`repos/${GH_REPO}/actions/artifacts/${artifact_id}/zip`,
`repos/${GH_REPO}/actions/runs/${artifact_run_id}`,
`artifact_name="candidate-release-${VERSION}"`,
`artifact_name="published-release-${VERSION}"`,
`candidate-release-${VERSION}.commit`,
`run_path=""`,
`run_head_sha=""`,
`run_event=""`,
`run_repository=""`,
`run_head_branch=""`,
`run_path" != ".github/workflows/release.yml`,
`run_repository" != "$GH_REPO`,
`default_branch=$(gh api "repos/${GH_REPO}" --jq '.default_branch')`,
`case "$run_event" in`,
`push) [ "$run_head_sha" = "$release_commit" ] || continue ;;`,
`workflow_dispatch) [ "$run_head_branch" = "$default_branch" ] || continue ;;`,
`test "$(cat "$provenance")" = "$release_commit"`,
`gh release download "${VERSION}" --dir "$draft_dir"`,
`cmp -s "$draft_asset" "$candidate_dir/release/$name"`,
`No retained candidate artifact matches the existing draft assets`,
`cross_run=true`,
`if: steps.candidate_artifact.outputs.cross_run == 'true'`,
`if: steps.candidate_artifact.outputs.reused != 'true'`,
`if: steps.published_artifact.outputs.reused != 'true'`,
} {
if !strings.Contains(workflow, want) {
t.Errorf("release workflow missing rerun artifact contract %q", want)
}
}
}
func TestReleaseWorkflowRepairsPackageManagersWithoutRebuildingPublishedRelease(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
for _, want := range []string{
"\n prepare:\n",
`published: ${{ steps.release.outputs.published }}`,
`gh api "repos/${GH_REPO}/releases/tags/${VERSION}" --jq '.draft'`,
`elif ! grep -Fq "HTTP 404" "$release_error"`,
`needs: prepare`,
`needs.prepare.outputs.published != 'true'`,
"needs:\n - prepare\n - build",
`needs.prepare.outputs.published == 'true' || needs.build.result == 'success'`,
`if: steps.published_artifact.outputs.reused != 'true' && needs.prepare.outputs.published == 'true'`,
`gh release download "${VERSION}" --dir published-release`,
} {
if !strings.Contains(workflow, want) {
t.Errorf("release workflow missing published-release repair contract %q", want)
}
}
packStart := strings.Index(workflow, "- name: Pack immutable published artifact")
packEnd := strings.Index(workflow, "- name: Upload immutable published artifact")
if packStart == -1 || packEnd == -1 || packStart >= packEnd {
t.Fatal("release workflow missing published artifact packing step")
}
if !strings.Contains(workflow[packStart:packEnd], "mkdir -p workflow-artifact") {
t.Fatal("published-release repair must create the artifact directory before packing")
}
}
func TestReleaseWorkflowPublishesPackageManagersWhenBuildIsSkipped(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
const publisherCondition = "\n if: always() && needs.publish.result == 'success'\n"
const publisherNeeds = "\n needs: publish\n"
for _, jobName := range []string{"homebrew", "winget"} {
jobBlock := releaseWorkflowJobBlock(t, workflow, jobName)
// publish escapes the skipped build with always(); GitHub propagates that skip
// down the whole needs chain, so every publisher must break the chain the same
// way or the already-published repair path silently ships nothing.
if !strings.Contains(jobBlock, publisherCondition) {
t.Errorf("%s job must contain the exact publisher condition %q", jobName, strings.TrimSpace(publisherCondition))
}
if !strings.Contains(jobBlock, publisherNeeds) {
t.Errorf("%s job must depend on publish", jobName)
}
}
}
func TestVerifyReleaseAssetsRequiresExactChecksumCoverage(t *testing.T) {
workflowData, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
if got := strings.Count(string(workflowData), "verify_release_assets.py"); got != 6 {
t.Fatalf("every release consumer must run exact checksum coverage verification, got %d verifier calls", got)
}
if _, err := exec.LookPath("python3"); err != nil {
t.Fatalf("python3 is required for release asset verification tests: %v", err)
}
const version = "1.2.3"
canonicalNames := []string{
"asc_1.2.3_macOS_amd64",
"asc_1.2.3_macOS_arm64",
"asc_1.2.3_linux_amd64",
"asc_1.2.3_linux_arm64",
"asc_1.2.3_windows_amd64.exe",
}
tests := []struct {
name string
omitCanonical string
addUnlistedAsset bool
emptyAsset string
wrongDigest bool
pathTraversal bool
wantSucceeded bool
}{
{name: "complete", wantSucceeded: true},
{name: "missing canonical asset", omitCanonical: "asc_1.2.3_windows_amd64.exe"},
{name: "unlisted asset", addUnlistedAsset: true},
{name: "empty canonical asset", emptyAsset: "asc_1.2.3_macOS_arm64"},
{name: "wrong digest", wrongDigest: true},
{name: "path traversal", pathTraversal: true},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
releaseDir := t.TempDir()
var manifest strings.Builder
for index, name := range canonicalNames {
if name == tt.omitCanonical {
continue
}
asset := []byte("signed binary bytes for " + name)
if name == tt.emptyAsset {
asset = nil
}
if err := os.WriteFile(filepath.Join(releaseDir, name), asset, 0o600); err != nil {
t.Fatalf("write asset: %v", err)
}
digest := sha256.Sum256(asset)
digestText := fmt.Sprintf("%x", digest)
manifestName := name
if tt.wrongDigest && index == 0 {
digestText = strings.Repeat("0", 64)
}
if tt.pathTraversal && index == 0 {
manifestName = "../" + name
}
fmt.Fprintf(&manifest, "%s %s\n", digestText, manifestName)
}
if tt.addUnlistedAsset {
if err := os.WriteFile(filepath.Join(releaseDir, "asc_1.2.3_extra"), []byte("extra"), 0o600); err != nil {
t.Fatalf("write extra asset: %v", err)
}
}
if err := os.WriteFile(filepath.Join(releaseDir, "asc_1.2.3_checksums.txt"), []byte(manifest.String()), 0o600); err != nil {
t.Fatalf("write checksum manifest: %v", err)
}
cmd := exec.Command("python3", "scripts/verify_release_assets.py", "--release-dir", releaseDir, "--version", version)
output, err := cmd.CombinedOutput()
if tt.wantSucceeded && err != nil {
t.Fatalf("verify release assets: %v\n%s", err, output)
}
if !tt.wantSucceeded && err == nil {
t.Fatalf("verification unexpectedly accepted incomplete or unsafe checksum coverage\n%s", output)
}
})
}
}
func TestReleaseWorkflowResumesDraftButNeverClobbersPublishedAssets(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
if strings.Contains(workflow, "--clobber") {
t.Fatal("release workflow must not replace a published asset")
}
for _, want := range []string{
`--json isDraft`,
`gh release create "${VERSION}" --draft --generate-notes --verify-tag`,
`if [ "$release_is_draft" = "true" ]`,
`gh release upload "${VERSION}" "$asset"`,
`cmp -s "$asset" "published-release/$name"`,
`gh release edit "${VERSION}" --draft=false`,
`gh release download "${VERSION}"`,
`python3 workflow-source/scripts/verify_release_assets.py --release-dir published-release --version "${VERSION}"`,
`published-release-${VERSION}.tar`,
} {
if !strings.Contains(workflow, want) {
t.Errorf("release workflow missing retry-safe publication contract %q", want)
}
}
stepStart := strings.Index(workflow, "- name: Create, resume, or verify GitHub Release")
stepEnd := strings.Index(workflow, "- name: Pack immutable published artifact")
if stepStart == -1 || stepEnd == -1 || stepStart >= stepEnd {
t.Fatal("release workflow missing publication step boundaries")
}
publishStep := workflow[stepStart:stepEnd]
draftStart := strings.Index(publishStep, `if [ "$release_is_draft" = "true" ]`)
if draftStart == -1 {
t.Fatal("release workflow must checksum-verify and publish a completed draft")
}
checksumIndex := strings.Index(publishStep[draftStart:], `python3 workflow-source/scripts/verify_release_assets.py --release-dir published-release --version "${VERSION}"`)
publishIndex := strings.Index(publishStep[draftStart:], `gh release edit "${VERSION}" --draft=false`)
if checksumIndex == -1 || publishIndex == -1 {
t.Fatal("release workflow must checksum-verify and publish a completed draft")
}
if checksumIndex >= publishIndex {
t.Fatal("release workflow must verify draft checksums before making the release public")
}
}
func TestReleaseWorkflowGrantsArtifactReadPermissionToArtifactJobs(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
jobs := []struct {
name string
next string
}{
{name: "build", next: "publish"},
{name: "publish", next: "homebrew"},
{name: "homebrew", next: "winget"},
{name: "winget", next: ""},
}
for _, job := range jobs {
start := strings.Index(workflow, "\n "+job.name+":\n")
if start == -1 {
t.Fatalf("release workflow missing %s job", job.name)
}
end := len(workflow)
if job.next != "" {
next := strings.Index(workflow[start+1:], "\n "+job.next+":\n")
if next == -1 {
t.Fatalf("release workflow missing %s job boundary", job.next)
}
end = start + 1 + next
}
if !strings.Contains(workflow[start:end], "permissions:\n actions: read") {
t.Errorf("%s job must have actions read permission for artifact access", job.name)
}
}
}
func TestReleaseWorkflowSerializesTagAndDispatchForSameVersion(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
want := "group: release-cli-${{ github.event_name == 'workflow_dispatch' && inputs.version || github.ref_name }}"
if !strings.Contains(workflow, want) {
t.Fatalf("release workflow missing normalized concurrency group %q", want)
}
if strings.Contains(workflow, "inputs.version || github.ref }}") {
t.Fatal("release workflow splits tag and dispatch concurrency groups")
}
}
func TestReleaseWorkflowUsesCommitTimestampForBuildMetadata(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
if !strings.Contains(workflow, `DATE=$(git show -s --format=%cI HEAD)`) {
t.Fatal("release workflow must derive build metadata from the release commit")
}
if strings.Contains(workflow, `DATE=$(date -u`) {
t.Fatal("release workflow must not embed the wall-clock build time")
}
}
func TestReleaseWorkflowPushesWinGetBranchWithoutHistoryRewriteOrWorkflowScope(t *testing.T) {
data, err := readReleaseWorkflow()
if err != nil {
t.Fatalf("read release workflow: %v", err)
}
workflow := string(data)
for _, unwanted := range []string{
"--force-with-lease",
"git push --force",
`git merge-base --is-ancestor origin/master "origin/${BRANCH}"`,
`git checkout -b "${BRANCH}" upstream/master`,
`grep -Ev "^manifests/r/Rorkai/ASC/${VERSION}/"`,
} {
if strings.Contains(workflow, unwanted) {
t.Errorf("WinGet publication must not rewrite branch history; found %q", unwanted)
}
}
for _, want := range []string{
`git merge-base --is-ancestor origin/master upstream/master`,
`git checkout -b "${BRANCH}" origin/master`,
`git push --set-upstream origin "${BRANCH}"`,
`git diff --name-only -z upstream/master...HEAD`,
`case "$changed_path" in`,
`"manifests/r/Rorkai/ASC/${VERSION}/"*)`,
`WinGet branch contains changes outside the ${VERSION} manifest directory`,
} {
if !strings.Contains(workflow, want) {
t.Errorf("release workflow missing fast-forward-only WinGet contract %q", want)
}
}
}