nasa/fprime

Adding Coverage Files for Unit Tests

Open

#2572 opened on Mar 7, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C++ (9,718 stars) (1,249 forks)batch import
CIhelp wanted

Description
F´ Version v3.4.3
Affected Component All with unit tests

Feature Description

In the CI pipeline, add automatic code coverage documentation for unit tests.

Rationale

This will provide a snapshot of the percentage of source code that is covered by the component's unit tests. It can show areas that lack proper testing and provide users with confidence in fprime components. The CI already runs the unit tests, so it just needs to capture the coverage results as well.

Contributor guide

Tech stack
cppgithub actions
Domain
ci cdtesting
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
CI/CD pipeline knowledgeC++ basicsunit testing conceptsGitHub Actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the existing CI pipeline configuration in .github/workflows to identify where unit tests are run. Determine which coverage tool to use (e.g., gcov, lcov, or codecov) and how to capture coverage data from the C++ unit tests. Then modify the workflow to generate coverage reports and possibly upload them to a service like Codecov or archive them as artifacts. Review any existing coverage documentation in the repository for guidance.