This repository was archived by the owner on Aug 30, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 230
327 lines (281 loc) · 9.32 KB
/
go.yml
File metadata and controls
327 lines (281 loc) · 9.32 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
on:
pull_request:
paths:
- cli/**.go
- backend/**.go
- worker/**.go
- internal/**.go
- go.mod
- go.sum
- tools/go.mod
- tools/go.sum
push:
branches:
- main
paths:
- cli/**.go
- backend/**.go
- worker/**.go
- internal/**.go
- go.mod
- go.sum
name: Go
jobs:
golangci:
name: golang-lint
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version-file: go.mod
cache-dependency-path: go.sum
- name: golangci-lint
uses: golangci/golangci-lint-action@v7
with:
version: latest
args: --timeout=10m
vet:
name: vet
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version-file: go.mod
cache-dependency-path: go.sum
- name: Vet
run: go vet ./...
# Ensures that go generate runs and has no working directory changes afterwards
generate:
name: Go Generate
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version-file: go.mod
cache-dependency-path: go.sum
- name: Generate
run: go generate ./...
- name: Check for git changes
run: |
if [ -n "$(git status --porcelain .)" ]; then
echo "Error: git has changes after running 'go generate'"
echo "Please run 'go generate ./...' and commit the changes."
exit 1
fi
unit-test:
name: Unit Tests
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version-file: go.mod
cache-dependency-path: go.sum
- name: Test
run: |
go test -race -coverprofile=unit-coverage.out -covermode=atomic ./...
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v5
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
cli-integration-tests:
name: CLI Integration Tests
runs-on: ubuntu-latest
permissions:
id-token: write # required for requesting JWT for use with retrieving AWS creds
contents: read # required for actions/checkout
env:
AWS_REGION: "us-west-2"
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version-file: go.mod
cache-dependency-path: go.sum
- name: Configure AWS Credentials
uses: aws-actions/configure-aws-credentials@v4
with:
aws-region: ${{ env.AWS_REGION }}
role-to-assume: ${{ vars.INTEGRATION_TEST_AWS_ROLE_ARN }}
role-session-name: NeosyncCiIntegrationTests
- name: Run Integration Tests
run: |
go test -race -timeout 1800s -coverprofile=integration-coverage.out -covermode=atomic ./cli/...
env:
CLI_INTEGRATION_TESTS_ENABLED: 1
S3_INTEGRATION_TESTS_ENABLED: 1
TEST_S3_REGION: ${{ env.AWS_REGION }}
TEST_S3_BUCKET: ${{ vars.INTEGRATION_TEST_BUCKET_NAME }}
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v5
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
worker-integration-tests:
name: Worker Integration Tests
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version-file: go.mod
cache-dependency-path: go.sum
- name: Run Integration Tests
run: |
go test -race -timeout 1800s -coverprofile=integration-coverage.out -covermode=atomic ./internal/integration-tests/worker/...
env:
WORKER_INTEGRATION_TESTS_ENABLED: 1
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v5
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
integration-tests:
name: Integration Tests
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version-file: go.mod
cache-dependency-path: go.sum
- name: Run Integration Tests
run: |
go test -race -timeout 1800s -coverprofile=integration-coverage.out -covermode=atomic ./internal/integration-tests/...
env:
INTEGRATION_TESTS_ENABLED: 1
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v5
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
go-mod-tidy-check:
name: go-mod-tidy-check
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version-file: go.mod
cache-dependency-path: go.sum
- name: Run go mod tidy
run: go mod tidy
- name: Check for changes in go.mod and go.sum
run: |
if [ -n "$(git status --porcelain go.mod go.sum)" ]; then
echo "Error: go.mod and/or go.sum have changes after running 'go mod tidy'"
echo "Please run 'go mod tidy' and commit the changes."
exit 1
fi
tools-go-mod-tidy-check:
name: tools-go-mod-tidy-check
runs-on: ubuntu-latest
defaults:
run:
working-directory: tools
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version-file: tools/go.mod
cache-dependency-path: tools/go.sum
- name: Run go mod tidy
run: go mod tidy
- name: Check for changes in go.mod and go.sum
run: |
if [ -n "$(git status --porcelain go.mod go.sum)" ]; then
echo "Error: go.mod and/or go.sum have changes after running 'go mod tidy'"
echo "Please run 'go mod tidy' in the tools directory and commit the changes."
exit 1
fi
benchmark:
name: benchmarks
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version-file: go.mod
cache-dependency-path: go.sum
- name: Install benchstat
run: go install golang.org/x/perf/cmd/benchstat@latest
- name: Restore benchmark cache
id: cache-restore
uses: actions/cache/restore@v4
with:
path: main-benchmark.txt
key: benchmarks-main
restore-keys: benchmarks-main
- name: Run benchmarks on main if cache miss
if: steps.cache-restore.outputs.cache-hit != 'true'
run: |
git fetch origin main
git checkout origin/main
go test -run=^$ -bench=. -benchmem -count=6 ./... | grep -E "Benchmark" | tee main-benchmark.txt
git checkout -
- name: Cache main branch benchmark results
if: steps.cache-restore.outputs.cache-hit != 'true'
uses: actions/cache/save@v4
with:
path: main-benchmark.txt
key: benchmarks-main
- name: Run branch benchmark
run: go test -run=^$ -bench=. -benchmem -count=6 ./... | grep -E "Benchmark" | tee branch-benchmark.txt
- name: Compare benchmarks
run: |
# Run benchstat and save output
benchstat main-benchmark.txt branch-benchmark.txt | tee benchstat-output.txt
echo "### Benchstat Geomean Results" > benchstat-results.txt
if grep -q "geomean" benchstat-output.txt; then
changes=( $(grep "geomean" benchstat-output.txt | awk '{
for(i=1; i<=NF; i++) {
if($i ~ /%/) {
gsub(/[+%]/, "", $i)
print $i
}
}
}') )
if [ ${#changes[@]} -ge 3 ]; then
result="${changes[0]}% sec/op, ${changes[1]}% B/op, ${changes[2]}% allocs/op"
echo -e "\n$result" >> benchstat-results.txt
else
echo -e "\nError: Not enough metrics found in benchstat output" >> benchstat-results.txt
fi
else
echo -e "\nNo geomean found in benchstat output" >> benchstat-results.txt
fi
echo -e "\n<details>\n<summary>Benchstat results</summary>\n\n\`\`\`\n$(cat benchstat-output.txt)\n\`\`\`\n</details>\n" >> benchstat-results.txt
- name: Comment Benchstat Results on PR
if: github.event_name == 'pull_request'
uses: thollander/actions-comment-pull-request@v3
with:
file-path: benchstat-results.txt
comment-tag: benchmark-results
github-token: ${{ secrets.GITHUB_TOKEN }}
# if this is main branch, cache the results
- name: Cache main branch benchmark results
if: github.ref == 'refs/heads/main'
uses: actions/cache/save@v4
with:
path: branch-benchmark.txt
key: benchmarks-main