FredLoh/RxIdler

An IdlingResource for Espresso which wraps an RxJava Scheduler.

RxIdler

An IdlingResource for Espresso which wraps an RxJava Scheduler.

Usage

Set the wrapping functions as the delegate for handling scheduler initialization to RxJava:

• RxJava 3.x:

  RxJavaPlugins.setInitComputationSchedulerHandler(
      Rx3Idler.create("RxJava 3.x Computation Scheduler"));
  RxJavaPlugins.setInitIoSchedulerHandler(
      Rx3Idler.create("RxJava 3.x IO Scheduler"));
  // etc...

• RxJava 2.x:

  RxJavaPlugins.setInitComputationSchedulerHandler(
      Rx2Idler.create("RxJava 2.x Computation Scheduler"));
  RxJavaPlugins.setInitIoSchedulerHandler(
      Rx2Idler.create("RxJava 2.x IO Scheduler"));
  // etc...

• RxJava 1.x:

  RxJavaPlugins.getInstance().registerSchedulersHook(RxIdler.hooks());

When that Scheduler is first accessed via Schedulers, the RxIdler function will wrap it with an Espresso IdlingResource and side-effect by registering it to the Espresso class.

This code is most frequently put in a custom test runner's onStart() method:

public final class MyTestRunner extends AndroidJUnitRunner {
  @Override public void onStart() {
    RxJavaPlugins.setInitComputationSchedulerHandler(
        Rx3Idler.create("RxJava 3.x Computation Scheduler"));
    // etc...
    
    super.onStart();
  }
}

If you have custom Scheduler implementations you can wrap them directly and then register them with Espresso:

• RxJava 3.x:

  IdlingResourceScheduler wrapped = Rx3Idler.wrap(myScheduler, "My Scheduler");
  IdlingRegistry.getInstance().register(wrapped);
  // Use 'wrapped' now instead of 'myScheduler'...

• RxJava 2.x:

  IdlingResourceScheduler wrapped = Rx2Idler.wrap(myScheduler, "My Scheduler");
  IdlingRegistry.getInstance().register(wrapped);
  // Use 'wrapped' now instead of 'myScheduler'...

• RxJava 1.x:

  IdlingResourceScheduler wrapped = RxIdler.wrap(myScheduler, "My Scheduler");
  IdlingRegistry.getInstance().register(wrapped);
  // Use 'wrapped' now instead of 'myScheduler'...

Ensure that you provide unique name for your wrapped schedulers as Espresso will ignore multiple idling resources registered with the same name.

Download

• RxJava 3.x:

  dependencies {
    androidTestImplementation 'com.squareup.rx.idler:rx3-idler:0.11.0'
  }

• RxJava 2.x:

  dependencies {
    androidTestImplementation 'com.squareup.rx.idler:rx2-idler:0.11.0'
  }

• RxJava 1.x:

  dependencies {
    androidTestImplementation 'com.squareup.rx.idler:rx1-idler:0.11.0'
  }

Snapshots of the development version are available in Sonatype's snapshots repository.

ProGuard

If you use ProGuard on Espresso test builds, you may need to add the following rules into your ProGuard configuration.

RxJava 3.x:

-keep class io.reactivex.rxjava3.plugins.RxJavaPlugins { *; }
-keep class io.reactivex.rxjava3.disposables.CompositeDisposable { *; }

RxJava 2.x:

-keep class io.reactivex.plugins.RxJavaPlugins { *; }
-keep class io.reactivex.disposables.CompositeDisposable { *; }

RxJava 1.x:

-keep class rx.plugins.RxJavaPlugins { *; }
-keep class rx.subscriptions.CompositeSubscription { *; }

License

Copyright 2017 Square, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.