Add a test for this warning

Author: joerick

cibuildwheel/platforms/ios.py

@@ -32,7 +32,7 @@
     download,
     move_file,
 )
-from ..util.helpers import prepare_command, unwrap
+from ..util.helpers import prepare_command, unwrap_preserving_paragraphs
 from ..util.packaging import (
     combine_constraints,
     find_compatible_wheel,
@@ -597,14 +597,16 @@ def build(options: Options, tmp_path: Path) -> None:
                     test_command_parts = shlex.split(build_options.test_command)
                     if test_command_parts[0:2] != ["python", "-m"]:
                         log.warning(
-                            unwrap(f"""
-                                iOS tests run with test command '{build_options.test_command}' that
-                                doesn't start with 'python -m'. iOS tests must execute python
-                                modules - other entrypoints are not supported.
+                            unwrap_preserving_paragraphs(f"""
+                                iOS tests configured with a test command which doesn't start with
+                                'python -m'. iOS tests must execute python modules - other
+                                entrypoints are not supported.
 
                                 cibuildwheel will try to execute it as if it started with 'python
                                 -m'. If this works, all you need to do is add that to your test
                                 command.
+
+                                Test command: {build_options.test_command}
                             """)
                         )
                     else:

cibuildwheel/util/helpers.py

@@ -76,6 +76,21 @@ def unwrap(text: str) -> str:
     return re.sub(r"\s+", " ", text)
 
 
+def unwrap_preserving_paragraphs(text: str) -> str:
+    """
+    Unwraps multi-line text to a single line, but preserves paragraphs
+    """
+    # remove initial line indent
+    text = textwrap.dedent(text)
+    # remove leading/trailing whitespace
+    text = text.strip()
+
+    paragraphs = text.split("\n\n")
+    # remove consecutive whitespace
+    paragraphs = [re.sub(r"\s+", " ", paragraph) for paragraph in paragraphs]
+    return "\n\n".join(paragraphs)
+
+
 def parse_key_value_string(
     key_value_string: str,
     positional_arg_names: Sequence[str] | None = None,

test/test_ios.py

@@ -4,6 +4,7 @@
 import platform
 import shutil
 import subprocess
+import textwrap
 
 import pytest
 
@@ -80,21 +81,10 @@ def test_ios_platforms(tmp_path, build_config, monkeypatch, capfd):
     )
 
     # The expected wheels were produced.
-    ios_version = os.getenv("IPHONEOS_DEPLOYMENT_TARGET", "13.0").replace(".", "_")
-    platform_machine = platform.machine()
-
-    if platform_machine == "x86_64":
-        expected_wheels = {
-            f"spam-0.1.0-cp313-cp313-ios_{ios_version}_x86_64_iphonesimulator.whl",
-        }
-
-    elif platform_machine == "arm64":
-        expected_wheels = {
-            f"spam-0.1.0-cp313-cp313-ios_{ios_version}_arm64_iphoneos.whl",
-            f"spam-0.1.0-cp313-cp313-ios_{ios_version}_arm64_iphonesimulator.whl",
-        }
-
-    assert set(actual_wheels) == expected_wheels
+    expected_wheels = utils.expected_wheels(
+        "spam", "0.1.0", platform="ios", python_abi_tags=["cp313-cp313"]
+    )
+    assert set(actual_wheels) == set(expected_wheels)
 
     # The user was notified that the cross-build tool was found.
     captured = capfd.readouterr()
@@ -180,21 +170,10 @@ def test_no_xbuild_tool_definition(tmp_path, capfd):
     )
 
     # The expected wheels were produced.
-    ios_version = os.getenv("IPHONEOS_DEPLOYMENT_TARGET", "13.0").replace(".", "_")
-    platform_machine = platform.machine()
-
-    if platform_machine == "x86_64":
-        expected_wheels = {
-            f"spam-0.1.0-cp313-cp313-ios_{ios_version}_x86_64_iphonesimulator.whl",
-        }
-
-    elif platform_machine == "arm64":
-        expected_wheels = {
-            f"spam-0.1.0-cp313-cp313-ios_{ios_version}_arm64_iphoneos.whl",
-            f"spam-0.1.0-cp313-cp313-ios_{ios_version}_arm64_iphonesimulator.whl",
-        }
-
-    assert set(actual_wheels) == expected_wheels
+    expected_wheels = utils.expected_wheels(
+        "spam", "0.1.0", platform="ios", python_abi_tags=["cp313-cp313"]
+    )
+    assert set(actual_wheels) == set(expected_wheels)
 
     # The user was notified that there was no cross-build tool definition.
     captured = capfd.readouterr()
@@ -225,23 +204,48 @@ def test_empty_xbuild_tool_definition(tmp_path, capfd):
         },
     )
 
-    # The expected wheels were produced.
-    ios_version = os.getenv("IPHONEOS_DEPLOYMENT_TARGET", "13.0").replace(".", "_")
-    platform_machine = platform.machine()
-
-    if platform_machine == "x86_64":
-        expected_wheels = {
-            f"spam-0.1.0-cp313-cp313-ios_{ios_version}_x86_64_iphonesimulator.whl",
-        }
-
-    elif platform_machine == "arm64":
-        expected_wheels = {
-            f"spam-0.1.0-cp313-cp313-ios_{ios_version}_arm64_iphoneos.whl",
-            f"spam-0.1.0-cp313-cp313-ios_{ios_version}_arm64_iphonesimulator.whl",
-        }
-
-    assert set(actual_wheels) == expected_wheels
+    expected_wheels = utils.expected_wheels(
+        "spam", "0.1.0", platform="ios", python_abi_tags=["cp313-cp313"]
+    )
+    assert set(actual_wheels) == set(expected_wheels)
 
     # The warnings about cross-build notifications were silenced.
     captured = capfd.readouterr()
     assert "Your project configuration does not define any cross-build tools." not in captured.err
+
+
+def test_ios_test_command_without_python_dash_m(tmp_path, capfd):
+    """Test command should be able to run without python -m."""
+    if utils.platform != "macos":
+        pytest.skip("this test can only run on macOS")
+    if utils.get_xcode_version() < (13, 0):
+        pytest.skip("this test only works with Xcode 13.0 or greater")
+
+    project_dir = tmp_path / "project"
+    project = test_projects.new_c_project()
+    project.files["tests_module/__init__.py"] = ""
+    project.files["tests_module/__main__.py"] = textwrap.dedent("""
+        if __name__ == "__main__":
+            print("Hello from tests_module")
+    """)
+    project.generate(project_dir)
+
+    actual_wheels = utils.cibuildwheel_run(
+        project_dir,
+        add_env={
+            "CIBW_PLATFORM": "ios",
+            "CIBW_BUILD": "cp313-*",
+            "CIBW_TEST_COMMAND": "tests_module",
+            "CIBW_TEST_SOURCES": "tests_module",
+            "CIBW_XBUILD_TOOLS": "",
+        },
+    )
+
+    expected_wheels = utils.expected_wheels(
+        "spam", "0.1.0", platform="ios", python_abi_tags=["cp313-cp313"]
+    )
+    assert set(actual_wheels) == set(expected_wheels)
+
+    out, err = capfd.readouterr()
+
+    assert "iOS tests configured with a test command which doesn't start with 'python -m'" in err

test/utils.py

@@ -158,7 +158,9 @@ def expected_wheels(
     manylinux_versions: list[str] | None = None,
     musllinux_versions: list[str] | None = None,
     macosx_deployment_target: str = "10.9",
+    iphoneos_deployment_target: str = "13.0",
     machine_arch: str | None = None,
+    platform: str = platform,
     python_abi_tags: list[str] | None = None,
     include_universal2: bool = False,
     single_python: bool = False,
@@ -190,15 +192,17 @@ def expected_wheels(
         wheel
         for architecture in architectures
         for wheel in _expected_wheels(
-            package_name,
-            package_version,
-            architecture,
-            manylinux_versions,
-            musllinux_versions,
-            macosx_deployment_target,
-            python_abi_tags,
-            include_universal2,
-            single_python,
+            package_name=package_name,
+            package_version=package_version,
+            machine_arch=architecture,
+            manylinux_versions=manylinux_versions,
+            musllinux_versions=musllinux_versions,
+            macosx_deployment_target=macosx_deployment_target,
+            iphoneos_deployment_target=iphoneos_deployment_target,
+            platform=platform,
+            python_abi_tags=python_abi_tags,
+            include_universal2=include_universal2,
+            single_python=single_python,
         )
     ]
 
@@ -210,6 +214,8 @@ def _expected_wheels(
     manylinux_versions: list[str] | None,
     musllinux_versions: list[str] | None,
     macosx_deployment_target: str,
+    iphoneos_deployment_target: str,
+    platform: str,
     python_abi_tags: list[str] | None,
     include_universal2: bool,
     single_python: bool,
@@ -234,7 +240,9 @@ def _expected_wheels(
 
     if platform == "pyodide" and python_abi_tags is None:
         python_abi_tags = ["cp312-cp312"]
-    if python_abi_tags is None:
+    elif platform == "ios" and python_abi_tags is None:
+        python_abi_tags = ["cp313-cp313"]
+    elif python_abi_tags is None:
         python_abi_tags = [
             "cp38-cp38",
             "cp39-cp39",
@@ -314,6 +322,21 @@ def _expected_wheels(
 
             if include_universal2:
                 platform_tags.append(f"macosx_{min_macosx.replace('.', '_')}_universal2")
+
+        elif platform == "ios":
+            if machine_arch == "x86_64":
+                platform_tags = [
+                    f"ios_{iphoneos_deployment_target.replace('.', '_')}_x86_64_iphonesimulator"
+                ]
+            elif machine_arch == "arm64":
+                platform_tags = [
+                    f"ios_{iphoneos_deployment_target.replace('.', '_')}_arm64_iphoneos",
+                    f"ios_{iphoneos_deployment_target.replace('.', '_')}_arm64_iphonesimulator",
+                ]
+            else:
+                msg = f"Unsupported architecture {machine_arch!r} for iOS"
+                raise Exception(msg)
+
         else:
             msg = f"Unsupported platform {platform!r}"
             raise Exception(msg)