Enable other runners (DAN runner) (#155)

* Enable other runners (DAN runner)

We had created a DAN runner previously, but there was no option in the label analysis
command to actually select different runners.

Another issue is that thwe return of `collect_tests` in a runner needs to be a list,
and the DAN runner was not returning that.

The changes here should make the DAN runner a viable alternative to the
PythonStandardRunner, in case we need that.

* Move default value for runner to the runner-name option

Author: giovanni-guidini

codecov_cli/commands/labelanalysis.py

@@ -32,13 +32,16 @@
     cls=CodecovOption,
     required=True,
 )
+@click.option(
+    "--runner-name", "--runner", "runner_name", help="Runner to use", default="python"
+)
 @click.pass_context
 def label_analysis(
     ctx: click.Context,
     token: str,
     head_commit_sha: str,
     base_commit_sha: str,
-    runner_name: str = "python",
+    runner_name: str,
 ):
     logger.debug(
         "Starting label analysis",

codecov_cli/runners/dan_runner.py

@@ -1,3 +1,4 @@
+import json
 import subprocess
 from typing import List, Optional, Union
 
@@ -10,10 +11,19 @@
 class DoAnythingNowConfigParams(dict):
     @property
     def collect_tests_command(self) -> Union[List[str], str]:
+        """
+        Command to run when collecting tests.
+        The output of this command needs to be a list of test labels,
+        one test label per line.
+        """
         return self.get("collect_tests_command", None)
 
     @property
     def process_labelanalysis_result_command(self) -> Union[List[str], str]:
+        """
+        Command to run that handles the label analysis result.
+        The result will be passed as an argument to the command in JSON format.
+        """
         return self.get("process_labelanalysis_result_command", None)
 
 
@@ -30,12 +40,25 @@ def collect_tests(self) -> List[str]:
             raise Exception(
                 "DAN runner missing 'collect_tests_command' configuration value"
             )
-        return subprocess.run(command, check=True, capture_output=True).stdout.decode()
+        return list(
+            subprocess.run(command, check=True, capture_output=True)
+            .stdout.decode()
+            .splitlines()
+        )
 
     def process_labelanalysis_result(self, result: LabelAnalysisRequestResult):
+        json_result = json.dumps(result)
         command = self.params.process_labelanalysis_result_command
         if command is None:
             raise Exception(
                 "DAN runner missing 'process_labelanalysis_result_command' configuration value"
             )
-        return subprocess.run(command, check=True, capture_output=True).stdout.decode()
+        command_list = []
+        if type(command) == list:
+            command_list.extend(command)
+        else:
+            command_list.append(command)
+        command_list.append(json_result)
+        return subprocess.run(
+            command_list, check=True, capture_output=True
+        ).stdout.decode()

tests/commands/test_invoke_labelanalysis.py

@@ -21,15 +21,17 @@ def test_labelanalysis_help(self, mocker, fake_ci_provider):
 
         result = runner.invoke(cli, ["label-analysis", "--help"], obj={})
         assert result.exit_code == 0
+        print(result.output)
         assert result.output.split("\n") == [
             "Usage: cli label-analysis [OPTIONS]",
             "",
             "Options:",
-            "  --token TEXT     The static analysis token (NOT the same token as upload)",
-            "                   [required]",
-            "  --head-sha TEXT  Commit SHA (with 40 chars)  [required]",
-            "  --base-sha TEXT  Commit SHA (with 40 chars)  [required]",
-            "  --help           Show this message and exit.",
+            "  --token TEXT                  The static analysis token (NOT the same token as",
+            "                                upload)  [required]",
+            "  --head-sha TEXT               Commit SHA (with 40 chars)  [required]",
+            "  --base-sha TEXT               Commit SHA (with 40 chars)  [required]",
+            "  --runner-name, --runner TEXT  Runner to use",
+            "  --help                        Show this message and exit.",
             "",
         ]
 

tests/runners/test_dan_runner.py

@@ -19,7 +19,7 @@ def test_collect_tests(self, mock_run):
         runner = DoAnythingNowRunner(config_options)
         assert runner.params == config_options
         resp = runner.collect_tests()
-        assert resp.split() == test_list
+        assert resp == test_list
         mock_run.assert_called_with(
             ["mycommand", "--option"],
             capture_output=True,
@@ -54,7 +54,36 @@ def test_process_labelanalysis_result(self, mock_run):
         runner.process_labelanalysis_result(label_analysis_result)
         assert runner.params == config_options
         mock_run.assert_called_with(
-            ["mycommand", "--option"],
+            [
+                "mycommand",
+                "--option",
+                '{"present_report_labels": ["test_present"], "absent_labels": ["test_absent"], "present_diff_labels": ["test_in_diff"], "global_level_labels": ["test_global"]}',
+            ],
+            capture_output=True,
+            check=True,
+        )
+
+    @patch("codecov_cli.runners.dan_runner.subprocess.run")
+    def test_process_labelanalysis_result_string_command(self, mock_run):
+        label_analysis_result = {
+            "present_report_labels": ["test_present"],
+            "absent_labels": ["test_absent"],
+            "present_diff_labels": ["test_in_diff"],
+            "global_level_labels": ["test_global"],
+        }
+        cmd_output = "My command output"
+        mock_stdout = MagicMock()
+        mock_stdout.configure_mock(**{"stdout.decode.return_value": cmd_output})
+        mock_run.return_value = mock_stdout
+        config_options = {"process_labelanalysis_result_command": "mycommand --option"}
+        runner = DoAnythingNowRunner(config_options)
+        runner.process_labelanalysis_result(label_analysis_result)
+        assert runner.params == config_options
+        mock_run.assert_called_with(
+            [
+                "mycommand --option",
+                '{"present_report_labels": ["test_present"], "absent_labels": ["test_absent"], "present_diff_labels": ["test_in_diff"], "global_level_labels": ["test_global"]}',
+            ],
             capture_output=True,
             check=True,
         )