XCTest framework basics in Swift - Mini Project: Build & Apply

XCTest framework basics

📖 Scenario: You are building a simple calculator app and want to make sure the addition function works correctly. To do this, you will write tests using the XCTest framework in Swift.

🎯 Goal: Learn how to create a test case class, write a test method using XCTest, and run the test to check if the addition function returns the correct result.

📋 What You'll Learn

Create a test case class inheriting from XCTestCase

Write a test method starting with test

Use XCTAssertEqual to check the addition result

Run the test and print the result

💡 Why This Matters

🌍 Real World

Testing code ensures your app works correctly before users see it. XCTest is the standard way to write tests in Swift apps.

💼 Career

Many software jobs require writing automated tests. Knowing XCTest helps you write reliable Swift code and work well in teams.

1

Create the addition function

Create a function called add that takes two Int parameters named a and b and returns their sum as an Int.

Swift

# Create the add function
// Your code here

Hint

Define a function with two parameters and return their sum using return a + b.

2

Create a test case class

Create a class called CalculatorTests that inherits from XCTestCase.

Swift

func add(a: Int, b: Int) -> Int {
    return a + b
}

// Create CalculatorTests class inheriting from XCTestCase
// Your code here

Hint

Use class CalculatorTests: XCTestCase { } to create the test case class.

3

Write a test method for addition

Inside the CalculatorTests class, write a test method called testAdd that calls add(a: 2, b: 3) and uses XCTAssertEqual to check if the result equals 5.

Swift

import XCTest

func add(a: Int, b: Int) -> Int {
    return a + b
}

class CalculatorTests: XCTestCase {
    // Write testAdd method
    // Your code here
}

Hint

Define a method starting with test, call add, and use XCTAssertEqual to compare.

4

Run the test and print the result

Add code to run the test suite for CalculatorTests and print "All tests passed!" if the test succeeds.

Swift

import XCTest

func add(a: Int, b: Int) -> Int {
    return a + b
}

class CalculatorTests: XCTestCase {
    func testAdd() {
        let result = add(a: 2, b: 3)
        XCTAssertEqual(result, 5)
    }
}

// Run the test suite and print result
// Your code here

Hint

Use XCTMain with testCase and print the success message.

Practice

1. What is the main purpose of the XCTest framework in Swift?

easy

A. To manage app navigation and routing

B. To create user interfaces for iOS apps

C. To write tests that check if your Swift code works correctly

D. To handle network requests and responses

Solution

1. Step 1: Understand XCTest framework role

   XCTest is designed to help developers write tests for their Swift code to ensure it behaves as expected.

2. Step 2: Compare options with XCTest purpose

   Only To write tests that check if your Swift code works correctly describes writing tests to check code correctness, which matches XCTest's main use.

3. Final Answer:

   To write tests that check if your Swift code works correctly -> Option C

4. Quick Check:

   XCTest purpose = write tests [OK]

Hint: XCTest is for testing code correctness only [OK]

Common Mistakes:

• Confusing XCTest with UI design tools
• Thinking XCTest manages app navigation
• Assuming XCTest handles networking

2. Which of the following is the correct way to declare a test method inside an XCTestCase subclass?

easy

A. func testExample() { }

B. func exampleTest() { }

C. func TestExample() { }

D. func example() { }

Solution

1. Step 1: Recall XCTest method naming rules

   Test methods must start with the word 'test' and use camelCase, starting with lowercase.

2. Step 2: Check each option's method name

   func testExample() { } starts with 'test' and uses correct casing. Others either start with the wrong word or uppercase first letter.

3. Final Answer:

   func testExample() { } -> Option A

4. Quick Check:

   Test method name starts with 'test' [OK]

Hint: Test methods always start with 'test' lowercase [OK]

Common Mistakes:

• Starting method name with uppercase 'Test'
• Placing 'test' at the end of method name
• Not starting method name with 'test'

3. What will be the output when running this test method?

class MyTests: XCTestCase {
    func testSum() {
        let result = 2 + 3
        XCTAssertEqual(result, 5)
    }
}

medium

A. Test fails with an assertion error

B. Test passes with no errors

C. Compilation error due to missing return

D. Runtime error due to wrong XCTAssert usage

Solution

1. Step 1: Analyze the test method logic

   The method calculates 2 + 3 and stores in result, which equals 5.

2. Step 2: Check the assertion

   XCTAssertEqual compares result (5) with expected value 5, which matches, so assertion passes.

3. Final Answer:

   Test passes with no errors -> Option B

4. Quick Check:

   2 + 3 = 5, XCTAssertEqual passes [OK]

Hint: XCTAssertEqual passes if values are equal [OK]

Common Mistakes:

• Thinking test fails when values match
• Confusing compilation errors with test failures
• Assuming XCTAssertEqual causes runtime errors

4. Identify the error in this test code:

class SampleTests: XCTestCase {
    func testMultiply() {
        let product = 4 * 5
        XCTAssertEqual(product, 20
    }
}

medium

A. Missing closing parenthesis in XCTAssertEqual

B. Test method name does not start with 'test'

C. Incorrect multiplication operator used

D. XCTestCase subclass missing override keyword

Solution

1. Step 1: Check syntax of XCTAssertEqual call

   The XCTAssertEqual call is missing a closing parenthesis at the end.

2. Step 2: Verify other parts

   Method name starts with 'test', multiplication operator is correct, and override keyword is not required here.

3. Final Answer:

   Missing closing parenthesis in XCTAssertEqual -> Option A

4. Quick Check:

   Syntax error due to missing ')' [OK]

Hint: Count parentheses carefully in assertions [OK]

Common Mistakes:

• Ignoring missing parentheses causing syntax errors
• Thinking override is needed for test methods
• Confusing operators in simple math

5. You want to test a function that returns the maximum number from an array. Which XCTest assertion is best to verify the result?

hard

A. XCTAssertNil to check if the max value is nil

B. XCTAssertThrowsError to check if max throws an error

C. XCTAssertTrue to check if max value is greater than zero

D. XCTAssertEqual to compare expected and actual max values

Solution

1. Step 1: Understand the function's expected output

   The function returns the maximum number from an array, which is a specific value.

2. Step 2: Choose assertion to compare values

   XCTAssertEqual compares two values for equality, perfect to check if returned max matches expected max.

3. Step 3: Evaluate other options

   XCTAssertNil checks for nil, not suitable here. XCTAssertTrue checks a condition but not exact value. XCTAssertThrowsError checks for errors, irrelevant here.

4. Final Answer:

   XCTAssertEqual to compare expected and actual max values -> Option D

5. Quick Check:

   Compare expected and actual values with XCTAssertEqual [OK]

Hint: Use XCTAssertEqual to check exact values [OK]

Common Mistakes:

• Using XCTAssertNil when value is never nil
• Using XCTAssertTrue without exact value check
• Expecting errors when function doesn't throw