feat(ci): add code coverage report

.github/workflows/check.yml

@@ -84,3 +84,30 @@ jobs:
       - uses: crate-ci/[email protected]
         with:
           files: .
+
+  coverage:
+    if: ${{ !startsWith(github.head_ref, 'dependabot/') }}
+    runs-on: ubuntu-latest
+    env:
+      BEERUS_TEST_RUN: 1
+      BEERUS_TEST_STARKNET_URL: https://starknet-mainnet.g.alchemy.com/starknet/version/rpc/v0_7/${{ secrets.ALCHEMY_KEY }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+      - run: rm -rf /opt/hostedtoolcache
+      - name: Install Tarpaulin for code coverage
+        run: cargo install cargo-tarpaulin
+      # Exclude 'web' directory from coverage
+      - run: rm -rf ./web
+      - name: Run tests with coverage
+        run: cargo tarpaulin --out html
+      - name: View context attributes
+        uses: actions/github-script@v7
+        with:
+          script: console.log(context)
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          files: ./tarpaulin-report.html
+          #token: ${{ secrets.CODECOV_TOKEN }}

Cargo.toml

@@ -76,3 +76,6 @@ wiremock = "0.6.2"
 
 [patch.crates-io]
 starknet-core = { git = "https://github.com/kariy/starknet-rs", branch = "dojo-patch" }
+
+[lints.rust]
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(tarpaulin_include)'] }

src/bin/beerus.rs

@@ -7,6 +7,7 @@ use beerus::{
 use tokio::sync::RwLock;
 use validator::Validate;
 
+#[cfg(not(tarpaulin_include))] // exclude from coverage report
 #[tokio::main]
 async fn main() -> eyre::Result<()> {
     tracing_subscriber::fmt::init();
@@ -56,6 +57,7 @@ async fn main() -> eyre::Result<()> {
     Ok(())
 }
 
+#[cfg(not(tarpaulin_include))] // exclude from coverage report
 async fn get_config() -> eyre::Result<ServerConfig> {
     let path = std::env::args().nth(1);
     let config = if let Some(path) = path {

src/lib.rs

@@ -2,7 +2,10 @@ pub mod client;
 pub mod config;
 pub mod eth;
 pub mod exe;
+
+#[cfg(not(tarpaulin_include))] // exclude from coverage report
 pub mod gen;
+
 pub mod proof;
 
 #[cfg(not(target_arch = "wasm32"))]