refactor: rename state to stateful marker

Author: LouisTsai-Csie

docs/templates/base.md.j2

@@ -11,8 +11,8 @@ Documentation for [`{{ pytest_node_id }}@{{ short_git_ref }}`]({{ source_code_ur
     ```console
 {% if is_benchmark %}
     fill -v {{ pytest_node_id }} -m benchmark
-{% elif is_state %}
-    fill -v {{ pytest_node_id }} -m state
+{% elif is_stateful %}
+    fill -v {{ pytest_node_id }} -m stateful
 {% else %}
     fill -v {{ pytest_node_id }} --fork {{ target_or_valid_fork }}
 {% endif %}

src/pytest_plugins/filler/gen_test_doc/gen_test_doc.py

@@ -424,7 +424,7 @@ def create_function_page_props(self, test_functions: Dict["str", List[Item]]) ->
             )
 
             is_benchmark = items[0].get_closest_marker("benchmark") is not None
-            is_state = items[0].get_closest_marker("state") is not None
+            is_stateful = items[0].get_closest_marker("stateful") is not None
 
             self.function_page_props[function_id] = FunctionPageProps(
                 title=get_test_function_name(items[0]),
@@ -441,7 +441,7 @@ def create_function_page_props(self, test_functions: Dict["str", List[Item]]) ->
                 html_static_page_target=f"./{get_test_function_name(items[0])}.html",
                 mkdocs_function_page_target=f"./{get_test_function_name(items[0])}/",
                 is_benchmark=is_benchmark,
-                is_state=is_state,
+                is_stateful=is_stateful,
             )
 
     def create_module_page_props(self) -> None:
@@ -457,7 +457,7 @@ def create_module_page_props(self) -> None:
                     pytest_node_id=str(module_path),
                     package_name=get_import_path(module_path),
                     is_benchmark=function_page.is_benchmark,
-                    is_state=function_page.is_state,
+                    is_stateful=function_page.is_stateful,
                     test_functions=[
                         TestFunction(
                             name=function_page.title,
@@ -471,8 +471,8 @@ def create_module_page_props(self) -> None:
                 existing_module_page = self.module_page_props[str(function_page.path)]
                 if function_page.is_benchmark:
                     existing_module_page.is_benchmark = True
-                if function_page.is_state:
-                    existing_module_page.is_state = True
+                if function_page.is_stateful:
+                    existing_module_page.is_stateful = True
                 existing_module_page.test_functions.append(
                     TestFunction(
                         name=function_page.title,
@@ -510,8 +510,8 @@ def add_directory_page_props(self) -> None:
                 for module_page in self.module_page_props.values()
                 if directory in module_page.path.parents or module_page.path.parent == directory
             )
-            is_state = any(
-                module_page.is_state
+            is_stateful = any(
+                module_page.is_stateful
                 for module_page in self.module_page_props.values()
                 if directory in module_page.path.parents or module_page.path.parent == directory
             )
@@ -526,7 +526,7 @@ def add_directory_page_props(self) -> None:
                 target_or_valid_fork=fork.capitalize() if fork else "Unknown",
                 package_name=get_import_path(directory),  # init.py will be used for docstrings
                 is_benchmark=is_benchmark,
-                is_state=is_state,
+                is_stateful=is_stateful,
             )
 
     def find_files_within_collection_scope(self, file_pattern: str) -> List[Path]:

src/pytest_plugins/filler/gen_test_doc/page_props.py

@@ -105,7 +105,7 @@ class PagePropsBase:
     pytest_node_id: str
     package_name: str
     is_benchmark: bool = False
-    is_state: bool = False
+    is_stateful: bool = False
 
     @property
     @abstractmethod

src/pytest_plugins/shared/execute_fill.py

@@ -98,7 +98,7 @@ def pytest_configure(config: pytest.Config):
     )
     config.addinivalue_line(
         "markers",
-        "state: Tests for stateful benchmarking scenarios.",
+        "stateful: Tests for stateful benchmarking scenarios.",
     )
     config.addinivalue_line(
         "markers",

tests/benchmark/conftest.py

@@ -36,7 +36,7 @@ def pytest_collection_modifyitems(config, items):
             if (
                 benchmark_dir in Path(item.fspath).parents
                 and not item.get_closest_marker("benchmark")
-                and not item.get_closest_marker("state")
+                and not item.get_closest_marker("stateful")
             ):
                 item.add_marker(benchmark_marker)
         return
@@ -45,14 +45,16 @@ def pytest_collection_modifyitems(config, items):
     run_benchmarks = (
         marker_expr and "benchmark" in marker_expr and "not benchmark" not in marker_expr
     )
-    run_state_tests = marker_expr and "state" in marker_expr and "not state" not in marker_expr
+    run_stateful_tests = (
+        marker_expr and "stateful" in marker_expr and "not stateful" not in marker_expr
+    )
 
     items_for_removal = []
     for i, item in enumerate(items):
         is_in_benchmark_dir = benchmark_dir in Path(item.fspath).parents
-        has_state_marker = item.get_closest_marker("state")
+        has_stateful_marker = item.get_closest_marker("stateful")
         is_benchmark_test = (
-            is_in_benchmark_dir and not has_state_marker
+            is_in_benchmark_dir and not has_stateful_marker
         ) or item.get_closest_marker("benchmark")
 
         if is_benchmark_test:
@@ -62,7 +64,7 @@ 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:
+        elif is_in_benchmark_dir and has_stateful_marker and not run_stateful_tests:
             items_for_removal.append(i)
 
     for i in reversed(items_for_removal):

tests/benchmark/stateful/__init__.py

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

tests/benchmark/stateful/bloatnet/__init__.py

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

tests/benchmark/stateful/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/stateful/conftest.py

@@ -0,0 +1,63 @@
+"""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 stateful test markers and filtering."""
+    state_dir = Path(__file__).parent
+    gen_docs = config.getoption("--gen-docs", default=False)
+
+    if gen_docs:
+        _add_stateful_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 stateful marker to tests in state directory that don't have it
+        if is_in_state_dir and not item.get_closest_marker("stateful"):
+            item.add_marker(pytest.mark.stateful)
+
+        has_stateful_marker = item.get_closest_marker("stateful")
+
+        run_stateful = (
+            marker_expr and ("stateful" in marker_expr) and ("not stateful" not in marker_expr)
+        )
+
+        # When not running stateful tests, remove all stateful tests
+        if not run_stateful and has_stateful_marker:
+            items_to_remove.append(i)
+
+    for i in reversed(items_to_remove):
+        items.pop(i)
+
+
+def _add_stateful_markers_for_docs(items, state_dir):
+    """Add stateful 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("stateful"):
+            item.add_marker(pytest.mark.stateful)