Setup integration tests against named db (#11638)

wu-hui · web-flow · commit 54f1b1b33c15 · 2023-08-02T13:14:26.000-04:00
* Make tests work against named db

* setup jobs
diff --git a/.github/workflows/firestore.yml b/.github/workflows/firestore.yml
@@ -123,6 +123,54 @@ jobs:
       run:  scripts/third_party/travis/retry.sh scripts/build.sh Firestore ${{ runner.os }} cmake
 
 
+  cmake-prod-db:
+    # Don't run on private repo unless it is a PR.
+    if: (github.repository == 'Firebase/firebase-ios-sdk' && github.event_name == 'schedule') || github.event_name == 'pull_request'
+    needs: check
+
+    strategy:
+      matrix:
+        os: [macos-12]
+        databaseId: [(default), test-db]
+
+    env:
+      plist_secret: ${{ secrets.GHASecretsGPGPassphrase1 }}
+      MINT_PATH: ${{ github.workspace }}/mint
+      TARGET_DATABASE_ID: ${{ matrix.databaseId }}
+
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - uses: mikehardy/buildcache-action@c87cea0ccd718971d6cc39e672c4f26815b6c126
+      with:
+        cache_key: ${{ matrix.os }}
+
+    - name: Prepare ccache
+      uses: actions/cache@v3
+      with:
+        path: ~/.ccache
+        key: firestore-ccache-${{ runner.os }}-${{ github.sha }}
+        restore-keys: |
+          firestore-ccache-${{ runner.os }}-
+
+    - name: Cache Mint packages
+      uses: actions/cache@v3
+      with:
+        path: ${{ env.MINT_PATH }}
+        key: ${{ runner.os }}-mint-${{ hashFiles('**/Mintfile') }}
+        restore-keys: ${{ runner.os }}-mint-
+
+    - name: Install Secret GoogleService-Info.plist
+      run: scripts/decrypt_gha_secret.sh scripts/gha-encrypted/firestore.plist.gpg \
+        Firestore/Example/App/GoogleService-Info.plist "$plist_secret"
+
+    - name: Setup build
+      run:  scripts/install_prereqs.sh Firestore ${{ runner.os }} cmake
+
+    - name: Build and test
+      run:  scripts/third_party/travis/retry.sh scripts/build.sh Firestore ${{ runner.os }} cmake
+
+
   sanitizers:
     # Don't run on private repo unless it is a PR.
     if: (github.repository == 'Firebase/firebase-ios-sdk' && github.event_name == 'schedule') || github.event_name == 'pull_request'
diff --git a/Firestore/Example/Tests/Integration/API/FIRBundlesTests.mm b/Firestore/Example/Tests/Integration/API/FIRBundlesTests.mm
@@ -69,11 +69,16 @@ - (void)verifyErrorProgress:(FIRLoadBundleTaskProgress*)progress {
 }
 
 - (std::string)defaultBundle {
-  return CreateBundle(MakeString([FSTIntegrationTestCase projectID]));
+  return CreateBundle(MakeString([FSTIntegrationTestCase projectID]),
+                      MakeString([FSTIntegrationTestCase databaseID]));
 }
 
 - (std::string)bundleForProject:(NSString*)projectID {
-  return CreateBundle(MakeString(projectID));
+  return CreateBundle(MakeString(projectID), MakeString([FSTIntegrationTestCase databaseID]));
+}
+
+- (std::string)bundleForDatabase:(NSString*)databaseID {
+  return CreateBundle(MakeString([FSTIntegrationTestCase projectID]), MakeString(databaseID));
 }
 
 - (void)verifyQueryResults {
@@ -248,4 +253,27 @@ - (void)testLoadBundlesFromOtherProjectFails {
   XCTAssertEqualObjects(progresses[1], result);
 }
 
+- (void)testLoadBundlesFromOtherDatabaseFails {
+  NSMutableArray* progresses = [[NSMutableArray alloc] init];
+  __block FIRLoadBundleTaskProgress* result;
+  XCTestExpectation* expectation = [self expectationWithDescription:@"loading complete"];
+  auto bundle = [self bundleForDatabase:@"other-database"];
+  FIRLoadBundleTask* task =
+      [self.db loadBundle:[MakeNSString(bundle) dataUsingEncoding:NSUTF8StringEncoding]
+               completion:^(FIRLoadBundleTaskProgress* progress, NSError* error) {
+                 result = progress;
+                 XCTAssertNotNil(error);
+                 [expectation fulfill];
+               }];
+  [task addObserver:^(FIRLoadBundleTaskProgress* progress) {
+    [progresses addObject:progress];
+  }];
+  [self awaitExpectation:expectation];
+
+  XCTAssertEqual(2ul, progresses.count);
+  [self verifyProgress:progresses[0] hasLoadedDocument:0];
+  [self verifyErrorProgress:progresses[1]];
+  XCTAssertEqualObjects(progresses[1], result);
+}
+
 @end
diff --git a/Firestore/Example/Tests/Integration/API/FIRValidationTests.mm b/Firestore/Example/Tests/Integration/API/FIRValidationTests.mm
@@ -300,10 +300,11 @@ - (void)testWritesWithReferencesToADifferentDatabaseFail {
   id data = @{@"foo" : ref};
   [self expectWrite:data
       toFailWithReason:
-          [NSString
-              stringWithFormat:@"Document Reference is for database different-db/(default) but "
-                                "should be for database %@/(default) (found in field foo)",
-                               [FSTIntegrationTestCase projectID]]];
+          [NSString stringWithFormat:@"Document Reference is for database different-db/%@ but "
+                                      "should be for database %@/%@ (found in field foo)",
+                                     [FSTIntegrationTestCase databaseID],
+                                     [FSTIntegrationTestCase projectID],
+                                     [FSTIntegrationTestCase databaseID]]];
 }
 
 - (void)testWritesWithReservedFieldsFail {
diff --git a/Firestore/Example/Tests/Util/FSTIntegrationTestCase.h b/Firestore/Example/Tests/Util/FSTIntegrationTestCase.h
@@ -47,6 +47,9 @@ extern "C" {
 /** Returns the default Firestore project ID for testing. */
 + (NSString *)projectID;
 
+/** Returns the default Firestore database ID for testing. */
++ (NSString *)databaseID;
+
 + (bool)isRunningAgainstEmulator;
 
 /** Returns a FirestoreSettings configured to use either hexa or the emulator. */
diff --git a/Firestore/Example/Tests/Util/FSTIntegrationTestCase.mm b/Firestore/Example/Tests/Util/FSTIntegrationTestCase.mm
@@ -84,6 +84,7 @@
 static const double kPrimingTimeout = 45.0;
 
 static NSString *defaultProjectId;
+static NSString *defaultDatabaseId = @"(default)";
 static FIRFirestoreSettings *defaultSettings;
 
 static bool runningAgainstEmulator = false;
@@ -186,6 +187,12 @@ + (void)setUpDefaults {
 
   defaultSettings = [[FIRFirestoreSettings alloc] init];
 
+  // Setup database id to use.
+  NSString *databaseId = [[NSProcessInfo processInfo] environment][@"TARGET_DATABASE_ID"];
+  if (databaseId) {
+    defaultDatabaseId = databaseId;
+  }
+
   // Check for a MobileHarness configuration, running against nightly or prod, which have live
   // SSL certs.
   NSString *project = [[NSProcessInfo processInfo] environment][@"PROJECT_ID"];
@@ -217,7 +224,8 @@ + (void)setUpDefaults {
     defaultProjectId = project;
     defaultSettings.host = host;
 
-    NSLog(@"Integration tests running against %@/%@", defaultSettings.host, defaultProjectId);
+    NSLog(@"Integration tests running against %@/(%@:%@)", defaultSettings.host, defaultProjectId,
+          defaultDatabaseId);
     return;
   }
 
@@ -230,7 +238,8 @@ + (void)setUpDefaults {
       defaultSettings.host = host;
     }
 
-    NSLog(@"Integration tests running against %@/%@", defaultSettings.host, defaultProjectId);
+    NSLog(@"Integration tests running against %@/(%@:%@)", defaultSettings.host, defaultProjectId,
+          defaultDatabaseId);
     return;
   }
 
@@ -256,6 +265,13 @@ + (NSString *)projectID {
   return defaultProjectId;
 }
 
++ (NSString *)databaseID {
+  if (!defaultDatabaseId) {
+    return @"(default)";
+  }
+  return defaultDatabaseId;
+}
+
 + (bool)isRunningAgainstEmulator {
   // The only way to determine whether or not we're running against the emulator is to figure out
   // which testing environment we're using.  Essentially `setUpDefaults` determines
@@ -282,8 +298,9 @@ - (FIRFirestore *)firestoreWithApp:(FIRApp *)app {
   FIRSetLoggerLevel(FIRLoggerLevelDebug);
 
   std::string projectID = MakeString(app.options.projectID);
+  std::string databaseID = MakeString(defaultDatabaseId);
   FIRFirestore *firestore =
-      [[FIRFirestore alloc] initWithDatabaseID:DatabaseId(projectID)
+      [[FIRFirestore alloc] initWithDatabaseID:DatabaseId(projectID, databaseID)
                                 persistenceKey:MakeString(persistenceKey)
                        authCredentialsProvider:_fakeAuthCredentialsProvider
                    appCheckCredentialsProvider:_fakeAppCheckCredentialsProvider
diff --git a/Firestore/core/test/unit/testutil/bundle_builder.cc b/Firestore/core/test/unit/testutil/bundle_builder.cc
@@ -194,13 +194,15 @@ std::vector<std::string> BundleTemplate() {
 
 }  // namespace
 
-std::string CreateBundle(const std::string& project_id) {
+std::string CreateBundle(const std::string& project_id,
+                         const std::string& database_id) {
   std::string bundle;
 
   auto bundle_template = BundleTemplate();
   for (size_t i = 1; i < bundle_template.size(); ++i) {
-    auto element =
-        absl::StrReplaceAll(bundle_template[i], {{"{projectId}", project_id}});
+    auto element = absl::StrReplaceAll(
+        bundle_template[i],
+        {{"{projectId}", project_id}, {"(default)", database_id}});
     bundle.append(std::to_string(element.size()));
     bundle.append(std::move(element));
   }
diff --git a/Firestore/core/test/unit/testutil/bundle_builder.h b/Firestore/core/test/unit/testutil/bundle_builder.h
@@ -22,7 +22,8 @@ namespace firebase {
 namespace firestore {
 namespace testutil {
 
-std::string CreateBundle(const std::string& project_id);
+std::string CreateBundle(const std::string& project_id,
+                         const std::string& database_id);
 
 }  // namespace testutil
 }  // namespace firestore
diff --git a/scripts/gha-encrypted/firestore.plist.gpg b/scripts/gha-encrypted/firestore.plist.gpg
