chrome/browser/sync/glue/device_info_sync_service_unittest.cc

   1 // Copyright 2014 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/message_loop/message_loop.h"
   6 #include "chrome/browser/sync/glue/device_info_sync_service.h"
   7 #include "chrome/browser/sync/glue/local_device_info_provider_mock.h"
   8 #include "content/public/test/test_browser_thread_bundle.h"
   9 #include "sync/api/sync_change.h"
  10 #include "sync/api/sync_change_processor.h"
  11 #include "sync/api/sync_change_processor_wrapper_for_test.h"
  12 #include "sync/api/sync_error_factory_mock.h"
  13 #include "sync/internal_api/public/attachments/attachment_service_proxy_for_test.h"
  14 #include "testing/gtest/include/gtest/gtest.h"
  15
  16 using syncer::AttachmentIdList;
  17 using syncer::AttachmentServiceProxyForTest;
  18 using syncer::ModelType;
  19 using syncer::SyncChange;
  20 using syncer::SyncChangeList;
  21 using syncer::SyncChangeProcessor;
  22 using syncer::SyncChangeProcessorWrapperForTest;
  23 using syncer::SyncData;
  24 using syncer::SyncDataList;
  25 using syncer::SyncError;
  26 using syncer::SyncErrorFactory;
  27 using syncer::SyncErrorFactoryMock;
  28 using syncer::SyncMergeResult;
  29
  30 namespace browser_sync {
  31
  32 namespace {
  33
  34 class TestChangeProcessor : public SyncChangeProcessor {
  35  public:
  36   TestChangeProcessor() {}
  37   virtual ~TestChangeProcessor() {}
  38
  39   // SyncChangeProcessor implementation.
  40   // Store a copy of all the changes passed in so we can examine them later.
  41   virtual SyncError ProcessSyncChanges(
  42       const tracked_objects::Location& from_here,
  43       const SyncChangeList& change_list) OVERRIDE {
  44     change_list_ = change_list;
  45     return SyncError();
  46   }
  47
  48   // This method isn't used in these tests.
  49   virtual SyncDataList GetAllSyncData(ModelType type) const OVERRIDE {
  50     return SyncDataList();
  51   }
  52
  53   size_t change_list_size() const { return change_list_.size(); }
  54
  55   SyncChange::SyncChangeType change_type_at(size_t index) const {
  56     CHECK_LT(index, change_list_size());
  57     return change_list_[index].change_type();
  58   }
  59
  60   const sync_pb::DeviceInfoSpecifics& device_info_at(size_t index) const {
  61     CHECK_LT(index, change_list_size());
  62     return change_list_[index].sync_data().GetSpecifics().device_info();
  63   }
  64
  65   const std::string& cache_guid_at(size_t index) const {
  66     return device_info_at(index).cache_guid();
  67   }
  68
  69   const std::string& client_name_at(size_t index) const {
  70     return device_info_at(index).client_name();
  71   }
  72
  73  private:
  74   SyncChangeList change_list_;
  75 };
  76
  77 class DeviceInfoSyncServiceTest : public testing::Test,
  78                                   public DeviceInfoTracker::Observer {
  79  public:
  80   DeviceInfoSyncServiceTest() : num_device_info_changed_callbacks_(0) {}
  81   virtual ~DeviceInfoSyncServiceTest() {}
  82
  83   virtual void SetUp() OVERRIDE {
  84     local_device_.reset(new LocalDeviceInfoProviderMock(
  85         "guid_1",
  86         "client_1",
  87         "Chromium 10k",
  88         "Chrome 10k",
  89         sync_pb::SyncEnums_DeviceType_TYPE_LINUX,
  90         "device_id"));
  91     sync_service_.reset(new DeviceInfoSyncService(local_device_.get()));
  92     sync_processor_.reset(new TestChangeProcessor());
  93     // Register observer
  94     sync_service_->AddObserver(this);
  95   }
  96
  97   virtual void TearDown() OVERRIDE {
  98     sync_service_->RemoveObserver(this);
  99   }
 100
 101   virtual void OnDeviceInfoChange() OVERRIDE {
 102     num_device_info_changed_callbacks_++;
 103   }
 104
 105   scoped_ptr<SyncChangeProcessor> PassProcessor() {
 106     return scoped_ptr<SyncChangeProcessor>(
 107         new SyncChangeProcessorWrapperForTest(sync_processor_.get()));
 108   }
 109
 110   scoped_ptr<SyncErrorFactory> CreateAndPassSyncErrorFactory() {
 111     return scoped_ptr<SyncErrorFactory>(new SyncErrorFactoryMock());
 112   }
 113
 114   SyncData CreateRemoteData(const std::string& client_id,
 115                             const std::string& client_name) {
 116     sync_pb::EntitySpecifics entity;
 117     sync_pb::DeviceInfoSpecifics& specifics = *entity.mutable_device_info();
 118
 119     specifics.set_cache_guid(client_id);
 120     specifics.set_client_name(client_name);
 121     specifics.set_chrome_version("Chromium 10k");
 122     specifics.set_sync_user_agent("Chrome 10k");
 123     specifics.set_device_type(sync_pb::SyncEnums_DeviceType_TYPE_LINUX);
 124     specifics.set_signin_scoped_device_id("device_id");
 125
 126     return SyncData::CreateRemoteData(1,
 127                                       entity,
 128                                       base::Time(),
 129                                       AttachmentIdList(),
 130                                       AttachmentServiceProxyForTest::Create());
 131   }
 132
 133   void AddInitialData(SyncDataList& sync_data_list,
 134                       const std::string& client_id,
 135                       const std::string& client_name) {
 136     SyncData sync_data = CreateRemoteData(client_id, client_name);
 137     sync_data_list.push_back(sync_data);
 138   }
 139
 140   void AddChange(SyncChangeList& change_list,
 141                  SyncChange::SyncChangeType change_type,
 142                  const std::string& client_id,
 143                  const std::string& client_name) {
 144     SyncData sync_data = CreateRemoteData(client_id, client_name);
 145     SyncChange sync_change(FROM_HERE, change_type, sync_data);
 146     change_list.push_back(sync_change);
 147   }
 148
 149  protected:
 150   int num_device_info_changed_callbacks_;
 151   scoped_ptr<LocalDeviceInfoProviderMock> local_device_;
 152   scoped_ptr<DeviceInfoSyncService> sync_service_;
 153   scoped_ptr<TestChangeProcessor> sync_processor_;
 154   content::TestBrowserThreadBundle thread_bundle_;
 155 };
 156
 157 // Sync with empty initial data.
 158 TEST_F(DeviceInfoSyncServiceTest, StartSyncEmptyInitialData) {
 159   SyncMergeResult merge_result =
 160       sync_service_->MergeDataAndStartSyncing(syncer::DEVICE_INFO,
 161                                               SyncDataList(),
 162                                               PassProcessor(),
 163                                               CreateAndPassSyncErrorFactory());
 164
 165   EXPECT_EQ(0, merge_result.num_items_added());
 166   EXPECT_EQ(0, merge_result.num_items_modified());
 167   EXPECT_EQ(0, merge_result.num_items_deleted());
 168   EXPECT_EQ(1, merge_result.num_items_before_association());
 169   EXPECT_EQ(1, merge_result.num_items_after_association());
 170   EXPECT_EQ(SyncChange::ACTION_ADD, sync_processor_->change_type_at(0));
 171
 172   EXPECT_EQ(1U, sync_processor_->change_list_size());
 173   EXPECT_EQ("guid_1", sync_processor_->cache_guid_at(0));
 174
 175   // Should have one device info corresponding to local device info.
 176   EXPECT_EQ(1U, sync_service_->GetAllSyncData(syncer::DEVICE_INFO).size());
 177   EXPECT_EQ(1U, sync_service_->GetAllDeviceInfo().size());
 178   EXPECT_TRUE(sync_service_->GetDeviceInfo("guid_1"));
 179   EXPECT_FALSE(sync_service_->GetDeviceInfo("guid_0"));
 180 }
 181
 182 // Sync with initial data matching the local device data.
 183 TEST_F(DeviceInfoSyncServiceTest, StartSyncMatchingInitialData) {
 184   SyncDataList sync_data;
 185   AddInitialData(sync_data, "guid_1", "client_1");
 186
 187   SyncMergeResult merge_result =
 188       sync_service_->MergeDataAndStartSyncing(syncer::DEVICE_INFO,
 189                                               sync_data,
 190                                               PassProcessor(),
 191                                               CreateAndPassSyncErrorFactory());
 192   EXPECT_EQ(0, merge_result.num_items_added());
 193   EXPECT_EQ(0, merge_result.num_items_modified());
 194   EXPECT_EQ(0, merge_result.num_items_deleted());
 195   EXPECT_EQ(1, merge_result.num_items_before_association());
 196   EXPECT_EQ(1, merge_result.num_items_after_association());
 197
 198   // No changes expected because the device info matches.
 199   EXPECT_EQ(0U, sync_processor_->change_list_size());
 200
 201   EXPECT_EQ(1U, sync_service_->GetAllSyncData(syncer::DEVICE_INFO).size());
 202   EXPECT_EQ(1U, sync_service_->GetAllDeviceInfo().size());
 203   EXPECT_TRUE(sync_service_->GetDeviceInfo("guid_1"));
 204   EXPECT_FALSE(sync_service_->GetDeviceInfo("guid_0"));
 205 }
 206
 207 // Sync with misc initial data.
 208 TEST_F(DeviceInfoSyncServiceTest, StartSync) {
 209   SyncDataList sync_data;
 210   AddInitialData(sync_data, "guid_2", "foo");
 211   AddInitialData(sync_data, "guid_3", "bar");
 212   // This guid matches the local device but the client name is different.
 213   AddInitialData(sync_data, "guid_1", "baz");
 214
 215   SyncMergeResult merge_result =
 216       sync_service_->MergeDataAndStartSyncing(syncer::DEVICE_INFO,
 217                                               sync_data,
 218                                               PassProcessor(),
 219                                               CreateAndPassSyncErrorFactory());
 220
 221   EXPECT_EQ(2, merge_result.num_items_added());
 222   EXPECT_EQ(1, merge_result.num_items_modified());
 223   EXPECT_EQ(0, merge_result.num_items_deleted());
 224   EXPECT_EQ(1, merge_result.num_items_before_association());
 225   EXPECT_EQ(3, merge_result.num_items_after_association());
 226
 227   EXPECT_EQ(1U, sync_processor_->change_list_size());
 228   EXPECT_EQ(SyncChange::ACTION_UPDATE, sync_processor_->change_type_at(0));
 229   EXPECT_EQ("client_1", sync_processor_->client_name_at(0));
 230
 231   EXPECT_EQ(3U, sync_service_->GetAllSyncData(syncer::DEVICE_INFO).size());
 232   EXPECT_EQ(3U, sync_service_->GetAllDeviceInfo().size());
 233   EXPECT_TRUE(sync_service_->GetDeviceInfo("guid_1"));
 234   EXPECT_TRUE(sync_service_->GetDeviceInfo("guid_2"));
 235   EXPECT_TRUE(sync_service_->GetDeviceInfo("guid_3"));
 236   EXPECT_FALSE(sync_service_->GetDeviceInfo("guid_0"));
 237 }
 238
 239 // Process sync change with ACTION_ADD.
 240 // Verify callback.
 241 TEST_F(DeviceInfoSyncServiceTest, ProcessAddChange) {
 242   EXPECT_EQ(0, num_device_info_changed_callbacks_);
 243
 244   // Start with an empty initial data.
 245   SyncMergeResult merge_result =
 246       sync_service_->MergeDataAndStartSyncing(syncer::DEVICE_INFO,
 247                                               SyncDataList(),
 248                                               PassProcessor(),
 249                                               CreateAndPassSyncErrorFactory());
 250   // There should be only one item corresponding to the local device
 251   EXPECT_EQ(1, merge_result.num_items_after_association());
 252   EXPECT_EQ(1, num_device_info_changed_callbacks_);
 253
 254   // Add a new device info with a non-matching guid.
 255   SyncChangeList change_list;
 256   AddChange(change_list, SyncChange::ACTION_ADD, "guid_2", "foo");
 257
 258   SyncError error = sync_service_->ProcessSyncChanges(FROM_HERE, change_list);
 259   EXPECT_FALSE(error.IsSet());
 260   EXPECT_EQ(2, num_device_info_changed_callbacks_);
 261
 262   EXPECT_EQ(2U, sync_service_->GetAllDeviceInfo().size());
 263
 264   EXPECT_TRUE(sync_service_->GetDeviceInfo("guid_1"));
 265   EXPECT_TRUE(sync_service_->GetDeviceInfo("guid_2"));
 266   EXPECT_FALSE(sync_service_->GetDeviceInfo("guid_0"));
 267 }
 268
 269 // Process multiple sync change with ACTION_UPDATE and ACTION_ADD.
 270 // Verify that callback is called multiple times.
 271 TEST_F(DeviceInfoSyncServiceTest, ProcessMultipleChanges) {
 272   SyncDataList sync_data;
 273   AddInitialData(sync_data, "guid_2", "foo");
 274   AddInitialData(sync_data, "guid_3", "bar");
 275
 276   SyncMergeResult merge_result =
 277       sync_service_->MergeDataAndStartSyncing(syncer::DEVICE_INFO,
 278                                               sync_data,
 279                                               PassProcessor(),
 280                                               CreateAndPassSyncErrorFactory());
 281   EXPECT_EQ(3, merge_result.num_items_after_association());
 282   // reset callbacks counter
 283   num_device_info_changed_callbacks_ = 0;
 284
 285   SyncChangeList change_list;
 286   AddChange(change_list, SyncChange::ACTION_UPDATE, "guid_2", "foo_2");
 287
 288   SyncError error = sync_service_->ProcessSyncChanges(FROM_HERE, change_list);
 289   EXPECT_FALSE(error.IsSet());
 290
 291   EXPECT_EQ(1, num_device_info_changed_callbacks_);
 292   EXPECT_EQ(3U, sync_service_->GetAllDeviceInfo().size());
 293   EXPECT_EQ("foo_2", sync_service_->GetDeviceInfo("guid_2")->client_name());
 294
 295   change_list.clear();
 296   AddChange(change_list, SyncChange::ACTION_UPDATE, "guid_3", "bar_3");
 297   AddChange(change_list, SyncChange::ACTION_ADD, "guid_4", "baz_4");
 298
 299   error = sync_service_->ProcessSyncChanges(FROM_HERE, change_list);
 300   EXPECT_FALSE(error.IsSet());
 301
 302   EXPECT_EQ(2, num_device_info_changed_callbacks_);
 303   EXPECT_EQ(4U, sync_service_->GetAllDeviceInfo().size());
 304   EXPECT_EQ("bar_3", sync_service_->GetDeviceInfo("guid_3")->client_name());
 305   EXPECT_EQ("baz_4", sync_service_->GetDeviceInfo("guid_4")->client_name());
 306 }
 307
 308 // Process update to the local device info and verify that it is ignored.
 309 TEST_F(DeviceInfoSyncServiceTest, ProcessUpdateChangeMatchingLocalDevice) {
 310   SyncMergeResult merge_result =
 311       sync_service_->MergeDataAndStartSyncing(syncer::DEVICE_INFO,
 312                                               SyncDataList(),
 313                                               PassProcessor(),
 314                                               CreateAndPassSyncErrorFactory());
 315   EXPECT_EQ(1, merge_result.num_items_after_association());
 316   // reset callbacks counter
 317   num_device_info_changed_callbacks_ = 0;
 318
 319   SyncChangeList change_list;
 320   AddChange(change_list, SyncChange::ACTION_UPDATE, "guid_1", "foo_1");
 321
 322   SyncError error = sync_service_->ProcessSyncChanges(FROM_HERE, change_list);
 323   EXPECT_FALSE(error.IsSet());
 324   // Callback shouldn't be sent in this case.
 325   EXPECT_EQ(0, num_device_info_changed_callbacks_);
 326   // Should still have the old local device Info.
 327   EXPECT_EQ(1U, sync_service_->GetAllDeviceInfo().size());
 328   EXPECT_EQ("client_1", sync_service_->GetDeviceInfo("guid_1")->client_name());
 329 }
 330
 331 // Process sync change with ACTION_DELETE.
 332 TEST_F(DeviceInfoSyncServiceTest, ProcessDeleteChange) {
 333   SyncDataList sync_data;
 334   AddInitialData(sync_data, "guid_2", "foo");
 335   AddInitialData(sync_data, "guid_3", "bar");
 336
 337   SyncMergeResult merge_result =
 338       sync_service_->MergeDataAndStartSyncing(syncer::DEVICE_INFO,
 339                                               sync_data,
 340                                               PassProcessor(),
 341                                               CreateAndPassSyncErrorFactory());
 342   EXPECT_EQ(3, merge_result.num_items_after_association());
 343   // reset callbacks counter
 344   num_device_info_changed_callbacks_ = 0;
 345
 346   SyncChangeList change_list;
 347   AddChange(change_list, SyncChange::ACTION_DELETE, "guid_2", "foo_2");
 348
 349   SyncError error = sync_service_->ProcessSyncChanges(FROM_HERE, change_list);
 350   EXPECT_FALSE(error.IsSet());
 351
 352   EXPECT_EQ(1, num_device_info_changed_callbacks_);
 353   EXPECT_EQ(2U, sync_service_->GetAllDeviceInfo().size());
 354   EXPECT_FALSE(sync_service_->GetDeviceInfo("guid_2"));
 355 }
 356
 357 // Process sync change with unexpected action.
 358 TEST_F(DeviceInfoSyncServiceTest, ProcessInvalidChange) {
 359   SyncMergeResult merge_result =
 360       sync_service_->MergeDataAndStartSyncing(syncer::DEVICE_INFO,
 361                                               SyncDataList(),
 362                                               PassProcessor(),
 363                                               CreateAndPassSyncErrorFactory());
 364   EXPECT_EQ(1, merge_result.num_items_after_association());
 365   // reset callbacks counter
 366   num_device_info_changed_callbacks_ = 0;
 367
 368   SyncChangeList change_list;
 369   AddChange(change_list, (SyncChange::SyncChangeType)100, "guid_2", "foo_2");
 370
 371   SyncError error = sync_service_->ProcessSyncChanges(FROM_HERE, change_list);
 372   EXPECT_TRUE(error.IsSet());
 373
 374   // The number of callback should still be zero.
 375   EXPECT_EQ(0, num_device_info_changed_callbacks_);
 376   EXPECT_EQ(1U, sync_service_->GetAllDeviceInfo().size());
 377 }
 378
 379 // Process sync change after unsubscribing from notifications.
 380 TEST_F(DeviceInfoSyncServiceTest, ProcessChangesAfterUnsubscribing) {
 381   SyncMergeResult merge_result =
 382       sync_service_->MergeDataAndStartSyncing(syncer::DEVICE_INFO,
 383                                               SyncDataList(),
 384                                               PassProcessor(),
 385                                               CreateAndPassSyncErrorFactory());
 386   EXPECT_EQ(1, merge_result.num_items_after_association());
 387   // reset callbacks counter
 388   num_device_info_changed_callbacks_ = 0;
 389
 390   SyncChangeList change_list;
 391   AddChange(change_list, SyncChange::ACTION_ADD, "guid_2", "foo_2");
 392
 393   // Unsubscribe observer before processing changes.
 394   sync_service_->RemoveObserver(this);
 395
 396   SyncError error = sync_service_->ProcessSyncChanges(FROM_HERE, change_list);
 397   EXPECT_FALSE(error.IsSet());
 398
 399   // The number of callback should still be zero.
 400   EXPECT_EQ(0, num_device_info_changed_callbacks_);
 401 }
 402
 403 }  // namespace
 404
 405 }  // namespace browser_sync