machx / mocknetworking Goto Github PK

Apply URLProtocol to XCTests for Mock Networking API's

License: Apache License 2.0

Swift 100.00%

mocknetworking's Introduction

MockNetworking

MockNetworking is a Swift package allowing the replaying of mock responses to network requests through Apple Networking API's by tying into the URLProtocol system.

Installation

MockNetworking is available for integration into Xcode through the Swift Package Manager. Point to https://github.com/Machx/MockNetworking.git in Xcode when adding the new package.

Basic Usage

To setup a mock response you simply need to register the response and then unregister the class when appropraite. In the example below we'll setup a response for 1 test.

let url = try XCTUnwrap(URL(string: "https://wwww.apple.com"))
let response = try XCTUnwrap(HTTPURLResponse(url: url,
					statusCode: 200,
					httpVersion: HTTPURLResponse.HTTP_1_1,
					headerFields: nil))

MockURLProtocol.register(response: response, for: url)
defer {
	MockURLProtocol.unregister()
}

This uses HTTPURLResponse, there is also a custom api available.

let url = try XCTUnwrap(URL(string: "https://wwww.apple.com"))
let mockResponse = MockPropertyResponse(url: url,
					status: 200,
					headerFields: [:])

MockURLProtocol.regigsterMock(response: mockResponse, for: url)
defer {
	MockURLProtocol.unregister()
}

The register api both registers MockURLProtocol with the URLProtocol system if it isn't already registered and stores the prepared response for the given url.

License

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.

mocknetworking's People

Contributors

Watchers

mocknetworking's Issues

Unit Test Body Data to make sure that you get the correct response back

make sure you get this captured and tested correctly

See if you can compare 2 http responses that you get back

Implement remove response for url

Implement a remove individual response for a specific url

Go through all Unit Tests and verify they aren't actually going on the network

I believe the latest unit tests i'm developing right now actually went out on the network where I thought it wouldn't.

For each test verify it doesn't go out on the network

Implement Delayed Responses

Implement something to delay mock networking responses

Put MockPropertyResponse in its own file

Feels out of place in the same file as the protocol subclass

Update the ReadMe to use the MockURLResponse type in addition to the HTTP Response type

Currently the Readme shows an example of how to use MockNetworking with a API that I wouldn't use as much right now. This should be refactored to use the correct api type

Verify the HTTP Headers you setup in Mock Response are returned

Need to verify that the headers setup in the mock response are actually returned.

Review why 2 responses coming back in http response test weren't equal

In the test

func testHTTPResponse() throws {
		let url = try XCTUnwrap(URL(string: "https://wwww.apple.com"))
		let response = try XCTUnwrap(HTTPURLResponse(url: url,
									   statusCode: 200,
									   httpVersion: HTTPURLResponse.HTTP_1_1,
									   headerFields: ["thing180":"thing2"]))
		
		MockURLProtocol.register(response: response, for: url)
		defer {
			MockURLProtocol.unregister()
		}
		
		var receivedResponse: URLResponse?
		let expectation = XCTestExpectation()
		URLSession.sessionWith(.ephemeral).downloadTask(with: url) { (url, response, error) in
			receivedResponse = response
			expectation.fulfill()
		}.resume()
		
		wait(for: [expectation], timeout: 5.0)
		
		XCTAssertNotNil(receivedResponse)
		guard let receivedHTTPResponse = receivedResponse as? HTTPURLResponse else {
			XCTFail("Could not convert Response to HTTPURLResponse type")
			return
		}
		XCTAssertEqual(response.url, receivedHTTPResponse.url)
		XCTAssertEqual(response.statusCode, receivedHTTPResponse.statusCode)
		XCTAssertEqual(response.allStringHTTPHeaders(), receivedHTTPResponse.allStringHTTPHeaders())
	}

if you straight ask for the 2 http responses being equal, you will get a negative response back. I suspect that the 2nd response (having gone through URLProtocol) has more fields in it than the one we supplied it to begin with. Should quickly evaluate this and see if a better equality method can be made for the unit test.

Review the 2 registration api's and make sure they are consistent

There are a couple types now of registration methods and I just want to make sure they are consistent and both provide access to the same http information

Implement Cancel request

Currently there is an API

public override func stopLoading() {
	//
}

this should probably operate like NSOperation's cancel where you make a private variable and then just check it during the course of the load logic

Change URLPropertyStore to something else

URLPropertyStore sounds too official and doesn't sound like something from this package. I'd like to find a name that sounds more like it fits in with the expected naming style from this project.

URLResponse custom isEqual func for or custom XCTAssert for unit tests

URLResponse considers fields that MockNetworking doesn't care about such as mime type in the equality comparison. For unit test purposes only a better equality method/assertion should be made using 1 of 2 methods

Make a XCTAsser func that works better for URLResponse
Make a better (for unit tests) equal func for comparison of 2 responses

What the package is
What license its under
any other relevant information

Convert MockResponse to compose together HTTPURLResponse, error and data

Currently MockResponse is a collection of variables for things in HTTPURLResponse, etc. It should instead just compose together HTTPURLResponse and types in Foundation Networking.