[BugFix] Get snap info from environ (#34)

Signed-off-by: Douglas Chiang <[email protected]>

Author: douglasdotc

yarf/output/__init__.py

@@ -3,7 +3,6 @@
 import json
 import logging
 import os
-import subprocess
 import tempfile
 from pathlib import Path
 from typing import Any, Callable, Optional
@@ -179,7 +178,6 @@ def get_yarf_snap_info() -> dict[str, str] | None:
         date.
 
         Raises:
-            RuntimeError: When the subprocess failed to run
             ValueError: When match installed YARF information cannot match with YARF snap info
 
         Returns:
@@ -189,58 +187,15 @@ def get_yarf_snap_info() -> dict[str, str] | None:
             return None
 
         try:
-            # Run `snap info` command
-            result = subprocess.run(
-                ["snap", "info", "yarf"],
-                capture_output=True,
-                text=True,
-                check=True,
-            )
-            output = result.stdout
-        except subprocess.CalledProcessError as e:
-            raise RuntimeError("Subprocess execution failed.") from e
-
-        # Get the installed snap info
-        installed_yarf_info = {}
-        channels = {}
-        for line in output.splitlines():
-            if line.strip().startswith("name:"):
-                parts = line.split()
-                installed_yarf_info["name"] = parts[1]
-
-            elif line.strip().startswith("latest/"):
-                parts = line.split()
-                channel = parts[0].rstrip(":")
-                version = parts[1]
-                date = parts[2] if len(parts) > 2 else "Unknown"
-                revision = parts[3] if len(parts) > 3 else "Unknown"
-                channels[channel] = {
-                    "channel": channel,
-                    "version": version,
-                    "revision": revision.strip("()"),
-                    "date": date,
-                }
-
-            elif line.strip().startswith("installed:"):
-                parts = line.split()
-                installed_yarf_info["version"] = parts[1]
-                installed_yarf_info["revision"] = parts[2].strip("()")
-
-            elif line.strip().startswith("tracking:"):
-                parts = line.split()
-                installed_yarf_info["channel"] = parts[1]
-
-        for channel, info in channels.items():
-            if (
-                info["channel"] == installed_yarf_info["channel"]
-                and info["revision"] == installed_yarf_info["revision"]
-                and info["version"] == installed_yarf_info["version"]
-            ):
-                return channels[channel] | installed_yarf_info
-
-        raise ValueError(
-            "Cannot match installed YARF information with YARF snap info."
-        )
+            yarf_snap_info = {
+                "name": os.environ["SNAP_NAME"],
+                "version": os.environ["SNAP_VERSION"],
+                "revision": os.environ["SNAP_REVISION"],
+            }
+        except KeyError as exc:
+            raise ValueError("Cannot get installed YARF information.") from exc
+
+        return yarf_snap_info  # type: ignore[return-value]
 
 
 def import_supported_formats() -> None:

yarf/output/test_submission_schema.py

@@ -158,7 +158,6 @@ def get_origin(self) -> dict[str, Any]:
                 "name": current_yarf_info["name"],
                 "version": current_yarf_info["version"],
                 "revision": current_yarf_info["revision"],
-                "date": current_yarf_info["date"],
             }
         else:
             origin["version"] = metadata.version("yarf")

yarf/output/tests/test_init.py

@@ -1,7 +1,5 @@
 import os
-import subprocess
 from pathlib import Path
-from textwrap import dedent
 from typing import Any
 from unittest.mock import ANY, MagicMock, Mock, call, patch, sentinel
 
@@ -55,110 +53,39 @@ class TestModule(OutputConverterBase):
         with pytest.raises(TypeError):
             TestModule()
 
-    @patch("yarf.output.subprocess.run")
-    def test_get_yarf_snap_info(
-        self,
-        mock_subprocess_run: MagicMock,
-    ) -> None:
+    def test_get_yarf_snap_info(self) -> None:
         """
         Test whether the "get_yarf_snap_info" method is callable and return
         results with expected fields.
         """
-        mock_subprocess_run.return_value.stdout = dedent(
-            """
-            name:      yarf
-            summary:   Yet Another Robot Framework
-            publisher: Canonical Certification Team (ce-certification-qa)
-            store-url: https://snapcraft.io/yarf
-            license:   unset
-            description: |
-              Yet Another Robot Framework (YARF) is an interface that
-              allows developers to build complex test scenarios and
-              bootstrap them locally, then work towards automated runs.
-            commands:
-              - yarf
-            snap-id:      zIV9E2VxqRgGhIuttHs8YkCyWGjIOiRm
-            tracking:     latest/beta
-            refresh-date: 3 days ago, at 16:40 GMT
-            channels:
-              latest/stable:    –
-              latest/candidate: –
-              latest/beta:      1.0.0 2024-12-03 (124) 206MB -
-              latest/edge:      1.0.0 2024-12-03 (124) 206MB -
-            installed:          1.0.0            (124) 206MB -
-            """
-        )
-
         expected_result = {
-            "channel": "latest/beta",
-            "version": "1.0.0",
-            "revision": "124",
-            "date": "2024-12-03",
+            "version": "2.0.0",
+            "revision": "300",
             "name": "yarf",
         }
-        with patch.dict(os.environ, {"SNAP": str(sentinel.snap_env)}):
+        with patch.dict(
+            os.environ,
+            {
+                "SNAP": str(sentinel.snap_env),
+                "SNAP_NAME": "yarf",
+                "SNAP_VERSION": "2.0.0",
+                "SNAP_REVISION": "300",
+            },
+        ):
             result = OutputConverterBase.get_yarf_snap_info()
         assert expected_result == result
 
-    @patch("yarf.output.subprocess.run")
-    def test_get_yarf_snap_info_runtime_error(
-        self,
-        mock_subprocess_run: MagicMock,
-    ) -> None:
-        """
-        Test whether the function get_yarf_snap_info raises runtime error when
-        subprocess.run raises a CalledProcessError exception.
-        """
-
-        mock_subprocess_run.side_effect = subprocess.CalledProcessError(
-            returncode=1,
-            cmd=["snap", "info", "yarf"],
-            output="Error: Could not find snap 'yarf'.",
-        )
-
-        with (
-            patch.dict(os.environ, {"SNAP": str(sentinel.snap_env)}),
-            pytest.raises(RuntimeError),
-        ):
-            OutputConverterBase.get_yarf_snap_info()
-
-    @patch("yarf.output.subprocess.run")
-    def test_get_yarf_snap_info_value_error(
-        self,
-        mock_subprocess_run: MagicMock,
-    ) -> None:
+    def test_get_yarf_snap_info_value_error(self) -> None:
         """
         Test whether the function get_yarf_snap_info raises value error when
         there is a mismatch between the installed YARF and the snap info.
         """
-
-        mock_subprocess_run.return_value.stdout = dedent(
-            """
-            name:      yarf
-            summary:   Yet Another Robot Framework
-            publisher: Canonical Certification Team (ce-certification-qa)
-            store-url: https://snapcraft.io/yarf
-            license:   unset
-            description: |
-              Yet Another Robot Framework (YARF) is an interface that
-              allows developers to build complex test scenarios and
-              bootstrap them locally, then work towards automated runs.
-            commands:
-              - yarf
-            snap-id:      zIV9E2VxqRgGhIuttHs8YkCyWGjIOiRm
-            tracking:     latest/beta
-            refresh-date: 3 days ago, at 16:40 GMT
-            channels:
-              latest/stable:    –
-              latest/candidate: –
-              latest/beta:      1.0.0 2024-12-03 (124) 206MB -
-              latest/edge:      1.0.0 2024-12-03 (124) 206MB -
-            installed:          9.9.9            (999) 206MB -
-            """
-        )
-
         with (
-            patch.dict(os.environ, {"SNAP": str(sentinel.snap_env)}),
+            patch.dict(
+                os.environ,
+                {"SNAP": str(sentinel.snap_env), "SNAP_NAME": "yarf"},
+                clear=True,
+            ),
             pytest.raises(ValueError),
         ):
             OutputConverterBase.get_yarf_snap_info()

yarf/output/tests/test_test_submission_schema.py

@@ -297,10 +297,8 @@ def test_get_origin_has_snap(self) -> None:
         converter = TestSubmissionSchema()
         converter.get_yarf_snap_info = Mock(
             return_value={
-                "channel": "latest/beta",
                 "version": "1.0.0",
                 "revision": "124",
-                "date": "2024-12-03",
                 "name": "yarf",
             }
         )
@@ -312,7 +310,6 @@ def test_get_origin_has_snap(self) -> None:
                 "name": "yarf",
                 "version": "1.0.0",
                 "revision": "124",
-                "date": "2024-12-03",
             },
         }