assertTimeout for performance in JUnit - Build an Automation Script

Verify method completes within 2 seconds using assertTimeout

Preconditions (2)

Step 1: Call the method named 'performHeavyCalculation' without parameters

Step 2: Measure the execution time of the method

Step 3: Verify that the method finishes execution within 2 seconds

✅ Expected Result: The test passes if 'performHeavyCalculation' completes within 2 seconds, otherwise it fails

Automation Requirements - JUnit 5

Assertions Needed:

Use assertTimeout to check method execution time is less than or equal to 2 seconds

Best Practices:

Use lambda expression inside assertTimeout to call the method

Avoid Thread.sleep or manual timing for performance assertion

Keep test method simple and focused on timing assertion

Automated Solution

JUnit

import static org.junit.jupiter.api.Assertions.assertTimeout;
import java.time.Duration;
import org.junit.jupiter.api.Test;

public class PerformanceTest {

    // Example method to test
    public void performHeavyCalculation() {
        // Simulate some work
        for (int i = 0; i < 1_000_000; i++) {
            Math.sqrt(i);
        }
    }

    @Test
    public void testPerformHeavyCalculationCompletesWithinTwoSeconds() {
        assertTimeout(Duration.ofSeconds(2), () -> {
            performHeavyCalculation();
        });
    }
}

This test uses JUnit 5's assertTimeout method to check that performHeavyCalculation finishes within 2 seconds.

The Duration.ofSeconds(2) sets the maximum allowed time.

The method call is wrapped in a lambda expression, which assertTimeout runs and measures.

If the method takes longer than 2 seconds, the test fails automatically.

This approach is simple, readable, and uses JUnit's built-in timing features without manual timers.

Common Mistakes - 3 Pitfalls

Using Thread.sleep to simulate timing instead of assertTimeout

Calling the method outside the lambda passed to assertTimeout

Using assertTimeoutPreemptively without understanding it cancels the method on timeout

Bonus Challenge

Now add data-driven testing with 3 different methods that should complete within 2 seconds each

Show Hint

Practice

1. What is the main purpose of assertTimeout in JUnit testing?

easy

A. To test if exceptions are thrown correctly

B. To check if a block of code finishes execution within a specified time limit

C. To verify the correctness of output values

D. To compare two objects for equality

Solution

1. Step 1: Understand the role of assertTimeout

   assertTimeout is used to ensure that a piece of code completes within a given time limit.

2. Step 2: Differentiate from other assertions

   Other assertions check correctness or exceptions, but assertTimeout focuses on performance timing.

3. Final Answer:

   To check if a block of code finishes execution within a specified time limit -> Option B

4. Quick Check:

   assertTimeout checks execution time = C [OK]

Hint: assertTimeout checks speed, not correctness or exceptions [OK]

Common Mistakes:

• Confusing assertTimeout with assertEquals
• Thinking assertTimeout checks output correctness
• Assuming assertTimeout tests exception throwing

2. Which of the following is the correct syntax to use assertTimeout in JUnit 5 to test a method processData() with a 2-second limit?

easy

A. assertTimeout(Duration.ofSeconds(2), () -> processData());

B. assertTimeout(2, processData());

C. assertTimeout(2000, () -> processData());

D. assertTimeout(Duration.seconds(2), processData());

Solution

1. Step 1: Recall correct Duration usage

   JUnit 5 uses Duration.ofSeconds(2) to specify 2 seconds.

2. Step 2: Confirm lambda syntax

   The code block must be passed as a lambda: () -> processData().

3. Final Answer:

   assertTimeout(Duration.ofSeconds(2), () -> processData()); -> Option A

4. Quick Check:

   Duration.ofSeconds + lambda = A [OK]

Hint: Use Duration.ofSeconds and lambda for assertTimeout [OK]

Common Mistakes:

• Passing method call directly instead of lambda
• Using integer instead of Duration object
• Wrong Duration method like Duration.seconds

3. Given the code below, what will be the test result?

assertTimeout(Duration.ofMillis(500), () -> {
    Thread.sleep(300);
    Thread.sleep(250);
});

medium

A. Test passes because total sleep is 550ms which is less than 500ms

B. Test passes because each sleep is less than 500ms

C. Test fails because total sleep is 550ms which exceeds 500ms

D. Test fails due to syntax error in lambda

Solution

1. Step 1: Calculate total sleep time

   Thread sleeps 300ms + 250ms = 550ms total.

2. Step 2: Compare with timeout limit

   Timeout is 500ms, so 550ms exceeds the limit causing failure.

3. Final Answer:

   Test fails because total sleep is 550ms which exceeds 500ms -> Option C

4. Quick Check:

   Total sleep 550ms > 500ms timeout = B [OK]

Hint: Sum all delays and compare to timeout [OK]

Common Mistakes:

• Ignoring cumulative sleep time
• Assuming each sleep is checked separately
• Thinking test passes if individual sleeps are under limit

4. Identify the error in this JUnit 5 test using assertTimeout:

assertTimeout(Duration.ofSeconds(1), processData());

medium

A. processData() must return a boolean

B. Duration.ofSeconds should be Duration.seconds

C. assertTimeout requires a timeout in milliseconds

D. Missing lambda expression to defer execution

Solution

1. Step 1: Check how code block is passed

   assertTimeout expects a lambda or executable to delay running until assertion.

2. Step 2: Identify missing lambda

   Here, processData() is called immediately, not deferred by lambda.

3. Final Answer:

   Missing lambda expression to defer execution -> Option D

4. Quick Check:

   assertTimeout needs lambda to delay execution = A [OK]

Hint: Always wrap code in lambda for assertTimeout [OK]

Common Mistakes:

• Calling method directly instead of lambda
• Using wrong Duration method
• Expecting assertTimeout to accept milliseconds as int

5. You want to test a method calculate() that sometimes takes longer but should not exceed 3 seconds. Which approach correctly uses assertTimeout to fail the test if calculate() exceeds 3 seconds, and also returns the method's result for further checks?

hard

A. var result = assertTimeout(Duration.ofSeconds(3), () -> { return calculate(); });

B. assertTimeout(Duration.ofSeconds(3), () -> { calculate(); });

C. assertTimeout(Duration.ofSeconds(3), () -> { return calculate(); });

D. var result = assertTimeout(Duration.ofSeconds(3), calculate());

Solution

1. Step 1: Understand assertTimeout return value

   assertTimeout returns the value from the lambda if it completes in time.

2. Step 2: Use lambda with return and assign result

   To capture calculate() result, lambda must return it and assign to a variable.

3. Step 3: Check syntax correctness

   var result = assertTimeout(Duration.ofSeconds(3), () -> { return calculate(); }); uses lambda with return and assigns to result, matching requirements.

4. Final Answer:

   var result = assertTimeout(Duration.ofSeconds(3), () -> { return calculate(); }); -> Option A

5. Quick Check:

   Return value + assign result + timeout = D [OK]

Hint: Use lambda with return and assign to capture result [OK]

Common Mistakes:

• Not returning value inside lambda
• Not assigning assertTimeout result
• Using lambda without return for non-void methods