Testing async code in Swift

Introduction

We test async code to make sure it works correctly even when tasks happen at different times. This helps catch mistakes before users see them.

When you want to check if a network call returns the right data.

When you need to verify that a background task finishes successfully.

When you want to test code that waits for a delay or timer.

When you want to confirm that async functions handle errors properly.

Syntax

Swift

func testExample() async throws {
    let result = try await someAsyncFunction()
    XCTAssertEqual(result, expectedValue)
}

Use the 'async' keyword in your test function to test async code.

Use 'await' to wait for the async function to finish before checking results.

Examples

This test waits for fetchDataFromServer() to finish and checks that data is not nil.

Swift

func testFetchData() async throws {
    let data = try await fetchDataFromServer()
    XCTAssertNotNil(data)
}

This test checks that an async function throws an error as expected.

Swift

func testAsyncError() async {
    do {
        _ = try await asyncFunctionThatThrows()
        XCTFail("Expected error but got success")
    } catch {
        XCTAssertTrue(true)
    }
}

Sample Program

This program defines an async function that waits half a second and returns 42. The test checks if the returned number is 42 and prints a success message.

Swift

import XCTest

class AsyncTests: XCTestCase {
    func fetchNumber() async -> Int {
        // Simulate async delay
        try? await Task.sleep(nanoseconds: 500_000_000) // 0.5 seconds
        return 42
    }

    func testFetchNumber() async {
        let number = await fetchNumber()
        XCTAssertEqual(number, 42)
        print("Test passed: number is \(number)")
    }
}

// Run the test manually (for playground or script)
@main
struct Main {
    static func main() async {
        let tests = AsyncTests()
        await tests.testFetchNumber()
    }
}

Important Notes

Remember to mark test functions with async when testing async code.

Use await to pause until the async task finishes before checking results.

In XCTest, async tests can throw errors, so use async throws if needed.

Summary

Async tests let you check code that runs at different times.

Use async and await keywords in test functions.

Test both success and error cases for async functions.

Practice

1. What keyword must you add to a Swift test function to test asynchronous code?

easy

A. defer

B. await

C. async

D. try

Solution

1. Step 1: Understand async test function requirement

   To test asynchronous code, the test function itself must be marked as asynchronous.

2. Step 2: Identify the correct keyword

   The keyword to mark a function as asynchronous in Swift is async.

3. Final Answer:

   async -> Option C

4. Quick Check:

   async = async [OK]

Hint: Mark test functions with async to test async code [OK]

Common Mistakes:

• Using await instead of async on test function
• Forgetting to mark test function as async
• Using try instead of async
• Confusing defer with async

2. Which of the following is the correct syntax to wait for an async function fetchData() inside a test?

easy

A. let result = await fetchData()

B. let result = async fetchData()

C. await let result = fetchData()

D. fetchData().await()

Solution

1. Step 1: Recall await usage in Swift

   In Swift, to wait for an async function, you use the await keyword before the function call.

2. Step 2: Check correct syntax

   The correct syntax is let result = await fetchData(). The keyword await comes before the function call.

3. Final Answer:

   let result = await fetchData() -> Option A

4. Quick Check:

   await before function call = let result = await fetchData() [OK]

Hint: Put await before async function call to wait [OK]

Common Mistakes:

• Placing await after let or variable
• Using async instead of await before call
• Calling await as a method
• Omitting await keyword

3. Given this test code, what will be printed?

func testFetch() async {
  let data = try? await fetchData()
  print(data == nil ? "No Data" : "Got Data")
}

func fetchData() async throws -> String {
  return "Hello"
}

medium

A. No Data

B. Compilation error

C. Runtime error

D. Got Data

Solution

1. Step 1: Analyze fetchData() behavior

   The function fetchData() is async and throws but always returns "Hello" without throwing an error.

2. Step 2: Understand try? await usage

   The try? await fetchData() will return the string "Hello" wrapped as optional, not nil, because no error is thrown.

3. Step 3: Evaluate print statement

   Since data is not nil, the print outputs "Got Data".

4. Final Answer:

   Got Data -> Option D

5. Quick Check:

   try? await returns value = Got Data [OK]

Hint: try? returns nil only if error thrown, else returns value [OK]

Common Mistakes:

• Assuming try? always returns nil
• Confusing async throws with throwing error always
• Ignoring optional unwrapping
• Expecting compilation error due to async

4. Identify the error in this async test function:

func testDownload() async {
  let result = fetchData()
  XCTAssertEqual(result, "Success")
}

func fetchData() async -> String {
  return "Success"
}

medium

A. XCTAssertEqual cannot compare strings

B. Missing await before fetchData() call

C. Test function should not be async

D. fetchData() must throw an error

Solution

1. Step 1: Check async function call

   The function fetchData() is async, so calling it requires await to get the result.

2. Step 2: Identify missing await

   In the test, fetchData() is called without await, causing a compile error.

3. Final Answer:

   Missing await before fetchData() call -> Option B

4. Quick Check:

   Async calls need await = Missing await before fetchData() call [OK]

Hint: Always await async calls inside async functions [OK]

Common Mistakes:

• Calling async function without await
• Thinking test functions can't be async
• Misusing XCTAssertEqual with strings
• Assuming async functions must throw

5. You want to test an async function loadUser(id:) that throws an error if the user is not found. Which test code correctly checks that an error is thrown for an invalid id?

hard

A. func testLoadUserError() async throws {
do {
_ = try await loadUser(id: -1)
XCTFail("Expected error not thrown")
} catch {
XCTAssertTrue(true)
}
}

B. func testLoadUserError() async {
let user = try await loadUser(id: -1)
XCTAssertNil(user)
}

C. func testLoadUserError() async throws {
let user = await loadUser(id: -1)
XCTAssertNil(user)
}

D. func testLoadUserError() async throws {
_ = try await loadUser(id: -1)
XCTAssertTrue(false)
}

Solution

1. Step 1: Understand error throwing test pattern

   To test that an async function throws, use a do-catch block and call the function with try await.

2. Step 2: Verify correct error handling

   func testLoadUserError() async throws { do { _ = try await loadUser(id: -1) XCTFail("Expected error not thrown") } catch { XCTAssertTrue(true) } } calls loadUser(id: -1) with try await inside do, fails test if no error, and passes if error caught.

3. Step 3: Check other options

   Approaches expecting a nil user incorrectly assume throwing functions return nil instead of throwing. func testLoadUserError() async throws { _ = try await loadUser(id: -1) XCTAssertTrue(false) } fails test unconditionally.

4. Final Answer:

   do { _ = try await loadUser(id: -1) XCTFail("Expected error not thrown") } catch { XCTAssertTrue(true) } -> Option A

5. Quick Check:

   Use do-catch with try await to test errors [OK]

Hint: Use do-catch with try await to test thrown errors [OK]

Common Mistakes:

• Expecting nil instead of catching error
• Omitting try or await keywords
• Failing test unconditionally
• Not marking test async throws