|
1 | 1 | name: go test |
2 | 2 |
|
3 | 3 | permissions: |
4 | | - contents: read |
5 | 4 | pull-requests: read |
| 5 | + contents: read |
6 | 6 |
|
7 | 7 | on: |
8 | 8 | push: |
9 | | - tags: |
10 | | - - v* |
11 | 9 | branches: |
12 | 10 | - master |
13 | 11 |
|
14 | 12 | pull_request: |
15 | 13 |
|
16 | 14 | jobs: |
17 | | - lint: |
18 | | - name: Go lint mono-repo |
19 | | - runs-on: ubuntu-latest |
20 | | - steps: |
21 | | - - |
22 | | - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 |
23 | | - with: |
24 | | - fetch-depth: '0' |
25 | | - - |
26 | | - uses: actions/setup-go@7a3fe6cf4cb3a834922a1244abfce67bcef6a0c5 # v6.2.0 |
27 | | - with: |
28 | | - go-version: stable |
29 | | - check-latest: true |
30 | | - cache: true |
31 | | - cache-dependency-path: '**/go.sum' |
32 | | - - |
33 | | - name: Install golangci-lint |
34 | | - uses: golangci/golangci-lint-action@1e7e51e771db61008b38414a730f564565cf7c20 # v9.2.0 |
35 | | - with: |
36 | | - version: latest |
37 | | - skip-cache: true |
38 | | - install-only: true |
39 | | - - |
40 | | - name: Lint multiple modules |
41 | | - # golangci-lint doesn't support go.work to lint multiple modules in one single pass |
42 | | - run: | |
43 | | - set -euxo pipefail |
44 | | -
|
45 | | - git fetch origin master |
46 | | - git show --no-patch --oneline origin/master |
47 | | -
|
48 | | - while read module_location ; do |
49 | | - pushd "${module_location}" |
50 | | - golangci-lint run --new-from-rev origin/master |
51 | | - popd |
52 | | - done < <(go list -f '{{.Dir}}' -m) |
53 | | -
|
54 | | - module-test: |
55 | | - name: Unit tests |
56 | | - runs-on: ${{ matrix.os }} |
57 | | - needs: [ lint ] |
58 | | - |
59 | | - strategy: |
60 | | - matrix: |
61 | | - os: [ ubuntu-latest, macos-latest, windows-latest ] |
62 | | - go_version: ['oldstable', 'stable' ] |
63 | | - env: |
64 | | - TEST_REPORT: 'all_modules.report.${{ matrix.os }}.${{ matrix.go_version }}.json' |
65 | | - |
66 | | - steps: |
67 | | - - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 |
68 | | - - uses: actions/setup-go@7a3fe6cf4cb3a834922a1244abfce67bcef6a0c5 # v6.2.0 |
69 | | - with: |
70 | | - go-version: '${{ matrix.go_version }}' |
71 | | - check-latest: true |
72 | | - cache: true |
73 | | - cache-dependency-path: '**/go.sum' |
74 | | - |
75 | | - - name: Run unit tests on all modules in this repo |
76 | | - shell: bash |
77 | | - env: |
78 | | - # *.coverage.* pattern is automatically detected by codecov |
79 | | - COVER_PROFILE: 'all_modules.coverage.${{ matrix.os }}.${{ matrix.go_version }}.out' |
80 | | - run: | |
81 | | - # when go1.25 becomes the oldstable, we may replace this bash with "go test work" |
82 | | - declare -a ALL_MODULES |
83 | | - BASH_MAJOR=$(echo $BASH_VERSION|cut -d'.' -f1) |
84 | | - if [[ "${BASH_MAJOR}" -ge 4 ]] ; then |
85 | | - mapfile ALL_MODULES < <(go list -f '{{.Dir}}/...' -m) |
86 | | - else |
87 | | - # for older bash versions, e.g. on macOS runner. This fallback will eventually disappear. |
88 | | - while read line ; do |
89 | | - ALL_MODULES+=("${line}") |
90 | | - done < <(go list -f '{{.Dir}}/...' -m) |
91 | | - fi |
92 | | - echo "::notice title=Modules found::${ALL_MODULES[@]}" |
93 | | -
|
94 | | - # with go.work file enabled, go test recognizes sub-modules and collects all packages to be covered |
95 | | - # without specifying -coverpkg. |
96 | | - go test -race -coverprofile="${COVER_PROFILE}" -covermode=atomic -json ${ALL_MODULES[@]}|tee -a "${TEST_REPORT}" |
97 | | -
|
98 | | - - name: Upload coverage to codecov |
99 | | - if: ${{ success() }} # we do this only if all previous steps succeeded |
100 | | - uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5.5.2 |
101 | | - with: |
102 | | - name: Multi modules aggregated coverage |
103 | | - flags: '${{ matrix.go_version }}-${{ matrix.os }}' |
104 | | - fail_ci_if_error: false |
105 | | - verbose: false |
106 | | - |
107 | | - - name: Upload JSON test Results |
108 | | - if: always() |
109 | | - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 |
110 | | - with: |
111 | | - name: 'all_modules.report.${{ matrix.os }}.${{ matrix.go_version }}' |
112 | | - path: ${{ env.TEST_REPORT }} |
113 | | - |
114 | 15 | test: |
115 | | - needs: [ module-test ] |
116 | | - name: Test |
117 | | - runs-on: ubuntu-latest |
118 | | - steps: |
119 | | - - name: Tests complete |
120 | | - run: | |
121 | | - echo "::notice title=Success::All tests completed" |
122 | | -
|
123 | | - collect-reports: |
124 | | - if: always() |
125 | | - needs: [ module-test ] |
126 | | - name: Collect and merge test reports |
127 | | - runs-on: ubuntu-latest |
128 | | - steps: |
129 | | - - uses: actions/setup-go@7a3fe6cf4cb3a834922a1244abfce67bcef6a0c5 # v6.2.0 |
130 | | - with: |
131 | | - go-version: stable |
132 | | - check-latest: true |
133 | | - cache: true |
134 | | - |
135 | | - - name: Download all JSON artifacts |
136 | | - uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0 |
137 | | - with: |
138 | | - run-id: "${{ github.run_id }}" |
139 | | - pattern: "all_modules.report.*" |
140 | | - # artifacts resolve as folders |
141 | | - path: reports/ |
142 | | - |
143 | | - - name: Convert test reports to a merged JUnit XML |
144 | | - # NOTE: codecov test reports only support JUnit format at this moment. See https://docs.codecov.com/docs/test-analytics. |
145 | | - # Ideally, codecov improve a bit their platform, so we may only need a single pass to CTRF format. |
146 | | - # |
147 | | - # As a contemplated alternative, we could use gotestsum above to produce the JUnit XML directly. |
148 | | - run: | |
149 | | - go install github.com/jstemmer/go-junit-report/v2@latest |
150 | | - cat reports/*/*.json | go-junit-report -parser gojson -out=reports/junit_report.xml |
151 | | -
|
152 | | - - name: Upload test results to Codecov |
153 | | - if: always() |
154 | | - uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5.5.2 |
155 | | - with: |
156 | | - files: '**/junit_report.xml' |
157 | | - report_type: 'test_results' |
158 | | - fail_ci_if_error: false |
159 | | - handle_no_reports_found: true |
160 | | - verbose: true |
161 | | - |
162 | | - - name: Convert test reports to CTRF JSON |
163 | | - run: | |
164 | | - go install github.com/ctrf-io/go-ctrf-json-reporter/cmd/go-ctrf-json-reporter@v0.0.10 |
165 | | -
|
166 | | - appName="swag" |
167 | | - buildNumber="${{ github.run_id }}" |
168 | | - appVersion="${{ github.event.pull_request.head.sha }}" |
169 | | -
|
170 | | - while read report ; do |
171 | | - echo "::notice::converting report: ${report}" |
172 | | - #TEST_REPORT: 'all_modules.report.${{ matrix.os }}.${{ matrix.go_version }}.json' |
173 | | - reformated=$(echo "${report##*/}"|sed -E 's/(go)([[:digit:]]+)\.([[:digit:]]+)/\1\2\3/') # e.g. go1.24 becomes go124 |
174 | | - mapfile -d'.' -t -s 2 -n 2 split < <(echo $reformated) # skip the first 2 parts, stop on 2 more parts |
175 | | - osPlatform="${split[0]}" |
176 | | - osRelease="${split[1]}" |
177 | | -
|
178 | | - go-ctrf-json-reporter \ |
179 | | - -verbose \ |
180 | | - -appName "${appName}" \ |
181 | | - -appVersion "${appVersion}" \ |
182 | | - -buildNumber "${buildNumber}" \ |
183 | | - -osPlatform "${osPlatform}" \ |
184 | | - -osRelease "${osRelease}" \ |
185 | | - -output "./reports/ctrf_report_${osPlatform}_${osRelease}.json" \ |
186 | | - -quiet < "${report}" |
187 | | - done < <(find reports -name \*.json) |
188 | | -
|
189 | | - # NOTE: at this moment, we don't upload CTRF reports as artifacts. |
190 | | - # Some of the CTRF reports are therefore not available (flaky tests, history, ...). |
191 | | - # |
192 | | - # See https://github.com/ctrf-io/github-test-reporter?tab=readme-ov-file#report-showcase |
193 | | - # for more reporting possibilities. At the moment, we keep it simple, as most advanced features |
194 | | - # require a github token (thus adding the complexity of a separate workflow starting on pull_request_target). |
195 | | - # |
196 | | - # For the moment, we are contented with these simple reports. This is an opportunity to compare the insight they |
197 | | - # provide as compared to what is uploaded to codecov. |
198 | | - # |
199 | | - # Codecov analytics are pretty poor at this moment. On the other hand, they manage the bot that pushes back |
200 | | - # PR comments. |
201 | | - # |
202 | | - # They also handle the storage of past test reports, so as to assess flaky tests. |
203 | | - - name: Publish Test Summary Results |
204 | | - uses: ctrf-io/github-test-reporter@024bc4b64d997ca9da86833c6b9548c55c620e40 # v1.0.26 |
205 | | - with: |
206 | | - report-path: 'reports/ctrf_report_*.json' |
207 | | - use-suite-name: true |
208 | | - summary-report: true # post a report to the github actions summary |
209 | | - github-report: true |
210 | | - failed-folded-report: true |
211 | | - |
| 16 | + uses: go-openapi/ci-workflows/.github/workflows/go-test-monorepo.yml@565504edebe3ab7f7b4cbafc8d6f401b82e91c4c # v0.2.8 |
| 17 | + with: |
| 18 | + extra-flags: '-tags testcgo,testcolorized' # (1) this is to trigger extra tests in spew, (2) this is to enable integration test for colorized output |
| 19 | + secrets: inherit |
0 commit comments