Firestore: disable debug logging in integration tests (#1024)

Author: dconeybe

firestore/integration_test_internal/src/firestore_integration_test.cc

@@ -149,13 +149,10 @@ Firestore* FirestoreIntegrationTest::TestFirestoreWithProjectId(
     apps_[app] = std::unique_ptr<App>(app);
   }
 
-  // Firestore::set_log_level(LogLevel::kLogLevelDebug);
-
   Firestore* db = new Firestore(CreateTestFirestoreInternal(app));
   firestores_[db] = FirestoreInfo(name, std::unique_ptr<Firestore>(db));
 
   LocateEmulator(db);
-  InitializeFirestore(db);
   return db;
 }
 

firestore/integration_test_internal/src/firestore_integration_test.h

@@ -48,7 +48,6 @@ const int kCheckIntervalMillis = 100;
 const int kTimeOutMillis = 15000;
 
 FirestoreInternal* CreateTestFirestoreInternal(App* app);
-void InitializeFirestore(Firestore* instance);
 
 App* GetApp();
 App* GetApp(const char* name, const std::string& override_project_id);
@@ -175,6 +174,27 @@ class TestEventListener {
   bool print_debug_info_ = false;
 };
 
+// A RAII wrapper that enables Firestore debug logging and then disables it
+// upon destruction.
+//
+// This is useful for enabling Firestore debug logging in a specific test.
+//
+// Example:
+// TEST(MyCoolTest, VerifyFirestoreDoesItsThing) {
+//   FirestoreDebugLogEnabler firestore_debug_log_enabler;
+//   ...
+// }
+class FirestoreDebugLogEnabler {
+ public:
+  FirestoreDebugLogEnabler() {
+    Firestore::set_log_level(LogLevel::kLogLevelDebug);
+  }
+
+  ~FirestoreDebugLogEnabler() {
+    Firestore::set_log_level(LogLevel::kLogLevelInfo);
+  }
+};
+
 // Base class for Firestore integration tests.
 // Note it keeps a cache of created Firestore instances, and is thread-unsafe.
 class FirestoreIntegrationTest : public testing::Test {

firestore/integration_test_internal/src/listener_registration_test.cc

@@ -34,14 +34,7 @@
 namespace firebase {
 namespace firestore {
 
-using ListenerRegistrationCommonTest = testing::Test;
-
-class ListenerRegistrationTest : public FirestoreIntegrationTest {
- public:
-  ListenerRegistrationTest() {
-    // TestFirestore()->set_log_level(LogLevel::kLogLevelDebug);
-  }
-};
+using ListenerRegistrationTest = FirestoreIntegrationTest;
 
 TEST_F(ListenerRegistrationTest, TestCanBeRemoved) {
   CollectionReference collection = Collection();
@@ -136,7 +129,7 @@ TEST_F(ListenerRegistrationTest, TestCanBeRemovedIndependently) {
 // The most valuable test is making sure that a copy of a registration can be
 // used to remove the listener.
 
-TEST_F(ListenerRegistrationCommonTest, Construction) {
+TEST_F(ListenerRegistrationTest, Construction) {
   auto* internal = testutil::NewInternal<ListenerRegistrationInternal>();
   auto registration = MakePublic<ListenerRegistration>(internal);
   EXPECT_EQ(internal, GetInternal(registration));
@@ -155,7 +148,7 @@ TEST_F(ListenerRegistrationCommonTest, Construction) {
   delete internal;
 }
 
-TEST_F(ListenerRegistrationCommonTest, Assignment) {
+TEST_F(ListenerRegistrationTest, Assignment) {
   auto* internal = testutil::NewInternal<ListenerRegistrationInternal>();
   auto registration = MakePublic<ListenerRegistration>(internal);
   ListenerRegistration reg_copy;
@@ -171,7 +164,7 @@ TEST_F(ListenerRegistrationCommonTest, Assignment) {
   delete internal;
 }
 
-TEST_F(ListenerRegistrationCommonTest, Remove) {
+TEST_F(ListenerRegistrationTest, Remove) {
   auto* internal = testutil::NewInternal<ListenerRegistrationInternal>();
   auto registration = MakePublic<ListenerRegistration>(internal);
   ListenerRegistration reg_copy;

firestore/integration_test_internal/src/numeric_transforms_test.cc

@@ -126,6 +126,9 @@ class NumericTransformsTest : public FirestoreIntegrationTest {
 };
 
 TEST_F(NumericTransformsTest, CreateDocumentWithIncrement) {
+  // TODO(dconeybe) Remove the FirestoreDebugLogEnabler on the line below once
+  // this test's flakiness is solved.
+  FirestoreDebugLogEnabler debug_log_enabler;
   Await(doc_ref_.Set({{"sum", FieldValue::Increment(1337)}}));
 
   ExpectLocalAndRemoteValue(1337);

firestore/integration_test_internal/src/transaction_test.cc

@@ -732,6 +732,10 @@ TEST_F(TransactionTest, TestCancellationOnError) {
 }
 
 TEST_F(TransactionTest, TestMaxAttempts) {
+  // TODO(dconeybe) Remove the FirestoreDebugLogEnabler on the line below once
+  // this test's flakiness is solved.
+  FirestoreDebugLogEnabler firestore_debug_log_enabler;
+
   Firestore* firestore = TestFirestore();
   DocumentReference doc = firestore->Collection("TestMaxAttempts").Document();
 

firestore/integration_test_internal/src/type_test.cc

@@ -30,7 +30,6 @@ class TypeTest : public FirestoreIntegrationTest {
   // Write the specified data to Firestore as a document and read that document.
   // Check the data read from that document matches with the original data.
   void AssertSuccessfulRoundTrip(MapFieldValue data) {
-    // TestFirestore()->set_log_level(LogLevel::kLogLevelDebug);
     DocumentReference reference = Document();
     WriteDocument(reference, data);
     DocumentSnapshot snapshot = ReadDocument(reference);

firestore/integration_test_internal/src/util/integration_test_util.cc

@@ -81,9 +81,5 @@ FirestoreInternal* CreateTestFirestoreInternal(App* app) {
   return TestFriend::CreateTestFirestoreInternal(app);
 }
 
-void InitializeFirestore(Firestore* instance) {
-  Firestore::set_log_level(LogLevel::kLogLevelDebug);
-}
-
 }  // namespace firestore
 }  // namespace firebase