Support testing against more environments. (#4543)

Author: ehsannas

.github/workflows/ci_tests.yml

@@ -122,7 +122,7 @@ jobs:
           FTL_RESULTS_DIR: ${{ github.event_name == 'pull_request' && format('pr-logs/pull/{0}/{1}/{2}/{3}_{4}/artifacts/', github.repository, github.event.pull_request.number, github.job, github.run_id, github.run_attempt) || format('logs/{0}/{1}_{2}/artifacts/', github.workflow, github.run_id, github.run_attempt)}}
           FIREBASE_APP_CHECK_DEBUG_SECRET: ${{ secrets.FIREBASE_APP_CHECK_DEBUG_SECRET }}
         run: |
-          ./gradlew ${{matrix.module}}:deviceCheck withErrorProne -PuseProdBackendForTests=true
+          ./gradlew ${{matrix.module}}:deviceCheck withErrorProne -PtargetBackend="prod"
 
   publish-test-results:
     name: "Publish Tests Results"

firebase-firestore/firebase-firestore.gradle

@@ -89,18 +89,21 @@ android {
         targetCompatibility JavaVersion.VERSION_1_8
     }
     testOptions.unitTests.includeAndroidResources = true
-    ext.useProdBackendForTests = false
+
+    // Acceptable values are: 'emulator', 'qa', 'nightly', and 'prod'.
+    ext.targetBackend = 'emulator'
 }
 
 tasks.withType(Test) {
     maxParallelForks = Runtime.runtime.availableProcessors().intdiv(2) ?: 1
 }
 
 android.libraryVariants.all { variant ->
-    if (findProperty("useProdBackendForTests")) {
-        variant.buildConfigField("boolean", "USE_EMULATOR_FOR_TESTS", "false")
+    if (findProperty('targetBackend')) {
+        variant.buildConfigField("String", "TARGET_BACKEND", property("targetBackend"))
     } else {
-        variant.buildConfigField("boolean", "USE_EMULATOR_FOR_TESTS", "true")
+        // By default set the target backend to 'emulator'
+        variant.buildConfigField("String", "TARGET_BACKEND", "\"emulator\"")
     }
 
     def localProps = new Properties()

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/CountTest.java

@@ -15,6 +15,7 @@
 package com.google.firebase.firestore;
 
 import static com.google.common.truth.Truth.assertThat;
+import static com.google.firebase.firestore.testutil.IntegrationTestUtil.isRunningAgainstEmulator;
 import static com.google.firebase.firestore.testutil.IntegrationTestUtil.testCollection;
 import static com.google.firebase.firestore.testutil.IntegrationTestUtil.testCollectionWithDocs;
 import static com.google.firebase.firestore.testutil.IntegrationTestUtil.testFirestore;
@@ -264,7 +265,7 @@ public void testFailWithGoodMessageIfMissingIndex() {
     assumeFalse(
         "Skip this test when running against the Firestore emulator because the Firestore emulator "
             + "does not use indexes and never fails with a 'missing index' error",
-        BuildConfig.USE_EMULATOR_FOR_TESTS);
+        isRunningAgainstEmulator());
 
     CollectionReference collection = testCollectionWithDocs(Collections.emptyMap());
     Query compositeIndexQuery = collection.whereEqualTo("field1", 42).whereLessThan("field2", 99);

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/testutil/IntegrationTestUtil.java

@@ -82,10 +82,18 @@ public void changeUserTo(User user) {
 /** A set of helper methods for tests */
 public class IntegrationTestUtil {
 
-  // Whether the integration tests should run against a local Firestore emulator instead of the
-  // Production environment. Note that the Android Emulator treats "10.0.2.2" as its host machine.
-  // TODO(mrschmidt): Support multiple environments (Emulator, QA, Nightly, Production)
-  private static final boolean CONNECT_TO_EMULATOR = BuildConfig.USE_EMULATOR_FOR_TESTS;
+  public enum TargetBackend {
+    EMULATOR,
+    QA,
+    NIGHTLY,
+    PROD
+  }
+
+  // Set this to the desired enum value to change the target backend when running tests locally.
+  // Note: DO NOT change this variable except for local testing.
+  private static final TargetBackend backendForLocalTesting = null;
+
+  private static final TargetBackend backend = getTargetBackend();
   private static final String EMULATOR_HOST = "10.0.2.2";
   private static final int EMULATOR_PORT = 8080;
 
@@ -120,8 +128,26 @@ public static FirestoreProvider provider() {
     return provider;
   }
 
+  public static TargetBackend getTargetBackend() {
+    if (backendForLocalTesting != null) {
+      return backendForLocalTesting;
+    }
+    switch (BuildConfig.TARGET_BACKEND) {
+      case "emulator":
+        return TargetBackend.EMULATOR;
+      case "qa":
+        return TargetBackend.QA;
+      case "nightly":
+        return TargetBackend.NIGHTLY;
+      case "prod":
+        return TargetBackend.PROD;
+      default:
+        throw new RuntimeException("Unknown backend configuration used for integration tests.");
+    }
+  }
+
   public static DatabaseInfo testEnvDatabaseInfo() {
-    if (CONNECT_TO_EMULATOR) {
+    if (backend.equals(TargetBackend.EMULATOR)) {
       return new DatabaseInfo(
           DatabaseId.forProject(provider.projectId()),
           "test-persistenceKey",
@@ -131,19 +157,21 @@ public static DatabaseInfo testEnvDatabaseInfo() {
       return new DatabaseInfo(
           DatabaseId.forProject(provider.projectId()),
           "test-persistenceKey",
-          provider.firestoreHost(),
+          provider.firestoreHost(backend),
           /*sslEnabled=*/ true);
     }
   }
 
   public static FirebaseFirestoreSettings newTestSettings() {
+    Logger.debug("IntegrationTestUtil", "target backend is: %s", BuildConfig.TARGET_BACKEND);
+
     FirebaseFirestoreSettings.Builder settings = new FirebaseFirestoreSettings.Builder();
 
-    if (CONNECT_TO_EMULATOR) {
+    if (backend.equals(TargetBackend.EMULATOR)) {
       settings.setHost(String.format("%s:%d", EMULATOR_HOST, EMULATOR_PORT));
       settings.setSslEnabled(false);
     } else {
-      settings.setHost(provider.firestoreHost());
+      settings.setHost(provider.firestoreHost(backend));
     }
 
     settings.setPersistenceEnabled(true);
@@ -435,7 +463,7 @@ public static Map<String, Object> toDataMap(QuerySnapshot qrySnap) {
   }
 
   public static boolean isRunningAgainstEmulator() {
-    return CONNECT_TO_EMULATOR;
+    return backend.equals(TargetBackend.EMULATOR);
   }
 
   public static void testChangeUserTo(User user) {

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/testutil/prod_provider/FirestoreProvider.java

@@ -17,6 +17,7 @@
 import android.content.Context;
 import androidx.test.core.app.ApplicationProvider;
 import com.google.firebase.firestore.R;
+import com.google.firebase.firestore.testutil.IntegrationTestUtil;
 
 /**
  * Provides locations of production Firestore and Firebase Rules.
@@ -35,8 +36,17 @@ public FirestoreProvider(Context context) {
     this.context = context;
   }
 
-  public String firestoreHost() {
-    return "firestore.googleapis.com";
+  public String firestoreHost(IntegrationTestUtil.TargetBackend backend) {
+    switch (backend) {
+      case QA:
+        return "staging-firestore.sandbox.googleapis.com";
+      case NIGHTLY:
+        return "test-firestore.sandbox.googleapis.com";
+      case EMULATOR:
+      case PROD:
+      default:
+        return "firestore.googleapis.com";
+    }
   }
 
   public String projectId() {