Merge ~jugmac00/lpci:declare-snap-dependencies-for-jobs into lpci:main

[Jürgen Gmach]

Declare snap dependencies for jobs

[Colin Watson (cjwatson)]

review: Needs Fixing

[Jürgen Gmach (jugmac00)]

Applied suggested fixes - please re-re-view.

[Colin Watson (cjwatson)]

I expect that we'll have to extend this to support channels other than stable at some point, but this will do fine for now.

review: Approve

diff --git a/lpcraft/commands/run.py b/lpcraft/commands/run.py
index eb03be0..8e94a5d 100644
--- a/lpcraft/commands/run.py
+++ b/lpcraft/commands/run.py
@@ -11,6 +11,7 @@ from typing import List, Set
 
 from craft_cli import emit
 from craft_providers import Executor
+from craft_providers.actions.snap_installer import install_from_store
 from dotenv import dotenv_values
 
 from lpcraft import env
@@ -180,7 +181,6 @@ def run(args: Namespace) -> int:
                     f"does not set 'run'"
                 )
 
-            cmd = ["bash", "--noprofile", "--norc", "-ec", job.run]
             remote_cwd = env.get_managed_environment_project_path()
 
             emit.progress(
@@ -192,10 +192,20 @@ def run(args: Namespace) -> int:
                 series=job.series,
                 architecture=host_architecture,
             ) as instance:
+                if job.snaps:
+                    for snap in job.snaps:
+                        emit.progress(f"Running `snap install {snap}`")
+                        install_from_store(
+                            executor=instance,
+                            snap_name=snap,
+                            channel="stable",
+                            classic=True,
+                        )
+                run_cmd = ["bash", "--noprofile", "--norc", "-ec", job.run]
                 emit.progress("Running the job")
-                with emit.open_stream(f"Running {cmd}") as stream:
+                with emit.open_stream(f"Running {run_cmd}") as stream:
                     proc = instance.execute_run(
-                        cmd,
+                        run_cmd,
                         cwd=remote_cwd,
                         env=job.environment,
                         stdout=stream,
diff --git a/lpcraft/commands/tests/test_run.py b/lpcraft/commands/tests/test_run.py
index cf47f49..25ea37b 100644
--- a/lpcraft/commands/tests/test_run.py
+++ b/lpcraft/commands/tests/test_run.py
@@ -872,3 +872,90 @@ class TestRun(CommandBaseTestCase):
         self.assertEqual(1, result.exit_code)
         [error] = result.errors
         self.assertIn("/target", str(error))
+
+    @patch("lpcraft.commands.run.get_provider")
+    @patch("lpcraft.commands.run.get_host_architecture", return_value="amd64")
+    def test_install_snaps(
+        self, mock_get_host_architecture, mock_get_provider
+    ):
+        launcher = Mock(spec=launch)
+        provider = self.makeLXDProvider(lxd_launcher=launcher)
+        mock_get_provider.return_value = provider
+        execute_run = launcher.return_value.execute_run
+        execute_run.return_value = subprocess.CompletedProcess([], 0)
+        config = dedent(
+            """
+            pipeline:
+                - test
+
+            jobs:
+                test:
+                    series: focal
+                    architectures: amd64
+                    run: tox
+                    snaps: [chromium, firefox]
+            """
+        )
+        Path(".launchpad.yaml").write_text(config)
+
+        result = self.run_command("run")
+
+        self.assertEqual(0, result.exit_code)
+        self.assertEqual(
+            [
+                call(
+                    [
+                        "snap",
+                        "download",
+                        "chromium",
+                        "--channel=stable",
+                        "--basename=chromium",
+                        "--target-directory=/tmp",
+                    ],
+                    check=True,
+                    capture_output=True,
+                ),
+                call(
+                    [
+                        "snap",
+                        "install",
+                        "/tmp/chromium.snap",
+                        "--classic",
+                        "--dangerous",
+                    ],
+                    check=True,
+                    capture_output=True,
+                ),
+                call(
+                    [
+                        "snap",
+                        "download",
+                        "firefox",
+                        "--channel=stable",
+                        "--basename=firefox",
+                        "--target-directory=/tmp",
+                    ],
+                    check=True,
+                    capture_output=True,
+                ),
+                call(
+                    [
+                        "snap",
+                        "install",
+                        "/tmp/firefox.snap",
+                        "--classic",
+                        "--dangerous",
+                    ],
+                    check=True,
+                    capture_output=True,
+                ),
+                call(
+                    ["bash", "--noprofile", "--norc", "-ec", "tox"],
+                    cwd=Path("/root/project"),
+                    env=None,
+                    stdout=27,
+                    stderr=27,
+                ),
+            ],
+            execute_run.call_args_list,
+        )
diff --git a/lpcraft/config.py b/lpcraft/config.py
index 97c582b..fc49f85 100644
--- a/lpcraft/config.py
+++ b/lpcraft/config.py
@@ -53,6 +53,7 @@ class Job(ModelConfigDefaults):
     run: Optional[StrictStr]
     environment: Optional[Dict[str, Optional[str]]]
     output: Optional[Output]
+    snaps: Optional[List[StrictStr]]
 
     @pydantic.validator("architectures", pre=True)
     def validate_architectures(
diff --git a/lpcraft/tests/test_config.py b/lpcraft/tests/test_config.py
index 67a9e0e..0efd32d 100644
--- a/lpcraft/tests/test_config.py
+++ b/lpcraft/tests/test_config.py
@@ -212,3 +212,38 @@ class TestConfig(TestCase):
             Config.load,
             path,
         )
+
+    def test_load_snaps(self):
+        path = self.create_config(
+            dedent(
+                """
+                pipeline:
+                    - test
+
+                jobs:
+                    test:
+                        series: focal
+                        architectures: amd64
+                        snaps: [chromium, firefox]
+                """
+            )
+        )
+        config = Config.load(path)
+        self.assertEqual(["chromium", "firefox"], config.jobs["test"][0].snaps)
+
+    def test_load_config_without_snaps(self):
+        path = self.create_config(
+            dedent(
+                """
+                pipeline:
+                    - test
+
+                jobs:
+                    test:
+                        series: focal
+                        architectures: amd64
+                """
+            )
+        )
+        config = Config.load(path)
+        self.assertEqual(None, config.jobs["test"][0].snaps)