[Generator] Multipart support

Package.swift

@@ -64,7 +64,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", .upToNextMinor(from: "0.3.6")),
+        .package(url: "https://github.com/apple/swift-openapi-runtime", branch: "main"),
 
         // Build and preview docs
         .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),

Sources/PetstoreConsumerTestCore/Assertions.swift

@@ -61,3 +61,73 @@ public func XCTAssertEqualStringifiedData(
     if let body = try expression1() { data = try await Data(collecting: body, upTo: .max) } else { data = .init() }
     XCTAssertEqualStringifiedData(data, try expression2(), message(), file: file, line: line)
 }
+fileprivate extension UInt8 {
+    var asHex: String {
+        let original: String
+        switch self {
+        case 0x0d: original = "CR"
+        case 0x0a: original = "LF"
+        default: original = "\(UnicodeScalar(self)) "
+        }
+        return String(format: "%02x \(original)", self)
+    }
+}
+/// Asserts that the data matches the expected value.
+public func XCTAssertEqualData<C1: Collection, C2: Collection>(
+    _ expression1: @autoclosure () throws -> C1?,
+    _ expression2: @autoclosure () throws -> C2,
+    _ message: @autoclosure () -> String = "Data doesn't match.",
+    file: StaticString = #filePath,
+    line: UInt = #line
+) where C1.Element == UInt8, C2.Element == UInt8 {
+    do {
+        guard let actualBytes = try expression1() else {
+            XCTFail("First value is nil", file: file, line: line)
+            return
+        }
+        let expectedBytes = try expression2()
+        if ArraySlice(actualBytes) == ArraySlice(expectedBytes) { return }
+        let actualCount = actualBytes.count
+        let expectedCount = expectedBytes.count
+        let minCount = min(actualCount, expectedCount)
+        print("Printing both byte sequences, first is the actual value and second is the expected one.")
+        for (index, byte) in zip(actualBytes.prefix(minCount), expectedBytes.prefix(minCount)).enumerated() {
+            print("\(String(format: "%04d", index)): \(byte.0 != byte.1 ? "x" : " ") \(byte.0.asHex) | \(byte.1.asHex)")
+        }
+        let direction: String
+        let extraBytes: ArraySlice<UInt8>
+        if actualCount > expectedCount {
+            direction = "Actual bytes has extra bytes"
+            extraBytes = ArraySlice(actualBytes.dropFirst(minCount))
+        } else if expectedCount > actualCount {
+            direction = "Actual bytes is missing expected bytes"
+            extraBytes = ArraySlice(expectedBytes.dropFirst(minCount))
+        } else {
+            direction = ""
+            extraBytes = []
+        }
+        if !extraBytes.isEmpty {
+            print("\(direction):")
+            for (index, byte) in extraBytes.enumerated() {
+                print("\(String(format: "%04d", minCount + index)): \(byte.asHex)")
+            }
+        }
+        XCTFail(
+            "Actual stringified data '\(String(decoding: actualBytes, as: UTF8.self))' doesn't equal to expected stringified data '\(String(decoding: expectedBytes, as: UTF8.self))'. Details: \(message())",
+            file: file,
+            line: line
+        )
+    } catch { XCTFail(error.localizedDescription, file: file, line: line) }
+}
+/// Asserts that the data matches the expected value.
+public func XCTAssertEqualData<C: Collection>(
+    _ expression1: @autoclosure () throws -> HTTPBody?,
+    _ expression2: @autoclosure () throws -> C,
+    _ message: @autoclosure () -> String = "Data doesn't match.",
+    file: StaticString = #filePath,
+    line: UInt = #line
+) async throws where C.Element == UInt8 {
+    let data: Data
+    if let body = try expression1() { data = try await Data(collecting: body, upTo: .max) } else { data = .init() }
+    XCTAssertEqualData(data, try expression2(), message(), file: file, line: line)
+}

Sources/PetstoreConsumerTestCore/Common.swift

@@ -74,6 +74,103 @@ public extension Data {
     static var quotedEfghString: String { #""efgh""# }
 
     static var efgh: Data { Data(efghString.utf8) }
+
+    static let crlf: ArraySlice<UInt8> = [0xd, 0xa]
+
+    static var multipartBodyString: String { String(decoding: multipartBodyAsSlice, as: UTF8.self) }
+
+    static var multipartBodyAsSlice: [UInt8] {
+        var bytes: [UInt8] = []
+        bytes.append(contentsOf: "--__X_SWIFT_OPENAPI_GENERATOR_BOUNDARY__".utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"content-disposition: form-data; name="efficiency""#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"content-length: 3"#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: "4.2".utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: "--__X_SWIFT_OPENAPI_GENERATOR_BOUNDARY__".utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"content-disposition: form-data; name="name""#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"content-length: 21"#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: "Vitamin C and friends".utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: "--__X_SWIFT_OPENAPI_GENERATOR_BOUNDARY__--".utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: crlf)
+        return bytes
+    }
+
+    static var multipartBody: Data { Data(multipartBodyAsSlice) }
+
+    static var multipartTypedBodyAsSlice: [UInt8] {
+        var bytes: [UInt8] = []
+        bytes.append(contentsOf: "--__X_SWIFT_OPENAPI_GENERATOR_BOUNDARY__".utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"content-disposition: form-data; filename="process.log"; name="log""#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"content-length: 35"#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"content-type: text/plain"#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"x-log-type: unstructured"#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: "here be logs!\nand more lines\nwheee\n".utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: "--__X_SWIFT_OPENAPI_GENERATOR_BOUNDARY__".utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"content-disposition: form-data; filename="fun.stuff"; name="keyword""#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"content-length: 3"#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"content-type: text/plain"#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: "fun".utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: "--__X_SWIFT_OPENAPI_GENERATOR_BOUNDARY__".utf8)
+
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"content-disposition: form-data; filename="barfoo.txt"; name="foobar""#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"content-length: 0"#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: "".utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: "--__X_SWIFT_OPENAPI_GENERATOR_BOUNDARY__".utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"content-disposition: form-data; name="metadata""#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"content-length: 42"#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"content-type: application/json; charset=utf-8"#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: "{\n  \"createdAt\" : \"2023-01-18T10:04:11Z\"\n}".utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: "--__X_SWIFT_OPENAPI_GENERATOR_BOUNDARY__".utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"content-disposition: form-data; name="keyword""#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"content-length: 3"#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: #"content-type: text/plain"#.utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: "joy".utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: "--__X_SWIFT_OPENAPI_GENERATOR_BOUNDARY__".utf8)
+        bytes.append(contentsOf: "--".utf8)
+        bytes.append(contentsOf: crlf)
+        bytes.append(contentsOf: crlf)
+        return bytes
+    }
 }
 
 public extension HTTPRequest {

Sources/_OpenAPIGeneratorCore/Layers/StructuredSwiftRepresentation.swift

@@ -236,7 +236,7 @@ struct VariableDescription: Equatable, Codable {
     /// The name of the variable.
     ///
     /// For example, in `let foo = 42`, `left` is `foo`.
-    var left: String
+    var left: Expression
 
     /// The type of the variable.
     ///
@@ -1106,6 +1106,49 @@ extension Declaration {
         setter: [CodeBlock]? = nil,
         modify: [CodeBlock]? = nil
 
+    ) -> Self {
+        .variable(
+            accessModifier: accessModifier,
+            isStatic: isStatic,
+            kind: kind,
+            left: .identifierPattern(left),
+            type: type,
+            right: right,
+            getter: getter,
+            getterEffects: getterEffects,
+            setter: setter,
+            modify: modify
+        )
+    }
+
+    /// A variable declaration.
+    ///
+    /// For example: `let foo = 42`.
+    /// - Parameters:
+    ///   - accessModifier: An access modifier.
+    ///   - isStatic: A Boolean value that indicates whether the variable
+    ///   is static.
+    ///   - kind: The variable binding kind.
+    ///   - left: The name of the variable.
+    ///   - type: The type of the variable.
+    ///   - right: The expression to be assigned to the variable.
+    ///   - getter: Body code for the getter of the variable.
+    ///   - getterEffects: Effects of the getter.
+    ///   - setter: Body code for the setter of the variable.
+    ///   - modify: Body code for the `_modify` accessor.
+    /// - Returns: Variable declaration.
+    static func variable(
+        accessModifier: AccessModifier? = nil,
+        isStatic: Bool = false,
+        kind: BindingKind,
+        left: Expression,
+        type: ExistingTypeDescription? = nil,
+        right: Expression? = nil,
+        getter: [CodeBlock]? = nil,
+        getterEffects: [FunctionKeyword] = [],
+        setter: [CodeBlock]? = nil,
+        modify: [CodeBlock]? = nil
+
     ) -> Self {
         .variable(
             .init(
@@ -1521,14 +1564,6 @@ extension MemberAccessDescription {
     static func dot(_ member: String) -> Self { .init(right: member) }
 }
 
-extension Expression: ExpressibleByStringLiteral, ExpressibleByNilLiteral, ExpressibleByArrayLiteral {
-    init(arrayLiteral elements: Expression...) { self = .literal(.array(elements)) }
-
-    init(stringLiteral value: String) { self = .literal(.string(value)) }
-
-    init(nilLiteral: ()) { self = .literal(.nil) }
-}
-
 extension LiteralDescription: ExpressibleByStringLiteral, ExpressibleByNilLiteral, ExpressibleByArrayLiteral {
     init(arrayLiteral elements: Expression...) { self = .array(elements) }
 
@@ -1544,14 +1579,14 @@ extension VariableDescription {
     /// For example `var foo = 42`.
     /// - Parameter name: The name of the variable.
     /// - Returns: A new mutable variable declaration.
-    static func `var`(_ name: String) -> Self { Self.init(kind: .var, left: name) }
+    static func `var`(_ name: String) -> Self { Self.init(kind: .var, left: .identifierPattern(name)) }
 
     /// Returns a new immutable variable declaration.
     ///
     /// For example `let foo = 42`.
     /// - Parameter name: The name of the variable.
     /// - Returns: A new immutable variable declaration.
-    static func `let`(_ name: String) -> Self { Self.init(kind: .let, left: name) }
+    static func `let`(_ name: String) -> Self { Self.init(kind: .let, left: .identifierPattern(name)) }
 }
 
 extension Expression {
@@ -1563,10 +1598,6 @@ extension Expression {
     func equals(_ rhs: Expression) -> AssignmentDescription { .init(left: self, right: rhs) }
 }
 
-extension FunctionArgumentDescription: ExpressibleByStringLiteral {
-    init(stringLiteral value: String) { self = .init(expression: .literal(.string(value))) }
-}
-
 extension FunctionSignatureDescription {
     /// Returns a new function signature description that has the access
     /// modifier updated to the specified one.

Sources/_OpenAPIGeneratorCore/Renderer/TextBasedRenderer.swift

@@ -543,18 +543,21 @@ struct TextBasedRenderer: RendererProtocol {
     /// Renders the specified variable declaration.
     func renderVariable(_ variable: VariableDescription) {
         do {
-            var words: [String] = []
-            if let accessModifier = variable.accessModifier { words.append(renderedAccessModifier(accessModifier)) }
-            if variable.isStatic { words.append("static") }
-            words.append(renderedBindingKind(variable.kind))
-            let labelWithOptionalType: String
+            if let accessModifier = variable.accessModifier {
+                writer.writeLine(renderedAccessModifier(accessModifier) + " ")
+                writer.nextLineAppendsToLastLine()
+            }
+            if variable.isStatic {
+                writer.writeLine("static ")
+                writer.nextLineAppendsToLastLine()
+            }
+            writer.writeLine(renderedBindingKind(variable.kind) + " ")
+            writer.nextLineAppendsToLastLine()
+            renderExpression(variable.left)
             if let type = variable.type {
-                labelWithOptionalType = "\(variable.left): \(renderedExistingTypeDescription(type))"
-            } else {
-                labelWithOptionalType = variable.left
+                writer.nextLineAppendsToLastLine()
+                writer.writeLine(": \(renderedExistingTypeDescription(type))")
             }
-            words.append(labelWithOptionalType)
-            writer.writeLine(words.joinedWords())
         }
 
         if let right = variable.right {
@@ -883,3 +886,15 @@ fileprivate extension String {
     /// - Returns: A new string where each line has been transformed using the given closure.
     func transformingLines(_ work: (String) -> String) -> [String] { asLines().map(work) }
 }
+
+extension TextBasedRenderer {
+
+    /// Returns the provided expression rendered as a string.
+    /// - Parameter expression: The expression.
+    /// - Returns: The string representation of the expression.
+    static func renderedExpressionAsString(_ expression: Expression) -> String {
+        let renderer = TextBasedRenderer.default
+        renderer.renderExpression(expression)
+        return renderer.renderedContents()
+    }
+}

Sources/_OpenAPIGeneratorCore/Translator/ClientTranslator/translateClientMethod.swift

@@ -81,7 +81,7 @@ extension ClientFileTranslator {
             )
             requestBlocks.append(.expression(requestBodyExpr))
         } else {
-            requestBodyReturnExpr = nil
+            requestBodyReturnExpr = .literal(nil)
         }
 
         let returnRequestExpr: Expression = .return(.tuple([.identifierPattern("request"), requestBodyReturnExpr]))

Sources/_OpenAPIGeneratorCore/Translator/CommonTranslations/translateAllAnyOneOf.swift

@@ -23,7 +23,7 @@ enum AllOrAnyOf {
     case anyOf
 }
 
-extension FileTranslator {
+extension TypesFileTranslator {
 
     /// Returns a declaration for an allOf or anyOf schema.
     ///

Sources/_OpenAPIGeneratorCore/Translator/CommonTranslations/translateArray.swift

@@ -13,7 +13,7 @@
 //===----------------------------------------------------------------------===//
 import OpenAPIKit
 
-extension FileTranslator {
+extension TypesFileTranslator {
 
     /// Returns a list of declarations for an array schema.
     ///

Sources/_OpenAPIGeneratorCore/Translator/CommonTranslations/translateCodable.swift

@@ -52,7 +52,7 @@ extension FileTranslator {
                 trailingCodeBlocks: [
                     .expression(
                         .assignment(
-                            left: .identifierPattern("additionalProperties"),
+                            left: .identifierPattern(Constants.AdditionalProperties.variableName),
                             right: .try(
                                 .identifierPattern("decoder").dot("decodeAdditionalProperties")
                                     .call([knownKeysFunctionArg])
@@ -86,7 +86,12 @@ extension FileTranslator {
                     .expression(
                         .try(
                             .identifierPattern("encoder").dot("encodeAdditionalProperties")
-                                .call([.init(label: nil, expression: .identifierPattern("additionalProperties"))])
+                                .call([
+                                    .init(
+                                        label: nil,
+                                        expression: .identifierPattern(Constants.AdditionalProperties.variableName)
+                                    )
+                                ])
                         )
                     )
                 ]