Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

How to use Timeout.Builder class of org.junit.rules package

Best junit code snippet using org.junit.rules.Timeout.Builder

Source:ITUtil.java

1/**2 * Copyright 2007-2016, Kaazing Corporation. All rights reserved.3 *4 * Licensed under the Apache License, Version 2.0 (the "License");5 * you may not use this file except in compliance with the License.6 * You may obtain a copy of the License at7 *8 * http://www.apache.org/licenses/LICENSE-2.09 *10 * Unless required by applicable law or agreed to in writing, software11 * distributed under the License is distributed on an "AS IS" BASIS,12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.13 * See the License for the specific language governing permissions and14 * limitations under the License.15 */16package org.kaazing.test.util;17import static java.util.concurrent.TimeUnit.SECONDS;18import java.lang.reflect.Field;19import java.util.concurrent.TimeUnit;20import org.junit.internal.runners.statements.InvokeMethod;21import org.junit.rules.DisableOnDebug;22import org.junit.rules.MethodRule;23import org.junit.rules.RuleChain;24import org.junit.rules.TestRule;25import org.junit.rules.Timeout;26import org.junit.runner.Description;27import org.junit.runners.model.FrameworkMethod;28import org.junit.runners.model.Statement;29import org.kaazing.k3po.junit.rules.K3poRule;30public final class ITUtil {31    /**32     * Creates a rule (chain) out of a k3po rule and gateway rule, adding extra rules as follows:<ol>33     * <li> a timeout rule to have tests time out if they run for more than 10 seconds34     * <li> a rule to print console messages at the start and end of each test method and print trace level35     * log messages on test failure.36     * </ol>37     * @param gateway  Rule to start up and shut down the gateway38     * @param robot    Rule to startup and stop k3po39     * @return         A TestRule which should be the only public @Rule in our robot tests40     */41    public static RuleChain createRuleChain(TestRule gateway, K3poRule robot) {42        return createRuleChain(gateway, robot, 10, SECONDS);43    }44    /**45     * Creates a rule (chain) out of a k3po rule and gateway rule, adding extra rules as follows:<ol>46     * <li> a timeout rule47     * <li> a rule to print console messages at the start and end of each test method and print trace level48     * log messages on test failure.49     * </ol>50     * @param gateway  Rule to start up and shut down the gateway (or acceptor or etc)51     * @param robot    Rule to startup and stop k3po52     * @param timeout  The maximum allowed time duration of each test53     * @param timeUnit The unit for the timeout54     * @return         A TestRule which should be the only public @Rule in our robot tests55     */56    public static RuleChain createRuleChain(TestRule gateway, K3poRule robot, long timeout, TimeUnit timeUnit) {57                TestRule trace = new MethodExecutionTrace();58                TestRule timeoutRule = new DisableOnDebug(Timeout.builder().withTimeout(timeout, timeUnit)59                        .withLookingForStuckThread(true).build());60                return RuleChain.outerRule(trace).around(gateway).around(robot).around(timeoutRule);61    }62    /**63     * Creates a rule (chain) out of a gateway or other rule, adding extra rules as follows:<ol>64     * <li> a timeout rule65     * <li> a rule to print console messages at the start and end of each test method and print trace level66     * log messages on test failure.67     * </ol>68     * @param rule    Rule to startup and stop gateway69     * @param timeout  The maximum allowed time duration of each test (including the gateway rule)70     * @param timeUnit The unit for the timeout71     * @return         A TestRule which should be the only public @Rule in our robot tests72     */73    public static RuleChain createRuleChain(TestRule gateway, long timeout, TimeUnit timeUnit) {74        TestRule trace = new MethodExecutionTrace();75        TestRule timeoutRule = new DisableOnDebug(Timeout.builder().withTimeout(timeout, timeUnit)76                .withLookingForStuckThread(true).build());77        return RuleChain.outerRule(trace).around(timeoutRule).around(gateway);78    }79    /**80     * Creates a rule chain containing the following rules:<ol>81     * <li> a timeout rule82     * <li> a rule to print console messages at the start and end of each test method and print trace level83     * log messages on test failure.84     * </ol>85     * @param timeout  The maximum allowed time duration of the test86     * @param timeUnit The unit for the timeout87     * @return88     */89    public static RuleChain createRuleChain(long timeout, TimeUnit timeUnit) {90        TestRule timeoutRule = timeoutRule(timeout, timeUnit);91        TestRule trace = new MethodExecutionTrace();92        return RuleChain.outerRule(trace).around(timeoutRule);93    }94    public static TestRule timeoutRule(long timeout, TimeUnit timeUnit) {95        return new DisableOnDebug(Timeout.builder().withTimeout(timeout, timeUnit)96            .withLookingForStuckThread(true).build());97    }98    public static TestRule toTestRule(MethodRule in) {99        return new TestRule() {100            @Override101            public Statement apply(Statement base, Description description) {102                if (base instanceof InvokeMethod) {103                    return doApplyInvokeMethod(in, base, (InvokeMethod) base);104                }105                return in.apply(base, null, description);106            }107            private Statement doApplyInvokeMethod(108                MethodRule in,109                Statement base,110                InvokeMethod invokeMethod) {111                try {112                    FrameworkMethod frameworkMethod = (FrameworkMethod) FIELD_FRAMEWORK_METHOD.get(invokeMethod);113                    Object target = FIELD_TARGET.get(invokeMethod);114                    return in.apply(base, frameworkMethod, target);115                }116                catch (IllegalArgumentException | IllegalAccessException ex) {117                    throw new RuntimeException(ex);118                }119            }120        };121    }122    private ITUtil() {123    }124    private static final Field FIELD_TARGET;125    private static final Field FIELD_FRAMEWORK_METHOD;126    static {127        try {128            final Field target = InvokeMethod.class.getDeclaredField("target");129            final Field frameworkMethod = InvokeMethod.class.getDeclaredField("testMethod");130            target.setAccessible(true);131            frameworkMethod.setAccessible(true);132            FIELD_TARGET = target;133            FIELD_FRAMEWORK_METHOD = frameworkMethod;134        }135        catch (NoSuchFieldException | SecurityException ex) {136            throw new RuntimeException(ex);137        }138    }139}...

Source:CategoryBasedTimeout.java

...42  protected CategoryBasedTimeout(Builder builder) {43    super(builder);44  }45  public static Builder builder() {46    return new CategoryBasedTimeout.Builder();47  }48  public static class Builder extends Timeout.Builder {49    public Timeout.Builder withTimeout(Class<?> clazz) {50      Annotation annotation = clazz.getAnnotation(Category.class);51      if (annotation != null) {52        Category category = (Category)annotation;53        for (Class<?> c: category.value()) {54          if (c == SmallTests.class) {55            // See SmallTests. Supposed to run 15 seconds.56            return withTimeout(30, TimeUnit.SECONDS);57          } else if (c == MediumTests.class) {58            // See MediumTests. Supposed to run 50 seconds.59            return withTimeout(180, TimeUnit.SECONDS);60          } else if (c == LargeTests.class) {61            // Let large tests have a ten minute timeout.62            return withTimeout(10, TimeUnit.MINUTES);63          }...

Source:Timeout.java

1public class org.junit.rules.Timeout implements org.junit.rules.TestRule {2  public static org.junit.rules.Timeout$Builder builder();3  public org.junit.rules.Timeout(int);4  public org.junit.rules.Timeout(long, java.util.concurrent.TimeUnit);5  protected org.junit.rules.Timeout(org.junit.rules.Timeout$Builder);6  public static org.junit.rules.Timeout millis(long);7  public static org.junit.rules.Timeout seconds(long);8  protected final long getTimeout(java.util.concurrent.TimeUnit);9  protected final boolean getLookingForStuckThread();10  protected org.junit.runners.model.Statement createFailOnTimeoutStatement(org.junit.runners.model.Statement) throws java.lang.Exception;11  public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement, org.junit.runner.Description);12}...

Source:Timeout$Builder.java

1public class org.junit.rules.Timeout$Builder {2  protected org.junit.rules.Timeout$Builder();3  public org.junit.rules.Timeout$Builder withTimeout(long, java.util.concurrent.TimeUnit);4  protected long getTimeout();5  protected java.util.concurrent.TimeUnit getTimeUnit();6  public org.junit.rules.Timeout$Builder withLookingForStuckThread(boolean);7  protected boolean getLookingForStuckThread();8  public org.junit.rules.Timeout build();9}...

Timeout.Builder

Using AI Code Generation

1import org.junit.Rule;2import org.junit.Test;3import org.junit.rules.Timeout;4public class TimeoutTest {5    public void testInfiniteLoop1() {6        while (true);7    }8    public void testInfiniteLoop2() {9        while (true);10    }11    public void testInfiniteLoop3() {12        while (true);13    }14}15    at java.lang.Object.wait(Native Method)16    at java.lang.Object.wait(Object.java:502)17    at java.lang.ref.ReferenceQueue.remove(ReferenceQueue.java:143)18    at java.lang.ref.ReferenceQueue.remove(ReferenceQueue.java:164)19    at java.lang.ref.Finalizer$FinalizerThread.run(Finalizer.java:209)20import org.junit.jupiter.api.Test;21import org.junit.jupiter.api.Timeout;22import java.util.concurrent.TimeUnit;23public class TimeoutTest {24    @Timeout(value = 1000, unit = TimeUnit.MILLISECONDS)25    public void testInfiniteLoop1() {26        while (true);27    }28    @Timeout(value = 1000, unit = TimeUnit.MILLISECONDS)29    public void testInfiniteLoop2() {30        while (true);31    }32    @Timeout(value = 1000, unit = TimeUnit.MILLISECONDS)33    public void testInfiniteLoop3() {34        while (true);35    }36}37    at org.junit.jupiter.engine.extension.TimeoutExtension.intercept(TimeoutExtension.java:149)38    at org.junit.jupiter.engine.extension.TimeoutExtension.interceptTestableMethod(TimeoutExtension.java:140)39    at org.junit.jupiter.engine.extension.TimeoutExtension.interceptTestMethod(TimeoutExtension.java:84)40    at org.junit.jupiter.engine.execution.ExecutableInvoker$ReflectiveInterceptorCall.lambda$ofVoidMethod$0(ExecutableInvoker.java:115)

Timeout.Builder

Using AI Code Generation

1import org.junit.Rule;2import org.junit.Test;3import org.junit.rules.Timeout;4public class TimeoutTest {5    public Timeout globalTimeout = Timeout.seconds(10);6    public void testInfiniteLoop1() {7        while (true)8            ;9    }10    public void testInfiniteLoop2() {11        while (true)12            ;13    }14}15    at java.lang.Object.wait(Native Method)16    at java.lang.Object.wait(Object.java:502)17    at java.lang.Object.wait(Object.java:458)18    at java.lang.Thread.join(Thread.java:1252)19    at java.lang.Thread.join(Thread.java:1326)20    at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:78)21    at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:57)22    at org.junit.runners.ParentRunner$3.run(ParentRunner.java:290)23    at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71)24    at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288)25    at org.junit.runners.ParentRunner.access$000(ParentRunner.java:58)26    at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:268)27    at org.junit.runners.ParentRunner.run(ParentRunner.java:363)28    at org.junit.runner.JUnitCore.run(JUnitCore.java:137)29    at com.intellij.junit4.JUnit4IdeaTestRunner.startRunnerWithArgs(JUnit4IdeaTestRunner.java:68)30    at com.intellij.rt.execution.junit.IdeaTestRunner$Repeater.startRunnerWithArgs(IdeaTestRunner.java:47)31    at com.intellij.rt.execution.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:242)32    at com.intellij.rt.execution.junit.JUnitStarter.main(JUnitStarter.java:70)

Timeout.Builder

Using AI Code Generation

1import org.junit.Rule;2import org.junit.Test;3import org.junit.rules.Timeout;4public class TestTimeout {5    public void testInfiniteLoop1() {6        int i = 0;7        while (true) {8            System.out.println(i++);9        }10    }11    public void testInfiniteLoop2() {12        int i = 0;13        while (true) {14            System.out.println(i++);15        }16    }17}18    at java.lang.Object.wait(Native Method)19    at java.lang.Object.wait(Object.java:502)20    at java.lang.Thread.join(Thread.java:1252)21    at java.lang.Thread.join(Thread.java:1326)22    at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:76)23    at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:50)24    at org.junit.runners.ParentRunner$3.run(ParentRunner.java:238)25    at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:63)26    at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:236)27    at org.junit.runners.ParentRunner.access$000(ParentRunner.java:53)28    at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:229)29    at org.junit.runners.ParentRunner.run(ParentRunner.java:309)30    at org.eclipse.jdt.internal.junit4.runner.JUnit4TestReference.run(JUnit4TestReference.java:50)31    at org.eclipse.jdt.internal.junit.runner.TestExecution.run(TestExecution.java:38)32    at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java:467)33    at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java:683)34    at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.run(RemoteTestRunner.java:390)35    at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.main(RemoteTestRunner.java:197)

Timeout.Builder

Using AI Code Generation

1import org.junit.rules.Timeout;2import org.junit.Rule;3import org.junit.Test;4public class TimeoutTest {5    public void testInfiniteLoop1() {6        while (true) {7        }8    }9    public void testInfiniteLoop2() {10        while (true) {11        }12    }13}14import org.junit.Rule;15import org.junit.Test;16import org.junit.rules.Timeout;17import java.util.concurrent.TimeUnit;18public class TimeoutTest {19    public Timeout globalTimeout = new Timeout(20, TimeUnit.MILLISECONDS);20    public void testInfiniteLoop1() {21        while (true) {22        }23    }24    public void testInfiniteLoop2() {25        while (true) {26        }27    }28}29import org.junit.Rule;30import org.junit.Test;31import org.junit.rules.Timeout;32import java.util.concurrent.TimeUnit;33public class TimeoutTest {34    public Timeout globalTimeout = Timeout.millis(20);35    public void testInfiniteLoop1() {36        while (true) {37        }38    }39    public void testInfiniteLoop2() {40        while (true) {41        }42    }43}44import org.junit.Rule;45import org.junit.Test;46import org.junit.rules.Timeout;47import java.util.concurrent.TimeUnit;48public class TimeoutTest {49    public Timeout globalTimeout = Timeout.seconds(2);50    public void testInfiniteLoop1() {51        while (true) {52        }53    }54    public void testInfiniteLoop2() {55        while (true) {56        }

Timeout.Builder

Using AI Code Generation

1import org.junit.rules.Timeout;2import org.junit.Rule;3import org.junit.Test;4public class TimeoutTest {5	public void testInfiniteLoop1() {6		while (true)7			;8	}9	public void testInfiniteLoop2() {10		while (true)11			;12	}13}14	at java.lang.Object.wait(Native Method)15	at java.lang.Object.wait(Object.java:502)16	at java.lang.Thread.join(Thread.java:1252)17	at java.lang.Thread.join(Thread.java:1326)18	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:78)19	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:57)20	at org.junit.runners.ParentRunner$3.run(ParentRunner.java:290)21	at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71)22	at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288)23	at org.junit.runners.ParentRunner.access$000(ParentRunner.java:58)24	at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:268)25	at org.junit.runners.ParentRunner.run(ParentRunner.java:363)26	at org.junit.runner.JUnitCore.run(JUnitCore.java:137)27	at com.intellij.junit4.JUnit4IdeaTestRunner.startRunnerWithArgs(JUnit4IdeaTestRunner.java:68)28	at com.intellij.rt.execution.junit.IdeaTestRunner$Repeater.startRunnerWithArgs(IdeaTestRunner.java:47)29	at com.intellij.rt.execution.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:242)30	at com.intellij.rt.execution.junit.JUnitStarter.main(JUnitStarter.java:70)31	at java.lang.Object.wait(Native Method)32	at java.lang.Object.wait(Object.java:502)33	at java.lang.Thread.join(Thread.java:1252)34	at java.lang.Thread.join(Thread.java:1326)35	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:78)36	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:57)

Timeout.Builder

Using AI Code Generation

1import org.junit.rules.Timeout;2import org.junit.Rule;3import org.junit.Test;4public class TestClass {5  public void testInfiniteLoop1() {6    while (true) ;7  }8  public void testInfiniteLoop2() {9    while (true) ;10  }11}12import org.junit.Test;13import org.junit.rules.Timeout;14import org.junit.Rule;15import org.junit.Test;16public class TestClass {17  public void testInfiniteLoop1() {18    while (true) ;19  }20  public void testInfiniteLoop2() {21    while (true) ;22  }23}24import org.junit.Test;25import org.junit.rules.Timeout;26import org.junit.Rule;27import org.junit.Test;28public class TestClass {29  public void testInfiniteLoop1() {30    while (true) ;31  }32  public void testInfiniteLoop2() {33    while (true) ;34  }35}36import org.junit.Test;37import org.junit.rules.Timeout;38import org.junit.Rule;39import org.junit.Test;40public class TestClass {41  public void testInfiniteLoop1() {42    while (true) ;43  }44  public void testInfiniteLoop2() {45    while (true) ;46  }47}48import org.junit.Test;49import org.junit.rules.Timeout;50import org.junit.Rule;51import org.junit.Test;52public class TestClass {53  public void testInfiniteLoop1() {54    while (true) ;

Timeout.Builder

Using AI Code Generation

1import org.junit.rules.Timeout;2import org.junit.Rule;3import org.junit.Test;4import static org.junit.Assert.*;5public class TestTimeout {6    public void testInfiniteLoop1() {7        int i = 0;8        while (true) {9            i++;10        }11    }12    public void testInfiniteLoop2() {13        int i = 0;14        while (true) {15            i++;16        }17    }18}19    at java.lang.Object.wait(Native Method)20    at java.lang.Object.wait(Object.java:502)21    at java.lang.ref.ReferenceQueue.remove(ReferenceQueue.java:143)22    at java.lang.ref.ReferenceQueue.remove(ReferenceQueue.java:164)23    at java.lang.ref.Finalizer$FinalizerThread.run(Finalizer.java:209)

Timeout.Builder

Using AI Code Generation

1import org.junit.rules.Timeout;2import org.junit.Rule;3public class TimeoutTest {4    public Timeout globalTimeout = Timeout.seconds(20);5    public void testInfiniteLoop1() throws InterruptedException {6        Thread.sleep(1000);7    }8    public void testInfiniteLoop2() throws InterruptedException {9        Thread.sleep(1000);10    }11    public void testInfiniteLoop3() throws InterruptedException {12        Thread.sleep(1000);13    }14    public void testInfiniteLoop4() throws InterruptedException {15        Thread.sleep(1000);16    }17    public void testInfiniteLoop5() throws InterruptedException {18        Thread.sleep(1000);19    }20}21Output: TimeoutTest.java:16: error: test timed out after 20 seconds at org.junit.rules.Timeout$1.evaluate(Timeout.java:106) at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:325) at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:78) at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:57) at org.junit.runners.ParentRunner$3.run(ParentRunner.java:290) at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71) at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288) at org.junit.runners.ParentRunner.access$000(ParentRunner.java:58) at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:268) at org.junit.runners.ParentRunner.run(ParentRunner.java:363) at org.junit.runners.Suite.runChild(Suite.java:128) at org.junit.runners.Suite.runChild(Suite.java:27) at org.junit.runners.ParentRunner$3.run(ParentRunner.java:290) at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71) at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288) at org.junit.runners.ParentRunner.access$000(ParentRunner.java:58) at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:268) at org.junit.runners.ParentRunner.run(ParentRunner.java:363) at org.junit.runner.JUnitCore.run(JUnitCore.java:137) at com.intellij.junit4.JUnit4IdeaTestRunner.startRunnerWithArgs(JUnit4IdeaTestRunner.java:

JUnit Tutorial:

LambdaTest also has a detailed JUnit tutorial explaining its features, importance, advanced use cases, best practices, and more to help you get started with running your automation testing scripts.

JUnit Tutorial Chapters:

Here are the detailed JUnit testing chapters to help you get started:

Importance of Unit testing - Learn why Unit testing is essential during the development phase to identify bugs and errors.
Top Java Unit testing frameworks - Here are the upcoming JUnit automation testing frameworks that you can use in 2023 to boost your unit testing.
What is the JUnit framework
Why is JUnit testing important - Learn the importance and numerous benefits of using the JUnit testing framework.
Features of JUnit - Learn about the numerous features of JUnit and why developers prefer it.
JUnit 5 vs. JUnit 4: Differences - Here is a complete comparison between JUnit 5 and JUnit 4 testing frameworks.
Setting up the JUnit environment - Learn how to set up your JUnit testing environment.
Getting started with JUnit testing - After successfully setting up your JUnit environment, this chapter will help you get started with JUnit testing in no time.
Parallel testing with JUnit - Parallel Testing can be used to reduce test execution time and improve test efficiency. Learn how to perform parallel testing with JUnit.
Annotations in JUnit - When writing automation scripts with JUnit, we can use JUnit annotations to specify the type of methods in our test code. This helps us identify those methods when we run JUnit tests using Selenium WebDriver. Learn in detail what annotations are in JUnit.
Assertions in JUnit - Assertions are used to validate or test that the result of an action/functionality is the same as expected. Learn in detail what assertions are and how to use them while performing JUnit testing.
Parameterization in JUnit - Parameterized Test enables you to run the same automated test scripts with different variables. By collecting data on each method's test parameters, you can minimize time spent on writing tests. Learn how to use parameterization in JUnit.
Nested Tests In JUnit 5 - A nested class is a non-static class contained within another class in a hierarchical structure. It can share the state and setup of the outer class. Learn about nested annotations in JUnit 5 with examples.
Best practices for JUnit testing - Learn about the best practices, such as always testing key methods and classes, integrating JUnit tests with your build, and more to get the best possible results.
Advanced Use Cases for JUnit testing - Take a deep dive into the advanced use cases, such as how to run JUnit tests in Jupiter, how to use JUnit 5 Mockito for Unit testing, and more for JUnit testing.