feat(benchmark): add benchmark_test test type (ethereum#1945)

* feat: wrap blockchain test for benchmark

* feat: wrap state test for benchmark

* feat(benchmark): add code generator to generate transaction

* fix: resolve typing issue

* refactor: update benchmark code generator and test wrapper

* fix: udpate example changes

* refactor: resolve typing and update func interface

* refactor: remove benchmark state test wrapper

* fix: pydantic model validation for benchmark manager

* refactor synatx and parameter

* refactor: remove benchmark manager feature

* refactor: update logic and add benchmark tests

* refactor: enforce single property requirement in blockchain test generation

* refactor: update Bytecode serialization schema to use format_ser_schema

* refactor: update import paths

* refactor: update serialization schema

* refactor: remove unused parameters

* doc: add changelog entry

* fix typo

Author: LouisTsai-Csie

benchmark/conftest.py

@@ -4,6 +4,8 @@
 
 import pytest
 
+from ethereum_test_forks import Fork
+
 DEFAULT_BENCHMARK_FORK = "Prague"
 
 
@@ -59,3 +61,9 @@ def pytest_collection_modifyitems(config, items):
 
     for i in reversed(items_for_removal):
         items.pop(i)
+
+
+@pytest.fixture
+def tx_gas_limit_cap(fork: Fork, gas_benchmark_value: int) -> int:
+    """Return the transaction gas limit cap."""
+    return fork.transaction_gas_limit_cap() or gas_benchmark_value

benchmark/test_worst_blocks.py

@@ -9,14 +9,15 @@
 
 import pytest
 
+from ethereum_test_base_types import Account
 from ethereum_test_forks import Fork
 from ethereum_test_tools import (
     AccessList,
-    Account,
     Address,
     Alloc,
     Block,
     BlockchainTestFiller,
+    Environment,
     Hash,
     StateTestFiller,
     Transaction,
@@ -112,11 +113,13 @@ def ether_transfer_case(
 def test_block_full_of_ether_transfers(
     blockchain_test: BlockchainTestFiller,
     pre: Alloc,
+    env: Environment,
     case_id: str,
     ether_transfer_case,
     iteration_count: int,
     transfer_amount: int,
     intrinsic_cost: int,
+    gas_benchmark_value: int,
 ):
     """
     Single test for ether transfer scenarios.
@@ -153,10 +156,10 @@ def test_block_full_of_ether_transfers(
     )
 
     blockchain_test(
+        genesis_environment=env,
         pre=pre,
         post=post_state,
         blocks=[Block(txs=txs)],
-        exclude_full_post_state_in_output=True,
         expected_benchmark_gas_used=iteration_count * intrinsic_cost,
     )
 

benchmark/test_worst_compute.py

@@ -15,10 +15,12 @@
 from py_ecc.bn128 import G1, G2, multiply
 
 from ethereum_test_base_types.base_types import Bytes
+from ethereum_test_benchmark.benchmark_code_generator import JumpLoopGenerator
 from ethereum_test_forks import Fork
 from ethereum_test_tools import (
     Address,
     Alloc,
+    BenchmarkTestFiller,
     Block,
     BlockchainTestFiller,
     Bytecode,
@@ -1842,30 +1844,14 @@ def test_worst_jumpis(
 
 @pytest.mark.slow
 def test_worst_jumpdests(
-    state_test: StateTestFiller,
+    benchmark_test: BenchmarkTestFiller,
     pre: Alloc,
-    fork: Fork,
-    gas_benchmark_value: int,
 ):
     """Test running a JUMPDEST-intensive contract."""
-    max_code_size = fork.max_code_size()
-
-    # Create and deploy a contract with many JUMPDESTs
-    code_suffix = Op.JUMP(Op.PUSH0)
-    code_body = Op.JUMPDEST * (max_code_size - len(code_suffix))
-    code = code_body + code_suffix
-    jumpdests_address = pre.deploy_contract(code=code)
-
-    tx = Transaction(
-        to=jumpdests_address,
-        gas_limit=gas_benchmark_value,
-        sender=pre.fund_eoa(),
-    )
-
-    state_test(
+    benchmark_test(
         pre=pre,
         post={},
-        tx=tx,
+        code_generator=JumpLoopGenerator(attack_block=Op.JUMPDEST),
     )
 
 
@@ -2764,31 +2750,17 @@ def test_worst_calldataload(
     ],
 )
 def test_worst_swap(
-    state_test: StateTestFiller,
+    benchmark_test: BenchmarkTestFiller,
     pre: Alloc,
-    fork: Fork,
     opcode: Opcode,
-    gas_benchmark_value: int,
 ):
     """Test running a block with as many SWAP as possible."""
-    max_code_size = fork.max_code_size()
-
-    code_prefix = Op.JUMPDEST + Op.PUSH0 * opcode.min_stack_height
-    code_suffix = Op.PUSH0 + Op.JUMP
-    opcode_sequence = opcode * (max_code_size - len(code_prefix) - len(code_suffix))
-    code = code_prefix + opcode_sequence + code_suffix
-    assert len(code) <= max_code_size
-
-    tx = Transaction(
-        to=pre.deploy_contract(code=code),
-        gas_limit=gas_benchmark_value,
-        sender=pre.fund_eoa(),
-    )
-
-    state_test(
+    benchmark_test(
         pre=pre,
         post={},
-        tx=tx,
+        code_generator=JumpLoopGenerator(
+            attack_block=opcode, setup=Op.PUSH0 * opcode.min_stack_height
+        ),
     )