Package org.junit.rules
Class DisableOnDebug
- java.lang.Object
- org.junit.rules.DisableOnDebug
- All Implemented Interfaces:
TestRule
public class DisableOnDebug extends Object implements TestRule
TheDisableOnDebugRule allows you to label certain rules to be disabled when debugging.The most illustrative use case is for tests that make use of the
Timeoutrule, when ran in debug mode the test may terminate on timeout abruptly during debugging. Developers may disable the timeout, or increase the timeout by making a code change on tests that need debugging and remember revert the change afterwards or rules such asTimeoutthat may be disabled during debugging may be wrapped in aDisableOnDebug.The important benefit of this feature is that you can disable such rules without any making any modifications to your test class to remove them during debugging.
This does nothing to tackle timeouts or time sensitive code under test when debugging and may make this less useful in such circumstances.
Example usage:
public static class DisableTimeoutOnDebugSampleTest { @Rule public TestRule timeout = new DisableOnDebug(new Timeout(20)); @Test public void myTest() { int i = 0; assertEquals(0, i); // suppose you had a break point here to inspect i } }- Since:
- 4.12
Constructor Summary
Constructors Constructor Description DisableOnDebug(TestRule rule)Create aDisableOnDebuginstance with the timeout specified in milliseconds.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Statementapply(Statement base, Description description)Modifies the method-runningStatementto implement this test-running rule.booleanisDebugging()Returnstrueif the JVM is in debug mode.
Constructor Detail
DisableOnDebug
public DisableOnDebug(TestRule rule)
Create aDisableOnDebuginstance with the timeout specified in milliseconds.- Parameters:
rule- to disable during debugging
Method Detail
apply
public Statement apply(Statement base, Description description)
Description copied from interface:TestRuleModifies the method-runningStatementto implement this test-running rule.- Specified by:
applyin interfaceTestRule- Parameters:
base- TheStatementto be modifieddescription- ADescriptionof the test implemented inbase- Returns:
- a new statement, which may be the same as
base, a wrapper aroundbase, or a completely new Statement. - See Also:
TestRule.apply(Statement, Description)
isDebugging
public boolean isDebugging()
Returnstrueif the JVM is in debug mode. This method may be used by test classes to take additional action to disable code paths that interfere with debugging if required.- Returns:
trueif the current JVM is in debug mode,falseotherwise