Quick check uses dummy google-services file, and skip certain tests (#705)

Author: sunmou99

.github/workflows/desktop.yml

@@ -310,7 +310,6 @@ jobs:
       - name: Prepare for integration tests
         run: |
           pip install -r scripts/gha/requirements.txt
-          python scripts/gha/restore_secrets.py --passphrase "${{ secrets.TEST_SECRET }}"
       - name: Install OpenSSL
         run: |
           sudo apt install openssl
@@ -325,7 +324,8 @@ jobs:
             --output_directory "${{ github.workspace }}" \
             --artifact_name "desktop-ubuntu-latest-openssl" \
             --noadd_timestamp \
-            --short_output_paths 
+            --short_output_paths \
+            --cmake_flag=-DFIREBASE_QUICK_TEST=ON
       - name: Summarize build results
         if: ${{ !cancelled() }}
         shell: bash
@@ -343,7 +343,7 @@ jobs:
           npm install -g firebase-tools
       - name: Run Desktop integration tests
         run: |
-          python scripts/gha/restore_secrets.py --passphrase "${{ secrets.TEST_SECRET }}" --artifact testapps-desktop-ubuntu-latest-openssl
+          cp scripts/gha/integration_testing/google-services.json testapps-desktop-ubuntu-latest-openssl/firestore/google-services.json
           firebase emulators:exec --only firestore --project demo-example 'python scripts/gha/desktop_tester.py --testapp_dir testapps-desktop-ubuntu-latest-openssl --logfile_name "desktop-ubuntu-latest-openssl"'
         env:
           USE_FIRESTORE_EMULATOR: true

CMakeLists.txt

@@ -78,6 +78,9 @@ option(FIREBASE_USE_LINUX_CXX11_ABI
 option(FIREBASE_GITHUB_ACTION_BUILD
        "Indicates that this build was created from a GitHub Action" OFF)
 
+option(FIREBASE_QUICK_TEST
+       "Enable quick tests will skip tests which requires access to the SECRET" OFF)
+
 set(FIREBASE_ANDROID_STL "" CACHE STRING "STL implementation to use.")
 if (NOT FIREBASE_ANDROID_STL STREQUAL "")
   set(ANDROID_STL ${FIREBASE_ANDROID_STL})

app/CMakeLists.txt

@@ -347,6 +347,13 @@ target_compile_definitions(firebase_app
     -DINTERNAL_EXPERIMENTAL=1
 )
 
+if(FIREBASE_QUICK_TEST)
+  target_compile_definitions(firebase_app 
+      PUBLIC 
+          QUICK_CHECK
+  )
+endif()
+
 # firebase_app has a dependency on flatbuffers, which needs to be included.
 target_link_libraries(firebase_app
   PRIVATE

firestore/integration_test_internal/src/firestore_test.cc

@@ -1462,6 +1462,7 @@ TEST_F(FirestoreIntegrationTest, DomainObjectsReferToSameFirestoreInstance) {
 }
 
 TEST_F(FirestoreIntegrationTest, AuthWorks) {
+  SKIP_TEST_ON_QUICK_CHECK;
   // This app instance is managed by the text fixture.
   App* app = GetApp();
   EXPECT_NE(app, nullptr);

firestore/integration_test_internal/src/integration_test.cc

@@ -345,6 +345,7 @@ TEST_F(FirebaseFirestoreBasicTest, TestInitializeAndTerminate) {
 }
 
 TEST_F(FirebaseFirestoreBasicTest, TestSignIn) {
+  SKIP_TEST_ON_QUICK_CHECK;
   EXPECT_NE(shared_auth_->current_user(), nullptr);
 }
 
@@ -385,6 +386,7 @@ TEST_F(FirebaseFirestoreBasicTest, TestDocument) {
 }
 
 TEST_F(FirebaseFirestoreBasicTest, TestSetGet) {
+  SKIP_TEST_ON_QUICK_CHECK;
   SignIn();
 
   firebase::firestore::DocumentReference document = Doc();
@@ -405,6 +407,7 @@ TEST_F(FirebaseFirestoreBasicTest, TestSetGet) {
 }
 
 TEST_F(FirebaseFirestoreBasicTest, TestSetUpdateGet) {
+  SKIP_TEST_ON_QUICK_CHECK;
   SignIn();
 
   firebase::firestore::DocumentReference document = Doc();
@@ -429,6 +432,7 @@ TEST_F(FirebaseFirestoreBasicTest, TestSetUpdateGet) {
 }
 
 TEST_F(FirebaseFirestoreBasicTest, TestSetDelete) {
+  SKIP_TEST_ON_QUICK_CHECK;
   SignIn();
 
   firebase::firestore::DocumentReference document = Doc();
@@ -450,6 +454,7 @@ TEST_F(FirebaseFirestoreBasicTest, TestSetDelete) {
 }
 
 TEST_F(FirebaseFirestoreBasicTest, TestDocumentListener) {
+  SKIP_TEST_ON_QUICK_CHECK;
   SignIn();
 
   firebase::firestore::DocumentReference document = Doc();
@@ -489,6 +494,7 @@ TEST_F(FirebaseFirestoreBasicTest, TestDocumentListener) {
 }
 
 TEST_F(FirebaseFirestoreBasicTest, TestBatchWrite) {
+  SKIP_TEST_ON_QUICK_CHECK;
   SignIn();
 
   firebase::firestore::DocumentReference document1 = Doc("1");
@@ -518,6 +524,7 @@ TEST_F(FirebaseFirestoreBasicTest, TestBatchWrite) {
 }
 
 TEST_F(FirebaseFirestoreBasicTest, TestRunTransaction) {
+  SKIP_TEST_ON_QUICK_CHECK;
   SignIn();
 
   WaitForCompletion(
@@ -603,6 +610,7 @@ TEST_F(FirebaseFirestoreBasicTest, TestRunTransaction) {
 // TODO: Add test for failing transaction.
 
 TEST_F(FirebaseFirestoreBasicTest, TestQuery) {
+  SKIP_TEST_ON_QUICK_CHECK;
   SignIn();
 
   firebase::firestore::CollectionReference collection = GetTestCollection();
@@ -665,6 +673,7 @@ TEST_F(FirebaseFirestoreBasicTest,
 }
 
 TEST_F(FirebaseFirestoreBasicTest, TestInvalidatingReferencesWhenDeletingApp) {
+  SKIP_TEST_ON_QUICK_CHECK;
   delete shared_app_;
   shared_app_ = nullptr;
   // TODO: Ensure existing Firestore objects are invalidated.

scripts/gha/integration_testing/google-services.json

@@ -0,0 +1,42 @@
+{
+  "project_info": {
+    "project_number": "1",
+    "firebase_url": "1",
+    "project_id": "cpp-firestore-test-app",
+    "storage_bucket": "1"
+  },
+  "client": [
+    {
+      "client_info": {
+        "mobilesdk_app_id": "1",
+        "android_client_info": {
+          "package_name": "1"
+        }
+      },
+      "oauth_client": [
+        {
+          "client_id": "1",
+          "client_type": 3
+        }
+      ],
+      "api_key": [
+        {
+          "current_key": "1"
+        }
+      ],
+      "services": {
+        "analytics_service": {
+          "status": 1
+        },
+        "appinvite_service": {
+          "status": 1,
+          "other_platform_oauth_client": []
+        },
+        "ads_service": {
+          "status": 2
+        }
+      }
+    }
+  ],
+  "configuration_version": "1"
+}

testing/test_framework/src/firebase_test_framework.h

@@ -178,6 +178,17 @@ namespace firebase_test_framework {
 #define SKIP_TEST_IF_USING_STLPORT ((void)0)
 #endif  // defined(STLPORT)
 
+#if defined(QUICK_CHECK)
+#define SKIP_TEST_ON_QUICK_CHECK                                               \
+  {                                                                            \
+    app_framework::LogInfo("Skipping %s on quick check.", test_info_->name()); \
+    GTEST_SKIP();                                                              \
+    return;                                                                    \
+  }
+#else
+#define SKIP_TEST_ON_QUICK_CHECK ((void)0)
+#endif  // defined(QUICK_CHECK)
+
 #define KNOWN_FAILURE(explanation) \
   { FAIL() << test_info_->name() << " has a known failure: " << explanation; }