mirror of
https://github.com/apple/swift-nio
synced 2026-11-22 04:30:41 +00:00
### 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>
96 lines
3.8 KiB
Swift
96 lines
3.8 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the SwiftNIO open source project
|
|
//
|
|
// Copyright (c) 2023 Apple Inc. and the SwiftNIO project authors
|
|
// Licensed under Apache License v2.0
|
|
//
|
|
// See LICENSE.txt for license information
|
|
// See CONTRIBUTORS.txt for the list of SwiftNIO project authors
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
@_spi(Testing) import NIOFS
|
|
import XCTest
|
|
|
|
#if canImport(Darwin)
|
|
import Darwin
|
|
#elseif canImport(Glibc)
|
|
import Glibc
|
|
#elseif canImport(Android)
|
|
import Android
|
|
#endif
|
|
|
|
final class FileTypeTests: XCTestCase {
|
|
override func setUpWithError() throws {
|
|
#if os(Windows)
|
|
throw XCTSkip("The NIOFileSystem family is not yet functional on Windows")
|
|
#endif
|
|
}
|
|
|
|
func testFileTypeEquatable() {
|
|
let types = FileType.allCases
|
|
// Use indices to avoid using the `Equatable` conformance to write the tests.
|
|
for index in types.indices {
|
|
XCTAssertEqual(types[index], types[index])
|
|
for otherIndex in types.indices where otherIndex != index {
|
|
XCTAssertNotEqual(types[index], types[otherIndex])
|
|
}
|
|
}
|
|
}
|
|
|
|
func testFileTypeHashable() {
|
|
// Tests there is `Hashable` conformance is sufficient as we rely on the compiler
|
|
// synthesising the implementation.
|
|
let types = FileType.allCases
|
|
let unique = Set(types)
|
|
XCTAssertEqual(types.count, unique.count)
|
|
}
|
|
|
|
func testCustomStringConvertible() {
|
|
XCTAssertEqual(String(describing: FileType.block), "block")
|
|
XCTAssertEqual(String(describing: FileType.character), "character")
|
|
XCTAssertEqual(String(describing: FileType.directory), "directory")
|
|
XCTAssertEqual(String(describing: FileType.fifo), "fifo")
|
|
XCTAssertEqual(String(describing: FileType.regular), "regular")
|
|
XCTAssertEqual(String(describing: FileType.socket), "socket")
|
|
XCTAssertEqual(String(describing: FileType.symlink), "symlink")
|
|
XCTAssertEqual(String(describing: FileType.unknown), "unknown")
|
|
XCTAssertEqual(String(describing: FileType.whiteout), "whiteout")
|
|
}
|
|
|
|
func testConversionFromModeT() {
|
|
// `S_IFSOCK`/`S_IFLNK`/`S_IFBLK` don't exist on Windows.
|
|
#if !os(Windows)
|
|
XCTAssertEqual(FileType(platformSpecificMode: S_IFIFO), .fifo)
|
|
XCTAssertEqual(FileType(platformSpecificMode: S_IFCHR), .character)
|
|
XCTAssertEqual(FileType(platformSpecificMode: S_IFDIR), .directory)
|
|
XCTAssertEqual(FileType(platformSpecificMode: S_IFBLK), .block)
|
|
XCTAssertEqual(FileType(platformSpecificMode: S_IFREG), .regular)
|
|
XCTAssertEqual(FileType(platformSpecificMode: S_IFLNK), .symlink)
|
|
XCTAssertEqual(FileType(platformSpecificMode: S_IFSOCK), .socket)
|
|
#if canImport(Darwin)
|
|
XCTAssertEqual(FileType(platformSpecificMode: S_IFWHT), .whiteout)
|
|
#endif
|
|
#endif
|
|
}
|
|
|
|
func testConversionFromDirentType() {
|
|
// The `DT_*` constants aren't available on Windows.
|
|
#if !os(Windows)
|
|
XCTAssertEqual(FileType(direntType: numericCast(DT_FIFO)), .fifo)
|
|
XCTAssertEqual(FileType(direntType: numericCast(DT_CHR)), .character)
|
|
XCTAssertEqual(FileType(direntType: numericCast(DT_DIR)), .directory)
|
|
XCTAssertEqual(FileType(direntType: numericCast(DT_BLK)), .block)
|
|
XCTAssertEqual(FileType(direntType: numericCast(DT_REG)), .regular)
|
|
XCTAssertEqual(FileType(direntType: numericCast(DT_LNK)), .symlink)
|
|
XCTAssertEqual(FileType(direntType: numericCast(DT_SOCK)), .socket)
|
|
#if canImport(Darwin)
|
|
XCTAssertEqual(FileType(direntType: numericCast(DT_WHT)), .whiteout)
|
|
#endif
|
|
#endif
|
|
}
|
|
}
|