test: add windows integration test (#335)

Co-authored-by: Christian Clauss <cclauss@me.com>

Author: legendecas

.github/workflows/python_tests.yml

@@ -1,4 +1,3 @@
-# TODO: Enable os: windows-latest
 # TODO: Enable pytest --doctest-modules
 
 name: Python_tests
@@ -14,11 +13,15 @@ jobs:
       fail-fast: false
       max-parallel: 5
       matrix:
-        os: [macos-15-intel, macos-latest, ubuntu-latest] # , windows-latest]
+        os: [macos-15-intel, macos-latest, ubuntu-latest, windows-latest]
         python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
         include:
           - os: macos-26
             python-version: 3.x
+          - os: ubuntu-24.04-arm  # Ubuntu on ARM
+            python-version: "3.14"
+          - os: windows-11-arm  # Windows on ARM
+            python-version: "3.14"
     steps:
       - uses: actions/checkout@v6
       - name: Set up Python ${{ matrix.python-version }}

.gitignore

@@ -144,3 +144,7 @@ static
 
 test/fixtures/out
 *.actual
+*.sln
+*.vcproj
+!test/fixtures/expected-win32/**/*.sln
+!test/fixtures/expected-win32/**/*.vcproj

pylib/gyp/generator/ninja_test.py

@@ -11,26 +11,36 @@
 from pathlib import Path
 
 from gyp.generator import ninja
+from gyp.MSVSVersion import SelectVisualStudioVersion
+
+
+def _has_visual_studio():
+    """Check if Visual Studio can be detected by gyp's registry-based detection."""
+    if not sys.platform.startswith("win"):
+        return False
+    try:
+        SelectVisualStudioVersion("auto", allow_fallback=False)
+        return True
+    except ValueError:
+        return False
 
 
 class TestPrefixesAndSuffixes(unittest.TestCase):
+    @unittest.skipUnless(
+        _has_visual_studio(),
+        "requires Windows with a Visual Studio installation detected via the registry",
+    )
     def test_BinaryNamesWindows(self):
-        # These cannot run on non-Windows as they require a VS installation to
-        # correctly handle variable expansion.
-        if sys.platform.startswith("win"):
-            writer = ninja.NinjaWriter(
-                "foo", "wee", ".", ".", "build.ninja", ".", "build.ninja", "win"
-            )
-            spec = {"target_name": "wee"}
-            self.assertTrue(
-                writer.ComputeOutputFileName(spec, "executable").endswith(".exe")
-            )
-            self.assertTrue(
-                writer.ComputeOutputFileName(spec, "shared_library").endswith(".dll")
-            )
-            self.assertTrue(
-                writer.ComputeOutputFileName(spec, "static_library").endswith(".lib")
-            )
+        writer = ninja.NinjaWriter(
+            "foo", "wee", ".", ".", "build.ninja", ".", "build.ninja", "win"
+        )
+        spec = {"target_name": "wee"}
+        for key, ext in {
+            "executable": ".exe",
+            "shared_library": ".dll",
+            "static_library": ".lib",
+        }:
+            self.assertTrue(writer.ComputeOutputFileName(spec, key).endswith(ext))
 
     def test_BinaryNamesLinux(self):
         writer = ninja.NinjaWriter(

test/fixtures/expected-win32/msvs/integration.sln

@@ -0,0 +1,16 @@
+Microsoft Visual Studio Solution File, Format Version 9.00
+# Visual Studio 2005
+Project("{*}") = "test", "test.vcproj", "{*}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Default|Win32 = Default|Win32
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{*}.Default|Win32.ActiveCfg = Default|Win32
+		{*}.Default|Win32.Build.0 = Default|Win32
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+EndGlobal

test/fixtures/expected-win32/msvs/test.vcproj

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="Windows-1252"?><VisualStudioProject Keyword="Win32Proj" Name="test" ProjectGUID="{*}" ProjectType="Visual C++" RootNamespace="test" Version="8.00"><Platforms><Platform Name="Win32"/></Platforms><ToolFiles/><Configurations><Configuration ConfigurationType="1" IntermediateDirectory="$(ConfigurationName)\obj\$(ProjectName)\" Name="Default|Win32" OutputDirectory="$(SolutionDir)$(ConfigurationName)\"><Tool AdditionalDependencies="$(NOINHERIT)" AdditionalLibraryDirectories="mylib" Name="VCLinkerTool" OutputFile="$(OutDir)\$(ProjectName).exe"/><Tool AdditionalIncludeDirectories="include" Name="VCCLCompilerTool" ProgramDataBaseFileName="$(IntDir)$(ProjectName)\vc80.pdb"/><Tool AdditionalIncludeDirectories="include" Name="VCResourceCompilerTool"/></Configuration></Configurations><References/><Files><File RelativePath="test.cc"/><File RelativePath="integration.gyp"/></Files><Globals/></VisualStudioProject>

test/integration_test.py

@@ -5,47 +5,56 @@
 import os
 import re
 import shutil
+import sys
 import unittest
 
 import gyp
 
 fixture_dir = os.path.join(os.path.dirname(__file__), "fixtures")
 gyp_file = os.path.join(os.path.dirname(__file__), "fixtures/integration.gyp")
 
-supported_sysnames = {"darwin", "linux"}
-sysname = os.uname().sysname.lower()
+if sys.platform == "win32":
+    sysname = sys.platform
+else:
+    sysname = os.uname().sysname.lower()
 expected_dir = os.path.join(fixture_dir, f"expected-{sysname}")
 
 
-class TestGyp(unittest.TestCase):
-    def setUp(self) -> None:
-        if sysname not in supported_sysnames:
-            self.skipTest(f"Unsupported system: {sysname}")
-        shutil.rmtree(os.path.join(fixture_dir, "out"), ignore_errors=True)
+def assert_file(test, actual, expected) -> None:
+    actual_filepath = os.path.join(fixture_dir, actual)
+    expected_filepath = os.path.join(expected_dir, expected)
+
+    with open(expected_filepath) as in_file:
+        in_bytes = in_file.read()
+        in_bytes = in_bytes.strip()
+        expected_bytes = re.escape(in_bytes)
+    expected_bytes = expected_bytes.replace("\\*", ".*")
+    expected_re = re.compile(expected_bytes)
 
-    def assert_file(self, actual, expected) -> None:
-        actual_filepath = os.path.join(fixture_dir, actual)
-        expected_filepath = os.path.join(expected_dir, expected)
+    with open(actual_filepath) as in_file:
+        actual_bytes = in_file.read()
+        actual_bytes = actual_bytes.strip()
 
-        with open(expected_filepath) as in_file:
-            expected_bytes = re.escape(in_file.read())
-        expected_bytes = expected_bytes.replace("\\*", ".*")
-        expected_re = re.compile(expected_bytes)
+    try:
+        test.assertRegex(actual_bytes, expected_re)
+    except Exception:
+        shutil.copyfile(actual_filepath, f"{expected_filepath}.actual")
+        raise
 
-        with open(actual_filepath) as in_file:
-            actual_bytes = in_file.read()
 
-        try:
-            self.assertRegex(actual_bytes, expected_re)
-        except Exception:
-            shutil.copyfile(actual_filepath, f"{expected_filepath}.actual")
-            raise
+class TestGypUnix(unittest.TestCase):
+    supported_sysnames = {"darwin", "linux"}
+
+    def setUp(self) -> None:
+        if sysname not in TestGypUnix.supported_sysnames:
+            self.skipTest(f"Unsupported system: {sysname}")
+        shutil.rmtree(os.path.join(fixture_dir, "out"), ignore_errors=True)
 
     def test_ninja(self) -> None:
         rc = gyp.main(["-f", "ninja", "--depth", fixture_dir, gyp_file])
         assert rc == 0
 
-        self.assert_file("out/Default/obj/test.ninja", "ninja/test.ninja")
+        assert_file(self, "out/Default/obj/test.ninja", "ninja/test.ninja")
 
     def test_make(self) -> None:
         rc = gyp.main(
@@ -61,10 +70,24 @@ def test_make(self) -> None:
         )
         assert rc == 0
 
-        self.assert_file("out/test.target.mk", "make/test.target.mk")
+        assert_file(self, "out/test.target.mk", "make/test.target.mk")
 
     def test_cmake(self) -> None:
         rc = gyp.main(["-f", "cmake", "--depth", fixture_dir, gyp_file])
         assert rc == 0
 
-        self.assert_file("out/Default/CMakeLists.txt", "cmake/CMakeLists.txt")
+        assert_file(self, "out/Default/CMakeLists.txt", "cmake/CMakeLists.txt")
+
+
+class TestGypWindows(unittest.TestCase):
+    def setUp(self) -> None:
+        if sys.platform != "win32":
+            self.skipTest("Windows-only test")
+        shutil.rmtree(os.path.join(fixture_dir, "out"), ignore_errors=True)
+
+    def test_msvs(self) -> None:
+        rc = gyp.main(["-f", "msvs", "--depth", fixture_dir, gyp_file])
+        assert rc == 0
+
+        assert_file(self, "test.vcproj", "msvs/test.vcproj")
+        assert_file(self, "integration.sln", "msvs/integration.sln")