test: add test_develop and check_wheel_files testing for `--with-…

…debuginfo`

test-crates/pyo3-bin-msvc-debuginfo/.gitignore

@@ -0,0 +1,2 @@
+*.py[cdo]
+*.pdb

test-crates/pyo3-bin-msvc-debuginfo/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "pyo3-mixed"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[[bin]]
+name = "pyo3-bin"    # keep the name with a dash to test `.pdb` file name
+path = "src/main.rs"

test-crates/pyo3-bin-msvc-debuginfo/check_installed/check_installed.py

@@ -0,0 +1,31 @@
+import sys
+import platform
+from pathlib import Path
+
+
+class MaturinTestError(Exception):
+    pass
+
+
+def main():
+    # e.g. `venv\Scripts`
+    scripts_dir = Path(sys.executable).parent
+
+    # set by `bin.name = "pyo3-bin"` in `Cargo.toml`
+    exe_binding_path = scripts_dir / "pyo3-bin.exe"
+    if not exe_binding_path.exists():
+        raise MaturinTestError(f"{exe_binding_path} does not exist")
+
+    # the pdb file of `foo-bar.exe` is `foo_bar.pdb`
+    exe_binding_debuginfo_path = scripts_dir / "pyo3_bin.pdb"
+    if not exe_binding_debuginfo_path.exists():
+        raise MaturinTestError(f"{exe_binding_debuginfo_path} does not exist")
+
+
+if __name__ == "__main__":
+    if not platform.system() == "Windows":
+        raise MaturinTestError("This test is only supported on MSVC")
+
+    main()
+
+    print("SUCCESS")

test-crates/pyo3-bin-msvc-debuginfo/pyproject.toml

@@ -0,0 +1,16 @@
+[build-system]
+requires = ["maturin>=1.7,<2.0"]
+build-backend = "maturin"
+
+[project]
+name = "pyo3-mixed"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Rust",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+]
+dynamic = ["version"]
+
+[tool.maturin]
+bindings = "bin"

test-crates/pyo3-bin-msvc-debuginfo/src/main.rs

@@ -0,0 +1,3 @@
+fn main() {
+    println!("Hello, world!");
+}

test-crates/pyo3-mixed-msvc-debuginfo/.gitignore

@@ -0,0 +1,2 @@
+*.py[cdo]
+*.pdb

test-crates/pyo3-mixed-msvc-debuginfo/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "pyo3-mixed"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[lib]
+name = "pyo3_mixed"
+crate-type = ["cdylib"]
+
+[dependencies]
+pyo3 = "0.22.0"

test-crates/pyo3-mixed-msvc-debuginfo/check_installed/check_installed.py

@@ -0,0 +1,36 @@
+import platform
+from pathlib import Path
+import sysconfig
+
+import pyo3_mixed
+
+
+class MaturinTestError(Exception):
+    pass
+
+
+def main():
+    # e.g. `...\test-crates\pyo3-mixed-msvc-debuginfo\python\pyo3_mixed\__init__.py`
+    init_py_path = Path(pyo3_mixed.__file__)
+
+    ext_suffix = sysconfig.get_config_var("EXT_SUFFIX")
+
+    # set by `module-name = "pyo3_mixed._pyo3_lib"` in `pyproject.toml`
+    # e.g. `_pyo3_lib.cp310-win_amd64.pyd`
+    lib_pyd_path = init_py_path.with_name(f"_pyo3_lib{ext_suffix}")
+    if not lib_pyd_path.exists():
+        raise MaturinTestError(f"{lib_pyd_path} does not exist")
+
+    # set by `lib.name = "pyo3_mixed"` in `Cargo.toml`
+    lib_debuginfo_path = init_py_path.with_name("pyo3_mixed.pdb")
+    if not lib_debuginfo_path.exists():
+        raise MaturinTestError(f"{lib_debuginfo_path} does not exist")
+
+
+if __name__ == "__main__":
+    if not platform.system() == "Windows":
+        raise MaturinTestError("This test is only supported on MSVC")
+
+    main()
+
+    print("SUCCESS")

test-crates/pyo3-mixed-msvc-debuginfo/pyproject.toml

@@ -0,0 +1,19 @@
+[build-system]
+requires = ["maturin>=1.7,<2.0"]
+build-backend = "maturin"
+
+[project]
+name = "pyo3-mixed"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Rust",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+]
+dynamic = ["version"]
+
+[tool.maturin]
+python-source = "python"
+# keep the pyd name different from the rust lib name to test `.pdb` file name
+module-name = "pyo3_mixed._pyo3_lib"
+features = ["pyo3/extension-module"]

test-crates/pyo3-mixed-msvc-debuginfo/python/pyo3_mixed/__init__.py

@@ -0,0 +1,8 @@
+from ._pyo3_lib import sum_as_string
+from . import _pyo3_lib
+
+__all__ = ["sum_as_string"]
+
+__doc__ = _pyo3_lib.__doc__
+if hasattr(_pyo3_lib, "__all__"):
+    __all__ = _pyo3_lib.__all__

test-crates/pyo3-mixed-msvc-debuginfo/src/lib.rs

@@ -0,0 +1,15 @@
+use pyo3::prelude::*;
+
+/// A Python module implemented in Rust.
+#[pymodule]
+// keep the name the same as `module-name = "pyo3_mixed._pyo3_lib"` in `pyproject.toml`
+#[pyo3(name = "_pyo3_lib")]
+mod pyo3_lib {
+    use super::*;
+
+    /// Formats the sum of two numbers as string.
+    #[pyfunction]
+    fn sum_as_string(a: usize, b: usize) -> PyResult<String> {
+        Ok((a + b).to_string())
+    }
+}

tests/common/other.rs

@@ -191,7 +191,11 @@ pub fn test_source_distribution(
     Ok(())
 }
 
-fn build_wheel_files(package: impl AsRef<Path>, unique_name: &str) -> Result<ZipArchive<File>> {
+fn build_wheel_files(
+    package: impl AsRef<Path>,
+    unique_name: &str,
+    with_debuginfo: bool,
+) -> Result<ZipArchive<File>> {
     let manifest_path = package.as_ref().join("Cargo.toml");
     let wheel_directory = Path::new("test-crates").join("wheels").join(unique_name);
 
@@ -204,6 +208,7 @@ fn build_wheel_files(package: impl AsRef<Path>, unique_name: &str) -> Result<Zip
             ..Default::default()
         },
         platform_tag: vec![PlatformTag::Linux],
+        with_debuginfo,
         ..Default::default()
     };
 
@@ -223,7 +228,7 @@ pub fn check_wheel_mtimes(
     expected_mtime: Vec<OffsetDateTime>,
     unique_name: &str,
 ) -> Result<()> {
-    let mut wheel = build_wheel_files(package, unique_name)?;
+    let mut wheel = build_wheel_files(package, unique_name, false)?;
     let mut mtimes = BTreeSet::<OffsetDateTime>::new();
 
     for idx in 0..wheel.len() {
@@ -240,8 +245,9 @@ pub fn check_wheel_files(
     package: impl AsRef<Path>,
     expected_files: Vec<&str>,
     unique_name: &str,
+    with_debuginfo: bool,
 ) -> Result<()> {
-    let wheel = build_wheel_files(package, unique_name)?;
+    let wheel = build_wheel_files(package, unique_name, with_debuginfo)?;
     let drop_platform_specific_files = |file: &&str| -> bool {
         !matches!(Path::new(file).extension(), Some(ext) if ext == "pyc" || ext == "pyd" || ext == "so")
     };