fix(plugins): remove cwd change before running pytest (#1943)

Author: marioevz

src/cli/pytest_commands/base.py

@@ -1,9 +1,7 @@
 """Base classes and utilities for pytest-based CLI commands."""
 
-import os
 import sys
 from abc import ABC, abstractmethod
-from contextlib import contextmanager
 from dataclasses import dataclass, field
 from os.path import realpath
 from pathlib import Path
@@ -14,8 +12,8 @@
 from rich.console import Console
 
 CURRENT_FOLDER = Path(realpath(__file__)).parent
+PACKAGE_INSTALL_FOLDER = CURRENT_FOLDER.parent.parent
 PYTEST_INI_FOLDER = CURRENT_FOLDER / "pytest_ini_files"
-STATIC_TESTS_WORKING_DIRECTORY = CURRENT_FOLDER.parent.parent
 
 
 @dataclass
@@ -25,7 +23,7 @@ class PytestExecution:
     config_file: Path
     """Path to the pytest configuration file (e.g., 'pytest-fill.ini')."""
 
-    test_path_args: List[str] = field(default_factory=list)
+    command_logic_test_paths: List[str] = field(default_factory=list)
     """List of tests that have to be appended to the start of pytest command arguments."""
 
     args: List[str] = field(default_factory=list)
@@ -44,60 +42,35 @@ def process_args(self, args: List[str]) -> List[str]:
         pass
 
 
-@contextmanager
-def chdir(path: Path | None):
-    """Context manager to change the current working directory and restore it unconditionally."""
-    if path is None:
-        yield
-        return
-
-    prev_cwd = Path.cwd()
-    os.chdir(path)
-    try:
-        yield
-    finally:
-        os.chdir(prev_cwd)
-
-
 @dataclass(kw_only=True)
 class PytestRunner:
     """Handles execution of pytest commands."""
 
     console: Console = field(default_factory=lambda: Console(highlight=False))
     """Console to use for output."""
 
-    pytest_working_directory: Path | None = None
-    """
-    Working directory that pytest should use to start and look for tests.
-    If set, the working directory of the process will be changed to this directory
-    before running pytest, and a plugin will be used to change the working directory
-    back to the original directory to run the rest of the pytest plugins
-    (so flags like `--input` in `consume` do work with relative paths).
-    """
-
     def run_single(self, execution: PytestExecution) -> int:
         """Run pytest once with the given configuration and arguments."""
         root_dir_arg = ["--rootdir", "."]
         pytest_args = (
             ["-c", str(execution.config_file)]
             + root_dir_arg
-            + execution.test_path_args
+            + [
+                str(PACKAGE_INSTALL_FOLDER / test_path)
+                for test_path in execution.command_logic_test_paths
+            ]
             + execution.args
         )
-        if self.pytest_working_directory:
+        if execution.command_logic_test_paths:
             pytest_args += [
                 "-p",
-                "pytest_plugins.working_directory",
-                "--working-directory",
-                f"{Path.cwd()}",
+                "pytest_plugins.fix_package_test_path",
             ]
-
         if self._is_verbose(execution.args):
             pytest_cmd = f"pytest {' '.join(pytest_args)}"
             self.console.print(f"Executing: [bold]{pytest_cmd}[/bold]")
 
-        with chdir(self.pytest_working_directory):
-            return pytest.main(pytest_args)
+        return pytest.main(pytest_args)
 
     def _is_verbose(self, args: List[str]) -> bool:
         """Check if verbose output is requested."""
@@ -145,8 +118,8 @@ class PytestCommand:
     plugins: List[str] = field(default_factory=list)
     """Plugins to load for the pytest command."""
 
-    static_test_paths: List[Path] | None = None
-    """Static tests that contain the command logic."""
+    command_logic_test_paths: List[Path] | None = None
+    """Path to test files that contain the command logic."""
 
     pytest_ini_folder: Path = PYTEST_INI_FOLDER
     """Folder where the pytest configuration files are located."""
@@ -159,10 +132,6 @@ def config_path(self) -> Path:
     def execute(self, pytest_args: List[str]) -> None:
         """Execute the command with the given pytest arguments."""
         executions = self.create_executions(pytest_args)
-        if self.static_test_paths:
-            self.runner.pytest_working_directory = STATIC_TESTS_WORKING_DIRECTORY
-        else:
-            self.runner.pytest_working_directory = None
         result = self.runner.run_multiple(executions)
         sys.exit(result)
 
@@ -172,8 +141,8 @@ def test_args(self) -> List[str]:
         Return the test-path arguments that have to be appended to all PytestExecution
         instances.
         """
-        if self.static_test_paths:
-            return [str(path) for path in self.static_test_paths]
+        if self.command_logic_test_paths:
+            return [str(path) for path in self.command_logic_test_paths]
         return []
 
     def create_executions(self, pytest_args: List[str]) -> List[PytestExecution]:
@@ -187,7 +156,7 @@ def create_executions(self, pytest_args: List[str]) -> List[PytestExecution]:
         return [
             PytestExecution(
                 config_file=self.config_path,
-                test_path_args=self.test_args,
+                command_logic_test_paths=self.test_args,
                 args=processed_args,
             )
         ]

src/cli/pytest_commands/consume.py

@@ -12,7 +12,7 @@
 
 def create_consume_command(
     *,
-    static_test_paths: List[Path],
+    command_logic_test_paths: List[Path],
     is_hive: bool = False,
     command_name: str = "",
 ) -> PytestCommand:
@@ -32,27 +32,27 @@ def create_consume_command(
     return PytestCommand(
         config_file="pytest-consume.ini",
         argument_processors=processors,
-        static_test_paths=static_test_paths,
+        command_logic_test_paths=command_logic_test_paths,
     )
 
 
-def get_static_test_paths(command_name: str, is_hive: bool) -> List[Path]:
+def get_command_logic_test_paths(command_name: str, is_hive: bool) -> List[Path]:
     """Determine the command paths based on the command name and hive flag."""
     base_path = Path("pytest_plugins/consume")
     if command_name == "hive":
         commands = ["rlp", "engine"]
-        static_test_paths = [
+        command_logic_test_paths = [
             base_path / "simulators" / "simulator_logic" / f"test_via_{cmd}.py" for cmd in commands
         ]
     elif command_name in ["engine", "rlp"]:
-        static_test_paths = [
+        command_logic_test_paths = [
             base_path / "simulators" / "simulator_logic" / f"test_via_{command_name}.py"
         ]
     elif command_name == "direct":
-        static_test_paths = [base_path / "direct" / "test_via_direct.py"]
+        command_logic_test_paths = [base_path / "direct" / "test_via_direct.py"]
     else:
         raise ValueError(f"Unexpected command: {command_name}.")
-    return static_test_paths
+    return command_logic_test_paths
 
 
 @click.group(context_settings={"help_option_names": ["-h", "--help"]})
@@ -67,7 +67,7 @@ def consume_command(is_hive: bool = False) -> Callable[[Callable[..., Any]], cli
     def decorator(func: Callable[..., Any]) -> click.Command:
         command_name = func.__name__
         command_help = func.__doc__
-        static_test_paths = get_static_test_paths(command_name, is_hive)
+        command_logic_test_paths = get_command_logic_test_paths(command_name, is_hive)
 
         @consume.command(
             name=command_name,
@@ -78,7 +78,9 @@ def decorator(func: Callable[..., Any]) -> click.Command:
         @functools.wraps(func)
         def command(pytest_args: List[str], **kwargs) -> None:
             consume_cmd = create_consume_command(
-                static_test_paths=static_test_paths, is_hive=is_hive, command_name=command_name
+                command_logic_test_paths=command_logic_test_paths,
+                is_hive=is_hive,
+                command_name=command_name,
             )
             consume_cmd.execute(list(pytest_args))
 
@@ -117,5 +119,5 @@ def hive() -> None:
 @common_pytest_options
 def cache(pytest_args: List[str], **kwargs) -> None:
     """Consume command to cache test fixtures."""
-    cache_cmd = create_consume_command(static_test_paths=[], is_hive=False)
+    cache_cmd = create_consume_command(command_logic_test_paths=[], is_hive=False)
     cache_cmd.execute(list(pytest_args))

src/cli/pytest_commands/execute.py

@@ -24,13 +24,13 @@ def _create_execute_subcommand(
     config_file: str,
     help_text: str,
     required_args: List[str] | None = None,
-    static_test_paths: List[Path] | None = None,
+    command_logic_test_paths: List[Path] | None = None,
 ) -> click.Command:
     """Create an execute subcommand with standardized structure."""
     pytest_command = PytestCommand(
         config_file=config_file,
         argument_processors=[HelpFlagsProcessor(f"execute-{command_name}", required_args)],
-        static_test_paths=static_test_paths,
+        command_logic_test_paths=command_logic_test_paths,
     )
 
     @execute.command(
@@ -69,7 +69,7 @@ def command(pytest_args: List[str], **_kwargs) -> None:
     "pytest-execute-eth-config.ini",
     "Test a client's configuration using the `eth_config` RPC endpoint.",
     required_args=["--network=Mainnet", "--rpc-endpoint=http://localhost:8545"],
-    static_test_paths=[Path("pytest_plugins/execute/eth_config/execute_eth_config.py")],
+    command_logic_test_paths=[Path("pytest_plugins/execute/eth_config/execute_eth_config.py")],
 )
 
 recover = _create_execute_subcommand(
@@ -82,5 +82,5 @@ def command(pytest_args: List[str], **_kwargs) -> None:
         "--start-eoa-index=1",
         "--destination=0x0000000000000000000000000000000000000000",
     ],
-    static_test_paths=[Path("pytest_plugins/execute/execute_recover.py")],
+    command_logic_test_paths=[Path("pytest_plugins/execute/execute_recover.py")],
 )

src/pytest_plugins/consume/consume.py

@@ -446,12 +446,3 @@ def pytest_generate_tests(metafunc):
     if "client_type" in metafunc.fixturenames:
         client_ids = [client.name for client in metafunc.config.hive_execution_clients]
         metafunc.parametrize("client_type", metafunc.config.hive_execution_clients, ids=client_ids)
-
-
-def pytest_collection_modifyitems(items):
-    """Modify collected item names to remove the test runner function from the name."""
-    for item in items:
-        original_name = item.originalname
-        remove = f"{original_name}["
-        if item.name.startswith(remove):
-            item.name = item.name.removeprefix(remove)[:-1]

src/pytest_plugins/fix_package_test_path.py

@@ -0,0 +1,19 @@
+"""
+Pytest plugin to fix the test IDs for all pytest command that use a command-logic test
+file.
+"""
+
+from typing import List
+
+import pytest
+
+
+def pytest_collection_modifyitems(items: List[pytest.Item]):
+    """Modify collected item names to remove the test runner function from the name."""
+    for item in items:
+        original_name = item.originalname  # type: ignore
+        remove = f"{original_name}["
+        if item.name.startswith(remove):
+            item.name = item.name.removeprefix(remove)[:-1]
+        if remove in item.nodeid:
+            item._nodeid = item.nodeid[item.nodeid.index(remove) + len(remove) : -1]