-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Conform RuntimeError to HTTPResponseConvertible (#135)
### Motivation apple/swift-openapi-generator#609 (comment) ### Modifications Confirm `RuntimeError` to `HTTPResponseConvertible` and provide granular status codes. ### Result Response codes for bad user input will be 4xx (instead of 500) ### Test Plan Unit tests. --------- Co-authored-by: Gayathri Sairamkrishnan <[email protected]>
- Loading branch information
1 parent
56e9fea
commit 7e80669
Showing
2 changed files
with
100 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
//===----------------------------------------------------------------------===// | ||
// | ||
// This source file is part of the SwiftOpenAPIGenerator open source project | ||
// | ||
// Copyright (c) 2024 Apple Inc. and the SwiftOpenAPIGenerator project authors | ||
// Licensed under Apache License v2.0 | ||
// | ||
// See LICENSE.txt for license information | ||
// See CONTRIBUTORS.txt for the list of SwiftOpenAPIGenerator project authors | ||
// | ||
// SPDX-License-Identifier: Apache-2.0 | ||
// | ||
//===----------------------------------------------------------------------===// | ||
|
||
import HTTPTypes | ||
@_spi(Generated) @testable import OpenAPIRuntime | ||
import XCTest | ||
|
||
struct MockRuntimeErrorHandler: Sendable { | ||
var failWithError: (any Error)? = nil | ||
func greet(_ input: String) async throws -> String { | ||
if let failWithError { throw failWithError } | ||
guard input == "hello" else { throw TestError() } | ||
return "bye" | ||
} | ||
|
||
static let requestBody: HTTPBody = HTTPBody("hello") | ||
static let responseBody: HTTPBody = HTTPBody("bye") | ||
} | ||
|
||
final class Test_RuntimeError: XCTestCase { | ||
func testRuntimeError_withUnderlyingErrorNotConforming_returns500() async throws { | ||
let server = UniversalServer( | ||
handler: MockRuntimeErrorHandler(failWithError: RuntimeError.transportFailed(TestError())), | ||
middlewares: [ErrorHandlingMiddleware()] | ||
) | ||
let response = try await server.handle( | ||
request: .init(soar_path: "/", method: .post), | ||
requestBody: MockHandler.requestBody, | ||
metadata: .init(), | ||
forOperation: "op", | ||
using: { MockRuntimeErrorHandler.greet($0) }, | ||
deserializer: { request, body, metadata in | ||
let body = try XCTUnwrap(body) | ||
return try await String(collecting: body, upTo: 10) | ||
}, | ||
serializer: { output, _ in fatalError() } | ||
) | ||
XCTAssertEqual(response.0.status, .internalServerError) | ||
} | ||
|
||
func testRuntimeError_withUnderlyingErrorConforming_returnsCorrectStatusCode() async throws { | ||
let server = UniversalServer( | ||
handler: MockRuntimeErrorHandler(failWithError: TestErrorConvertible.testError("Test Error")), | ||
middlewares: [ErrorHandlingMiddleware()] | ||
) | ||
let response = try await server.handle( | ||
request: .init(soar_path: "/", method: .post), | ||
requestBody: MockHandler.requestBody, | ||
metadata: .init(), | ||
forOperation: "op", | ||
using: { MockRuntimeErrorHandler.greet($0) }, | ||
deserializer: { request, body, metadata in | ||
let body = try XCTUnwrap(body) | ||
return try await String(collecting: body, upTo: 10) | ||
}, | ||
serializer: { output, _ in fatalError() } | ||
) | ||
XCTAssertEqual(response.0.status, .badGateway) | ||
} | ||
} | ||
|
||
enum TestErrorConvertible: Error, HTTPResponseConvertible { | ||
case testError(String) | ||
/// HTTP status code for error cases | ||
public var httpStatus: HTTPTypes.HTTPResponse.Status { .badGateway } | ||
} |