Mila/dynamically set target backend in test (#769)

Author: milaGGL

.github/workflows/integration_tests.yml

@@ -377,9 +377,26 @@ jobs:
           name: 'firebase_unity_sdk.zip'
           workflow: 'build_starter.yml'
           run_id: ${{ github.event.inputs.packaged_sdk_run_id }} 
+      - name: Set up Node (16)
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+      - name: Setup java for Firestore emulator
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+      - name: Setup Firestore Emulator
+        uses: nick-invision/retry@v2
+        with:
+          shell: bash
+          timeout_minutes: 5
+          max_attempts: 3
+          command: npm install -g firebase-tools 
       - name: Run Playmode (in editor mode) integration tests
         shell: bash
         run: |
+          firebase emulators:start --only firestore &
           if [[ -n "${{ github.event.inputs.packaged_sdk_run_id }}" ]]; then
             unzip -q firebase_unity_sdk.zip -d ~/Downloads/
           else
@@ -466,11 +483,31 @@ jobs:
         with:
           path: testapps
           name: ${{ steps.matrix_info.outputs.artifact_path }}
+      - name: Set up Node (16)
+        if: ${{ matrix.test_device == 'github_runner'  }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+      - name: Setup java for Firestore emulator
+        if: ${{ matrix.test_device == 'github_runner'  }}
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+      - name: Setup Firestore Emulator
+        if: ${{ matrix.test_device == 'github_runner'  }}
+        uses: nick-invision/retry@v2
+        with:
+          shell: bash
+          timeout_minutes: 5
+          max_attempts: 3
+          command: npm install -g firebase-tools  
       - name: Run Desktop integration tests
         if: ${{ matrix.test_device == 'github_runner'  }}
         timeout-minutes: 30
         shell: bash
         run: |
+          firebase emulators:start --only firestore &
           python scripts/gha/desktop_tester.py --testapp_dir testapps \
             --logfile_name "${{ steps.matrix_info.outputs.info }}"
       - name: Run Mobile integration tests on real device via FTL

firestore/testapp/Assets/Firebase/Sample/Firestore/UIHandler.cs

@@ -60,6 +60,34 @@ public class UIHandler : MonoBehaviour {
     // Previously completed task.
     protected Task previousTask;
 
+    private enum Backend {
+      Production = 0,
+      Emulator = 1
+      // Nightly and stage can be added later.
+    }
+
+    private Backend TargetBackend = GetTargetBackend();
+    // For local testing purpose, manually modify the port number if Firestore
+    // emulator is running at a different port.
+    private string EmulatorPort = "8080";
+
+    private static Backend GetTargetBackend() {
+      // Set Firestore emulator as default backend.
+      Backend targetBackend = Backend.Emulator;
+
+      // Use production backend if not running on Unity editor or standalone platform (Mac OS X,
+      // Windows or Linux).
+      #if !UNITY_EDITOR && !UNITY_STANDALONE
+        targetBackend = Backend.Production;
+      // Set custom script `RUN_AGAINST_PRODUCTION` to run tests against the productions. Refer to
+      // unity documents for guidance:https://docs.unity3d.com/Manual/CustomScriptingSymbols.html
+      #elif RUN_AGAINST_PRODUCTION
+        targetBackend = Backend.Production;
+      #endif 
+
+      return targetBackend;
+    }
+    
     /**
      * Compares two objects for deep equality.
      */
@@ -227,18 +255,23 @@ protected internal FirebaseFirestore TestFirestore(FirebaseApp app, string datab
       return firestore;
     }
 
+    // Check if Firestore emulator is the target backend.
+    protected bool IsUsingFirestoreEmulator() {
+        return (TargetBackend == Backend.Emulator);
+    }
+
     // Update the `Settings` of a Firestore instance to run tests against the production or
     // Firestore emulator backend.
     protected internal void SetTargetBackend(FirebaseFirestore db) {
       string targetHost = GetTargetHost();
-      
+
       // Avoid updating `Settings` if not required. No changes are allowed to be made to the
       // settings of a <c>FirebaseFirestore</c> instance if it has invoked any non-static method.
       /// Attempting to do so will result in an exception.
       if (db.Settings.Host == targetHost) {
         return;
       }
-  
+
       db.Settings.Host = targetHost;
       // Emulator does not support ssl.
       db.Settings.SslEnabled = IsUsingFirestoreEmulator() ? false : true;
@@ -252,20 +285,10 @@ private string GetTargetHost() {
         #else
           string localHost = "localhost";
         #endif // UNITY_ANDROID
-
-        // Use FIRESTORE_EMULATOR_PORT if it is set to non empty string, otherwise use the
-        // default port.
-        string port = Environment.GetEnvironmentVariable("FIRESTORE_EMULATOR_PORT") ?? "8080";
-        return localHost + ":" + port;
+        return localHost + ":" + EmulatorPort;
       }
-      
-      return FirebaseFirestore.DefaultInstance.Settings.Host;
-    }
 
-    // Check if the `USE_FIRESTORE_EMULATOR` environment variable is set regardsless
-    // of its value.
-    protected internal bool IsUsingFirestoreEmulator() {
-      return (Environment.GetEnvironmentVariable("USE_FIRESTORE_EMULATOR") != null);
+      return FirebaseFirestore.DefaultInstance.Settings.Host;
     }
 
     // Cancel the currently running operation.

firestore/testapp/Assets/Firebase/Sample/Firestore/UIHandlerAutomated.cs

@@ -115,7 +115,6 @@ protected override void Start() {
         TestDocumentSnapshotDoubleIncrementBehavior,
         TestDocumentSnapshotServerTimestampBehavior,
         TestSnapshotMetadataEqualsAndGetHashCode,
-        TestAuthIntegration,
         TestDocumentListen,
         TestDocumentListenWithMetadataChanges,
         TestQueryListen,
@@ -170,21 +169,19 @@ protected override void Start() {
         TestTerminateAppWithMultiDB,
         TestRestartCustomFirestore,
       };
+      
+      // Set the list of tests to run against Production only.
+      Func<Task>[] testsToRunAgainstProductionOnly = {
+        // While running on CI, this test case passes only if it is tested against the production.
+        TestAuthIntegration,
+      };
 
       // For local development convenience, populate `testFilter` with the tests that you would like
       // to run (instead of running the entire suite).
       Func<Task>[] testFilter = {
         // THIS LIST MUST BE EMPTY WHEN CHECKED INTO SOURCE CONTROL!
       };
 
-      /*
-       * THIS MUST BE COMMENTED OUT WHEN CHECKED INTO SOURCE CONTROL!
-       * 
-       * To run tests against Firestore emulator locally, set `USE_FIRESTORE_EMULATOR` to "true".
-       * To switch back to run against prod, set it back to null.
-       */
-      // Environment.SetEnvironmentVariable("USE_FIRESTORE_EMULATOR", "true");
-
       // Unity "helpfully" adds stack traces whenever you call Debug.Log. Unfortunately, these stack
       // traces are basically useless, since the good parts are always truncated.  (See comments on
       // LogInBatches.) So just disable them.
@@ -204,6 +201,8 @@ protected override void Start() {
       if (IsUsingFirestoreEmulator()) {
         Debug.Log("Running tests against Firestore Emulator.");
         tests = tests.Concat(testsToRunAgainstFirestoreEmulatorOnly).ToArray();
+      } else {
+        tests = tests.Concat(testsToRunAgainstProductionOnly).ToArray();
       }
 
       testRunner = AutomatedTestRunner.CreateTestRunner(