Test fixtures and lifecycle in Kotlin - Mini Project: Build & Apply

Test fixtures and lifecycle

📖 Scenario: You are writing simple tests for a calculator app. You want to set up a calculator object before each test and clean up after each test.

🎯 Goal: Learn how to use test fixtures and lifecycle methods in Kotlin tests to prepare and clean up test data.

📋 What You'll Learn

Create a Calculator class instance as a test fixture

Use @BeforeEach to initialize the Calculator before each test

Use @AfterEach to reset the Calculator after each test

Write a simple test method that uses the Calculator

💡 Why This Matters

🌍 Real World

Test fixtures and lifecycle methods help prepare and clean up data for automated tests in real apps.

💼 Career

Understanding test lifecycle is essential for writing reliable unit tests in Kotlin development jobs.

1

Create Calculator class and test fixture variable

Create a Kotlin class called Calculator with a method add(a: Int, b: Int): Int that returns the sum of a and b. Then create a test class called CalculatorTest and declare a variable calculator of type Calculator? initialized to null.

Kotlin

class Calculator {
    // Your code here
}

class CalculatorTest {
    var calculator: Calculator? = null
    // Your code here
}

Hint

Define the Calculator class with an add method. Declare a nullable Calculator variable in the test class.

2

Initialize Calculator before each test

In the CalculatorTest class, add a method annotated with @BeforeEach called setup that creates a new Calculator instance and assigns it to the calculator variable.

Kotlin

class Calculator {
    fun add(a: Int, b: Int): Int {
        return a + b
    }
}

class CalculatorTest {
    var calculator: Calculator? = null

    // Add a @BeforeEach method called setup to initialize calculator
    // Your code here
}

Hint

Use @BeforeEach annotation and assign a new Calculator to calculator inside setup.

3

Reset Calculator after each test

In the CalculatorTest class, add a method annotated with @AfterEach called tearDown that sets the calculator variable to null.

Kotlin

import org.junit.jupiter.api.BeforeEach

class Calculator {
    fun add(a: Int, b: Int): Int {
        return a + b
    }
}

class CalculatorTest {
    var calculator: Calculator? = null

    @BeforeEach
    fun setup() {
        calculator = Calculator()
    }

    // Add a @AfterEach method called tearDown to reset calculator
    // Your code here
}

Hint

Use @AfterEach annotation and set calculator to null inside tearDown.

4

Write a test using the fixture

In the CalculatorTest class, add a test method annotated with @Test called testAdd that uses the calculator variable to call add(2, 3) and prints the result.

Kotlin

import org.junit.jupiter.api.BeforeEach
import org.junit.jupiter.api.AfterEach
import org.junit.jupiter.api.Test

class Calculator {
    fun add(a: Int, b: Int): Int {
        return a + b
    }
}

class CalculatorTest {
    var calculator: Calculator? = null

    @BeforeEach
    fun setup() {
        calculator = Calculator()
    }

    @AfterEach
    fun tearDown() {
        calculator = null
    }

    // Add a @Test method called testAdd that prints calculator.add(2, 3)
    // Your code here
}

Hint

Use @Test annotation and print the result of calculator?.add(2, 3).

Practice

1. What is the main purpose of test fixtures in Kotlin testing?

easy

A. To prepare and clean the test environment before and after tests

B. To write the actual test cases

C. To generate random test data automatically

D. To compile the Kotlin code before running tests

Solution

1. Step 1: Understand what test fixtures do

   Test fixtures set up the environment needed for tests and clean it afterward to avoid side effects.

2. Step 2: Identify the correct purpose

   Among the options, only preparing and cleaning the test environment matches the role of test fixtures.

3. Final Answer:

   To prepare and clean the test environment before and after tests -> Option A

4. Quick Check:

   Test fixtures = prepare and clean environment [OK]

Hint: Remember: fixtures setup and cleanup tests [OK]

Common Mistakes:

• Confusing fixtures with test case logic
• Thinking fixtures generate test data
• Assuming fixtures compile code

2. Which annotation in Kotlin testing runs a method once before all tests in a class?

easy

A. @AfterEach

B. @BeforeAll

C. @BeforeEach

D. @AfterAll

Solution

1. Step 1: Recall lifecycle annotations

   @BeforeAll runs once before all tests; @BeforeEach runs before each test.

2. Step 2: Match annotation to description

   The annotation that runs once before all tests is @BeforeAll.

3. Final Answer:

   @BeforeAll -> Option B

4. Quick Check:

   @BeforeAll = run once before all tests [OK]

Hint: BeforeAll runs once before all tests [OK]

Common Mistakes:

• Mixing @BeforeEach with @BeforeAll
• Confusing @AfterAll with @BeforeAll
• Using @AfterEach instead of @BeforeAll

3. Given the following Kotlin test class, what will be the output order of the print statements?

class SampleTest {
    @BeforeAll
    fun setupAll() = println("SetupAll")

    @BeforeEach
    fun setup() = println("Setup")

    @Test
    fun test1() = println("Test1")

    @Test
    fun test2() = println("Test2")

    @AfterEach
    fun tearDown() = println("TearDown")

    @AfterAll
    fun tearDownAll() = println("TearDownAll")
}

medium

A. Setup
Test1
Setup
Test2
TearDown
TearDownAll
SetupAll

B. Setup
Test1
TearDown
Setup
Test2
TearDown
SetupAll
TearDownAll

C. SetupAll
Setup
Test1
Test2
TearDown
TearDownAll

D. SetupAll
Setup
Test1
TearDown
Setup
Test2
TearDown
TearDownAll

Solution

1. Step 1: Understand lifecycle order

   @BeforeAll runs once before all tests, then for each test @BeforeEach, test, @AfterEach run, and finally @AfterAll runs once after all tests.

2. Step 2: Trace the print statements

   Output order: SetupAll (once), then for test1: Setup, Test1, TearDown; for test2: Setup, Test2, TearDown; finally TearDownAll.

3. Final Answer:

   SetupAll Setup Test1 TearDown Setup Test2 TearDown TearDownAll -> Option D

4. Quick Check:

   Lifecycle order = D [OK]

Hint: BeforeAll once, BeforeEach per test, AfterEach per test, AfterAll once [OK]

Common Mistakes:

• Assuming @BeforeEach runs once only
• Mixing order of AfterEach and AfterAll
• Forgetting @BeforeAll and @AfterAll run once

4. Identify the error in this Kotlin test fixture code snippet:

@BeforeAll
fun setup() {
    println("Setup")
}

@Test
fun testExample() {
    println("Test")
}

medium

A. @BeforeAll method must be static or inside a companion object

B. setup() should return a value

C. Missing @Test annotation on setup()

D. testExample() must be private

Solution

1. Step 1: Recall @BeforeAll requirements in Kotlin

   @BeforeAll methods must be static or placed inside a companion object to run once before all tests.

2. Step 2: Check the code snippet

   The setup() method is annotated with @BeforeAll but is not static nor inside a companion object, causing an error.

3. Final Answer:

   @BeforeAll method must be static or inside a companion object -> Option A

4. Quick Check:

   @BeforeAll requires static or companion object [OK]

Hint: @BeforeAll needs static or companion object [OK]

Common Mistakes:

• Thinking @BeforeAll can be a normal instance method
• Assuming test methods must be private
• Believing setup() needs a return value

5. You want to ensure a database connection is opened once before all tests and closed once after all tests in a Kotlin test class. Which is the best way to implement this using test fixtures?

hard

A. Use @BeforeEach to open and @AfterEach to close the connection

B. Open the connection in the constructor and close it in a test method

C. Use @BeforeAll inside a companion object to open and @AfterAll inside the companion object to close

D. Use @BeforeAll and @AfterAll as instance methods without companion object

Solution

1. Step 1: Understand lifecycle for shared resources

   Resources like database connections should open once before all tests and close once after all tests to save time and avoid repeated setup.

2. Step 2: Apply Kotlin @BeforeAll/@AfterAll rules

   In Kotlin, @BeforeAll and @AfterAll must be inside a companion object or be static to run once per class.

3. Step 3: Evaluate options

   Use @BeforeAll inside a companion object to open and @AfterAll inside the companion object to close correctly uses @BeforeAll and @AfterAll inside a companion object for one-time setup and teardown.

4. Final Answer:

   Use @BeforeAll inside a companion object to open and @AfterAll inside the companion object to close -> Option C

5. Quick Check:

   Shared setup/teardown = @BeforeAll/@AfterAll in companion object [OK]

Hint: Use companion object for @BeforeAll/@AfterAll in Kotlin [OK]

Common Mistakes:

• Using @BeforeEach/@AfterEach for expensive shared setup
• Placing @BeforeAll/@AfterAll outside companion object
• Opening connection in constructor instead of fixture