Make PythonStandardRunner include curr dir by default (#133)

Turns out that when you package the CLI in PyInstaller, if you don't have the curr dir in PATH
there's a high probability that pytest will fail because of the pytest plugins (it won't find them)

So it's better to add the current dir by default to avoid issues.

On top of that also adding `params` in the runner interface so we can log the params of the selected runner.

Author: giovanni-guidini

codecov_cli/commands/labelanalysis.py

@@ -56,7 +56,10 @@ def label_analysis(
     codecov_yaml = ctx.obj["codecov_yaml"] or {}
     cli_config = codecov_yaml.get("cli", {})
     runner = get_runner(cli_config, runner_name)
-    logger.debug(f"Selected runner: {runner}")
+    logger.debug(
+        f"Selected runner: {runner}",
+        extra=dict(extra_log_attributes=dict(config=runner.params)),
+    )
     requested_labels = runner.collect_tests()
     logger.info(f"Collected {len(requested_labels)} tests")
     logger.debug(

codecov_cli/runners/python_standard_runner.py

@@ -42,7 +42,7 @@ def __init__(self, config_params: PythonStandardRunnerConfigParams = None) -> No
         super().__init__()
         default_config: PythonStandardRunnerConfigParams = {
             "collect_tests_options": [],
-            "include_curr_dir": False,
+            "include_curr_dir": True,
         }
         if config_params is None:
             config_params = PythonStandardRunnerConfigParams()

codecov_cli/runners/types.py

@@ -9,6 +9,8 @@ class LabelAnalysisRequestResult(TypedDict):
 
 
 class LabelAnalysisRunnerInterface(object):
+    params = None
+
     def collect_tests(self) -> List[str]:
         raise NotImplementedError()
 

tests/runners/test_python_standard_runner.py

@@ -16,18 +16,24 @@ class TestPythonStandardRunner(object):
 
     def test_init_with_params(self):
         assert self.runner.params == PythonStandardRunnerConfigParams(
-            collect_tests_options=[], include_curr_dir=False
+            collect_tests_options=[], include_curr_dir=True
         )
         config_params = PythonStandardRunnerConfigParams(
             collect_tests_options=["--option=value", "-option"], include_curr_dir=True
         )
         runner_with_params = PythonStandardRunner(config_params)
         assert runner_with_params.params == config_params
 
+    @patch(
+        "codecov_cli.runners.python_standard_runner.getcwd",
+        return_value="current directory",
+    )
     @patch("codecov_cli.runners.python_standard_runner.path")
     @patch("codecov_cli.runners.python_standard_runner.StringIO")
     @patch("codecov_cli.runners.python_standard_runner.pytest")
-    def test_execute_pytest(self, mock_pytest, mock_stringio, mock_sys_path):
+    def test_execute_pytest(
+        self, mock_pytest, mock_stringio, mock_sys_path, mock_getcwd
+    ):
         output = "Output in stdout"
         mock_getvalue = MagicMock(return_value=output)
         mock_stringio.return_value.__enter__.return_value.getvalue = mock_getvalue
@@ -37,13 +43,20 @@ def test_execute_pytest(self, mock_pytest, mock_stringio, mock_sys_path):
         mock_pytest.main.assert_called_with(["--option", "--ignore=batata"])
         mock_stringio.assert_called()
         mock_getvalue.assert_called()
-        mock_sys_path.append.assert_not_called()
+        mock_sys_path.append.assert_called_with("current directory")
+        mock_sys_path.remove.assert_called_with("current directory")
         assert result == output
 
+    @patch(
+        "codecov_cli.runners.python_standard_runner.getcwd",
+        return_value="current directory",
+    )
     @patch("codecov_cli.runners.python_standard_runner.path")
     @patch("codecov_cli.runners.python_standard_runner.StringIO")
     @patch("codecov_cli.runners.python_standard_runner.pytest")
-    def test_execute_pytest_fail(self, mock_pytest, mock_stringio, mock_sys_path):
+    def test_execute_pytest_fail(
+        self, mock_pytest, mock_stringio, mock_sys_path, mock_getcwd
+    ):
         output = "Output in stdout"
         mock_getvalue = MagicMock(return_value=output)
         mock_stringio.return_value.__enter__.return_value.getvalue = mock_getvalue
@@ -55,13 +68,13 @@ def test_execute_pytest_fail(self, mock_pytest, mock_stringio, mock_sys_path):
         mock_pytest.main.assert_called_with(["--option", "--ignore=batata"])
         mock_stringio.assert_called()
         mock_getvalue.assert_called()
-        mock_sys_path.append.assert_not_called()
+        mock_sys_path.append.assert_called_with("current directory")
 
     @patch("codecov_cli.runners.python_standard_runner.getcwd")
     @patch("codecov_cli.runners.python_standard_runner.path")
     @patch("codecov_cli.runners.python_standard_runner.StringIO")
     @patch("codecov_cli.runners.python_standard_runner.pytest")
-    def test_execute_pytest_include_curr_dir(
+    def test_execute_pytest_NOT_include_curr_dir(
         self, mock_pytest, mock_stringio, mock_sys_path, mock_getcwd
     ):
         output = "Output in stdout"
@@ -70,14 +83,13 @@ def test_execute_pytest_include_curr_dir(
         mock_stringio.return_value.__enter__.return_value.getvalue = mock_getvalue
         mock_pytest.main.return_value = ExitCode.OK
 
-        config_params = PythonStandardRunnerConfigParams(include_curr_dir=True)
+        config_params = PythonStandardRunnerConfigParams(include_curr_dir=False)
         runner = PythonStandardRunner(config_params)
         result = runner._execute_pytest(["--option", "--ignore=batata"])
         mock_pytest.main.assert_called_with(["--option", "--ignore=batata"])
         mock_stringio.assert_called()
         mock_getvalue.assert_called()
-        mock_sys_path.append.assert_called_with("current directory")
-        mock_sys_path.remove.assert_called_with("current directory")
+        mock_sys_path.append.assert_not_called()
         mock_getcwd.assert_called()
         assert result == output
 

tests/runners/test_runners.py

@@ -17,7 +17,7 @@ def test_python_standard_runner_with_options(self):
         )
         runner_instance = get_runner({"runners": {"python": config_params}}, "python")
         assert isinstance(runner_instance, PythonStandardRunner)
-        assert runner_instance.params == {**config_params, "include_curr_dir": False}
+        assert runner_instance.params == {**config_params, "include_curr_dir": True}
 
     def test_get_dan_runner_with_params(self):
         config = {