chore(ci): measure coverage in prs

piotr-roslaniec · piotr-roslaniec · commit 27145131a253 · 2025-02-28T14:54:37.000+01:00
diff --git a/.github/workflows/coverage.yaml b/.github/workflows/coverage.yaml
@@ -0,0 +1,77 @@
+name: Code Coverage
+
+on:
+  workflow_call:
+    inputs:
+      web-prover-circuits-cache-key:
+        required: true
+        type: string
+    outputs:
+      coverage-report:
+        description: "Path to the coverage report"
+        value: ${{ jobs.coverage.outputs.coverage-report }}
+
+jobs:
+  coverage:
+    name: Generate code coverage
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      checks: write
+      pull-requests: write  # Needed for coverage comments
+    outputs:
+      coverage-report: ${{ steps.upload-coverage.outputs.artifact-url }}
+    
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 2  # Needed for coverage comparison in PRs
+
+      - uses: ./.github/actions/setup-rust-ubuntu
+        with:
+          rust-cache-key: coverage
+
+      - name: Fetch web-prover-circuits cache
+        uses: actions/cache/restore@v4
+        with:
+          path: proofs/web_proof_circuits
+          key: ${{ inputs.web-prover-circuits-cache-key }}
+          fail-on-error: true
+
+      - name: Install tarpaulin
+        run: cargo install cargo-tarpaulin --version "^0.27"  # Pin version for stability
+
+      - name: Run tarpaulin
+        id: run-tarpaulin
+        run: |
+          cargo tarpaulin --workspace \
+            --timeout 360 \
+            --out Xml \
+            --out Html \
+            --output-dir coverage \
+            --exclude-files 'tests/*' \
+            --fail-under 70  # Fail if coverage drops below 70%
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage/cobertura.xml
+          fail_ci_if_error: true  # Fail if upload fails
+          verbose: true  # Better debugging
+
+      - name: Upload coverage report
+        id: upload-coverage
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: coverage/
+          retention-days: 7
+          if-no-files-found: error  # Fail if no coverage files generated
+
+      - name: Check coverage report exists
+        run: |
+          if [ ! -f coverage/tarpaulin-report.html ]; then
+            echo "Coverage report not generated"
+            exit 1
+          fi
diff --git a/.github/workflows/web-prover.yaml b/.github/workflows/web-prover.yaml
@@ -20,6 +20,13 @@ jobs:
     with:
       web-prover-circuits-cache-key: ${{ needs.web-prover-circuits.outputs.cache-key }}
 
+  coverage:
+    needs: ["web-prover-circuits"]
+    uses: ./.github/workflows/coverage.yaml
+    with:
+      web-prover-circuits-cache-key: ${{ needs.web-prover-circuits.outputs.cache-key }}
+    secrets: inherit
+
   build_notary:
     needs: ["web-prover-circuits"]
     uses: ./.github/workflows/build_notary.yaml
diff --git a/.gitignore b/.gitignore
@@ -30,4 +30,9 @@ client_ios/demo/demo.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChec
 *.zip
 
 # rust tools
-bacon.toml
+bacon.toml
+
+# coverage reports
+coverage/
+cobertura.xml
+tarpaulin-report.html
diff --git a/Makefile b/Makefile
@@ -64,4 +64,9 @@ wasm-demo/node_modules:
 wasm-demo: wasm-demo/node_modules
 	cd client_wasm/demo && npm run start
 
-.PHONY: wasm wasm-debug wasm-demo ios
+coverage: artifacts
+	-cargo install cargo-tarpaulin
+	cargo tarpaulin --workspace --timeout 360 --out Xml --out Html --output-dir coverage
+	@echo "Coverage report generated in coverage/tarpaulin-report.html"
+
+.PHONY: wasm wasm-debug wasm-demo ios coverage
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # Web Prover
 
 [![web-prover workflow](https://github.com/pluto/web-prover/actions/workflows/web-prover.yaml/badge.svg)](https://github.com/pluto/web-prover/actions/workflows/web-prover.yaml)
+[![codecov](https://codecov.io/gh/pluto/web-prover/branch/main/graph/badge.svg)](https://codecov.io/gh/pluto/web-prover)
 [![docs](https://img.shields.io/badge/docs-e28f00)](https://docs.pluto.xyz)
 
 The Web Prover is infrastructure for generating Web Proofs. There are 3 components of the Web Prover — (1) the Client Crates, which run inside of the app or browser; (2) Notary Crate, which is a hosted service; and (3) the Proofs Crate, which handles running the circuits through the `client-side-prover`.
diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,47 @@
+codecov:
+  require_ci_to_pass: true
+  notify:
+    wait_for_ci: true
+
+coverage:
+  precision: 2
+  round: down
+  range: "70...100"
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 1%
+        base: auto
+        if_ci_failed: error
+        informational: false
+        only_pulls: false
+    patch:
+      default:
+        target: auto
+        threshold: 1%
+        base: auto
+        if_ci_failed: error
+        only_pulls: true
+
+parsers:
+  gcov:
+    branch_detection:
+      conditional: true
+      loop: true
+      method: false
+      macro: false
+
+comment:
+  layout: "reach,diff,flags,files,footer"
+  behavior: default
+  require_changes: false
+  require_base: false
+  require_head: true
+
+ignore:
+  - "tests/**/*"
+  - "**/tests/**/*"
+  - "**/*.md"
+  - "**/*.yml"
+  - "**/*.yaml" 
diff --git a/web-prover-core/src/http.rs b/web-prover-core/src/http.rs
@@ -685,7 +685,7 @@ pub mod tests {
   macro_rules! request {
     // Match with optional parameters
     ($($key:ident: $value:expr),* $(,)?) => {{
-        let mut request = ManifestRequest {
+        let mut request = crate::http::ManifestRequest {
             method: "GET".to_string(),
             url: "https://example.com".to_string(),
             version: "HTTP/1.1".to_string(),
@@ -719,18 +719,18 @@ pub mod tests {
     // Match with optional parameters
     ($($key:ident: $value:expr),* $(,)?) => {{
         #[allow(unused_mut)]
-        let mut response = ManifestResponse {
+        let mut response = crate::http::ManifestResponse {  // Changed from crate::manifest::ManifestResponse
             status: "200".to_string(),
             version: "HTTP/1.1".to_string(),
             message: "OK".to_string(),
             headers: std::collections::HashMap::from([
                 ("Content-Type".to_string(), "application/json".to_string())
             ]),
-            body: ManifestResponseBody {
+            body: crate::http::ManifestResponseBody {
                 json_path: vec![
-                    JsonKey::String("key1".to_string()),
-                    JsonKey::String("key2".to_string()),
-                    JsonKey::Num(3)
+                  crate::http::JsonKey::String("key1".to_string()),
+                  crate::http::JsonKey::String("key2".to_string()),
+                  crate::http::JsonKey::Num(3)
                 ]
             },
         };
diff --git a/web-prover-core/src/manifest.rs b/web-prover-core/src/manifest.rs
@@ -77,14 +77,11 @@ mod tests {
   use std::collections::HashMap;
 
   use crate::{
-    errors::ProofError,
-    program::{
-      http::{JsonKey, ManifestRequest, ManifestResponse, ManifestResponseBody, TemplateVar},
-      manifest::HTTP_1_1,
-      plain_manifest::Manifest,
-    },
+    errors::ManifestError,
+    http::{TemplateVar, HTTP_1_1},
+    manifest::Manifest,
     request, response,
-    tests::inputs::TEST_MANIFEST,
+    test_utils::TEST_MANIFEST,
   };
 
   macro_rules! create_manifest {
@@ -93,7 +90,7 @@ mod tests {
         $response:expr
         $(, $field:ident = $value:expr)* $(,)?
     ) => {{
-        Manifest {
+        crate::manifest::Manifest {
             // manifest_version: "1".to_string(),
             // id: "Default Manifest ID".to_string(),
             // title: "Default Manifest Title".to_string(),
