nasa/fprime

Adding Coverage Files for Unit Tests

Geschlossen

#2.572 geöffnet am 07.03.2024

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (1.249 Forks)batch import
CIhelp wanted

Repository-Metriken

Stars
 (9.718 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 5T 15h) (65 gemergte PRs in 30 T)

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

Research-Richtung
Untersuchen Sie die vorhandene CI Pipeline Konfiguration in .github/workflows, um zu ermitteln, wo die Unittests ausgeführt werden. Bestimmen Sie, welches Abdeckungstool verwendet werden soll (z. B. gcov, lcov oder codecov) und wie Abdeckungsdaten aus den C++ Unittests erfasst werden können. Ändern Sie dann den Workflow, um Abdeckungsberichte zu generieren und diese möglicherweise an einen Dienst wie Codecov hochzuladen oder als Artefakte zu archivieren. Überprüfen Sie vorhandene Abdeckungsdokumentation im Repository, um Anleitungen zu erhalten.
Tech Stack
cppgithub actions
Domain
ci cdtesting
Issue Type
Funktion
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 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
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