nasa/fprime

Adding Coverage Files for Unit Tests

Open

Aperta il 7 mar 2024

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)C++ (9718 star) (1249 fork)batch import
CIhelp wanted

Descrizione
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.

Guida contributor

Tech stack
cppgithub actions
Dominio
ci cdtesting
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
fresh
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
CI/CD pipeline knowledgeC++ basicsunit testing conceptsGitHub Actions
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60
Direzione di ricerca
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.