Update firestore code & enable firestore test in CI (#165)

Author: sunmou99

.github/workflows/integration_tests.yml

@@ -23,16 +23,15 @@ on:
         required: true
       apis:
         description: 'CSV of apis to build and test'
-        # TODO: firestore is excluded, because it fails to build on Unity 2017
-        default: 'analytics,auth,crashlytics,database,dynamic_links,functions,installations,messaging,remote_config,storage'
+        default: 'analytics,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
         required: true
       mobile_test_on:
         description: 'Run mobile tests on real and/or virtual devices? (separated by commas)'
         default: 'real,virtual'
         required: true
       sdk_url:
         description: 'Download unity sdk from this URL'
-        default: 'https://dl.google.com/firebase/sdk/unity/firebase_unity_sdk_8.5.0.zip'
+        default: 'https://dl.google.com/firebase/sdk/unity/firebase_unity_sdk_8.7.0.zip'
         required: true 
       use_expanded_matrix:
         description: 'Use an expanded matrix? Note: above config will be ignored.'
@@ -263,7 +262,7 @@ jobs:
             unzip -q firebase_unity_sdk.zip -d ~/Downloads/
           else
             if [[ -z "${{ github.event.inputs.sdk_url }}" ]];then
-              sdk_url="https://dl.google.com/firebase/sdk/unity/firebase_unity_sdk_8.5.0.zip"
+              sdk_url="https://dl.google.com/firebase/sdk/unity/firebase_unity_sdk_8.7.0.zip"
             else
               sdk_url=${{ github.event.inputs.sdk_url }}
             fi

scripts/gha/build_testapps.py

@@ -756,7 +756,10 @@ def _copy_unity_assets(dir_helper, files_to_ignore):
     if any(name in copied_file for name in files_to_ignore):
       logging.info("Removing %s", copied_file)
       os.remove(copied_file)
-
+  if "firestore" in dest.lower():
+    logging.info("Removing firestore a) Tests b) Firebase/Editor/Builder.cs")
+    dir_util.remove_tree(os.path.join(dir_helper.unity_project_assets_dir, "Tests"))
+    os.remove(os.path.join(dir_helper.unity_project_assets_dir, "Firebase", "Editor", "Builder.cs"))
 
 # The menu scene will timeout to the automated version of the app,
 # while leaving an option in manual testing to select the manual version.

scripts/gha/integration_testing/automated_testapp/AutomatedTestRunner.cs

@@ -13,6 +13,10 @@ public class AutomatedTestRunner {
     private Func<Task>[] tests = null;
     // The index of the currently running test.
     private int currentTestIndex = -1;
+    // List of exceptions thrown in the currently running test.
+    private List<Exception> testExceptions = new List<Exception>();
+    // Whether the currently running test is expected to fail.
+    private bool postTestIgnoredFailureCheckEnabled = true;
     // Name and index of the current running test function.
     public string CurrentTestDescription { get; private set; }
     // The Task that represents the currently running test.
@@ -59,6 +63,12 @@ public static AutomatedTestRunner CreateTestRunner(
       return new AutomatedTestRunner(testsToRun, testLabManager, logFunc, testNames);
     }
 
+    public void FailTest(String reason) {
+      var e = new Exception(reason);
+      testExceptions.Add(e);
+      throw e;
+    }
+
     /// <summary>
     /// Configures a TestLabManager object to be used with Firebase Test Lab. Required even
     /// if not using Firebase Test Lab.
@@ -129,8 +139,18 @@ public void Update() {
                                   CurrentTestResult.Exception.Flatten().ToString()));
             ++failedTestsCount;
             failingTestDescriptions.Add(CurrentTestDescription);
+          } else if (postTestIgnoredFailureCheckEnabled && testExceptions.Count > 0) {
+            LogFunc(String.Format("Test {0} failed with {1} exception(s).\n\n",
+                                  CurrentTestDescription, testExceptions.Count.ToString()));
+            for (int i = 0; i < testExceptions.Count; ++i) {
+              LogFunc(String.Format("Exception message ({0}): {1}\n\n", (i + 1).ToString(),
+                                    testExceptions[i].ToString()));
+            }
+            ++failedTestsCount;
+            failingTestDescriptions.Add(CurrentTestDescription);
           } else {
-            // If the task was not faulted, assume it succeeded.
+            // If the task was not faulted and no exceptions have been recorded,
+            // assume it succeeded.
             LogFunc("Test " + CurrentTestDescription + " passed.");
             ++passedTestsCount;
           }
@@ -158,6 +178,8 @@ public void Update() {
 
     void StartNextTest() {
       CurrentTestResult = null;
+      postTestIgnoredFailureCheckEnabled = true;
+      testExceptions.Clear();
       ++currentTestIndex;
       if (currentTestIndex < tests.Length && tests[currentTestIndex] != null) {
         // Start running the next test.
@@ -179,6 +201,11 @@ void StartNextTest() {
         startTime = Time.time;
       }
     }
+
+    // Informs the test runner that the currently running test contains expected assertion failures.
+    public void DisablePostTestIgnoredFailureCheck() {
+      postTestIgnoredFailureCheckEnabled = false;
+    }
   }
 
   // This is a class for forcing code to run on the main thread.

scripts/gha/print_matrix_configuration.py

@@ -58,20 +58,18 @@
 
       MINIMAL_KEY: {
         "platform": ["Linux"],
-        "apis": "firestore"
       },
 
       EXPANDED_KEY: {
         "build_os": ["macos-latest"],
         "unity_version": ["2020", "2019", "2018"],
         "android_device": ["android_target", "android_latest", "emulator_target", "emulator_latest", "emulator_32bit"],
         "ios_device": ["ios_min", "ios_target", "ios_latest", "simulator_min", "simulator_target", "simulator_latest"],
-        "apis": "crashlytics,database",
       }
     },
     "config": {
       "platform": "Windows,macOS,Linux",
-      "apis": "analytics,auth,crashlytics,database,dynamic_links,functions,installations,messaging,remote_config,storage",
+      "apis": "analytics,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage",
       "mobile_test_on": "real,virtual"
     }
   },

scripts/gha/unity_installer.py

@@ -149,7 +149,7 @@ def main(argv):
       username = FLAGS.username
       password = FLAGS.password
       serial_ids = FLAGS.serial_ids
-    activate_license(username, password, serial_ids, FLAGS.logfile, FLAGS.version)
+    return activate_license(username, password, serial_ids, FLAGS.logfile, FLAGS.version)
 
   if FLAGS.release_license:
     release_license(FLAGS.logfile, FLAGS.version)