nasa/fprime

Adding Coverage Files for Unit Tests

Open

#2.572 geöffnet am 7. März 2024

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (9.718 Stars) (1.249 Forks)batch import
CIhelp wanted

Beschreibung
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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
CI/CD pipeline knowledgeC++ basicsunit testing conceptsGitHub Actions
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
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.