craft-application 2.6.2__tar.gz → 2.6.3__tar.gz

{craft_application-2.6.2 → craft_application-2.6.3}/PKG-INFO

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

{craft_application-2.6.2 → craft_application-2.6.3}/craft_application/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.6.2'
-__version_tuple__ = version_tuple = (2, 6, 2)
+__version__ = version = '2.6.3'
+__version_tuple__ = version_tuple = (2, 6, 3)

{craft_application-2.6.2 → craft_application-2.6.3}/craft_application/application.py

@@ -280,11 +280,18 @@ class Application:
             self._full_build_plan, platform, build_for, host_arch
         )
 
-        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
+        if not build_for:
+            # get the build-for arch from the platform
+            if platform:
+                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
+            # otherwise get the build-for arch from the build plan
+            elif self._build_plan:
+                build_for = self._build_plan[0].build_for
 
         # validate project grammar
         GrammarAwareProject.validate_grammar(yaml_data)
@@ -576,34 +583,29 @@ class Application:
         Performs task such as environment expansion. Note that this transforms
         ``yaml_data`` in-place.
         """
+        # apply application-specific transformations first because an application may
+        # add advanced grammar, project variables, or secrets to the yaml
+        yaml_data = self._extra_yaml_transform(
+            yaml_data, build_on=build_on, build_for=build_for
+        )
+
+        # At the moment there is no perfect solution for what do to do
+        # expand project variables or to 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 and incorrect build_for
+        # architectures.
+        build_for = build_for or build_on
+
         # Perform variable expansion.
-        self._expand_environment(yaml_data)
+        self._expand_environment(yaml_data=yaml_data, build_for=build_for)
 
         # Handle build secrets.
         if self.app.features.build_secrets:
             self._render_secrets(yaml_data)
 
-        # apply application-specific transformations before expanding grammar
-        # because an application may add advanced grammar to the yaml
-        yaml_data = self._extra_yaml_transform(
-            yaml_data, build_on=build_on, build_for=build_for
-        )
-
         # Expand grammar.
         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"],
@@ -613,8 +615,12 @@ class Application:
 
         return yaml_data
 
-    def _expand_environment(self, yaml_data: dict[str, Any]) -> None:
-        """Perform expansion of project environment variables."""
+    def _expand_environment(self, yaml_data: dict[str, Any], build_for: str) -> None:
+        """Perform expansion of project environment variables.
+
+        :param yaml_data: The project's yaml data.
+        :param build_for: The architecture to build for.
+        """
         environment_vars = self._get_project_vars(yaml_data)
         project_dirs = craft_parts.ProjectDirs(
             work_dir=self._work_dir, partitions=self._partitions
@@ -623,6 +629,7 @@ class Application:
         info = craft_parts.ProjectInfo(
             application_name=self.app.name,  # not used in environment expansion
             cache_dir=pathlib.Path(),  # not used in environment expansion
+            arch=util.convert_architecture_deb_to_platform(build_for),
             project_name=yaml_data.get("name", ""),
             project_dirs=project_dirs,
             project_vars=environment_vars,

{craft_application-2.6.2 → craft_application-2.6.3}/craft_application/services/lifecycle.py

@@ -263,7 +263,7 @@ class LifecycleService(base.ProjectService):
             raise RuntimeError(f"Parts processing internal error: {err}") from err
         except OSError as err:
             raise errors.PartsLifecycleError.from_os_error(err) from err
-        except Exception as err:  # noqa: BLE001 - Converting general error.
+        except Exception as err:
             raise errors.PartsLifecycleError(f"Unknown error: {str(err)}") from err
 
     def post_prime(self, step_info: StepInfo) -> bool:

{craft_application-2.6.2 → craft_application-2.6.3}/craft_application.egg-info/PKG-INFO

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

craft_application-2.6.3/tests/integration/data/valid_projects/environment/testcraft.yaml

@@ -0,0 +1,18 @@
+name: environment-project
+summary: A project with environment variables
+version: 1.0
+base: ["ubuntu", "22.04"]
+
+parts:
+  my-part:
+    plugin: nil
+    override-build: |
+        target_file=${CRAFT_PART_INSTALL}/variables.yaml
+        touch $target_file
+        echo "project_name:           \"${CRAFT_PROJECT_NAME}\""           >> $target_file
+        echo "project_dir:            \"${CRAFT_PROJECT_DIR}\""            >> $target_file
+        echo "project_version:        \"${CRAFT_PROJECT_VERSION}\""        >> $target_file
+        echo "arch_build_for:         \"${CRAFT_ARCH_BUILD_FOR}\""         >> $target_file
+        echo "arch_triplet_build_for: \"${CRAFT_ARCH_TRIPLET_BUILD_FOR}\"" >> $target_file
+        echo "arch_build_on:          \"${CRAFT_ARCH_BUILD_ON}\""         >> $target_file
+        echo "arch_triplet_build_on:  \"${CRAFT_ARCH_TRIPLET_BUILD_ON}\"" >> $target_file

{craft_application-2.6.2 → craft_application-2.6.3}/tests/integration/test_application.py

@@ -21,10 +21,12 @@ import craft_application
 import craft_cli
 import pytest
 import pytest_check
-from craft_application import secrets, util
+from craft_application import models, secrets, util
 from craft_application.util import yaml
 from typing_extensions import override
 
+from tests.conftest import MyBuildPlanner
+
 
 class TestableApplication(craft_application.Application):
     """An application modified for integration tests.
@@ -267,8 +269,18 @@ def test_invalid_command_argument(monkeypatch, capsys, app):
     assert stderr == expected_stderr
 
 
+@pytest.mark.parametrize(
+    "arguments",
+    [
+        [],
+        ["--build-for", "s390x"],
+        ["--platform", "my-platform"],
+    ],
+)
 def test_global_environment(
+    arguments,
     create_app,
+    mocker,
     monkeypatch,
     tmp_path,
 ):
@@ -276,8 +288,24 @@ def test_global_environment(
     monkeypatch.chdir(tmp_path)
     shutil.copytree(VALID_PROJECTS_DIR / "environment", tmp_path, dirs_exist_ok=True)
 
+    # a build plan that builds for s390x (a cross-compiling scenario unless on s390x)
+    mocker.patch.object(
+        MyBuildPlanner,
+        "get_build_plan",
+        return_value=[
+            models.BuildInfo(
+                platform="my-platform",
+                build_on=util.get_host_architecture(),
+                build_for="s390x",
+                base=util.get_host_base(),
+            ),
+        ],
+    )
+
     # Run in destructive mode
-    monkeypatch.setattr("sys.argv", ["testcraft", "prime", "--destructive-mode"])
+    monkeypatch.setattr(
+        "sys.argv", ["testcraft", "prime", "--destructive-mode", *arguments]
+    )
     app = create_app()
     app.run()
 
@@ -291,6 +319,13 @@ def test_global_environment(
     assert variables["project_name"] == "environment-project"
     assert variables["project_dir"] == str(tmp_path)
     assert variables["project_version"] == "1.0"
+    assert variables["arch_build_for"] == "s390x"
+    assert variables["arch_triplet_build_for"] == "s390x-linux-gnu"
+    assert variables["arch_build_on"] == "amd64"
+    # craft-application doesn't have utility for getting arch triplets
+    assert variables["arch_triplet_build_on"].startswith(
+        util.convert_architecture_deb_to_platform(util.get_host_architecture())
+    )
 
 
 @pytest.fixture()

{craft_application-2.6.2 → craft_application-2.6.3}/tests/unit/services/test_lifecycle.py

@@ -96,7 +96,7 @@ def test_get_parts_action_message_run(step: Step, message: str):
 
     actual = lifecycle._get_parts_action_message(action)
 
-    assert actual == message, "Unexpected %r" % actual
+    assert actual == message, f"Unexpected {actual!r}"
 
 
 @pytest.mark.parametrize(
@@ -118,7 +118,7 @@ def test_get_parts_re_action_message_run(step: Step, message: str):
 
     actual = lifecycle._get_parts_action_message(action)
 
-    assert actual == message, "Unexpected %r" % actual
+    assert actual == message, f"Unexpected {actual!r}"
 
 
 @pytest.mark.parametrize(
@@ -140,7 +140,7 @@ def test_get_parts_skip_action_message_run(step: Step, message: str):
 
     actual = lifecycle._get_parts_action_message(action)
 
-    assert actual == message, "Unexpected %r" % actual
+    assert actual == message, f"Unexpected {actual!r}"
 
 
 @pytest.mark.parametrize(
@@ -160,7 +160,7 @@ def test_get_parts_update_action_message_run(step: Step, message: str):
 
     actual = lifecycle._get_parts_action_message(action)
 
-    assert actual == message, "Unexpected %r" % actual
+    assert actual == message, f"Unexpected {actual!r}"
 
 
 @pytest.mark.parametrize(
@@ -178,7 +178,7 @@ def get_parts_action_message_with_reason(step: Step, message: str):
 
     actual = lifecycle._get_parts_action_message(action)
 
-    assert actual == message, "Unexpected %r" % actual
+    assert actual == message, f"Unexpected {actual!r}"
 
 
 def test_progress_messages(fake_parts_lifecycle, emitter):

{craft_application-2.6.2 → craft_application-2.6.3}/tests/unit/test_application.py

@@ -1306,10 +1306,10 @@ def test_extra_yaml_transform(tmp_path, app_metadata, fake_services):
 
     app = FakeApplication(app_metadata, fake_services)
     app.project_dir = tmp_path
-    _ = app.get_project(build_for="fake-build-for")
+    _ = app.get_project(build_for="s390x")
 
     assert app.build_on == util.get_host_architecture()
-    assert app.build_for == "fake-build-for"
+    assert app.build_for == "s390x"
 
 
 def test_mandatory_adoptable_fields(tmp_path, app_metadata, fake_services):
@@ -1505,7 +1505,7 @@ def test_process_grammar_no_match(grammar_app_mini, mocker):
 
 
 class FakeApplicationWithYamlTransform(FakeApplication):
-    """Application class that adds advanced grammar in `_extra_yaml_transform`."""
+    """Application class that adds data in `_extra_yaml_transform`."""
 
     @override
     def _extra_yaml_transform(
@@ -1520,9 +1520,17 @@ class FakeApplicationWithYamlTransform(FakeApplication):
         new_yaml_data["parts"] = {
             "mypart": {
                 "plugin": "nil",
-                "source": [
-                    {"to riscv64": "to-riscv64"},
-                    {"to s390x": "to-s390x"},
+                # advanced grammar
+                "build-packages": [
+                    "test-package",
+                    {"to riscv64": "riscv64-package"},
+                    {"to s390x": "s390x-package"},
+                ],
+                "build-environment": [
+                    # project variables
+                    {"hello": "$CRAFT_ARCH_BUILD_ON"},
+                    # build secrets
+                    {"MY_VAR": "$(HOST_SECRET:echo ${SECRET_VAR})"},
                 ],
             }
         }
@@ -1530,16 +1538,30 @@ class FakeApplicationWithYamlTransform(FakeApplication):
         return new_yaml_data
 
 
-def test_process_grammar_from_extra_transform(app_metadata, fake_services, tmp_path):
+@pytest.mark.enable_features("build_secrets")
+def test_process_yaml_from_extra_transform(
+    app_metadata, fake_services, tmp_path, monkeypatch
+):
     """Test that grammar is applied on data from `_extra_yaml_transform`."""
+    monkeypatch.setenv("SECRET_VAR", "secret-value")
     project_file = tmp_path / "testcraft.yaml"
     project_file.write_text(BASIC_PROJECT_YAML)
 
     app = FakeApplicationWithYamlTransform(app_metadata, fake_services)
     app.project_dir = tmp_path
-
     project = app.get_project(build_for="riscv64")
-    assert project.parts["mypart"]["source"] == "to-riscv64"
+
+    # process grammar
+    assert project.parts["mypart"]["build-packages"] == [
+        "test-package",
+        "riscv64-package",
+    ]
+    assert project.parts["mypart"]["build-environment"] == [
+        # evaluate project variables
+        {"hello": get_host_architecture()},
+        # render secrets
+        {"MY_VAR": "secret-value"},
+    ]
 
 
 class FakePartitionsApplication(FakeApplication):

craft_application-2.6.2/tests/integration/data/valid_projects/environment/testcraft.yaml

@@ -1,14 +0,0 @@
-name: environment-project
-summary: A project with environment variables
-version: 1.0
-base: ["ubuntu", "22.04"]
-
-parts:
-  my-part:
-    plugin: nil
-    override-build: |
-        target_file=${CRAFT_PART_INSTALL}/variables.yaml
-        touch $target_file
-        echo "project_name:    \"${CRAFT_PROJECT_NAME}\""    >> $target_file
-        echo "project_dir:     \"${CRAFT_PROJECT_DIR}\""     >> $target_file
-        echo "project_version: \"${CRAFT_PROJECT_VERSION}\"" >> $target_file