Skip to content

Commit 9d8174d

Browse files
josecelanojosecelano
committed
ci: [#1075] fix coverage report
1 parent 4dd6659 commit 9d8174d

File tree

4 files changed

+211
-2
lines changed

4 files changed

+211
-2
lines changed

‎.cargo/config.toml

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[alias]
22
cov = "llvm-cov"
33
cov-lcov = "llvm-cov --lcov --output-path=./.coverage/lcov.info"
4+
cov-codecov = "llvm-cov --codecov --output-path=./.coverage/codecov.json"
45
cov-html = "llvm-cov --html"
56
time = "build --timings --all-targets"
67

‎.github/workflows/generate_coverage.yaml

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
name: Generate Coverage Report
2+
3+
on:
4+
push:
5+
branches:
6+
- develop
7+
pull_request:
8+
branches:
9+
- develop
10+
11+
env:
12+
CARGO_TERM_COLOR: always
13+
14+
jobs:
15+
coverage:
16+
name: Generate Coverage Report
17+
environment: coverage
18+
runs-on: ubuntu-latest
19+
env:
20+
CARGO_INCREMENTAL: "0"
21+
RUSTFLAGS: "-Cinstrument-coverage"
22+
23+
steps:
24+
- name: Checkout repository
25+
uses: actions/checkout@v4
26+
27+
- name: Install LLVM tools
28+
run: sudo apt-get update && sudo apt-get install -y llvm
29+
30+
- id: setup
31+
name: Setup Toolchain
32+
uses: dtolnay/rust-toolchain@nightly
33+
with:
34+
toolchain: nightly
35+
components: llvm-tools-preview
36+
37+
- id: cache
38+
name: Enable Workflow Cache
39+
uses: Swatinem/rust-cache@v2
40+
41+
- id: tools
42+
name: Install Tools
43+
uses: taiki-e/install-action@v2
44+
with:
45+
tool: grcov,cargo-llvm-cov
46+
47+
- id: coverage
48+
name: Generate Coverage Report
49+
run: |
50+
cargo clean
51+
cargo llvm-cov --all-features --workspace --codecov --output-path ./codecov.json
52+
53+
- name: Store PR number and commit SHA
54+
run: |
55+
echo "Storing PR number ${{ github.event.number }}"
56+
echo "${{ github.event.number }}" > pr_number.txt
57+
58+
echo "Storing commit SHA ${{ github.event.pull_request.head.sha }}"
59+
echo "${{ github.event.pull_request.head.sha }}" > commit_sha.txt
60+
61+
# Workaround for https://github.com/orgs/community/discussions/25220
62+
# Triggered sub-workflow is not able to detect the original commit/PR which is available
63+
# in this workflow.
64+
- name: Store PR number
65+
uses: actions/upload-artifact@v4
66+
with:
67+
name: pr_number
68+
path: pr_number.txt
69+
70+
- name: Store commit SHA
71+
uses: actions/upload-artifact@v4
72+
with:
73+
name: commit_sha
74+
path: commit_sha.txt
75+
76+
# This stores the coverage report in artifacts. The actual upload to Codecov
77+
# is executed by a different workflow `upload_coverage.yml`. The reason for this
78+
# split is because `on.pull_request` workflows don't have access to secrets.
79+
- name: Store coverage report in artifacts
80+
uses: actions/upload-artifact@v4
81+
with:
82+
name: codecov_report
83+
path: ./codecov.json
84+
85+
- run: |
86+
echo "The coverage report was stored in Github artifacts."
87+
echo "It will be uploaded to Codecov using [upload_coverage.yml] workflow shortly."

‎.github/workflows/upload_coverage.yaml

+119
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
name: Upload Coverage Report
2+
3+
on:
4+
# This workflow is triggered after every successfull execution
5+
# of `Generate Coverage Report` workflow.
6+
workflow_run:
7+
workflows: ["Generate Coverage Report"]
8+
types:
9+
- completed
10+
11+
permissions:
12+
actions: write
13+
contents: write
14+
issues: write
15+
pull-requests: write
16+
17+
jobs:
18+
coverage:
19+
name: Upload Coverage Report
20+
environment: coverage
21+
runs-on: ubuntu-latest
22+
steps:
23+
- name: "Download existing coverage report"
24+
id: prepare_report
25+
uses: actions/github-script@v7
26+
with:
27+
script: |
28+
var fs = require('fs');
29+
30+
// List artifacts of the workflow run that triggered this workflow
31+
var artifacts = await github.rest.actions.listWorkflowRunArtifacts({
32+
owner: context.repo.owner,
33+
repo: context.repo.repo,
34+
run_id: context.payload.workflow_run.id,
35+
});
36+
37+
let codecovReport = artifacts.data.artifacts.filter((artifact) => {
38+
return artifact.name == "codecov_report";
39+
});
40+
41+
if (codecovReport.length != 1) {
42+
throw new Error("Unexpected number of {codecov_report} artifacts: " + codecovReport.length);
43+
}
44+
45+
var download = await github.rest.actions.downloadArtifact({
46+
owner: context.repo.owner,
47+
repo: context.repo.repo,
48+
artifact_id: codecovReport[0].id,
49+
archive_format: 'zip',
50+
});
51+
fs.writeFileSync('codecov_report.zip', Buffer.from(download.data));
52+
53+
let prNumber = artifacts.data.artifacts.filter((artifact) => {
54+
return artifact.name == "pr_number";
55+
});
56+
57+
if (prNumber.length != 1) {
58+
throw new Error("Unexpected number of {pr_number} artifacts: " + prNumber.length);
59+
}
60+
61+
var download = await github.rest.actions.downloadArtifact({
62+
owner: context.repo.owner,
63+
repo: context.repo.repo,
64+
artifact_id: prNumber[0].id,
65+
archive_format: 'zip',
66+
});
67+
fs.writeFileSync('pr_number.zip', Buffer.from(download.data));
68+
69+
let commitSha = artifacts.data.artifacts.filter((artifact) => {
70+
return artifact.name == "commit_sha";
71+
});
72+
73+
if (commitSha.length != 1) {
74+
throw new Error("Unexpected number of {commit_sha} artifacts: " + commitSha.length);
75+
}
76+
77+
var download = await github.rest.actions.downloadArtifact({
78+
owner: context.repo.owner,
79+
repo: context.repo.repo,
80+
artifact_id: commitSha[0].id,
81+
archive_format: 'zip',
82+
});
83+
fs.writeFileSync('commit_sha.zip', Buffer.from(download.data));
84+
85+
- id: parse_previous_artifacts
86+
run: |
87+
unzip codecov_report.zip
88+
unzip pr_number.zip
89+
unzip commit_sha.zip
90+
91+
echo "Detected PR is: $(<pr_number.txt)"
92+
echo "Detected commit_sha is: $(<commit_sha.txt)"
93+
94+
# Make the params available as step output
95+
echo "override_pr=$(<pr_number.txt)" >> "$GITHUB_OUTPUT"
96+
echo "override_commit=$(<commit_sha.txt)" >> "$GITHUB_OUTPUT"
97+
98+
- name: Checkout repository
99+
uses: actions/checkout@v4
100+
with:
101+
ref: ${{ steps.parse_previous_artifacts.outputs.override_commit || '' }}
102+
path: repo_root
103+
104+
- name: Upload coverage to Codecov
105+
uses: codecov/codecov-action@v5
106+
with:
107+
verbose: true
108+
token: ${{ secrets.CODECOV_TOKEN }}
109+
files: ${{ github.workspace }}/codecov.json
110+
fail_ci_if_error: true
111+
# Manual overrides for these parameters are needed because automatic detection
112+
# in codecov-action does not work for non-`pull_request` workflows.
113+
# In `main` branch push, these default to empty strings since we want to run
114+
# the analysis on HEAD.
115+
override_commit: ${{ steps.parse_previous_artifacts.outputs.override_commit || '' }}
116+
override_pr: ${{ steps.parse_previous_artifacts.outputs.override_pr || '' }}
117+
working-directory: ${{ github.workspace }}/repo_root
118+
# Location where coverage report files are searched for
119+
directory: ${{ github.workspace }}

‎.gitignore

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.env
2+
*.code-workspace
23
**/*.rs.bk
34
/.coverage/
45
/.idea/
@@ -12,5 +13,6 @@
1213
/tracker.*
1314
/tracker.toml
1415
callgrind.out
15-
perf.data*
16-
*.code-workspace
16+
codecov.json
17+
lcov.info
18+
perf.data*

0 commit comments

Comments
 (0)