craft-application 2.3.0__tar.gz → 2.4.0__tar.gz

{craft-application-2.3.0 → craft-application-2.4.0}/PKG-INFO

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

{craft-application-2.3.0 → craft-application-2.4.0}/craft_application/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.3.0'
-__version_tuple__ = version_tuple = (2, 3, 0)
+__version__ = version = '2.4.0'
+__version_tuple__ = version_tuple = (2, 4, 0)

{craft-application-2.3.0 → craft-application-2.4.0}/craft_application/launchpad/models/project.py

@@ -37,7 +37,7 @@ import launchpadlib.errors  # type: ignore[import-untyped]
 from typing_extensions import Self, Any
 from typing import TYPE_CHECKING
 
-from ..models.base import LaunchpadObject
+from ..models.base import InformationType, LaunchpadObject
 from .. import errors
 
 if TYPE_CHECKING:
@@ -64,6 +64,7 @@ class Project(LaunchpadObject):
     display_name: str
     summary: str
     description: str
+    information_type: InformationType
 
     @classmethod
     def new(  # pyright: ignore[reportIncompatibleMethodOverride]

{craft-application-2.3.0 → craft-application-2.4.0}/craft_application/services/remotebuild.py

@@ -62,6 +62,7 @@ class RemoteBuildService(base.AppService):
         self._repository: launchpad.models.GitRepository = None  # type: ignore[assignment]
         self._recipe: launchpad.models.recipe.BaseRecipe = None  # type: ignore[assignment]
         self._builds: Collection[launchpad.models.Build] = []
+        self._project_name: str | None = None
 
     def setup(self) -> None:
         """Set up the remote builder."""
@@ -69,6 +70,35 @@ class RemoteBuildService(base.AppService):
 
     # region Public API
     # Commands will call a subset of these methods, generally in order.
+    def set_project(self, name: str) -> None:
+        """Set the name of the project to use."""
+        if self._is_setup:
+            raise RuntimeError(
+                "Project name may only be set before starting or resuming builds."
+            )
+        try:
+            self._lp_project = self.lp.get_project(name)
+        except launchpad.errors.NotFoundError:
+            raise errors.CraftError(
+                message=f"Could not find project on Launchpad: {name}",
+                resolution="Ensure the project exists and that you have access to it.",
+                retcode=77,  # EX_NOPERM from sysexits.h
+                reportable=False,
+                logpath_report=False,
+            )
+        self._project_name = name
+
+    def is_project_private(self) -> bool:
+        """Check whether the named project is private."""
+        if not self._lp_project:
+            raise RuntimeError(
+                "Cannot check if the project is private before setting its name."
+            )
+        return self._lp_project.information_type not in (
+            launchpad.models.InformationType.PUBLIC,
+            launchpad.models.InformationType.PUBLIC_SECURITY,
+        )
+
     def set_timeout(self, seconds_in_future: int) -> None:
         """Set the deadline to a certain number of seconds in the future."""
         self._deadline = time.monotonic_ns() + (seconds_in_future * 10**9)
@@ -207,17 +237,16 @@ class RemoteBuildService(base.AppService):
 
     def _ensure_project(self) -> launchpad.models.Project:
         """Ensure that the user's remote build project exists."""
+        if self._lp_project:
+            return self._lp_project
         try:
-            return launchpad.models.Project.get(
-                self.lp, f"{self.lp.username}-craft-remote-build"
-            )
+            return self.lp.get_project(f"{self.lp.username}-craft-remote-build")
         except launchpad.errors.NotFoundError:
-            return launchpad.models.Project.new(
-                self.lp,
-                f"*craft remote builds for {self.lp.username}",
-                f"{self.lp.username}-craft-remote-build",
-                f"{self.lp.username} remote builds",
-                f"Automatically-generated project for housing {self.lp.username}'s remote builds in snapcraft, charmcraft, etc.",
+            return self.lp.new_project(
+                name=f"{self.lp.username}-craft-remote-build",
+                title=f"*craft remote builds for {self.lp.username}",
+                display_name=f"{self.lp.username} remote builds",
+                summary=f"Automatically-generated project for housing {self.lp.username}'s remote builds in snapcraft, charmcraft, etc.",
             )
 
     def _new_repository(

{craft-application-2.3.0 → craft-application-2.4.0}/craft_application.egg-info/PKG-INFO

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

{craft-application-2.3.0 → craft-application-2.4.0}/craft_application.egg-info/SOURCES.txt

@@ -109,6 +109,7 @@ tests/integration/launchpad/test_anonymous_access.py
 tests/integration/services/__init__.py
 tests/integration/services/test_lifecycle.py
 tests/integration/services/test_provider.py
+tests/integration/services/test_remotebuild.py
 tests/integration/services/test_request.py
 tests/integration/services/test_service_factory.py
 tests/unit/__init__.py

{craft-application-2.3.0 → craft-application-2.4.0}/tests/conftest.py

@@ -72,6 +72,18 @@ def features(request) -> dict[str, bool]:
     return features
 
 
+@pytest.fixture(scope="session")
+def default_app_metadata() -> craft_application.AppMetadata:
+    with pytest.MonkeyPatch.context() as m:
+        m.setattr(metadata, "version", lambda _: "3.14159")
+        return craft_application.AppMetadata(
+            "testcraft",
+            "A fake app for testing craft-application",
+            BuildPlannerClass=MyBuildPlanner,
+            source_ignore_patterns=["*.snap", "*.charm", "*.starcraft"],
+        )
+
+
 @pytest.fixture()
 def app_metadata(features) -> craft_application.AppMetadata:
     with pytest.MonkeyPatch.context() as m:

{craft-application-2.3.0 → craft-application-2.4.0}/tests/integration/conftest.py

@@ -18,9 +18,11 @@ import os
 import pathlib
 import sys
 import tempfile
+from unittest import mock
 
 import pytest
-from craft_application.services import provider
+from craft_application import launchpad
+from craft_application.services import provider, remotebuild
 from craft_providers import lxd, multipass
 
 
@@ -53,6 +55,14 @@ def provider_service(app_metadata, fake_project, fake_build_plan, fake_services)
     )
 
 
+@pytest.fixture(scope="session")
+def anonymous_remote_build_service(default_app_metadata):
+    """Provider service with install snap disabled for integration tests"""
+    service = remotebuild.RemoteBuildService(default_app_metadata, services=mock.Mock())
+    service.lp = launchpad.Launchpad.anonymous("testcraft")
+    return service
+
+
 @pytest.fixture()
 def snap_safe_tmp_path():
     """A temporary path accessible to snap-confined craft providers.

craft-application-2.4.0/tests/integration/services/test_remotebuild.py

@@ -0,0 +1,47 @@
+#  This file is part of craft-application.
+#
+#  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 warranties of MERCHANTABILITY,
+#  SATISFACTORY QUALITY, 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/>.
+"""Tests for the remote build service."""
+
+import pytest
+from craft_application import errors
+
+
+@pytest.fixture(scope="module", params=["charmcraft", "coreutils", "dpkg", "sudo"])
+def public_project_name(request):
+    return request.param
+
+
+def test_use_public_project(anonymous_remote_build_service, public_project_name):
+    """Test that we can get a real (public) project using an anonymous client."""
+    anonymous_remote_build_service.set_project(public_project_name)
+
+    assert anonymous_remote_build_service._lp_project.name == public_project_name
+
+
+def test_error_with_nonexistent_project(anonymous_remote_build_service):
+    """Test failing gracefully with a nonexistent project."""
+    name = "this launchpad project does not exist!"
+
+    with pytest.raises(
+        errors.CraftError, match=f"Could not find project on Launchpad: {name}"
+    ):
+        anonymous_remote_build_service.set_project(name)
+
+
+def test_project_is_public(anonymous_remote_build_service, public_project_name):
+    """Test that the given project is public."""
+    anonymous_remote_build_service.set_project(public_project_name)
+    assert not anonymous_remote_build_service.is_project_private()

{craft-application-2.3.0 → craft-application-2.4.0}/tests/unit/services/test_remotebuild.py

@@ -21,7 +21,7 @@ from unittest import mock
 import lazr.restfulclient.errors
 import lazr.restfulclient.resource
 import pytest
-from craft_application import launchpad
+from craft_application import errors, launchpad
 from craft_application.remote import git
 
 from tests.unit.services.conftest import (
@@ -41,6 +41,35 @@ def mock_lp_project(fake_launchpad, mock_project_entry):
     return launchpad.models.Project(fake_launchpad, mock_project_entry)
 
 
+@pytest.mark.parametrize("name", ["some-project", "another-project"])
+def test_set_project_success(remote_build_service, mock_project_entry, name):
+    mock_project_entry.name = name
+    remote_build_service.lp.lp.projects = {name: mock_project_entry}
+
+    remote_build_service.set_project(name)
+    project = remote_build_service._ensure_project()
+
+    assert project.name == name
+
+
+@pytest.mark.parametrize("name", ["some-project", "another-project"])
+def test_set_project_name_error(remote_build_service, mock_project_entry, name):
+    mock_project_entry.name = name
+    remote_build_service.lp.lp.projects.__getitem__.side_effect = (
+        lazr.restfulclient.errors.NotFound("yo", "dawg")
+    )
+
+    with pytest.raises(
+        errors.CraftError, match=f"Could not find project on Launchpad: {name}"
+    ) as exc_info:
+        remote_build_service.set_project(name)
+
+    assert (
+        exc_info.value.resolution
+        == "Ensure the project exists and that you have access to it."
+    )
+
+
 def test_ensure_project_existing(remote_build_service, mock_project_entry):
     remote_build_service.lp.lp.projects = {
         "craft_test_user-craft-remote-build": mock_project_entry
@@ -57,6 +86,35 @@ def test_ensure_project_new(remote_build_service):
     remote_build_service._ensure_project()
 
 
+@pytest.mark.parametrize(
+    ("information_type", "expected"),
+    [
+        (launchpad.models.InformationType.PUBLIC, False),
+        (launchpad.models.InformationType.PUBLIC_SECURITY, False),
+        (launchpad.models.InformationType.PRIVATE, True),
+        (launchpad.models.InformationType.PRIVATE_SECURITY, True),
+        (launchpad.models.InformationType.PROPRIETARY, True),
+        (launchpad.models.InformationType.EMBARGOED, True),
+    ],
+)
+def test_is_project_private(
+    remote_build_service, mock_project_entry, information_type, expected
+):
+    mock_project_entry.information_type = str(information_type.value)
+    remote_build_service.lp.lp.projects = {"test-project": mock_project_entry}
+
+    remote_build_service.set_project("test-project")
+    assert remote_build_service.is_project_private() == expected
+
+
+def test_is_project_private_error(remote_build_service):
+    with pytest.raises(
+        RuntimeError,
+        match="Cannot check if the project is private before setting its name.",
+    ):
+        remote_build_service.is_project_private()
+
+
 def test_new_repository(
     monkeypatch, tmp_path, remote_build_service, mock_lp_project, mock_push_url
 ):