NEW: Nominations are now open for the 2019 Swift Community Awards! >>

How to test throwing functions

Swift version: 5.1

Paul Hudson    @twostraws   

One of the many brilliant features of Swift’s error handling system is its ability to throw errors during tests and have them considered as failures. That is, if you mark your test using throws you run any throwing code inside that test and if it throws an error the test will be marked as a failure.

For example, if I have an ImageGenerator struct that has a throwing method called generateImages(), I could test it out using code like this:

func testFailingExample() throws {
    let generator = ImageGenerator()
    let result = try generator.generateImages()
    XCTAssertTrue(result, "Image generation should complete successfully.")

That creates an instance of the struct, attempts to run its generateImages() method, then asserts that the result of the method was true. If generateImages() throws an error it won’t be caught inside the test – there’s no do/catch blocks in there – so instead it will bubble up to the XCTestCase, which will automatically mark the test as being failed.

Although this approach works well for individual throwing methods like you see above, I don’t think you should use it for more complex tests because you can mask failures too easily. If you have three throwing function calls inside a single test, it’s a better idea to wrap them individually in do/catch blocks so you can deal with the error inline by calling XCTFail() at the point of failure.

SAVE 20% ON iOS CONF SG The largest iOS conference in Southeast Asia is back in Singapore for the 5th time in January 2020, now with two days of workshops plus two days of talks on SwiftUI, Combine, GraphQL, and more! Save a massive 20% on your tickets by clicking on this link.

Available from iOS

Similar solutions…

About the Swift Knowledge Base

This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.

Buy Testing Swift Buy Practical iOS 12 Buy Pro Swift Buy Swift Design Patterns Buy Swift Coding Challenges Buy Server-Side Swift (Vapor Edition) Buy Server-Side Swift (Kitura Edition) Buy Hacking with macOS Buy Advanced iOS Volume One Buy Advanced iOS Volume Two Buy Hacking with watchOS Buy Hacking with tvOS Buy Hacking with Swift Buy Dive Into SpriteKit Buy Swift in Sixty Seconds Buy Objective-C for Swift Developers Buy Beyond Code

Was this page useful? Let us know!