eclipse-iceoryx/iceoryx2

Adjust `internal/scripts/generate-coverage.sh` to use source-coverage

Open

#372 opened on Sep 6, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Rust (172 forks)auto 404
good first issue

Repository metrics

Stars
 (2,403 stars)
PR merge metrics
 (PR metrics pending)

Description

Brief feature description

The current code coverage script is not yet perfectly configured to generate a branch coverage report. Follow the documentation from:

To adjust the script so that it generates a coverage report

  • for the whole iceoryx2 workspace
  • for every component individually, via CLI arguments
  • for the C and C++ language bindings.

Contributor guide

Research direction
Read the provided documentation on Rust coverage instrumentation (rustc and rustc dev guide). Understand how to enable source based coverage for the whole workspace, per component, and for C/C++ bindings using LLVM tools. Modify the shell script to invoke rustc with appropriate flags and generate coverage reports.
Tech stack
rustshell
Domain
testingdevops
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustShell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60