nasa/fprime

Adding Coverage Files for Unit Tests

Open

#2,572 opened on 2024年3月7日

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

説明
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.

コントリビューターガイド

技術スタック
cppgithub actions
領域
ci cdtesting
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
CI/CD pipeline knowledgeC++ basicsunit testing conceptsGitHub Actions
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60
調査方針
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.