Introduce a new framework for back-and-forth tracked/protected preferences migration.

base/prefs/json_pref_store_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 "base/prefs/json_pref_store.h"
 
+#include "base/bind.h"
 #include "base/file_util.h"
 #include "base/files/scoped_temp_dir.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/path_service.h"
 #include "base/prefs/pref_filter.h"
 #include "base/run_loop.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/string_util.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/threading/sequenced_worker_pool.h"
 #include "base/threading/thread.h"
 #include "base/values.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace base {
 namespace {
 
 const char kHomePage[] = "homepage";
 
+class TestFileReadInterceptor {
+ public:
+  TestFileReadInterceptor();
+  ~TestFileReadInterceptor();
+
+  // Tells this TestFileReadInterceptor to intercept the next file read on
+  // |json_pref_store|.
+  void InterceptNextFileReadOnPrefStore(JsonPrefStore* json_pref_store);
+
+  bool has_intercepted_prefs() const { return intercepted_prefs_ != NULL; }
+
+  // Finalize an intercepted read, handing |intercept_prefs_| back to its
+  // JsonPrefStore.
+  void FinalizeInterceptedRead();
+
+ private:
+  void OnFileRead(
+      scoped_ptr<base::DictionaryValue> prefs,
+      const JsonPrefStore::FinalizePrefsReadCallback& finalize_prefs_read);
+
+  scoped_ptr<base::DictionaryValue> intercepted_prefs_;
+  JsonPrefStore::FinalizePrefsReadCallback finalize_prefs_read_;
+
+  DISALLOW_COPY_AND_ASSIGN(TestFileReadInterceptor);
+};
+
+TestFileReadInterceptor::TestFileReadInterceptor() {}
+TestFileReadInterceptor::~TestFileReadInterceptor() {}
+
+void TestFileReadInterceptor::InterceptNextFileReadOnPrefStore(
+    JsonPrefStore* json_pref_store) {
+  json_pref_store->InterceptNextFileRead(
+      base::Bind(&TestFileReadInterceptor::OnFileRead, base::Unretained(this)));
+}
+
+void TestFileReadInterceptor::FinalizeInterceptedRead() {
+  EXPECT_FALSE(finalize_prefs_read_.is_null());
+  finalize_prefs_read_.Run(intercepted_prefs_.Pass(), false);
+}
+
+void TestFileReadInterceptor::OnFileRead(
+    scoped_ptr<base::DictionaryValue> prefs,
+    const JsonPrefStore::FinalizePrefsReadCallback& finalize_prefs_read) {
+  intercepted_prefs_ = prefs.Pass();
+  finalize_prefs_read_ = finalize_prefs_read;
+}
+
 class MockPrefStoreObserver : public PrefStore::Observer {
  public:
   MOCK_METHOD1(OnPrefValueChanged, void (const std::string&));
   MOCK_METHOD1(OnInitializationCompleted, void (bool));
 };
 
 class MockReadErrorDelegate : public PersistentPrefStore::ReadErrorDelegate {
  public:
   MOCK_METHOD1(OnError, void(PersistentPrefStore::PrefReadError));
 };
 
 }  // namespace
 
 class JsonPrefStoreTest : public testing::Test {
  protected:
   virtual void SetUp() OVERRIDE {
     ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
 
     ASSERT_TRUE(PathService::Get(base::DIR_TEST_DATA, &data_dir_));
     data_dir_ = data_dir_.AppendASCII("prefs");
     ASSERT_TRUE(PathExists(data_dir_));
   }
 
+  TestFileReadInterceptor file_read_interceptor_;
+
   // The path to temporary directory used to contain the test operations.
   base::ScopedTempDir temp_dir_;
   // The path to the directory where the test data is stored.
   base::FilePath data_dir_;
   // A message loop that we can use as the file thread message loop.
   MessageLoop message_loop_;
 };
 
 // Test fallback behavior for a nonexistent file.
 TEST_F(JsonPrefStoreTest, NonExistentFile) {
@@ skipping 89 matching lines @@
   // Serialize and compare to expected output.
   ASSERT_TRUE(PathExists(golden_output_file));
   pref_store->CommitPendingWrite();
   RunLoop().RunUntilIdle();
   EXPECT_TRUE(TextContentsEqual(golden_output_file, output_file));
   ASSERT_TRUE(base::DeleteFile(output_file, false));
 }
 
 TEST_F(JsonPrefStoreTest, Basic) {
   ASSERT_TRUE(base::CopyFile(data_dir_.AppendASCII("read.json"),
-                                  temp_dir_.path().AppendASCII("write.json")));
+                             temp_dir_.path().AppendASCII("write.json")));
 
   // Test that the persistent value can be loaded.
   base::FilePath input_file = temp_dir_.path().AppendASCII("write.json");
   ASSERT_TRUE(PathExists(input_file));
   scoped_refptr<JsonPrefStore> pref_store = new JsonPrefStore(
       input_file,
       message_loop_.message_loop_proxy().get(),
       scoped_ptr<PrefFilter>());
   ASSERT_EQ(PersistentPrefStore::PREF_READ_ERROR_NONE, pref_store->ReadPrefs());
-  ASSERT_FALSE(pref_store->ReadOnly());
+  EXPECT_FALSE(pref_store->ReadOnly());
+  EXPECT_FALSE(file_read_interceptor_.has_intercepted_prefs());
+  EXPECT_TRUE(pref_store->IsInitializationComplete());
 
   // The JSON file looks like this:
   // {
   //   "homepage": "http://www.cnn.com",
   //   "some_directory": "/usr/local/",
   //   "tabs": {
   //     "new_windows_in_tabs": true,
   //     "max_tabs": 20
   //   }
   // }
 
   RunBasicJsonPrefStoreTest(
       pref_store.get(), input_file, data_dir_.AppendASCII("write.golden.json"));
 }
 
 TEST_F(JsonPrefStoreTest, BasicAsync) {
   ASSERT_TRUE(base::CopyFile(data_dir_.AppendASCII("read.json"),
-                                  temp_dir_.path().AppendASCII("write.json")));
+                             temp_dir_.path().AppendASCII("write.json")));
 
   // Test that the persistent value can be loaded.
   base::FilePath input_file = temp_dir_.path().AppendASCII("write.json");
   ASSERT_TRUE(PathExists(input_file));
   scoped_refptr<JsonPrefStore> pref_store = new JsonPrefStore(
       input_file,
       message_loop_.message_loop_proxy().get(),
       scoped_ptr<PrefFilter>());
 
   {
     MockPrefStoreObserver mock_observer;
     pref_store->AddObserver(&mock_observer);
 
     MockReadErrorDelegate* mock_error_delegate = new MockReadErrorDelegate;
     pref_store->ReadPrefsAsync(mock_error_delegate);
 
     EXPECT_CALL(mock_observer, OnInitializationCompleted(true)).Times(1);
     EXPECT_CALL(*mock_error_delegate,
                 OnError(PersistentPrefStore::PREF_READ_ERROR_NONE)).Times(0);
     RunLoop().RunUntilIdle();
     pref_store->RemoveObserver(&mock_observer);
 
-    ASSERT_FALSE(pref_store->ReadOnly());
+    EXPECT_FALSE(pref_store->ReadOnly());
+    EXPECT_FALSE(file_read_interceptor_.has_intercepted_prefs());
+    EXPECT_TRUE(pref_store->IsInitializationComplete());
   }
 
   // The JSON file looks like this:
   // {
   //   "homepage": "http://www.cnn.com",
   //   "some_directory": "/usr/local/",
   //   "tabs": {
   //     "new_windows_in_tabs": true,
   //     "max_tabs": 20
   //   }
@@ skipping 72 matching lines @@
 
   EXPECT_CALL(mock_observer, OnInitializationCompleted(true)).Times(1);
   EXPECT_CALL(*mock_error_delegate,
               OnError(PersistentPrefStore::PREF_READ_ERROR_NO_FILE)).Times(1);
   RunLoop().RunUntilIdle();
   pref_store->RemoveObserver(&mock_observer);
 
   EXPECT_FALSE(pref_store->ReadOnly());
 }
 
+TEST_F(JsonPrefStoreTest, ReadWithInterceptor) {
+  ASSERT_TRUE(base::CopyFile(data_dir_.AppendASCII("read.json"),
+                             temp_dir_.path().AppendASCII("write.json")));
+
+  // Test that the persistent value can be loaded.
+  base::FilePath input_file = temp_dir_.path().AppendASCII("write.json");
+  ASSERT_TRUE(PathExists(input_file));
+  scoped_refptr<JsonPrefStore> pref_store = new JsonPrefStore(
+      input_file,
+      message_loop_.message_loop_proxy().get(),
+      scoped_ptr<PrefFilter>());
+  file_read_interceptor_.InterceptNextFileReadOnPrefStore(pref_store);
+
+  ASSERT_EQ(PersistentPrefStore::PREF_READ_ERROR_NONE, pref_store->ReadPrefs());
+  EXPECT_FALSE(pref_store->ReadOnly());
+
+  // The store shouldn't be considered initialized until the interceptor
+  // returns.
+  EXPECT_TRUE(file_read_interceptor_.has_intercepted_prefs());
+  EXPECT_FALSE(pref_store->IsInitializationComplete());
+  EXPECT_FALSE(pref_store->GetValue(kHomePage, NULL));
+
+  file_read_interceptor_.FinalizeInterceptedRead();
+
+  EXPECT_FALSE(file_read_interceptor_.has_intercepted_prefs());
+  EXPECT_TRUE(pref_store->IsInitializationComplete());
+  EXPECT_TRUE(pref_store->GetValue(kHomePage, NULL));
+
+  // The JSON file looks like this:
+  // {
+  //   "homepage": "http://www.cnn.com",
+  //   "some_directory": "/usr/local/",
+  //   "tabs": {
+  //     "new_windows_in_tabs": true,
+  //     "max_tabs": 20
+  //   }
+  // }
+
+  RunBasicJsonPrefStoreTest(
+      pref_store.get(), input_file, data_dir_.AppendASCII("write.golden.json"));
+}
+
+TEST_F(JsonPrefStoreTest, ReadAsyncWithInterceptor) {
+  ASSERT_TRUE(base::CopyFile(data_dir_.AppendASCII("read.json"),
+                             temp_dir_.path().AppendASCII("write.json")));
+
+  // Test that the persistent value can be loaded.
+  base::FilePath input_file = temp_dir_.path().AppendASCII("write.json");
+  ASSERT_TRUE(PathExists(input_file));
+  scoped_refptr<JsonPrefStore> pref_store = new JsonPrefStore(
+      input_file,
+      message_loop_.message_loop_proxy().get(),
+      scoped_ptr<PrefFilter>());
+  file_read_interceptor_.InterceptNextFileReadOnPrefStore(pref_store);
+
+  MockPrefStoreObserver mock_observer;
+  pref_store->AddObserver(&mock_observer);
+
+  // Ownership of the |mock_error_delegate| is handed to the |pref_store| below.
+  MockReadErrorDelegate* mock_error_delegate = new MockReadErrorDelegate;
+
+  {
+    pref_store->ReadPrefsAsync(mock_error_delegate);
+
+    EXPECT_CALL(mock_observer, OnInitializationCompleted(true)).Times(0);
+    EXPECT_CALL(*mock_error_delegate,
+                OnError(PersistentPrefStore::PREF_READ_ERROR_NONE)).Times(0);
+    RunLoop().RunUntilIdle();
+
+    EXPECT_FALSE(pref_store->ReadOnly());
+    EXPECT_TRUE(file_read_interceptor_.has_intercepted_prefs());
+    EXPECT_FALSE(pref_store->IsInitializationComplete());
+    EXPECT_FALSE(pref_store->GetValue(kHomePage, NULL));
+  }
+
+  {
+    EXPECT_CALL(mock_observer, OnInitializationCompleted(true)).Times(1);
+    EXPECT_CALL(*mock_error_delegate,
+                OnError(PersistentPrefStore::PREF_READ_ERROR_NONE)).Times(0);
+
+    file_read_interceptor_.FinalizeInterceptedRead();
+
+    EXPECT_FALSE(pref_store->ReadOnly());
+    EXPECT_FALSE(file_read_interceptor_.has_intercepted_prefs());
+    EXPECT_TRUE(pref_store->IsInitializationComplete());
+    EXPECT_TRUE(pref_store->GetValue(kHomePage, NULL));
+  }
+
+  pref_store->RemoveObserver(&mock_observer);
+
+  // The JSON file looks like this:
+  // {
+  //   "homepage": "http://www.cnn.com",
+  //   "some_directory": "/usr/local/",
+  //   "tabs": {
+  //     "new_windows_in_tabs": true,
+  //     "max_tabs": 20
+  //   }
+  // }
+
+  RunBasicJsonPrefStoreTest(
+      pref_store.get(), input_file, data_dir_.AppendASCII("write.golden.json"));
+}
+
+TEST_F(JsonPrefStoreTest, MultipleReadsResultInASingleIntercept) {
+  ASSERT_TRUE(base::CopyFile(data_dir_.AppendASCII("read.json"),
+                             temp_dir_.path().AppendASCII("write.json")));
+
+  // Test that the persistent value can be loaded.
+  base::FilePath input_file = temp_dir_.path().AppendASCII("write.json");
+  ASSERT_TRUE(PathExists(input_file));
+  scoped_refptr<JsonPrefStore> pref_store = new JsonPrefStore(
+      input_file,
+      message_loop_.message_loop_proxy().get(),
+      scoped_ptr<PrefFilter>());
+  file_read_interceptor_.InterceptNextFileReadOnPrefStore(pref_store);
+
+  ASSERT_EQ(PersistentPrefStore::PREF_READ_ERROR_NONE, pref_store->ReadPrefs());
+  EXPECT_TRUE(file_read_interceptor_.has_intercepted_prefs());
+  file_read_interceptor_.FinalizeInterceptedRead();
+  EXPECT_FALSE(file_read_interceptor_.has_intercepted_prefs());
+
+  // Read again; expect no intercepts.
+  ASSERT_EQ(PersistentPrefStore::PREF_READ_ERROR_NONE, pref_store->ReadPrefs());
+  EXPECT_FALSE(pref_store->ReadOnly());
+  EXPECT_FALSE(file_read_interceptor_.has_intercepted_prefs());
+  EXPECT_TRUE(pref_store->IsInitializationComplete());
+  EXPECT_TRUE(pref_store->GetValue(kHomePage, NULL));
+
+  // The JSON file looks like this:
+  // {
+  //   "homepage": "http://www.cnn.com",
+  //   "some_directory": "/usr/local/",
+  //   "tabs": {
+  //     "new_windows_in_tabs": true,
+  //     "max_tabs": 20
+  //   }
+  // }
+
+  RunBasicJsonPrefStoreTest(
+      pref_store.get(), input_file, data_dir_.AppendASCII("write.golden.json"));
+}
+
 }  // namespace base