Rust代码覆盖率工具coverage-prepare的使用：快速生成和分析Rust项目的测试覆盖率报告

工具介绍

Coverage Prepare是一个将覆盖率数据转换为HTML报告、LCOV文件或终端表格的工具。

工具功能：

• 将"profraw"覆盖率数据转换为：
  • HTML报告
  • 终端表格报告
  • LCOV文件（用于上传到codecov等平台）

安装方法

cargo install coverage-prepare

运行上述命令将全局安装coverage-prepare二进制文件。

使用示例

以下是coverage-prepare --help的输出：

Convert "profraw" coverage data to:
* HTML reports
* terminal table reports
* LCOV files (for upload to codecov etc.)

USAGE:
    coverage-prepare [OPTIONS] <OUTPUT_FORMAT> [BINARIES]...

ARGS:
    <OUTPUT_FORMAT>
            output format
            
            [possible values: html, report, lcov]

    <BINARIES>...
            binary files to build coverage from

OPTIONS:
    -h, --help
            Print help information

        --ignore-filename-regex <IGNORE_FILENAME_REGEX>
            maps to the `--ignore-filename-regex` argument to `llvm-cov`, `\.cargo/registry` &
            `library/std` are always ignored, repeat to ignore multiple filenames

        --no-delete
            whether to not delete the processed `.profraw` files and the generated `.profdata` file
            after generating the coverage reports, by default these files are deleted

    -o, --output-path <OUTPUT_PATH>
            Output path, defaults to `rust_coverage.lcov` for lcov output, and `htmlcov/rust` for
            html output

    -V, --version
            Print version information

完整示例demo

1. 首先配置Cargo.toml启用覆盖率收集：

[profile.test]
coverage = true  # 启用测试覆盖率收集

1. 创建示例Rust项目（假设项目名为coverage-demo）：

cargo new coverage-demo
cd coverage-demo

1. 添加测试代码到src/lib.rs：

pub fn add(a: i32, b: i32) -> i32 {
    a + b
}

pub fn sub(a: i32, b: i32) -> i32 {
    a - b
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_add() {
        assert_eq!(add(2, 3), 5);
    }

    // 故意不测试sub函数，以展示覆盖率差异
}

1. 运行测试并收集覆盖率数据：

# 设置环境变量
export RUSTFLAGS="-C instrument-coverage"  # 启用覆盖率检测
export LLVM_PROFILE_FILE="coverage-demo-%p-%m.profraw"  # 定义profraw文件名格式

# 运行测试
cargo test

1. 生成HTML覆盖率报告：

# 生成HTML报告
coverage-prepare html target/debug/deps/coverage_demo-*.so

1. 生成LCOV文件：

# 生成LCOV文件用于CI/CD
coverage-prepare lcov target/debug/deps/coverage_demo-*.so -o coverage.lcov

1. 查看终端报告：

# 在终端查看覆盖率报告
coverage-prepare report target/debug/deps/coverage_demo-*.so

1. 使用高级选项：

# 忽略测试文件并保留中间文件
coverage-prepare html \
    --ignore-filename-regex ".*test.*" \
    --no-delete \
    target/debug/deps/coverage_demo-*.so

# 自定义输出路径
coverage-prepare html -o ./custom_coverage_report target/debug/deps/coverage_demo-*.so

注意事项

1. 工具会默认忽略.cargo/registry和library/std目录的文件
2. 默认情况下会删除处理后的.profraw文件和生成的.profdata文件
3. 对于HTML输出，默认路径是htmlcov/rust
4. 对于LCOV输出，默认路径是rust_coverage.lcov

通过以上完整示例，你可以快速生成和分析Rust项目的测试覆盖率报告，帮助提高代码质量。