sync/notifier/invalidator_registrar_unittest.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "base/basictypes.h"
   6 #include "base/compiler_specific.h"
   7 #include "base/memory/scoped_ptr.h"
   8 #include "google/cacheinvalidation/types.pb.h"
   9 #include "sync/notifier/fake_invalidation_handler.h"
  10 #include "sync/notifier/invalidator_registrar.h"
  11 #include "sync/notifier/invalidator_test_template.h"
  12 #include "sync/notifier/object_id_invalidation_map_test_util.h"
  13 #include "testing/gtest/include/gtest/gtest.h"
  14
  15 namespace syncer {
  16
  17 namespace {
  18
  19 // We test InvalidatorRegistrar by wrapping it in an Invalidator and
  20 // running the usual Invalidator tests.
  21
  22 // Thin Invalidator wrapper around InvalidatorRegistrar.
  23 class RegistrarInvalidator : public Invalidator {
  24  public:
  25   RegistrarInvalidator() {}
  26   virtual ~RegistrarInvalidator() {}
  27
  28   InvalidatorRegistrar* GetRegistrar() {
  29     return &registrar_;
  30   }
  31
  32   // Invalidator implementation.
  33   virtual void RegisterHandler(InvalidationHandler* handler) OVERRIDE {
  34     registrar_.RegisterHandler(handler);
  35   }
  36
  37   virtual void UpdateRegisteredIds(InvalidationHandler* handler,
  38                                    const ObjectIdSet& ids) OVERRIDE {
  39     registrar_.UpdateRegisteredIds(handler, ids);
  40   }
  41
  42   virtual void UnregisterHandler(InvalidationHandler* handler) OVERRIDE {
  43     registrar_.UnregisterHandler(handler);
  44   }
  45
  46   virtual void Acknowledge(const invalidation::ObjectId& id,
  47                            const AckHandle& ack_handle) OVERRIDE {
  48     // Do nothing.
  49   }
  50
  51   virtual InvalidatorState GetInvalidatorState() const OVERRIDE {
  52     return registrar_.GetInvalidatorState();
  53   }
  54
  55   virtual void UpdateCredentials(
  56       const std::string& email, const std::string& token) OVERRIDE {
  57     // Do nothing.
  58   }
  59
  60  private:
  61   InvalidatorRegistrar registrar_;
  62
  63   DISALLOW_COPY_AND_ASSIGN(RegistrarInvalidator);
  64 };
  65
  66 class RegistrarInvalidatorTestDelegate {
  67  public:
  68   RegistrarInvalidatorTestDelegate() {}
  69
  70   ~RegistrarInvalidatorTestDelegate() {
  71     DestroyInvalidator();
  72   }
  73
  74   void CreateInvalidator(
  75       const std::string& invalidator_client_id,
  76       const std::string& initial_state,
  77       const base::WeakPtr<InvalidationStateTracker>&
  78           invalidation_state_tracker) {
  79     DCHECK(!invalidator_.get());
  80     invalidator_.reset(new RegistrarInvalidator());
  81   }
  82
  83   RegistrarInvalidator* GetInvalidator() {
  84     return invalidator_.get();
  85   }
  86
  87   void DestroyInvalidator() {
  88     invalidator_.reset();
  89   }
  90
  91   void WaitForInvalidator() {
  92     // Do nothing.
  93   }
  94
  95   void TriggerOnInvalidatorStateChange(InvalidatorState state) {
  96     invalidator_->GetRegistrar()->UpdateInvalidatorState(state);
  97   }
  98
  99   void TriggerOnIncomingInvalidation(
 100       const ObjectIdInvalidationMap& invalidation_map) {
 101     invalidator_->GetRegistrar()->DispatchInvalidationsToHandlers(
 102         invalidation_map);
 103   }
 104
 105  private:
 106   scoped_ptr<RegistrarInvalidator> invalidator_;
 107 };
 108
 109 INSTANTIATE_TYPED_TEST_CASE_P(
 110     RegistrarInvalidatorTest, InvalidatorTest,
 111     RegistrarInvalidatorTestDelegate);
 112
 113 class InvalidatorRegistrarTest : public testing::Test {};
 114
 115 // Technically the tests below can be part of InvalidatorTest, but we
 116 // want to keep the number of death tests down.
 117
 118 // When we expect a death via CHECK(), we can't match against the
 119 // CHECK() message since they are removed in official builds.
 120
 121 #if GTEST_HAS_DEATH_TEST
 122 // Having registered handlers on destruction should cause a CHECK.
 123 TEST_F(InvalidatorRegistrarTest, RegisteredHandlerOnDestruction) {
 124   scoped_ptr<InvalidatorRegistrar> registrar(new InvalidatorRegistrar());
 125   FakeInvalidationHandler handler;
 126
 127   registrar->RegisterHandler(&handler);
 128
 129   EXPECT_DEATH({ registrar.reset(); }, "");
 130
 131   ASSERT_TRUE(registrar.get());
 132   registrar->UnregisterHandler(&handler);
 133 }
 134
 135 // Multiple registrations by different handlers on the same object ID should
 136 // cause a CHECK.
 137 TEST_F(InvalidatorRegistrarTest, MultipleRegistration) {
 138   const invalidation::ObjectId id1(ipc::invalidation::ObjectSource::TEST, "a");
 139   const invalidation::ObjectId id2(ipc::invalidation::ObjectSource::TEST, "a");
 140
 141   InvalidatorRegistrar registrar;
 142
 143   FakeInvalidationHandler handler1;
 144   registrar.RegisterHandler(&handler1);
 145
 146   FakeInvalidationHandler handler2;
 147   registrar.RegisterHandler(&handler2);
 148
 149   ObjectIdSet ids;
 150   ids.insert(id1);
 151   ids.insert(id2);
 152   registrar.UpdateRegisteredIds(&handler1, ids);
 153
 154   registrar.DetachFromThreadForTest();
 155   EXPECT_DEATH({ registrar.UpdateRegisteredIds(&handler2, ids); }, "");
 156
 157   registrar.UnregisterHandler(&handler2);
 158   registrar.UnregisterHandler(&handler1);
 159 }
 160 #endif  // GTEST_HAS_DEATH_TEST
 161
 162 }  // namespace
 163
 164 }  // namespace syncer