feat: add state marker

Author: LouisTsai-Csie

src/pytest_plugins/shared/execute_fill.py

@@ -96,6 +96,10 @@ def pytest_configure(config: pytest.Config):
         "markers",
         "benchmark: Tests relevant to benchmarking EVMs.",
     )
+    config.addinivalue_line(
+        "markers",
+        "state: Tests for stateful benchmarking scenarios.",
+    )
     config.addinivalue_line(
         "markers",
         "exception_test: Negative tests that include an invalid block or transaction.",

tests/benchmark/conftest.py

@@ -33,21 +33,27 @@ def pytest_collection_modifyitems(config, items):
 
     if gen_docs:
         for item in items:
-            if benchmark_dir in Path(item.fspath).parents and not item.get_closest_marker(
-                "benchmark"
+            if (
+                benchmark_dir in Path(item.fspath).parents
+                and not item.get_closest_marker("benchmark")
+                and not item.get_closest_marker("state")
             ):
                 item.add_marker(benchmark_marker)
         return
 
     marker_expr = config.getoption("-m", default="")
     run_benchmarks = (
         marker_expr and "benchmark" in marker_expr and "not benchmark" not in marker_expr
-    ) or config.getoption("--gas-benchmark-values", default=None)
+    )
+    run_state_tests = marker_expr and "state" in marker_expr and "not state" not in marker_expr
 
     items_for_removal = []
     for i, item in enumerate(items):
         is_in_benchmark_dir = benchmark_dir in Path(item.fspath).parents
-        is_benchmark_test = is_in_benchmark_dir or item.get_closest_marker("benchmark")
+        has_state_marker = item.get_closest_marker("state")
+        is_benchmark_test = (
+            is_in_benchmark_dir and not has_state_marker
+        ) or item.get_closest_marker("benchmark")
 
         if is_benchmark_test:
             if is_in_benchmark_dir and not item.get_closest_marker("benchmark"):
@@ -56,6 +62,8 @@ def pytest_collection_modifyitems(config, items):
                 items_for_removal.append(i)
         elif run_benchmarks:
             items_for_removal.append(i)
+        elif is_in_benchmark_dir and has_state_marker and not run_state_tests:
+            items_for_removal.append(i)
 
     for i in reversed(items_for_removal):
         items.pop(i)

tests/benchmark/state/__init__.py

@@ -0,0 +1 @@
+"""Benchmark state tests package."""

tests/benchmark/state/bloatnet/__init__.py

@@ -0,0 +1 @@
+"""Bloatnet benchmark tests package."""

tests/benchmark/state/bloatnet/test_bloatnet.py

@@ -0,0 +1,6 @@
+"""
+abstract: Tests benchmark worst-case bloatnet scenarios.
+    Tests benchmark worst-case bloatnet scenarios.
+
+Tests running worst-case bloatnet scenarios for benchmarking purposes.
+"""

tests/benchmark/state/conftest.py

@@ -0,0 +1,61 @@
+"""Pytest configuration for state tests."""
+
+from pathlib import Path
+
+import pytest
+
+DEFAULT_BENCHMARK_FORK = "Prague"
+
+
+def pytest_generate_tests(metafunc):
+    """Add default valid_from marker to state tests without explicit fork specification."""
+    state_dir = Path(__file__).parent
+    test_file_path = Path(metafunc.definition.fspath)
+
+    if state_dir in test_file_path.parents:
+        has_valid_from = any(
+            marker.name == "valid_from" for marker in metafunc.definition.iter_markers()
+        )
+        if not has_valid_from:
+            metafunc.definition.add_marker(pytest.mark.valid_from(DEFAULT_BENCHMARK_FORK))
+
+
+def pytest_collection_modifyitems(config, items):
+    """Manage state test markers and filtering."""
+    state_dir = Path(__file__).parent
+    gen_docs = config.getoption("--gen-docs", default=False)
+
+    if gen_docs:
+        _add_state_markers_for_docs(items, state_dir)
+        return
+
+    marker_expr = config.getoption("-m", default="")
+
+    items_to_remove = []
+
+    for i, item in enumerate(items):
+        item_path = Path(item.fspath)
+        is_in_state_dir = state_dir in item_path.parents
+
+        # Add state marker to tests in state directory that don't have it
+        if is_in_state_dir and not item.get_closest_marker("state"):
+            item.add_marker(pytest.mark.state)
+
+        has_state_marker = item.get_closest_marker("state")
+
+        run_state = marker_expr and ("state" in marker_expr) and ("not state" not in marker_expr)
+
+        # When not running state tests, remove all state tests
+        if not run_state and has_state_marker:
+            items_to_remove.append(i)
+
+    for i in reversed(items_to_remove):
+        items.pop(i)
+
+
+def _add_state_markers_for_docs(items, state_dir):
+    """Add state markers for documentation generation."""
+    for item in items:
+        item_path = Path(item.fspath)
+        if state_dir in item_path.parents and not item.get_closest_marker("state"):
+            item.add_marker(pytest.mark.state)