nasa/fprime

Adding Coverage Files for Unit Tests

Open

#2,572 建立於 2024年3月7日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)C++ (9,718 star) (1,249 fork)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
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.