Merge pull request #16371 from argotorg/fix-gas-report

Fix external tests for hardhat-gas-reporter v2 compatibility

Author: r0qs

scripts/externalTests/common.sh

@@ -18,7 +18,7 @@
 #
 # (c) 2019 solidity contributors.
 #------------------------------------------------------------------------------
-set -e
+set -eo pipefail
 
 # Requires $REPO_ROOT to be defined and "${REPO_ROOT}/scripts/common.sh" to be included before.
 
@@ -434,9 +434,9 @@ function eth_gas_reporter_settings
     echo "    enabled: true,"
     echo "    gasPrice: 1,"                           # Gas price does not matter to us at all. Set to whatever to avoid API call.
     echo "    noColors: true,"
-    echo "    showTimeSpent: false,"                  # We're not interested in test timing
-    echo "    onlyCalledMethods: true,"               # Exclude entries with no gas for shorter report
+    echo "    showUncalledMethods: false,"            # Exclude entries with no gas for shorter report
     echo "    showMethodSig: true,"                   # Should make diffs more stable if there are overloaded functions
+    echo "    reportFormat: 'legacy',"                # Use v1.x format for compatibility with parse_eth_gas_report.py
     echo "    outputFile: \"$(gas_report_path "$preset")\""
     echo "}"
 }

scripts/externalTests/parse_eth_gas_report.py

@@ -10,8 +10,8 @@
 REPORT_HEADER_REGEX = re.compile(r'''
     ^[|\s]+ Solc[ ]version:\s*(?P<solc_version>[\w\d.]+)
     [|\s]+ Optimizer[ ]enabled:\s*(?P<optimize>[\w]+)
-    [|\s]+ Runs:\s*(?P<runs>[\d]+)
-    [|\s]+ Block[ ]limit:\s*(?P<block_limit>[\d]+)\s*gas
+    [|\s]+ Runs:\s*(?P<runs>[\d,]+)
+    [|\s]+ Block[ ]limit:\s*(?P<block_limit>[\d,]+)\s*gas
     [|\s]+$
 ''', re.VERBOSE)
 METHOD_HEADER_REGEX = re.compile(r'^[|\s]+Methods[|\s]+$')
@@ -122,10 +122,11 @@ def parse_bool(input_string: str) -> bool:
 
 
 def parse_optional_int(input_string: str, default: Optional[int] = None) -> Optional[int]:
-    if input_string.strip() == '-':
+    stripped = input_string.strip().replace(',', '')
+    if stripped == '-':
         return default
 
-    return int(input_string)
+    return int(stripped)
 
 
 def parse_report_header(line: str) -> Optional[dict]:
@@ -136,8 +137,8 @@ def parse_report_header(line: str) -> Optional[dict]:
     return {
         'solc_version': match.group('solc_version'),
         'optimize': parse_bool(match.group('optimize')),
-        'runs': int(match.group('runs')),
-        'block_limit': int(match.group('block_limit')),
+        'runs': int(match.group('runs').replace(',', '')),
+        'block_limit': int(match.group('block_limit').replace(',', '')),
     }
 
 
@@ -147,7 +148,7 @@ def parse_method_row(line: str, line_number: int) -> Optional[Tuple[str, str, Me
         raise ReportParsingError("Expected a table row with method details.", line, line_number)
 
     avg_gas = parse_optional_int(match['avg'])
-    call_count = int(match['call_count'])
+    call_count = int(match['call_count'].strip().replace(',', ''))
 
     if avg_gas is None and call_count == 0:
         # No calls, no gas values. Uninteresting. Skip the row.
@@ -174,7 +175,7 @@ def parse_deployment_row(line: str, line_number: int) -> Tuple[str, int, int, in
         match['contract'].strip(),
         parse_optional_int(match['min'].strip()),
         parse_optional_int(match['max'].strip()),
-        int(match['avg'].strip()),
+        int(match['avg'].strip().replace(',', '')),
     )
 
 

test/externalTests/gp2.sh

@@ -68,7 +68,8 @@ function gp2_test
     yarn
     # Hardhat 3.0+ breaks the test suite
     # v2.27.1 is the last v2 Hardhat (introduces Osaka support)
-    yarn add [email protected]
+    # hardhat-gas-reporter v2 is required for compatibility with our injected gas reporter settings
+    yarn add [email protected] hardhat-gas-reporter@^2
 
     # Ignore bench directory which fails to compile with current hardhat and ethers versions.
     # bench/trace/gas.ts:123:19 - error TS2339: Property 'equals' does not exist on type 'Uint8Array'.