Description
As Test Management, we would like to have a code coverage analysis / measurement metric and a reporting of this metric from all product teams that participate in Eclipse Tractus-X releases, as a standard testing practice and baseline to know how well code is currently covered by automated tests.
Thus we kindly request that all product teams implement such a functionality / tool / framework within the upcoming release cycle. We are aware that some teams are already analyzing this metric and are publishing it in reports, and thus will have no or minimal additional efforts besides their regular development and testing activities.
This sub-issue tracks the implementation for this repository / for product Policy Hub to the work summarized in the Release Planning Testmanagement reference issue at eclipse-tractusx/sig-release#1300
Also referenced in this issue, a Tractus-X Release Guideline (TRG) for code coverage is in discussion in parallel at eclipse-tractusx/eclipse-tractusx.github.io#1149
Steps for Each Product Team
1) Implement Code Coverage Analysis
- Ensure there is a method to perform code coverage analysis for the product (for unit and integration tests) as part of your build pipeline (per pull request, or at least per release build). Update applicable code, configurations, and documentation.
If none is available yet, an appropriate tool / framework can be chosen by the team that fits their product e.g. for the used programming languages and other criteria.
2) Implement Code Coverage Reporting
-
Ensure there is a method to report the measured code coverage for the product. Update applicable code, configurations, and documentation.
-
This could be achieved by publishing a report "standalone" in the build pipeline (per pull request, at least per release build).
-
Alternatively, this could be achieved by integrating in the cental Eclipse Tractus-X SonarQube installation. (We are aware from the TRG discussion of an issue with forked repositories outside of the Eclipse Tractus-X project not having access to the necessary secrets, thus this method would be sufficient for Test Management but may pose issues for external contributions/future developments. See reference issue for details.)
Note: Policy Hub already has an integration in SonarQube including code coverage analysis. Thus to be aligned with Test Management if this can also be published/accessed in a "standalone" variant.
https://sonarcloud.io/summary/new_code?id=eclipse-tractusx_policy-hub&branch=main
https://sonarcloud.io/project/overview?id=eclipse-tractusx_policy-hub
- If code coverage analysis + reports are already available/operational internally to a product team, please align with test management (e.g. in office hour, technical status sync) how this could be made available publicly so test management can have access to the code coverage per release build.
3) Track Progress
- Please keep the issue updated as you make progress.
- If needed, please create and link additional own issues to track detailled implementation tasks, as this issue is just intended as an overview summary.
- Close this issue once a solution has been defined and implemented
Test Management will support the initiative regarding examples and best practices from other products. Thank you.
Metadata
Metadata
Assignees
Labels
Type
Projects
Status