Repository navigation
2032 lines (1856 loc) · 92.9 KB
/
Copy pathci.yml
File metadata and controls
2032 lines (1856 loc) · 92.9 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
# CI Workflow - Build, Test, Lint, Security
#
# This workflow runs on every pull request and push to main/develop branches.
# It performs comprehensive quality checks before allowing code to be merged.
#
# Required GitHub Secrets: None (all checks run without cloud credentials)
#
# Required GitHub Variables:
# - GO_VERSION: Go version to use (default: 1.26.10)
#
# Triggered by:
# - Pull requests to main/develop
# - Pushes to main/develop
# - Manual workflow dispatch
#
# Runners: the Go and Docker heavy jobs (lint, unit, integration, the
# selection self-test, security scanning, e2e) run on ubuntu-24.04-arm.
# On main's runs the same cold Dockerfile build took 124-142s there against
# 201-207s on ubuntu-latest, and `go install govulncheck` under 3s against
# 12-16s. arm64 is also what the AWS deploys run (Graviton). The amd64 image
# leg stays on ubuntu-latest, as GCP and Azure run amd64. Snyk (a Docker
# action), Terraform (provider lock files) and the jobs that finish in
# seconds stay there too: nothing to gain. Every cache key in this file
# includes the runner architecture, so neither architecture restores the
# other's Go build cache or binaries.
name: CI - Build & Test
permissions:
contents: read
on:
pull_request:
branches: [main, develop]
push:
branches: [main, develop]
workflow_dispatch:
env:
GO_VERSION: '1.26.10'
DOCKER_BUILDKIT: 1
COMPOSE_DOCKER_CLI_BUILD: 1
jobs:
# Go code linting
lint:
name: Lint Code
runs-on: ubuntu-24.04-arm
permissions:
contents: read
steps:
- name: Checkout code
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Set up Go
uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
with:
go-version: ${{ env.GO_VERSION }}
cache: true
- name: Install golangci-lint
uses: golangci/golangci-lint-action@ba0d7d2ec06a0ea1cb5fa41b2e4a3ab91d21278a # v9.3.0
with:
version: v2.10.1
install-only: true
- name: Verify golangci-lint config against vendored schema
# `golangci-lint config verify` downloads its JSON schema from
# golangci-lint.run by default, with a hard-coded 2s HTTP timeout, and
# that fetch timing out failed this job at random (#977). The schema is
# vendored instead and passed through the (hidden) --schema flag, so
# the config is still validated on every run, with no network access.
#
# Vendored file: .github/golangci-lint/golangci.v<major>.<minor>.jsonschema.json
# source: https://golangci-lint.run/jsonschema/golangci.v2.10.jsonschema.json
# (byte-identical to jsonschema/golangci.next.jsonschema.json
# at golangci-lint tag v2.10.1, the copy this file came from)
# sha256: GOLANGCI_LINT_SCHEMA_SHA256 below
#
# When bumping `version:` above to a new minor, this step fails until
# the matching schema is vendored. To update: download the URL above
# with the new minor, save it under the new file name, delete the old
# one, and set GOLANGCI_LINT_SCHEMA_SHA256 to its sha256sum.
env:
GOLANGCI_LINT_SCHEMA_SHA256: '692e8da79dc1f110a4a4f3bb841b26ed44e461d3503678eaaae90ae8876e3403'
run: |
set -euo pipefail
version=$(golangci-lint version --short)
minor="${version#v}"
minor="${minor%.*}"
schema=".github/golangci-lint/golangci.v${minor}.jsonschema.json"
if [ ! -f "$schema" ]; then
echo "::error::no vendored schema for golangci-lint ${version}: expected ${schema} (see the update steps in ci.yml)"
exit 1
fi
echo "${GOLANGCI_LINT_SCHEMA_SHA256} ${schema}" | sha256sum -c -
# One check covers both modules: tests/e2e has no config of its own,
# and golangci-lint finds the root .golangci.yml from there too.
golangci-lint config verify --schema "file://${PWD}/${schema}"
- name: Run golangci-lint
run: |
set -uo pipefail
export GOLANGCI_LINT_CACHE="$HOME/.cache/golangci-lint"
status=0
for mod in . tests/e2e; do
echo "==> golangci-lint in $mod"
args=(run --timeout=10m)
# The standalone e2e module has only e2e-tagged test files.
if [ "$mod" = "tests/e2e" ]; then
args+=(--build-tags=e2e)
fi
if ! (cd "$mod" && golangci-lint "${args[@]}" ./...); then
status=1
fi
done
exit "$status"
- name: Run go vet
run: |
set -uo pipefail
status=0
for mod in . tests/e2e; do
echo "==> go vet in $mod"
args=(vet)
if [ "$mod" = "tests/e2e" ]; then
args+=(-tags=e2e)
fi
if ! (cd "$mod" && go "${args[@]}" ./...); then
status=1
fi
done
exit "$status"
- name: Install gocyclo
run: go install github.com/fzipp/gocyclo/cmd/gocyclo@v0.6.0
- name: Check cyclomatic complexity
run: |
echo "Checking for functions with cyclomatic complexity over 10..."
# Exclude _test.go files to stay consistent with .golangci.yml, which
# excludes gocyclo on test files (test helpers/table-driven tests are
# allowed higher complexity). Production code is still gated at >10.
# Also exclude node_modules/ and vendor/ trees: the `.` walk would
# otherwise report third-party Go files that npm packages ship
# (e.g. frontend/node_modules/flatted) whenever deps are installed.
COMPLEXITY_ISSUES=$(gocyclo -over 10 -ignore "_test\.go|(^|/)(node_modules|vendor)/" . 2>&1 || true)
if [ -n "$COMPLEXITY_ISSUES" ]; then
echo "❌ Found functions with cyclomatic complexity over 10:"
echo "$COMPLEXITY_ISSUES"
echo ""
echo "⚠️ Please refactor these functions to reduce complexity."
echo "📖 Tip: Extract helper functions, use early returns, or simplify logic."
exit 1
fi
echo "✅ All functions have acceptable cyclomatic complexity (≤10)"
- name: Run Makefile gate self-tests
# The local lint, scanner and terraform-validate targets must fail
# when their tool is missing or fails (#349); stub tools only. Also
# checks with the real go command that the Go targets' ./... skips
# frontend/node_modules (#177).
run: bash scripts/test-make-gates.sh
# GitHub Actions workflow linting
#
# Nothing else in this repo reads .github/workflows/ for defects. govulncheck
# and gosec are Go source scanners, trivy-config targets Terraform/Dockerfile/
# Kubernetes, and check-yaml only proves the YAML parses. That gap is why the
# rollback.yml and deploy-aws-lambda.yml expression injections (#1542, #1649),
# both reaching production cloud credentials, passed every CI run.
#
# Both linters are needed and neither substitutes for the other:
# - actionlint catches workflow-level defects and, via shellcheck, shell
# bugs inside run: blocks.
# - zizmor has a template-injection audit that names the injection itself.
# Measured against the pre-fix rollback.yml, actionlint exited 1 only on
# unrelated SC2086 noise and never flagged the injected heredoc at all;
# zizmor flagged that exact line high severity, high confidence. actionlint
# alone would not have caught the bug this job exists to prevent.
workflow-lint:
name: Lint Workflows
runs-on: ubuntu-latest
permissions:
contents: read
env:
# Pinned by digest, not only by tag. A tag is mutable, and a linter whose
# ruleset changes without a change in this repo turns main red on its own
# schedule -- the hadolint :latest failure in #1695.
ACTIONLINT_IMAGE: 'rhysd/actionlint:1.7.12@sha256:b1934ee5f1c509618f2508e6eb47ee0d3520686341fec936f3b79331f9315667'
ZIZMOR_VERSION: '1.29.0'
steps:
- name: Checkout code
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Assert there are workflows to lint
run: |
set -euo pipefail
count=$(find .github/workflows -maxdepth 1 -type f \( -name '*.yml' -o -name '*.yaml' \) | wc -l | tr -d ' ')
# Defence in depth, not the only guard: both linters do exit 3 on an
# empty input set. This catches the case they cannot, where the path
# still resolves but the set silently shrinks, and it prints the count
# so a drop is visible in the log rather than inferred from silence.
if [ "$count" -eq 0 ]; then
echo "::error::no workflow files found under .github/workflows"
exit 1
fi
echo "Linting $count workflow files"
- name: Assert Terraform is installed only at the version in .terraform-version
# Issue #349: deploy workflows applied on 1.10.0 while ci.yml and
# pre-commit.yml validated on 1.10.5. Fast (grep only).
run: |
bash scripts/check-terraform-pin.sh
bash scripts/test-check-terraform-pin.sh
- name: Assert shellcheck is available to actionlint
# actionlint does not fail when shellcheck is missing from PATH: it
# silently skips every run: block and still exits 0. That silent skip is
# the failure mode this job exists to close, so assert the binary is
# present rather than trusting the image to keep bundling it.
run: |
set -euo pipefail
docker run --rm --entrypoint sh "$ACTIONLINT_IMAGE" -c '
command -v shellcheck >/dev/null || {
echo "::error::shellcheck is not present in the actionlint image; shell linting would be silently skipped"
exit 1
}
shellcheck --version | sed -n "1,3p"'
- name: Run actionlint
# No file arguments: actionlint discovers .github/workflows itself, so
# it also covers .yaml files and any workflow added later. Passing an
# explicit *.yml glob would silently skip a .yaml workflow that the
# count step above still counts.
run: |
set -euo pipefail
docker run --rm -v "$PWD:/repo" -w /repo "$ACTIONLINT_IMAGE" -color
- name: Run zizmor
# --offline on purpose: the online audits query the GitHub API for action
# metadata, so findings could change without a change in this repo and
# redden main, the same class of failure the hadolint digest pin fixed.
#
# Coverage note: zizmor reads the directory non-recursively, while
# actionlint walks it. A workflow under .github/workflows/sub/ would
# therefore reach actionlint but not zizmor. GitHub itself ignores
# workflows in subdirectories, so this is not a live hole, and the
# -maxdepth 1 count above fails loud if the set ever moves down a level.
#
# Two independent filters, and it matters which does what.
#
# --persona=pedantic rather than the default regular: regular hides
# three high-severity findings this repo actually had (workflow-level
# id-token: write in both sanity workflows, and an unpinned postgres
# service image). Those are fixed rather than filtered, so the stricter
# persona costs nothing today and gates more. auditor is the one level
# up and is documented as accepting false positives, so it is not used.
#
# --min-severity=medium is a threshold, not a suppression: no baseline
# file, no per-finding ignore, no only-new-issues. Every medium and
# high finding the pedantic persona surfaces fails this job, and the
# injection class this job exists to catch scores high. Below the line
# sit 35 findings with the pinned zizmor, none above low: 24
# undocumented-permissions and 11 concurrency-limits. zizmor 1.31 adds
# a self-repository audit, which reports 4 more low findings on the
# local reusable-workflow calls in deploy-all.yml. template-injection
# is at zero since #155 moved every expression out of run: blocks into
# env:. The rest are left to a follow-up rather than silenced here.
run: |
set -euo pipefail
# `pipx run --spec` rather than `pipx install`: it pins the version in
# the same statement that invokes it and does not assume pipx's bin
# directory is on PATH.
pipx run --spec "zizmor==${ZIZMOR_VERSION}" zizmor \
--offline --persona=pedantic --min-severity=medium \
--color=always .github/workflows/
# Unit tests with race detection
unit-tests:
name: Unit Tests
runs-on: ubuntu-24.04-arm
permissions:
contents: read
steps:
- name: Checkout code
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Set up Go
uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
with:
go-version: ${{ env.GO_VERSION }}
cache: true
- name: Download dependencies
run: |
# Verify both platform-owned modules; libraries have their own CI.
set -e
for mod in . tests/e2e; do
echo "==> go mod download/verify in $mod"
(cd "$mod" && go mod download && go mod verify)
done
- name: Run unit tests (all modules)
run: |
# Each ./... walks one module. Check both platform-owned modules.
#
# A failing module must not abort the loop. Aborting would hide every
# later module's result behind the first failure, which is the same
# shape as the gosec bug in issue #1717. Guard each run, record the
# status, and fail at the end so every module is reported.
set -uo pipefail
status=0
for mod in . tests/e2e; do
tag=$(echo "$mod" | tr './' '--' | sed 's/^-/root/')
log="$RUNNER_TEMP/unit-${tag}.log"
# tests/e2e holds only //go:build e2e files, so `go test ./...`
# there matches no packages and exits 1 -- it cannot be run like the
# others. Its tests need the running stack and are executed by the
# e2e-tests job over docker compose; what this job can add is a
# type-check under that tag, which nothing else here does. Handled
# by name, not by a pattern, so the difference is visible in review.
if [ "$mod" = "tests/e2e" ]; then
echo "==> type-check $mod under -tags=e2e (tests run in the e2e-tests job)"
if ! (cd "$mod" && go vet -tags=e2e ./...) 2>&1 | tee "$log"; then
echo "::error::$mod failed to type-check under -tags=e2e"
status=1
fi
continue
fi
echo "==> unit tests in $mod"
# Profiles go to $RUNNER_TEMP, not the checkout: never leave working
# files in the repository root (repo coding guideline).
if ! (cd "$mod" && go test -v -race -short \
-coverprofile="$RUNNER_TEMP/coverage-${tag}.out" \
-covermode=atomic ./...) 2>&1 | tee "$log"; then
echo "::error::unit tests failed in $mod"
status=1
fi
# A module that runs zero tests is issue #1751 wearing a new
# costume: the loop would "cover" it while asserting nothing. Count
# top-level results (subtest lines are indented) and fail loudly.
ran=$(grep -cE '^--- (PASS|FAIL|SKIP)' "$log" || true)
echo "==> $mod ran $ran top-level test(s)"
if [ "$ran" -eq 0 ]; then
echo "::error::$mod ran zero tests -- it is in the loop but asserting nothing"
status=1
fi
done
# Merge the per-module profiles into the single file the steps below
# expect. A Go profile is one "mode:" header followed by block lines,
# so keep one header and concatenate the bodies.
shopt -s nullglob
profiles=("$RUNNER_TEMP"/coverage-*.out)
if [ "${#profiles[@]}" -eq 0 ]; then
echo "::error::no module produced a coverage profile" >&2
exit 1
fi
# Take the mode header from the first profile rather than hardcoding
# it: go test picks the default covermode itself (atomic whenever
# -race is on), so a literal here would silently mislabel the merge if
# the flags change.
merged="$RUNNER_TEMP/coverage.out"
head -n 1 "${profiles[0]}" > "$merged"
for p in "${profiles[@]}"; do
tail -n +2 "$p" >> "$merged"
done
echo "Merged ${#profiles[@]} coverage profile(s), $(( $(wc -l < "$merged") - 1 )) block(s)"
exit "$status"
- name: Upload coverage to Codecov
uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1
with:
files: ${{ runner.temp }}/coverage.out
flags: unittests
name: codecov-umbrella
fail_ci_if_error: false
- name: Generate coverage report
run: |
go tool cover -html="$RUNNER_TEMP/coverage.out" -o "$RUNNER_TEMP/coverage.html"
- name: Upload coverage artifacts
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
with:
name: coverage-report
path: |
${{ runner.temp }}/coverage.out
${{ runner.temp }}/coverage.html
retention-days: 30
- name: Check coverage threshold
run: |
coverage=$(go tool cover -func="$RUNNER_TEMP/coverage.out" | grep total | awk '{print $3}' | sed 's/%//')
echo "Total coverage: ${coverage}%"
if (( $(echo "$coverage < 80" | bc -l) )); then
echo "::warning::Coverage is below 80% (current: ${coverage}%)"
fi
# Integration tests with real PostgreSQL, sharded across parallel runners.
#
# Only the tests the Unit Tests job does not run are run here: those in
# `//go:build integration` files, plus untagged tests that skip themselves
# under -short. scripts/integration-test-selection.sh finds them and prints a
# `-run` regex per package; packages with none are not even compiled. Before
# that, this job re-ran every unit test under -tags=integration as well.
#
# Each leg runs the packages INTEGRATION_SHARDS gives its shard; `*` marks
# the catch-all shard, which takes every package with integration tests that
# no other shard names, so a new package is never silently skipped. Balance
# the shards by the per-package "ok ... <time>" lines in the test step's log.
# `needs: integration-tests` waits for every leg, so ci-success fails if any
# leg fails or is cancelled.
integration-tests:
name: Integration Tests (${{ matrix.title }})
runs-on: ubuntu-24.04-arm
permissions:
contents: read
strategy:
# One shard failing must not cancel the others: their results are what
# tell a real failure from a flaky one.
fail-fast: false
matrix:
# Same shards, same order as INTEGRATION_SHARDS below; the guard step
# fails on any difference.
#
# Balanced on PR #1402's first run (package test times under -race
# in the three-leg layout): api 87s, config 85s, auth 62s, server
# 55s, purchase 53s, migrations 64s, and the rest 95s together
# (testhelpers 32s, cleanup-lambda 15s, database 15s, scheduler 12s,
# analytics 12s, commitmentopts 9s; cleanup-lambda was deleted in
# #357, so the rest is about 80s now). api is the floor, as one package
# is never split; migrations and the rest run side by side within it.
include:
- shard: api
title: api
- shard: config
title: config
- shard: purchase
title: purchase
- shard: auth
title: auth
- shard: server
title: server
- shard: migrations-rest
title: migrations, rest
e2e-typecheck: true
env:
# <shard> <package path relative to the module> ... ; `*` = the rest.
# Shard names also go into cache keys and artifact names.
INTEGRATION_SHARDS: |
api internal/api
config internal/config
purchase internal/purchase
auth internal/auth
server internal/server
migrations-rest internal/database/postgres/migrations *
SHARD: ${{ matrix.shard }}
services:
postgres:
# Pinned by digest for the same reason as the linter images below: a
# floating tag lets the service container change under an unchanged
# repo, which is how #1695 turned main red.
image: postgres:16-alpine@sha256:cf78e76683b9ca8c5733cbbdce6c9262b45b6767934dd0a95e671f9a0fc20685
env:
POSTGRES_DB: cudly_test
POSTGRES_USER: cudly_test
POSTGRES_PASSWORD: test_password # CI-only throwaway password — not used in any real environment
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
ports:
- 5432:5432
steps:
- name: Checkout code
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Set up Go
uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
with:
go-version: ${{ env.GO_VERSION }}
# The caches below replace setup-go's. Its one entry is shared by
# every job, keyed on go.sum and saved by whichever job finishes
# first, so it never holds this job's -race -tags=integration
# coverage build: every leg compiled cold, minutes per leg.
cache: false
# Each leg restores its own build cache (GOCACHE), as each compiles a
# different set of packages, and the legs share one module cache
# (GOMODCACHE). Restore and save are separate steps, as in the
# security-scan job, so that a red run still warms the build cache.
- name: Compute Go cache keys
id: go_cache
run: |
set -euo pipefail
go_version=$(go env GOVERSION)
# sha256sum lines carry each path as well as its content, so a
# renamed file changes the hash too. The sources are every Go file
# plus everything under cmd/, internal/ and iac/, which covers the
# go:embed inputs (openapi.yaml, IaC templates). Including too much
# only costs a partial hit and a save.
hash_files() {
git ls-files -z -- "$@" | xargs -0 sha256sum | sha256sum | cut -d' ' -f1
}
mod_hash=$(hash_files go.work go.work.sum '*go.mod' '*go.sum')
src_hash=$(hash_files go.work go.work.sum '*go.mod' '*go.sum' '*.go' cmd internal iac)
build_any="integration-gobuild-${RUNNER_OS}-${RUNNER_ARCH}-${go_version}-"
{
echo "gocache=$(go env GOCACHE)"
echo "gomodcache=$(go env GOMODCACHE)"
echo "mod_prefix=integration-gomod-${RUNNER_OS}-${RUNNER_ARCH}-"
echo "mod_key=integration-gomod-${RUNNER_OS}-${RUNNER_ARCH}-${mod_hash}"
echo "build_any_prefix=${build_any}"
echo "build_prefix=${build_any}shard-${SHARD}-src-"
echo "build_key=${build_any}shard-${SHARD}-src-${src_hash}"
} | tee -a "$GITHUB_OUTPUT"
- name: Restore Go module cache
id: go_mod_cache
uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
with:
path: ${{ steps.go_cache.outputs.gomodcache }}
key: ${{ steps.go_cache.outputs.mod_key }}
# An older module set still saves most downloads; go fetches the
# rest.
restore-keys: ${{ steps.go_cache.outputs.mod_prefix }}
- name: Restore Go build cache
id: go_build_cache
uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
with:
path: ${{ steps.go_cache.outputs.gocache }}
key: ${{ steps.go_cache.outputs.build_key }}
# On a miss, this shard's latest entry (a PR's own, else main's),
# then any shard's (a renamed or new shard still gets the shared
# dependencies). Go's build cache is content-addressed: an entry
# from other sources is used only where it still matches, so a
# stale cache recompiles just what changed.
restore-keys: |
${{ steps.go_cache.outputs.build_prefix }}
${{ steps.go_cache.outputs.build_any_prefix }}
- name: Mark restored build cache entries unused
# Go moves an entry's mtime to now when it uses an entry that is over
# an hour old. Backdating every restored entry by two hours (well
# inside Go's own 5-day trim) lets the prune step below drop exactly
# the entries this run did not use, so a cache restored from an older
# key or from another shard does not keep growing.
env:
GOCACHE_DIR: ${{ steps.go_cache.outputs.gocache }}
run: |
set -euo pipefail
mkdir -p "$GOCACHE_DIR"
find "$GOCACHE_DIR" -mindepth 2 -maxdepth 2 -type f -print0 |
xargs -0 -r touch -m -d '2 hours ago'
touch "$RUNNER_TEMP/go-build-restored"
echo "Restored $(find "$GOCACHE_DIR" -mindepth 2 -maxdepth 2 -type f | wc -l) build cache entries, $(du -sh "$GOCACHE_DIR" | cut -f1)"
- name: Download the modules of every shard
id: go_mod_download
# Only on the leg that saves the module cache, and only on a miss, so
# the saved set covers every leg, not just this one's packages.
if: strategy.job-index == 0 && steps.go_mod_cache.outputs.cache-hit != 'true'
run: go list -deps -test -tags=integration ./... > /dev/null
- name: Install golang-migrate
run: |
# -tags 'pgx5', matching the Dockerfile and the library import in
# internal/database/postgres/migrations: the postgres tag links
# lib/pq, which carries unfixable advisories (issue #1849). No
# @version suffix: installed as a package of this module, so the
# version and dependency set come from go.mod.
go install -tags 'pgx5' github.com/golang-migrate/migrate/v4/cmd/migrate
- name: Run database migrations
env:
DB_HOST: localhost
DB_PORT: 5432
DB_NAME: cudly_test
DB_USER: cudly_test
DB_PASSWORD: test_password # CI-only throwaway password — not used in any real environment
run: |
if [ -d "internal/database/postgres/migrations" ]; then
# The password goes through PGPASSWORD, not the URL, so it needs no
# encoding whatever it contains (@ : / ? # % or spaces).
PGPASSWORD="$DB_PASSWORD" migrate -path internal/database/postgres/migrations \
-database "pgx5://${DB_USER}@${DB_HOST}:${DB_PORT}/${DB_NAME}?sslmode=disable" \
up
fi
- name: Select integration tests
run: |
set -euo pipefail
bash scripts/integration-test-selection.sh ./... > "$RUNNER_TEMP/selection.tsv"
echo "Packages with integration tests (top-level tests selected):"
awk -F'\t' '{ printf " %s (%d)\n", $1, $3 }' "$RUNNER_TEMP/selection.tsv"
- name: Check every package with integration tests is in exactly one shard
env:
SHARD_INDEX: ${{ strategy.job-index }}
SHARD_TOTAL: ${{ strategy.job-total }}
run: |
set -euo pipefail
# The matrix and INTEGRATION_SHARDS must list the same shards in the
# same order. job-index is unique per leg, so each spec shard then
# has exactly one leg, and no leg runs a shard the spec lacks.
mapfile -t names < <(awk 'NF { print $1 }' <<<"$INTEGRATION_SHARDS")
if [ "${#names[@]}" -ne "$SHARD_TOTAL" ] || [ "${names[$SHARD_INDEX]:-}" != "$SHARD" ]; then
echo "::error::matrix leg $((SHARD_INDEX + 1)) of $SHARD_TOTAL is shard '$SHARD', but INTEGRATION_SHARDS line $((SHARD_INDEX + 1)) of ${#names[@]} is '${names[$SHARD_INDEX]:-}'"
exit 1
fi
# Fails if a package lands in no shard or in two, if a named package
# has no integration tests left, or if a shard is left empty.
# From go.mod, not `go list -m`: the checked-in go.work makes that
# print tests/e2e's module path as well.
INTEGRATION_MODULE="$(awk '$1 == "module" { print $2; exit }' go.mod)" \
bash scripts/integration-test-selection.sh \
--shard "$SHARD" "$RUNNER_TEMP/selection.tsv" > "$RUNNER_TEMP/shard.tsv"
echo "Shard $SHARD runs:"
cut -f1 "$RUNNER_TEMP/shard.tsv" | sed 's/^/ /'
- name: Run integration tests
id: integration_tests
env:
DB_HOST: localhost
DB_PORT: 5432
DB_NAME: cudly_test
DB_USER: cudly_test
DB_PASSWORD: test_password # CI-only throwaway password — not used in any real environment
DB_SSL_MODE: disable
run: |
set -uo pipefail
log="$RUNNER_TEMP/integration-${SHARD}.log"
profile="$RUNNER_TEMP/coverage-integration-${SHARD}.out"
mapfile -t pkgs < <(cut -f1 "$RUNNER_TEMP/shard.tsv")
# One go test for the whole shard, so its packages still build and
# run in parallel. -run is the per-package regexes joined by |; a
# name only matches that name, so another package in the shard runs
# extra tests only if it has a test of the same name (counted below).
run_regex="$(cut -f2 "$RUNNER_TEMP/shard.tsv" | paste -sd'|' -)"
selected=$(awk -F'\t' '{ n += $3 } END { print n + 0 }' "$RUNNER_TEMP/shard.tsv")
status=0
echo "==> integration tests: ${pkgs[*]}"
# -count=1: with the build cache restored, go test would otherwise
# replay an earlier run's results. -run, -v, -timeout and
# -coverprofile are all cacheable test flags, and go test cannot
# see that the tests depend on the database.
if ! go test -count=1 -v -race -tags=integration -timeout=20m \
-run "$run_regex" \
-coverprofile="$profile" \
"${pkgs[@]}" 2>&1 | tee "$log"; then
echo "::error::integration tests failed in shard $SHARD"
status=1
fi
# Every selected test reports exactly one top-level result line
# (subtests are indented). Fewer means the selection named tests
# that did not run; zero is the #1751 shape, asserting nothing.
ran=$(grep -cE '^--- (PASS|FAIL|SKIP)' "$log" || true)
echo "==> shard $SHARD ran $ran of $selected selected top-level test(s)"
if [ "$ran" -eq 0 ] || [ "$ran" -lt "$selected" ]; then
echo "::error::shard $SHARD ran $ran top-level test(s), $selected were selected"
status=1
elif [ "$ran" -gt "$selected" ]; then
echo "::warning::shard $SHARD ran $ran top-level tests for $selected selected: a selected name also names a unit test in another package of this shard, which therefore ran twice"
fi
if [ ! -s "$profile" ]; then
echo "::error::shard $SHARD produced no integration coverage profile" >&2
status=1
fi
exit "$status"
- name: Type-check tests/e2e under -tags=e2e
# tests/e2e holds only //go:build e2e files in a module of its own, so
# it has no package to test here; its tests run in the e2e-tests job.
# One leg is enough for a type-check. It runs even when the tests
# failed, as both results were reported side by side before.
if: ${{ !cancelled() && matrix.e2e-typecheck }}
working-directory: tests/e2e
run: go vet -tags=e2e ./...
- name: Drop build cache entries this run did not use
id: go_build_prune
# Whenever the tests ran, pass or fail, so a red run still warms the
# cache. Not on an exact hit: that key is already saved.
if: ${{ !cancelled() && steps.go_build_cache.outputs.cache-hit != 'true' && (steps.integration_tests.outcome == 'success' || steps.integration_tests.outcome == 'failure') }}
env:
GOCACHE_DIR: ${{ steps.go_cache.outputs.gocache }}
run: |
set -euo pipefail
# Entries still older than the marker were restored and never used
# (see "Mark restored build cache entries unused").
dropped=$(find "$GOCACHE_DIR" -mindepth 2 -maxdepth 2 -type f \
! -newer "$RUNNER_TEMP/go-build-restored" -print -delete | wc -l)
echo "Dropped $dropped unused entries; saving $(find "$GOCACHE_DIR" -mindepth 2 -maxdepth 2 -type f | wc -l), $(du -sh "$GOCACHE_DIR" | cut -f1)"
- name: Save Go build cache
if: ${{ !cancelled() && steps.go_build_prune.outcome == 'success' }}
uses: actions/cache/save@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
with:
path: ${{ steps.go_cache.outputs.gocache }}
key: ${{ steps.go_cache.outputs.build_key }}
- name: Save Go module cache
if: ${{ !cancelled() && steps.go_mod_download.outcome == 'success' }}
uses: actions/cache/save@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
with:
path: ${{ steps.go_cache.outputs.gomodcache }}
key: ${{ steps.go_cache.outputs.mod_key }}
- name: Upload integration coverage
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
with:
# One artifact per shard; the integration-coverage job below merges
# them into the single artifact this job used to upload. Short
# retention: only the merged one is kept for 30 days.
name: integration-coverage-${{ matrix.shard }}
path: ${{ runner.temp }}/coverage-integration-${{ matrix.shard }}.out
if-no-files-found: error
retention-days: 1
# Rebuild the integration-coverage artifact (coverage-integration.out) the
# unsharded job used to upload. That job ran the unit tests too, so its
# profile covered both suites; the shards run only integration tests, so
# the unit job's profile is merged back in and the artifact keeps its
# meaning (81.6% total on main's run 40153816430, 81.6% for the same merge
# on this layout). Nothing in CI reads it: Codecov and the 80% coverage
# warning use the unit job's own profile. Produced only when every shard
# and the unit job passed.
integration-coverage:
name: Merge integration coverage
needs: [unit-tests, integration-tests]
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Download shard coverage
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
with:
pattern: integration-coverage-*
path: ${{ runner.temp }}/shards
merge-multiple: true
- name: Download unit coverage
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
with:
name: coverage-report
path: ${{ runner.temp }}/unit
- name: Merge profiles
run: |
set -euo pipefail
shopt -s nullglob
profiles=("$RUNNER_TEMP"/shards/coverage-integration-*.out)
if [ "${#profiles[@]}" -eq 0 ]; then
echo "::error::no integration shard produced a coverage profile" >&2
exit 1
fi
profiles+=("$RUNNER_TEMP/unit/coverage.out")
# Same merge as the unit job: one "mode:" header, then every
# profile's blocks. All are atomic (-race); a block present in
# more than one profile is summed by go tool cover when read.
merged="$RUNNER_TEMP/coverage-integration.out"
head -n 1 "${profiles[0]}" > "$merged"
for p in "${profiles[@]}"; do
if [ "$(head -n 1 "$p")" != "$(head -n 1 "$merged")" ]; then
echo "::error::$p has '$(head -n 1 "$p")', expected '$(head -n 1 "$merged")'" >&2
exit 1
fi
tail -n +2 "$p" >> "$merged"
done
echo "Merged ${#profiles[@]} coverage profile(s), $(( $(wc -l < "$merged") - 1 )) block(s)"
- name: Upload integration coverage
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
with:
name: integration-coverage
path: ${{ runner.temp }}/coverage-integration.out
retention-days: 30
# Self-test for scripts/integration-test-selection.sh, which decides what the
# Integration Tests job runs. A selector that drops a test drops it from CI
# entirely, as the Unit Tests job skips integration files, so the suite
# asserts both directions over fixture packages. Needs Go (go list); the
# fixtures are stdlib-only, so no module cache.
integration-test-selection:
name: Integration test selection self-test
runs-on: ubuntu-24.04-arm
permissions:
contents: read
steps:
- name: Checkout code
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Set up Go
uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
with:
go-version: ${{ env.GO_VERSION }}
cache: false
- name: Run selection self-tests
run: bash scripts/test-integration-test-selection.sh
# Docker image build test, once per architecture the image ships for.
#
# The AWS deploys (deploy-aws-lambda.yml, deploy-aws-fargate.yml) build
# linux/arm64 natively on ubuntu-24.04-arm for Graviton; GCP and Azure build
# linux/amd64 on ubuntu-latest. This job used to build amd64 only, so the
# arm64 image AWS actually runs was first built by a deploy (#56). Each leg
# builds natively on the same runner its deploy uses, so the Dockerfile's
# $BUILDPLATFORM stages run on the same images and architecture as in
# production, with no QEMU. `needs: docker-build` waits for every leg, so
# ci-success fails if either architecture does.
docker-build:
name: Build Docker Image (${{ matrix.arch }})
runs-on: ${{ matrix.runner }}
permissions:
contents: read
strategy:
# One architecture failing must not cancel the other: its result is the
# thing this matrix exists to report.
fail-fast: false
matrix:
include:
- arch: amd64
runner: ubuntu-latest
cache-from: type=gha
cache-to: type=gha,mode=max
# No GHA cache on this leg. The repository's Actions cache is
# already at its 10 GB limit, mostly buildkit blobs from the amd64
# leg, and a second mode=max scope would evict other jobs' caches.
# A cold native arm64 build takes about 2 minutes (measured in
# deploy-aws-lambda.yml), and this job is not on the critical path.
- arch: arm64
runner: ubuntu-24.04-arm
cache-from: ''
cache-to: ''
steps:
- name: Checkout code
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
- name: Build Docker image
uses: docker/build-push-action@c3c9e263c25d99ce0380d002d59b67737d91b0dc # v7.4.0
with:
context: .
push: false
# Stated rather than left to the builder's default, so the image's
# architecture is the matrix's and not whatever the runner is.
platforms: linux/${{ matrix.arch }}
# Export the built image into the local docker image store so the
# steps below inspect the artifact this job just produced,
# rather than rebuilding one and hoping it is the same.
load: true
tags: cudly:${{ github.sha }}
cache-from: ${{ matrix.cache-from }}
cache-to: ${{ matrix.cache-to }}
build-args: |
VERSION=${{ github.sha }}
# Go is needed by both the architecture check and the image scan below.
- name: Set up Go
uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
with:
go-version: ${{ env.GO_VERSION }}
# Replaces a step that rebuilt the image with plain `docker build` (2m18s
# on amd64) and ran `/app/cudly --version || true`, which asserted
# nothing: cudly has no --version flag, and `|| true` hid every failure.
# The plain `docker build` path is still covered by the e2e-tests job,
# whose compose file builds this Dockerfile.
- name: Verify image architecture and binaries
env:
IMAGE: cudly:${{ github.sha }}
ARCH: ${{ matrix.arch }}
run: |
set -euo pipefail
fail() { echo "::error::$*"; exit 1; }
# Native, not emulated: the runner's own architecture is the target.
case "$RUNNER_ARCH" in
X64) runner_arch=amd64 ;;
ARM64) runner_arch=arm64 ;;
*) runner_arch="$RUNNER_ARCH" ;;
esac
[ "$runner_arch" = "$ARCH" ] ||
fail "runner is $RUNNER_ARCH, expected a native $ARCH runner"
platform="$(docker image inspect --format '{{.Os}}/{{.Architecture}}' "$IMAGE")"
[ "$platform" = "linux/$ARCH" ] ||
fail "image $IMAGE is $platform, expected linux/$ARCH"
# The image metadata alone does not prove what was compiled into it:
# read GOOS/GOARCH from each Go binary's embedded build info.
bins="$(mktemp -d "$RUNNER_TEMP/image-bins.XXXXXX")"
cid="$(docker create "$IMAGE")"
trap 'docker rm -f "$cid" >/dev/null' EXIT
for bin in /app/cudly /usr/local/bin/migrate; do
out="$bins/$(basename "$bin")"
docker cp "$cid:$bin" "$out"
info="$(go version -m "$out")"
if ! grep -qxF "$(printf '\tbuild\tGOOS=linux')" <<<"$info" ||
! grep -qxF "$(printf '\tbuild\tGOARCH=%s' "$ARCH")" <<<"$info"; then
fail "$bin is not a linux/$ARCH Go binary: $(awk '$1 == "build" && $2 ~ /^GO(OS|ARCH)=/ { printf "%s ", $2 }' <<<"$info")"
fi
echo "$bin: linux/$ARCH"
done
# And both execute. cudly runs through the real entrypoint, which
# appends --mode/--port; -h stops flag parsing there and exits 0.
timeout 60 docker run --rm "$IMAGE" /app/cudly -h
timeout 60 docker run --rm --entrypoint /usr/local/bin/migrate "$IMAGE" -version
# Nothing else in the pipeline looks at the artifact: govulncheck runs in
# source mode, and Trivy runs with scan-type fs and config, all against
# the repository. A vulnerable binary baked into the image was invisible
# by construction, which is how #1833 shipped twice (issue #1836). These
# steps live in this job rather than a new one so the image is scanned
# without being built again; docker-build is already in ci-success's
# needs, so the gate is wired. They run on both legs: the arm64 image is
# the one the AWS deploys ship.
- name: Install govulncheck
run: |
# Same pin as the security-scan job: a govulncheck release with new
# detection logic must not silently change this gate's verdict
# between PRs.
go install golang.org/x/vuln/cmd/govulncheck@v1.1.4
- name: Run image scan self-tests
# Asserts both directions of the verdict against recorded govulncheck
# output, so a scanner that can no longer fail cannot ship as coverage.
run: bash scripts/test-scan-shipped-image.sh
- name: Run govulncheck retry self-tests
run: bash scripts/test-govulncheck-retry.sh
- name: Scan the shipped image for Go advisories
env:
IMAGE: cudly:${{ github.sha }}
run: bash scripts/scan-shipped-image.sh "$IMAGE"
# Terraform validation for all environments
terraform-validate:
name: Validate Terraform (${{ matrix.cloud }})
runs-on: ubuntu-latest
permissions:
contents: read
env:
CLOUD: ${{ matrix.cloud }}
strategy:
matrix:
cloud: [aws, gcp, azure]
fail-fast: false
steps:
- name: Checkout code
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Read Terraform version
# The one pin lives in .terraform-version (issue #349); the script
# validates it, because an empty terraform_version means `latest`.
id: terraform-version
run: bash scripts/terraform-version.sh
- name: Setup Terraform
uses: hashicorp/setup-terraform@dfe3c3f87815947d99a8997f908cb6525fc44e9e # v4.0.1
with:
# .terraform-version must satisfy `required_version = ">= 1.10.0"`
# declared by every terraform/environments/*/main.tf -- below 1.10
# `terraform init`/`validate` abort with "Unsupported Terraform
# Core version". Every workflow that installs Terraform reads the
# same file, so validate here and apply in the deploy workflows
# run the same binary.
terraform_version: ${{ steps.terraform-version.outputs.version }}
- name: Terraform Format Check
# Must cover every SCAN_ROOTS entry in scripts/check-gcp-secret-scope.sh,
# whose block tracking was written against fmt layout (#150). The
# guard's self-test fails if a scan root has no line here.