cli: add --use-buildtrees option for artifacts checkout

Add support for checking out build trees via bst artifacts checkout, similar to the existing bst shell --use-buildtrees functionality.

Author: ownik

src/buildstream/_frontend/cli.py

@@ -1379,6 +1379,16 @@ def artifact_show(app, deps, artifact_remotes, ignore_project_artifact_remotes,
     is_flag=True,
     help="Ignore remote artifact cache servers recommended by projects",
 )
+@click.option(
+    "--use-buildtree",
+    "-t",
+    "cli_buildtree",
+    is_flag=True,
+    help=(
+        "Stage a buildtree. Will fail if a buildtree is not available. "
+        "pull-buildtrees configuration is needed if the buildtree is not available locally."
+    ),
+)
 @click.argument("target", required=False, type=click.Path(readable=False))
 @click.pass_obj
 def artifact_checkout(
@@ -1392,6 +1402,7 @@ def artifact_checkout(
     directory,
     artifact_remotes,
     ignore_project_artifact_remotes,
+    cli_buildtree,
     target,
 ):
     """Checkout contents of an artifact
@@ -1454,6 +1465,7 @@ def artifact_checkout(
             tar=bool(tar),
             artifact_remotes=artifact_remotes,
             ignore_project_artifact_remotes=ignore_project_artifact_remotes,
+            usebuildtree=cli_buildtree,
         )
 
 

src/buildstream/_stream.py

@@ -695,6 +695,7 @@ def checkout(
         tar: bool = False,
         artifact_remotes: Iterable[RemoteSpec] = (),
         ignore_project_artifact_remotes: bool = False,
+        usebuildtree: bool = False,
     ):
 
         elements = self._load(
@@ -728,7 +729,7 @@ def checkout(
                 _PipelineSelection.NONE: _Scope.NONE,
                 _PipelineSelection.ALL: _Scope.ALL,
             }
-            with element._prepare_sandbox(scope=scope[selection], integrate=integrate) as sandbox:
+            with element._prepare_sandbox(scope=scope[selection], integrate=integrate, usebuildtree=usebuildtree) as sandbox:
                 # Copy or move the sandbox to the target directory
                 virdir = sandbox.get_virtual_directory()
                 self._export_artifact(tar, location, compression, element, hardlinks, virdir)