Add support for Windows

Disable tests relying on the executable since those aren't yet supported by SwiftPM, and tweak a couple platform-conditional pieces of code to support the Windows path.

Author: jakepetroules

.github/workflows/main.yml

@@ -16,6 +16,12 @@ jobs:
       linux_6_0_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error"
       linux_nightly_next_arguments_override: "--explicit-target-dependency-import-check error"
       linux_nightly_main_arguments_override: "--explicit-target-dependency-import-check error"
+      windows_6_0_enabled: true
+      windows_nightly_6_1_enabled: true
+      windows_nightly_main_enabled: true
+      windows_6_0_arguments_override: "--explicit-target-dependency-import-check error"
+      windows_nightly_6_1_arguments_override: "--explicit-target-dependency-import-check error"
+      windows_nightly_main_arguments_override: "--explicit-target-dependency-import-check error"
 
   integration-test:
     name: Integration test

.github/workflows/pull_request.yml

@@ -22,6 +22,12 @@ jobs:
       linux_6_0_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error"
       linux_nightly_next_arguments_override: "--explicit-target-dependency-import-check error"
       linux_nightly_main_arguments_override: "--explicit-target-dependency-import-check error"
+      windows_6_0_enabled: true
+      windows_nightly_6_1_enabled: true
+      windows_nightly_main_enabled: true
+      windows_6_0_arguments_override: "--explicit-target-dependency-import-check error"
+      windows_nightly_6_1_arguments_override: "--explicit-target-dependency-import-check error"
+      windows_nightly_main_arguments_override: "--explicit-target-dependency-import-check error"
 
   integration-test:
     name: Integration test

Package.swift

@@ -54,7 +54,7 @@ let package = Package(
         // Tests-only: Runtime library linked by generated code, and also
         // helps keep the runtime library new enough to work with the generated
         // code.
-        .package(url: "https://github.com/apple/swift-openapi-runtime", from: "1.3.2"),
+        .package(url: "https://github.com/apple/swift-openapi-runtime", from: "1.8.2"),
         .package(url: "https://github.com/apple/swift-http-types", from: "1.0.2"),
     ],
     targets: [
@@ -111,7 +111,9 @@ let package = Package(
         .testTarget(
             name: "OpenAPIGeneratorTests",
             dependencies: [
-                "swift-openapi-generator", .product(name: "ArgumentParser", package: "swift-argument-parser"),
+                // Everything except windows: https://github.com/swiftlang/swift-package-manager/issues/6367
+                .target(name: "swift-openapi-generator", condition: .when(platforms: [.android, .linux, .macOS, .openbsd, .wasi, .custom("freebsd")])),
+                .product(name: "ArgumentParser", package: "swift-argument-parser"),
             ],
             resources: [.copy("Resources")],
             swiftSettings: swiftSettings

Plugins/PluginsShared/PluginUtils.swift

@@ -64,7 +64,7 @@ enum PluginUtils {
 
     /// Find the config file.
     private static func findConfig(inputFiles: FileList, targetName: String) -> Result<Path, FileError> {
-        let matchedConfigs = inputFiles.filter { supportedConfigFiles.contains($0.path.lastComponent) }.map(\.path)
+        let matchedConfigs = inputFiles.filter { supportedConfigFiles.contains($0.path.lastComponent_fixed) }.map(\.path)
         guard matchedConfigs.count > 0 else {
             return .failure(FileError(targetName: targetName, fileKind: .config, issue: .noFilesFound))
         }
@@ -78,7 +78,7 @@ enum PluginUtils {
 
     /// Find the document file.
     private static func findDocument(inputFiles: FileList, targetName: String) -> Result<Path, FileError> {
-        let matchedDocs = inputFiles.filter { supportedDocFiles.contains($0.path.lastComponent) }.map(\.path)
+        let matchedDocs = inputFiles.filter { supportedDocFiles.contains($0.path.lastComponent_fixed) }.map(\.path)
         guard matchedDocs.count > 0 else {
             return .failure(FileError(targetName: targetName, fileKind: .document, issue: .noFilesFound))
         }
@@ -97,3 +97,23 @@ extension Array where Element == String {
         return "\(self.dropLast().joined(separator: separator))\(lastSeparator)\(self.last!)"
     }
 }
+
+extension PackagePlugin.Path {
+    /// Workaround for the ``lastComponent`` property being broken on Windows
+    /// due to hardcoded assumptions about the path separator being forward slash.
+    @available(_PackageDescription, deprecated: 6.0, message: "Use `URL` type instead of `Path`.")
+    public var lastComponent_fixed: String {
+        #if !os(Windows)
+        lastComponent
+        #else
+        // Find the last path separator.
+        guard let idx = string.lastIndex(where: { $0 == "/" || $0 == "\\" }) else {
+            // No path separators, so the basename is the whole string.
+            return self.string
+        }
+        // Otherwise, it's the string from (but not including) the last path
+        // separator.
+        return String(self.string.suffix(from: self.string.index(after: idx)))
+        #endif
+    }
+}

README.md

@@ -99,12 +99,12 @@ See also [Supported OpenAPI features][supported-openapi-features].
 
 ### Supported platforms and minimum versions
 
-The generator is used during development and is supported on macOS and Linux.
+The generator is used during development and is supported on macOS, Linux, and Windows.
 
 The generated code, runtime library, and transports are supported on more
 platforms, listed below.
 
-| Component                           | macOS     | Linux | iOS    | tvOS   | watchOS | visionOS |
+| Component                           | macOS     | Linux, Windows | iOS    | tvOS   | watchOS | visionOS |
 | ----------------------------------: | :---      | :---  | :-     | :--    | :-----  | :------  |
 | Generator plugin and CLI            | ✅ 10.15+ | ✅    | ✖️      | ✖️      | ✖️       | ✖️        |
 | Generated code and runtime library  | ✅ 10.15+ | ✅    | ✅ 13+ | ✅ 13+ | ✅ 6+   | ✅ 1+    |

Tests/OpenAPIGeneratorReferenceTests/CompatabilityTest.swift

@@ -358,14 +358,12 @@ fileprivate extension CompatibilityTest {
     func log(_ message: String) { print("\(name) \(message)") }
 
     var testCaseName: String {
-        /// The `name` property is `<test-suite-name>.<test-case-name>` on Linux,
-        /// and `-[<test-suite-name> <test-case-name>]` on macOS.
+        /// The `name` property is `-[<test-suite-name> <test-case-name>]` on Apple platforms (e.g. with an Objective-C runtime),
+        /// and `<test-suite-name>.<test-case-name>` elsewhere.
         #if canImport(Darwin)
         return String(name.split(separator: " ", maxSplits: 2).last!.dropLast())
-        #elseif os(Linux)
-        return String(name.split(separator: ".", maxSplits: 2).last!)
         #else
-        #error("Platform not supported")
+        return String(name.split(separator: ".", maxSplits: 2).last!)
         #endif
     }
 }
@@ -417,7 +415,7 @@ fileprivate extension URLSession {
     func data(from url: URL) async throws -> (Data, URLResponse) {
         #if canImport(Darwin)
         return try await data(from: url, delegate: nil)
-        #elseif os(Linux)
+        #else
         return try await withCheckedThrowingContinuation { continuation in
             dataTask(with: URLRequest(url: url)) { data, response, error in
                 if let error {
@@ -432,8 +430,6 @@ fileprivate extension URLSession {
             }
             .resume()
         }
-        #else
-        #error("Platform not supported")
         #endif
     }
 }

Tests/OpenAPIGeneratorTests/Test_GenerateOptions.swift

@@ -15,7 +15,11 @@ import XCTest
 import _OpenAPIGeneratorCore
 import OpenAPIKit
 import ArgumentParser
+
+// https://github.com/swiftlang/swift-package-manager/issues/6367
+#if !os(Windows)
 @testable import swift_openapi_generator
+#endif
 
 final class Test_GenerateOptions: XCTestCase {
 
@@ -29,6 +33,8 @@ final class Test_GenerateOptions: XCTestCase {
         )
     }
 
+    // https://github.com/swiftlang/swift-package-manager/issues/6367
+    #if !os(Windows)
     func testRunGeneratorThrowsErrorDiagnostic() async throws {
         let outputDirectory = URL(fileURLWithPath: "/invalid/path")
         let docsDirectory = resourcesDirectory.appendingPathComponent("Docs")
@@ -45,4 +51,5 @@ final class Test_GenerateOptions: XCTestCase {
             XCTAssertEqual(diagnostic.severity, .error, "Expected diagnostic severity to be `.error`")
         } catch { XCTFail("Expected to throw a Diagnostic `.error`, but threw a different error: \(error)") }
     }
+    #endif
 }