Rust代码覆盖率工具lcov的使用

概述

LCOV是一个纯Rust实现的LCOV tracefile解析器/合并器/过滤器。它是gcov的图形前端工具，可以收集多个源文件的gcov数据并将其存储到名为"tracefile"的文件中。

安装与使用

在项目的Cargo.toml中添加以下依赖：

[dependencies]
lcov = "0.8.1"

核心概念

数据结构

LCOV tracefile的每一行对应一个数据结构称为"LCOV记录"，表示为Record。每条记录的格式如下：

<KIND>:<field#0>,<field#1>,...<field#N>

基本用法示例

1. 解析LCOV tracefile

use lcov::{Record, RecordKind, Reader};

// 创建Reader来读取文件
let mut reader = Reader::open_file("tests/fixtures/report.info")?;

// 收集所有记录
let records = reader.collect::<Result<Vec<_>, _>>()?;
assert_eq!(records[0], Record::TestName { name: "".into() });
assert_eq!(records[1].kind(), RecordKind::SourceFile);

// 输出记录
for record in records {
    println!("{}", record);
}

2. 从字符串创建报告

use lcov::{Reader, Record};

let input = "\
TN:test_name
SF:/path/to/source/file.rs
DA:1,2
DA:3,0
DA:5,6
LF:3
LH:2
end_of_record
";

let mut reader = Reader::new(input.as_bytes());
let records = reader.collect::<Result<Vec<_>, _>>()?;

// 验证记录内容
assert_eq!(records[0], Record::TestName { name: "test_name".into() });
assert_eq!(records[1], Record::SourceFile { path: "/path/to/source/file.rs".into() });

// 重新生成tracefile字符串
let output = records.into_iter().map(|rec| format!("{}\n", rec)).collect::<String>();
assert_eq!(input, output);

3. 合并多个tracefile

use lcov::{Report, RecordKind};

let mut report = Report::new();

// 合并两个报告文件
report.merge(Report::from_file("tests/fixtures/report.init.info")?)?;
report.merge(Report::from_file("tests/fixtures/report.run.info")?)?;

// 输出合并结果
for record in report.into_records() {
    println!("{}", record);
}

完整工作示例

use lcov::{Report, Record, Reader};
use std::error::Error;

fn main() -> Result<(), Box<dyn Error>> {
    // 模拟的覆盖率数据
    let coverage_data = r#"
TN:integration_test
SF:src/main.rs
DA:1,10
DA:2,5
DA:3,0
LF:3
LH:2
end_of_record
"#;

    // 从字符串创建报告
    let mut reader = Reader::new(coverage_data.as_bytes());
    let records = reader.collect::<Result<Vec<_>, _>>()?;
    
    // 构建报告
    let mut report = Report::new();
    for record in records {
        report.add_record(record)?;
    }

    // 分析覆盖率数据
    println!("覆盖率报告:");
    for record in report.into_records() {
        println!("{}", record);
    }

    // 计算覆盖率百分比
    if let Some(file_rec) = report.into_records().find(|r| matches!(r, Record::SourceFile { .. })) {
        println!("\n覆盖率分析:");
        if let Record::SourceFile { path } = file_rec {
            println!("文件: {}", path);
        }
    }

    Ok(())
}

版本支持与许可

• 最低支持Rust版本(MSRV): 1.56.1
• 许可证选项:
  • Apache License 2.0
  • MIT License

这个lcov库提供了完整的工具链来处理Rust项目的代码覆盖率数据，从解析、合并到生成报告，是Rust项目测试覆盖率分析的有力工具。