Timeout Test in JUnit 5

1. Introduction

This tutorial is going to cover about Timeout test in JUnit 5. If a test takes too long, can be failed automatically. JUnit 5 provides us some timeout assertions which we can specify the timeout to cause a test method to fail if it takes longer than that timeout.

1. Prerequisites

We will need the following items to be ready on your environment.

Java 8
JUnit 5
Any IDE: Eclipse, IntelliJ IDE

Guides to setup those can be found at: JUnit 5 Basic Introduction – Getting Started With The Next Generation of JUnit

2. Timeout Test in JUnit 5

JUnit 5 comes with 2 main assertions for timeout test:

assertTimeout
assertTimeoutPreemptively

Let’s see the detailed signature of each method:

2.1. assertTimeout

public static void assertTimeout(Duration timeout, Executable executable) {
    AssertTimeout.assertTimeout(timeout, executable);
}

public static void assertTimeout(Duration timeout, Executable executable) {

AssertTimeout.assertTimeout(timeout, executable);

}

This method asserts that execution of the supplied executable completes before the given timeout is exceeded.

2.2. assertTimeoutPreemptively

public static void assertTimeoutPreemptively(Duration timeout, Executable executable) {
    AssertTimeout.assertTimeoutPreemptively(timeout, executable);
}

public static void assertTimeoutPreemptively(Duration timeout, Executable executable) {

AssertTimeout.assertTimeoutPreemptively(timeout, executable);

}

This method asserts that execution of the supplied executable completes before the given timeout is exceeded. Note that the executable will be executed in a different thread than that of the calling code. Furthermore, execution of the executable will be preemptively aborted if the timeout is exceeded.

Besides, there are several overloaded methods of the above methods to supply additional messages in case the tests failed by timeouts.

3. JUnit 5 Timeout Test Examples

In this section, we’re going to get through some examples of timeout test in JUnit 5. The sample source code can be found in Github or download via the link: java-source-example.zip

Let’s say we have a class with 2 methods need to be tested as below:

public class OrderService {

    public void doPayment() {
        try {
            Thread.sleep(10000);// 10 seconds
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }

    public void printShippingLabel() {
        try {
            Thread.sleep(20000);// 20 seconds
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

public class OrderService {

public void doPayment() {

try {

Thread.sleep(10000);// 10 seconds

} catch (InterruptedException e) {

e.printStackTrace();

}

public void printShippingLabel() {

try {

Thread.sleep(20000);// 20 seconds

} catch (InterruptedException e) {

e.printStackTrace();

}

They have no business logic insight but just contain source code to simulate a duration that each method is going to take. We may have several test cases as below:

3.1. Using the assertTimeout method

@Test
public void doPaymentNotExceed15Seconds() {
    OrderService orderService = new OrderService();
    assertTimeout(ofSeconds(15), () -> {
        // This method runs in 10 seconds
        orderService.doPayment();
    });
}

@Test

public void doPaymentNotExceed15Seconds() {

OrderService orderService = new OrderService();

assertTimeout(ofSeconds(15), () -> {

// This method runs in 10 seconds

orderService.doPayment();

});

}

Another example that uses an overload of assertTimeout method:

@Test
public void doPaymentExceed5Seconds() {
    OrderService orderService = new OrderService();
    assertTimeout(ofSeconds(5), () -> {
        // This method runs in 10 seconds
        orderService.doPayment();
    } , "The doPayment method take more than 5 seconds");
}

@Test

public void doPaymentExceed5Seconds() {

OrderService orderService = new OrderService();

assertTimeout(ofSeconds(5), () -> {

// This method runs in 10 seconds

orderService.doPayment();

} , "The doPayment method take more than 5 seconds");

}

We have just supplied a message for the assertTimeout method and the message will be printed out if the test fails.

3.2. Using the assertTimeoutPreemptively method

@Test
public void printShippingLabelExceeded15SecondsWithPreemptiveTermination() {
    OrderService orderService = new OrderService();
    assertTimeoutPreemptively(ofSeconds(15), () -> {
        // This method takes 20 seconds to run
        orderService.printShippingLabel();
    } , () -> "The printShippingLabel method took more than 15 seconds and was aborted.");
}

@Test

public void printShippingLabelExceeded15SecondsWithPreemptiveTermination() {

OrderService orderService = new OrderService();

assertTimeoutPreemptively(ofSeconds(15), () -> {

// This method takes 20 seconds to run

orderService.printShippingLabel();

} , () -> "The printShippingLabel method took more than 15 seconds and was aborted.");

}

We have used the assertTimeoutPreemptively method and supplied it a message in case the test fails. Note that when we use this assertion method, the printShippingLabel method will be aborted if its execution time is exceeded 15 seconds.

3.3. The test result in IntelliJ

Test results in IntelliJ

4. Conclusion

The tutorial has shown us about timeout test in JUnit 5 with 2 main supported assertions. Besides, there are other overloaded methods which support additional messages in case the test fails.

Below are other articles related to JUnit 5 for your references:

JUnit 5 Tutorial

JUnit 5 Annotations Example

JUnit 5 Basic Introduction – Getting Started With The Next Generation of JUnit

JUnit 5 Maven Example

JUnit 5 vs JUnit 4

JUnit 5 Assertions Example

JUnit 5 Disable or Ignore A Test

JUnit 5 Exception Testing

JUnit 5 Dynamic Tests – Generate Tests at Run-time

JUnit 5 Nested Tests Examples

JUnit 5 Test Suite – Aggregating Tests In Suites

JUnit 5 Assumptions With Assume

JUnit 5 Parameter Resolution Example

0 0 vote

Article Rating

Timeout Test in JUnit 5

1. Introduction

1. Prerequisites

2. Timeout Test in JUnit 5

2.1. assertTimeout

2.2. assertTimeoutPreemptively

3. JUnit 5 Timeout Test Examples

3.1. Using the assertTimeout method

3.2. Using the assertTimeoutPreemptively method

3.3. The test result in IntelliJ

4. Conclusion

howtoprogram