Skip to content

Commit 6b20393

Browse files
authored
Merge pull request #236 from JenySadadia/coverage-command-doc
Document `maestro coverage command`
2 parents 7007c8c + afcb452 commit 6b20393

File tree

2 files changed

+62
-0
lines changed

2 files changed

+62
-0
lines changed

docs/coverage-bar-graph.jpeg

137 KB
Loading

docs/maestro-coverage.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
+++
2+
title = 'maestro coverage'
3+
date = 2025-10-15
4+
description = 'Command to show Maestro coverage information'
5+
+++
6+
7+
This command is Maestro-specific and will fetch coverage information
8+
for ChromiumOS tree.
9+
10+
```sh
11+
kci-dev maestro coverage
12+
```
13+
14+
This command will show the coverage information including function coverage, line coverage, coverage report URL and coverage logs for the specific maestro build.
15+
16+
Sample command:
17+
```
18+
$ kci-dev maestro coverage
19+
- Tree/branch: chromiumos/chromeos-6.12
20+
Commit: 1d022843a344dd50b57600abc3e5b3f14f8a463f
21+
Build: https://staging.kernelci.org:9000/viewer?node_id=68b83f8a18776824c891f55c
22+
Function coverage: 19.3%
23+
Line coverage: 15.5%
24+
Coverage report: https://files-staging.kernelci.org/coverage-report-x86-68bac05fa6a30c5a1ec57f88/coverage-68b83f8a18776824c891f55c.html
25+
Coverage logs: https://files-staging.kernelci.org/coverage-report-x86-68bac05fa6a30c5a1ec57f88/log.txt
26+
27+
- Tree/branch: chromiumos/chromeos-6.6
28+
Commit: 3a3e081223ed84b1e24cee86fb599c209ee489be
29+
Build: https://staging.kernelci.org:9000/viewer?node_id=68c31cbf223895c1a77c5cee
30+
Function coverage: 10.7%
31+
Line coverage: 8.7%
32+
Coverage report: https://files-staging.kernelci.org/coverage-report-arm64-68c350e8223895c1a77cb5fe/coverage-68c31cbf223895c1a77c5cee.html
33+
Coverage logs: https://files-staging.kernelci.org/coverage-report-arm64-68c350e8223895c1a77cb5fe/log.txt
34+
35+
- Tree/branch: chromiumos/chromeos-6.12
36+
Commit: 5086fc23a5a4236fc7cc06aa92329d729761465d
37+
Build: https://staging.kernelci.org:9000/viewer?node_id=68c31d0a223895c1a77c5d3c
38+
Function coverage: 11.0%
39+
Line coverage: 9.1%
40+
Coverage report: https://files-staging.kernelci.org/coverage-report-arm64-68c371969e7d6a2d0e73dc70/coverage-68c31d0a223895c1a77c5d3c.html
41+
Coverage logs: https://files-staging.kernelci.org/coverage-report-arm64-68c371969e7d6a2d0e73dc70/log.txt
42+
```
43+
44+
By default the command will retrieve coverage information for the first 1000 builds. That can be changed by specifying `--limit` option.
45+
Additionally, you can provide optional parameters such as branch, start date, end date to filter the results.
46+
For example:
47+
```sh
48+
kci-dev maestro coverage --start-date 2025-09-01
49+
```
50+
51+
Use `--help` option to list all the optional arguments.
52+
53+
You can also generate a bar graph to get coverage information visualization.
54+
It can be retrieved by using `--graph-output` option.
55+
For example:
56+
```sh
57+
kci-dev maestro coverage --start-date 2025-09-01 --graph-output
58+
```
59+
The command will generate a graph per branch. The bars will show function and lines coverage against different build commits. You can see the coverage report URL by hovering on the bars. Click the link to download the report or open it in your browser.
60+
61+
Sample output:
62+
[![Coverage bar graph](coverage-bar-graph.jpeg)](coverage-bar-graph.jpeg)

0 commit comments

Comments
 (0)