Timeout annotations in JUnit - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of timeout annotations in JUnit?

Timeout annotations in JUnit are used to specify the maximum time a test method should run. If the test exceeds this time, it fails automatically to prevent hanging or long-running tests.

beginner

How do you apply a timeout to a single test method in JUnit 5?

You use the @Timeout annotation above the test method and specify the duration, for example:
@Timeout(5) means the test must finish within 5 seconds.

beginner

What happens if a test annotated with @Timeout exceeds the specified time?

The test fails immediately with a timeout exception, indicating it took longer than allowed.

intermediate

Can you apply @Timeout at the class level in JUnit? What does it do?

Yes, applying @Timeout at the class level sets the timeout for all test methods in that class. Each test must complete within the specified time individually.

intermediate

How do you specify timeout duration units in JUnit 5's @Timeout annotation?

You can specify the time unit using the 'unit' parameter, for example:
@Timeout(value = 500, unit = java.util.concurrent.TimeUnit.MILLISECONDS) sets a 500 milliseconds timeout.

What is the default time unit for the @Timeout annotation in JUnit 5 if not specified?

A Seconds

B Milliseconds

C Minutes

D Hours

If you do not specify the unit in @Timeout, it defaults to seconds.

Where can you apply the @Timeout annotation in JUnit 5?

A Only on test methods

B On both test methods and test classes

C Only on test classes

D Only on setup methods

@Timeout can be applied on both test methods and test classes to set time limits.

What happens if a test exceeds the timeout specified by @Timeout?

A Test fails with a timeout exception

B Test is skipped

C Test continues running

D Test is retried automatically

JUnit fails the test immediately with a timeout exception if it runs longer than allowed.

Which import is required to use @Timeout in JUnit 5?

A org.junit.jupiter.api.TestTimeout

B org.junit.Timeout

C org.junit.jupiter.api.Timeout

D org.junit.jupiter.api.TimeLimit

The correct import for @Timeout in JUnit 5 is org.junit.jupiter.api.Timeout.

How do you specify a timeout of 2 minutes using @Timeout?

A @Timeout(2)

B @Timeout(value = 2, unit = java.util.concurrent.TimeUnit.SECONDS)

C @Timeout(120)

D @Timeout(value = 2, unit = java.util.concurrent.TimeUnit.MINUTES)

You specify the value and unit explicitly: @Timeout(value = 2, unit = TimeUnit.MINUTES).

Explain how timeout annotations help improve test reliability in JUnit.

Think about what happens when a test runs forever or too slow.

Describe how to use the @Timeout annotation to set a 10-second timeout on a test method.

Remember the default time unit if not specified.

Practice

1. What is the main purpose of the @Timeout annotation in JUnit tests?

easy

A. To mark a test as expected to fail

B. To repeat a test multiple times automatically

C. To skip a test during execution

D. To stop a test if it runs longer than a specified time limit

Solution

1. Step 1: Understand the role of @Timeout

   The @Timeout annotation sets a maximum time limit for a test method to run.

2. Step 2: Identify what happens when time limit is exceeded

   If the test runs longer than the specified time, it is stopped and marked as failed.

3. Final Answer:

   To stop a test if it runs longer than a specified time limit -> Option D

4. Quick Check:

   @Timeout stops long tests = A [OK]

Hint: Timeout means stop test if too slow [OK]

Common Mistakes:

• Confusing timeout with repeating tests
• Thinking timeout skips tests
• Assuming timeout marks tests as expected failures

2. Which of the following is the correct way to set a timeout of 5 seconds on a JUnit 5 test method?

easy

A. @Timeout(5)

B. @Timeout(5, SECONDS)

C. @Timeout(value = 5, unit = TimeUnit.SECONDS)

D. @Timeout(value = 5, unit = SECONDS)

Solution

1. Step 1: Recall JUnit 5 @Timeout syntax

   The @Timeout annotation requires a value and a time unit specified as an enum from java.util.concurrent.TimeUnit.

2. Step 2: Match correct syntax

   @Timeout(value = 5, unit = TimeUnit.SECONDS) uses named parameters with value=5 and unit=TimeUnit.SECONDS, which is correct syntax.

3. Final Answer:

   @Timeout(value = 5, unit = TimeUnit.SECONDS) -> Option C

4. Quick Check:

   Use named params with TimeUnit enum = C [OK]

Hint: Use named params and TimeUnit enum for timeout [OK]

Common Mistakes:

• Omitting the time unit
• Using wrong enum or missing TimeUnit prefix
• Passing timeout as single unnamed parameter

3. Consider this JUnit 5 test method:

@Test
@Timeout(value = 2, unit = TimeUnit.SECONDS)
void testSleep() throws InterruptedException {
    Thread.sleep(3000);
}

What will happen when this test runs?

medium

A. The test will fail due to timeout after 2 seconds

B. The test will pass after sleeping 3 seconds

C. The test will fail immediately with an exception

D. The test will be skipped because of timeout

Solution

1. Step 1: Analyze the timeout and sleep duration

   The test has a timeout of 2 seconds but sleeps for 3 seconds, which is longer than allowed.

2. Step 2: Understand test behavior on timeout

   JUnit will stop the test after 2 seconds and mark it as failed due to timeout.

3. Final Answer:

   The test will fail due to timeout after 2 seconds -> Option A

4. Quick Check:

   Sleep longer than timeout causes failure = B [OK]

Hint: Sleep longer than timeout causes fail [OK]

Common Mistakes:

• Thinking test passes despite long sleep
• Assuming test fails immediately without waiting
• Believing test is skipped instead of failed

4. This JUnit 5 test uses @Timeout(1) but does not compile. What is the error?

@Test
@Timeout(1)
void testMethod() {
    // test code
}

medium

A. Missing import for @Timeout annotation

B. Timeout annotation requires a time unit parameter

C. Timeout value must be a string, not an integer

D. Timeout annotation cannot be used on void methods

Solution

1. Step 1: Check @Timeout annotation parameters

   The @Timeout annotation requires both a value and a time unit parameter in JUnit 5.

2. Step 2: Identify missing time unit

   Using @Timeout(1) without specifying the time unit causes a compilation error.

3. Final Answer:

   Timeout annotation requires a time unit parameter -> Option B

4. Quick Check:

   Missing time unit parameter = A [OK]

Hint: Specify time unit with @Timeout [OK]

Common Mistakes:

• Forgetting to specify time unit
• Using @Timeout without time unit
• Thinking @Timeout only works on non-void methods

5. You want to apply a timeout of 500 milliseconds to all test methods in a JUnit 5 test class. Which is the best way to do this?

hard

A. Add @Timeout(value = 500, unit = TimeUnit.MILLISECONDS) on the test class

B. Use Thread.sleep(500) in each test method

C. Set a global timeout property in the JUnit configuration file

D. Add @Timeout(value = 500, unit = TimeUnit.MILLISECONDS) on each test method

Solution

1. Step 1: Understand class-level @Timeout usage

   JUnit 5 allows applying @Timeout at the class level to set a timeout for all test methods inside.

2. Step 2: Compare options for efficiency

   Adding @Timeout on the class is simpler and ensures all tests have the timeout without repeating annotation.

3. Final Answer:

   Add @Timeout(value = 500, unit = TimeUnit.MILLISECONDS) on the test class -> Option A

4. Quick Check:

   Class-level @Timeout applies to all tests = D [OK]

Hint: Put @Timeout on class to affect all tests [OK]

Common Mistakes:

• Adding @Timeout repeatedly on each method
• Trying to set timeout via sleep calls
• Assuming global config sets timeout automatically