Tests: Enable tests on Windows (#8466)

bkhouri · web-flow · commit cc0b1a5d1668 · 2025-04-09T03:51:59.000-07:00
Enable additional tests on Windows host platform - Enable a few `AsyncProcessTests` - Enable the lone skipped test in `EnvironmentTests` - Enable the only skipped test in `Tests/SourceKitLSPAPITests/SourceKitLSPAPITests.swift` - Enable the only skipped test in `Tests/BuildTests/BuildSystemDelegateTests.swift` - Enable the lone skipped test in `Tests/BuildTests/LLBuildManifestBuilderTests.swift` - Replace usages of `fixwin` with `AbsolutePath.pathString` Related to: #8433 rdar://148248105
diff --git a/Tests/BasicsTests/AsyncProcessTests.swift b/Tests/BasicsTests/AsyncProcessTests.swift
@@ -23,14 +23,19 @@ import func TSCBasic.withTemporaryFile
 import func TSCTestSupport.withCustomEnv
 
 final class AsyncProcessTests: XCTestCase {
+    #if os(Windows)
+    let executableExt = ".exe"
+    #else
+    let executableExt = ""
+    #endif
 
-    override func setUp() async throws {
-        try skipOnWindowsAsTestCurrentlyFails()
-    }
-    
     func testBasics() throws {
+        try skipOnWindowsAsTestCurrentlyFails(because: """
+            threw error "missingExecutableProgram(program: "echo.exe")"
+        """)
+
         do {
-            let process = AsyncProcess(args: "echo", "hello")
+            let process = AsyncProcess(args: "echo\(executableExt)", "hello")
             try process.launch()
             let result = try process.waitUntilExit()
             XCTAssertEqual(try result.utf8Output(), "hello\n")
@@ -46,27 +51,26 @@ final class AsyncProcessTests: XCTestCase {
         }
     }
 
-    func testPopen() throws {
-        #if os(Windows)
-        let echo = "echo.exe"
-        #else
-        let echo = "echo"
-        #endif
+    func testPopenBasic() throws {
+        try skipOnWindowsAsTestCurrentlyFails(because: """
+            threw error "missingExecutableProgram(program: "echo.exe")"
+        """)
+
         // Test basic echo.
-        XCTAssertEqual(try AsyncProcess.popen(arguments: [echo, "hello"]).utf8Output(), "hello\n")
+        XCTAssertEqual(try AsyncProcess.popen(arguments: ["echo\(executableExt)", "hello"]).utf8Output(), "hello\n")
+    }
 
+    func testPopenWithBufferLargerThanAllocated() throws {
+        try skipOnWindowsAsTestCurrentlyFails(because: """
+            threw error "missingExecutableProgram(program: "cat.exe")"
+        """)
         // Test buffer larger than that allocated.
         try withTemporaryFile { file in
             let count = 10000
             let stream = BufferedOutputByteStream()
             stream.send(Format.asRepeating(string: "a", count: count))
             try localFileSystem.writeFileContents(file.path, bytes: stream.bytes)
-            #if os(Windows)
-            let cat = "cat.exe"
-            #else
-            let cat = "cat"
-            #endif
-            let outputCount = try AsyncProcess.popen(args: cat, file.path.pathString).utf8Output().count
+            let outputCount = try AsyncProcess.popen(args: "cat\(executableExt)", file.path.pathString).utf8Output().count
             XCTAssert(outputCount == count)
         }
     }
@@ -119,8 +123,12 @@ final class AsyncProcessTests: XCTestCase {
     }
 
     func testCheckNonZeroExit() throws {
+        try skipOnWindowsAsTestCurrentlyFails(because: """
+            threw error "missingExecutableProgram(program: "echo.exe")"
+        """)
+
         do {
-            let output = try AsyncProcess.checkNonZeroExit(args: "echo", "hello")
+            let output = try AsyncProcess.checkNonZeroExit(args: "echo\(executableExt)", "hello")
             XCTAssertEqual(output, "hello\n")
         }
 
@@ -134,8 +142,12 @@ final class AsyncProcessTests: XCTestCase {
 
     @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
     func testCheckNonZeroExitAsync() async throws {
+        try skipOnWindowsAsTestCurrentlyFails(because: """
+            threw error "missingExecutableProgram(program: "echo.exe")"
+        """)
+
         do {
-            let output = try await AsyncProcess.checkNonZeroExit(args: "echo", "hello")
+            let output = try await AsyncProcess.checkNonZeroExit(args: "echo\(executableExt)", "hello")
             XCTAssertEqual(output, "hello\n")
         }
 
@@ -148,6 +160,8 @@ final class AsyncProcessTests: XCTestCase {
     }
 
     func testFindExecutable() throws {
+        try skipOnWindowsAsTestCurrentlyFails(because: "Assertion failure when trying to find ls executable")
+
         try testWithTemporaryDirectory { tmpdir in
             // This process should always work.
             XCTAssertTrue(AsyncProcess.findExecutable("ls") != nil)
@@ -192,7 +206,11 @@ final class AsyncProcessTests: XCTestCase {
     }
 
     func testThreadSafetyOnWaitUntilExit() throws {
-        let process = AsyncProcess(args: "echo", "hello")
+        try skipOnWindowsAsTestCurrentlyFails(because: """
+            threw error "missingExecutableProgram(program: "echo.exe")"
+        """)
+
+        let process = AsyncProcess(args: "echo\(executableExt)", "hello")
         try process.launch()
 
         var result1 = ""
@@ -217,7 +235,11 @@ final class AsyncProcessTests: XCTestCase {
 
     @available(macOS 12.0, iOS 15.0, tvOS 15.0, watchOS 8.0, *)
     func testThreadSafetyOnWaitUntilExitAsync() async throws {
-        let process = AsyncProcess(args: "echo", "hello")
+        try skipOnWindowsAsTestCurrentlyFails(because: """
+            threw error "missingExecutableProgram(program: "echo.exe")"
+        """)
+
+        let process = AsyncProcess(args: "echo\(executableExt)", "hello")
         try process.launch()
 
         let t1 = Task {
@@ -236,6 +258,10 @@ final class AsyncProcessTests: XCTestCase {
     }
 
     func testStdin() throws {
+        try skipOnWindowsAsTestCurrentlyFails(because: """
+        threw error "Error Domain=NSCocoaErrorDomain Code=3584 "(null)"UserInfo={NSUnderlyingError=Error Domain=org.swift.Foundation.WindowsError Code=193 "(null)"}"
+        """)
+
         var stdout = [UInt8]()
         let process = AsyncProcess(scriptName: "in-to-out", outputRedirection: .stream(stdout: { stdoutBytes in
             stdout += stdoutBytes
@@ -253,6 +279,10 @@ final class AsyncProcessTests: XCTestCase {
     }
 
     func testStdoutStdErr() throws {
+        try skipOnWindowsAsTestCurrentlyFails(because: """
+        threw error "Error Domain=NSCocoaErrorDomain Code=3584 "(null)"UserInfo={NSUnderlyingError=Error Domain=org.swift.Foundation.WindowsError Code=193 "(null)"}"
+        """)
+
         // A simple script to check that stdout and stderr are captured separatly.
         do {
             let result = try AsyncProcess.popen(scriptName: "simple-stdout-stderr")
@@ -279,6 +309,10 @@ final class AsyncProcessTests: XCTestCase {
 
     @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
     func testStdoutStdErrAsync() async throws {
+        try skipOnWindowsAsTestCurrentlyFails(because: """
+        threw error "Error Domain=NSCocoaErrorDomain Code=3584 "(null)"UserInfo={NSUnderlyingError=Error Domain=org.swift.Foundation.WindowsError Code=193 "(null)"}"
+        """)
+
         // A simple script to check that stdout and stderr are captured separatly.
         do {
             let result = try await AsyncProcess.popen(scriptName: "simple-stdout-stderr")
@@ -304,6 +338,10 @@ final class AsyncProcessTests: XCTestCase {
     }
 
     func testStdoutStdErrRedirected() throws {
+        try skipOnWindowsAsTestCurrentlyFails(because: """
+        threw error "Error Domain=NSCocoaErrorDomain Code=3584 "(null)"UserInfo={NSUnderlyingError=Error Domain=org.swift.Foundation.WindowsError Code=193 "(null)"}"
+        """)
+
         // A simple script to check that stdout and stderr are captured in the same location.
         do {
             let process = AsyncProcess(
@@ -332,6 +370,10 @@ final class AsyncProcessTests: XCTestCase {
     }
 
     func testStdoutStdErrStreaming() throws {
+        try skipOnWindowsAsTestCurrentlyFails(because: """
+        threw error "Error Domain=NSCocoaErrorDomain Code=3584 "(null)"UserInfo={NSUnderlyingError=Error Domain=org.swift.Foundation.WindowsError Code=193 "(null)"}"
+        """)
+
         var stdout = [UInt8]()
         var stderr = [UInt8]()
         let process = AsyncProcess(scriptName: "long-stdout-stderr", outputRedirection: .stream(stdout: { stdoutBytes in
@@ -348,6 +390,10 @@ final class AsyncProcessTests: XCTestCase {
     }
 
     func testStdoutStdErrStreamingRedirected() throws {
+        try skipOnWindowsAsTestCurrentlyFails(because: """
+        threw error "Error Domain=NSCocoaErrorDomain Code=3584 "(null)"UserInfo={NSUnderlyingError=Error Domain=org.swift.Foundation.WindowsError Code=193 "(null)"}"
+        """)
+
         var stdout = [UInt8]()
         var stderr = [UInt8]()
         let process = AsyncProcess(scriptName: "long-stdout-stderr", outputRedirection: .stream(stdout: { stdoutBytes in
@@ -364,6 +410,10 @@ final class AsyncProcessTests: XCTestCase {
     }
 
     func testWorkingDirectory() throws {
+        try skipOnWindowsAsTestCurrentlyFails(because: """
+            threw error "missingExecutableProgram(program: "cat.exe")"
+        """)
+
         guard #available(macOS 10.15, *) else {
             // Skip this test since it's not supported in this OS.
             return
@@ -385,7 +435,7 @@ final class AsyncProcessTests: XCTestCase {
             try localFileSystem.writeFileContents(childPath, bytes: ByteString("child"))
 
             do {
-                let process = AsyncProcess(arguments: ["cat", "file"], workingDirectory: tempDirPath)
+                let process = AsyncProcess(arguments: ["cat\(executableExt)", "file"], workingDirectory: tempDirPath)
                 try process.launch()
                 let result = try process.waitUntilExit()
                 XCTAssertEqual(try result.utf8Output(), "parent")
@@ -403,12 +453,15 @@ final class AsyncProcessTests: XCTestCase {
     func testAsyncStream() async throws {
         // rdar://133548796
         try XCTSkipIfCI()
+        try skipOnWindowsAsTestCurrentlyFails(because: """
+        threw error "Error Domain=NSCocoaErrorDomain Code=3584 "(null)"UserInfo={NSUnderlyingError=Error Domain=org.swift.Foundation.WindowsError Code=193 "(null)"}"
+        """)
 
         let (stdoutStream, stdoutContinuation) = AsyncProcess.ReadableStream.makeStream()
         let (stderrStream, stderrContinuation) = AsyncProcess.ReadableStream.makeStream()
 
         let process = AsyncProcess(
-            scriptName: "echo",
+            scriptName: "echo\(executableExt)",
             outputRedirection: .stream {
                 stdoutContinuation.yield($0)
             } stderr: {
@@ -460,9 +513,12 @@ final class AsyncProcessTests: XCTestCase {
     func testAsyncStreamHighLevelAPI() async throws {
         // rdar://133548796
         try XCTSkipIfCI()
+        try skipOnWindowsAsTestCurrentlyFails(because: """
+        threw error "Error Domain=NSCocoaErrorDomain Code=3584 "(null)"UserInfo={NSUnderlyingError=Error Domain=org.swift.Foundation.WindowsError Code=193 "(null)"}"
+        """)
 
         let result = try await AsyncProcess.popen(
-            scriptName: "echo",
+            scriptName: "echo\(executableExt)",
             stdout: { stdin, stdout in
                 var counter = 0
                 stdin.write("Hello \(counter)\n")
diff --git a/Tests/BasicsTests/Environment/EnvironmentTests.swift b/Tests/BasicsTests/Environment/EnvironmentTests.swift
@@ -15,7 +15,6 @@
 import Basics
 
 import XCTest
-import _InternalTestSupport // for skipOnWindowsAsTestCurrentlyFails()
 
 final class EnvironmentTests: XCTestCase {
     func test_init() {
@@ -103,8 +102,6 @@ final class EnvironmentTests: XCTestCase {
     /// Important: This test is inherently race-prone, if it is proven to be
     /// flaky, it should run in a singled threaded environment/removed entirely.
     func test_current() throws {
-        try skipOnWindowsAsTestCurrentlyFails(because: "ProcessInfo.processInfo.environment[pathEnvVarName] return nil in the docker container")
-
         #if os(Windows)
         let pathEnvVarName = "Path"
         #else
diff --git a/Tests/BuildTests/BuildSystemDelegateTests.swift b/Tests/BuildTests/BuildSystemDelegateTests.swift
@@ -30,13 +30,18 @@ final class BuildSystemDelegateTests: XCTestCase {
     }
 
     func testFilterNonFatalCodesignMessages() async throws {
-        try skipOnWindowsAsTestCurrentlyFails()
+        try skipOnWindowsAsTestCurrentlyFails(because: "Package fails to build when the test is being executed")
 
         try XCTSkipIf(!UserToolchain.default.supportsSDKDependentTests(), "skipping because test environment doesn't support this test")
         // Note: we can re-use the `TestableExe` fixture here since we just need an executable.
+        #if os(Windows)
+        let executableExt = ".exe"
+        #else
+        let executableExt = ""
+        #endif
         try await fixture(name: "Miscellaneous/TestableExe") { fixturePath in
             _ = try await executeSwiftBuild(fixturePath)
-            let execPath = fixturePath.appending(components: ".build", "debug", "TestableExe1")
+            let execPath = fixturePath.appending(components: ".build", "debug", "TestableExe1\(executableExt)")
             XCTAssertTrue(localFileSystem.exists(execPath), "executable not found at '\(execPath)'")
             try localFileSystem.removeFileTree(execPath)
             let (fullLog, _) = try await executeSwiftBuild(fixturePath)
diff --git a/Tests/BuildTests/LLBuildManifestBuilderTests.swift b/Tests/BuildTests/LLBuildManifestBuilderTests.swift
@@ -195,8 +195,6 @@ final class LLBuildManifestBuilderTests: XCTestCase {
     
     /// Verifies that two modules with the same name but different triples don't share same build manifest keys.
     func testToolsBuildTriple() async throws {
-        try skipOnWindowsAsTestCurrentlyFails()
-
         let (graph, fs, scope) = try macrosPackageGraph()
         let productsTriple = Triple.x86_64MacOS
         let toolsTriple = Triple.arm64Linux
@@ -221,6 +219,6 @@ final class LLBuildManifestBuilderTests: XCTestCase {
 
         XCTAssertNotNil(manifest.commands["C.SwiftSyntax-aarch64-unknown-linux-gnu-debug-tool.module"])
         // Ensure that Objects.LinkFileList is -tool suffixed.
-        XCTAssertNotNil(manifest.commands["/path/to/build/aarch64-unknown-linux-gnu/debug/MMIOMacros-tool.product/Objects.LinkFileList"])
+        XCTAssertNotNil(manifest.commands[AbsolutePath("/path/to/build/aarch64-unknown-linux-gnu/debug/MMIOMacros-tool.product/Objects.LinkFileList").pathString])
     }
 }
diff --git a/Tests/SourceKitLSPAPITests/SourceKitLSPAPITests.swift b/Tests/SourceKitLSPAPITests/SourceKitLSPAPITests.swift
@@ -24,8 +24,6 @@ import XCTest
 
 final class SourceKitLSPAPITests: XCTestCase {
     func testBasicSwiftPackage() async throws {
-        try skipOnWindowsAsTestCurrentlyFails()
-
         let fs = InMemoryFileSystem(emptyFiles:
             "/Pkg/Sources/exe/main.swift",
             "/Pkg/Sources/exe/README.md",
@@ -89,7 +87,7 @@ final class SourceKitLSPAPITests: XCTestCase {
                 "-package-name", "pkg",
                 "-emit-dependencies",
                 "-emit-module",
-                "-emit-module-path", "/path/to/build/\(plan.destinationBuildParameters.triple)/debug/Modules/exe.swiftmodule"
+                "-emit-module-path", AbsolutePath("/path/to/build/\(plan.destinationBuildParameters.triple)/debug/Modules/exe.swiftmodule").pathString
             ],
             resources: [.init(filePath: "/Pkg/Sources/exe/Resources/some_file.txt")],
             ignoredFiles: [.init(filePath: "/Pkg/Sources/exe/exe.docc")],
@@ -104,7 +102,7 @@ final class SourceKitLSPAPITests: XCTestCase {
                 "-package-name", "pkg",
                 "-emit-dependencies",
                 "-emit-module",
-                "-emit-module-path", "/path/to/build/\(plan.destinationBuildParameters.triple)/debug/Modules/lib.swiftmodule"
+                "-emit-module-path", AbsolutePath("/path/to/build/\(plan.destinationBuildParameters.triple)/debug/Modules/lib.swiftmodule").pathString
             ],
             resources: [.init(filePath: "/Pkg/Sources/lib/Resources/some_file.txt")],
             ignoredFiles: [.init(filePath: "/Pkg/Sources/lib/lib.docc")],
@@ -115,7 +113,7 @@ final class SourceKitLSPAPITests: XCTestCase {
             for: "plugin",
             graph: graph,
             partialArguments: [
-                "-I", "/fake/manifestLib/path"
+                "-I", AbsolutePath("/fake/manifestLib/path").pathString
             ],
             isPartOfRootPackage: true,
             destination: .host
@@ -318,7 +316,7 @@ final class SourceKitLSPAPITests: XCTestCase {
                     "-package-name", "pkg",
                     "-emit-dependencies",
                     "-emit-module",
-                    "-emit-module-path", "/path/to/build/\(destinationBuildParameters.triple)/debug/Modules/lib.swiftmodule".fixwin
+                    "-emit-module-path", AbsolutePath("/path/to/build/\(destinationBuildParameters.triple)/debug/Modules/lib.swiftmodule").pathString
                 ],
                 isPartOfRootPackage: true
             )
@@ -402,13 +400,3 @@ extension SourceKitLSPAPI.BuildDescription {
         return result
     }
 }
-
-extension String {
-    var fixwin: String {
-        #if os(Windows)
-        return self.replacingOccurrences(of: "/", with: "\\")
-        #else
-        return self
-        #endif
-    }
-}
diff --git a/Tests/WorkspaceTests/PrebuiltsTests.swift b/Tests/WorkspaceTests/PrebuiltsTests.swift

Original file line number	Diff line number	Diff line change
`@@ -195,8 +195,6 @@ final class LLBuildManifestBuilderTests: XCTestCase {`
`195`	`195`
`196`	`196`	`/// Verifies that two modules with the same name but different triples don't share same build manifest keys.`
`197`	`197`	`func testToolsBuildTriple() async throws {`
`198`		`- try skipOnWindowsAsTestCurrentlyFails()`
`199`		`-`
`200`	`198`	`let (graph, fs, scope) = try macrosPackageGraph()`
`201`	`199`	`let productsTriple = Triple.x86_64MacOS`
`202`	`200`	`let toolsTriple = Triple.arm64Linux`
`@@ -221,6 +219,6 @@ final class LLBuildManifestBuilderTests: XCTestCase {`
`221`	`219`
`222`	`220`	`XCTAssertNotNil(manifest.commands["C.SwiftSyntax-aarch64-unknown-linux-gnu-debug-tool.module"])`
`223`	`221`	`// Ensure that Objects.LinkFileList is -tool suffixed.`
`224`		`- XCTAssertNotNil(manifest.commands["/path/to/build/aarch64-unknown-linux-gnu/debug/MMIOMacros-tool.product/Objects.LinkFileList"])`
	`222`	`+ XCTAssertNotNil(manifest.commands[AbsolutePath("/path/to/build/aarch64-unknown-linux-gnu/debug/MMIOMacros-tool.product/Objects.LinkFileList").pathString])`
`225`	`223`	`}`
`226`	`224`	`}`