Repository navigation
[Windows] Compile the low-hanging test targets - #3663
Merged
Merged
Conversation
`Posix.close(descriptor:)` was gated out on Windows only because it sat inside the `#if !os(Windows)` block of socket syscalls (next to `Posix.shutdown`), even though its body already handled Windows (reading `errno` via `_get_errno`). Define the `sysClose` alias as `_close` on Windows (alongside the existing `_read`/`_write`/etc. aliases) and lift `close(descriptor:)` out of the `#if !os(Windows)` block so it compiles on all platforms. `shutdown` and the socket calls remain gated. No behavior change off Windows: `close` was already compiled there.
Gets 8 more test targets compiling on Windows (NIOTestUtilsTests, NIOConcurrencyHelpersTests, NIOCoreTests, NIOEmbeddedTests, NIOHTTP1Tests, NIOFSTests, NIOFSIntegrationTests, NIOFSFoundationCompatTests), joining the 6 that already did. NIOPosixTests and NIOFoundationCompatTests (a `CNIOPosix` module issue) are left as follow-ups. The changes are compile-only; they do not aim to make the tests functional yet. Following a gate-out-plus-minimal-shim approach: - Add a tiny `#if os(Windows)` `usleep` shim (backed by `Sleep`) once per affected test target, and a Windows branch to the `#error` C-library check in NIOConcurrencyHelpersTests. - Implement the temp-file/pipe test helpers on Windows rather than stubbing them: `withPipe` via `_pipe`, `openTemporaryFile` via `_mktemp_s` + `_sopen_s`, and `createTemporaryDirectory` via a GUID plus `CreateDirectoryW`. `Posix.close` is used unconditionally now that it is available on Windows (preceding commit). - Gate test logic that relies on genuinely-unavailable APIs behind `#if !os(Windows)`: `System.enumerateInterfaces`, `ChannelOptions.socket` with `IPPROTO_IP`/`IP_TTL`, `mkfifo`-based tests, the POSIX-`stat`-shaped `FileInfoTests`, the `S_IFSOCK`/`DT_*` conversion tests, and the `openat` oflag-bit test. - Gate the `Data(contentsOf:maximumSizeAllowed:)` test with the same condition the library uses for that initializer. - In SyscallTests, type the xattr buffer as `CChar` (what the API takes; identical to `PlatformChar` off Windows) rather than `CInterop.PlatformChar`. The `usleep` shim is duplicated once per affected test target rather than shared: there is no test-only support target these all depend on (the only shared dependencies, NIOCore and NIOTestUtils, are shipping libraries), and adding one is out of scope for this compile-only change. It can be centralised later. The `NIOHTTP1Tests` and `NIOPosixTests` copies of `TestUtils.swift` are intentional duplicates; both get the same Windows helper implementations to stay in sync (NIOPosixTests's full compile remains a follow-up). Two Windows-only library shim tweaks make the NIOFS `OpenOptions` gap values and `Errno.noData` `@_spi(Testing) public`, matching the accessibility of the swift-system equivalents on other platforms so the tests' SPI import can reach them. No behavior change off Windows: every change is guarded by `#if os(Windows)` / `#if !os(Windows)`, and the one shared edit (`PlatformChar` -> `CChar`) is identical on POSIX.
…ndows `ChannelOptions.Types.SocketOption.init(level:name:)`, `ChannelOptions.socket`, and the `socket(_:_:)` option accessor are gated `#if !os(Windows)` with no stated reason. Document it: on Windows, WinSDK imports the socket option level/name constants (`IPPROTO_IP`, `IP_TTL`, `SO_REUSEADDR`, …) as enumeration cases rather than plain integers, so they don't fit the integer `SocketOptionLevel`/`SocketOptionName` typealiases the integer-based API uses (see `NIOBSDSocket.OptionLevel.ipv6` reading `IPPROTO_IPV6.rawValue`). Windows callers use the typed `NIOBSDSocket.Option` accessors instead. Comment-only.
glbrntt
reviewed
Jul 17, 2026
glbrntt
reviewed
Jul 17, 2026
glbrntt
approved these changes
Jul 17, 2026
glbrntt
added a commit
that referenced
this pull request
Jul 24, 2026
…ationCompatTests) (#3665) ## Motivation Follow-up to #3663 (which got the "low-hanging" test targets compiling on Windows). This finishes the job by getting the **last two** test targets — `NIOPosixTests` and `NIOFoundationCompatTests` — compiling on Windows, so **all 16 test targets now build**, and switches Windows CI to `swift build --build-tests`. These are **compile-only** changes: the goal is compilation, not runtime pass. Verified by building on a Windows ARM64 VM with `swift build --build-tests`. ## What's here 1. **Compile `NIOFoundationCompatTests`** — the target imports the `NIO` umbrella (in `WaitSpinningRunLoopTests`, for `MultiThreadedEventLoopGroup`) but only declared `NIOCore`/`NIOFoundationCompat` as dependencies. `NIO` re-exports `NIOPosix`, which imports the `CNIOPosix` **C module**; Linux/macOS resolve that transitively, but on Windows the C-module map isn't in the target's search path unless declared, giving the opaque `<unknown>:0: error: missing required module 'CNIOPosix'`. Fix: declare the `NIO` dependency it actually uses. 2. **Compile `NIOPosixTests`** — the deeply-POSIX target. Gate-out-plus-minimal-shim: - `import WinSDK` where only `sockaddr`/`timeval`/`in_addr` field or type access was missing (`MemberImportVisibility`) — this alone cleared the two largest files (`SocketAddressTest`, `HappyEyeballsTest`). - Real fixes where cheap: `pipe` → `_pipe` (via `ucrt`), an `STDOUT_FILENO` shim, `Thread.sleep` instead of `sleep`, and letting `IOResult` type inference pick `ssize_t`. - `#if !os(Windows)` gating (per-method where possible, to preserve Windows-compilable coverage) for genuinely-unavailable APIs: `fcntl`/`O_NONBLOCK`/`O_ASYNC`/`F_GETFL`/`F_SETFL`, `Posix.fcntl`, `Posix.socketpair`, the integer socket-option API (`ChannelOptions.socket`, `SOL_SOCKET`, `SO_REUSEADDR`, `so_timestamp`), `poll`/`pollfd`, `cmsg`/`msghdr` construction, `NonBlockingFileIO.lstat`/`symlink`/`listDirectory`/`createDirectory`, vsock CID/connect tests, `/dev/null` syscall-wrapper perf tests, and socket-handle (`NIOBSDSocket.Handle` `UInt64` vs `CInt`) mismatches. - Whole-file gating only where a file is pervasively unsupported: the SAL mock harness and its dependents (`SyscallAbstractionLayer[Context]`, `SALChannelTests`, `SALEventLoopTests`) — it's built on `CInt` fds and can't compile against Windows's `UInt64` socket handles without a larger rework; `ControlMessageTests` (POSIX `msghdr`/control-message throughout); and `MulticastTest` (deprecated `enumerateInterfaces`/`NIONetworkInterface`). 3. **Build the test targets in CI** — change the Windows matrix command from `swift build` to `swift build --build-tests` in `main.yml` and `pull_request.yml`. ## Notes for reviewers - No behavior change off Windows: every edit is behind `#if os(Windows)` / `#if !os(Windows)`; the few shared-line changes (`Thread.sleep`, `IOResult` inference, an IUO force-unwrap of `msg_name`) are identical on POSIX. - The tests are **compiled, not run** on Windows yet. Running them needs real Winsock work (socket handle types, etc.) and is the natural next step. --------- Co-authored-by: George Barnett <gbarnett@apple.com>
glbrntt
added a commit
that referenced
this pull request
Jul 29, 2026
… in CI (#3680) ### Motivation: All of the test targets now compile on Windows (#3663, #3665), but `swift test` doesn't yet pass: a number of tests exercise functionality that isn't supported or isn't yet functional on Windows, some crash or hang, and a few are flaky on the WSAPoll-based selector. Before the Windows unit tests can run in CI, those tests need to be skipped (with reasons) so a full `swift test` exits cleanly. ### Modifications: Skip the tests that don't pass on Windows, using `XCTSkip` / Swift Testing's `.disabled` / a gated `setUp` where a fixture itself traps, each with a reason. Broadly: - **Unsupported transports/APIs:** Unix domain sockets, datagram/UDP channels, pipe channels, raw sockets, vsock, pre-connected sockets, and `FileRegion` sends. - **Whole suites** for subsystems that aren't functional on Windows yet, including the **NIOFileSystem family** (`NIOFSTests`, `NIOFSIntegrationTests`, `NIOFSFoundationCompatTests`) whose Windows syscall shims are still stubbed, plus `EchoServerClientTest`, `ChannelTests`, `DatagramChannelTests`, `StreamChannelTest`, `FileRegionTest`, `PipeChannelTest`, `RawSocketBootstrapTests`, `ThreadTest`, and `SocketOptionProviderTest`. - **Real crashes surfaced by a full run:** `System.enumerateDevices()` (mis-sized `GetAdaptersAddresses` buffer), the WSAPoll selector trapping on an invalid fd and on schedule-after-shutdown, and a connection-reset promise leak. - **Flaky, timing-sensitive tests:** the event-loop tick-count metrics tests (the WSAPoll selector wakes far more often than epoll/kqueue). Then enable the Windows 6.3 + nightly jobs in the reusable unit-tests workflow (which runs `swift test`) in both the PR and push workflows, and drop the separate build-only Windows job (which only ran `swift build --build-tests`). Windows uses the default `swift test` arguments rather than the Linux `-Xswiftc -warnings-as-errors` override, because a `#warning` in the (skipped) stream-channel tests would otherwise fail the build. All skips are Windows-only; there is no behaviour change on other platforms. ### Result: `swift test` passes on Windows, and the Windows unit tests run in CI. --------- Co-authored-by: George Barnett <gbarnett@apple.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Follow-up to #3649 (all non-test targets now build on Windows). This gets the bulk of the test targets compiling on Windows so we can start moving toward running them in CI.
Of the 16 test targets, 6 already compiled unchanged. This brings 8 more to a clean compile, leaving only two as dedicated follow-ups:
NIOPosixTests— large, many distinct Winsock/POSIX issues; deserves its own PR.NIOFoundationCompatTests— amissing required module 'CNIOPosix'issue to investigate separately.The changes are compile-only — they don't aim to make the tests pass on Windows yet. Verified by building each target on a Windows ARM64 VM; not yet wired into CI (CI still builds products only, since the two deferred targets would fail
--build-tests).What's here
Three commits:
Posix.closeavailable on Windows — it was gated out only because it sat inside the socket-syscalls#if !os(Windows)block (next toshutdown), even though its body already handled Windows. DefinesysClose = _closeand liftclose(descriptor:)out of that block. No behavior change off Windows.#if os(Windows)usleepshim (backed bySleep), once per affected target, plus a Windows branch for the#errorC-library check.withPipe→_pipe,openTemporaryFile→_mktemp_s+_sopen_s,createTemporaryDirectory→ a GUID +CreateDirectoryW.#if !os(Windows):System.enumerateInterfaces,ChannelOptions.socket(IPPROTO_IP, IP_TTL),mkfifo-based tests, the POSIX-stat-shapedFileInfoTests, theS_IFSOCK/DT_*conversion tests, and theopenatoflag-bit test.OpenOptionsgap values andErrno.noData@_spi(Testing) public, matching how swift-system exposes the equivalents elsewhere (the tests reach them via an SPI import).NIOHTTP1TestsandNIOPosixTestscopies ofTestUtils.swiftare intentional duplicates and get identical Windows helper implementations to stay in sync.SocketOption's integer API is unavailable on Windows — comment-only: WinSDK imports the socket option level/name constants as enumeration cases, not plain integers, so they don't fit the integerSocketOptionLevel/SocketOptionNametypealiases.Notes for reviewers
#if os(Windows)/#if !os(Windows); the one shared edit (a test buffer typedCCharinstead ofCInterop.PlatformChar) is identical on POSIX.usleepshim is duplicated per target rather than shared: there's no test-only support target these all depend on (the shared deps,NIOCore/NIOTestUtils, are shipping libraries). It can be centralised later if desired.