-
Notifications
You must be signed in to change notification settings - Fork 0
386 lines (337 loc) · 11.2 KB
/
ci.yml
File metadata and controls
386 lines (337 loc) · 11.2 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
# =============================================================================
# TelemetryFlow Go SDK - CI Workflow
# =============================================================================
#
# TelemetryFlow Go SDK - Community Enterprise Observability Platform (CEOP)
# Copyright (c) 2024-2026 DevOpsCorner Indonesia. All rights reserved.
#
# This workflow runs tests and linting for the TelemetryFlow Go SDK:
# - Unit tests
# - Integration tests
# - Linting with golangci-lint
# - Code coverage
#
# =============================================================================
name: CI - TFO Go SDK
on:
push:
branches:
- main
- master
- develop
- 'feature/**'
- 'release/**'
paths:
- 'cmd/**'
- 'internal/**'
- 'pkg/**'
- 'tests/**'
- 'go.mod'
- 'go.sum'
- '.github/workflows/ci.yml'
pull_request:
branches:
- main
- master
- develop
paths:
- 'cmd/**'
- 'internal/**'
- 'pkg/**'
- 'tests/**'
- 'go.mod'
- 'go.sum'
workflow_dispatch:
inputs:
run_e2e:
description: 'Run E2E tests'
required: false
type: boolean
default: false
skip_lint:
description: 'Skip linting'
required: false
type: boolean
default: false
env:
GO_VERSION: '1.24'
PRODUCT_NAME: TelemetryFlow Go SDK
permissions:
contents: read
security-events: write
pull-requests: write
jobs:
# ===========================================================================
# Code Quality - Lint, Vet, Format
# ===========================================================================
lint:
name: Lint & Code Quality
runs-on: ubuntu-latest
if: ${{ !inputs.skip_lint }}
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: ${{ env.GO_VERSION }}
cache: true
- name: Download and verify dependencies
run: make deps-verify
- name: Check formatting
run: make fmt-check
- name: Run go vet
run: make vet
- name: Run staticcheck
run: make staticcheck
- name: Run golangci-lint
uses: golangci/golangci-lint-action@v7
with:
version: v2.7.2
args: --timeout=5m
skip-cache: true
verify: false
# ===========================================================================
# Unit Tests
# ===========================================================================
test-unit:
name: Unit Tests
runs-on: ubuntu-latest
needs: lint
if: always() && (needs.lint.result == 'success' || needs.lint.result == 'skipped')
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: ${{ env.GO_VERSION }}
cache: true
- name: Download dependencies
run: make deps
- name: Run unit tests
run: make test-unit-ci
- name: Upload unit test coverage
uses: actions/upload-artifact@v4
with:
name: coverage-unit
path: coverage-unit.out
retention-days: 7
# ===========================================================================
# Integration Tests
# ===========================================================================
test-integration:
name: Integration Tests
runs-on: ubuntu-latest
needs: lint
if: always() && (needs.lint.result == 'success' || needs.lint.result == 'skipped')
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: ${{ env.GO_VERSION }}
cache: true
- name: Download dependencies
run: make deps
- name: Run integration tests
run: make test-integration-ci
- name: Upload integration test coverage
uses: actions/upload-artifact@v4
with:
name: coverage-integration
path: coverage-integration.out
retention-days: 7
# ===========================================================================
# E2E Tests (Optional)
# ===========================================================================
test-e2e:
name: E2E Tests
runs-on: ubuntu-latest
needs: [test-unit, test-integration]
if: ${{ inputs.run_e2e == true || github.event_name == 'push' && github.ref == 'refs/heads/main' }}
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: ${{ env.GO_VERSION }}
cache: true
- name: Download dependencies
run: make deps
- name: Run E2E tests
run: make test-e2e-ci
# ===========================================================================
# Build Verification Generators
# ===========================================================================
build:
name: Build (${{ matrix.os }}/${{ matrix.arch }})
runs-on: ${{ matrix.runner }}
needs: lint
if: always() && (needs.lint.result == 'success' || needs.lint.result == 'skipped')
strategy:
fail-fast: false
matrix:
include:
- os: linux
arch: amd64
runner: ubuntu-latest
- os: linux
arch: arm64
runner: ubuntu-latest
- os: darwin
arch: amd64
runner: macos-latest
- os: darwin
arch: arm64
runner: macos-latest
- os: windows
arch: amd64
runner: windows-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: ${{ env.GO_VERSION }}
cache: true
- name: Download dependencies
run: make deps
- name: Build generators (Unix)
if: matrix.os != 'windows'
run: make build-generators
- name: Build generators (Windows)
if: matrix.os == 'windows'
shell: bash
run: make ci-build-generators
env:
GOOS: ${{ matrix.os }}
GOARCH: ${{ matrix.arch }}
- name: Verify binaries (Unix)
if: matrix.os != 'windows'
run: |
./build/telemetryflow-gen version
./build/telemetryflow-restapi version
- name: Verify binaries (Windows)
if: matrix.os == 'windows'
run: |
.\dist\telemetryflow-gen-windows-amd64.exe version
.\dist\telemetryflow-restapi-windows-amd64.exe version
# ===========================================================================
# Security Scan
# ===========================================================================
security:
name: Security Scan
runs-on: ubuntu-latest
needs: lint
if: always() && (needs.lint.result == 'success' || needs.lint.result == 'skipped')
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: ${{ env.GO_VERSION }}
cache: true
- name: Download dependencies
run: make deps
- name: Run Gosec Security Scanner
uses: securego/gosec@master
with:
args: '-no-fail -fmt sarif -out gosec-results.sarif ./...'
- name: Upload SARIF file
uses: github/codeql-action/upload-sarif@v4
if: always()
with:
sarif_file: gosec-results.sarif
- name: Run govulncheck
run: make govulncheck
# ===========================================================================
# Coverage Report
# ===========================================================================
coverage:
name: Coverage Report
runs-on: ubuntu-latest
needs: [test-unit, test-integration]
if: always() && needs.test-unit.result == 'success'
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: ${{ env.GO_VERSION }}
cache: true
- name: Download unit coverage
uses: actions/download-artifact@v4
with:
name: coverage-unit
path: coverage/
- name: Download integration coverage
uses: actions/download-artifact@v4
with:
name: coverage-integration
path: coverage/
continue-on-error: true
- name: Prepare coverage files
run: |
cp coverage/coverage-unit.out coverage-unit.out
if [ -f coverage/coverage-integration.out ]; then
cp coverage/coverage-integration.out coverage-integration.out
fi
- name: Generate coverage report
run: make coverage-report
- name: Move coverage files
run: |
mv coverage-merged.out coverage/coverage-merged.out
mv coverage-summary.txt coverage/coverage-summary.txt
mv coverage.html coverage/coverage.html
- name: Upload coverage report
uses: actions/upload-artifact@v4
with:
name: coverage-report
path: coverage/
retention-days: 30
- name: Coverage summary
run: |
echo "## Coverage Summary" >> $GITHUB_STEP_SUMMARY
echo '```' >> $GITHUB_STEP_SUMMARY
cat coverage/coverage-summary.txt >> $GITHUB_STEP_SUMMARY
echo '```' >> $GITHUB_STEP_SUMMARY
# ===========================================================================
# CI Summary
# ===========================================================================
summary:
name: CI Summary
runs-on: ubuntu-latest
needs: [lint, test-unit, test-integration, build, security, coverage]
if: always()
steps:
- name: Generate summary
run: |
echo "## ${{ env.PRODUCT_NAME }} - CI Results" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "| Job | Status |" >> $GITHUB_STEP_SUMMARY
echo "|-----|--------|" >> $GITHUB_STEP_SUMMARY
echo "| Lint | ${{ needs.lint.result }} |" >> $GITHUB_STEP_SUMMARY
echo "| Unit Tests | ${{ needs.test-unit.result }} |" >> $GITHUB_STEP_SUMMARY
echo "| Integration Tests | ${{ needs.test-integration.result }} |" >> $GITHUB_STEP_SUMMARY
echo "| Build | ${{ needs.build.result }} |" >> $GITHUB_STEP_SUMMARY
echo "| Security | ${{ needs.security.result }} |" >> $GITHUB_STEP_SUMMARY
echo "| Coverage | ${{ needs.coverage.result }} |" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "**Commit:** ${{ github.sha }}" >> $GITHUB_STEP_SUMMARY
echo "**Branch:** ${{ github.ref_name }}" >> $GITHUB_STEP_SUMMARY
echo "**Triggered by:** ${{ github.event_name }}" >> $GITHUB_STEP_SUMMARY
- name: Check overall status
run: |
if [[ "${{ needs.lint.result }}" == "failure" ]] || \
[[ "${{ needs.test-unit.result }}" == "failure" ]] || \
[[ "${{ needs.build.result }}" == "failure" ]]; then
echo "CI failed - one or more required jobs failed"
exit 1
fi
echo "CI passed successfully"