refactor(all): rename 'engine reorg' to 'engine x'

danceratopz · danceratopz · commit 3537b50b9280 · 2025-06-18T05:47:35.000+02:00
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -31,7 +31,7 @@ Users can select any of the artifacts depending on their testing needs for their
 
 - ✨ Add the `ported_from` test marker to track Python test cases that were converted from static fillers in [ethereum/tests](https://github.com/ethereum/tests) repository [#1590](https://github.com/ethereum/execution-spec-tests/pull/1590).
 - ✨ Add a new pytest plugin, `ported_tests`, that lists the static fillers and PRs from `ported_from` markers for use in the coverage Github Workflow [#1634](https://github.com/ethereum/execution-spec-tests/pull/1634).
-- ✨ Enable two-phase filling of fixtures with shared pre-allocation groups and add a `BlockchainEngineReorgFixture` format [#1606](https://github.com/ethereum/execution-spec-tests/pull/1706).
+- ✨ Enable two-phase filling of fixtures with shared pre-allocation groups and add a `BlockchainEngineXFixture` format [#1606](https://github.com/ethereum/execution-spec-tests/pull/1706).
 - 🔀 Refactor: Encapsulate `fill`'s fixture output options (`--output`, `--flat-output`, `--single-fixture-per-file`) into a `FixtureOutput` class ([#1471](https://github.com/ethereum/execution-spec-tests/pull/1471),[#1612](https://github.com/ethereum/execution-spec-tests/pull/1612)).
 - ✨ Don't warn about a "high Transaction gas_limit" for `zkevm` tests ([#1598](https://github.com/ethereum/execution-spec-tests/pull/1598)).
 - 🐞 `fill` no longer writes generated fixtures into an existing, non-empty output directory; it must now be empty or `--clean` must be used to delete it first ([#1608](https://github.com/ethereum/execution-spec-tests/pull/1608)).
diff --git a/docs/running_tests/test_formats/blockchain_test_engine_x.md b/docs/running_tests/test_formats/blockchain_test_engine_x.md
@@ -1,26 +1,26 @@
-# Blockchain Engine Reorg Tests  <!-- markdownlint-disable MD051 (MD051=link-fragments "Link fragments should be valid") -->
+# Blockchain Engine X Tests  <!-- markdownlint-disable MD051 (MD051=link-fragments "Link fragments should be valid") -->
 
-The Blockchain Engine Reorg Test fixture format tests are included in the fixtures subdirectory `blockchain_tests_engine_reorg`, and use Engine API directives with optimized shared pre-allocation for improved execution performance.
+The Blockchain Engine X Test fixture format tests are included in the fixtures subdirectory `blockchain_tests_engine_x`, and use Engine API directives with optimized shared pre-allocation for improved execution performance.
 
 These are produced by the `StateTest` and `BlockchainTest` test specs when using the `--generate-shared-pre` and `--use-shared-pre` flags.
 
 ## Description
 
-The Blockchain Engine Reorg Test fixture format is an optimized variant of the [Blockchain Engine Test](./blockchain_test_engine.md) format designed for large-scale test execution with performance optimizations.
+The Blockchain Engine X Test fixture format is an optimized variant of the [Blockchain Engine Test](./blockchain_test_engine.md) format designed for large-scale test execution with performance optimizations.
 
-It uses the Engine API to test block validation and consensus rules while leveraging **shared pre-allocation state** to significantly reduce test execution time and resource usage. Tests are grouped by their initial state (fork + environment + pre-allocation) and share common genesis states through blockchain reorganization.
+It uses the Engine API to test block validation and consensus rules while leveraging **shared pre-allocation state** to significantly reduce test execution time and resource usage. Tests are grouped by their initial state (fork + environment + pre-allocation). Each groups are executed against the same client instance using a common genesis state.
 
 The key optimization is that **clients need only be started once per group** instead of once per test (as in the original engine fixture format), dramatically improving execution performance for large test suites.
 
 Instead of including large pre-allocation state in each test fixture, this format references a shared pre-allocation folder (`pre_alloc`) which includes all different pre-allocation combinations used for any test fixture group.
 
-A single JSON fixture file is composed of a JSON object where each key-value pair is a different [`ReorgFixture`](#reorgfixture) test object, with the key string representing the test name.
+A single JSON fixture file is composed of a JSON object where each key-value pair is a different [`BlockchainTestEngineXFixture`](#BlockchainTestEngineXFixture) test object, with the key string representing the test name.
 
 The JSON file path plus the test name are used as the unique test identifier.
 
 ## Shared Pre-Allocation File
 
-The `blockchain_tests_engine_reorg` directory contains a special directory `pre_alloc` that stores shared pre-allocation state file used by all tests in this format, one per pre-allocation group with the name of the pre-alloc hash. This folder is essential for test execution and must be present alongside the test fixtures.
+The `blockchain_tests_engine_x` directory contains a special directory `pre_alloc` that stores shared pre-allocation state file used by all tests in this format, one per pre-allocation group with the name of the pre-alloc hash. This folder is essential for test execution and must be present alongside the test fixtures.
 
 ### Pre-Allocation File Structure
 
@@ -48,7 +48,7 @@ Each file in the `pre_alloc` folder corresponds to a pre-allocation hash to shar
 
 ## Consumption
 
-For each [`ReorgFixture`](#reorgfixture) test object in the JSON fixture file, perform the following steps:
+For each [`BlockchainTestEngineXFixture`](#BlockchainTestEngineXFixture) test object in the JSON fixture file, perform the following steps:
 
 1. **Load Shared Pre-Allocation**:
    - Read the appropriate file from the `pre_alloc` folder in the same directory
@@ -76,7 +76,7 @@ For each [`ReorgFixture`](#reorgfixture) test object in the JSON fixture file, p
 
 ## Structures
 
-### `ReorgFixture`
+### `BlockchainTestEngineXFixture`
 
 #### - `network`: [`Fork`](./common_types.md#fork)
 
@@ -100,7 +100,7 @@ List of `engine_newPayloadVX` directives to be processed after the genesis block
 
 #### - `syncPayload`: [`Optional`](./common_types.md#optional)`[`[`FixtureEngineNewPayload`](#fixtureenginenewpayload)`]`
 
-Optional synchronization payload used for blockchain reorganization scenarios. When present, this payload is typically used to sync the chain to a specific state before or after the main payload sequence.
+Optional synchronization payload. When present, this payload is typically used to sync the chain to a specific state before or after the main payload sequence.
 
 #### - `lastblockhash`: [`Hash`](./common_types.md#hash)
 
@@ -120,7 +120,7 @@ To reconstruct the final state:
 
 #### - `config`: [`FixtureConfig`](#fixtureconfig)
 
-Chain configuration object to be applied to the client running the blockchain engine reorg test.
+Chain configuration object to be applied to the client running the blockchain engine x test.
 
 ### `FixtureConfig`
 
@@ -142,4 +142,3 @@ Engine API payload structure identical to the one defined in [Blockchain Engine
 - The `pre_alloc` folder is essential and must be distributed with the test fixtures
 - Tests are grouped by identical (fork + environment + pre-allocation) combinations
 - The format is optimized for Engine API testing (post-Paris forks)
-- Reorganization scenarios are supported through the `forkChoiceUpdate` mechanism
diff --git a/src/cli/show_pre_alloc_group_stats.py b/src/cli/show_pre_alloc_group_stats.py
@@ -452,7 +452,7 @@ def display_stats(stats: Dict, console: Console, verbose: int = 0):
 @click.argument(
     "pre_alloc_folder",
     type=click.Path(exists=True, path_type=Path),
-    default="fixtures/blockchain_tests_engine_reorg/pre_alloc",
+    default="fixtures/blockchain_tests_engine_x/pre_alloc",
 )
 @click.option(
     "--verbose",
diff --git a/src/ethereum_test_fixtures/__init__.py b/src/ethereum_test_fixtures/__init__.py
@@ -4,7 +4,7 @@
 from .blockchain import (
     BlockchainEngineFixture,
     BlockchainEngineFixtureCommon,
-    BlockchainEngineReorgFixture,
+    BlockchainEngineXFixture,
     BlockchainFixture,
     BlockchainFixtureCommon,
 )
@@ -19,7 +19,7 @@
     "BaseFixture",
     "BlockchainEngineFixture",
     "BlockchainEngineFixtureCommon",
-    "BlockchainEngineReorgFixture",
+    "BlockchainEngineXFixture",
     "BlockchainFixture",
     "BlockchainFixtureCommon",
     "EOFFixture",
diff --git a/src/ethereum_test_fixtures/blockchain.py b/src/ethereum_test_fixtures/blockchain.py
@@ -64,7 +64,7 @@ def validate_post_state_fields(self):
             if mode == "after":
                 # Determine which fields to check
                 if alternate_field:
-                    # For reorg fixtures: check post_state vs post_state_diff
+                    # For engine x fixtures: check post_state vs post_state_diff
                     field1_name, field2_name = "post_state", alternate_field
                 else:
                     # For standard fixtures: check post_state vs post_state_hash
@@ -560,19 +560,16 @@ class BlockchainEngineFixture(BlockchainEngineFixtureCommon):
 
 
 @post_state_validator(alternate_field="post_state_diff")
-class BlockchainEngineReorgFixture(BlockchainEngineFixtureCommon):
+class BlockchainEngineXFixture(BlockchainEngineFixtureCommon):
     """
-    Engine reorg specific test fixture information.
+    Engine X specific test fixture information.
 
-    Uses shared pre-allocations and blockchain reorganization for efficient
+    Uses shared pre-allocations (and a shared client instance) for efficient
     test execution without client restarts.
     """
 
-    format_name: ClassVar[str] = "blockchain_test_engine_reorg"
-    description: ClassVar[str] = (
-        "Tests that generate a blockchain test fixture for use with a shared pre-state and engine "
-        "reorg execution."
-    )
+    format_name: ClassVar[str] = "blockchain_test_engine_x"
+    description: ClassVar[str] = "Tests that generate a Blockchain Test Engine X fixture."
 
     pre_hash: str
     """Hash of the shared pre-allocation group this test belongs to."""
diff --git a/src/ethereum_test_specs/blockchain.py b/src/ethereum_test_specs/blockchain.py
@@ -28,7 +28,7 @@
 from ethereum_test_fixtures import (
     BaseFixture,
     BlockchainEngineFixture,
-    BlockchainEngineReorgFixture,
+    BlockchainEngineXFixture,
     BlockchainFixture,
     FixtureFormat,
     LabeledFixtureFormat,
@@ -308,7 +308,7 @@ class BlockchainTest(BaseTest):
     supported_fixture_formats: ClassVar[Sequence[FixtureFormat | LabeledFixtureFormat]] = [
         BlockchainFixture,
         BlockchainEngineFixture,
-        BlockchainEngineReorgFixture,
+        BlockchainEngineXFixture,
     ]
     supported_execute_formats: ClassVar[Sequence[LabeledExecuteFormat]] = [
         LabeledExecuteFormat(
@@ -630,7 +630,7 @@ def make_hive_fixture(
         t8n: TransitionTool,
         fork: Fork,
         fixture_format: FixtureFormat = BlockchainEngineFixture,
-    ) -> BlockchainEngineFixture | BlockchainEngineReorgFixture:
+    ) -> BlockchainEngineFixture | BlockchainEngineXFixture:
         """Create a hive fixture from the blocktest definition."""
         fixture_payloads: List[FixtureEngineNewPayload] = []
 
@@ -722,8 +722,8 @@ def make_hive_fixture(
         }
 
         # Add format-specific fields
-        if fixture_format == BlockchainEngineReorgFixture:
-            # For reorg format, exclude pre (will be provided via shared state)
+        if fixture_format == BlockchainEngineXFixture:
+            # For Engine X format, exclude pre (will be provided via shared state)
             # and prepare for state diff optimization
             fixture_data.update(
                 {
@@ -733,7 +733,7 @@ def make_hive_fixture(
                     "pre_hash": "",  # Will be set by BaseTestWrapper
                 }
             )
-            return BlockchainEngineReorgFixture(**fixture_data)
+            return BlockchainEngineXFixture(**fixture_data)
         else:
             # Standard engine fixture
             fixture_data.update(
@@ -760,7 +760,7 @@ def generate(
         t8n.reset_traces()
         if fixture_format == BlockchainEngineFixture:
             return self.make_hive_fixture(t8n, fork, fixture_format)
-        elif fixture_format == BlockchainEngineReorgFixture:
+        elif fixture_format == BlockchainEngineXFixture:
             return self.make_hive_fixture(t8n, fork, fixture_format)
         elif fixture_format == BlockchainFixture:
             return self.make_fixture(t8n, fork)
diff --git a/src/pytest_plugins/filler/filler.py b/src/pytest_plugins/filler/filler.py
@@ -26,7 +26,7 @@
 from ethereum_test_base_types import Account, Address, Alloc, ReferenceSpec
 from ethereum_test_fixtures import (
     BaseFixture,
-    BlockchainEngineReorgFixture,
+    BlockchainEngineXFixture,
     FixtureCollector,
     FixtureConsumer,
     LabeledFixtureFormat,
@@ -55,7 +55,7 @@ def calculate_post_state_diff(post_state: Alloc, genesis_state: Alloc) -> Alloc:
     """
     Calculate the state difference between post_state and genesis_state.
 
-    This function enables significant space savings in reorg fixtures by storing
+    This function enables significant space savings in Engine X fixtures by storing
     only the accounts that changed during test execution, rather than the full
     post-state which may contain thousands of unchanged shared accounts.
 
@@ -878,17 +878,17 @@ def __init__(self, *args, **kwargs):
                 self._request = request
 
                 # Phase 1: Generate shared pre-state
-                if fixture_format is BlockchainEngineReorgFixture and request.config.getoption(
+                if fixture_format is BlockchainEngineXFixture and request.config.getoption(
                     "generate_shared_pre"
                 ):
                     self.update_shared_pre_state(
                         request.config.shared_pre_state, fork, request.node.nodeid
                     )
                     return  # Skip fixture generation in phase 1
 
-                # Phase 2: Use shared pre-state (only for BlockchainEngineReorgFixture)
+                # Phase 2: Use shared pre-state (only for BlockchainEngineXFixture)
                 pre_alloc_hash = None
-                if fixture_format is BlockchainEngineReorgFixture and request.config.getoption(
+                if fixture_format is BlockchainEngineXFixture and request.config.getoption(
                     "use_shared_pre"
                 ):
                     pre_alloc_hash = self.compute_shared_pre_alloc_hash(fork=fork)
@@ -911,9 +911,9 @@ def __init__(self, *args, **kwargs):
                     fixture_format=fixture_format,
                 )
 
-                # Post-process for reorg format (add pre_hash and state diff)
+                # Post-process for Engine X format (add pre_hash and state diff)
                 if (
-                    fixture_format is BlockchainEngineReorgFixture
+                    fixture_format is BlockchainEngineXFixture
                     and request.config.getoption("use_shared_pre")
                     and pre_alloc_hash is not None
                 ):
@@ -968,28 +968,28 @@ def pytest_generate_tests(metafunc: pytest.Metafunc):
             use_shared_pre = metafunc.config.getoption("use_shared_pre", False)
 
             if generate_shared_pre or use_shared_pre:
-                # When shared alloc flags are set, only generate BlockchainEngineReorgFixture
+                # When shared alloc flags are set, only generate BlockchainEngineXFixture
                 supported_formats = [
                     format_item
                     for format_item in test_type.supported_fixture_formats
                     if (
-                        format_item is BlockchainEngineReorgFixture
+                        format_item is BlockchainEngineXFixture
                         or (
                             isinstance(format_item, LabeledFixtureFormat)
-                            and format_item.format is BlockchainEngineReorgFixture
+                            and format_item.format is BlockchainEngineXFixture
                         )
                     )
                 ]
             else:
-                # Filter out BlockchainEngineReorgFixture if shared alloc flags not set
+                # Filter out BlockchainEngineXFixture if shared alloc flags not set
                 supported_formats = [
                     format_item
                     for format_item in test_type.supported_fixture_formats
                     if not (
-                        format_item is BlockchainEngineReorgFixture
+                        format_item is BlockchainEngineXFixture
                         or (
                             isinstance(format_item, LabeledFixtureFormat)
-                            and format_item.format is BlockchainEngineReorgFixture
+                            and format_item.format is BlockchainEngineXFixture
                         )
                     )
                 ]
diff --git a/src/pytest_plugins/filler/fixture_output.py b/src/pytest_plugins/filler/fixture_output.py
@@ -7,7 +7,7 @@
 import pytest
 from pydantic import BaseModel, Field
 
-from ethereum_test_fixtures.blockchain import BlockchainEngineReorgFixture
+from ethereum_test_fixtures.blockchain import BlockchainEngineXFixture
 
 
 class FixtureOutput(BaseModel):
@@ -64,8 +64,8 @@ def is_stdout(self) -> bool:
     @property
     def shared_pre_alloc_folder_path(self) -> Path:
         """Return the path for shared pre-allocation state file."""
-        reorg_dir = BlockchainEngineReorgFixture.output_base_dir_name()
-        return self.directory / reorg_dir / "pre_alloc"
+        engine_x_dir = BlockchainEngineXFixture.output_base_dir_name()
+        return self.directory / engine_x_dir / "pre_alloc"
 
     @staticmethod
     def strip_tarball_suffix(path: Path) -> Path:
diff --git a/src/pytest_plugins/forks/tests/test_forks.py b/src/pytest_plugins/forks/tests/test_forks.py
@@ -45,7 +45,7 @@ def test_all_forks({StateTest.pytest_parameter_name()}):
                 fixture_format_label = fixture_format.format_name.lower()
             if (
                 not fixture_format.supports_fork(fork)
-                or "blockchain_test_engine_reorg" in fixture_format_label
+                or "blockchain_test_engine_x" in fixture_format_label
             ):
                 expected_passed -= 1
                 assert f":test_all_forks[fork_{fork}-{fixture_format_label}]" not in stdout
@@ -91,7 +91,7 @@ def test_all_forks({StateTest.pytest_parameter_name()}):
                 fixture_format_label = fixture_format.format_name.lower()
             if (
                 not fixture_format.supports_fork(fork)
-                or "blockchain_test_engine_reorg" in fixture_format_label
+                or "blockchain_test_engine_x" in fixture_format_label
             ):
                 expected_passed -= 1
                 assert f":test_all_forks[fork_{fork}-{fixture_format_label}]" not in stdout
@@ -137,7 +137,7 @@ def test_all_forks({StateTest.pytest_parameter_name()}):
                 fixture_format_label = fixture_format.format_name.lower()
             if (
                 not fixture_format.supports_fork(fork)
-                or "blockchain_test_engine_reorg" in fixture_format_label
+                or "blockchain_test_engine_x" in fixture_format_label
             ):
                 expected_passed -= 1
                 assert f":test_all_forks[fork_{fork}-{fixture_format_label}]" not in stdout
@@ -178,7 +178,7 @@ def test_all_forks({StateTest.pytest_parameter_name()}):
                 fixture_format = fixture_format.format
             else:
                 fixture_format_label = fixture_format.format_name.lower()
-            if "blockchain_test_engine_reorg" in fixture_format_label:
+            if "blockchain_test_engine_x" in fixture_format_label:
                 expected_passed -= 1
                 assert f":test_all_forks[fork_{fork}-{fixture_format_label}]" not in stdout
                 continue

Original file line number	Diff line number	Diff line change
`@@ -452,7 +452,7 @@ def display_stats(stats: Dict, console: Console, verbose: int = 0):`
`452`	`452`	`@click.argument(`
`453`	`453`	`"pre_alloc_folder",`
`454`	`454`	`type=click.Path(exists=True, path_type=Path),`
`455`		`- default="fixtures/blockchain_tests_engine_reorg/pre_alloc",`
	`455`	`+ default="fixtures/blockchain_tests_engine_x/pre_alloc",`
`456`	`456`	`)`
`457`	`457`	`@click.option(`
`458`	`458`	`"--verbose",`