create report scripts

Author: turbocrime

.github/workflows/test.yml

@@ -5,16 +5,17 @@ on:
   pull_request:
   workflow_dispatch:
 
-env:
-  FOUNDRY_PROFILE: ci
-
 jobs:
   check:
     strategy:
       fail-fast: true
+      matrix:
+        foundry_profile: ["test-via-ir", "test-no-ir"]
 
     name: Foundry project
     runs-on: ubuntu-latest
+    env:
+      FOUNDRY_PROFILE: ${{ matrix.foundry_profile }}
     steps:
       - uses: actions/checkout@v4
         with:
@@ -39,23 +40,30 @@ jobs:
           forge build --sizes
         id: build
 
+      # This `forge snapshot` command is only used for CBORDecoder comparison.
+      # https://book.getfoundry.sh/forge/gas-section-snapshots
       - name: Confirm comparison snapshot
         run: |
-          forge snapshot --match-path "test/comparison/*" --check
+          forge snapshot --check ${{ env.FOUNDRY_PROFILE }}.gas-snapshot \
+            --match-path "test/comparison/*"
         id: comparison-snapshot
 
-      - name: Run all Forge tests
+      - name: Run remaining Forge tests, confirm section snapshots
         run: |
-          forge test -vvv
+          forge test -vvv \
+            --no-match-path "test/comparison/*"
+          git diff --exit-code snapshots-${{ env.FOUNDRY_PROFILE }}
         id: test
 
-      - name: Confirm section snapshots
-        run: |
-          git diff --exit-code snapshots
-        id: diff-section-snapshots
 
+      # Coverage testing affects gas cost, and creates different snapshots.
+      # Only `lcov.info` is diffed to confirm coverage is checked in.  Coverage
+      # doesn't use the 'comparison' tests.
       - name: Confirm coverage
         run: |
-          forge coverage --report lcov
-          git diff --exit-code lcov.info
-        id: diff-coverage
+          forge coverage --report-file ${{ env.FOUNDRY_PROFILE }}.lcov.info \
+            --report lcov --report summary \
+            --no-match-path "test/comparison/*" \
+            --no-match-coverage "test/comparison/*"
+          git diff --exit-code ${{ env.FOUNDRY_PROFILE }}.lcov.info
+        id: diff-coverage

foundry.toml

@@ -1,17 +1,17 @@
 [profile.default]
-src = "src"
-out = "out"
-libs = ["lib"]
-optimize = true
+src            = "src"
+out            = "out"
+libs           = ["lib"]
+optimize       = true
 optimizer_runs = 1000000
 
+[fmt]
+int_types = "preserve"
+
 [profile.test-no-ir]
-via-ir = false
+via-ir    = false
+snapshots = "snapshots-test-no-ir"
 
 [profile.test-via-ir]
-via-ir = true
-
-# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options
-
-[fmt]
-int_types = "preserve"
+via-ir    = true
+snapshots = "snapshots-test-via-ir"

generate-snapshots.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env sh
+
+set -euxo pipefail
+
+unset FORGE_GAS_REPORT
+unset FOUNDRY_PROFILE
+unset FOUNDRY_VIA_IR
+
+for test_profile in test-no-ir test-via-ir; do
+  export FOUNDRY_PROFILE=$test_profile
+  forge coverage --force --report-file $test_profile.lcov.info --report lcov --report summary --no-match-path "test/comparison/*" --no-match-coverage "test/comparison/*"
+  forge snapshot --force --snap $test_profile.gas-snapshot --match-path "test/comparison/*"
+  forge test --force -vvv --no-match-path "test/comparison/*"
+done