Remove SchedulerAppliers and use Espresso idling resouces for handling RxJava Observable executions

Author: Ivan Carballo

app/build.gradle

@@ -19,7 +19,7 @@ android {
         applicationId 'uk.co.ribot.androidboilerplate'
         minSdkVersion 16
         targetSdkVersion 23
-        testInstrumentationRunner 'uk.co.ribot.androidboilerplate.util.UnlockDeviceTestRunner'
+        testInstrumentationRunner "${applicationId}.runner.RxAndroidJUnitRunner"
         versionCode 1000
         // Major -> Millions, Minor -> Thousands, Bugfix -> Hundreds. E.g 1.3.72 == 1,003,072
         versionName '0.1.0'

app/src/androidTest/java/uk/co/ribot/androidboilerplate/runner/RxAndroidJUnitRunner.java

@@ -0,0 +1,26 @@
+package uk.co.ribot.androidboilerplate.runner;
+
+import android.os.Bundle;
+import android.support.test.espresso.Espresso;
+
+import rx.plugins.RxJavaPlugins;
+import uk.co.ribot.androidboilerplate.util.RxIdlingExecutionHook;
+import uk.co.ribot.androidboilerplate.util.RxIdlingResource;
+
+/**
+ * Runner that registers a Espresso Indling resource that handles waiting for
+ * RxJava Observables to finish.
+ * WARNING - Using this runner will block the tests if the application uses long-lived hot
+ * Observables such us event buses, etc.
+ */
+public class RxAndroidJUnitRunner extends UnlockDeviceAndroidJUnitRunner {
+
+    @Override
+    public void onCreate(Bundle arguments) {
+        super.onCreate(arguments);
+        RxIdlingResource rxIdlingResource = new RxIdlingResource();
+        RxJavaPlugins.getInstance()
+                .registerObservableExecutionHook(new RxIdlingExecutionHook(rxIdlingResource));
+        Espresso.registerIdlingResources(rxIdlingResource);
+    }
+}

app/src/androidTest/java/uk/co/ribot/androidboilerplate/util/UnlockDeviceTestRunner.java renamed to app/src/androidTest/java/uk/co/ribot/androidboilerplate/runner/UnlockDeviceAndroidJUnitRunner.java

@@ -1,4 +1,4 @@
-package uk.co.ribot.androidboilerplate.util;
+package uk.co.ribot.androidboilerplate.runner;
 
 import android.app.Application;
 import android.app.KeyguardManager;
@@ -11,14 +11,18 @@
 import static android.os.PowerManager.FULL_WAKE_LOCK;
 import static android.os.PowerManager.ON_AFTER_RELEASE;
 
-public class UnlockDeviceTestRunner extends AndroidJUnitRunner {
+/**
+ * Extension of AndroidJUnitRunner that adds some functionality to unblock the device screen
+ * before starting the tests.
+ */
+public class UnlockDeviceAndroidJUnitRunner extends AndroidJUnitRunner {
 
     private PowerManager.WakeLock mWakeLock;
 
     @Override
     public void onStart() {
         Application application = (Application) getTargetContext().getApplicationContext();
-        String simpleName = UnlockDeviceTestRunner.class.getSimpleName();
+        String simpleName = UnlockDeviceAndroidJUnitRunner.class.getSimpleName();
         // Unlock the device so that the tests can input keystrokes.
         ((KeyguardManager) application.getSystemService(KEYGUARD_SERVICE))
                 .newKeyguardLock(simpleName)
@@ -36,4 +40,4 @@ public void onDestroy() {
         super.onDestroy();
         mWakeLock.release();
     }
-}
+}

app/src/androidTest/java/uk/co/ribot/androidboilerplate/util/RxIdlingExecutionHook.java

@@ -0,0 +1,37 @@
+package uk.co.ribot.androidboilerplate.util;
+
+import rx.Observable;
+import rx.Subscription;
+import rx.plugins.RxJavaObservableExecutionHook;
+
+/**
+ * RxJava Observable execution hook that handles updating the active subscription
+ * count for a given Espresso RxIdlingResource.
+ */
+public class RxIdlingExecutionHook extends RxJavaObservableExecutionHook {
+
+    private RxIdlingResource mRxIdlingResource;
+
+    public RxIdlingExecutionHook(RxIdlingResource rxIdlingResource) {
+        mRxIdlingResource = rxIdlingResource;
+    }
+
+    @Override
+    public <T> Observable.OnSubscribe<T> onSubscribeStart(
+            Observable<? extends T> observableInstance, Observable.OnSubscribe<T> onSubscribe) {
+        mRxIdlingResource.incrementActiveSubscriptionsCount();
+        return super.onSubscribeStart(observableInstance, onSubscribe);
+    }
+
+    @Override
+    public <T> Throwable onSubscribeError(Throwable e) {
+        mRxIdlingResource.decrementActiveSubscriptionsCount();
+        return super.onSubscribeError(e);
+    }
+
+    @Override
+    public <T> Subscription onSubscribeReturn(Subscription subscription) {
+        mRxIdlingResource.decrementActiveSubscriptionsCount();
+        return super.onSubscribeReturn(subscription);
+    }
+}

app/src/androidTest/java/uk/co/ribot/androidboilerplate/util/RxIdlingResource.java

@@ -0,0 +1,51 @@
+package uk.co.ribot.androidboilerplate.util;
+
+import android.support.test.espresso.IdlingResource;
+
+import java.util.concurrent.atomic.AtomicInteger;
+
+import timber.log.Timber;
+
+/**
+ * Espresso Idling resource that handles waiting for RxJava Observables executions.
+ * This class must be used with RxIdlingExecutionHook.
+ * Before registering this idling resource you must:
+ * 1. Create an instance of RxIdlingExecutionHook by passing an instance of this class.
+ * 2. Register RxIdlingExecutionHook with the RxJavaPlugins using registerObservableExecutionHook()
+ * 3. Register this idle resource with Espresso using Espresso.registerIdlingResources()
+ */
+public class RxIdlingResource implements IdlingResource {
+
+    private final AtomicInteger mActiveSubscriptionsCount = new AtomicInteger(0);
+    private ResourceCallback mResourceCallback;
+
+    @Override
+    public String getName() {
+        return getClass().getSimpleName();
+    }
+
+    @Override
+    public boolean isIdleNow() {
+        return mActiveSubscriptionsCount.get() == 0;
+    }
+
+    @Override
+    public void registerIdleTransitionCallback(ResourceCallback callback) {
+        mResourceCallback = callback;
+    }
+
+    public void incrementActiveSubscriptionsCount() {
+        int count = mActiveSubscriptionsCount.incrementAndGet();
+        Timber.i("Active subscriptions count increased to %d", count);
+    }
+
+    public void decrementActiveSubscriptionsCount() {
+        int count = mActiveSubscriptionsCount.decrementAndGet();
+        Timber.i("Active subscriptions count decreased to %d", count);
+        if (isIdleNow()) {
+            Timber.i("There is no active subscriptions, transitioning to Idle");
+            mResourceCallback.onTransitionToIdle();
+        }
+    }
+
+}

app/src/commonTest/java/uk/co/ribot/androidboilerplate/test/common/injection/component/TestComponent.java

@@ -5,10 +5,9 @@
 import dagger.Component;
 import uk.co.ribot.androidboilerplate.injection.component.ApplicationComponent;
 import uk.co.ribot.androidboilerplate.test.common.injection.module.ApplicationTestModule;
-import uk.co.ribot.androidboilerplate.test.common.injection.module.DefaultSchedulersTestModule;
 
 @Singleton
-@Component(modules = {ApplicationTestModule.class, DefaultSchedulersTestModule.class})
+@Component(modules = ApplicationTestModule.class)
 public interface TestComponent extends ApplicationComponent {
 
 }

app/src/commonTest/java/uk/co/ribot/androidboilerplate/test/common/injection/module/ApplicationTestModule.java

@@ -38,7 +38,7 @@ Application provideApplication() {
     @Singleton
     DataManager provideDataManager() {
         TestDataManager testDataManager = new TestDataManager(mApplication);
-        return mMockableDataManager ? mock(DataManager.class) : testDataManager;
+        return mMockableDataManager ? spy(testDataManager) : testDataManager;
     }
 
     @Provides

app/src/commonTest/java/uk/co/ribot/androidboilerplate/test/common/injection/module/DefaultSchedulersTestModule.java

@@ -11,12 +11,12 @@
 
 import rx.Observer;
 import rx.Subscription;
+import rx.schedulers.Schedulers;
 import timber.log.Timber;
 import uk.co.ribot.androidboilerplate.BoilerplateApplication;
 import uk.co.ribot.androidboilerplate.data.model.Ribot;
 import uk.co.ribot.androidboilerplate.util.AndroidComponentUtil;
 import uk.co.ribot.androidboilerplate.util.NetworkUtil;
-import uk.co.ribot.androidboilerplate.util.SchedulerAppliers;
 
 public class SyncService extends Service {
 
@@ -50,7 +50,7 @@ public int onStartCommand(Intent intent, int flags, final int startId) {
 
         if (mSubscription != null && !mSubscription.isUnsubscribed()) mSubscription.unsubscribe();
         mSubscription = mDataManager.syncRibots()
-                .compose(SchedulerAppliers.<Ribot>defaultSubscribeScheduler())
+                .subscribeOn(Schedulers.io())
                 .subscribe(new Observer<Ribot>() {
                     @Override
                     public void onCompleted() {

app/src/main/java/uk/co/ribot/androidboilerplate/data/SyncService.java

@@ -10,12 +10,10 @@
 import uk.co.ribot.androidboilerplate.data.DataManager;
 import uk.co.ribot.androidboilerplate.data.SyncService;
 import uk.co.ribot.androidboilerplate.injection.module.ApplicationModule;
-import uk.co.ribot.androidboilerplate.injection.module.DefaultSchedulersModule;
 import uk.co.ribot.androidboilerplate.ui.main.MainPresenter;
-import uk.co.ribot.androidboilerplate.util.SchedulerApplier;
 
 @Singleton
-@Component(modules = {ApplicationModule.class, DefaultSchedulersModule.class})
+@Component(modules = ApplicationModule.class)
 public interface ApplicationComponent {
 
     void inject(SyncService syncService);

app/src/main/java/uk/co/ribot/androidboilerplate/injection/component/ApplicationComponent.java

@@ -20,6 +20,7 @@ protected void onCreate(Bundle savedInstanceState) {
     public ActivityComponent getActivityComponent() {
         if (mActivityComponent == null) {
             mActivityComponent = DaggerActivityComponent.builder()
+                    .presentersModule(new PresentersModule(getApplication()))
                     .applicationComponent(BoilerplateApplication.get(this).getComponent())
                     .build();
         }

app/src/main/java/uk/co/ribot/androidboilerplate/injection/component/DefaultSchedulersComponent.java

@@ -48,8 +48,9 @@ public void showRibots(List<Ribot> ribots) {
     }
 
     @Override
-    public void showError(String errorMessage) {
-        DialogFactory.createGenericErrorDialog(this, errorMessage).show();
+    public void showError() {
+        DialogFactory.createGenericErrorDialog(this, getString(R.string.error_loading_ribots))
+                .show();
     }
 
     @Override

app/src/main/java/uk/co/ribot/androidboilerplate/injection/module/DefaultSchedulersModule.java

@@ -11,6 +11,6 @@ public interface MainMvpView extends MvpView {
 
     void showRibotsEmpty();
 
-    void showError(String errorMessage);
+    void showError();
 
 }

app/src/main/java/uk/co/ribot/androidboilerplate/ui/base/BaseActivity.java

@@ -49,8 +49,7 @@ public void onCompleted() {
                     @Override
                     public void onError(Throwable e) {
                         Timber.e(e, "There was an error loading the ribots.");
-                        //todo String errorString = getContext().getString(R.string.error_loading_ribots);
-                        getMvpView().showError("todo change");
+                        getMvpView().showError();
                     }
 
                     @Override