cli: Add prepare command

This can be used to prepare an environment with a build before
running the exec, shell, or activate commands.

Author: cassava

cli/cloe_launch/__main__.py

@@ -198,9 +198,9 @@ def cli_exec(
     options.deny_profile_and_path(profile, profile_path)
     conf = Configuration(profile)
     engine = Engine(conf, conanfile=profile_path)
-    engine.conan_args = conan_arg
-    engine.conan_options = conan_option
-    engine.conan_settings = conan_setting
+    engine.conan_args = list(conan_arg)
+    engine.conan_options = list(conan_option)
+    engine.conan_settings = list(conan_setting)
 
     engine.preserve_env = preserve_env
 
@@ -248,9 +248,9 @@ def cli_shell(
     conf = Configuration(profile)
     engine = Engine(conf, conanfile=profile_path)
     engine.preserve_env = preserve_env
-    engine.conan_args = conan_arg
-    engine.conan_options = conan_option
-    engine.conan_settings = conan_setting
+    engine.conan_args = list(conan_arg)
+    engine.conan_options = list(conan_option)
+    engine.conan_settings = list(conan_setting)
 
     # Replace process with shell.
     engine.shell(shell_args, use_cache=cache)
@@ -305,14 +305,45 @@ def cli_activate(
     options.deny_profile_and_path(profile, profile_path)
     conf = Configuration(profile)
     engine = Engine(conf, conanfile=profile_path)
-    engine.conan_args = conan_arg
-    engine.conan_options = conan_option
-    engine.conan_settings = conan_setting
+    engine.conan_args = list(conan_arg)
+    engine.conan_options = list(conan_option)
+    engine.conan_settings = list(conan_setting)
 
-    # Replace process with shell.
     engine.activate(use_cache=cache)
 
 
+# _________________________________________________________________________
+# Command: prepare [--cache] [--profile=PROFILE | --profile-path=CONANFILE]
+@main.command("prepare")
+@options.profile()
+@options.profile_path()
+@options.conan_arg()
+@options.conan_option()
+@options.conan_setting()
+@click.pass_obj
+def cli_prepare(
+    opt,
+    profile: str,
+    profile_path: str,
+    conan_arg: List[str],
+    conan_option: List[str],
+    conan_setting: List[str],
+) -> None:
+    """Prepare environment for selected profile.
+
+    This involves downloading missing and available packages and building
+    outdated packages.
+    """
+    options.deny_profile_and_path(profile, profile_path)
+    conf = Configuration(profile)
+    engine = Engine(conf, conanfile=profile_path)
+    engine.conan_args = list(conan_arg)
+    engine.conan_options = list(conan_option)
+    engine.conan_settings = list(conan_setting)
+
+    engine.prepare()
+
+
 # _________________________________________________________________________
 # Command: clean [--profile PROFILE | --profile-path=CONANFILE]
 @main.command("clean")

cli/cloe_launch/exec.py

@@ -353,9 +353,10 @@ def __init__(self, conf, conanfile=None):
         self.engine_pre_args = conf._conf["engine"]["pre_arguments"]
         self.engine_post_args = conf._conf["engine"]["post_arguments"]
         self.preserve_env = False
-        self.conan_args = []
-        self.conan_options = []
-        self.conan_settings = []
+        self.conan_args = list()
+        self.conan_options = list()
+        self.conan_settings = list()
+        self.capture_output = True
 
         logging.info(f"Profile name: {self.profile}")
         logging.info("Configuration:")
@@ -591,6 +592,15 @@ def activate(
             print(f'export {var}="{env[var]}"')
         print(f'export CLOE_SHELL="{self.runtime_env_path()}"')
 
+    def prepare(self, build_policy: str = "outdated") -> None:
+        """Prepare (by downloading or building) dependencies for the profile."""
+        self.capture_output = False
+        if build_policy == "":
+            self.conan_args.append("--build")
+        else:
+            self.conan_args.append(f"--build={build_policy}")
+        self._prepare_runtime_env(use_cache=False)
+
     def exec(
         self,
         args: List[str],
@@ -636,4 +646,4 @@ def exec(
         return result
 
     def _run_cmd(self, cmd, must_succeed=True) -> subprocess.CompletedProcess:
-        return run_cmd(cmd, must_succeed=must_succeed)
+        return run_cmd(cmd, must_succeed=must_succeed, capture_output=self.capture_output)

cli/cloe_launch/utility.py

@@ -10,15 +10,16 @@ def run_cmd(
     cmd: List[str],
     env: Optional[Dict[str, str]] = None,
     must_succeed: bool = True,
+    capture_output: bool = True,
 ) -> subprocess.CompletedProcess:
     """Run a command quietly, only printing stderr if the command fails."""
 
     logging.info(f"Exec: {' '.join(cmd)}")
     result = subprocess.run(
         cmd,
         check=False,
-        stdout=subprocess.PIPE,
-        stderr=subprocess.STDOUT,
+        stdout=subprocess.PIPE if capture_output else None,
+        stderr=subprocess.STDOUT if capture_output else None,
         universal_newlines=True,
         env=env,
     )

cli/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cloe-launch"
-version = "0.18.0"
+version = "0.19.0"
 description = "Launch cloe-engine with Conan profiles."
 license = "Apache-2.0"
 authors = [

cli/setup.py

@@ -12,7 +12,7 @@
 setup(
     long_description=readme,
     name="cloe-launch",
-    version="0.18.0",
+    version="0.19.0",
     description="Launch cloe-engine with Conan profiles.",
     python_requires="==3.*,>=3.6.0",
     author="Robert Bosch GmbH",