public
class
DisableOnAndroidDebug
extends Object
implements
TestRule
java.lang.Object | |
↳ | android.support.test.rule.DisableOnAndroidDebug |
The DisableOnAndroidDebug
Rule allows you to label certain rules to be
disabled when debugging.
The most illustrative use case is for tests that make use of the
Timeout
rule, 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 as
Timeout
that
may be disabled during debugging may be wrapped in a DisableOnDebug
.
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 DisableOnAndroidDebug(new Timeout(20)); @Test public void myTest() { int i = 0; assertEquals(0, i); // suppose you had a break point here to inspect i } }
Public constructors | |
---|---|
DisableOnAndroidDebug(TestRule rule)
Wrap another |
Public methods | |
---|---|
final
Statement
|
apply(Statement base, Description description)
|
boolean
|
isDebugging()
Returns |
Inherited methods | |
---|---|
![]()
java.lang.Object
| |
![]()
org.junit.rules.TestRule
|
DisableOnAndroidDebug (TestRule rule)
Wrap another TestRule
and conditionally disable it when a debugger is attached.
Parameters | |
---|---|
rule |
TestRule :
to disable during debugging
|
Statement apply (Statement base, Description description)
Parameters | |
---|---|
base |
Statement
|
description |
Description
|
Returns | |
---|---|
Statement |
boolean isDebugging ()
Returns true
if the VM has a debugger connected. This method may be used by test
classes to take additional action to disable code paths that interfere with debugging if
required.
Returns | |
---|---|
boolean |
true if a debugger is connected, false otherwise
|