Testing async code in Swift - Step-by-Step Execution

Concept Flow - Testing async code

Start Test

↓

Call async function

↓

Wait for async result

↓

Check result

↓

Pass

↓

End Test

The test starts by calling the async function, waits for its result, then checks if the result matches the expectation to pass or fail the test.

Execution Sample

Swift

func testFetchData() async throws {
  let result = try await fetchData()
  XCTAssertEqual(result, "Hello")
}

This test calls an async function fetchData, waits for its result, and checks if it equals "Hello".

Execution Table

Step	Action	Evaluation	Result
1	Call testFetchData()	Start async test	Test started
2	Call fetchData()	Await async operation	Waiting for result
3	fetchData() completes	Returns "Hello"	Result = "Hello"
4	XCTAssertEqual(result, "Hello")	Compare result with "Hello"	True (test passes)
5	Test ends	No errors thrown	Test passed

💡 Test ends after assertion passes and no errors are thrown

Variable Tracker

Variable	Start	After Step 3	Final
result	nil	"Hello"	"Hello"

Key Moments - 2 Insights

Why do we use 'await' before calling fetchData()?

Because fetchData() is asynchronous, 'await' pauses the test until fetchData() finishes and returns a value, as shown in step 2 and 3 of the execution_table.

What happens if fetchData() returns a different value than "Hello"?

The XCTAssertEqual check in step 4 would fail, causing the test to fail instead of passing, as the comparison would be false.

Visual Quiz - 3 Questions

Look at the execution_table, what is the value of 'result' after step 3?

A nil

B "World"

C "Hello"

D Error

💡 Hint

Check the 'Evaluation' and 'Result' columns in row 3 of the execution_table.

At which step does the test check if the result matches the expected value?

A Step 4

B Step 3

C Step 2

D Step 5

💡 Hint

Look for the step where XCTAssertEqual is called in the execution_table.

If fetchData() took longer to complete, which step would be delayed?

A Step 2

B Step 3

C Step 1

D Step 4

💡 Hint

Step 3 is when fetchData() completes and returns the result.

Concept Snapshot

Testing async code in Swift:
- Use 'async' in test function signature
- Call async functions with 'try await'
- Wait for async result before assertions
- Use XCTAssert functions to check results
- Test passes if no errors and assertions succeed

Full Transcript

This visual trace shows how to test asynchronous code in Swift. The test function is marked async and calls an async function fetchData using 'try await'. The test waits for fetchData to complete and returns a result. Then it compares the result with the expected value using XCTAssertEqual. If the values match and no errors occur, the test passes. Key moments include understanding why 'await' is needed to pause execution until the async call finishes, and how the assertion checks the result. The quiz questions help reinforce these steps by asking about variable values and timing of checks.

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