test: combined test coverage reports from Hardhat and Foundry

Author: jaybuidl

.github/workflows/contracts-testing.yml

@@ -59,30 +59,22 @@ jobs:
         key: ${{ runner.os }}-build-${{ secrets.CACHE_VERSION }}-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}
         restore-keys: |
           ${{ runner.os }}-build-${{ secrets.CACHE_VERSION }}-${{ env.cache-name }}-
-             
+
     - name: Install contracts dependencies
-      run: |
-        yarn workspace @kleros/kleros-v2-contracts install
+      run: yarn workspace @kleros/kleros-v2-contracts install
 
     - name: Install Foundry
       uses: foundry-rs/foundry-toolchain@8f1998e9878d786675189ef566a2e4bf24869773 # v1.2.0
       with:
         version: nightly
 
-    - name: Run Foundry tests
-      run: forge test -vvv
-      working-directory: contracts
-      
-    - name: Compile
-      run: |
-        yarn hardhat compile
-      working-directory: contracts
-      
-    - name: Run Hardhat tests with coverage
-      run: |         
-        yarn hardhat coverage --solcoverjs ./.solcover.js --temp artifacts --testfiles './test/**/*.ts' --show-stack-traces
-      working-directory: contracts
+    - name: Install lcov
+      run: sudo apt-get install -y lcov
 
+    - name: Run Hardhat and Foundry tests with coverage
+      run: yarn coverage
+      working-directory: contracts
+                   
     - name: Upload a build artifact
       uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
       with:    

contracts/.solcover.js

@@ -5,7 +5,7 @@ const shell = require("shelljs");
 // The environment variables are loaded in hardhat.config.ts
 
 module.exports = {
-  istanbulReporter: ["html"],
+  istanbulReporter: ["lcov"],
   onCompileComplete: async function (_config) {
     await run("typechain");
   },
@@ -14,7 +14,7 @@ module.exports = {
     shell.rm("-rf", "./artifacts");
     shell.rm("-rf", "./typechain");
   },
-  skipFiles: ["mocks", "test"],
+  skipFiles: ["test", "token", "kleros-v1", "proxy/mock", "gateway/mock", "rng/mock"],
   mocha: {
     timeout: 20000,
     grep: "@skip-on-coverage", // Find everything with this tag

contracts/package.json

@@ -22,6 +22,7 @@
     "clean": "hardhat clean",
     "check": "hardhat check",
     "test": "TS_NODE_TRANSPILE_ONLY=1 hardhat test",
+    "coverage": "scripts/coverage.sh",
     "start": "hardhat node --tags nop",
     "start-local": "hardhat node --tags Arbitration,HomeArbitrable --hostname 0.0.0.0",
     "deploy": "hardhat deploy",

contracts/scripts/coverage.sh

@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+
+set -e # exit on error
+
+rm -rf coverage
+mkdir -p coverage
+
+# Generate the Forge coverage report
+forge coverage --report summary --report lcov --report-file coverage/lcov-forge.info
+
+# Generate the Hardhat coverage report
+yarn clean
+yarn hardhat coverage --solcoverjs ./.solcover.js --temp artifacts --show-stack-traces --testfiles "test/**/*.ts"
+mv coverage/lcov.info coverage/lcov-hardhat.info
+
+# Make the Hardhat report paths relative for consistency with Forge coverage report
+sed -i -e 's/\/.*\/kleros-v2\/contracts\///g' coverage/lcov-hardhat.info
+
+# Merge the two reports
+lcov \
+  --ignore-errors format \
+  --ignore-errors inconsistent \
+  --rc max_message_count=3 \
+  --rc derive_function_end_line=0 \
+  --rc branch_coverage=1 \
+  --add-tracefile coverage/lcov-hardhat.info \
+  --add-tracefile coverage/lcov-forge.info \
+  --output-file coverage/merged-lcov.info
+
+# Filter out unnecessary contracts from the report
+lcov \
+  --ignore-errors inconsistent \
+  --rc max_message_count=3 \
+  --rc branch_coverage=1 \
+  --rc derive_function_end_line=0 \
+  --remove coverage/merged-lcov.info \
+  --output-file coverage/filtered-lcov.info \
+  "../node_modules" "src/test" "src/token" "src/kleros-v1" "src/proxy/mock" "src/gateway/mock" "src/rng/mock"
+
+# Open more granular breakdown in browser
+if [ "$CI" != "true" ]; then
+  # Generate the HTML report
+  genhtml coverage/filtered-lcov.info \
+    --ignore-errors inconsistent \
+    --rc branch_coverage=1 \
+    --rc max_message_count=3 \
+    -o coverage \
+    --ignore-errors category \
+    --ignore-errors format
+  open coverage/index.html
+fi