Skip to content

extensions/gnome: Add sdk include directories to C_INCLUDE_PATH #5514

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
3v1n0 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

extensions/gnome: Add sdk include directories to C_INCLUDE_PATH #5514

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/reference/extensions/gnome-extension.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ The paths differ slightly between core24 and core22 bases.
build-environment:
- PATH: /snap/gnome-46-2404-sdk/current/usr/bin${PATH:+:$PATH}
- XDG_DATA_DIRS: $CRAFT_STAGE/usr/share:/snap/gnome-46-2404-sdk/current/usr/share:/usr/share${XDG_DATA_DIRS:+:$XDG_DATA_DIRS}
- C_INCLUDE_PATH: $CRAFT_STAGE/usr/include:/snap/gnome-46-2404-sdk/current/usr/include:/snap/core24/current/usr/include${C_INCLUDE_PATH:+:$C_INCLUDE_PATH}
- LD_LIBRARY_PATH: /snap/gnome-46-2404-sdk/current/lib/$CRAFT_ARCH_TRIPLET_BUILD_FOR:/snap/gnome-46-2404-sdk/current/usr/lib/$CRAFT_ARCH_TRIPLET_BUILD_FOR:/snap/gnome-46-2404-sdk/current/usr/lib:/snap/gnome-46-2404-sdk/current/usr/lib/vala-current:/snap/gnome-46-2404-sdk/current/usr/lib/$CRAFT_ARCH_TRIPLET_BUILD_FOR/pulseaudio${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}
- PKG_CONFIG_PATH: /snap/gnome-46-2404-sdk/current/usr/lib/$CRAFT_ARCH_TRIPLET_BUILD_FOR/pkgconfig:/snap/gnome-46-2404-sdk/current/usr/lib/pkgconfig:/snap/gnome-46-2404-sdk/current/usr/share/pkgconfig${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}
- GETTEXTDATADIRS: /snap/gnome-46-2404-sdk/current/usr/share/gettext-current${GETTEXTDATADIRS:+:$GETTEXTDATADIRS}
Expand Down
22 changes: 21 additions & 1 deletion snapcraft/extensions/gnome.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,9 +216,10 @@ def get_root_snippet(self) -> dict[str, Any]:

@overrides
def get_part_snippet(self, *, plugin_name: str) -> dict[str, Any]:
base = self.yaml_data["base"]
sdk_snap = self.gnome_snaps.sdk

return {
part_snippet = {
"build-environment": [
{
"PATH": prepend_to_env(
Expand Down Expand Up @@ -320,6 +321,25 @@ def get_part_snippet(self, *, plugin_name: str) -> dict[str, Any]:
],
}

if base != "core22":
# While this should be done with any base, clang that is available
# in core22 does not handle it properly, breaking the flutter
# builds. So do it only on newer bases.
part_snippet["build-environment"].append(
{
"C_INCLUDE_PATH": prepend_to_env(
"C_INCLUDE_PATH",
[
"$CRAFT_STAGE/usr/include",
f"/snap/{sdk_snap}/current/usr/include",
f"/snap/{base}/current/include",
],
),
}
)

return part_snippet

@overrides
def get_parts_snippet(self) -> dict[str, Any]:
"""Get the parts snippet for the GNOME extension.
Expand Down
78 changes: 58 additions & 20 deletions tests/unit/extensions/test_gnome.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,18 @@ def gnome_extension_with_default_build_snap_from_latest_edge():
)


@pytest.fixture
def gnome_extension_with_core24_build_snap_from_latest_edge():
return gnome.GNOME(
yaml_data={
"base": "core24",
"parts": {"part1": {"build-snaps": ["gnome-46-2404-sdk/latest/edge"]}},
},
arch="amd64",
target_arch="amd64",
)


###################
# GNOME Extension #
###################
Expand Down Expand Up @@ -234,63 +246,73 @@ def test_get_part_snippet_latest_edge(
gnome_extension_with_default_build_snap_from_latest_edge
)

def test_get_part_snippet_core24_latest_edge(
self, gnome_extension_with_core24_build_snap_from_latest_edge
):
self.assert_get_part_snippet(
gnome_extension_with_core24_build_snap_from_latest_edge
)

@staticmethod
def assert_get_part_snippet(gnome_instance):
assert gnome_instance.get_part_snippet(plugin_name="autotools") == {
base = gnome_instance.yaml_data["base"]
sdk_snap = gnome_instance.gnome_snaps.sdk

expected_snippet = {
"build-environment": [
{"PATH": "/snap/gnome-42-2204-sdk/current/usr/bin${PATH:+:$PATH}"},
{"PATH": f"/snap/{sdk_snap}/current/usr/bin${{PATH:+:$PATH}}"},
{
"XDG_DATA_DIRS": (
"$CRAFT_STAGE/usr/share:/snap/gnome-42-2204-sdk"
f"$CRAFT_STAGE/usr/share:/snap/{sdk_snap}"
"/current/usr/share:/usr/share${XDG_DATA_DIRS:+:$XDG_DATA_DIRS}"
)
},
{
"LD_LIBRARY_PATH": ":".join(
[
"/snap/gnome-42-2204-sdk/current/lib/$CRAFT_ARCH_TRIPLET_BUILD_FOR",
"/snap/gnome-42-2204-sdk/current/usr/lib/$CRAFT_ARCH_TRIPLET_BUILD_FOR",
"/snap/gnome-42-2204-sdk/current/usr/lib",
"/snap/gnome-42-2204-sdk/current/usr/lib/vala-current",
"/snap/gnome-42-2204-sdk/current/usr/lib/"
f"/snap/{sdk_snap}/current/lib/$CRAFT_ARCH_TRIPLET_BUILD_FOR",
f"/snap/{sdk_snap}/current/usr/lib/$CRAFT_ARCH_TRIPLET_BUILD_FOR",
f"/snap/{sdk_snap}/current/usr/lib",
f"/snap/{sdk_snap}/current/usr/lib/vala-current",
f"/snap/{sdk_snap}/current/usr/lib/"
"$CRAFT_ARCH_TRIPLET_BUILD_FOR/pulseaudio",
]
)
+ "${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}"
},
{
"PKG_CONFIG_PATH": (
"/snap/gnome-42-2204-sdk/current/usr/lib/"
f"/snap/{sdk_snap}/current/usr/lib/"
"$CRAFT_ARCH_TRIPLET_BUILD_FOR/pkgconfig:"
"/snap/gnome-42-2204-sdk/current/usr/lib/pkgconfig:"
"/snap/gnome-42-2204-sdk/current/usr/share/pkgconfig"
f"/snap/{sdk_snap}/current/usr/lib/pkgconfig:"
f"/snap/{sdk_snap}/current/usr/share/pkgconfig"
"${PKG_CONFIG_PATH:+:$PKG_CONFIG_PATH}"
)
},
{
"GETTEXTDATADIRS": (
"/snap/gnome-42-2204-sdk/current/usr/share/gettext-current"
f"/snap/{sdk_snap}/current/usr/share/gettext-current"
"${GETTEXTDATADIRS:+:$GETTEXTDATADIRS}"
)
},
{
"GDK_PIXBUF_MODULE_FILE": (
"/snap/gnome-42-2204-sdk/current/usr/lib/$CRAFT_ARCH_TRIPLET_BUILD_FOR"
f"/snap/{sdk_snap}/current/usr/lib/$CRAFT_ARCH_TRIPLET_BUILD_FOR"
"/gdk-pixbuf-current/loaders.cache"
)
},
{
"ACLOCAL_PATH": (
"/snap/gnome-42-2204-sdk/current/usr/share/aclocal"
f"/snap/{sdk_snap}/current/usr/share/aclocal"
"${ACLOCAL_PATH:+:$ACLOCAL_PATH}"
)
},
{
"PYTHONPATH": ":".join(
[
"/snap/gnome-42-2204-sdk/current/usr/lib/python3.10",
"/snap/gnome-42-2204-sdk/current/usr/lib/python3/dist-packages",
"/snap/gnome-42-2204-sdk/current/usr/lib/$CRAFT_ARCH_TRIPLET_BUILD_FOR"
f"/snap/{sdk_snap}/current/usr/lib/python3.10",
f"/snap/{sdk_snap}/current/usr/lib/python3/dist-packages",
f"/snap/{sdk_snap}/current/usr/lib/$CRAFT_ARCH_TRIPLET_BUILD_FOR"
"/gobject-introspection",
]
)
Expand All @@ -299,9 +321,9 @@ def assert_get_part_snippet(gnome_instance):
{
"GI_TYPELIB_PATH": ":".join(
[
"/snap/gnome-42-2204-sdk/current/usr/lib/girepository-1.0",
f"/snap/{sdk_snap}/current/usr/lib/girepository-1.0",
(
"/snap/gnome-42-2204-sdk/current/usr/lib/"
f"/snap/{sdk_snap}/current/usr/lib/"
"$CRAFT_ARCH_TRIPLET_BUILD_FOR/girepository-1.0"
),
]
Expand All @@ -311,14 +333,30 @@ def assert_get_part_snippet(gnome_instance):
{
"CMAKE_PREFIX_PATH": (
"$CRAFT_STAGE:"
"/snap/gnome-42-2204-sdk/current"
f"/snap/{sdk_snap}/current"
"${CMAKE_PREFIX_PATH:"
"+:$CMAKE_PREFIX_PATH}"
)
},
]
}

if base != "core22":
expected_snippet["build-environment"].append(
{
"C_INCLUDE_PATH": (
"$CRAFT_STAGE/usr/include:"
f"/snap/{sdk_snap}/current/usr/include:"
f"/snap/{base}/current/include"
"${C_INCLUDE_PATH:+:$C_INCLUDE_PATH}"
)
}
)

assert (
gnome_instance.get_part_snippet(plugin_name="autotools") == expected_snippet
)


def test_get_part_snippet_with_external_sdk(gnome_extension_with_build_snap):
assert gnome_extension_with_build_snap.get_part_snippet(plugin_name="meson") == {
Expand Down
Loading