如何让Rust代码覆盖率统计包含宏（如#[error]）的使用？

我目前使用GitHub Actions搭配Codecov监控Rust项目的代码覆盖率，CI流水线配置如下：

test:
  name: Test
  runs-on: ubuntu-latest

  steps:
    - uses: actions/checkout@v3
      with:
        lfs: true

    - uses: actions-rs/toolchain@v1
      with:
        toolchain: nightly
        override: true
 
    - uses: actions-rs/cargo@v1
      with:
        command: test        
      args: --all-features
      env:
        CARGO_INCREMENTAL: '0'
        RUSTFLAGS: '-Zprofile -Ccodegen-units=1 -Cinline-threshold=0 -Clink-dead-code -Coverflow-checks=off -Cpanic=abort -Zpanic_abort_tests -Cinstrument-coverage'
        RUSTDOCFLAGS: '-Zprofile -Ccodegen-units=1 -Cinline-threshold=0 -Clink-dead-code -Coverflow-checks=off -Cpanic=abort -Zpanic_abort_tests -Cinstrument-coverage'
    
    - uses: actions-rs/grcov@v0.1
      id: coverage
      name: Generate code coverage

    - name: Upload to codecov.io
      uses: codecov/codecov-action@v3
      with:
        files: ${{ steps.coverage.outputs.report }}
        token: ${{ secrets.CODECOV_TOKEN }}

但覆盖率报告显示，以下代码中#[error]宏所在行未被覆盖：

#[derive(Error, Debug, PartialEq, Eq)]
pub enum EncodingFormatParsingError {
    #[error("Unexpected encoding {0}")] // line not covered
    UnexpectedEncoding(String),
}

解决方法 #

问题的核心是：#[error]宏并不会直接生成可执行代码，而是为枚举变体实现了Display trait。只有当这个trait的方法（比如to_string()、或通过println!("{}", err)触发）被实际调用时，对应的源码行才会被覆盖率工具标记为已执行。

要让该行纳入覆盖率统计，只需在测试中添加触发Display实现的测试用例即可：

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

    #[test]
    fn test_unexpected_encoding_error_display() {
        let error = EncodingFormatParsingError::UnexpectedEncoding("gbk".to_string());
        // 调用to_string()触发Display trait的实现，覆盖#[error]宏对应的代码
        assert_eq!(error.to_string(), "Unexpected encoding gbk");
    }
}

如果你的测试中已经有触发错误场景的用例，但没有显式格式化错误信息，也可以修改现有测试，添加对错误信息的断言，或者在捕获错误后调用to_string()方法，确保Display逻辑被执行。

另外，确认你的CI配置无需调整——当前的RUSTFLAGS已经正确开启了代码覆盖率 instrumentation，问题本质是测试未覆盖宏生成的trait实现逻辑。

内容的提问来源于stack exchange，提问作者Edmondo