moc

MockUIAlertController

Mock alerts and action sheets for iOS unit tests

Showing:

Popularity

Downloads/wk

0

GitHub Stars

45

Maintenance

Last Commit

2yrs ago

Contributors

7

Package

Dependencies

0

License

MIT

Categories

Readme

Deprecated… Come over to ViewControllerPresentationSpy

This library has been renamed to ViewControllerPresentationSpy.

  • It introduces a new verifier to capture any presented view controller, including segues.
  • The verifiers are written in Swift, so you no longer need a bridging header.
  • Other compatibility-breaking changes. You're welcome to stick with MockUIAlertController, but all improvements will be made in the new library.

MockUIAlertController

Build Status Coverage Status Carthage compatible CocoaPods Version Twitter Follow

MockUIAlertController lets you mock iOS alerts and action sheets for unit tests. It works for Swift as well as Objective-C.

(For old UIAlertView or UIActionSheet mocking, use MockUIAlertViewActionSheet.)

No actual alerts are presented. This means:

  • The workflow doesn't pause for an action to be selected
  • Tests are blazing fast.

For more discussion, see my blog post How to Test UIAlertControllers and Control Swizzling.

Writing Tests

What do I need to change in production code?

Nothing.

How do I test an alert controller?

  1. @import MockUIAlertController.h; or add it to your Swift test target's bridging header.
  2. Instantiate a QCOMockAlertVerifier before the Act phase of the test.
  3. Invoke the code to create and present your alert or action sheet.

Information about the alert or action sheet is then available through the QCOMockAlertVerifier.

For example, here's a test verifying the title (and that the alert is presented exactly once). sut is the System Under Test in the test fixture.

func test_showAlert_alertShouldHaveTitle() {
    let alertVerifier = QCOMockAlertVerifier()

    sut.showAlert() // Whatever triggers the alert

    XCTAssertEqual(alertVerifier.presentedCount, 1, "presented count")
    XCTAssertEqual(alertVerifier.title, "Hello!", "title")
}
- (void)test_showAlert_alertShouldHaveTitle {
    QCOMockAlertVerifier *alertVerifier = [[QCOMockAlertVerifier alloc] init];

    [sut showAlert]; // Whatever triggers the alert

    XCTAssertEqual(alertVerifier.presentedCount, 1, @"presented count");
    XCTAssertEqualObjects(alertVerifier.title, @"Hello!", @"title");
}

To guard against tests which accidentally present real alerts, I recommend placing the alert verifier in the test fixture with setUp()/tearDown():

private var alertVerifier: QCOMockAlertVerifier!

override func setUp() {
    super.setUp()
    alertVerifier = QCOMockAlertVerifier()
}

override func setUp() {
    alertVerifier = nil
    super.tearDown()
}

How can I invoke the block associated with a UIAlertAction?

Go through the steps above to present your alert or action sheet using QCOMockAlertController. Then call executeActionForButton(withTitle:) on your QCOMockAlertVerifier with the button title. For example:

func test_executingActionForOKButton_shouldDoSomething() {
    let alertVerifier = QCOMockAlertVerifier()
    sut.showAlert()
    
    alertVerifier.executeActionForButton(withTitle: "OK")

    // Now assert what you want
}
- (void)test_executingActionForOKButton_shouldDoSomething {
    QCOMockAlertVerifier *alertVerifier = [[QCOMockAlertVerifier alloc] init];
    [sut showAlert];

    [alertVerifier executeActionForButtonWithTitle:@"OK"];

    // Now assert what you want
}

How can I test an alert that's presented using DispatchQueue.main?

Create an expectation in your test case. Fulfill it in the alert verifier's completion block. Add a short wait at the start of the Assert phase.

func test_showAlertOnMainDispatchQueue_shouldDoSomething() {
    let alertVerifier = QCOMockAlertVerifier()
    let expectation = self.expectation(description: "alert presented")
    alertVerifier.closure = { expectation.fulfill() }
    
    sut.showAlert()
    
    waitForExpectations(timeout: 0.001)
    // Now assert what you want
}

Can I see some examples?

There are sample apps in both Swift and Objective-C. Run them on both phone & pad to see what they do, then read the ViewController tests.

Adding it to your project

Swift use

For Swift, add

@import MockUIAlertController;

to the bridging header of your test target. If you don't have it as a separate module, then #import "MockUIAlertController/MockUIAlertController.h"

CocoaPods

Add the following to your Podfile, changing "MyTests" to the name of your test target:

target 'MyTests' do
  inherit! :search_paths
  pod 'MockUIAlertController', '~> 3.0'
end

Carthage

Add the following to your Cartfile:

github "jonreid/MockUIAlertController" ~> 3.0

Building It Yourself

Make sure to take everything from Source/MockUIAlertController.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100