Updates to test suite after running for EELS backend

Author: fselmo

Diff for: conftest.py

@@ -3,7 +3,6 @@
 import warnings
 
 from eth_tester import (
-    EELSBackend,
     EthereumTester,
 )
 import pytest_asyncio
@@ -75,17 +74,15 @@ def _wait_for_transaction(w3, txn_hash, timeout=120):
 
 
 @pytest.fixture
-def w3():
-    t = EthereumTester(backend=EELSBackend("cancun"))
-    w3 = Web3(EthereumTesterProvider(t))
+def w3(backend_class):
+    w3 = Web3(EthereumTesterProvider(EthereumTester(backend=backend_class())))
     w3.eth.default_account = w3.eth.accounts[0]
     return w3
 
 
 @pytest.fixture(scope="module")
-def w3_non_strict_abi():
-    t = EthereumTester(backend=EELSBackend("cancun"))
-    w3 = Web3(EthereumTesterProvider(t))
+def w3_non_strict_abi(backend_class):
+    w3 = Web3(EthereumTesterProvider(EthereumTester(backend=backend_class())))
     w3.eth.default_account = w3.eth.accounts[0]
     w3.strict_bytes_type_checking = False
     return w3

Diff for: docs/contributing.rst

@@ -160,11 +160,12 @@ Typically, you'll just want to run a subset instead, like:
     $ pytest tests/core/eth-module/test_accounts.py
 
 
-You can use ``tox`` to run all the tests for a given version of Python:
+You can use ``tox`` to run all the core tests for a given version of Python. You must
+an available backend for eth-tester to use (currently {'pyevm', 'eels'}).
 
 .. code:: sh
 
-   $ tox -e py38-core
+   $ tox -e py38-core --backend=pyevm
 
 
 Linting is also performed by the CI. You can save yourself some time by checking for

Diff for: setup.py

@@ -4,6 +4,8 @@
     setup,
 )
 
+CUSTOM_ETH_TESTER_BRANCH = " @ git+https://github.com/fselmo/eth-tester@eels-backend"
+
 extras_require = {
     "dev": [
         "build>=0.9.0",
@@ -30,8 +32,9 @@
     "test": [
         # Note: ethereum-maintained libraries in this list should be added to the
         # `install_pre_releases.py` script.
-        "eth-tester[py-evm]>=0.11.0b1,<0.13.0b1",
-        "py-geth>=5.0.0",
+        f"eth-tester[py-evm]{CUSTOM_ETH_TESTER_BRANCH}",
+        # if python version >= 3.10, install the eels backend:
+        f"eth-tester[eels]{CUSTOM_ETH_TESTER_BRANCH} ; python_version >= '3.10'",
         "pytest-asyncio>=0.18.1,<0.23",
         "pytest-mock>=1.10",
         "pytest-xdist>=2.4.0",

Diff for: tests/conftest.py

@@ -3,6 +3,9 @@
     Type,
 )
 
+from eth_tester import (
+    PyEVMBackend,
+)
 from eth_utils import (
     event_signature_to_log_topic,
     to_bytes,
@@ -23,20 +26,63 @@
     get_open_port,
 )
 
+SUPPORTED_ETH_TESTER_BACKENDS = {"pyevm", "eels"}
+
 
 @pytest.fixture(scope="module", params=[lambda x: to_bytes(hexstr=x), identity])
 def address_conversion_func(request):
     return request.param
 
 
-@pytest.fixture()
+@pytest.fixture
 def open_port():
     return get_open_port()
 
 
 # --- session-scoped constants --- #
 
 
+def pytest_addoption(parser):
+    parser.addoption(
+        "--backend",
+        action="store",
+        default=None,
+        help="Specify the backend for `EthereumTester` to use.",
+    )
+
+
+def pytest_collection_modifyitems(config, items):
+    backend_required_for_tests = any(
+        "backend_class" in item.fixturenames for item in items
+    )
+    if backend_required_for_tests:
+        backend = config.getoption("--backend")
+        if not backend:
+            raise pytest.UsageError(
+                "This test run requires a specified a backend via the `--backend` "
+                "command line option. Supported backends are: "
+                f"{SUPPORTED_ETH_TESTER_BACKENDS}"
+            )
+        elif backend not in SUPPORTED_ETH_TESTER_BACKENDS:
+            raise pytest.UsageError(f"Unsupported backend: `{backend}`.")
+
+
+@pytest.fixture(scope="session")
+def backend_class(request):
+    backend = request.config.getoption("--backend")
+    if backend == "pyevm":
+        return PyEVMBackend
+    elif backend == "eels":
+        # conditionally import since eels is only supported on python >= 3.10
+        from eth_tester.backends.eels import (
+            EELSBackend,
+        )
+
+        return EELSBackend
+    else:
+        raise ValueError("Invariant: Unreachable code path.")
+
+
 @pytest.fixture(scope="session")
 def emitter_contract_data():
     return EMITTER_CONTRACT_DATA

Diff for: tests/core/conftest.py

@@ -1,7 +1,6 @@
 import pytest
 
 from eth_tester import (
-    EELSBackend,
     EthereumTester,
 )
 import pytest_asyncio
@@ -121,19 +120,16 @@ def __init__(self, a, b):
 
 
 @pytest_asyncio.fixture
-async def async_w3():
-    t = EthereumTester(backend=EELSBackend("cancun"))
-    provider = AsyncEthereumTesterProvider()
-    provider.ethereum_tester = t
-    w3 = AsyncWeb3(provider)
+async def async_w3(backend_class):
+    w3 = AsyncWeb3(AsyncEthereumTesterProvider(EthereumTester(backend=backend_class())))
     accounts = await w3.eth.accounts
     w3.eth.default_account = accounts[0]
     return w3
 
 
 @pytest_asyncio.fixture
-async def async_w3_non_strict_abi():
-    w3 = AsyncWeb3(AsyncEthereumTesterProvider())
+async def async_w3_non_strict_abi(backend_class):
+    w3 = AsyncWeb3(AsyncEthereumTesterProvider(EthereumTester(backend=backend_class())))
     w3.strict_bytes_type_checking = False
     accounts = await w3.eth.accounts
     w3.eth.default_account = accounts[0]

Diff for: tests/core/contracts/test_contract_attributes.py

@@ -6,7 +6,7 @@
 )
 
 
-@pytest.fixture()
+@pytest.fixture
 def abi():
     return """[{"anonymous":false,"inputs":[{"indexed":false,"name":"value","type":"uint256"}],"name":"Increased","type":"function"}, {"anonymous":false,"inputs":[{"indexed":false,"name":"value","type":"uint256"}],"name":"Increased","type":"event"}]"""  # noqa: E501
 

Diff for: tests/core/contracts/test_contract_caller_interface.py

@@ -8,12 +8,12 @@
 )
 
 
-@pytest.fixture()
+@pytest.fixture
 def address(w3):
     return w3.eth.accounts[1]
 
 
-@pytest.fixture()
+@pytest.fixture
 def transaction_dict(w3, address):
     return {
         "from": address,

Diff for: tests/core/contracts/test_contract_example.py

@@ -2,6 +2,9 @@
 # of how to write unit tests with web3.py
 import pytest
 
+from eth_tester import (
+    EthereumTester,
+)
 import pytest_asyncio
 
 from web3 import (
@@ -15,8 +18,8 @@
 
 
 @pytest.fixture
-def tester_provider():
-    return EthereumTesterProvider()
+def tester_provider(backend_class):
+    return EthereumTesterProvider(EthereumTester(backend=backend_class()))
 
 
 @pytest.fixture
@@ -118,8 +121,10 @@ def async_eth_tester():
 
 
 @pytest_asyncio.fixture()
-async def async_w3():
-    async_w3 = AsyncWeb3(AsyncEthereumTesterProvider())
+async def async_w3(backend_class):
+    async_w3 = AsyncWeb3(
+        AsyncEthereumTesterProvider(EthereumTester(backend=backend_class()))
+    )
     accounts = await async_w3.eth.accounts
     async_w3.eth.default_account = accounts[0]
     return async_w3

Diff for: tests/core/contracts/test_contract_init.py

@@ -10,7 +10,7 @@
 )
 
 
-@pytest.fixture()
+@pytest.fixture
 def math_addr(math_contract_factory, address_conversion_func):
     w3 = math_contract_factory.w3
     deploy_txn = math_contract_factory.constructor().transact(

Diff for: tests/core/contracts/test_extracting_event_data.py

@@ -28,7 +28,7 @@
 )
 
 
-@pytest.fixture()
+@pytest.fixture
 def dup_txn_receipt(w3, indexed_event_contract, wait_for_transaction, event_contract):
     emitter_fn = indexed_event_contract.functions.logTwoEvents
 

Diff for: tests/core/contracts/test_extracting_event_data_old.py

@@ -9,7 +9,7 @@
 )
 
 
-@pytest.fixture()
+@pytest.fixture
 def emitter(
     w3,
     emitter_contract_data,

Diff for: tests/core/eth-module/test_accounts.py

@@ -9,6 +9,9 @@
 from eth_account.signers.local import (
     LocalAccount,
 )
+from eth_tester import (
+    EthereumTester,
+)
 from eth_utils import (
     is_bytes,
     is_checksum_address,
@@ -98,9 +101,9 @@ def acct(request, w3):
     raise Exception("Unreachable!")
 
 
-@pytest.fixture()
-def w3():
-    return Web3(EthereumTesterProvider())
+@pytest.fixture
+def w3(backend_class):
+    return Web3(EthereumTesterProvider(EthereumTester(backend=backend_class())))
 
 
 def test_eth_default_account_is_empty_by_default(w3):
@@ -560,9 +563,11 @@ def test_eth_account_sign_and_send_EIP155_transaction_to_eth_tester(
 # -- async -- #
 
 
-@pytest.fixture()
-def async_w3():
-    return AsyncWeb3(AsyncEthereumTesterProvider())
+@pytest.fixture
+def async_w3(backend_class):
+    return AsyncWeb3(
+        AsyncEthereumTesterProvider(EthereumTester(backend=backend_class()))
+    )
 
 
 @patch("web3.eth.BaseEth.account", "wired via BaseEth")

Diff for: tests/core/eth-module/test_eth_filter.py

@@ -1,5 +1,8 @@
 import pytest
 
+from eth_tester import (
+    EthereumTester,
+)
 import pytest_asyncio
 
 from web3 import (
@@ -30,11 +33,11 @@ def test_eth_filter_creates_correct_filter_type(w3):
 # --- async --- #
 
 
-@pytest_asyncio.fixture()
-async def async_w3():
-    provider = AsyncEthereumTesterProvider()
-    w3 = AsyncWeb3(provider)
-    return w3
+@pytest_asyncio.fixture
+async def async_w3(backend_class):
+    return AsyncWeb3(
+        AsyncEthereumTesterProvider(EthereumTester(backend=backend_class()))
+    )
 
 
 @pytest.mark.asyncio

Diff for: tests/core/eth-module/test_eth_properties.py

@@ -1,5 +1,9 @@
 import pytest
 
+from eth_tester import (
+    EthereumTester,
+)
+
 from web3 import (
     AsyncWeb3,
 )
@@ -9,16 +13,19 @@
 
 
 @pytest.fixture
-def async_w3():
+def async_w3(backend_class):
     return AsyncWeb3(
-        AsyncEthereumTesterProvider(),
+        AsyncEthereumTesterProvider(EthereumTester(backend=backend_class())),
     )
 
 
 def test_eth_chain_id(w3):
-    assert w3.eth.chain_id == w3.provider.eth_tester.chain_id
+    assert w3.eth.chain_id == w3.provider.ethereum_tester.backend.chain.chain_id
 
 
 @pytest.mark.asyncio
 async def test_async_eth_chain_id(async_w3):
-    assert await async_w3.eth.chain_id == async_w3.provider.eth_tester.chain_id
+    assert (
+        await async_w3.eth.chain_id
+        == async_w3.provider.ethereum_tester.backend.chain.chain_id
+    )

Diff for: tests/core/filtering/conftest.py

@@ -22,8 +22,8 @@
     params=[True, False],
     ids=["LocalFilterMiddleware", "node_based_filter"],
 )
-def w3(request):
-    return _w3_fixture_logic(request)
+def w3(request, backend_class):
+    return _w3_fixture_logic(request, backend_class)
 
 
 @pytest.fixture
@@ -69,8 +69,8 @@ def create_filter(request):
     params=[True, False],
     ids=["LocalFilterMiddleware", "node_based_filter"],
 )
-async def async_w3(request):
-    return await _async_w3_fixture_logic(request)
+async def async_w3(request, backend_class):
+    return await _async_w3_fixture_logic(request, backend_class)
 
 
 @pytest.fixture

Diff for: tests/core/filtering/test_contract_data_filters.py

@@ -81,8 +81,8 @@ def array_values(draw):
     params=[True, False],
     ids=["LocalFilterMiddleware", "node_based_filter"],
 )
-def w3(request):
-    return _w3_fixture_logic(request)
+def w3(request, backend_class):
+    return _w3_fixture_logic(request, backend_class)
 
 
 @pytest.fixture(scope="module")
@@ -284,8 +284,8 @@ def event_loop():
     params=[True, False],
     ids=["LocalFilterMiddleware", "node_based_filter"],
 )
-async def async_w3(request):
-    return await _async_w3_fixture_logic(request)
+async def async_w3(request, backend_class):
+    return await _async_w3_fixture_logic(request, backend_class)
 
 
 @pytest.fixture(scope="module")