One issue I've been running into lately has been when I want to test the process of multiple requests in a single test case. An example of this would be testing successfully unregistering from a server. First I want to simulate successfully registering with a server stubbing the response with a 200 and some JSON, and once that is done I want to stub the response with another 200 response and different JSON and then send the unregister request.

I have a helper function I call in each test so I can quickly stub a response with a single line of code:

- (void)stubResponseWithStatusCode:(int)statusCode dictionary:(NSDictionary *)responseDictionary delay:(NSTimeInterval)delay {
    [OHHTTPStubs removeLastStub];

    [OHHTTPStubs stubRequestsPassingTest:^BOOL(NSURLRequest *request) {
        return YES;
    } withStubResponse:^OHHTTPStubsResponse *(NSURLRequest *request) {
        return [[OHHTTPStubsResponse responseWithJSONObject:responseDictionary statusCode:statusCode headers:nil] responseTime:delay];
    }];
}

EDIT: I've updated my current async testing strategy to take advantage of the XCTestExpectation APIs after reading your docs, rather than implement my own method, and the problem still exists.

When I stub a response without any delay in the beginning of the test, send the request, and inside the completion block when the request is successful stub the NEXT request with a new response without any delay, there are times where the second response is never received, so the tests fail when they hit the 2-4 second timeout. Is this something you've seen before, a known issue, or operator error? Thanks!

I use OHHTTPStubs to test if my AFHTTPRequest send the correct xml as body in a request. This works fine and all tests pass, checking the body that would be sent in the stubRequestPassingTest:

Now I moved to using AFHTTPSessionManager, and the program still works fine, but the tests fail, telling me that the body to be sent is empty, instead of the expected xml.

Something funny that happens: the request that gets prepared by my program has a different pointer (0xe1efbc0) than the request (0xe2c3310) that is checked in the stub. Any idea what is going on? Is it possible the requests gets copied, but the body didn't make it to the copy?

Here is a log from my console:

2014-02-06 14:09:36.278 xctest[69495:303] Posting request 0xe1efbc0 with body: 2014-02-06 14:09:36.278 xctest[69495:1903] Stubbing url /admin/_cmdstat.jsp 2014-02-06 14:09:36.278 xctest[69495:1903] checking body of request 0xe2c3310 2014-02-06 14:09:36.279 xctest[69495:1903] Would sent body: /Volumes/InternalHD/Projecten/ZoneDirectorViewer/ZoneDirectorViewer/Connection/ServerConnectionTests.m:551: error: -[ServerConnectionTests testGetSystemInfo] : ((requestedBody) equal to (expectedBody)) failed: ("") is not equal to ("")

I'm setting up a stub in an Specta spec that isn't getting called. Here's the code I'm using:

it(@"should request splashes", ^{
    __block BOOL success = NO ;

    [OHHTTPStubs stubRequestsPassingTest:^BOOL(NSURLRequest *request) {
        return [request.URL.host isEqualToString:@"zamba.cs.vt.edu"];
    }
                        withStubResponse: ^OHHTTPStubsResponse *(NSURLRequest *request) {
                            NSData *stubData = [NSData dataWithContentsOfFile:[[NSBundle mainBundle] pathForResource:@"findSplashesResponse" ofType:@"txt"]];
                            NSDictionary *standardHeaders = @{ @"Content-Type":@"text/html"};
                            return [OHHTTPStubsResponse responseWithData:stubData statusCode:200 headers:standardHeaders];
                        }].name = @"findSplashes.php";
    [OHHTTPStubs setEnabled:YES];

    [client POST:@"findSplashes.php"
      parameters:@{ @"hash": [client hashString],
                    @"lat":[NSString stringWithFormat:@"%f", vt.coordinate.latitude],
                    @"long":[NSString stringWithFormat:@"%f", vt.coordinate.longitude],
                    @"radius":@"1600" }
         success:^(NSURLSessionDataTask *task, id responseObject) {
             NSString *response = [[NSString alloc] initWithData:(NSData *) responseObject encoding:NSUTF8StringEncoding];
             success = [response isEqualToString:@"252\t5527.5387976613\t4\t4\t1387655919\t1387568319\t300\t40.739983\t-73.992951\n"] ? YES : NO;
         }
         failure:^(NSURLSessionDataTask *task, NSError *error) {
             success = NO;
         }];

    expect(success).will.beTruthy();
});

client is a singleton instance of an AFHTTPSessionManager from AFNetworking 2.0. Strangely, this test and other similar tests were passing originally--I don't know what I've done to break them! When the POST request is made, I can check that OHHTTPStubs.sharedInstance is the same as when the stub was created. I've added the +[OHHTTPStubs setEnabled:] call per other issues here. The block passed as thestubRequestsPassingTest:` parameter is never executed--all requests hit the network. Any ideas? Thanks!

Hi, I tried to implement stubs on xcode 5 with afnetworking 2.0 and it is not working. My current version of OHHTTPStubs pod is 3.0.0

  [OHHTTPStubs stubRequestsPassingTest:^BOOL(NSURLRequest *request) {
    return YES;
  }
     withStubResponse:^OHHTTPStubsResponse *(NSURLRequest *request) {
                        return [[OHHTTPStubsResponse alloc] init];
                      }];

I am actually using an AFHTTPSessionManager singleton configured:

+ (instancetype)sharedInstance
{
  static APTHttpClient *_sharedClient = nil;
  static dispatch_once_t onceToken;
  dispatch_once(&onceToken, ^{
    _sharedClient = [[APTHttpClient alloc] initWithBaseURL:[NSURL URLWithString:APRProductionServer] sessionConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration]];
  });

  return _sharedClient;
}

This is the method I am actually calling after the stub:

- (void)getContacts
{
  [self GET:@"/contacts"
 parameters:nil
    success:^(NSURLSessionDataTask *task, id responseObject) {
      NSLog(@"%@",responseObject);
    } failure:^(NSURLSessionDataTask *task, NSError *error) {
      NSLog(@"Error: %@", error.userInfo);
    }];
}

Is there something I am doing wrong?

This addresses the issue described in https://github.com/AliSoftware/OHHTTPStubs/wiki/Testing-for-the-request-body-in-your-stubs and #52

It also avoids unnecessary changes to the code under test as the setter and getter for HTTPBody can still be used without change in behavior (as far as one can tell).

The new getter -[NSURLRequest OHHTTPStubs_HTTPBody] can be used in your [OHHTTPStubs stubRequestsPassingTest:withStubResponse:] to test the HTTPBody.

One known issue is that if you set the HTTPBody and later reset it to nil (for whatever reason),OHHTTPStubs_HTTPBody will still return the last non-nil value.

Thanks to @shagedorn for the help on method swizzling.

Hi !

I have picked up the work of @mxcl to make OHHTTPStubs support swift 3.0. The objective was to make the code works on every version of swift (2.2, 2.3, 3.0) to fix issue #189. To achieve this, I made some tradeoffs.

Remove first parameter label in Swift 3.0

To avoid declaring the methods multiple times to support both 2.3 and 3.0 syntax, some warnings are generated when using 2.x compilers. For example, so that we can still use isPath("myPath") in Swift 3.0, the declaration has been changed to func isPath(_ path: String) -> OHHTTPStubsTestBlock. This generates the following warning on 2.x compilers: Extraneous '_' in parameter: 'path' has no keyword argument name

Multiple #if branching to instantiate either URLRequest or NSURLRequest in tests

While we could do some tricks using extensions to support 3.0 methods and attributes in swift 2.x, this is not feasible for a whole struct/class like URLRequest/NSURLRequest. So, in the tests, every time we were instantiating a NSURLRequest object, the call is now replaced by the creation of a URLRequest value-type using #if branching. We may want to factorize this code into a helper function in the test class though. But this may need to convert all NSURLRequest to NSMutableURLRequest to have only one method call.

Use NSURL's path in isPath instead of URL's path

The path property on URL does not behave as the one in NSURL. In URL, the path is not truncated at the first semicolon. This has the effect to make the actual tests fail. So to fix this, I used NSURL's path.

For this pull request, I used the swift version of Xcode 8 beta 4.

I hope this helps!

Not sure if I should post this issue here or over at Alamofire

I have a unit test that stubs httpbin.org, and then it makes an Alamofire request. The request is stubbed as expected.

If I then add an Alamofire request to AppDelegate, the stub in the unit test stops mocking and instead the Alamofire request in the unit test calls the actual service.

I have a sample here https://github.com/iwllyu/test-ohhttpstubs

• Swift 2.0
• Xcode 7.0.1 (7A1001)
• OHHTTPStubs 4.3.0 with swift support
• Alamofire 2.0.2
• Quick/Nimble

Updating gitignore. Adding Package.swift Adding Swift tests, getting all builds working. Downgrading swift package version to be compatible with Xcode 9.1. Disabling xcode 9.1 tests and redirect tests in other xcode versions. Changing iPhone types depending on Xcode version. Passing conditional compilation flags to swift test to disable redirect tests in CI. Bumping podspec version. Cleaning up podspec. Updating example projects. Adding SPM Example. Moving Example Stubs to shared folder. Adding building example apps to CI. Adding Carthage builds to CI. Updating rake file for SPM tests. Passing Swift Versions to carthage. Updating SPM example to use URLSession instead of URLConnection. Updating documentation.

Checklist

• [x] I've checked that all new and existing tests pass
• [x] I've updated the documentation if necessary
• [x] I've added an entry in the CHANGELOG to credit myself

Description

This PR is for adding Swift Package Manager support.

Motivation and Context

Apple integrated Swift Package Manager into Xcode 11 this year and these are the changes to support it.

File Structure:

The apple docs tell us to have the Package.swift at the root of the repository.

To turn your existing component into a Swift package, you don’t need to create a new Swift package from scratch. Instead, keep your existing project and add a README.md and a Package.swift file inside the root directory of your library project to turn your library into a Swift package.

While SPM does not require a specific structure, OHHTTPStubs's SPM support will be easier to maintain if we conform to the standard style of foldering in SPM: Sources and Tests at the root of the repo, and then folders matching the names of the targets inside of those. This required moving most of the files up a level by removing the OHHTTPStubs folder that was previously at the root of the project and also renaming UnitTests to become Tests.

The pod specs were updated for the new file structure. To validate them, I ran a pod install in the ObjC and Swift Example projects, I verified that the same files exist, their visibility did not change, and that the example projects still work as expected.

The OHHTTPStub project was also updated for the new file structure. To validate it, I ran unit tests on several Xcode versions (9.1, 10.1, 10.2, 11).

Package Naming:

I went through several revisions on the right design for the package targets.

Original Design

I originally went down the path of trying to recreate the subspecs that exist in our Cocoapods integration. This was a bit painful, but worked. Once I started on the SPM example project, I saw the awkwardness of having to import each of the targets to my swift example code.

Second Design

I then decided to modify the package design to be 2 targets: OHHTTPStubs and OHHTTPStubsSwift, but ran into problems with this approach also.

As soon as I created the OHHTTPStubs target, I started receiving warnings about certain headers not being included in our OHHTTPStubs.h umbrella header. SPM started seeing this existing file as our umbrella header and wasn't generating one on its own anymore. I was tempted to rename our OHHTTPStubs.h file to be something else to get SPM to create an umbrella header again, but wanted to retain backwards compatibility with this PR.

Final Design

I then changed the design to be 2 targets: OHHTTPStubsCore and OHHTTPStubsSwift.

Importing these in Swift will look like this:

Example Projects:

• A Swift Package Manager project with OHHTTPStubs integration (Xcode-11 beta 5) was added to the Examples/SwiftPackageManager folder. This example project uses URLSession APIs.
• The Stubs folder and files used in the example apps is now shared to remove the previously duplicate stub files in each example.

CI Support:

I added a lot more (is this overkill?) travis tasks in this PR. These are the new tasks:

• xcodebuild test in Xcode 11 for iOS Static, iOS Dynamic, MacOS, and tvOS
• swift test in Xcode 10.1, 10.2, 11.
• carthage build commands in 9.1, 10.1, 10.2, 11 and several versions of swift: 3.2, 4.0, 4.1, 4.2, 5.0, 5.1.
• xcodebuild build to build all example projects in Xcode 11.

Other:

• Mocktail and HTTPMessage targets were not created in this PR. Mocktail does not support SPM, and hasn't actually been updated in several years. I added a comment in the README for anyone to open an issue if they see a need for these. I would be happy to create a follow-up PR for OHHTTPStubsHTTPMessage if we desire it.
• Fixes #311.

Before this change, a POST request redirected with status code 307 or 308 would become a request with GET method. This check-in changes the behavior to retain the HTTP method in the case of 307/308 redirect

Checklist

• [X] I've checked that all new and existing tests pass
• [ N/A ] I've updated the documentation if necessary
• [X] I've added an entry in the CHANGELOG to credit myself

Description

Motivation and Context

inadherence to RFC and HTTP specs.

Fixes #262

I ran existing NSURLSession tests. TODO: Create a test case to handle these cases. Will require some help from @AliSoftware to do so

Thanks to my colleague @sashra for finding this!

New Issue Checklist

• [x] I have tried with the latest version of OHHTTPStubs
• [x] I have read the README
• [x] I have read the Using the right Swift Version of OHHTTPStubs for your project section
• [x] I have searched in the existing issues
• [x] I have read the OHHTTPStubs wiki to see if there wasn't a detailed page talking about my issue

Environment

• version of OHHTTPStubs: 6.0.0
• integration method you are using:
  • [x] Cocoapods
  • [ ] Carthage
  • [ ] submodule
  • [ ] other
• version of the tool you use: 1.2.1

Issue Description

I was trying to test my own CocoaPods library web services with OHHTTPStubs. All the service is built on top of Alamofire through a singleton which creates its own Alamofire.SessionManager created in the following way:

public var configuration: SessionManagerConfiguration = SessionManagerConfiguration.default {
        didSet(newValue) {
            let configuration = URLSession.shared.configuration
            if let token = UserDefaults.standard.string(forKey: newValue.userDefaultsTokenKey) {
                configuration.httpAdditionalHeaders = ["token": token]
                configuration.urlCache = nil
            }
            let delegate = Alamofire.SessionDelegate()
            let session = URLSession(configuration: configuration, delegate: delegate, delegateQueue: nil)
            self._sessionManager = Alamofire.SessionManager(session: session, delegate: delegate)!
            
            self.initializeObservables()
        }
    }

This is being correctly invoked in my beforeSuite{ } method when I create the singleton and set the configuration at the same time:

SessionManager.shared.configuration = SessionManagerConfiguration(withInvalidAuthenticationNotificationName: Notification.Name(rawValue: "testInvalidAuthenticationName"), invalidAuthenticationCode: 1500, userDefaultsTokenKey: "testTokenKey", baseURL: self.baseURL)

Where baseURL is just a random URL that I want to stub certain endpoints that satisfy my services, like this:

        describe("User Operations Spec") {
            
            it("Should retrieve an user") {
                
                OHHTTPStubs.setEnabled(true, for: SessionManager.shared.sessionManager.session.configuration)
                
                self.userDetailStub = stub(condition: isHost(self.baseURL)) {
                    _ in
                    let stubData = self.loadUserStub()
                    return OHHTTPStubsResponse(data: stubData, statusCode: 200, headers: nil)
                }
                
                var user: User!
                
                SessionManager.shared.service.user.user(.internet)
                    .observeOn(MainScheduler.instance)
                    .subscribe(onNext: {
                        _user in
                        user = _user
                    })
                    .disposed(by: self.disposeBag)
                
                expect(user).toEventuallyNot(beNil(), timeout: 5)
                expect(user.id_hash.int64Value) == 1446546480781
            }
        }

After running the test, the expectation did not get fulfilled so the tests fails, as shown in the lines below.

Complete output when you encounter the issue (if any)

/Users/GabrielVillarrubia/Documents/Private Pods/EbmCore/Example/Tests/User Operation Specs.swift:76: error: -[EbmCore_Tests.UserOperationSpecs User_Operations_Spec__Should_retrieve_an_user] : expected to eventually not be nil, got <nil>

fatal error: unexpectedly found nil while unwrapping an Optional value

There's something obvious that I'm skipping on this? There's no host app due to the fact that this is a CocoaPods framework's test suite.

Thank you very much and keep it up with the great work with this library!

Per Apple docs https://developer.apple.com/library/prerelease/ios/samplecode/CustomHTTPProtocol/Listings/Read_Me_About_CustomHTTPProtocol_txt.html :

In addition, an NSURLProtocol subclass is expected to call the various methods of the NSURLProtocolClient protocol from the client thread

So, instead of having callbacks happen on a background queue, OHHTTPStubsProtocol need to capture the executing runloop and execute callbacks from that runloop. This is a requirement of NSURLProtocol.

-- Twitter uses OHHTTPStubs for certain unit tests and we have made this change on our local fork. Providing the fix here for the benefit of all.

New Issue Checklist

• [ ] I have tried with the latest version of OHHTTPStubs
• [ ] I have read the README
• [ ] I have read the Using the right Swift Version of OHHTTPStubs for your project section
• [ ] I have searched in the existing issues
• [ ] I have read the OHHTTPStubs wiki to see if there wasn't a detailed page talking about my issue

Environment

• version of OHHTTPStubs: [LIB VERSION HERE]
• integration method you are using:
  • [ ] Cocoapods
  • [ ] Carthage
  • [ ] submodule
  • [ ] other
• version of the tool you use: [INSERT VERSION HERE]

Issue Description

[DESCRIBE YOUR ISSUE HERE]

Complete output when you encounter the issue (if any)

[INSERT OUTPUT HERE]

Checklist

• [ ] I've checked that all new and existing tests pass
• [ ] I've updated the documentation if necessary
• [ ] I've added an entry in the CHANGELOG to credit myself

Description

Export OHHTTPStubs from OHHTTPStubsSwift using @_exported so that users doesn't need to import both of them.

Motivation and Context

Previously SwiftPM users should import both OHHTTPStubs and OHHTTPStubs, contrary to CocoaPods users who need to import only OHHTTPStubs. This difference is small but an obstacle for migrating to Swift Package Manager.

1. Firstly I removed import OHHTTPStubs statement from Tests/OHHTTPStubsSwiftTests/SwiftHelperTests.swift. This change made tests fail.
2. Then add @_exported modifier to import statement, then the test passed.

Checklist

• [x] I've checked that all new and existing tests pass
• [x] I've updated the documentation if necessary
• [x] I've added an entry in the CHANGELOG to credit myself

Description

Hi, I would like to contribute fixing a recent warning.

The new Xcode 14 uses next SDKs as base: iOS 11.0, macOS 10.13, watchOS 4.0 and tvOS 11.0. Compiling in this Xcode shows a warning. Handle this restrictions relying on swift version (which is also vinculated to each Xcode version).

Regards and comments welcomed

Motivation and Context

Fixes a warning

Run project tests and compile on each platform.

Checklist

• [ X ] I've checked that all new and existing tests pass
• [ X ] I've updated the documentation if necessary
• [ X ] I've added an entry in the CHANGELOG to credit myself

Motivation and Context

On Xcode 13.3 sometimes an error about cycle dependencies is emitted. The fix to this is to put the Headers build phase before Sources build phase.

It'd be really nice if there was a fluent API for stubbing. I personally feel this drastically helps readability and has the added benefit of making it very simple to return different responses for the same condition.

Ideal API (in my head):

    func testExample() async throws {
        let expectedData = try XCTUnwrap(UUID().uuidString.data(using: .utf8))
        let secondData = try XCTUnwrap(UUID().uuidString.data(using: .utf8))
        StubResponse(on: isHost("www.someapi.com") && isMethodGET() ) { req in
            HTTPStubsResponse(data: expectedData, statusCode: 500, headers: nil)
        }.thenRespond(on: isHost("www.someapi.com") && isMethodGET() ) { req in
            HTTPStubsResponse(data: secondData, statusCode: 400, headers: nil)
        }

        let (data, response) = try await URLSession.shared.data(from: URL(string: "https://www.someapi.com")!)
        XCTAssertEqual((response as? HTTPURLResponse)?.statusCode, 500) // first respond with a 500
        XCTAssertEqual(data, expectedData)

        let (data2, response2) = try await URLSession.shared.data(from: URL(string: "https://www.someapi.com")!)
        XCTAssertEqual((response2 as? HTTPURLResponse)?.statusCode, 400) // then respond with a 400
        XCTAssertEqual(data2, secondData)

        let (data3, response3) = try await URLSession.shared.data(from: URL(string: "https://www.someapi.com")!)
        XCTAssertEqual((response3 as? HTTPURLResponse)?.statusCode, 400) // 400 response stays stubbed, cause that was the last one
        XCTAssertEqual(data3, secondData)
    }

WIP - (The thing I usually rebuild)

I thought I'd share code I often rewrite when I pull in this library so that others might benefit. It has some drawbacks, it's not particularly efficient, and it's a little questionable how it removes stubs, but I think it's a useful copy/paste if you also like this sort of thing.

import OHHTTPStubs
import OHHTTPStubsSwift

final class StubResponse {
    var stubs: [(condition: HTTPStubsTestBlock, response: HTTPStubsResponseBlock)] = []
    @discardableResult convenience init(on condition: @escaping HTTPStubsTestBlock, with response: @escaping HTTPStubsResponseBlock) {
        self.init(stubs: [(condition, response)])
    }

    private init(stubs: [(condition: HTTPStubsTestBlock, response: HTTPStubsResponseBlock)]) {
        self.stubs = stubs
        stub { req in
            let filtered = self.stubs.enumerated().filter { $0.element.condition(req) }
            return !filtered.isEmpty
        } response: { req in
            let filtered = self.stubs.enumerated().filter { $0.element.condition(req) }
            guard let first = filtered.first else { fatalError("No stub response found, something bad happened") }
            defer {
                if filtered.count > 1, let first = filtered.first {
                    self.stubs.remove(at: first.offset)
                }
            }
            return first.element.response(req)
        }
    }

    @discardableResult func thenRespond(on condition: @escaping HTTPStubsTestBlock, with response: @escaping HTTPStubsResponseBlock) -> Self {
        Self(stubs: stubs.appending((condition, response)))
    }
}


extension Array {
    fileprivate func appending(_ element: Element) -> Self {
        var copy = self
        copy.append(element)
        return copy
    }
}

I would submit a PR but I'm not sure if others would find this useful and didn't want to spend time resolving the issues mentioned unless this is useful to anybody other than me.

New Issue Checklist

• [x] I have tried with the latest version of OHHTTPStubs
• [x] I have read the README
• [x] I have read the Using the right Swift Version of OHHTTPStubs for your project section
• [x] I have searched in the existing issues
• [x] I have read the OHHTTPStubs wiki to see if there wasn't a detailed page talking about my issue

Environment

• version of OHHTTPStubs: 9.1.0
• integration method you are using:
  • [ ] Cocoapods
  • [ ] Carthage
  • [ ] submodule
  • [x] other (SPM)
• version of the tool you use: Xcode 12.5.1

Issue Description

Stubs are being added but test condition block is never called. I am using Xcode 12.5.1 and thus Swift 5.4.2. I think I have an identical setup to #346 because I am also using UI tests without a host application.