assertTimeout for performance in JUnit - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is assertTimeout used for in JUnit?

assertTimeout checks if a block of code finishes execution within a specified time limit. It helps test performance by ensuring methods run fast enough.

beginner

How do you specify the time limit in assertTimeout?

You specify the time limit using a Duration object, like Duration.ofSeconds(2), which means the code must finish within 2 seconds.

beginner

What happens if the code inside assertTimeout takes longer than the specified duration?

The test fails with a timeout exception, indicating the code did not meet the performance requirement.

intermediate

Write a simple example of assertTimeout in JUnit to test a method processData() runs within 1 second.

assertTimeout(Duration.ofSeconds(1), () -> {
    processData();
});

intermediate

Can assertTimeout return a value from the tested code block?

Yes, assertTimeout can return the result of the code block if you use the variant that returns a value, allowing further assertions on the result.

What does assertTimeout(Duration.ofSeconds(2), () -> method()) check?

A Method finishes within 2 seconds

B Method throws an exception within 2 seconds

C Method runs exactly 2 seconds

D Method runs longer than 2 seconds

assertTimeout ensures the method finishes within the given duration, here 2 seconds.

If the tested code exceeds the timeout in assertTimeout, what is the test result?

A Test passes

B Test is skipped

C Test fails

D Test retries automatically

The test fails because the code did not complete within the allowed time.

Which Java class is used to specify the timeout duration in assertTimeout?

A Duration

B TimeUnit

C Timer

D Timeout

Duration is used to specify time intervals like seconds or milliseconds.

Can assertTimeout be used to test asynchronous code performance?

A Yes, directly

B Yes, but requires special handling

C No, it only tests exceptions

D No, it only works with synchronous code

It can test async code but you need to wait or block until completion inside the lambda.

What is the difference between assertTimeout and assertTimeoutPreemptively?

A Only <code>assertTimeout</code> supports durations

B <code>assertTimeout</code> interrupts the code on timeout, <code>assertTimeoutPreemptively</code> waits

C Both behave the same

D <code>assertTimeoutPreemptively</code> interrupts the code on timeout, <code>assertTimeout</code> waits

assertTimeoutPreemptively stops the code immediately on timeout, assertTimeout waits for completion but fails if too slow.

Explain how assertTimeout helps in performance testing with JUnit.

Think about how you check if a method runs fast enough.

Describe the difference between assertTimeout and assertTimeoutPreemptively.

One stops the code immediately, the other waits for it to finish.

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