[Sync] Rework Invalidator-related unit tests

sync/notifier/invalidation_notifier_unittest.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "sync/notifier/invalidation_notifier.h"
 
 #include "base/memory/scoped_ptr.h"
 #include "base/message_loop.h"
 #include "jingle/notifier/base/fake_base_task.h"
 #include "jingle/notifier/base/notifier_options.h"
 #include "jingle/notifier/listener/fake_push_client.h"
 #include "net/url_request/url_request_test_util.h"
 #include "sync/internal_api/public/base/model_type.h"
 #include "sync/internal_api/public/base/model_type_state_map.h"
 #include "sync/internal_api/public/util/weak_handle.h"
 #include "sync/notifier/fake_invalidation_handler.h"
 #include "sync/notifier/fake_invalidation_state_tracker.h"
 #include "sync/notifier/invalidation_state_tracker.h"
+#include "sync/notifier/invalidator_test_template.h"
 #include "sync/notifier/object_id_state_map_test_util.h"
-#include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace syncer {
 
 namespace {
 
-using ::testing::InSequence;
-using ::testing::StrictMock;
+class InvalidationNotifierTestDelegate {
+ public:
+  InvalidationNotifierTestDelegate() {}
 
-class InvalidationNotifierTest : public testing::Test {
- protected:
-  virtual void TearDown() {
-    if (invalidation_notifier_.get())
-      ResetNotifier();
+  ~InvalidationNotifierTestDelegate() {
+    DestroyInvalidator();
   }
 
-  // Constructs an InvalidationNotifier, places it in |invalidation_notifier_|,
-  // and registers |fake_handler_| as a handler. This remains in place until
-  // either TearDown (automatic) or ResetNotifier (manual) is called.
-  void CreateNotifier(
-      const std::string& initial_invalidation_state) {
-    notifier::NotifierOptions notifier_options;
-    // Note: URLRequestContextGetters are ref-counted.
-    notifier_options.request_context_getter =
-        new TestURLRequestContextGetter(message_loop_.message_loop_proxy());
-    invalidation_notifier_.reset(
+  void CreateInvalidator(
+      const std::string& initial_state,
+      const base::WeakPtr<InvalidationStateTracker>&
+          invalidation_state_tracker) {
+    DCHECK(!invalidator_.get());
+    invalidator_.reset(
         new InvalidationNotifier(
             scoped_ptr<notifier::PushClient>(new notifier::FakePushClient()),
             InvalidationVersionMap(),
-            initial_invalidation_state,
-            MakeWeakHandle(fake_tracker_.AsWeakPtr()),
+            initial_state,
+            MakeWeakHandle(invalidation_state_tracker),
             "fake_client_info"));
-    invalidation_notifier_->RegisterHandler(&fake_handler_);
   }
 
-  void ResetNotifier() {
-    invalidation_notifier_->UnregisterHandler(&fake_handler_);
-    // Stopping the invalidation notifier stops its scheduler, which deletes any
-    // pending tasks without running them.  Some tasks "run and delete" another
-    // task, so they must be run in order to avoid leaking the inner task.
-    // Stopping does not schedule any tasks, so it's both necessary and
+  Invalidator* GetInvalidator() {
+    return invalidator_.get();
+  }
+
+  void DestroyInvalidator() {
+    // Stopping the invalidation notifier stops its scheduler, which deletes
+    // any pending tasks without running them.  Some tasks "run and delete"
+    // another task, so they must be run in order to avoid leaking the inner
+    // task.  Stopping does not schedule any tasks, so it's both necessary and
     // sufficient to drain the task queue before stopping the notifier.
     message_loop_.RunAllPending();
-    invalidation_notifier_.reset();
+    invalidator_.reset();
   }
 
-  void SetStateDeprecated(const std::string& new_state) {
-    invalidation_notifier_->SetStateDeprecated(new_state);
+  void WaitForInvalidator() {
     message_loop_.RunAllPending();
   }
 
+  void TriggerOnNotificationsEnabled() {
+    invalidator_->OnNotificationsEnabled();
+  }
+
+  void TriggerOnIncomingNotification(const ObjectIdStateMap& id_state_map,
+                                     IncomingNotificationSource source) {
+    // None of the tests actually care about |source|.
+    invalidator_->OnInvalidate(id_state_map);
+  }
+
+  void TriggerOnNotificationsDisabled(NotificationsDisabledReason reason) {
+    invalidator_->OnNotificationsDisabled(reason);
+  }
+
+  static bool InvalidatorHandlesDeprecatedState() {
+    return true;
+  }
+
  private:
-  MessageLoopForIO message_loop_;
-  notifier::FakeBaseTask fake_base_task_;
-
- protected:
-  scoped_ptr<InvalidationNotifier> invalidation_notifier_;
-  FakeInvalidationStateTracker fake_tracker_;
-  FakeInvalidationHandler fake_handler_;
+  MessageLoop message_loop_;
+  scoped_ptr<InvalidationNotifier> invalidator_;
 };
 
-TEST_F(InvalidationNotifierTest, Basic) {
-  CreateNotifier("fake_state");
-
-  const ModelTypeSet models(PREFERENCES, BOOKMARKS, AUTOFILL);
-  const ObjectIdStateMap& id_state_map =
-      ModelTypeStateMapToObjectIdStateMap(
-          ModelTypeSetToStateMap(models, "payload"));
-
-  invalidation_notifier_->UpdateRegisteredIds(
-      &fake_handler_, ModelTypeSetToObjectIdSet(models));
-
-  // TODO(tim): This call should be a no-op, Remove once bug 124140 and
-  // associated issues are fixed.
-  invalidation_notifier_->SetStateDeprecated("fake_state");
-  // We don't expect |fake_tracker_|'s state to change, as we
-  // initialized with non-empty initial_invalidation_state above.
-  EXPECT_TRUE(fake_tracker_.GetInvalidationState().empty());
-  invalidation_notifier_->SetUniqueId("fake_id");
-  invalidation_notifier_->UpdateCredentials("foo@bar.com", "fake_token");
-
-  invalidation_notifier_->OnNotificationsEnabled();
-  EXPECT_EQ(NO_NOTIFICATION_ERROR,
-            fake_handler_.GetNotificationsDisabledReason());
-
-  invalidation_notifier_->OnInvalidate(id_state_map);
-  EXPECT_THAT(id_state_map,
-              Eq(fake_handler_.GetLastNotificationIdStateMap()));
-  EXPECT_EQ(REMOTE_NOTIFICATION, fake_handler_.GetLastNotificationSource());
-
-  invalidation_notifier_->OnNotificationsDisabled(
-      TRANSIENT_NOTIFICATION_ERROR);
-  EXPECT_EQ(TRANSIENT_NOTIFICATION_ERROR,
-            fake_handler_.GetNotificationsDisabledReason());
-
-  invalidation_notifier_->OnNotificationsDisabled(
-      NOTIFICATION_CREDENTIALS_REJECTED);
-  EXPECT_EQ(NOTIFICATION_CREDENTIALS_REJECTED,
-            fake_handler_.GetNotificationsDisabledReason());
-}
-
-TEST_F(InvalidationNotifierTest, MigrateState) {
-  CreateNotifier(std::string());
-
-  SetStateDeprecated("fake_state");
-  EXPECT_EQ("fake_state", fake_tracker_.GetInvalidationState());
-
-  // Should do nothing.
-  SetStateDeprecated("spurious_fake_state");
-  EXPECT_EQ("fake_state", fake_tracker_.GetInvalidationState());
-
-  // Pretend Chrome shut down.
-  ResetNotifier();
-
-  CreateNotifier("fake_state");
-  // Should do nothing.
-  SetStateDeprecated("more_spurious_fake_state");
-  EXPECT_EQ("fake_state", fake_tracker_.GetInvalidationState());
-}
+INSTANTIATE_TYPED_TEST_CASE_P(
+    InvalidationNotifierTest, InvalidatorTest,
+    InvalidationNotifierTestDelegate);
 
 }  // namespace
 
 }  // namespace syncer