fix: foundry coverage

Author: LHerskind

l1-contracts/bootstrap.sh

@@ -336,34 +336,39 @@ function coverage {
   forge --version
 
   # Default values
-  MATCH_PATH=""
+  TEST_MATCH_PATH=""
   LCOV=false
   SERVE=false
   HELP=false
   GOVERNANCE=false
+  CORE=false
 
   # Help text
   show_help() {
     echo "Usage: ./bootstrap.sh coverage [options]"
     echo "Options:"
-    echo "  -p <path>    Run coverage only for files matching this path pattern"
-    echo "  -l           Generate LCOV report"
-    echo "  -s           Serve coverage report (requires -l)"
+    echo "  -p <path>    Run only tests in files matching this path pattern"
+    echo "  -c           Run core coverage using only non-governance tests"
+    echo "  -l           Generate a fresh LCOV report"
+    echo "  -s           Serve the existing coverage report"
     echo "  -g           Run coverage for governance contracts using only gov tests"
     echo "  -h           Show this help message"
     echo ""
     echo "Examples:"
     echo "  ./bootstrap.sh coverage                  # Run coverage for all files"
-    echo "  ./bootstrap.sh coverage -p src/core      # Run coverage only for src/core"
-    echo "  ./bootstrap.sh coverage -l -s            # Generate and serve LCOV report"
+    echo "  ./bootstrap.sh coverage -p test/staking_asset_handler/**/*.t.sol  # Run only matching tests"
+    echo "  ./bootstrap.sh coverage -c               # Run core coverage using only non-governance tests"
+    echo "  ./bootstrap.sh coverage -s               # Serve the existing coverage report"
+    echo "  ./bootstrap.sh coverage -l -s            # Generate and serve a fresh LCOV report"
     echo "  ./bootstrap.sh coverage -g               # Run coverage for governance contracts using only gov tests"
     echo "  ./bootstrap.sh coverage -g -l -s         # Run coverage for governance contracts using only gov tests with LCOV report and serve"
   }
 
   # Parse options
-  while getopts "p:lshg" opt; do
+  while getopts "p:lcshg" opt; do
     case $opt in
-      p) MATCH_PATH="$OPTARG" ;;
+      p) TEST_MATCH_PATH="$OPTARG" ;;
+      c) CORE=true ;;
       l) LCOV=true ;;
       s) SERVE=true ;;
       h) HELP=true ;;
@@ -378,54 +383,96 @@ function coverage {
     exit 0
   fi
 
-  # Validate serve option
   if [ "$SERVE" = true ] && [ "$LCOV" = false ]; then
-    echo "Error: -s option requires -l option to be enabled"
+    if [ -n "$TEST_MATCH_PATH" ] || [ "$GOVERNANCE" = true ] || [ "$CORE" = true ]; then
+      echo "Warning: -s serves the existing report only; it cannot be combined with -p, -c, or -g without -l"
+      exit 1
+    fi
+
+    coverage_serve
+    exit 0
+  fi
+
+  download_solc
+
+  local -a ENV_VARS=("FOUNDRY_PROFILE=coverage" "FORGE_COVERAGE=true")
+  local -a CMD=("forge" "coverage" "--offline")
+
+  if [ "$GOVERNANCE" = true ] && [ "$CORE" = true ]; then
+    echo "Warning: -c and -g cannot be used together"
     exit 1
   fi
 
-  # Build the command
   if [ "$GOVERNANCE" = true ]; then
-    CMD="FORGE_COVERAGE=true forge coverage --match-path \"test/governance/**/*.t.sol\" --no-match-coverage \"(test|script|mock|generated|core|periphery)\""
+    CMD+=(
+      "--match-path" "test/governance/**/*.t.sol"
+      "--no-match-coverage" "(test|script|mock|generated|core|periphery)"
+    )
+  elif [ "$CORE" = true ]; then
+    CMD+=(
+      "--no-match-path" "test/governance/**/*.t.sol"
+      "--no-match-coverage" "(test|script|mock|generated|governance)"
+    )
   else
-    # Default coverage command
-    CMD="FORGE_COVERAGE=true forge coverage --no-match-coverage \"(test|script|mock|generated)\""
+    CMD+=("--no-match-coverage" "(test|script|mock|generated)")
   fi
 
-  if [ -n "$MATCH_PATH" ] && [ "$GOVERNANCE" = true ]; then
-    echo "Warning: -p option is not supported in governance mode"
+  if [ -n "$TEST_MATCH_PATH" ] && { [ "$GOVERNANCE" = true ] || [ "$CORE" = true ]; }; then
+    echo "Warning: -p option is not supported in governance or core mode"
     exit 1
   fi
 
-  # Add path filter if specified (only if not in governance mode)
-  if [ -n "$MATCH_PATH" ] && [ "$GOVERNANCE" = false ]; then
-    if [ ! -e "$MATCH_PATH" ]; then
-      echo "Warning: Path '$MATCH_PATH' does not exist"
+  # Add a test-file filter if specified (only if not in governance mode).
+  # This narrows which tests execute via `--match-path`; it does not scope
+  # coverage output to those paths.
+  if [ -n "$TEST_MATCH_PATH" ] && [ "$GOVERNANCE" = false ]; then
+    local -a MATCHED_PATHS=()
+    shopt -s globstar nullglob
+    MATCHED_PATHS=($TEST_MATCH_PATH)
+    shopt -u globstar nullglob
+
+    if [ ${#MATCHED_PATHS[@]} -eq 0 ]; then
+      echo "Warning: Path pattern '$TEST_MATCH_PATH' did not match any files"
       exit 1
     fi
-    CMD="$CMD --match-path \"$MATCH_PATH\""
+    CMD+=("--match-path" "$TEST_MATCH_PATH")
   fi
 
   # Add LCOV report if requested
   if [ "$LCOV" = true ]; then
-    CMD="$CMD --report lcov"
+    CMD+=("--report" "lcov")
   fi
 
-  echo "Running coverage with command: $CMD"
-  eval "$CMD"
+  local DISPLAY_CMD
+  printf -v DISPLAY_CMD '%q ' env "${ENV_VARS[@]}" "${CMD[@]}"
+  echo "Running coverage with command: ${DISPLAY_CMD% }"
+  env "${ENV_VARS[@]}" "${CMD[@]}"
 
   # Serve report if requested
   if [ "$SERVE" = true ]; then
-    if ! command -v genhtml &> /dev/null; then
-      echo "Error: genhtml not found. Please install lcov package."
-      exit 1
-    fi
+    coverage_serve
+  fi
+}
+
+function coverage_serve {
+  echo_header "l1-contracts coverage serve"
+
+  if ! command -v genhtml &> /dev/null; then
+    echo "Error: genhtml not found. Please install lcov package."
+    exit 1
+  fi
 
-    mkdir -p coverage
-    genhtml lcov.info --branch-coverage --output-dir coverage
-    echo "Serving coverage report at http://localhost:8000"
-    python3 -m http.server --directory "coverage" 8000
+  if [ ! -f "lcov.info" ]; then
+    echo "Error: lcov.info not found. Run './bootstrap.sh coverage -l' first."
+    exit 1
   fi
+
+  mkdir -p coverage
+  # Foundry can emit LCOV branch records that genhtml treats as inconsistent
+  # even when the report is otherwise usable.
+  genhtml lcov.info --branch-coverage --ignore-errors inconsistent,inconsistent --output-dir coverage
+  echo "Serving coverage report at http://localhost:8000"
+  python3 -m http.server --directory "coverage" 8000
 }
 
 function release {
@@ -445,6 +492,12 @@ case "$cmd" in
   "hash")
     echo $hash
     ;;
+  "coverage-serve")
+    coverage_serve
+    ;;
+  "coverage_serve")
+    coverage_serve
+    ;;
   *)
     default_cmd_handler "$@"
     ;;

l1-contracts/coverage-script/.gitkeep

@@ -0,0 +1 @@
+

l1-contracts/foundry.toml

@@ -38,6 +38,7 @@ remappings = [
   "@oz/=lib/openzeppelin-contracts/contracts/",
   "@aztec/=src",
   "@test/=test",
+  "@generated/=generated/",
   "@zkpassport/=lib/circuits/src/solidity/src/",
   "@zkpassport-test/=lib/circuits/src/solidity/test",
   "@aztec-blob-lib/=src/mock/libraries",
@@ -95,7 +96,30 @@ remappings = [
   "@oz/=lib/openzeppelin-contracts/contracts/",
   "@aztec/=src",
   "@test/=test",
+  "@generated/=generated/",
   "@zkpassport/=lib/circuits/src/solidity/src/",
   "@zkpassport-test/=lib/circuits/src/solidity/test",
   "@aztec-blob-lib/=src/core/libraries/rollup/",
 ]
+
+[profile.coverage]
+script = "coverage-script"
+sparse_mode = true
+skip = [
+  "shouting.t.sol",
+  "test/benchmark/happy.t.sol",
+  "test/script",
+  "script/deploy/DeployAztecL1Contracts.s.sol",
+  "test/staking/move.t.sol",
+  "test/validator-selection/setupEpoch.t.sol",
+  "test/validator-selection/setupSampleSeed.t.sol",
+]
+remappings = [
+  "@oz/=lib/openzeppelin-contracts/contracts/",
+  "@aztec/=src",
+  "@test/=test",
+  "@generated/=src/mock/coverage/generated/",
+  "@zkpassport/=src/mock/coverage/zkpassport/",
+  "@zkpassport-test/=lib/circuits/src/solidity/test",
+  "@aztec-blob-lib/=src/mock/libraries",
+]

l1-contracts/script/deploy/DeployRollupLib.sol

@@ -24,7 +24,7 @@ import {TestERC20} from "@aztec/mock/TestERC20.sol";
 
 import {SlashFactory} from "@aztec/periphery/SlashFactory.sol";
 
-import {HonkVerifier} from "../../generated/HonkVerifier.sol";
+import {HonkVerifier} from "@generated/HonkVerifier.sol";
 
 import {IRollupConfiguration} from "./RollupConfiguration.sol";
 

l1-contracts/script/deploy/RollupConfiguration.sol

@@ -102,50 +102,46 @@ contract RollupConfiguration is IRollupConfiguration, Test {
     view
     returns (RollupConfigInput memory)
   {
-    uint256 aztecSlotDuration = vm.envUint("AZTEC_SLOT_DURATION");
-    uint256 aztecEpochDuration = vm.envUint("AZTEC_EPOCH_DURATION");
-    uint256 roundSizeInEpochs = vm.envUint("AZTEC_SLASHING_ROUND_SIZE_IN_EPOCHS");
-    uint256 slashingRoundSize = roundSizeInEpochs * aztecEpochDuration;
-    // The slashing quorum, i.e. how many slots must signal for the same payload in a round for it to be submittable to
-    // the Slasher (defaults to slashRoundSize / 2 + 1)
-    uint256 slashingQuorum = vm.envOr("AZTEC_SLASHING_QUORUM", slashingRoundSize / 2 + 1);
-
-    // Build config without version first
-    RollupConfigInput memory config = RollupConfigInput({
-      aztecSlotDuration: aztecSlotDuration,
-      aztecEpochDuration: aztecEpochDuration,
-      targetCommitteeSize: vm.envUint("AZTEC_TARGET_COMMITTEE_SIZE"),
-      lagInEpochsForValidatorSet: vm.envUint("AZTEC_LAG_IN_EPOCHS_FOR_VALIDATOR_SET"),
-      lagInEpochsForRandao: vm.envUint("AZTEC_LAG_IN_EPOCHS_FOR_RANDAO"),
-      inboxLag: vm.envUint("AZTEC_INBOX_LAG"),
-      aztecProofSubmissionEpochs: vm.envUint("AZTEC_PROOF_SUBMISSION_EPOCHS"),
-      localEjectionThreshold: vm.envUint("AZTEC_LOCAL_EJECTION_THRESHOLD"),
-      slashingQuorum: slashingQuorum,
-      slashingRoundSize: slashingRoundSize,
-      slashingLifetimeInRounds: vm.envUint("AZTEC_SLASHING_LIFETIME_IN_ROUNDS"),
-      slashingExecutionDelayInRounds: vm.envUint("AZTEC_SLASHING_EXECUTION_DELAY_IN_ROUNDS"),
-      slashAmounts: _getSlashAmounts(),
-      slashingOffsetInRounds: _getSlashingOffset(),
-      slasherFlavor: _getSlasherFlavor(),
-      slashingVetoer: vm.envAddress("AZTEC_SLASHING_VETOER"),
-      slashingDisableDuration: vm.envUint("AZTEC_SLASHING_DISABLE_DURATION"),
-      manaTarget: vm.envUint("AZTEC_MANA_TARGET"),
-      exitDelaySeconds: vm.envUint("AZTEC_EXIT_DELAY_SECONDS"),
-      version: 0, // Computed below
-      provingCostPerMana: EthValue.wrap(vm.envUint("AZTEC_PROVING_COST_PER_MANA")),
-      initialEthPerFeeAsset: EthPerFeeAssetE12.wrap(vm.envUint("AZTEC_INITIAL_ETH_PER_FEE_ASSET")),
-      rewardConfig: this.getRewardConfiguration(_rewardDistributor),
-      rewardBoostConfig: this.getRewardBoostConfiguration(),
-      stakingQueueConfig: this.getStakingQueueConfiguration(),
-      earliestRewardsClaimableTimestamp: getEarliestRewardsClaimableTimestamp()
-    });
+    RollupConfigInput memory config = _getBaseRollupConfiguration();
+    config.rewardConfig = this.getRewardConfiguration(_rewardDistributor);
+    config.rewardBoostConfig = this.getRewardBoostConfiguration();
+    config.stakingQueueConfig = this.getStakingQueueConfiguration();
+    config.earliestRewardsClaimableTimestamp = getEarliestRewardsClaimableTimestamp();
 
     // Compute version as first 4 bytes of hash(abi.encode(config, genesisState))
     config.version = _computeConfigVersion(config, this.getGenesisState());
 
     return config;
   }
 
+  function _getBaseRollupConfiguration() private view returns (RollupConfigInput memory config) {
+    uint256 aztecEpochDuration = vm.envUint("AZTEC_EPOCH_DURATION");
+    uint256 slashingRoundSize = vm.envUint("AZTEC_SLASHING_ROUND_SIZE_IN_EPOCHS") * aztecEpochDuration;
+
+    config.aztecSlotDuration = vm.envUint("AZTEC_SLOT_DURATION");
+    config.aztecEpochDuration = aztecEpochDuration;
+    config.targetCommitteeSize = vm.envUint("AZTEC_TARGET_COMMITTEE_SIZE");
+    config.lagInEpochsForValidatorSet = vm.envUint("AZTEC_LAG_IN_EPOCHS_FOR_VALIDATOR_SET");
+    config.lagInEpochsForRandao = vm.envUint("AZTEC_LAG_IN_EPOCHS_FOR_RANDAO");
+    config.inboxLag = vm.envUint("AZTEC_INBOX_LAG");
+    config.aztecProofSubmissionEpochs = vm.envUint("AZTEC_PROOF_SUBMISSION_EPOCHS");
+    config.localEjectionThreshold = vm.envUint("AZTEC_LOCAL_EJECTION_THRESHOLD");
+    config.slashingQuorum = vm.envOr("AZTEC_SLASHING_QUORUM", slashingRoundSize / 2 + 1);
+    config.slashingRoundSize = slashingRoundSize;
+    config.slashingLifetimeInRounds = vm.envUint("AZTEC_SLASHING_LIFETIME_IN_ROUNDS");
+    config.slashingExecutionDelayInRounds = vm.envUint("AZTEC_SLASHING_EXECUTION_DELAY_IN_ROUNDS");
+    config.slashAmounts = _getSlashAmounts();
+    config.slashingOffsetInRounds = _getSlashingOffset();
+    config.slasherFlavor = _getSlasherFlavor();
+    config.slashingVetoer = vm.envAddress("AZTEC_SLASHING_VETOER");
+    config.slashingDisableDuration = vm.envUint("AZTEC_SLASHING_DISABLE_DURATION");
+    config.manaTarget = vm.envUint("AZTEC_MANA_TARGET");
+    config.exitDelaySeconds = vm.envUint("AZTEC_EXIT_DELAY_SECONDS");
+    config.version = 0;
+    config.provingCostPerMana = EthValue.wrap(vm.envUint("AZTEC_PROVING_COST_PER_MANA"));
+    config.initialEthPerFeeAsset = EthPerFeeAssetE12.wrap(vm.envUint("AZTEC_INITIAL_ETH_PER_FEE_ASSET"));
+  }
+
   /// @notice Compute rollup config version by hashing config + genesis state
   /// @dev Version is the first 4 bytes (uint32) of keccak256(abi.encode(rollupConfig, genesisState))
   ///      This DOES NOT match the TS implementation: keccak256(jsonStringify({rollupConfigArgs, genesisStateArgs}))