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.
Adding Coverage Files for Unit Tests · nasa/fprime#2572 | Good First Issue