[FLoC] Change FLoC instrumental tests to be unit tests. (#1058)

* [FLoC] Change FLoC instrumental tests to be unit tests.

Author: diwu-arete

firebase-segmentation/firebase-segmentation.gradle

@@ -54,13 +54,7 @@ dependencies {
     testImplementation 'androidx.test:core:1.2.0'
     testImplementation 'junit:junit:4.12'
     testImplementation "org.robolectric:robolectric:$robolectricVersion"
-
-    androidTestImplementation "androidx.annotation:annotation:1.1.0"
-    androidTestImplementation 'androidx.test.ext:junit:1.1.1'
-    androidTestImplementation 'androidx.test:rules:1.2.0'
-    androidTestImplementation 'androidx.test:runner:1.2.0'
-    androidTestImplementation "com.google.truth:truth:$googleTruthVersion"
-    androidTestImplementation 'junit:junit:4.12'
-    androidTestImplementation 'org.mockito:mockito-core:2.25.0'
-    androidTestImplementation 'org.mockito:mockito-android:2.25.0'
+    testImplementation "com.google.truth:truth:$googleTruthVersion"
+    testImplementation 'org.mockito:mockito-core:2.25.0'
+    testImplementation 'org.mockito:mockito-inline:2.25.0'
 }

firebase-segmentation/src/androidTest/AndroidManifest.xml

@@ -17,14 +17,13 @@
 import static com.google.common.truth.Truth.assertThat;
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.fail;
+import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyLong;
 import static org.mockito.ArgumentMatchers.anyString;
-import static org.mockito.Mockito.any;
 import static org.mockito.Mockito.when;
 
 import androidx.annotation.NonNull;
 import androidx.test.core.app.ApplicationProvider;
-import androidx.test.ext.junit.runners.AndroidJUnit4;
 import com.google.android.gms.tasks.Tasks;
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.FirebaseOptions;
@@ -34,6 +33,10 @@
 import com.google.firebase.segmentation.local.CustomInstallationIdCacheEntryValue;
 import com.google.firebase.segmentation.remote.SegmentationServiceClient;
 import java.util.concurrent.ExecutionException;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.LinkedBlockingQueue;
+import java.util.concurrent.ThreadPoolExecutor;
+import java.util.concurrent.TimeUnit;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.FixMethodOrder;
@@ -42,26 +45,24 @@
 import org.junit.runners.MethodSorters;
 import org.mockito.Mock;
 import org.mockito.MockitoAnnotations;
+import org.robolectric.RobolectricTestRunner;
 
-/**
- * Instrumented test, which will execute on an Android device.
- *
- * @see <a href="http://d.android.com/tools/testing">Testing documentation</a>
- */
-@RunWith(AndroidJUnit4.class)
+@RunWith(RobolectricTestRunner.class)
 @FixMethodOrder(MethodSorters.NAME_ASCENDING)
-public class FirebaseSegmentationInstrumentedTest {
-
+public class FirebaseSegmentationTest {
   private static final String CUSTOM_INSTALLATION_ID = "123";
   private static final String FIREBASE_INSTANCE_ID = "cAAAAAAAAAA";
 
   private FirebaseApp firebaseApp;
   @Mock private FirebaseInstanceId firebaseInstanceId;
   @Mock private SegmentationServiceClient backendClientReturnsOk;
   @Mock private SegmentationServiceClient backendClientReturnsError;
+
   private CustomInstallationIdCache actualCache;
   @Mock private CustomInstallationIdCache cacheReturnsError;
 
+  private ExecutorService taskExecutor;
+
   @Before
   public void setUp() {
     MockitoAnnotations.initMocks(this);
@@ -105,6 +106,8 @@ public String getToken() {
                 }));
     when(cacheReturnsError.insertOrUpdateCacheEntry(any())).thenReturn(false);
     when(cacheReturnsError.readCacheEntryValue()).thenReturn(null);
+
+    taskExecutor = new ThreadPoolExecutor(0, 1, 30L, TimeUnit.SECONDS, new LinkedBlockingQueue<>());
   }
 
   @After
@@ -119,7 +122,11 @@ public void testUpdateCustomInstallationId_CacheOk_BackendOk() throws Exception
             firebaseApp, firebaseInstanceId, actualCache, backendClientReturnsOk);
 
     // No exception, means success.
-    assertNull(Tasks.await(firebaseSegmentation.setCustomInstallationId(CUSTOM_INSTALLATION_ID)));
+    TestOnCompleteListener<Void> onCompleteListener = new TestOnCompleteListener<>();
+    firebaseSegmentation
+        .setCustomInstallationId(CUSTOM_INSTALLATION_ID)
+        .addOnCompleteListener(taskExecutor, onCompleteListener);
+    assertNull(onCompleteListener.await());
     CustomInstallationIdCacheEntryValue entryValue = actualCache.readCacheEntryValue();
     assertThat(entryValue.getCustomInstallationId()).isEqualTo(CUSTOM_INSTALLATION_ID);
     assertThat(entryValue.getFirebaseInstanceId()).isEqualTo(FIREBASE_INSTANCE_ID);
@@ -135,7 +142,11 @@ public void testUpdateCustomInstallationId_CacheOk_BackendError_Retryable()
 
     // Expect exception
     try {
-      Tasks.await(firebaseSegmentation.setCustomInstallationId(CUSTOM_INSTALLATION_ID));
+      TestOnCompleteListener<Void> onCompleteListener = new TestOnCompleteListener<>();
+      firebaseSegmentation
+          .setCustomInstallationId(CUSTOM_INSTALLATION_ID)
+          .addOnCompleteListener(taskExecutor, onCompleteListener);
+      onCompleteListener.await();
       fail();
     } catch (ExecutionException expected) {
       Throwable cause = expected.getCause();
@@ -163,7 +174,11 @@ public void testUpdateCustomInstallationId_CacheOk_BackendError_NotRetryable()
 
     // Expect exception
     try {
-      Tasks.await(firebaseSegmentation.setCustomInstallationId(CUSTOM_INSTALLATION_ID));
+      TestOnCompleteListener<Void> onCompleteListener = new TestOnCompleteListener<>();
+      firebaseSegmentation
+          .setCustomInstallationId(CUSTOM_INSTALLATION_ID)
+          .addOnCompleteListener(taskExecutor, onCompleteListener);
+      onCompleteListener.await();
       fail();
     } catch (ExecutionException expected) {
       Throwable cause = expected.getCause();
@@ -184,7 +199,11 @@ public void testUpdateCustomInstallationId_CacheError_BackendOk() throws Interru
 
     // Expect exception
     try {
-      Tasks.await(firebaseSegmentation.setCustomInstallationId(CUSTOM_INSTALLATION_ID));
+      TestOnCompleteListener<Void> onCompleteListener = new TestOnCompleteListener<>();
+      firebaseSegmentation
+          .setCustomInstallationId(CUSTOM_INSTALLATION_ID)
+          .addOnCompleteListener(taskExecutor, onCompleteListener);
+      onCompleteListener.await();
       fail();
     } catch (ExecutionException expected) {
       Throwable cause = expected.getCause();
@@ -206,7 +225,11 @@ public void testClearCustomInstallationId_CacheOk_BackendOk() throws Exception {
             firebaseApp, firebaseInstanceId, actualCache, backendClientReturnsOk);
 
     // No exception, means success.
-    assertNull(Tasks.await(firebaseSegmentation.setCustomInstallationId(null)));
+    TestOnCompleteListener<Void> onCompleteListener = new TestOnCompleteListener<>();
+    firebaseSegmentation
+        .setCustomInstallationId(null)
+        .addOnCompleteListener(taskExecutor, onCompleteListener);
+    assertNull(onCompleteListener.await());
     CustomInstallationIdCacheEntryValue entryValue = actualCache.readCacheEntryValue();
     assertNull(entryValue);
   }
@@ -224,7 +247,11 @@ public void testClearCustomInstallationId_CacheOk_BackendError() throws Exceptio
 
     // Expect exception
     try {
-      Tasks.await(firebaseSegmentation.setCustomInstallationId(null));
+      TestOnCompleteListener<Void> onCompleteListener = new TestOnCompleteListener<>();
+      firebaseSegmentation
+          .setCustomInstallationId(null)
+          .addOnCompleteListener(taskExecutor, onCompleteListener);
+      onCompleteListener.await();
       fail();
     } catch (ExecutionException expected) {
       Throwable cause = expected.getCause();
@@ -248,7 +275,11 @@ public void testClearCustomInstallationId_CacheError_BackendOk() throws Interrup
 
     // Expect exception
     try {
-      Tasks.await(firebaseSegmentation.setCustomInstallationId(CUSTOM_INSTALLATION_ID));
+      TestOnCompleteListener<Void> onCompleteListener = new TestOnCompleteListener<>();
+      firebaseSegmentation
+          .setCustomInstallationId(null)
+          .addOnCompleteListener(taskExecutor, onCompleteListener);
+      onCompleteListener.await();
       fail();
     } catch (ExecutionException expected) {
       Throwable cause = expected.getCause();

firebase-segmentation/src/androidTest/java/com/google/firebase/segmentation/FirebaseSegmentationInstrumentedTest.java renamed to firebase-segmentation/src/test/java/com/google/firebase/segmentation/FirebaseSegmentationTest.java

@@ -0,0 +1,70 @@
+// Copyright 2019 Google LLC
+//
+// 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.
+
+package com.google.firebase.segmentation;
+
+import androidx.annotation.NonNull;
+import com.google.android.gms.tasks.OnCompleteListener;
+import com.google.android.gms.tasks.Task;
+import java.io.IOException;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+
+/**
+ * Helper listener that works around a limitation of the Tasks API where await() cannot be called on
+ * the main thread. This listener works around it by running itself on a different thread, thus
+ * allowing the main thread to be woken up when the Tasks complete.
+ */
+public class TestOnCompleteListener<TResult> implements OnCompleteListener<TResult> {
+  private static final long TIMEOUT_MS = 5000;
+  private final CountDownLatch latch = new CountDownLatch(1);
+  private Task<TResult> task;
+  private volatile TResult result;
+  private volatile Exception exception;
+  private volatile boolean successful;
+
+  @Override
+  public void onComplete(@NonNull Task<TResult> task) {
+    this.task = task;
+    successful = task.isSuccessful();
+    if (successful) {
+      result = task.getResult();
+    } else {
+      exception = task.getException();
+    }
+    latch.countDown();
+  }
+
+  /** Blocks until the {@link #onComplete} is called. */
+  public TResult await() throws InterruptedException, ExecutionException {
+    if (!latch.await(TIMEOUT_MS, TimeUnit.MILLISECONDS)) {
+      throw new InterruptedException("timed out waiting for result");
+    }
+    if (successful) {
+      return result;
+    } else {
+      if (exception instanceof InterruptedException) {
+        throw (InterruptedException) exception;
+      }
+      if (exception instanceof SetCustomInstallationIdException) {
+        throw new ExecutionException(exception);
+      }
+      if (exception instanceof IOException) {
+        throw new ExecutionException(exception);
+      }
+      throw new IllegalStateException("got an unexpected exception type", exception);
+    }
+  }
+}

firebase-segmentation/src/test/java/com/google/firebase/segmentation/TestOnCompleteListener.java

@@ -19,16 +19,16 @@
 import static org.junit.Assert.assertTrue;
 
 import androidx.test.core.app.ApplicationProvider;
-import androidx.test.ext.junit.runners.AndroidJUnit4;
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.FirebaseOptions;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
+import org.robolectric.RobolectricTestRunner;
 
 /** Instrumented tests for {@link CustomInstallationIdCache} */
-@RunWith(AndroidJUnit4.class)
+@RunWith(RobolectricTestRunner.class)
 public class CustomInstallationIdCacheTest {
 
   private FirebaseApp firebaseApp0;