craft-application 4.2.1__tar.gz → 4.2.3__tar.gz

{craft_application-4.2.1/craft_application.egg-info → craft_application-4.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: craft-application
-Version: 4.2.1
+Version: 4.2.3
 Summary: A framework for *craft applications.
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console

{craft_application-4.2.1 → craft_application-4.2.3}/craft_application/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '4.2.1'
-__version_tuple__ = version_tuple = (4, 2, 1)
+__version__ = version = '4.2.3'
+__version_tuple__ = version_tuple = (4, 2, 3)

{craft_application-4.2.1 → craft_application-4.2.3}/craft_application/application.py

@@ -392,8 +392,9 @@ class Application:
         """Configure the application using any global arguments."""
 
     def _get_dispatcher(self) -> craft_cli.Dispatcher:
-        """Configure this application. Should be called by the run method.
+        """Configure this application.
 
+        Should be called by the _run_inner method.
         Side-effect: This method may exit the process.
 
         :returns: A ready-to-run Dispatcher object
@@ -504,61 +505,67 @@ class Application:
         :param item: the name of the namespace or config item.
         :returns: the requested value.
         """
-        return getattr(parsed_args, item, self.services.config.get(item))
+        arg_value = getattr(parsed_args, item, None)
+        if arg_value is not None:
+            return arg_value
+        return self.services.config.get(item)
 
-    def run(  # noqa: PLR0912,PLR0915  (too many branches, too many statements)
-        self,
-    ) -> int:
-        """Bootstrap and run the application."""
-        self._setup_logging()
-        self._initialize_craft_parts()
+    def _run_inner(self) -> int:
+        """Actual run implementation."""
         dispatcher = self._get_dispatcher()
-        craft_cli.emit.debug("Preparing application...")
-
-        return_code = 1  # General error
-        try:
-            command = cast(
-                commands.AppCommand,
-                dispatcher.load_command(self.app_config),
+        command = cast(
+            commands.AppCommand,
+            dispatcher.load_command(self.app_config),
+        )
+        parsed_args = dispatcher.parsed_args()
+        platform = self.get_arg_or_config(parsed_args, "platform")
+        build_for = self.get_arg_or_config(parsed_args, "build_for")
+
+        # Some commands (e.g. remote build) can allow multiple platforms
+        # or build-fors, comma-separated. In these cases, we create the
+        # project using the first defined platform.
+        if platform and "," in platform:
+            platform = platform.split(",", maxsplit=1)[0]
+        if build_for and "," in build_for:
+            build_for = build_for.split(",", maxsplit=1)[0]
+
+        provider_name = command.provider_name(dispatcher.parsed_args())
+
+        craft_cli.emit.debug(f"Build plan: platform={platform}, build_for={build_for}")
+        self._pre_run(dispatcher)
+
+        managed_mode = command.run_managed(dispatcher.parsed_args())
+        if managed_mode or command.needs_project(dispatcher.parsed_args()):
+            self.services.project = self.get_project(
+                platform=platform, build_for=build_for
             )
-            parsed_args = dispatcher.parsed_args()
-            platform = self.get_arg_or_config(parsed_args, "platform")
-            build_for = self.get_arg_or_config(parsed_args, "build_for")
 
-            # Some commands (e.g. remote build) can allow multiple platforms
-            # or build-fors, comma-separated. In these cases, we create the
-            # project using the first defined platform.
-            if platform and "," in platform:
-                platform = platform.split(",", maxsplit=1)[0]
-            if build_for and "," in build_for:
-                build_for = build_for.split(",", maxsplit=1)[0]
+        self._configure_services(provider_name)
 
-            provider_name = command.provider_name(dispatcher.parsed_args())
+        return_code = 1  # General error
+        if not managed_mode:
+            # command runs in the outer instance
+            craft_cli.emit.debug(f"Running {self.app.name} {command.name} on host")
+            return_code = dispatcher.run() or os.EX_OK
+        elif not self.is_managed():
+            # command runs in inner instance, but this is the outer instance
+            self.run_managed(platform, build_for)
+            return_code = os.EX_OK
+        else:
+            # command runs in inner instance
+            return_code = dispatcher.run() or 0
 
-            craft_cli.emit.debug(
-                f"Build plan: platform={platform}, build_for={build_for}"
-            )
-            self._pre_run(dispatcher)
+        return return_code
 
-            managed_mode = command.run_managed(dispatcher.parsed_args())
-            if managed_mode or command.needs_project(dispatcher.parsed_args()):
-                self.services.project = self.get_project(
-                    platform=platform, build_for=build_for
-                )
+    def run(self) -> int:
+        """Bootstrap and run the application."""
+        self._setup_logging()
+        self._initialize_craft_parts()
 
-            self._configure_services(provider_name)
+        craft_cli.emit.debug("Preparing application...")
 
-            if not managed_mode:
-                # command runs in the outer instance
-                craft_cli.emit.debug(f"Running {self.app.name} {command.name} on host")
-                return_code = dispatcher.run() or os.EX_OK
-            elif not self.is_managed():
-                # command runs in inner instance, but this is the outer instance
-                self.run_managed(platform, build_for)
-                return_code = os.EX_OK
-            else:
-                # command runs in inner instance
-                return_code = dispatcher.run() or 0
+        try:
+            return_code = self._run_inner()
         except craft_cli.ArgumentParsingError as err:
             print(err, file=sys.stderr)  # to stderr, as argparse normally does
             craft_cli.emit.ended_ok()

{craft_application-4.2.1 → craft_application-4.2.3}/craft_application/services/provider.py

@@ -98,12 +98,16 @@ class ProviderService(base.ProjectService):
             self.environment[f"{scheme.upper()}_PROXY"] = value
 
         if self._install_snap:
-            channel = (
-                None
-                if util.is_running_from_snap(self._app.name)
-                else os.getenv("CRAFT_SNAP_CHANNEL", "latest/stable")
-            )
-            self.snaps.append(Snap(name=self._app.name, channel=channel, classic=True))
+            if util.is_running_from_snap(self._app.name):
+                # use the aliased name of the snap when injecting
+                name = os.getenv("SNAP_INSTANCE_NAME", self._app.name)
+                channel = None
+            else:
+                # use the snap name when installing from the store
+                name = self._app.name
+                channel = os.getenv("CRAFT_SNAP_CHANNEL", "latest/stable")
+
+            self.snaps.append(Snap(name=name, channel=channel, classic=True))
 
     @contextlib.contextmanager
     def instance(

{craft_application-4.2.1 → craft_application-4.2.3/craft_application.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: craft-application
-Version: 4.2.1
+Version: 4.2.3
 Summary: A framework for *craft applications.
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console

{craft_application-4.2.1 → craft_application-4.2.3}/docs/reference/changelog.rst

@@ -2,6 +2,27 @@
 Changelog
 *********
 
+4.2.3 (2024-Sep-18)
+-------------------
+
+Application
+===========
+
+- ``get_arg_or_config`` now correctly checks the config service if the passed
+  namespace has ``None`` as the value of the requested item.
+
+For a complete list of commits, check out the `4.2.3`_ release on GitHub.
+
+4.2.2 (2024-Sep-13)
+-------------------
+
+Application
+===========
+
+- Add a ``_run_inner`` method to override or wrap the core run logic.
+
+For a complete list of commits, check out the `4.2.2`_ release on GitHub.
+
 4.2.1 (2024-Sep-13)
 -------------------
 
@@ -255,3 +276,5 @@ For a complete list of commits, check out the `2.7.0`_ release on GitHub.
 .. _4.1.2: https://github.com/canonical/craft-application/releases/tag/4.1.2
 .. _4.2.0: https://github.com/canonical/craft-application/releases/tag/4.2.0
 .. _4.2.1: https://github.com/canonical/craft-application/releases/tag/4.2.1
+.. _4.2.2: https://github.com/canonical/craft-application/releases/tag/4.2.2
+.. _4.2.3: https://github.com/canonical/craft-application/releases/tag/4.2.3

{craft_application-4.2.1 → craft_application-4.2.3}/tests/unit/services/test_provider.py

@@ -84,41 +84,70 @@ def test_setup_proxy_environment(
 
 
 @pytest.mark.parametrize(
-    ("install_snap", "environment", "snaps"),
+    ("environment", "snaps"),
     [
-        (True, {}, [Snap(name="testcraft", channel="latest/stable", classic=True)]),
-        (
-            True,
+        pytest.param(
+            {},
+            [Snap(name="testcraft", channel="latest/stable", classic=True)],
+            id="install-from-store-default-channel",
+        ),
+        pytest.param(
             {"CRAFT_SNAP_CHANNEL": "something"},
             [Snap(name="testcraft", channel="something", classic=True)],
+            id="install-from-store-with-channel",
         ),
-        (
-            True,
-            {"SNAP_NAME": "testcraft", "SNAP": "/snap/testcraft/x1"},
-            [Snap(name="testcraft", channel=None, classic=True)],
+        pytest.param(
+            {
+                "SNAP_NAME": "testcraft",
+                "SNAP_INSTANCE_NAME": "testcraft_1",
+                "SNAP": "/snap/testcraft/x1",
+            },
+            [Snap(name="testcraft_1", channel=None, classic=True)],
+            id="inject-from-host",
         ),
-        (
-            True,
+        pytest.param(
             {
                 "SNAP_NAME": "testcraft",
+                "SNAP_INSTANCE_NAME": "testcraft_1",
                 "SNAP": "/snap/testcraft/x1",
                 "CRAFT_SNAP_CHANNEL": "something",
             },
+            [Snap(name="testcraft_1", channel=None, classic=True)],
+            id="inject-from-host-ignore-channel",
+        ),
+        pytest.param(
+            # SNAP_INSTANCE_NAME may not exist if snapd < 2.43 or feature is disabled
+            {
+                "SNAP_NAME": "testcraft",
+                "SNAP": "/snap/testcraft/x1",
+            },
             [Snap(name="testcraft", channel=None, classic=True)],
+            id="missing-snap-instance-name",
         ),
-        (False, {}, []),
-        (False, {"CRAFT_SNAP_CHANNEL": "something"}, []),
-        (
-            False,
+        pytest.param(
+            # SNAP_INSTANCE_NAME may not exist if snapd < 2.43 or feature is disabled
             {
                 "SNAP_NAME": "testcraft",
                 "SNAP": "/snap/testcraft/x1",
+                # CRAFT_SNAP_CHANNEL should be ignored
                 "CRAFT_SNAP_CHANNEL": "something",
             },
-            [],
+            [Snap(name="testcraft", channel=None, classic=True)],
+            id="missing-snap-instance-name-ignore-snap-channel",
+        ),
+        pytest.param(
+            # this can happen when running testcraft from a venv in a snapped terminal
+            {
+                "SNAP_NAME": "kitty",
+                "SNAP_INSTANCE_NAME": "kitty",
+                "SNAP": "/snap/kitty/x1",
+            },
+            [Snap(name="testcraft", channel="latest/stable", classic=True)],
+            id="running-inside-another-snap",
         ),
     ],
 )
+@pytest.mark.parametrize("install_snap", [True, False])
 def test_install_snap(
     monkeypatch,
     app_metadata,
@@ -143,7 +172,10 @@ def test_install_snap(
     )
     service.setup()
 
-    assert service.snaps == snaps
+    if install_snap:
+        assert service.snaps == snaps
+    else:
+        assert service.snaps == []
 
 
 @pytest.mark.parametrize(

{craft_application-4.2.1 → craft_application-4.2.3}/tests/unit/test_application.py

@@ -614,6 +614,38 @@ def test_run_managed_empty_plan(app, fake_project):
         app.run_managed(None, None)
 
 
+@pytest.mark.parametrize(
+    ("parsed_args", "environ", "item", "expected"),
+    [
+        (argparse.Namespace(), {}, "build_for", None),
+        (argparse.Namespace(build_for=None), {}, "build_for", None),
+        (
+            argparse.Namespace(build_for=None),
+            {"CRAFT_BUILD_FOR": "arm64"},
+            "build_for",
+            "arm64",
+        ),
+        (
+            argparse.Namespace(build_for=None),
+            {"TESTCRAFT_BUILD_FOR": "arm64"},
+            "build_for",
+            "arm64",
+        ),
+        (
+            argparse.Namespace(build_for="riscv64"),
+            {"TESTCRAFT_BUILD_FOR": "arm64"},
+            "build_for",
+            "riscv64",
+        ),
+    ],
+)
+def test_get_arg_or_config(monkeypatch, app, parsed_args, environ, item, expected):
+    for var, content in environ.items():
+        monkeypatch.setenv(var, content)
+
+    assert app.get_arg_or_config(parsed_args, item) == expected
+
+
 @pytest.mark.parametrize(
     ("managed", "error", "exit_code", "message"),
     [