fix: set VSCMD_ARG_TGT_ARCH based on targeted architecture (#1876)

* set VSCMD_ARG_TGT_ARCH based on targetted architecture * only set VSCMD_ARG_TGT_ARCH if not already set * add unit tests to check setuptools correctly identifies windows arch * only run tests on windows * arm64 fails on azure pipelines (only) * Update windows.py * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Apply suggestions from code review Co-authored-by: Joe Rickerby <joerick@mac.com> * update test_env_set to validate FatalError is raised on env collision * remove noqa ARG001 (no longer needed) --------- Co-authored-by: Henry Schreiner <HenrySchreinerIII@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Joe Rickerby <joerick@mac.com>
2024-07-12 14:32:42 -04:00
parent cac121a67d
commit de84624d70
3 changed files with 105 additions and 0 deletions
@@ -0,0 +1,92 @@
+import contextlib
+import sys
+from pathlib import Path
+from typing import Dict
+
+import pytest
+import setuptools._distutils.util
+
+from cibuildwheel.errors import FatalError
+from cibuildwheel.util import CIProvider, detect_ci_provider
+from cibuildwheel.windows import PythonConfiguration, setup_setuptools_cross_compile
+
+# monkeypatching os.name is too flaky. E.g. It works on my machine, but fails in pipeline
+if not sys.platform.startswith("win"):
+    pytest.skip("Windows-only tests", allow_module_level=True)
+
+
+@contextlib.contextmanager
+def patched_environment(monkeypatch: pytest.MonkeyPatch, environment: Dict[str, str]):
+    with monkeypatch.context() as mp:
+        for envvar, val in environment.items():
+            mp.setenv(name=envvar, value=val)
+        yield
+
+
+def test_x86(tmp_path: Path, monkeypatch: pytest.MonkeyPatch):
+    arch = "32"
+    environment: Dict[str, str] = {}
+
+    configuration = PythonConfiguration("irrelevant", arch, "irrelevant", None)
+
+    setup_setuptools_cross_compile(tmp_path, configuration, tmp_path, environment)
+    with patched_environment(monkeypatch, environment):
+        target_platform = setuptools._distutils.util.get_platform()
+
+    assert environment["VSCMD_ARG_TGT_ARCH"] == "x86"
+    assert target_platform == "win32"
+
+
+def test_x64(tmp_path: Path, monkeypatch: pytest.MonkeyPatch):
+    arch = "64"
+    environment: Dict[str, str] = {}
+
+    configuration = PythonConfiguration("irrelevant", arch, "irrelevant", None)
+
+    setup_setuptools_cross_compile(tmp_path, configuration, tmp_path, environment)
+    with patched_environment(monkeypatch, environment):
+        target_platform = setuptools._distutils.util.get_platform()
+
+    assert environment["VSCMD_ARG_TGT_ARCH"] == "x64"
+    assert target_platform == "win-amd64"
+
+
+@pytest.mark.skipif(
+    detect_ci_provider() == CIProvider.azure_pipelines, reason="arm64 not recognised on azure"
+)
+def test_arm(tmp_path: Path, monkeypatch: pytest.MonkeyPatch):
+    arch = "ARM64"
+    environment: Dict[str, str] = {}
+
+    configuration = PythonConfiguration("irrelevant", arch, "irrelevant", None)
+
+    setup_setuptools_cross_compile(tmp_path, configuration, tmp_path, environment)
+    with patched_environment(monkeypatch, environment):
+        target_platform = setuptools._distutils.util.get_platform()
+
+    assert environment["VSCMD_ARG_TGT_ARCH"] == "arm64"
+    assert target_platform == "win-arm64"
+
+
+def test_env_set(tmp_path: Path):
+    arch = "32"
+    environment = {"VSCMD_ARG_TGT_ARCH": "x64"}
+
+    configuration = PythonConfiguration("irrelevant", arch, "irrelevant", None)
+
+    with pytest.raises(FatalError, match="VSCMD_ARG_TGT_ARCH"):
+        setup_setuptools_cross_compile(tmp_path, configuration, tmp_path, environment)
+
+
+def test_env_blank(tmp_path: Path, monkeypatch: pytest.MonkeyPatch):
+    arch = "32"
+    environment = {"VSCMD_ARG_TGT_ARCH": ""}
+
+    configuration = PythonConfiguration("irrelevant", arch, "irrelevant", None)
+
+    setup_setuptools_cross_compile(tmp_path, configuration, tmp_path, environment)
+    with patched_environment(monkeypatch, environment):
+        target_platform = setuptools._distutils.util.get_platform()
+
+    assert environment["VSCMD_ARG_TGT_ARCH"] == "x86"
+    assert target_platform == "win32"