craft-application 4.2.2__tar.gz → 4.2.4__tar.gz

{craft_application-4.2.2/craft_application.egg-info → craft_application-4.2.4}/PKG-INFO

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

{craft_application-4.2.2 → craft_application-4.2.4}/craft_application/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '4.2.2'
-__version_tuple__ = version_tuple = (4, 2, 2)
+__version__ = version = '4.2.4'
+__version_tuple__ = version_tuple = (4, 2, 4)

{craft_application-4.2.2 → craft_application-4.2.4}/craft_application/application.py

@@ -505,7 +505,10 @@ 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_inner(self) -> int:
         """Actual run implementation."""

craft_application-4.2.4/craft_application/remote/errors.py

@@ -0,0 +1,54 @@
+# Copyright 2023-2024 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Remote build errors."""
+
+import craft_cli.errors
+
+from craft_application.util import humanize_list
+
+
+class RemoteBuildError(craft_cli.errors.CraftError):
+    """Error for remote builds."""
+
+
+class RemoteBuildGitError(RemoteBuildError):
+    """Git repository cannot be prepared correctly.
+
+    :param message: Git error message.
+    """
+
+    def __init__(self, message: str) -> None:
+        message = f"Git operation failed with: {message}"
+        super().__init__(message=message)
+
+
+class UnsupportedArchitectureError(RemoteBuildError):
+    """Unsupported architecture error.
+
+    :param architectures: List of unsupported architectures.
+    """
+
+    def __init__(self, architectures: list[str]) -> None:
+        message = (
+            "The following architectures are not supported by the remote builder: "
+            f"{humanize_list(architectures, 'and')}."
+        )
+        resolution = "Remove them from the architecture list and try again."
+
+        super().__init__(message=message, resolution=resolution)
+
+
+class RemoteBuildInvalidGitRepoError(RemoteBuildError):
+    """The Git repository is invalid for remote build."""

{craft_application-4.2.2 → craft_application-4.2.4}/craft_application/remote/git.py

@@ -32,10 +32,12 @@ def check_git_repo_for_remote_build(path: Path) -> None:
 
     if git_type == GitType.INVALID:
         raise RemoteBuildInvalidGitRepoError(
-            f"Could not find a git repository in {str(path)!r}"
+            message=f"Could not find a git repository in {str(path)!r}",
+            resolution="Initialize a git repository in the project directory",
         )
 
     if git_type == GitType.SHALLOW:
         raise RemoteBuildInvalidGitRepoError(
-            "Remote build for shallow cloned git repos are no longer supported"
+            message="Remote builds for shallow cloned git repos are not supported",
+            resolution="Make a non-shallow clone of the repository",
         )

{craft_application-4.2.2 → craft_application-4.2.4}/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.2 → craft_application-4.2.4/craft_application.egg-info}/PKG-INFO

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

{craft_application-4.2.2 → craft_application-4.2.4}/craft_application.egg-info/SOURCES.txt

@@ -160,6 +160,7 @@ tests/unit/models/project_models/invalid_project.yaml
 tests/unit/remote/__init__.py
 tests/unit/remote/conftest.py
 tests/unit/remote/test_errors.py
+tests/unit/remote/test_git.py
 tests/unit/remote/test_utils.py
 tests/unit/remote/test_worktree.py
 tests/unit/services/__init__.py

{craft_application-4.2.2 → craft_application-4.2.4}/docs/reference/changelog.rst

@@ -2,6 +2,27 @@
 Changelog
 *********
 
+4.2.4 (2024-Sep-19)
+-------------------
+
+Remote build
+============
+
+- Remote build errors are now a subclass of ``CraftError``.
+
+For a complete list of commits, check out the `4.2.4`_ release on GitHub.
+
+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)
 -------------------
 
@@ -266,3 +287,5 @@ For a complete list of commits, check out the `2.7.0`_ release on GitHub.
 .. _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
+.. _4.2.4: https://github.com/canonical/craft-application/releases/tag/4.2.4

{craft_application-4.2.2 → craft_application-4.2.4}/tests/unit/git/test_git.py

@@ -894,6 +894,6 @@ def test_check_git_repo_for_remote_build_shallow(empty_working_directory):
 
     with pytest.raises(
         RemoteBuildInvalidGitRepoError,
-        match="Remote build for shallow cloned git repos are no longer supported",
+        match="Remote builds for shallow cloned git repos are not supported",
     ):
         check_git_repo_for_remote_build(git_shallow_path)

{craft_application-4.2.2 → craft_application-4.2.4}/tests/unit/remote/test_errors.py

@@ -15,25 +15,21 @@
 from craft_application.remote import errors
 
 
+def test_git_error():
+    """Test RemoteBuildGitError."""
+    error = errors.RemoteBuildGitError(message="failed to push some refs to 'unknown'")
+
+    assert (
+        str(error) == "Git operation failed with: failed to push some refs to 'unknown'"
+    )
+
+
 def test_unsupported_architecture_error():
     """Test UnsupportedArchitectureError."""
     error = errors.UnsupportedArchitectureError(architectures=["amd64", "arm64"])
 
     assert str(error) == (
-        "Architecture not supported by the remote builder.\nThe following "
-        "architectures are not supported by the remote builder: ['amd64', 'arm64'].\n"
-        "Please remove them from the architecture list and try again."
-    )
-    assert repr(error) == (
-        "UnsupportedArchitectureError(brief='Architecture not supported by the remote "
-        "builder.', details=\"The following architectures are not supported by the "
-        "remote builder: ['amd64', 'arm64'].\\nPlease remove them from the "
-        'architecture list and try again.")'
-    )
-
-    assert error.brief == "Architecture not supported by the remote builder."
-    assert error.details == (
         "The following architectures are not supported by the remote builder: "
-        "['amd64', 'arm64'].\nPlease remove them from the architecture list and "
-        "try again."
+        "'amd64' and 'arm64'."
     )
+    assert error.resolution == "Remove them from the architecture list and try again."

craft_application-4.2.4/tests/unit/remote/test_git.py

@@ -0,0 +1,57 @@
+# Copyright 2024 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Remote-build git tests."""
+
+import pytest
+from craft_application.git import GitType
+from craft_application.remote import errors, git
+
+
+@pytest.fixture
+def mock_get_git_repo_type(mocker):
+    return mocker.patch("craft_application.remote.git.get_git_repo_type")
+
+
+def test_git_normal(tmp_path, mock_get_git_repo_type):
+    """No-op for a normal git repo."""
+    mock_get_git_repo_type.return_value = GitType.NORMAL
+
+    assert git.check_git_repo_for_remote_build(tmp_path) is None
+
+
+def test_git_invalid_error(tmp_path, mock_get_git_repo_type):
+    """Raise an error for invalid git repos."""
+    mock_get_git_repo_type.return_value = GitType.INVALID
+
+    with pytest.raises(errors.RemoteBuildInvalidGitRepoError) as err:
+        git.check_git_repo_for_remote_build(tmp_path)
+
+    assert str(err.value) == f"Could not find a git repository in {str(tmp_path)!r}"
+    assert (
+        err.value.resolution == "Initialize a git repository in the project directory"
+    )
+
+
+def test_git_shallow_clone_error(tmp_path, mock_get_git_repo_type):
+    """Raise an error for shallowly cloned repos."""
+    mock_get_git_repo_type.return_value = GitType.SHALLOW
+
+    with pytest.raises(errors.RemoteBuildInvalidGitRepoError) as err:
+        git.check_git_repo_for_remote_build(tmp_path)
+
+    assert (
+        str(err.value) == "Remote builds for shallow cloned git repos are not supported"
+    )
+    assert err.value.resolution == "Make a non-shallow clone of the repository"

{craft_application-4.2.2 → craft_application-4.2.4}/tests/unit/remote/test_utils.py

@@ -25,6 +25,7 @@ from craft_application.remote import (
     validate_architectures,
 )
 from craft_application.remote.utils import _SUPPORTED_ARCHS
+from craft_application.util import humanize_list
 
 ###############################
 # validate architecture tests #
@@ -57,7 +58,7 @@ def test_validate_architectures_error(archs, expected_archs):
 
     assert (
         "The following architectures are not supported by the remote builder: "
-        f"{expected_archs}"
+        f"{humanize_list(expected_archs, 'and')}"
     ) in str(raised.value)
 
 

{craft_application-4.2.2 → craft_application-4.2.4}/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.2 → craft_application-4.2.4}/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"),
     [

craft_application-4.2.2/craft_application/remote/errors.py

@@ -1,76 +0,0 @@
-# Copyright 2023-2024 Canonical Ltd.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License version 3 as
-# published by the Free Software Foundation.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-"""Remote build errors."""
-
-from dataclasses import dataclass
-
-
-@dataclass(repr=True)
-class RemoteBuildError(Exception):
-    """Unexpected remote build error.
-
-    :param brief: Brief description of error.
-    :param details: Detailed information.
-    """
-
-    brief: str
-    details: str | None = None
-
-    def __str__(self) -> str:
-        """Return the string representation of the error."""
-        components = [self.brief]
-
-        if self.details:
-            components.append(self.details)
-
-        return "\n".join(components)
-
-
-class RemoteBuildGitError(RemoteBuildError):
-    """Git repository cannot be prepared correctly."""
-
-    def __init__(self, message: str) -> None:
-        self.message = message
-        brief = "Git operation failed"
-        details = message
-
-        super().__init__(brief=brief, details=details)
-
-
-class UnsupportedArchitectureError(RemoteBuildError):
-    """Unsupported architecture error."""
-
-    def __init__(self, architectures: list[str]) -> None:
-        brief = "Architecture not supported by the remote builder."
-        details = (
-            "The following architectures are not supported by the remote builder: "
-            f"{architectures}.\nPlease remove them from the "
-            "architecture list and try again."
-        )
-
-        super().__init__(brief=brief, details=details)
-
-
-class RemoteBuildInvalidGitRepoError(RemoteBuildError):
-    """The Git repository is invalid for remote build.
-
-    :param brief: Brief description of error.
-    :param details: Detailed information.
-    """
-
-    def __init__(self, details: str) -> None:
-        brief = "The Git repository is invalid for remote build."
-
-        super().__init__(brief=brief, details=details)