feat: let users specify pytest command (#322)

context: codecov/engineering-team#715

Apparently some users don't have a virtualenv or don't install packages globaly.
In this case running `python -m pytest` doesn't work because pytest is not accessible to the
global python.

These changes let users specify a different command to run, so that they can tell
the PytestStandardRunner where to find `pytest`.

In terms of security it's not more dangerous than having a DAN runner, so should be ok.

Author: giovanni-guidini

codecov_cli/runners/pytest_standard_runner.py

@@ -16,6 +16,14 @@
 
 
 class PytestStandardRunnerConfigParams(dict):
+    @property
+    def pytest_command(self) -> List[str]:
+        command_from_config = self.get("pytest_command")
+        if isinstance(command_from_config, str):
+            logger.warning("pytest_command should be a list")
+            command_from_config = command_from_config.split(" ")
+        return command_from_config or ["python", "-m", "pytest"]
+
     @property
     def collect_tests_options(self) -> List[str]:
         return self.get("collect_tests_options", [])
@@ -62,7 +70,7 @@ def _execute_pytest(self, pytest_args: List[str], capture_output: bool = True):
         Raises Exception if pytest fails
         Returns the complete pytest output
         """
-        command = ["python", "-m", "pytest"] + pytest_args
+        command = self.params.pytest_command + pytest_args
         try:
             result = subprocess.run(
                 command,
@@ -92,7 +100,10 @@ def collect_tests(self):
         logger.info(
             "Collecting tests",
             extra=dict(
-                extra_log_attributes=dict(pytest_options=options_to_use),
+                extra_log_attributes=dict(
+                    pytest_command=self.params.pytest_command,
+                    pytest_options=options_to_use,
+                ),
             ),
         )
 

tests/runners/test_pytest_standard_runner.py

@@ -39,6 +39,28 @@ def test_execute_pytest(self, mock_subprocess):
         )
         assert result == output
 
+    @pytest.mark.parametrize(
+        "command_configured", [["pyenv", "pytest"], "pyenv pytest"]
+    )
+    @patch("codecov_cli.runners.pytest_standard_runner.subprocess")
+    def test_execute_pytest_user_provided_command(
+        self, mock_subprocess, command_configured
+    ):
+        output = "Output in stdout"
+        return_value = MagicMock(stdout=output.encode("utf-8"))
+        mock_subprocess.run.return_value = return_value
+
+        runner = PytestStandardRunner(dict(pytest_command=command_configured))
+
+        result = runner._execute_pytest(["--option", "--ignore=batata"])
+        mock_subprocess.run.assert_called_with(
+            ["pyenv", "pytest", "--option", "--ignore=batata"],
+            capture_output=True,
+            check=True,
+            stdout=None,
+        )
+        assert result == output
+
     @patch("codecov_cli.runners.pytest_standard_runner.subprocess")
     def test_execute_pytest_fail_collection(self, mock_subprocess):
         def side_effect(command, *args, **kwargs):