Add wheel repair test

LecrisUT · LecrisUT · commit 565dbfea92c2 · 2025-07-30T18:54:33.000+02:00
Signed-off-by: Cristian Le &lt;git@lecris.dev&gt;
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -4,6 +4,7 @@
 import dataclasses
 import importlib.util
 import os
+import platform
 import shutil
 import subprocess
 import sys
@@ -56,6 +57,11 @@ def pep518_wheelhouse(tmp_path_factory: pytest.TempPathFactory) -> Path:
         "virtualenv",
         "wheel",
     ]
+    if platform.system() == "Linux":
+        packages.append("auditwheel")
+        packages.append("patchelf")
+    if platform.system() == "Darwin":
+        packages.append("delocate")
 
     if importlib.util.find_spec("cmake") is not None:
         packages.append("cmake")
@@ -346,6 +352,15 @@ def package_pep639_pure(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> Pack
     return package
 
 
+@pytest.fixture
+def repair_wheel(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> PackageInfo:
+    package = PackageInfo(
+        "repair_wheel",
+    )
+    process_package(package, tmp_path, monkeypatch)
+    return package
+
+
 def which_mock(name: str) -> str | None:
     if name in {"ninja", "ninja-build", "cmake3", "samu", "gmake", "make"}:
         return None
diff --git a/tests/packages/repair_wheel/CMakeLists.txt b/tests/packages/repair_wheel/CMakeLists.txt
@@ -0,0 +1,57 @@
+cmake_minimum_required(VERSION 3.15...3.26)
+
+project(${SKBUILD_PROJECT_NAME} LANGUAGES CXX)
+
+set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
+
+include(GNUInstallDirs)
+include(CMakePackageConfigHelpers)
+
+find_package(Base CONFIG REQUIRED)
+find_package(Python COMPONENTS Interpreter Development.Module)
+
+add_executable(main src/main.cpp)
+add_library(other SHARED src/other.cpp)
+python_add_library(_module MODULE src/module.cpp WITH_SOABI)
+
+target_link_libraries(other PRIVATE base::base)
+target_link_libraries(main PRIVATE other)
+target_link_libraries(_module PRIVATE base::base)
+
+install(TARGETS main other)
+install(TARGETS _module DESTINATION ".")
+
+if(DO_MANUAL_REPAIR)
+  if(APPLE)
+    set(origin_token "@loader_path")
+  else()
+    set(origin_token "$ORIGIN")
+  endif()
+  set_property(
+    TARGET main PROPERTY INSTALL_RPATH
+                         "${origin_token}/../${CMAKE_INSTALL_LIBDIR}")
+  set_property(
+    TARGET other
+    PROPERTY INSTALL_RPATH
+             "${origin_token}/../../base_project/${CMAKE_INSTALL_LIBDIR}")
+  set_property(
+    TARGET _module
+    PROPERTY INSTALL_RPATH
+             "${origin_token}/../base_project/${CMAKE_INSTALL_LIBDIR}")
+  if(WIN32)
+    install(TARGETS other RUNTIME DESTINATION ${SKBUILD_SCRIPTS_DIR})
+    file(
+      WRITE ${CMAKE_CURRENT_BINARY_DIR}/__init__.py
+      "
+import os
+import sysconfig
+from pathlib import Path
+
+base_project_bindir = Path(__file__).parent / \"../base_project/${CMAKE_INSTALL_BINDIR}\"
+project_bindir = Path(__file__).parent / \"${CMAKE_INSTALL_BINDIR}\"
+os.add_dll_directory(str(base_project_bindir))
+os.add_dll_directory(str(project_bindir))
+")
+    install(FILES ${CMAKE_CURRENT_BINARY_DIR}/__init__.py DESTINATION ".")
+  endif()
+endif()
diff --git a/tests/packages/repair_wheel/extern/BaseConfig.cmake.in b/tests/packages/repair_wheel/extern/BaseConfig.cmake.in
@@ -0,0 +1,3 @@
+@PACKAGE_INIT@
+
+include(${CMAKE_CURRENT_LIST_DIR}/BaseTargets.cmake)
diff --git a/tests/packages/repair_wheel/extern/CMakeLists.txt b/tests/packages/repair_wheel/extern/CMakeLists.txt
@@ -0,0 +1,30 @@
+cmake_minimum_required(VERSION 3.15...3.26)
+
+project(Base LANGUAGES CXX)
+
+include(GNUInstallDirs)
+include(CMakePackageConfigHelpers)
+
+set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
+
+add_library(base SHARED)
+
+target_sources(base PRIVATE base.cpp)
+set_property(
+  TARGET base
+  APPEND
+  PROPERTY PUBLIC_HEADER base.h)
+target_include_directories(
+  base PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
+              $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>)
+
+install(TARGETS base EXPORT BaseTargets)
+install(
+  EXPORT BaseTargets
+  DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/base
+  NAMESPACE base::)
+configure_package_config_file(
+  BaseConfig.cmake.in BaseConfig.cmake
+  INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/Base)
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/BaseConfig.cmake
+        DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/base)
diff --git a/tests/packages/repair_wheel/extern/base.cpp b/tests/packages/repair_wheel/extern/base.cpp
@@ -0,0 +1,7 @@
+#include <iostream>
+
+#include "base.h"
+
+void base::hello() {
+    std::cout << "Hello, World!" << std::endl;
+}
diff --git a/tests/packages/repair_wheel/extern/base.h b/tests/packages/repair_wheel/extern/base.h
@@ -0,0 +1,5 @@
+#pragma once
+
+namespace base {
+    void hello();
+}
diff --git a/tests/packages/repair_wheel/extern/base_project/__init__.py b/tests/packages/repair_wheel/extern/base_project/__init__.py
diff --git a/tests/packages/repair_wheel/extern/pyproject.toml b/tests/packages/repair_wheel/extern/pyproject.toml
@@ -0,0 +1,13 @@
+[build-system]
+requires = ["scikit-build-core"]
+build-backend = "scikit_build_core.build"
+
+[project]
+name = "base_project"
+version = "0.1.0"
+
+[project.entry-points."cmake.root"]
+Base = "base_project"
+
+[tool.scikit-build]
+wheel.install-dir = "base_project"
diff --git a/tests/packages/repair_wheel/pyproject.toml b/tests/packages/repair_wheel/pyproject.toml
@@ -0,0 +1,22 @@
+[build-system]
+requires = ["scikit-build-core"]
+build-backend = "scikit_build_core.build"
+
+[project]
+name = "repair_wheel"
+version = "0.1.0"
+dependencies = ["base_project"]
+
+[tool.scikit-build]
+build.requires = ["base_project @ {root:uri}/extern"]
+wheel.install-dir = "repair_wheel"
+wheel.repair = true
+experimental = true
+
+[project.scripts]
+main = "repair_wheel.__main__:run"
+
+[[tool.scikit-build.overrides]]
+if.env.MANUAL = true
+wheel.repair = false
+cmake.define.DO_MANUAL_REPAIR = true
diff --git a/tests/packages/repair_wheel/python/repair_wheel/__init__.py b/tests/packages/repair_wheel/python/repair_wheel/__init__.py
diff --git a/tests/packages/repair_wheel/python/repair_wheel/__main__.py b/tests/packages/repair_wheel/python/repair_wheel/__main__.py
@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+import subprocess
+import sys
+from pathlib import Path
+
+
+def run() -> None:
+    exe_path = Path(__file__).parent
+    exe_path = next((exe_path / "bin").glob("main*"))
+    sys.exit(subprocess.call([str(exe_path), *sys.argv[2:]]))
+
+
+if __name__ == "__main__":
+    run()
diff --git a/tests/packages/repair_wheel/python/repair_wheel/_module.pyi b/tests/packages/repair_wheel/python/repair_wheel/_module.pyi
@@ -0,0 +1 @@
+def hello() -> None: ...
diff --git a/tests/packages/repair_wheel/src/main.cpp b/tests/packages/repair_wheel/src/main.cpp
@@ -0,0 +1,6 @@
+#include "other.h"
+
+int main() {
+    other::hello();
+    return 0;
+}
diff --git a/tests/packages/repair_wheel/src/module.cpp b/tests/packages/repair_wheel/src/module.cpp
@@ -0,0 +1,20 @@
+#define PY_SSIZE_T_CLEAN
+#include <Python.h>
+
+#include <base.h>
+
+static PyObject *hello(PyObject *self, PyObject *args){
+  base::hello();
+  Py_RETURN_NONE;
+}
+
+static PyMethodDef repair_wheel_methods[] = {
+    {"hello", hello, METH_NOARGS, "Say hello"},
+    {NULL, NULL, 0, NULL}};
+
+static struct PyModuleDef repair_wheel_module = {PyModuleDef_HEAD_INIT, "_module",
+                                             NULL, -1, repair_wheel_methods};
+
+PyMODINIT_FUNC PyInit__module(void) {
+    return PyModule_Create(&repair_wheel_module);
+}
diff --git a/tests/packages/repair_wheel/src/other.cpp b/tests/packages/repair_wheel/src/other.cpp
@@ -0,0 +1,7 @@
+#include <base.h>
+
+#include "other.h"
+
+void other::hello() {
+    base::hello();
+}
diff --git a/tests/packages/repair_wheel/src/other.h b/tests/packages/repair_wheel/src/other.h
@@ -0,0 +1,5 @@
+#pragma once
+
+namespace other {
+    void hello();
+}
diff --git a/tests/test_repair_wheel.py b/tests/test_repair_wheel.py
@@ -0,0 +1,79 @@
+import platform
+import shutil
+from pathlib import Path
+
+import pytest
+
+DIR = Path(__file__).parent.resolve()
+REPAIR_WHEEL = DIR / "packages/repair_wheel"
+
+
+@pytest.mark.compile
+@pytest.mark.configure
+@pytest.mark.parametrize(
+    ("backend", "with_isolation", "manual_repair"),
+    [
+        ("pip", True, False),
+        ("pip", False, False),
+        ("pip", True, True),
+        ("build", True, False),
+        ("build", False, False),
+    ],
+    ids=[
+        "pip-isolated",
+        "pip-not-isolated",
+        "manual",
+        "build-isolated",
+        "build-not-isolated",
+    ],
+)
+@pytest.mark.usefixtures("repair_wheel")
+def test_full_build(
+    backend,
+    isolated,
+    with_isolation,
+    manual_repair,
+    monkeypatch,
+    tmp_path,
+):
+    monkeypatch.setenv("MANUAL", f"{manual_repair}")
+    if backend == "pip":
+        isolated.install("pip>=23")
+    elif backend == "build":
+        isolated.install("build[virtualenv]")
+    else:
+        raise NotImplementedError
+
+    if not with_isolation:
+        isolated.install("scikit-build-core")
+        if platform.system() == "Linux":
+            isolated.install("auditwheel")
+            if shutil.which("patchelf") is None:
+                isolated.install("patchelf")
+        if platform.system() == "Darwin":
+            isolated.install("delocate")
+        isolated.install("./extern", isolated=with_isolation)
+
+    if backend == "pip":
+        isolated.install(
+            "-v",
+            "./extern",
+            ".",
+            isolated=with_isolation,
+        )
+    elif backend == "build":
+        dist = tmp_path / "dist"
+        build_args = ["-v", "--wheel", f"--outdir={dist}"]
+        if with_isolation:
+            isolated.module("build", *build_args, "./extern")
+        else:
+            build_args.append("--no-isolation")
+        isolated.module("build", *build_args, ".")
+        wheels = list(dist.glob("*.whl"))
+        isolated.install(*wheels)
+
+    isolated.run("main")
+    isolated.module("repair_wheel")
+    isolated.execute(
+        "from repair_wheel._module import hello; hello()",
+    )

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+@PACKAGE_INIT@`
	`2`	`+`
	`3`	`+include(${CMAKE_CURRENT_LIST_DIR}/BaseTargets.cmake)`