craft-application 2.0.0__tar.gz → 2.2.0__tar.gz

{craft-application-2.0.0 → craft-application-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: craft-application
-Version: 2.0.0
+Version: 2.2.0
 Summary: A framework for *craft applications.
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
@@ -35,7 +35,7 @@ Requires-Dist: hypothesis>=6.0; extra == "dev"
 Requires-Dist: pyfakefs~=5.3; extra == "dev"
 Requires-Dist: pytest==8.1.1; extra == "dev"
 Requires-Dist: pytest-check==2.3.1; extra == "dev"
-Requires-Dist: pytest-cov==4.1.0; extra == "dev"
+Requires-Dist: pytest-cov==5.0.0; extra == "dev"
 Requires-Dist: pytest-mock==3.12.0; extra == "dev"
 Requires-Dist: pytest-rerunfailures==13.0; extra == "dev"
 Requires-Dist: pytest-time>=0.3.1; extra == "dev"

{craft-application-2.0.0 → craft-application-2.2.0}/craft_application/__init__.py

@@ -32,7 +32,7 @@ except ImportError:  # pragma: no cover
     from importlib.metadata import version, PackageNotFoundError
 
     try:
-        __version__ = version("craft-archives")
+        __version__ = version("craft-application")
     except PackageNotFoundError:
         __version__ = "dev"
 

{craft-application-2.0.0 → craft-application-2.2.0}/craft_application/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.0.0'
-__version_tuple__ = version_tuple = (2, 0, 0)
+__version__ = version = '2.2.0'
+__version_tuple__ = version_tuple = (2, 2, 0)

{craft-application-2.0.0 → craft-application-2.2.0}/craft_application/application.py

@@ -125,6 +125,7 @@ class Application:
         self._command_groups: list[craft_cli.CommandGroup] = []
         self._global_arguments: list[craft_cli.GlobalArgument] = [GLOBAL_VERSION]
         self._cli_loggers = DEFAULT_CLI_LOGGERS | set(extra_loggers)
+        self._full_build_plan: list[models.BuildInfo] = []
         self._build_plan: list[models.BuildInfo] = []
         # When build_secrets are enabled, this contains the secret info to pass to
         # managed instances.
@@ -235,6 +236,7 @@ class Application:
         """
         if project_dir is None:
             project_dir = self.project_dir
+
         return (project_dir / f"{self.app.name}.yaml").resolve(strict=True)
 
     def get_project(
@@ -255,18 +257,29 @@ class Application:
         if self.__project is not None:
             return self.__project
 
-        project_path = self._resolve_project_path(self.project_dir)
+        try:
+            project_path = self._resolve_project_path(self.project_dir)
+        except FileNotFoundError as err:
+            raise errors.ProjectFileMissingError(
+                f"Project file '{self.app.name}.yaml' not found in '{self.project_dir}'.",
+                details="The project file could not be found.",
+                resolution="Ensure the project file exists.",
+                retcode=66,  # EX_NOINPUT from sysexits.h
+            ) from err
         craft_cli.emit.debug(f"Loading project file '{project_path!s}'")
 
         with project_path.open() as file:
             yaml_data = util.safe_yaml_load(file)
 
+        host_arch = util.get_host_architecture()
         build_planner = self.app.BuildPlannerClass.unmarshal(yaml_data)
-        full_build_plan = build_planner.get_build_plan()
-        self._build_plan = _filter_plan(full_build_plan, platform, build_for)
+        self._full_build_plan = build_planner.get_build_plan()
+        self._build_plan = filter_plan(
+            self._full_build_plan, platform, build_for, host_arch
+        )
 
-        if platform:
-            all_platforms = {b.platform: b for b in full_build_plan}
+        if platform and not build_for:
+            all_platforms = {b.platform: b for b in self._full_build_plan}
             if platform not in all_platforms:
                 raise errors.InvalidPlatformError(platform, list(all_platforms.keys()))
             build_for = all_platforms[platform].build_for
@@ -274,7 +287,7 @@ class Application:
         # validate project grammar
         GrammarAwareProject.validate_grammar(yaml_data)
 
-        build_on = util.get_host_architecture()
+        build_on = host_arch
         yaml_data = self._transform_project_yaml(yaml_data, build_on, build_for)
         self.__project = self.app.ProjectClass.from_yaml_data(yaml_data, project_path)
 
@@ -310,7 +323,10 @@ class Application:
             if build_for and build_for != build_info.build_for:
                 continue
 
-            env = {"CRAFT_PLATFORM": build_info.platform}
+            env = {
+                "CRAFT_PLATFORM": build_info.platform,
+                "CRAFT_VERBOSITY_LEVEL": craft_cli.emit.get_mode().name,
+            }
 
             if self.app.features.build_secrets:
                 # If using build secrets, put them in the environment of the managed
@@ -351,12 +367,7 @@ class Application:
 
         :returns: A ready-to-run Dispatcher object
         """
-        dispatcher = craft_cli.Dispatcher(
-            self.app.name,
-            self.command_groups,
-            summary=str(self.app.summary),
-            extra_global_args=self._global_arguments,
-        )
+        dispatcher = self._create_dispatcher()
 
         try:
             craft_cli.emit.trace("pre-parsing arguments...")
@@ -371,8 +382,8 @@ class Application:
                 global_args = dispatcher.pre_parse_args(sys.argv[1:])
 
             if global_args.get("version"):
+                craft_cli.emit.message(f"{self.app.name} {self.app.version}")
                 craft_cli.emit.ended_ok()
-                print(f"{self.app.name} {self.app.version}")
                 sys.exit(0)
         except craft_cli.ProvideHelpException as err:
             print(err, file=sys.stderr)  # to stderr, as argparse normally does
@@ -400,6 +411,19 @@ class Application:
 
         return dispatcher
 
+    def _create_dispatcher(self) -> craft_cli.Dispatcher:
+        """Create the Dispatcher that will run the application's command.
+
+        Subclasses can override this if they need to create a Dispatcher with
+        different parameters.
+        """
+        return craft_cli.Dispatcher(
+            self.app.name,
+            self.command_groups,
+            summary=str(self.app.summary),
+            extra_global_args=self._global_arguments,
+        )
+
     def _get_app_plugins(self) -> dict[str, PluginType]:
         """Get the plugins for this application.
 
@@ -490,6 +514,7 @@ class Application:
             return_code = 128 + signal.SIGINT
         except craft_cli.CraftError as err:
             self._emit_error(err)
+            return_code = err.retcode
         except craft_parts.PartsError as err:
             self._emit_error(
                 craft_cli.CraftError(
@@ -549,7 +574,20 @@ class Application:
             self._render_secrets(yaml_data)
 
         # Expand grammar.
-        if build_for and "parts" in yaml_data:
+        if "parts" in yaml_data:
+            if not build_for:
+                # At the moment there is no perfect solution for what do to do
+                # resolve the grammar if there's no explicitly-provided target
+                # arch. However, we must resolve it with *something* otherwise
+                # we might have an invalid parts definition full of grammar
+                # declarations.
+                if self._build_plan:
+                    # If we have a build plan use one of its items, because
+                    # it's likely contemplated on the grammar.
+                    build_for = self._build_plan[0].build_for
+                else:
+                    # As a last resort, default to the same arch as the host.
+                    build_for = build_on
             craft_cli.emit.debug(f"Processing grammar (on {build_on} for {build_for})")
             yaml_data["parts"] = grammar.process_parts(
                 parts_yaml_data=yaml_data["parts"],
@@ -623,32 +661,69 @@ class Application:
         # Set the logging level to DEBUG for all craft-libraries. This is OK even if
         # the specific application doesn't use a specific library, the call does not
         # import the package.
+        emitter_mode: craft_cli.EmitterMode = craft_cli.EmitterMode.BRIEF
+        invalid_emitter_level = False
         util.setup_loggers(*self._cli_loggers)
 
+        # environment variable takes precedence over the default
+        emitter_verbosity_level_env = os.environ.get("CRAFT_VERBOSITY_LEVEL", None)
+
+        if emitter_verbosity_level_env:
+            try:
+                emitter_mode = craft_cli.EmitterMode[
+                    emitter_verbosity_level_env.strip().upper()
+                ]
+            except KeyError:
+                invalid_emitter_level = True
+
         craft_cli.emit.init(
-            mode=craft_cli.EmitterMode.BRIEF,
+            mode=emitter_mode,
             appname=self.app.name,
             greeting=f"Starting {self.app.name}, version {self.app.version}",
             log_filepath=self.log_path,
             streaming_brief=True,
         )
 
+        craft_cli.emit.debug(f"Log verbosity level set to {emitter_mode.name}")
+
+        if invalid_emitter_level:
+            craft_cli.emit.progress(
+                f"Invalid verbosity level '{emitter_verbosity_level_env}', using default 'BRIEF'.\n"
+                f"Valid levels are: {', '.join(emitter.name for emitter in craft_cli.EmitterMode)}",
+                permanent=True,
+            )
+
 
-def _filter_plan(
+def filter_plan(
     build_plan: list[BuildInfo],
     platform: str | None,
     build_for: str | None,
+    host_arch: str | None,
 ) -> list[BuildInfo]:
-    """Filter out builds not matching build-on and build-for."""
-    host_arch = util.get_host_architecture()
+    """Filter out build plans that are not matching build-on, build-for, and platform.
+
+    If the host_arch is None, ignore the build-on check for remote builds.
+    """
+    new_plan_matched_build_for: list[BuildInfo] = []
+    new_plan_matched_platform_name: list[BuildInfo] = []
 
-    plan: list[BuildInfo] = []
     for build_info in build_plan:
-        platform_matches = not platform or build_info.platform == platform
-        build_on_matches = build_info.build_on == host_arch
-        build_for_matches = not build_for or build_info.build_for == build_for
+        if platform and build_info.platform != platform:
+            continue
+
+        if host_arch and build_info.build_on != host_arch:
+            continue
+
+        if build_for and build_info.build_for != build_for:
+            continue
+
+        if build_for and build_info.platform == build_for:
+            # prioritize platform name if matched build_for
+            new_plan_matched_platform_name.append(build_info)
+            continue
 
-        if platform_matches and build_on_matches and build_for_matches:
-            plan.append(build_info)
+        new_plan_matched_build_for.append(build_info)
 
-    return plan
+    if new_plan_matched_platform_name:
+        return new_plan_matched_platform_name
+    return new_plan_matched_build_for

{craft-application-2.0.0 → craft-application-2.2.0}/craft_application/errors.py

@@ -126,7 +126,7 @@ class EmptyBuildPlanError(CraftError):
 
     def __init__(self) -> None:
         message = "No build matches the current platform."
-        resolution = 'Check the "--platform" parameter.'
+        resolution = 'Check the "--platform" and "--build-for" parameters.'
 
         super().__init__(message=message, resolution=resolution)
 
@@ -136,7 +136,7 @@ class MultipleBuildsError(CraftError):
 
     def __init__(self) -> None:
         message = "Multiple builds match the current platform."
-        resolution = 'Check the "--platform" parameter.'
+        resolution = 'Check the "--platform" and "--bulld-for" parameters.'
 
         super().__init__(message=message, resolution=resolution)
 

{craft-application-2.0.0 → craft-application-2.2.0}/craft_application/launchpad/models/recipe.py

@@ -34,6 +34,7 @@ from collections.abc import Collection, Iterable
 from typing import TYPE_CHECKING
 
 import lazr.restfulclient.errors  # type: ignore[import-untyped]
+from craft_cli import emit
 from typing_extensions import Any, Self, TypedDict, override
 
 from .. import errors, util
@@ -43,6 +44,8 @@ from .base import LaunchpadObject, Pocket
 if TYPE_CHECKING:
     from .. import Launchpad
 
+_ATTEMPT_COUNT = 4
+
 
 class RecipeType(enum.Enum):
     """The type of recipe."""
@@ -244,13 +247,31 @@ class SnapRecipe(_StoreRecipe):
                 "An auto-build archive may only be provided if auto-build is enabled.",
             )
 
-        snap_entry = lp.lp.snaps.new(
-            name=name,
-            owner=util.get_person_link(owner),
-            store_upload=bool(store_name),
-            auto_build=auto_build,
-            **kwargs,
-        )
+        snap_entry = None
+
+        for attempt in range(_ATTEMPT_COUNT):
+            emit.debug(
+                f"Trying to create snap recipe {name!r} (attempt {attempt + 1}/{_ATTEMPT_COUNT})"
+            )
+            try:
+                snap_entry = lp.lp.snaps.new(
+                    name=name,
+                    owner=util.get_person_link(owner),
+                    store_upload=bool(store_name),
+                    auto_build=auto_build,
+                    **kwargs,
+                )
+            except lazr.restfulclient.errors.BadRequest as err:
+                emit.debug(str(err))
+                if attempt >= _ATTEMPT_COUNT - 1:
+                    raise
+                time.sleep(3)
+                continue
+            else:
+                break
+
+        if not snap_entry:
+            raise ValueError("Failed to create snap recipe")
 
         return cls(lp, lp_obj=snap_entry)
 
@@ -370,13 +391,31 @@ class CharmRecipe(_StoreRecipe):
         )
         cls._fill_repo_info(kwargs, git_ref=git_ref)
 
-        charm_entry = lp.lp.charm_recipes.new(
-            name=name,
-            owner=util.get_person_link(owner),
-            project=f"/{project}",
-            auto_build=auto_build,
-            **kwargs,
-        )
+        charm_entry = None
+
+        for attempt in range(_ATTEMPT_COUNT):
+            emit.debug(
+                f"Trying to create charm recipe {name!r} (attempt {attempt + 1}/{_ATTEMPT_COUNT})"
+            )
+            try:
+                charm_entry = lp.lp.charm_recipes.new(
+                    name=name,
+                    owner=util.get_person_link(owner),
+                    project=f"/{project}",
+                    auto_build=auto_build,
+                    **kwargs,
+                )
+            except lazr.restfulclient.errors.BadRequest as err:
+                emit.debug(str(err))
+                if attempt >= _ATTEMPT_COUNT - 1:
+                    raise
+                time.sleep(3)
+                continue
+            else:
+                break
+
+        if not charm_entry:
+            raise ValueError("Failed to create charm recipe")
 
         return cls(lp, charm_entry)
 

{craft-application-2.0.0 → craft-application-2.2.0}/craft_application/services/package.py

@@ -57,6 +57,9 @@ class PackageService(base.ProjectService):
         emit.debug(f"Update project variables: {update_vars}")
         self._project.__dict__.update(update_vars)
 
+        # Give subclasses a chance to update the project with their own logic
+        self._extra_project_updates()
+
         unset_fields = [
             field
             for field in self._app.mandatory_adoptable_fields
@@ -78,3 +81,6 @@ class PackageService(base.ProjectService):
         """
         path.mkdir(parents=True, exist_ok=True)
         self.metadata.to_yaml_file(path / "metadata.yaml")
+
+    def _extra_project_updates(self) -> None:
+        """Perform domain-specific updates to the project before packing."""

{craft-application-2.0.0 → craft-application-2.2.0}/craft_application/util/yaml.py

@@ -132,6 +132,7 @@ def dump_yaml(data: Any, stream: TextIO | None = None, **kwargs: Any) -> str | N
         str, _repr_str, Dumper=cast(type[yaml.Dumper], yaml.SafeDumper)
     )
     kwargs.setdefault("sort_keys", False)
+    kwargs.setdefault("allow_unicode", True)
     return cast(  # This cast is needed for pyright but not mypy
         str | None, yaml.dump(data, stream, Dumper=yaml.SafeDumper, **kwargs)
     )

{craft-application-2.0.0 → craft-application-2.2.0}/craft_application.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: craft-application
-Version: 2.0.0
+Version: 2.2.0
 Summary: A framework for *craft applications.
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
@@ -35,7 +35,7 @@ Requires-Dist: hypothesis>=6.0; extra == "dev"
 Requires-Dist: pyfakefs~=5.3; extra == "dev"
 Requires-Dist: pytest==8.1.1; extra == "dev"
 Requires-Dist: pytest-check==2.3.1; extra == "dev"
-Requires-Dist: pytest-cov==4.1.0; extra == "dev"
+Requires-Dist: pytest-cov==5.0.0; extra == "dev"
 Requires-Dist: pytest-mock==3.12.0; extra == "dev"
 Requires-Dist: pytest-rerunfailures==13.0; extra == "dev"
 Requires-Dist: pytest-time>=0.3.1; extra == "dev"

{craft-application-2.0.0 → craft-application-2.2.0}/craft_application.egg-info/SOURCES.txt

@@ -99,6 +99,10 @@ tests/integration/data/valid_projects/basic/stderr
 tests/integration/data/valid_projects/basic/testcraft.yaml
 tests/integration/data/valid_projects/environment/stderr
 tests/integration/data/valid_projects/environment/testcraft.yaml
+tests/integration/data/valid_projects/grammar/stderr
+tests/integration/data/valid_projects/grammar/testcraft.yaml
+tests/integration/data/valid_projects/grammar/src/on-amd64-to-amd64/hello.txt
+tests/integration/data/valid_projects/grammar/src/on-amd64-to-arm64/hello.txt
 tests/integration/launchpad/__init__.py
 tests/integration/launchpad/conftest.py
 tests/integration/launchpad/test_anonymous_access.py

{craft-application-2.0.0 → craft-application-2.2.0}/craft_application.egg-info/requires.txt

@@ -22,7 +22,7 @@ hypothesis>=6.0
 pyfakefs~=5.3
 pytest==8.1.1
 pytest-check==2.3.1
-pytest-cov==4.1.0
+pytest-cov==5.0.0
 pytest-mock==3.12.0
 pytest-rerunfailures==13.0
 pytest-time>=0.3.1

{craft-application-2.0.0 → craft-application-2.2.0}/pyproject.toml

@@ -50,7 +50,7 @@ dev = [
     "pyfakefs~=5.3",
     "pytest==8.1.1",
     "pytest-check==2.3.1",
-    "pytest-cov==4.1.0",
+    "pytest-cov==5.0.0",
     "pytest-mock==3.12.0",
     "pytest-rerunfailures==13.0",
     "pytest-time>=0.3.1",

craft-application-2.2.0/tests/integration/data/valid_projects/grammar/src/on-amd64-to-amd64/hello.txt

@@ -0,0 +1 @@
+on-amd64-to-amd64

craft-application-2.2.0/tests/integration/data/valid_projects/grammar/src/on-amd64-to-arm64/hello.txt

@@ -0,0 +1 @@
+on-amd64-to-arm64

craft-application-2.2.0/tests/integration/data/valid_projects/grammar/stderr

@@ -0,0 +1 @@
+Packed package_1.0.tar.zst

craft-application-2.2.0/tests/integration/data/valid_projects/grammar/testcraft.yaml

@@ -0,0 +1,11 @@
+name: empty
+title: A most basic project
+version: 1.0
+base: ["ubuntu", "22.04"]
+
+parts:
+  hello-world:
+    plugin: dump
+    source:
+      - on amd64 to amd64: src/on-amd64-to-amd64
+      - on amd64 to arm64: src/on-amd64-to-arm64

{craft-application-2.0.0 → craft-application-2.2.0}/tests/integration/test_application.py

@@ -103,7 +103,7 @@ INVALID_PROJECTS_DIR = TEST_DATA_DIR / "invalid_projects"
         (["-h"], "", BASIC_USAGE, 0),
         (["--version"], VERSION_INFO, "", 0),
         (["-V"], VERSION_INFO, "", 0),
-        (["-q", "--version"], VERSION_INFO, "", 0),
+        (["-q", "--version"], "", "", 0),
         (["--invalid-parameter"], "", BASIC_USAGE, 64),
         (["non-command"], "", INVALID_COMMAND, 64),
     ],
@@ -214,15 +214,15 @@ def test_non_lifecycle_command_does_not_require_project(monkeypatch, app):
 
 
 @pytest.mark.parametrize("cmd", ["clean", "pull", "build", "stage", "prime", "pack"])
-def test_run_always_load_project(monkeypatch, app, cmd):
+def test_run_always_load_project(capsys, monkeypatch, app, cmd):
     """Run a lifecycle command without having a project shall fail."""
     monkeypatch.setenv("CRAFT_DEBUG", "1")
     monkeypatch.setattr("sys.argv", ["testcraft", cmd])
 
-    with pytest.raises(FileNotFoundError) as raised:
-        app.run()
+    assert app.run() == 66  # noqa: PLR2004
 
-    assert str(raised.value).endswith("/testcraft.yaml'") is True
+    captured = capsys.readouterr()
+    assert "'testcraft.yaml' not found" in captured.err
 
 
 @pytest.mark.parametrize("help_param", ["-h", "--help"])

{craft-application-2.0.0 → craft-application-2.2.0}/tests/unit/launchpad/test_launchpad.py

@@ -22,9 +22,11 @@ from unittest import mock
 
 import launchpadlib.launchpad
 import launchpadlib.uris
+import lazr.restfulclient.errors
 import pytest
 from craft_application import launchpad
 from craft_application.launchpad import models
+from lazr.restfulclient.resource import Entry
 
 
 def flatten_enum(e: type[enum.Enum]) -> list:
@@ -180,6 +182,36 @@ def test_get_recipe_snap(fake_launchpad, type_, owner):
     )
 
 
+def test_recipe_snap_new_retry(emitter, mocker):
+    """Test that a SnapRecipe is retried when it fails to create."""
+    mocker.patch("time.sleep")
+    response = mocker.Mock(
+        status=400, reason="Bad Request", items=mocker.Mock(return_value=[])
+    )
+    mock_launchpad = mock.Mock()
+
+    mock_entry = mock.Mock(spec=Entry)
+    mock_entry.resource_type_link = "http://blah/#snap"
+    mock_entry.name = "test-snap"
+
+    mock_launchpad.lp.snaps.new = mock.Mock(
+        side_effect=[
+            lazr.restfulclient.errors.BadRequest(response=response, content=""),
+            mock_entry,
+        ]
+    )
+
+    recipe = launchpad.models.SnapRecipe.new(
+        mock_launchpad, "my_recipe", "test_user", git_ref="my_ref"
+    )
+
+    assert isinstance(recipe, models.SnapRecipe)
+    assert mock_launchpad.lp.snaps.new.call_count == 2  # noqa: PLR2004
+
+    emitter.assert_debug("Trying to create snap recipe 'my_recipe' (attempt 1/4)")
+    emitter.assert_debug("Trying to create snap recipe 'my_recipe' (attempt 2/4)")
+
+
 @pytest.mark.parametrize("type_", ["charm", "Charm", models.RecipeType.CHARM])
 def test_get_recipe_charm(fake_launchpad, type_):
     with mock.patch("craft_application.launchpad.models.CharmRecipe.get") as mock_get:
@@ -200,6 +232,36 @@ def test_get_recipe_charm_has_project(fake_launchpad):
         fake_launchpad.get_recipe(models.RecipeType.CHARM, "my_recipe")
 
 
+def test_recipe_charm_new_retry(emitter, mocker):
+    """Test that a CharmRecipe is retried when it fails to create."""
+    mocker.patch("time.sleep")
+    response = mocker.Mock(
+        status=400, reason="Bad Request", items=mocker.Mock(return_value=[])
+    )
+
+    mock_entry = mock.Mock(spec=Entry)
+    mock_entry.resource_type_link = "http://whatever/#charm_recipe"
+    mock_entry.name = "test-charm"
+
+    mock_launchpad = mock.Mock()
+    mock_launchpad.lp.charm_recipes.new = mock.Mock(
+        side_effect=[
+            lazr.restfulclient.errors.BadRequest(response=response, content=""),
+            mock_entry,
+        ]
+    )
+
+    recipe = launchpad.models.CharmRecipe.new(
+        mock_launchpad, "my_recipe", "test_user", "test_project", git_ref="my_ref"
+    )
+
+    assert isinstance(recipe, models.CharmRecipe)
+    assert mock_launchpad.lp.charm_recipes.new.call_count == 2  # noqa: PLR2004
+
+    emitter.assert_debug("Trying to create charm recipe 'my_recipe' (attempt 1/4)")
+    emitter.assert_debug("Trying to create charm recipe 'my_recipe' (attempt 2/4)")
+
+
 @pytest.mark.parametrize(
     ("name", "owner", "project", "path"),
     [