feat(consume): add consume enginex simulator

docs/CHANGELOG.md

@@ -41,6 +41,8 @@ Users can select any of the artifacts depending on their testing needs for their
 
 #### `consume`
 
+- 🔀 Refactor consume simulator architecture to use explicit pytest plugin structure with forward-looking architecture ([#1801](https://github.com/ethereum/execution-spec-tests/pull/1801)).
+
 #### `execute`
 
 - ✨ Add `blob_transaction_test` execute test spec, which allows tests that send blob transactions to a running client and verifying its `engine_getBlobsVX` endpoint behavior ([#1644](https://github.com/ethereum/execution-spec-tests/pull/1644)).

pyproject.toml

@@ -20,7 +20,7 @@ classifiers = [
 dependencies = [
     "click>=8.1.0,<9",
     "ethereum-execution==1.17.0rc6.dev1",
-    "hive.py @ git+https://github.com/marioevz/hive.py",
+    "hive-py",
     "ethereum-spec-evm-resolver",
     "gitpython>=3.1.31,<4",
     "PyJWT>=2.3.0,<3",
@@ -147,4 +147,5 @@ check-filenames = true
 ignore-words-list = "ingenuous"
 
 [tool.uv.sources]
-ethereum-spec-evm-resolver = { git = "https://github.com/spencer-tb/ethereum-spec-evm-resolver", rev = "ee273e7344e24a739ebfbf0ea1f758530c4d032b" }
+ethereum-spec-evm-resolver = { git = "https://github.com/spencer-tb/ethereum-spec-evm-resolver", rev = "ee273e7344e24a739ebfbf0ea1f758530c4d032b" }
+hive-py = { git = "https://github.com/marioevz/hive.py", rev = "582703e2f94b4d5e61ae495d90d684852c87a580" }

pytest-framework.ini

@@ -13,7 +13,7 @@ addopts =
     --ignore=src/pytest_plugins/consume/test_cache.py
     --ignore=src/pytest_plugins/consume/direct/
     --ignore=src/pytest_plugins/consume/direct/test_via_direct.py
-    --ignore=src/pytest_plugins/consume/hive_simulators/
-    --ignore=src/pytest_plugins/consume/hive_simulators/engine/test_via_engine.py
-    --ignore=src/pytest_plugins/consume/hive_simulators/rlp/test_via_rlp.py
+    --ignore=src/pytest_plugins/consume/simulators/
+    --ignore=src/pytest_plugins/consume/simulators/engine/test_via_engine.py
+    --ignore=src/pytest_plugins/consume/simulators/rlp/test_via_rlp.py
     --ignore=src/pytest_plugins/execute/test_recover.py

src/cli/extract_config.py

@@ -23,7 +23,7 @@
 from ethereum_test_fixtures.file import Fixtures
 from ethereum_test_fixtures.pre_alloc_groups import PreAllocGroup
 from ethereum_test_forks import Fork
-from pytest_plugins.consume.hive_simulators.ruleset import ruleset
+from pytest_plugins.consume.simulators.helpers.ruleset import ruleset
 
 
 def get_docker_containers() -> set[str]:

src/cli/pytest_commands/consume.py

@@ -13,14 +13,14 @@
 class ConsumeCommand(PytestCommand):
     """Pytest command for consume operations."""
 
-    def __init__(self, command_paths: List[Path], is_hive: bool = False):
+    def __init__(self, command_paths: List[Path], is_hive: bool = False, command_name: str = ""):
         """Initialize consume command with paths and processors."""
         processors: List[ArgumentProcessor] = [HelpFlagsProcessor("consume")]
 
         if is_hive:
             processors.extend(
                 [
-                    HiveEnvironmentProcessor(),
+                    HiveEnvironmentProcessor(command_name=command_name),
                     ConsumeCommandProcessor(is_hive=True),
                 ]
             )
@@ -54,13 +54,17 @@ def get_command_paths(command_name: str, is_hive: bool) -> List[Path]:
     base_path = Path("src/pytest_plugins/consume")
     if command_name == "hive":
         commands = ["rlp", "engine"]
+        command_paths = [
+            base_path / "simulators" / "hive_tests" / f"test_via_{cmd}.py" for cmd in commands
+        ]
+    elif command_name in ["engine", "enginex"]:
+        command_paths = [base_path / "simulators" / "hive_tests" / "test_via_engine.py"]
+    elif command_name == "rlp":
+        command_paths = [base_path / "simulators" / "hive_tests" / "test_via_rlp.py"]
+    elif command_name == "direct":
+        command_paths = [base_path / "direct" / "test_via_direct.py"]
     else:
-        commands = [command_name]
-
-    command_paths = [
-        base_path / ("hive_simulators" if is_hive else "") / cmd / f"test_via_{cmd}.py"
-        for cmd in commands
-    ]
+        raise ValueError(f"Unexpected command: {command_name}.")
     return command_paths
 
 
@@ -86,7 +90,7 @@ def decorator(func: Callable[..., Any]) -> click.Command:
         @common_pytest_options
         @functools.wraps(func)
         def command(pytest_args: List[str], **kwargs) -> None:
-            consume_cmd = ConsumeCommand(command_paths, is_hive)
+            consume_cmd = ConsumeCommand(command_paths, is_hive, command_name)
             consume_cmd.execute(list(pytest_args))
 
         return command
@@ -108,13 +112,45 @@ def rlp() -> None:
 
 @consume_command(is_hive=True)
 def engine() -> None:
-    """Client consumes via the Engine API."""
+    """Client consumes Engine Fixtures via the Engine API."""
     pass
 
 
+@consume.command(
+    name="enginex",
+    help="Client consumes Engine X Fixtures via the Engine API.",
+    context_settings={"ignore_unknown_options": True},
+)
+@click.option(
+    "--enginex-fcu-frequency",
+    type=int,
+    default=1,
+    help=(
+        "Control forkchoice update frequency for enginex simulator. "
+        "0=disable FCUs, 1=FCU every test (default), N=FCU every Nth test per "
+        "pre-allocation group."
+    ),
+)
+@common_pytest_options
+def enginex(enginex_fcu_frequency: int, pytest_args: List[str], **_kwargs) -> None:
+    """Client consumes Engine X Fixtures via the Engine API."""
+    command_name = "enginex"
+    command_paths = get_command_paths(command_name, is_hive=True)
+
+    # Validate the frequency parameter
+    if enginex_fcu_frequency < 0:
+        raise click.BadParameter("FCU frequency must be non-negative")
+
+    # Add the FCU frequency to pytest args as a custom config option
+    pytest_args_with_fcu = [f"--enginex-fcu-frequency={enginex_fcu_frequency}"] + list(pytest_args)
+
+    consume_cmd = ConsumeCommand(command_paths, is_hive=True, command_name=command_name)
+    consume_cmd.execute(pytest_args_with_fcu)
+
+
 @consume_command(is_hive=True)
 def hive() -> None:
-    """Client consumes via all available hive methods (rlp, engine)."""
+    """Client consumes via rlp & engine hive methods."""
     pass
 
 

src/cli/pytest_commands/processors.py

@@ -74,6 +74,16 @@ def _is_writing_to_stdout(self, args: List[str]) -> bool:
 class HiveEnvironmentProcessor(ArgumentProcessor):
     """Processes Hive environment variables for consume commands."""
 
+    def __init__(self, command_name: str):
+        """
+        Initialize the processor with command name to determine plugin.
+
+        Args:
+            command_name: The command name to determine which plugin to load.
+
+        """
+        self.command_name = command_name
+
     def process_args(self, args: List[str]) -> List[str]:
         """Convert hive environment variables into pytest flags."""
         modified_args = args[:]
@@ -92,8 +102,14 @@ def process_args(self, args: List[str]) -> List[str]:
         if os.getenv("HIVE_LOGLEVEL") is not None:
             warnings.warn("HIVE_LOG_LEVEL is not yet supported.", stacklevel=2)
 
-        modified_args.extend(["-p", "pytest_plugins.pytest_hive.pytest_hive"])
-
+        if self.command_name == "engine":
+            modified_args.extend(["-p", "pytest_plugins.consume.simulators.engine.conftest"])
+        elif self.command_name == "enginex":
+            modified_args.extend(["-p", "pytest_plugins.consume.simulators.enginex.conftest"])
+        elif self.command_name == "rlp":
+            modified_args.extend(["-p", "pytest_plugins.consume.simulators.rlp.conftest"])
+        else:
+            raise ValueError(f"Unknown command name: {self.command_name}")
         return modified_args
 
     def _has_regex_or_sim_limit(self, args: List[str]) -> bool: