chore(merge): '8.2.1' into 'main' (#4760)

docs/requirements.txt

@@ -1,7 +1,7 @@
 attrs==23.1.0
 catkin-pkg==0.5.2
 click==8.1.7
-craft-application==2.5.0
+craft-application==2.6.0
 craft-archives==1.1.3
 craft-cli==2.5.1
 craft-grammar==1.2.0

requirements-devel.txt

@@ -11,7 +11,7 @@ click==8.1.7
 codespell==2.2.6
 colorama==0.4.6
 coverage==7.4.4
-craft-application==2.5.0
+craft-application==2.6.0
 craft-archives==1.1.3
 craft-cli==2.5.1
 craft-grammar==1.2.0

requirements.txt

@@ -5,7 +5,7 @@ cffi==1.16.0
 chardet==5.2.0
 charset-normalizer==3.3.2
 click==8.1.7
-craft-application==2.5.0
+craft-application==2.6.0
 craft-archives==1.1.3
 craft-cli==2.5.1
 craft-grammar==1.2.0

snapcraft/application.py

@@ -38,6 +38,7 @@
 from snapcraft.commands import unimplemented
 from snapcraft.extensions import apply_extensions
 from snapcraft.models.project import SnapcraftBuildPlanner, apply_root_packages
+from snapcraft.parts import set_global_environment
 from snapcraft.utils import get_host_architecture
 from snapcraft_legacy.cli import legacy
 
@@ -247,6 +248,12 @@ def _create_dispatcher(self) -> craft_cli.Dispatcher:
             default_command=craft_app_commands.lifecycle.PackCommand,
         )
 
+    @override
+    def _set_global_environment(self, info: craft_parts.ProjectInfo) -> None:
+        """Set global environment variables."""
+        super()._set_global_environment(info)
+        set_global_environment(info)
+
 
 def create_app() -> Snapcraft:
     """Create a Snapcraft application with the proper commands."""

snapcraft/parts/__init__.py

@@ -1,6 +1,6 @@
 # -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
 #
-# Copyright 2022 Canonical Ltd.
+# Copyright 2022,2024 Canonical Ltd.
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
@@ -18,7 +18,13 @@
 
 from craft_parts import validate_part
 
-from .lifecycle import patch_elf
+from .lifecycle import patch_elf, set_global_environment, set_step_environment
 from .parts import PartsLifecycle
 
-__all__ = ["PartsLifecycle", "patch_elf", "validate_part"]
+__all__ = [
+    "PartsLifecycle",
+    "patch_elf",
+    "set_global_environment",
+    "set_step_environment",
+    "validate_part",
+]

snapcraft/parts/lifecycle.py

@@ -83,8 +83,8 @@ def run(command_name: str, parsed_args: "argparse.Namespace") -> None:
     build_plan = get_build_plan(yaml_data, parsed_args)
 
     # Register our own callbacks
-    callbacks.register_prologue(_set_global_environment)
-    callbacks.register_pre_step(_set_step_environment)
+    callbacks.register_prologue(set_global_environment)
+    callbacks.register_pre_step(set_step_environment)
     callbacks.register_post_step(patch_elf, step_list=[Step.PRIME])
 
     build_count = utils.get_parallel_build_count()
@@ -574,12 +574,10 @@ def _expose_prime(
     instance.mount(host_source=project_path / "prime", target=dirs.prime_dir)
 
 
-def _set_global_environment(info: ProjectInfo) -> None:
+def set_global_environment(info: ProjectInfo) -> None:
     """Set global environment variables."""
     info.global_environment.update(
         {
-            "SNAPCRAFT_ARCH_TRIPLET": info.arch_triplet,
-            "SNAPCRAFT_TARGET_ARCH": info.target_arch,
             "SNAPCRAFT_PARALLEL_BUILD_COUNT": str(info.parallel_build_count),
             "SNAPCRAFT_PROJECT_VERSION": info.get_project_var("version", raw_read=True),
             "SNAPCRAFT_PROJECT_GRADE": info.get_project_var("grade", raw_read=True),
@@ -590,6 +588,15 @@ def _set_global_environment(info: ProjectInfo) -> None:
         }
     )
 
+    # add deprecated environment variables for core22
+    if info.base == "core22":
+        info.global_environment.update(
+            {
+                "SNAPCRAFT_ARCH_TRIPLET": info.arch_triplet,
+                "SNAPCRAFT_TARGET_ARCH": info.target_arch,
+            }
+        )
+
     if info.partitions:
         info.global_environment.update(_get_environment_for_partitions(info))
 
@@ -645,7 +652,7 @@ def _check_experimental_plugins(
         )
 
 
-def _set_step_environment(step_info: StepInfo) -> bool:
+def set_step_environment(step_info: StepInfo) -> bool:
     """Set the step environment before executing each lifecycle step."""
     step_info.step_environment.update(
         {
@@ -737,6 +744,7 @@ def _expand_environment(
     dirs = craft_parts.ProjectDirs(work_dir=work_dir, partitions=partitions)
     info = craft_parts.ProjectInfo(
         application_name="snapcraft",  # not used in environment expansion
+        base=yaml_utils.get_base_from_yaml(snapcraft_yaml) or "",
         cache_dir=Path(),  # not used in environment expansion
         arch=convert_architecture_deb_to_platform(target_arch),
         parallel_build_count=parallel_build_count,
@@ -745,7 +753,7 @@ def _expand_environment(
         project_vars=project_vars,
         partitions=partitions,
     )
-    _set_global_environment(info)
+    set_global_environment(info)
 
     craft_parts.expand_environment(snapcraft_yaml, info=info, skip=["name", "version"])
 

snapcraft/parts/yaml_utils.py

@@ -1,6 +1,6 @@
 # -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
 #
-# Copyright 2022-2023 Canonical Ltd.
+# Copyright 2022-2024 Canonical Ltd.
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
@@ -127,6 +127,18 @@ def get_base(filestream: TextIO) -> Optional[str]:
     :raises SnapcraftError: If the yaml could not be loaded.
     """
     data = safe_load(filestream)
+    return get_base_from_yaml(data)
+
+
+def get_base_from_yaml(data: dict[str, Any]) -> str | None:
+    """Get the effective base from a dictionary of yaml data.
+
+    :param data: The YAML data to load.
+
+    :returns: Effective base of the project or None if the base cannot be determined.
+
+    :raises SnapcraftError: If the yaml could not be loaded.
+    """
     return utils.get_effective_base(
         base=data.get("base"),
         build_base=data.get("build-base"),

snapcraft/services/lifecycle.py

@@ -24,10 +24,12 @@
 
 from craft_application import AppMetadata, LifecycleService, ServiceFactory
 from craft_application.models import BuildInfo
-from craft_parts import ProjectInfo, StepInfo
+from craft_parts import ProjectInfo, StepInfo, callbacks
+from craft_parts.packages import Repository as Repo
 from overrides import overrides
 
 from snapcraft import __version__, errors, models, os_release, parts, utils
+from snapcraft.parts.yaml_utils import get_snap_project
 
 
 class Lifecycle(LifecycleService):
@@ -60,6 +62,14 @@ def __init__(  # noqa: PLR0913 (too many arguments)
     def setup(self) -> None:
         project = cast(models.Project, self._project)
 
+        if project.package_repositories:
+            # Note: we unfortunately need to handle missing gpg/dirmngr binaries
+            # ourselves here, as this situation happens in Launchpad (where
+            # builds are executed destructively).
+            required_packages = ["gpg", "dirmngr"]
+            if any(p for p in required_packages if not Repo.is_package_installed(p)):
+                Repo.install_packages(required_packages, refresh_package_cache=False)
+
         # Have the lifecycle install the base snap, and look into it when
         # determining the package cutoff.
         self._manager_kwargs.update(
@@ -68,6 +78,8 @@ def setup(self) -> None:
             confinement=project.confinement,
             project_base=project.base or "",
         )
+        callbacks.register_prologue(parts.set_global_environment)
+        callbacks.register_pre_step(parts.set_step_environment)
         super().setup()
 
     @overrides
@@ -158,6 +170,15 @@ def generate_manifest(self) -> models.Manifest:
             primed_stage_packages=sorted(primed_stage_packages),
         )
 
+    @overrides
+    def _get_local_keys_path(self) -> Path | None:
+        snap_project = get_snap_project()
+        keys_dir = snap_project.assets_dir / "keys"
+        if keys_dir.is_dir():
+            return keys_dir
+
+        return None
+
 
 def get_prime_dirs_from_project(project_info: ProjectInfo) -> dict[str | None, Path]:
     """Get a mapping of component names to prime directories from a ProjectInfo.

tests/spread/core-devel/basic/task.yaml

@@ -1,4 +1,4 @@
-summary: Test basic build for devel base
+summary: Build a base snap using the 'devel' build base
 
 environment:
   SNAPCRAFT_BUILD_ENVIRONMENT: ""
@@ -7,13 +7,8 @@ restore: |
   cd "./snap"
   snapcraft clean
   rm -f ./*.snap
-  snap remove build-base-devel
 
 execute: |
   cd "./snap"
 
   snapcraft pack
-
-  snap install --dangerous ./*.snap
-
-  grep -i "devel" /snap/build-base-devel/current/etc/os-release || { echo "Devel image not found" ; exit 1; }

tests/spread/core24-suites/environment/test-variables/task.yaml

@@ -26,8 +26,18 @@ execute: |
     echo "==== $file ===="
     cat "$file"
     for exp in \
-      "^CRAFT_ARCH_TRIPLET=x86_64-linux-gnu$" \
-      "^CRAFT_TARGET_ARCH=amd64$" \
+      "^SNAPCRAFT_PROJECT_GRADE=devel$" \
+      "^SNAPCRAFT_PROJECT_NAME=None$" \
+      "^SNAPCRAFT_PROJECT_VERSION=1$" \
+      "^SNAPCRAFT_PARALLEL_BUILD_COUNT=[0-9]\+$" \
+      "^SNAPCRAFT_PROJECT_DIR=${root}$" \
+      "^SNAPCRAFT_PART_SRC=${root}/parts/hello/src$" \
+      "^SNAPCRAFT_PART_SRC_WORK=${root}/parts/hello/src$" \
+      "^SNAPCRAFT_PART_BUILD=${root}/parts/hello/build$" \
+      "^SNAPCRAFT_PART_BUILD_WORK=${root}/parts/hello/build$" \
+      "^SNAPCRAFT_PART_INSTALL=${root}/parts/hello/install$" \
+      "^SNAPCRAFT_STAGE=${root}/stage$" \
+      "^SNAPCRAFT_PRIME=${root}/prime$" \
       "^CRAFT_PARALLEL_BUILD_COUNT=[0-9]\+$" \
       "^CRAFT_PROJECT_DIR=${root}$" \
       "^CRAFT_PART_NAME=hello$" \

tests/spread/core24/grammar/snap/snapcraft.yaml

@@ -15,6 +15,12 @@ platforms:
     build-on: amd64
     build-for: arm64
 
+build-packages:
+  - on amd64 to amd64:
+    - libogg-dev
+  - on amd64 to arm64:
+    - libpci-dev
+
 parts:
   hello-world:
     plugin: dump

tests/spread/core24/package-repositories/task.yaml

@@ -10,7 +10,14 @@ environment:
   SNAP/test_foreign_armhf: test-foreign-armhf
   SNAP/test_foreign_i386: test-foreign-i386
 
+prepare: |
+  # Remove the currently installed "gpg" and "dirmngr" packages to ensure that
+  # Snapcraft itself is installing them when necessary.
+  sudo dpkg --remove --force-depends gpg dirmngr
+
 restore: |
+  sudo apt install -y gpg dirmngr
+
   cd "$SNAP"
   rm -f ./*.snap
   snapcraft clean

tests/spread/core24/package-repositories/test-apt-key-fingerprint/snap/snapcraft.yaml

@@ -25,3 +25,5 @@ package-repositories:
     suites: [focal]
     key-id: 78E1918602959B9C59103100F1831DDAFC42E99D
     url: http://ppa.launchpad.net/snappy-dev/snapcraft-daily/ubuntu
+    # Set an invalid keyserver here to force the use of the local key
+    key-server: keyserver.invalid.com

tests/unit/conftest.py

@@ -1,6 +1,6 @@
 # -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
 #
-# Copyright 2022-2023 Canonical Ltd.
+# Copyright 2022-2024 Canonical Ltd.
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
@@ -23,7 +23,7 @@
 
 import pytest
 import yaml
-from craft_parts import Features
+from craft_parts import Features, callbacks
 from craft_providers import Executor, Provider
 from craft_providers.base import Base
 from overrides import override
@@ -32,6 +32,11 @@
 from snapcraft.extensions import extension, register, unregister
 
 
+@pytest.fixture(autouse=True)
+def unregister_callbacks(mocker):
+    callbacks.unregister_all()
+
+
 @pytest.fixture
 def snapcraft_yaml(new_dir):
     """Return a fixture that can write a snapcraft.yaml."""

tests/unit/parts/test_lifecycle.py

@@ -23,13 +23,14 @@
 
 import pytest
 from craft_cli import EmitterMode, emit
-from craft_parts import Action, Features, Step, callbacks
+from craft_parts import Action, Features, ProjectInfo, Step, callbacks
 from craft_providers.bases.ubuntu import BuilddBaseAlias
 
 from snapcraft import errors
 from snapcraft.elf import ElfFile
 from snapcraft.models import MANDATORY_ADOPTABLE_FIELDS, Project
 from snapcraft.parts import lifecycle as parts_lifecycle
+from snapcraft.parts import set_global_environment
 from snapcraft.parts.plugins import KernelPlugin, MatterSdkPlugin
 from snapcraft.parts.update_metadata import update_project_metadata
 from snapcraft.utils import get_host_architecture
@@ -1205,13 +1206,50 @@ def test_get_snap_project_no_base(snapcraft_yaml, new_dir):
     )
 
 
+@pytest.mark.parametrize("base", ["core22", "core24"])
+def test_set_global_environment(base, mocker, new_dir):
+    """Set the global environment."""
+    expected_global_environment = {
+        "SNAPCRAFT_PARALLEL_BUILD_COUNT": "1",
+        "SNAPCRAFT_PRIME": f"{new_dir}/prime",
+        "SNAPCRAFT_PROJECT_DIR": str(new_dir),
+        "SNAPCRAFT_PROJECT_GRADE": "test-grade",
+        "SNAPCRAFT_PROJECT_NAME": "None",
+        "SNAPCRAFT_PROJECT_VERSION": "test-version",
+        "SNAPCRAFT_STAGE": f"{new_dir}/stage",
+    }
+    if base == "core22":
+        expected_global_environment.update(
+            {
+                "SNAPCRAFT_ARCH_TRIPLET": "aarch64-linux-gnu",
+                "SNAPCRAFT_TARGET_ARCH": "arm64",
+            }
+        )
+    mocker.patch("platform.machine", return_value="aarch64")
+
+    info = ProjectInfo(
+        application_name="test",
+        base=base,
+        project_vars={
+            "version": "test-version",
+            "grade": "test-grade",
+        },
+        arch="aarch64",
+        cache_dir=new_dir,
+    )
+    set_global_environment(info)
+
+    assert info.global_environment == expected_global_environment
+
+
 def test_expand_environment(new_dir, mocker):
     mocker.patch("platform.machine", return_value="aarch64")
 
     yaml_data = {
         "name": "test-env",
         "version": "1.2.3",
         "grade": "stable",
+        "base": "core22",
         "field0": "$CRAFT_PROJECT_NAME",
         "field1": "$SNAPCRAFT_PROJECT_NAME",
         "field2": "$SNAPCRAFT_PROJECT_VERSION",
@@ -1235,6 +1273,7 @@ def test_expand_environment(new_dir, mocker):
     )
 
     assert yaml_data == {
+        "base": "core22",
         "name": "test-env",
         "version": "1.2.3",
         "grade": "stable",