Rename utility classes and refactor test runner

Author: allisonbm92

smoke-tests/build.gradle

@@ -60,8 +60,6 @@ dependencies {
 
   implementation "com.google.firebase:firebase-common:16.0.7"
 
-  androidTestImplementation "androidx.test.espresso:espresso-core:3.1.0"
-  androidTestImplementation "androidx.test.espresso:espresso-idling-resource:3.1.0"
   androidTestImplementation "androidx.test:runner:1.1.0"
 
   // Firestore

smoke-tests/src/androidTest/java/com/google/firebase/testing/common/SmokeTestBase.java

@@ -0,0 +1,73 @@
+// Copyright 2018 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.testing.common;
+
+import android.app.Activity;
+import android.util.Log;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+
+/**
+ * A runner for smoke tests.
+ *
+ * <p>This class will eventually become a JUnit runner, but it is simply a utility class for now.
+ *
+ * <p>All smoke tests should manually use this class until JUnit integration is complete. Test
+ * methods must be annotated with {@link SmokeTest} and must be in the test's primary activity.
+ *
+ * <p>This design enables test code to be built, obfuscated, and run like any other application's
+ * code. Test methods may be fully defined in one source tree, instead of splitting them across the
+ * two APKs used during testing.
+ */
+public class SmokeTestRunner {
+
+  private static final String TAG = "SmokeTestRunner";
+
+  /**
+   * Runs all smoke tests in the provided activity.
+   *
+   * <p>This method reflectively obtains all methods defined in the activity with the {@link
+   * SmokeTest} annotation. These are executed sequentially. Any exception thrown by the test
+   * methods is rethrown here without wrapping.
+   */
+  public static void runSmokeTests(Activity instance) throws Exception {
+    Method[] methods = instance.getClass().getMethods();
+    Log.d(TAG, "Searching for SmokeTest methods.");
+    for (Method method : methods) {
+      if (method.getAnnotation(SmokeTest.class) == null) {
+        continue;
+      }
+
+      Log.d(TAG, "Preparing to run method, " + method.getName() + ".");
+      try {
+        method.invoke(instance);
+        Log.d(TAG, "Test method complete.");
+      } catch (IllegalAccessException ex) {
+        throw new IllegalStateException("Test method is not public", ex);
+      } catch (InvocationTargetException ex) {
+        Throwable t = ex.getCause();
+        if (t instanceof Exception) {
+          throw (Exception) t;
+        } else if (t instanceof Error) {
+          throw (Error) t;
+        }
+
+        throw new IllegalStateException("Test threw unexpected Throwable", t);
+      }
+    }
+
+    Log.d(TAG, "Finished test runs.");
+  }
+}

smoke-tests/src/androidTest/java/com/google/firebase/testing/common/SmokeTestRunner.java

@@ -17,13 +17,13 @@
 import android.util.Log;
 import androidx.test.rule.ActivityTestRule;
 import androidx.test.runner.AndroidJUnit4;
-import com.google.firebase.testing.common.SmokeTestBase;
+import com.google.firebase.testing.common.SmokeTestRunner;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 
 @RunWith(AndroidJUnit4.class)
-public final class FirestoreTest extends SmokeTestBase {
+public final class FirestoreTest {
 
   private static final String TAG = "FirestoreTest";
 
@@ -36,7 +36,7 @@ public void runSmokeTests() throws Exception {
     Log.d(TAG, "Initializing activity.");
     FirestoreActivity instance = atr.getActivity();
 
-    // Delegate to base class.
-    runSmokeTests(instance);
+    // Delegate to test runner class.
+    SmokeTestRunner.runSmokeTests(instance);
   }
 }

smoke-tests/src/androidTest/java/com/google/firebase/testing/common/TestApkUtil.java

@@ -27,7 +27,7 @@
 import com.google.firebase.firestore.FirebaseFirestoreException;
 import com.google.firebase.firestore.ListenerRegistration;
 import com.google.firebase.testing.common.SmokeTest;
-import com.google.firebase.testing.common.TestUtil;
+import com.google.firebase.testing.common.Tasks2;
 import java.util.HashMap;
 
 /** An empty activity with Firestore smoke tests. */
@@ -40,7 +40,7 @@ public void listenForUpdate() throws Exception {
 
     auth.signOut();
     Task<?> signInTask = auth.signInWithEmailAndPassword("[email protected]", "password");
-    TestUtil.waitForSuccess(signInTask);
+    Tasks2.waitForSuccess(signInTask);
 
     DocumentReference doc = firestore.collection("restaurants").document("Baadal");
     SnapshotListener listener = new SnapshotListener();
@@ -52,8 +52,8 @@ public void listenForUpdate() throws Exception {
 
       Task<?> setTask = doc.set(new HashMap<>(data));
       Task<DocumentSnapshot> snapshotTask = listener.toTask();
-      TestUtil.waitForSuccess(setTask);
-      TestUtil.waitForSuccess(snapshotTask);
+      Tasks2.waitForSuccess(setTask);
+      Tasks2.waitForSuccess(snapshotTask);
 
       DocumentSnapshot result = snapshotTask.getResult();
       assertThat(result.getData()).isEqualTo(data);

smoke-tests/src/androidTestFirestore/java/com/google/firebase/testing/firestore/FirestoreTest.java

@@ -15,30 +15,28 @@
 package com.google.firebase.testing.common;
 
 import com.google.android.gms.tasks.Task;
-import java.lang.reflect.InvocationTargetException;
-import java.lang.reflect.Method;
+import com.google.android.gms.tasks.Tasks;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
 
-/** Test utilities invoked from the application APK. */
-public final class TestUtil {
+/** Test utilities for asynchronous tasks. */
+public final class Tasks2 {
 
-  private static Method waitForSuccessImpl;
+  private static final long WAIT_DURATION = 30;
+  private static final TimeUnit WAIT_UNIT = TimeUnit.SECONDS;
 
-  private TestUtil() {}
+  private Tasks2() {}
 
-  @SuppressWarnings("unchecked")
+  /**
+   * Waits for the task to complete successfully.
+   *
+   * <p>This method will block the current thread and return the result of the task. It will rethrow
+   * any expection thrown by the task without wrapping.
+   */
   public static <T> T waitForSuccess(Task<T> task) throws Exception {
-    if (waitForSuccessImpl == null) {
-      try {
-        Class<?> impl = Class.forName("com.google.firebase.testing.common.TestApkUtil");
-        waitForSuccessImpl = impl.getMethod("waitForSuccess", Task.class);
-      } catch (Exception ex) {
-        throw new IllegalStateException("Error initializing test framework", ex);
-      }
-    }
-
     try {
-      return (T) waitForSuccessImpl.invoke(null, task);
-    } catch (InvocationTargetException ex) {
+      return Tasks.await(task, WAIT_DURATION, WAIT_UNIT);
+    } catch (ExecutionException ex) {
       Throwable t = ex.getCause();
       if (t instanceof Exception) {
         throw (Exception) t;
@@ -47,8 +45,6 @@ public static <T> T waitForSuccess(Task<T> task) throws Exception {
       }
 
       throw new IllegalStateException("Task threw unexpected Throwable", t);
-    } catch (Exception ex) {
-      throw new IllegalStateException("Error invoking test APK", ex);
     }
   }
 }