Testing async code in Swift - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the main challenge when testing async code?

The main challenge is that async code runs in the background, so tests must wait for the async tasks to complete before checking results.

beginner

What Swift feature helps to write tests for async functions?

Swift uses the async keyword in test functions and await to wait for async calls to finish.

intermediate

How do you tell XCTest to wait for an async operation to finish?

You mark the test method with async and use await inside it to pause until the async operation completes.

intermediate

What is an XCTestExpectation and when is it used?

An XCTestExpectation is used to tell the test to wait for an async event to happen, especially when not using async/await syntax.

advanced

Why is it important to avoid blocking the main thread in async tests?

Blocking the main thread can cause deadlocks or freeze the test runner, so async tests should use proper async patterns to stay responsive.

Which keyword do you use in Swift to wait for an async function to complete in a test?

A wait

B await

C pause

D delay

The await keyword pauses the test until the async function finishes.

How do you mark a test function in Swift that tests async code?

A Add <code>async</code> to the function signature

B Add <code>throws</code> only

C Use <code>dispatch_async</code>

D No special marking needed

You add async to the test function so it can use await inside.

What does XCTestExpectation help with?

A Waiting for async events in tests

B Creating UI elements

C Logging test results

D Measuring performance

XCTestExpectation lets tests wait for async events to complete.

What happens if you block the main thread in async tests?

A Nothing special happens

B The test runs faster

C The test automatically retries

D The test may freeze or deadlock

Blocking the main thread can cause the test to freeze or deadlock.

Which is the best way to test async code in Swift?

A Run async code on the main thread

B Use sleep() to wait

C Use async test functions with await

D Ignore async and test synchronously

Using async test functions with await is the cleanest and safest way.

Explain how to write a simple async test function in Swift using XCTest.

Think about marking the test function and how to pause for async calls.

Describe the role of XCTestExpectation in testing asynchronous code.

Consider how tests wait for background tasks before async/await was common.

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