Fix duplicate code between process helpers and runner

Author: BenjaminHamon

Sources/toolkit/bhamon_development_toolkit/processes/process_helpers.py

@@ -3,13 +3,6 @@
 import shlex
 from typing import List, Optional, TextIO
 
-from bhamon_development_toolkit.processes.executable_command import ExecutableCommand
-from bhamon_development_toolkit.processes.process_options import ProcessOptions
-from bhamon_development_toolkit.processes.process_output_collector import ProcessOutputCollector
-from bhamon_development_toolkit.processes.process_output_handler import ProcessOutputHandler
-from bhamon_development_toolkit.processes.process_result import ProcessResult
-from bhamon_development_toolkit.processes.process_spawner import ProcessSpawner
-
 
 def format_executable_command(command: List[str]):
     return " ".join(format_executable_command_element(element) for element in command)
@@ -40,57 +33,3 @@ def create_raw_logger(stream: Optional[TextIO] = None, log_file_path: Optional[s
         logger.addHandler(file_handler)
 
     return logger
-
-
-async def run(
-        spawner: ProcessSpawner,
-        command: ExecutableCommand,
-        options: ProcessOptions,
-        output_handlers: Optional[List[ProcessOutputHandler]] = None,
-        check_exit_code: bool = True,
-    ) -> ProcessResult:
-
-    watcher = await spawner.spawn_process(command = command, options = options)
-
-    if output_handlers is not None:
-        for handler in output_handlers:
-            watcher.add_output_handler(handler)
-
-    try:
-        await watcher.start()
-        await watcher.wait()
-        await watcher.complete(check_exit_code)
-
-    except BaseException as exception:
-        if watcher.get_status().is_running:
-            await watcher.terminate(type(exception).__name__)
-
-        raise
-
-    status = watcher.get_status()
-    if status.exit_code is None:
-        raise ValueError("Process exit code is not set")
-
-    return ProcessResult(
-        executable = status.executable,
-        exit_code = status.exit_code,
-    )
-
-
-async def run_with_collector(
-        spawner: ProcessSpawner,
-        command: ExecutableCommand,
-        options: ProcessOptions,
-        check_exit_code: bool = True,
-    ) -> ProcessResult:
-
-    output_collector = ProcessOutputCollector()
-
-    result = await run(spawner, command, options, output_handlers = [ output_collector ], check_exit_code = check_exit_code)
-
-    return ProcessResult(
-        executable = result.executable,
-        exit_code = result.exit_code,
-        standard_output = output_collector.get_stdout(),
-        error_output = output_collector.get_stderr(),
-    )

Sources/toolkit/bhamon_development_toolkit/processes/process_runner.py

@@ -2,9 +2,10 @@
 
 from bhamon_development_toolkit.processes.executable_command import ExecutableCommand
 from bhamon_development_toolkit.processes.process_options import ProcessOptions
+from bhamon_development_toolkit.processes.process_output_collector import ProcessOutputCollector
 from bhamon_development_toolkit.processes.process_output_handler import ProcessOutputHandler
+from bhamon_development_toolkit.processes.process_result import ProcessResult
 from bhamon_development_toolkit.processes.process_spawner import ProcessSpawner
-from bhamon_development_toolkit.processes.process_status import ProcessStatus
 
 
 class ProcessRunner:
@@ -19,7 +20,7 @@ async def run(self,
             options: ProcessOptions,
             output_handlers: Optional[List[ProcessOutputHandler]] = None,
             check_exit_code: bool = True
-            ) -> ProcessStatus:
+        ) -> ProcessResult:
 
         watcher = await self._spawner.spawn_process(command = command, options = options)
 
@@ -38,4 +39,29 @@ async def run(self,
 
             raise
 
-        return watcher.get_status()
+        status = watcher.get_status()
+        if status.exit_code is None:
+            raise ValueError("Process exit code is not set")
+
+        return ProcessResult(
+            executable = status.executable,
+            exit_code = status.exit_code,
+        )
+
+
+    async def run_with_collector(self,
+            command: ExecutableCommand,
+            options: ProcessOptions,
+            check_exit_code: bool = True,
+        ) -> ProcessResult:
+
+        output_collector = ProcessOutputCollector()
+
+        result = await self.run(command, options, output_handlers = [ output_collector ], check_exit_code = check_exit_code)
+
+        return ProcessResult(
+            executable = result.executable,
+            exit_code = result.exit_code,
+            standard_output = output_collector.get_stdout(),
+            error_output = output_collector.get_stderr(),
+        )

Sources/toolkit/bhamon_development_toolkit/python/pylint_runner.py

@@ -76,10 +76,10 @@ async def _run_with_scope(self,
         success = True
 
         if not simulate:
-            status = await self._process_runner.run(command, process_options, [ raw_output_logger, pylint_output_handler ], check_exit_code = False)
+            result = await self._process_runner.run(command, process_options, [ raw_output_logger, pylint_output_handler ], check_exit_code = False)
 
-            self._check_exit_code(status.exit_code)
-            success = self._get_success_from_exit_code(status.exit_code)
+            self._check_exit_code(result.exit_code)
+            success = self._get_success_from_exit_code(result.exit_code)
 
         return success
 

Sources/toolkit/bhamon_development_toolkit/python/pytest_runner.py

@@ -80,10 +80,10 @@ async def _run_with_scope(self,
         success = True
 
         if not simulate:
-            status = await self._process_runner.run(command, process_options, [ raw_output_logger, pytest_output_handler ], check_exit_code = False)
+            result = await self._process_runner.run(command, process_options, [ raw_output_logger, pytest_output_handler ], check_exit_code = False)
 
-            self._check_exit_code(status.exit_code)
-            success = self._get_success_from_exit_code(status.exit_code)
+            self._check_exit_code(result.exit_code)
+            success = self._get_success_from_exit_code(result.exit_code)
 
             with open(json_report_file_path, mode = "r", encoding = "utf-8") as json_report_file:
                 json_report = json.load(json_report_file)