Sync: Add DeviceInfo's ChangeProcessor

chrome/browser/sync/glue/synced_device_tracker_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 <string>
+
+#include "base/memory/scoped_ptr.h"
+#include "base/message_loop.h"
+#include "base/run_loop.h"
+#include "chrome/browser/sync/glue/device_info.h"
+#include "chrome/browser/sync/glue/synced_device_tracker.h"
+#include "sync/internal_api/public/base/model_type.h"
+#include "sync/internal_api/public/test/test_user_share.h"
+#include "sync/protocol/sync.pb.h"
+#include "sync/syncable/directory.h"
+#include "sync/test/test_transaction_observer.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace browser_sync {
+
+class SyncedDeviceTrackerTest : public ::testing::Test {
+ protected:
+  SyncedDeviceTrackerTest() : transaction_count_baseline_(0) { }
+  ~SyncedDeviceTrackerTest() { }
+
+  void SetUp() {
+    test_user_share_.SetUp();
+    syncer::TestUserShare::CreateRoot(syncer::DEVICE_INFO, user_share());
+
+    synced_device_tracker_.reset(
+        new SyncedDeviceTracker(user_share(),
+                                user_share()->directory->cache_guid()));
+
+    // We don't actually touch the Profile, so we can get away with passing in a
+    // NULL here.  Constructing a TestingProfile can take over a 100ms, so this
+    // optimization can be the difference between 'tests run with a noticeable
+    // delay' and 'tests run instantaneously'.
+    synced_device_tracker_->Start(NULL, user_share());
+  }
+
+  void TearDown() {
+    synced_device_tracker_.reset();
+    test_user_share_.TearDown();
+  }
+
+  syncer::UserShare* user_share() {
+    return test_user_share_.user_share();
+  }
+
+  // Expose the private method to our tests.
+  void WriteLocalDeviceInfo(const DeviceInfo& info) {
+    synced_device_tracker_->WriteLocalDeviceInfo(info);
+  }
+
+  void ResetObservedChangesCounter() {
+    transaction_count_baseline_ = GetTotalTransactionsCount();
+  }
+
+  int GetObservedChangesCounter() {
+    return GetTotalTransactionsCount() - transaction_count_baseline_;
+  }
+
+  scoped_ptr<SyncedDeviceTracker> synced_device_tracker_;
+
+ private:
+  // Count of how many closed WriteTransactions notified of meaningful changes.
+  int GetTotalTransactionsCount() {
+    base::RunLoop run_loop;
+    run_loop.RunUntilIdle();
+    return test_user_share_.transaction_observer()->transactions_observed();
+  }
+
+  MessageLoop message_loop_;
+  syncer::TestUserShare test_user_share_;
+  int transaction_count_baseline_;
+};
+
+namespace {
+
+// New client scenario: set device info when no previous info existed.
+TEST_F(SyncedDeviceTrackerTest, CreateNewDeviceInfo) {
+  ASSERT_FALSE(synced_device_tracker_->ReadLocalDeviceInfo());
+
+  ResetObservedChangesCounter();
+
+  DeviceInfo write_device_info(
+      "Name", "Chromium 3000", "ChromeSyncAgent 3000",
+      sync_pb::SyncEnums_DeviceType_TYPE_LINUX);
+  WriteLocalDeviceInfo(write_device_info);
+
+  scoped_ptr<DeviceInfo> read_device_info(
+      synced_device_tracker_->ReadLocalDeviceInfo());
+  ASSERT_TRUE(read_device_info);
+  EXPECT_TRUE(write_device_info.Equals(*read_device_info.get()));
+
+  EXPECT_EQ(1, GetObservedChangesCounter());
+}
+
+// Restart scenario: update existing device info with identical data.
+TEST_F(SyncedDeviceTrackerTest, DontModifyExistingDeviceInfo) {
+  // For writing.
+  DeviceInfo device_info(
+      "Name", "XYZ v1", "XYZ SyncAgent v1",
+      sync_pb::SyncEnums_DeviceType_TYPE_LINUX);
+  WriteLocalDeviceInfo(device_info);
+
+  // First read.
+  scoped_ptr<DeviceInfo> old_device_info(
+      synced_device_tracker_->ReadLocalDeviceInfo());
+  ASSERT_TRUE(old_device_info);
+
+  ResetObservedChangesCounter();
+
+  // Overwrite the device info with the same data as before.
+  WriteLocalDeviceInfo(device_info);
+
+  // Ensure that this didn't count as a change worth syncing.
+  EXPECT_EQ(0, GetObservedChangesCounter());
+
+  // Second read.
+  scoped_ptr<DeviceInfo> new_device_info(
+      synced_device_tracker_->ReadLocalDeviceInfo());
+  ASSERT_TRUE(new_device_info);
+  EXPECT_TRUE(old_device_info->Equals(*new_device_info.get()));
+}
+
+// Upgrade scenario: update existing device info with new version.
+TEST_F(SyncedDeviceTrackerTest, UpdateExistingDeviceInfo) {
+  // Write v1 device info.
+  DeviceInfo device_info_v1(
+      "Name", "XYZ v1", "XYZ SyncAgent v1",
+      sync_pb::SyncEnums_DeviceType_TYPE_LINUX);
+  WriteLocalDeviceInfo(device_info_v1);
+
+  ResetObservedChangesCounter();
+
+  // Write upgraded device info.
+  DeviceInfo device_info_v2(
+      "Name", "XYZ v2", "XYZ SyncAgent v2",
+      sync_pb::SyncEnums_DeviceType_TYPE_LINUX);
+  WriteLocalDeviceInfo(device_info_v2);
+
+  // Verify result.
+  scoped_ptr<DeviceInfo> result_device_info(
+      synced_device_tracker_->ReadLocalDeviceInfo());
+  ASSERT_TRUE(result_device_info);
+
+  EXPECT_TRUE(result_device_info->Equals(device_info_v2));
+
+  // The update write should have sent a nudge.
+  EXPECT_EQ(1, GetObservedChangesCounter());
+}
+
+}  // namespace
+
+}  // namespace browser_sync