Project

General

Profile

Actions

action #176595

open

coordination #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

Added by tinita about 2 months ago. Updated 11 days ago.

Status:
New
Priority:
Low
Assignee:
-
Category:
Feature requests
Target version:
Start date:
2025-02-05
Due date:
% Done:

0%

Estimated time:

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


Related issues 1 (1 open0 closed)

Copied to openQA Project (public) - action #179212: [spike][timeboxed:10h] Code coverage: Create Proof of Concept report about which code is covered by which unit testNew2025-03-19

Actions
Actions #1

Updated by tinita about 2 months ago

  • Description updated (diff)
Actions #2

Updated by okurz about 2 months ago

  • Priority changed from Normal to Low
  • Target version set to Tools - Next
  • Parent task set to #130414
Actions #3

Updated by tinita about 2 months ago

  • Description updated (diff)
Actions #4

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?

Actions #5

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)
Actions #6

Updated by okurz about 2 months ago

  • Parent task changed from #130414 to #177045
Actions #7

Updated by okurz about 1 month ago

  • Target version changed from Tools - Next to Ready
Actions #8

Updated by tinita 28 days ago

  • Description updated (diff)
Actions #9

Updated by okurz 26 days ago

  • Target version changed from Ready to Tools - Next
Actions #10

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/

Actions #11

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
Actions #12

Updated by tinita 11 days ago

  • Target version changed from Tools - Next to future

Moved to future in favor of #179212

Actions

Also available in: Atom PDF