action #176595
opencoordination #177042: [saga][epic] Future ideas for higher quality os-autoinst+openQA product
coordination #177045: [epic] Improved development environment for os-autoinst
[retro] Code coverage: Create report about which code is covered by which unit test
0%
Description
Motivation¶
This came up in the retro on 2025-01-31.
We have a lot of unit test files in openQA and os-autoinst, and it can be hard to figure out which covers what parts of the code.
For adding new tests it can be very helpful to quickly find out suggestions on where to put them.
It's possible to gather that information by executing tests and retrieving the JSON coverage data after each test file.
There is a draft https://github.com/os-autoinst/os-autoinst/pull/2644 which creates a JSON file per each code file with information on which uni test file covered it.
This could be run as a nightly job and create a HTML report. Doesn't need to be fancy.
Acceptance Criteria¶
- AC1: We have a reasonably up-to-date HTML report documenting which code lines are covered by which test files
Suggestions¶
- JSON Data can be retrieved from here: https://github.com/perlpunk/os-autoinst/actions/runs/13619564612 (or simply run the PR on your fork and look into your fork's Action tab)
- Todos:
- Make this work with cmake: https://github.com/os-autoinst/os-autoinst/pull/2644/files#r1951240209
- Run this as a scheduled github action every day/week or for every push to master
- Create HTML pages from JSON
- Do the same kind of thing for openQA
Updated by okurz about 2 months ago
- Priority changed from Normal to Low
- Target version set to Tools - Next
- Parent task set to #130414
Updated by tinita about 2 months ago
How about creating a simple, minimal HTML report from my proof of concept data, and then we look at it together and decide if this is useful, and then we can care about the other details?
Updated by tinita about 2 months ago
- Subject changed from Code coverage: Create report about which code is covered by which unit test to [retro] Code coverage: Create report about which code is covered by which unit test
- Description updated (diff)
Updated by okurz about 1 month ago
- Target version changed from Tools - Next to Ready
Updated by gpuliti 11 days ago
I think is a good idea, even something like the coverage summary ui should be enough. Or maybe we could consider to add an asciidoc/html and add somewhere in the https://open.qa/docs/
Updated by tinita 11 days ago
- Copied to action #179212: [spike][timeboxed:10h] Code coverage: Create Proof of Concept report about which code is covered by which unit test added