Why lifecycle hooks manage setup and teardown in JUnit - Automation Benefits in Action

Verify setup and teardown using JUnit lifecycle hooks

Preconditions (2)

Step 1: Create a test class CalculatorTest

Step 2: Use @BeforeEach to initialize a Calculator object before each test

Step 3: Write a test method testAdd that adds two numbers and asserts the result

Step 4: Write a test method testSubtract that subtracts two numbers and asserts the result

Step 5: Use @AfterEach to set the Calculator object to null after each test

Step 6: Run the tests and observe that setup runs before each test and teardown runs after each test

✅ Expected Result: Each test method runs with a fresh Calculator instance initialized by @BeforeEach, and after each test the Calculator reference is cleared by @AfterEach. Tests pass successfully.

Automation Requirements - JUnit 5

Assertions Needed:

Assert that add method returns correct sum

Assert that subtract method returns correct difference

Best Practices:

Use @BeforeEach for setup to ensure fresh test state

Use @AfterEach for cleanup to avoid side effects

Keep tests independent and repeatable

Automated Solution

JUnit

import static org.junit.jupiter.api.Assertions.*;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;

class Calculator {
    int add(int a, int b) {
        return a + b;
    }
    int subtract(int a, int b) {
        return a - b;
    }
}

public class CalculatorTest {
    private Calculator calculator;

    @BeforeEach
    void setUp() {
        calculator = new Calculator();
    }

    @AfterEach
    void tearDown() {
        calculator = null;
    }

    @Test
    void testAdd() {
        int result = calculator.add(5, 3);
        assertEquals(8, result, "5 + 3 should equal 8");
    }

    @Test
    void testSubtract() {
        int result = calculator.subtract(10, 4);
        assertEquals(6, result, "10 - 4 should equal 6");
    }
}

The @BeforeEach method setUp() runs before each test method. It creates a new Calculator instance so each test starts fresh, avoiding shared state.

The @AfterEach method tearDown() runs after each test method. It clears the Calculator reference to help with cleanup and avoid side effects.

Each test method uses the Calculator instance to perform operations and asserts the expected results. This shows how lifecycle hooks manage setup and teardown to keep tests independent and reliable.

Common Mistakes - 3 Pitfalls

Initializing the Calculator object inside each test method instead of using @BeforeEach

Not cleaning up resources or resetting state in @AfterEach

Using @BeforeAll or @AfterAll for instance setup and teardown

Bonus Challenge

Now add a test method that verifies multiplication using the same setup and teardown lifecycle hooks.

Show Hint

Practice

1. Why do we use lifecycle hooks like @BeforeEach and @AfterEach in JUnit tests?

easy

A. To write test cases faster by skipping assertions

B. To run setup and cleanup code before and after each test automatically

C. To make tests run in parallel

D. To generate test reports automatically

Solution

1. Step 1: Understand lifecycle hooks purpose

   Lifecycle hooks like @BeforeEach and @AfterEach run code before and after each test method to prepare and clean up the test environment.

2. Step 2: Identify correct use case

   This avoids repeating setup and teardown code inside every test, keeping tests clean and consistent.

3. Final Answer:

   To run setup and cleanup code before and after each test automatically -> Option B

4. Quick Check:

   Lifecycle hooks = setup/teardown automation [OK]

Hint: Lifecycle hooks automate setup and cleanup around tests [OK]

Common Mistakes:

• Thinking lifecycle hooks skip assertions
• Confusing lifecycle hooks with parallel test execution
• Assuming lifecycle hooks generate reports

2. Which of the following is the correct syntax to run a method once before all tests in a JUnit 5 test class?

easy

A. @BeforeEach public void setup() {}

B. @AfterAll public void finish() {}

C. @BeforeAll public static void init() {}

D. @AfterEach public void cleanup() {}

Solution

1. Step 1: Identify the annotation for running once before all tests

   The @BeforeAll annotation runs a method once before any tests in the class run.

2. Step 2: Check method signature requirements

   Methods with @BeforeAll must be static in JUnit 5, so public static void init() is correct.

3. Final Answer:

   @BeforeAll public static void init() {} -> Option C

4. Quick Check:

   @BeforeAll + static = run once before all tests [OK]

Hint: @BeforeAll must be static to run once before all tests [OK]

Common Mistakes:

• Using @BeforeEach instead of @BeforeAll for once-only setup
• Not making @BeforeAll method static
• Confusing @AfterEach with setup annotations

3. Consider this JUnit 5 test class snippet:

class SampleTest {
  static int counter = 0;

  @BeforeEach
  void beforeEach() {
    counter++;
  }

  @Test
  void testOne() {}

  @Test
  void testTwo() {}

  @AfterAll
  static void afterAll() {
    System.out.println(counter);
  }
}

What will be printed when the tests run?

medium

A. 2

B. 1

C. 0

D. Compilation error

Solution

1. Step 1: Analyze the lifecycle annotations and method signatures

   The @AfterAll method must be static, which it is. However, counter is static and incremented in @BeforeEach which is non-static, so no issue there.

2. Step 2: Check for JUnit 5 rules on lifecycle methods

   JUnit 5 requires @BeforeEach and @AfterEach methods to be non-static, which is correct here. But @AfterAll is static, so no problem.

3. Step 3: Identify the problem

   However, the class is missing the @TestInstance(Lifecycle.PER_CLASS) annotation if we want to use static fields properly with lifecycle hooks. Without it, static fields are fine but the test runner may not allow static @AfterAll without this annotation in some setups.

4. Step 4: Confirm if code compiles

   Actually, this code compiles and runs fine. The counter increments twice (once per test), so 2 is printed.

5. Final Answer:

   2 -> Option A

6. Quick Check:

   Counter increments twice = 2 printed [OK]

Hint: Each @BeforeEach runs before every test, incrementing counter [OK]

Common Mistakes:

• Assuming @AfterAll cannot access static fields
• Thinking counter resets between tests
• Confusing static and instance method requirements

4. Identify the error in this JUnit 5 test class:

class TestExample {
  @BeforeAll
  void setup() {
    System.out.println("Setup");
  }

  @Test
  void test() {
    System.out.println("Test running");
  }
}

medium

A. Method annotated with @BeforeAll must be static

B. Method annotated with @Test must be static

C. Missing @AfterEach method

D. No error, code is correct

Solution

1. Step 1: Check @BeforeAll method requirements

   In JUnit 5, methods annotated with @BeforeAll must be static unless the test class is annotated with @TestInstance(Lifecycle.PER_CLASS).

2. Step 2: Verify method signature

   The setup() method is not static, and the class lacks @TestInstance, so this causes a runtime error.

3. Final Answer:

   Method annotated with @BeforeAll must be static -> Option A

4. Quick Check:

   @BeforeAll requires static method without @TestInstance [OK]

Hint: @BeforeAll methods must be static unless @TestInstance used [OK]

Common Mistakes:

• Thinking @Test methods must be static
• Believing missing @AfterEach is an error
• Ignoring static requirement for @BeforeAll

5. You want to open a database connection once before all tests and close it once after all tests in a JUnit 5 class. Which setup is best practice?

hard

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

B. Open and close connection inside each test method manually

C. Use @BeforeAll non-static method to open and @AfterAll non-static method to close

D. Use @BeforeAll static method to open and @AfterAll static method to close the connection

Solution

1. Step 1: Understand resource management scope

   Opening a database connection once before all tests and closing it once after all tests saves time and resources.

2. Step 2: Choose correct lifecycle hooks

   @BeforeAll and @AfterAll run once per test class, ideal for this purpose. They must be static methods unless using @TestInstance(Lifecycle.PER_CLASS).

3. Final Answer:

   Use @BeforeAll static method to open and @AfterAll static method to close the connection -> Option D

4. Quick Check:

   Open/close once with @BeforeAll/@AfterAll static methods [OK]

Hint: Use @BeforeAll/@AfterAll static for one-time setup/teardown [OK]

Common Mistakes:

• Using @BeforeEach/@AfterEach causing repeated open/close
• Opening/closing inside each test wastes resources
• Using non-static @BeforeAll/@AfterAll without @TestInstance