New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Typealias RequestError to avoid KituraContracts import #1267
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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,82 @@ | ||
/** | ||
* Copyright IBM Corporation 2018 | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
**/ | ||
|
||
import XCTest | ||
import Foundation | ||
|
||
@testable import Kitura | ||
|
||
#if os(Linux) | ||
import Glibc | ||
#else | ||
import Darwin | ||
#endif | ||
|
||
// This file does not import KituraContracts and is relying on the typealias of | ||
// RequestError. This tests that a Codable handler can be declared, and built and | ||
// run without error in the absence of this import. Other existing tests that | ||
// import KituraContracts should be sufficient to show that the typealias does not | ||
// interfere in that case. | ||
class TestBridgingRequestError: KituraTest { | ||
|
||
static var allTests: [(String, (TestBridgingRequestError) -> () throws -> Void)] { | ||
return [ | ||
("testRequestError", testRequestError) | ||
] | ||
} | ||
|
||
/// An error message that will be returned as a RequestError body. Equatable | ||
/// in order to assert that the correct body was received in the response. | ||
struct AccessError: Codable, Equatable { | ||
let errorReason: String | ||
|
||
static func ==(lhs: TestBridgingRequestError.AccessError, rhs: TestBridgingRequestError.AccessError) -> Bool { | ||
return lhs.errorReason == rhs.errorReason | ||
} | ||
} | ||
|
||
/// The error instance that will be used when responding, and used to validate | ||
/// that the deserialized response contains the same error. | ||
static let expectedError = AccessError(errorReason: "impossible") | ||
|
||
/// Used only in the signature of our route, never created as we return an error | ||
/// instead. | ||
struct Dummy: Codable { | ||
let dummy: String | ||
} | ||
|
||
let router = TestBridgingRequestError.setupRouter() | ||
|
||
/// Tests that a RequestError can be received, of the correct class, and that | ||
/// a custom error body containing the expected content can be decoded. | ||
func testRequestError() { | ||
buildServerTest(router, timeout: 30) | ||
.request("get", path: "/mission") | ||
.hasStatus(.badRequest) | ||
.hasContentType(withPrefix: "application/json") | ||
.hasData(TestBridgingRequestError.expectedError) | ||
.run() | ||
} | ||
|
||
static func setupRouter() -> Router { | ||
let router = Router() | ||
router.get("/mission") { (respondWith: ([Dummy]?, RequestError?) -> Void) in | ||
let error = RequestError(.badRequest, body: expectedError) | ||
respondWith(nil, error) | ||
} | ||
return router | ||
} | ||
} |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need a dummy class like https://github.com/IBM-Swift/Kitura/blob/a8144547ed284befec973a0154790f208eb234d1/Sources/Kitura/HTTPStatusCode.swift#L20 ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As far as I can tell, this dummy class was only necessary because the file otherwise contains only a
typealias
. In this case I dropped the typealias into the existingCodableRouter.swift
since I could argue it belongs there.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK as long as Jazzy is generating the typealias OK then we're fine :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tested locally, it generates fine.