Enable swift PM tests on Linux and macOS #118
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| name: "Mocker SPM CI" | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - master | ||
| pull_request: | ||
| branches: | ||
| - '*' | ||
|
|
||
| jobs: | ||
| macos-run-tests: | ||
| name: Unit Tests (macOS) | ||
| runs-on: macos-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - name: Run Tests | ||
| run: swift test | ||
|
|
||
| linux-run-tests: | ||
| name: Unit Tests (Linux) | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - name: Run Tests | ||
| run: swift test |
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
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 |
|---|---|---|
|
|
@@ -7,6 +7,9 @@ | |
| // | ||
|
|
||
| import XCTest | ||
| #if canImport(FoundationNetworking) | ||
| import FoundationNetworking | ||
| #endif | ||
| @testable import Mocker | ||
|
|
||
| final class MockerTests: XCTestCase { | ||
|
|
@@ -36,17 +39,15 @@ final class MockerTests: XCTestCase { | |
| let expectation = self.expectation(description: "Data request should succeed") | ||
| let originalURL = URL(string: "https://avatars3.githubusercontent.com/u/26250426?v=4&s=400")! | ||
|
|
||
| let mockedData = MockedData.botAvatarImageFileUrl.data | ||
| let mock = Mock(url: originalURL, dataType: .imagePNG, statusCode: 200, data: [ | ||
| .get: mockedData | ||
| ]) | ||
|
|
||
| mock.register() | ||
| URLSession.shared.dataTask(with: originalURL) { (data, _, error) in | ||
| XCTAssertNil(error) | ||
| XCTAssertEqual(data, mockedData, "Image should be returned mocked") | ||
| expectation.fulfill() | ||
| }.resume() | ||
|
|
||
|
|
@@ -58,16 +59,14 @@ final class MockerTests: XCTestCase { | |
| let expectation = self.expectation(description: "Data request should succeed") | ||
| let originalURL = URL(string: "https://www.wetransfer.com/sample-image.png") | ||
|
|
||
| let mockedData = MockedData.botAvatarImageFileUrl.data | ||
| Mock(fileExtensions: "png", dataType: .imagePNG, statusCode: 200, data: [ | ||
| .get: mockedData | ||
| ]).register() | ||
|
|
||
| URLSession.shared.dataTask(with: originalURL!) { (data, _, error) in | ||
| XCTAssertNil(error) | ||
| XCTAssertEqual(data, mockedData, "Image should be returned mocked") | ||
| expectation.fulfill() | ||
| }.resume() | ||
|
|
||
|
|
@@ -82,23 +81,15 @@ final class MockerTests: XCTestCase { | |
| Mock(fileExtensions: "png", dataType: .imagePNG, statusCode: 400, data: [ | ||
| .get: Data() | ||
| ]).register() | ||
|
|
||
| let mockedData = MockedData.botAvatarImageFileUrl.data | ||
| Mock(url: originalURL, ignoreQuery: true, dataType: .imagePNG, statusCode: 200, data: [ | ||
| .get: mockedData | ||
| ]).register() | ||
|
|
||
| URLSession.shared.dataTask(with: originalURL) { (data, _, error) in | ||
| XCTAssertNil(error) | ||
| XCTAssertEqual(data, mockedData, "Image should be returned mocked") | ||
| expectation.fulfill() | ||
| }.resume() | ||
|
|
||
|
|
@@ -110,27 +101,17 @@ final class MockerTests: XCTestCase { | |
| let expectation = self.expectation(description: "Data request should succeed") | ||
| let originalURL = URL(string: "https://www.wetransfer.com/sample-image.png?width=200&height=200")! | ||
|
|
||
| let mockedData = MockedData.botAvatarImageFileUrl.data | ||
| Mock(url: originalURL, ignoreQuery: true, dataType: .imagePNG, statusCode: 200, data: [ | ||
| .get: mockedData | ||
| ]).register() | ||
|
|
||
| /// Make it different compared to the mocked URL. | ||
| let customURL = URL(string: originalURL.absoluteString + "&" + UUID().uuidString)! | ||
|
|
||
| URLSession.shared.dataTask(with: customURL) { (data, _, error) in | ||
| XCTAssertNil(error) | ||
| XCTAssertEqual(data, mockedData, "Image should be returned mocked") | ||
| expectation.fulfill() | ||
| }.resume() | ||
|
|
||
|
|
@@ -173,13 +154,13 @@ final class MockerTests: XCTestCase { | |
| /// It should return the additional headers. | ||
| func testAdditionalHeaders() { | ||
| let expectation = self.expectation(description: "Data request should succeed") | ||
| let headers = ["Testkey": "testvalue"] | ||
|
There was a problem hiding this comment. Added capitalisation to HTTP headers because Foundation on Linux does this 🤷 |
||
| let mock = Mock(dataType: .json, statusCode: 200, data: [.get: Data()], additionalHeaders: headers) | ||
| mock.register() | ||
|
|
||
| URLSession.shared.dataTask(with: mock.request) { (_, response, error) in | ||
| XCTAssertNil(error) | ||
| XCTAssertEqual(((response as? HTTPURLResponse)?.allHeaderFields["Testkey"] as? String), "testvalue", "Additional headers should be added.") | ||
| expectation.fulfill() | ||
| }.resume() | ||
|
|
||
|
|
@@ -192,12 +173,12 @@ final class MockerTests: XCTestCase { | |
| let mock = Mock(dataType: .json, statusCode: 200, data: [.get: Data()], additionalHeaders: ["testkey": "testvalue"]) | ||
| mock.register() | ||
|
|
||
| let newMock = Mock(dataType: .json, statusCode: 200, data: [.get: Data()], additionalHeaders: ["Newkey": "newvalue"]) | ||
| newMock.register() | ||
|
|
||
| URLSession.shared.dataTask(with: mock.request) { (_, response, error) in | ||
| XCTAssertNil(error) | ||
| XCTAssertEqual(((response as? HTTPURLResponse)?.allHeaderFields["Newkey"] as? String), "newvalue", "Additional headers should be added.") | ||
| expectation.fulfill() | ||
| }.resume() | ||
|
|
||
|
|
@@ -209,8 +190,9 @@ final class MockerTests: XCTestCase { | |
| let expectation = self.expectation(description: "Data request should succeed") | ||
| let originalURL = URL(string: "https://www.wetransfer.com/sample-image.png") | ||
|
|
||
| let mockedData = MockedData.botAvatarImageFileUrl.data | ||
| Mock(fileExtensions: "png", dataType: .imagePNG, statusCode: 200, data: [ | ||
| .get: mockedData | ||
| ]).register() | ||
|
|
||
| let configuration = URLSessionConfiguration.default | ||
|
|
@@ -219,18 +201,7 @@ final class MockerTests: XCTestCase { | |
|
|
||
| urlSession.dataTask(with: originalURL!) { (data, _, error) in | ||
| XCTAssertNil(error) | ||
| XCTAssertEqual(data, mockedData, "Image should be returned mocked") | ||
| expectation.fulfill() | ||
| }.resume() | ||
|
|
||
|
|
@@ -258,7 +229,10 @@ final class MockerTests: XCTestCase { | |
| } | ||
|
|
||
| /// It should correctly handle redirect responses. | ||
| func testRedirectResponse() throws { | ||
| #if os(Linux) | ||
| throw XCTSkip("The URLSession swift-corelibs-foundation implementation doesn't currently handle redirects directly") | ||
|
There was a problem hiding this comment. 👌. Perhaps we can even leave a reference to the issue that tracks this here? There was a problem hiding this comment. Here is the code that throws this error https://github.com/apple/swift-corelibs-foundation/blob/main/Sources/FoundationNetworking/URLSession/URLSessionTask.swift#L1037 I haven't found any open issue, seems like |
||
| #endif | ||
| let expectation = self.expectation(description: "Data request should be cancelled") | ||
| let urlWhichRedirects: URL = URL(string: "https://we.tl/redirect")! | ||
| Mock(url: urlWhichRedirects, dataType: .html, statusCode: 200, data: [.get: MockedData.redirectGET.data]).register() | ||
|
|
@@ -447,10 +421,14 @@ final class MockerTests: XCTestCase { | |
| XCTAssertNil(urlresponse) | ||
| XCTAssertNotNil(error) | ||
| if let error = error { | ||
| #if os(Linux) | ||
| XCTAssertEqual(error as? TestExampleError, .example) | ||
| #else | ||
| // there's not a particularly elegant way to verify an instance | ||
| // of an error, but this is a convenient workaround for testing | ||
| // purposes | ||
| XCTAssertTrue(String(describing: error).contains("TestExampleError")) | ||
| #endif | ||
| } | ||
|
|
||
| expectation.fulfill() | ||
|
|
@@ -460,7 +438,10 @@ final class MockerTests: XCTestCase { | |
| } | ||
|
|
||
| /// It should cache response | ||
| func testMockCachePolicy() throws { | ||
| #if os(Linux) | ||
| throw XCTSkip("URLSessionTask in swift-corelibs-foundation doesn't cache response for custom protocols") | ||
| #endif | ||
| let expectation = self.expectation(description: "Data request should succeed") | ||
| let originalURL = URL(string: "https://www.wetransfer.com/example.json")! | ||
|
|
||
|
|
@@ -471,7 +452,9 @@ final class MockerTests: XCTestCase { | |
| ).register() | ||
|
|
||
| let configuration = URLSessionConfiguration.default | ||
| #if !os(Linux) | ||
| configuration.urlCache = URLCache() | ||
| #endif | ||
| configuration.protocolClasses = [MockingURLProtocol.self] | ||
| let urlSession = URLSession(configuration: configuration) | ||
|
|
||
|
|
||
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.
Wait, how does this work for the constants above if we're
SWIFT_PACKAGEisYES? From what I can tell, it shouldn't compile? 🤔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.
SPM generates this special
Bundle.moduleaccessor (https://developer.apple.com/documentation/swift_packages/bundling_resources_with_a_swift_package) Unfortunately, it doesn't exist in non-SPM targets, so here I was trying to keep both Xcode iOS tests and SPM tests working with resources.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.
Yeah, this makes sense to me! 🙂