Merge #1986: ci: replace grcov by cargo-llvm-cov

066c4cd ci: replace grcov by cargo-llvm-cov (nymius)

Pull request description:

  ### Description

  As explained in #1984 , I discovered some misreportings in the coverage information given by grcov.

  Fixes #1984

  ### Notes to the reviewers

  The discussion about the tool to use is open, but I'm adding this PR to showcase how a change from `grcov` to `cargo-llvm-cov` would look like and the improvements in reporting this change will bring. [Look the report in `coveralls`](https://coveralls.io/github/nymius/bdk?branch=ci/replace-grcov-by-cargo-llvm-cov) to get a better perspective of them.

  ### Checklists

  #### All Submissions:

  * [x] I've signed all my commits
  * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md)
  * [x] I ran `cargo +nightly fmt` and `cargo clippy` before committing

ACKs for top commit:
  ValuedMammal:
    ACK 066c4cd
  oleonardolima:
    ACK 066c4cd

Tree-SHA512: d237fcc36efb6a4d3ccfaa371c2c70fc18ee40b48ca48f1230c5df6dca093f57bc1096927ddb15f9cae59a4640d9e34bf3ef1a309037e21fe0e8348e132bf38d

Author: ValuedMammal

.github/workflows/code_coverage.yml

@@ -8,11 +8,6 @@ jobs:
   Codecov:
     name: Code Coverage
     runs-on: ubuntu-latest
-    env:
-      RUSTFLAGS: "-Cinstrument-coverage"
-      RUSTDOCFLAGS: "-Cinstrument-coverage"
-      LLVM_PROFILE_FILE: "./target/coverage/%p-%m.profraw"
-
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -23,20 +18,18 @@ jobs:
       - name: Install Rust toolchain
         uses: actions-rs/toolchain@v1
         with:
-            toolchain: stable
+            toolchain: nightly
             override: true
             profile: minimal
             components: llvm-tools-preview
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2.7.8
-      - name: Install grcov
-        run: if [[ ! -e ~/.cargo/bin/grcov ]]; then cargo install grcov; fi
-      - name: Test
-        run: cargo test --all-features
+      - name: Install cargo-llvm-cov
+        run: if [[ ! -e ~/.cargo/bin/cargo-llvm-cov ]]; then cargo install cargo-llvm-cov; fi
       - name: Make coverage directory
         run: mkdir coverage
-      - name: Run grcov
-        run: grcov . --binary-path ./target/debug/ -s . -t lcov --branch --ignore-not-existing --keep-only '**/crates/**' --ignore '**/tests/**' --ignore '**/examples/**' -o ./coverage/lcov.info
+      - name: Test and report coverage
+        run: cargo +nightly llvm-cov -q --doctests --branch --all --ignore-filename-regex "(example*|crates/testenv/*)" --all-features --lcov --output-path ./coverage/lcov.info
       - name: Generate HTML coverage report
         run: genhtml -o coverage-report.html --ignore-errors unmapped ./coverage/lcov.info
       - name: Coveralls upload

Cargo.toml

@@ -20,3 +20,6 @@ authors = ["Bitcoin Dev Kit Developers"]
 [workspace.lints.clippy]
 print_stdout = "deny"
 print_stderr = "deny"
+
+[workspace.lints.rust]
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(coverage,coverage_nightly)'] }

crates/bitcoind_rpc/src/lib.rs

@@ -7,6 +7,7 @@
 //! To only get block updates (exclude mempool transactions), the caller can use
 //! [`Emitter::next_block`] until it returns `Ok(None)` (which means the chain tip is reached). A
 //! separate method, [`Emitter::mempool`] can be used to emit the whole mempool.
+#![cfg_attr(coverage_nightly, feature(coverage_attribute))]
 #![warn(missing_docs)]
 
 #[allow(unused_imports)]
@@ -399,6 +400,7 @@ impl BitcoindRpcErrorExt for bitcoincore_rpc::Error {
 }
 
 #[cfg(test)]
+#[cfg_attr(coverage_nightly, coverage(off))]
 mod test {
     use crate::{bitcoincore_rpc::RpcApi, Emitter, NO_EXPECTED_MEMPOOL_TXS};
     use bdk_chain::local_chain::LocalChain;

crates/chain/src/chain_data.rs

@@ -164,6 +164,7 @@ impl<A: Anchor> FullTxOut<A> {
 }
 
 #[cfg(test)]
+#[cfg_attr(coverage_nightly, coverage(off))]
 mod test {
     use bdk_core::ConfirmationBlockTime;
 

crates/chain/src/lib.rs

@@ -25,6 +25,7 @@
 )]
 #![no_std]
 #![warn(missing_docs)]
+#![cfg_attr(coverage_nightly, feature(coverage_attribute))]
 
 pub use bitcoin;
 mod balance;

crates/chain/src/rusqlite_impl.rs

@@ -660,6 +660,7 @@ impl keychain_txout::ChangeSet {
 }
 
 #[cfg(test)]
+#[cfg_attr(coverage_nightly, coverage(off))]
 mod test {
     use super::*;
 

crates/chain/src/spk_iter.rs

@@ -134,6 +134,7 @@ where
 }
 
 #[cfg(test)]
+#[cfg_attr(coverage_nightly, coverage(off))]
 mod test {
     use crate::{
         bitcoin::secp256k1::Secp256k1,

crates/electrum/src/bdk_electrum_client.rs

@@ -688,6 +688,7 @@ fn chain_update(
 }
 
 #[cfg(test)]
+#[cfg_attr(coverage_nightly, coverage(off))]
 mod test {
     use crate::{bdk_electrum_client::TxUpdate, BdkElectrumClient};
     use bdk_chain::bitcoin::{constants, Network, OutPoint, ScriptBuf, Transaction, TxIn};

crates/electrum/src/lib.rs

@@ -16,7 +16,7 @@
 //! [`example_electrum`]: https://github.com/bitcoindevkit/bdk/tree/master/examples/example_electrum
 //! [`SyncResponse`]: bdk_core::spk_client::SyncResponse
 //! [`FullScanResponse`]: bdk_core::spk_client::FullScanResponse
-
+#![cfg_attr(coverage_nightly, feature(coverage_attribute))]
 #![warn(missing_docs)]
 
 mod bdk_electrum_client;

crates/esplora/src/async_ext.rs

@@ -550,6 +550,7 @@ where
 }
 
 #[cfg(test)]
+#[cfg_attr(coverage_nightly, coverage(off))]
 mod test {
     use std::{collections::BTreeSet, time::Duration};