refactor(consume): split base functionality out to the base plugin

These are fixtures that can also be shared by multi-client architecture simulators.

Author: danceratopz

src/pytest_plugins/consume/simulators/base.py

@@ -0,0 +1,86 @@
+"""Common pytest fixtures for the Hive simulators."""
+
+from pathlib import Path
+from typing import Dict, Literal
+
+import pytest
+from hive.client import Client
+
+from ethereum_test_fixtures import (
+    BaseFixture,
+)
+from ethereum_test_fixtures.consume import TestCaseIndexFile, TestCaseStream
+from ethereum_test_fixtures.file import Fixtures
+from ethereum_test_rpc import EthRPC
+from pytest_plugins.consume.consume import FixturesSource
+
+
+@pytest.fixture(scope="function")
+def eth_rpc(client: Client) -> EthRPC:
+    """Initialize ethereum RPC client for the execution client under test."""
+    return EthRPC(f"http://{client.ip}:8545")
+
+
+@pytest.fixture(scope="function")
+def check_live_port(test_suite_name: str) -> Literal[8545, 8551]:
+    """Port used by hive to check for liveness of the client."""
+    if test_suite_name == "eest/consume-rlp":
+        return 8545
+    elif test_suite_name == "eest/consume-engine":
+        return 8551
+    raise ValueError(
+        f"Unexpected test suite name '{test_suite_name}' while setting HIVE_CHECK_LIVE_PORT."
+    )
+
+
+class FixturesDict(Dict[Path, Fixtures]):
+    """
+    A dictionary caches loaded fixture files to avoid reloading the same file
+    multiple times.
+    """
+
+    def __init__(self) -> None:
+        """Initialize the dictionary that caches loaded fixture files."""
+        self._fixtures: Dict[Path, Fixtures] = {}
+
+    def __getitem__(self, key: Path) -> Fixtures:
+        """Return the fixtures from the index file, if not found, load from disk."""
+        assert key.is_file(), f"Expected a file path, got '{key}'"
+        if key not in self._fixtures:
+            self._fixtures[key] = Fixtures.model_validate_json(key.read_text())
+        return self._fixtures[key]
+
+
+@pytest.fixture(scope="session")
+def fixture_file_loader() -> Dict[Path, Fixtures]:
+    """Return a singleton dictionary that caches loaded fixture files used in all tests."""
+    return FixturesDict()
+
+
+@pytest.fixture(scope="function")
+def fixture(
+    fixtures_source: FixturesSource,
+    fixture_file_loader: Dict[Path, Fixtures],
+    test_case: TestCaseIndexFile | TestCaseStream,
+) -> BaseFixture:
+    """
+    Load the fixture from a file or from stream in any of the supported
+    fixture formats.
+
+    The fixture is either already available within the test case (if consume
+    is taking input on stdin) or loaded from the fixture json file if taking
+    input from disk (fixture directory with index file).
+    """
+    fixture: BaseFixture
+    if fixtures_source.is_stdin:
+        assert isinstance(test_case, TestCaseStream), "Expected a stream test case"
+        fixture = test_case.fixture
+    else:
+        assert isinstance(test_case, TestCaseIndexFile), "Expected an index file test case"
+        fixtures_file_path = fixtures_source.path / test_case.json_path
+        fixtures: Fixtures = fixture_file_loader[fixtures_file_path]
+        fixture = fixtures[test_case.id]
+    assert isinstance(fixture, test_case.format), (
+        f"Expected a {test_case.format.format_name} test fixture"
+    )
+    return fixture

src/pytest_plugins/consume/simulators/engine/conftest.py

@@ -15,6 +15,7 @@
 from ethereum_test_rpc import EngineRPC
 
 pytest_plugins = (
+    "pytest_plugins.consume.simulators.base",
     "pytest_plugins.consume.simulators.single_test_client",
     "pytest_plugins.consume.simulators.test_case_description",
     "pytest_plugins.consume.simulators.timing_data",

src/pytest_plugins/consume/simulators/rlp/conftest.py

@@ -12,6 +12,7 @@
 TestCase = TestCaseIndexFile | TestCaseStream
 
 pytest_plugins = (
+    "pytest_plugins.consume.simulators.base",
     "pytest_plugins.consume.simulators.single_test_client",
     "pytest_plugins.consume.simulators.test_case_description",
     "pytest_plugins.consume.simulators.timing_data",

src/pytest_plugins/consume/simulators/single_test_client.py

@@ -1,24 +1,18 @@
-"""Common pytest fixtures for the RLP and Engine simulators."""
+"""Common pytest fixtures for simulators with single-test client architecture."""
 
 import io
 import json
 import logging
-from pathlib import Path
-from typing import Dict, Generator, Literal, cast
+from typing import Generator, Literal, cast
 
 import pytest
 from hive.client import Client, ClientType
 from hive.testing import HiveTest
 
 from ethereum_test_base_types import Number, to_json
 from ethereum_test_fixtures import (
-    BaseFixture,
     BlockchainFixtureCommon,
 )
-from ethereum_test_fixtures.consume import TestCaseIndexFile, TestCaseStream
-from ethereum_test_fixtures.file import Fixtures
-from ethereum_test_rpc import EthRPC
-from pytest_plugins.consume.consume import FixturesSource
 from pytest_plugins.consume.simulators.helpers.ruleset import (
     ruleset,  # TODO: generate dynamically
 )
@@ -28,12 +22,6 @@
 logger = logging.getLogger(__name__)
 
 
-@pytest.fixture(scope="function")
-def eth_rpc(client: Client) -> EthRPC:
-    """Initialize ethereum RPC client for the execution client under test."""
-    return EthRPC(f"http://{client.ip}:8545")
-
-
 @pytest.fixture(scope="function")
 def client_genesis(fixture: BlockchainFixtureCommon) -> dict:
     """Convert the fixture genesis block header and pre-state to a client genesis state."""
@@ -44,18 +32,6 @@ def client_genesis(fixture: BlockchainFixtureCommon) -> dict:
     return genesis
 
 
-@pytest.fixture(scope="function")
-def check_live_port(test_suite_name: str) -> Literal[8545, 8551]:
-    """Port used by hive to check for liveness of the client."""
-    if test_suite_name == "eest/consume-rlp":
-        return 8545
-    elif test_suite_name == "eest/consume-engine":
-        return 8551
-    raise ValueError(
-        f"Unexpected test suite name '{test_suite_name}' while setting HIVE_CHECK_LIVE_PORT."
-    )
-
-
 @pytest.fixture(scope="function")
 def environment(
     fixture: BlockchainFixtureCommon,
@@ -105,56 +81,3 @@ def client(
     with total_timing_data.time("Stop client"):
         client.stop()
     logger.info(f"Client ({client_type.name}) stopped!")
-
-
-class FixturesDict(Dict[Path, Fixtures]):
-    """
-    A dictionary caches loaded fixture files to avoid reloading the same file
-    multiple times.
-    """
-
-    def __init__(self) -> None:
-        """Initialize the dictionary that caches loaded fixture files."""
-        self._fixtures: Dict[Path, Fixtures] = {}
-
-    def __getitem__(self, key: Path) -> Fixtures:
-        """Return the fixtures from the index file, if not found, load from disk."""
-        assert key.is_file(), f"Expected a file path, got '{key}'"
-        if key not in self._fixtures:
-            self._fixtures[key] = Fixtures.model_validate_json(key.read_text())
-        return self._fixtures[key]
-
-
-@pytest.fixture(scope="session")
-def fixture_file_loader() -> Dict[Path, Fixtures]:
-    """Return a singleton dictionary that caches loaded fixture files used in all tests."""
-    return FixturesDict()
-
-
-@pytest.fixture(scope="function")
-def fixture(
-    fixtures_source: FixturesSource,
-    fixture_file_loader: Dict[Path, Fixtures],
-    test_case: TestCaseIndexFile | TestCaseStream,
-) -> BaseFixture:
-    """
-    Load the fixture from a file or from stream in any of the supported
-    fixture formats.
-
-    The fixture is either already available within the test case (if consume
-    is taking input on stdin) or loaded from the fixture json file if taking
-    input from disk (fixture directory with index file).
-    """
-    fixture: BaseFixture
-    if fixtures_source.is_stdin:
-        assert isinstance(test_case, TestCaseStream), "Expected a stream test case"
-        fixture = test_case.fixture
-    else:
-        assert isinstance(test_case, TestCaseIndexFile), "Expected an index file test case"
-        fixtures_file_path = fixtures_source.path / test_case.json_path
-        fixtures: Fixtures = fixture_file_loader[fixtures_file_path]
-        fixture = fixtures[test_case.id]
-    assert isinstance(fixture, test_case.format), (
-        f"Expected a {test_case.format.format_name} test fixture"
-    )
-    return fixture