public final class CountingIdlingResource extends java.lang.Object implements IdlingResource
IdlingResource
that determines idleness by maintaining an internal
counter. When the counter is 0 - it is considered to be idle, when it is non-zero it is not
idle. This is very similar to the way a Semaphore
behaves.
The counter may be incremented or decremented from any thread. If it reaches an illogical state (like counter less than zero) it will throw an IllegalStateException.
This class can then be used to wrap up operations that while in progress should block tests from accessing the UI.
public interface FooServer {
public Foo newFoo();
public void updateFoo(Foo foo);
}
public DecoratedFooServer implements FooServer {
private final FooServer realFooServer;
private final CountingIdlingResource fooServerIdlingResource;
public DecoratedFooServer(FooServer realFooServer,
CountingIdlingResource fooServerIdlingResource) {
this.realFooServer = checkNotNull(realFooServer);
this.fooServerIdlingResource = checkNotNull(fooServerIdlingResource);
}
public Foo newFoo() {
fooServerIdlingResource.increment();
try {
return realFooServer.newFoo();
} finally {
fooServerIdlingResource.decrement();
}
}
public void updateFoo(Foo foo) {
fooServerIdlingResource.increment();
try {
realFooServer.updateFoo(foo);
} finally {
fooServerIdlingResource.decrement();
}
}
}
Then in your test setup:
public void setUp() throws Exception {
super.setUp();
FooServer realServer = FooApplication.getFooServer();
CountingIdlingResource countingResource = new CountingIdlingResource("FooServerCalls");
FooApplication.setFooServer(new DecoratedFooServer(realServer, countingResource));
Espresso.registerIdlingResource(countingResource);
}
IdlingResource.ResourceCallback
Constructor and Description |
---|
CountingIdlingResource(java.lang.String resourceName)
Creates a CountingIdlingResource without debug tracing.
|
CountingIdlingResource(java.lang.String resourceName,
boolean debugCounting)
Creates a CountingIdlingResource.
|
Modifier and Type | Method and Description |
---|---|
void |
decrement()
Decrements the count of in-flight transactions to the resource being monitored.
|
void |
dumpStateToLogs()
Prints the current state of this resource to the logcat at info level.
|
java.lang.String |
getName()
Returns the name of the resources (used for logging and idempotency of registration).
|
void |
increment()
Increments the count of in-flight transactions to the resource being monitored.
|
boolean |
isIdleNow()
Returns
true if resource is currently idle. |
void |
registerIdleTransitionCallback(IdlingResource.ResourceCallback resourceCallback)
Registers the given
IdlingResource.ResourceCallback with the resource. |
public CountingIdlingResource(java.lang.String resourceName)
resourceName
- the resource name this resource should report to Espresso.public CountingIdlingResource(java.lang.String resourceName, boolean debugCounting)
resourceName
- the resource name this resource should report to Espresso.debugCounting
- if true increment & decrement calls will print trace information to logs.public java.lang.String getName()
IdlingResource
getName
in interface IdlingResource
public boolean isIdleNow()
IdlingResource
true
if resource is currently idle. Espresso will always call this
method from the main thread, therefore it should be non-blocking and return immediately.isIdleNow
in interface IdlingResource
public void registerIdleTransitionCallback(IdlingResource.ResourceCallback resourceCallback)
IdlingResource
IdlingResource.ResourceCallback
with the resource. Espresso will call this method:
IdlingResource.ResourceCallback
so it can be notified asynchronously
that your resource is idle
registerIdleTransitionCallback
in interface IdlingResource
public void increment()
public void decrement()
java.lang.IllegalStateException
- if the counter is below 0.public void dumpStateToLogs()