Merge pull request #103 from jakeberesford-palmetto/feature/run-in-docker-util

Abstract run_in_docker to a utility function

Author: jakeberesford-palmetto

palm/environment.py

@@ -6,7 +6,7 @@
 from pydantic import BaseModel
 
 from palm.plugin_manager import PluginManager
-from palm.utils import run_on_host
+from palm.utils import run_on_host, run_in_docker
 
 from .code_generator import CodeGenerator
 from .palm_config import PalmConfig
@@ -23,27 +23,12 @@ def run_in_docker(
         cmd: str,
         env_vars: Optional[dict] = {},
         no_bin_bash: Optional[bool] = False,
+        silent: Optional[bool] = False,
     ) -> Tuple[bool, str]:
-        """Shells out and runs the cmd in docker
-
-        Args:
-            cmd (str): The command you want to run
-            env_vars (Optional[dict], optional): Dict of env vars to pass to the docker container.
-        """
-        click.secho(f"Executing command `{cmd}` in compose...", fg="yellow")
-
-        docker_cmd = ["docker compose run --service-ports --rm"]
-        docker_cmd.extend(self._build_env_vars(env_vars))
-        docker_cmd.append(self.palm.image_name)
-        if no_bin_bash:
-            docker_cmd.append(cmd)
-        else:
-            docker_cmd.append(f'/bin/bash -c "{cmd}" ')
-
-        ex_code, _, _ = run_on_host(" ".join(docker_cmd))
-        if ex_code == 0:
-            return (True, "Success! Palm completed with exit code 0")
-        return (False, f"Fail! Palm exited with code {ex_code}")
+        env_vars_list = self._build_env_vars(env_vars)
+        return run_in_docker(
+            cmd, self.palm.image_name, env_vars_list, no_bin_bash, silent
+        )
 
     def run_on_host(
         self,

palm/plugins/base_plugin_config.py

@@ -19,8 +19,7 @@ def set(self) -> dict:
         """Setter for plugin config
 
         This method should be implemented by the plugin to set the config
-        for the plugin. It should return True if the config was set successfully,
-        and False if it was not.
+        for the plugin. It should return a dict of the config that was set.
 
         Returns:
             dict: The config that was set

palm/utils.py

@@ -1,6 +1,8 @@
 import subprocess
 from sys import version_info
-from typing import Optional, Tuple
+from typing import Optional, Tuple, List
+
+import click
 
 
 class UnsupportedVersion(Exception):
@@ -53,3 +55,39 @@ def run_on_host(
         completed.stdout.decode("utf-8") if completed.stdout else "",
         completed.stderr.decode("utf-8") if completed.stderr else "",
     )
+
+
+def run_in_docker(
+    cmd: str,
+    image_name: str,
+    env_vars: Optional[List[str]] = [],
+    no_bin_bash: Optional[bool] = False,
+    capture_output: Optional[bool] = False,
+    silent: Optional[bool] = False,
+) -> Tuple[bool, str]:
+    """Shells out and runs the cmd in docker
+
+    Args:
+        cmd (str): The command you want to run
+        env_vars (Optional[dict], optional): Dict of env vars to pass to the docker container.
+    """
+    if not silent:
+        click.secho(f"Executing command `{cmd}` in compose...", fg="yellow")
+
+    docker_cmd = ["docker compose run --service-ports --rm"]
+    docker_cmd.extend(env_vars)
+    docker_cmd.append(image_name)
+    if no_bin_bash:
+        docker_cmd.append(cmd)
+    else:
+        docker_cmd.append(f'/bin/bash -c "{cmd}" ')
+
+    ex_code, std_out, std_err = run_on_host(" ".join(docker_cmd), False, capture_output)
+    if capture_output:
+        if ex_code == 0:
+            return (True, std_out)
+        return (False, std_err)
+
+    if ex_code == 0:
+        return (True, "Success! Palm completed with exit code 0")
+    return (False, f"Fail! Palm exited with code {ex_code}")