Implementation of leveldb-backed PrefStore

base/prefs/leveldb_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/leveldb_pref_store.h"
+
+#include "base/file_util.h"
+#include "base/files/scoped_temp_dir.h"
+#include "base/memory/scoped_ptr.h"
+#include "base/message_loop/message_loop.h"
+#include "base/path_service.h"
+#include "base/prefs/pref_filter.h"

[Mattias Nissler (ping if slow), 2014/03/20 09:32:25]

used?

[dgrogan, 2014/04/12 00:32:45]

Removed.

+#include "base/run_loop.h"
+#include "base/values.h"
+#include "testing/gmock/include/gmock/gmock.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace base {
+namespace {
+
+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 LevelDBPrefStoreTest : 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_));
+  }
+
+  void Open() {
+    pref_store_ = new LevelDBPrefStore(
+        temp_dir_.path(), message_loop_.message_loop_proxy().get());
+    EXPECT_EQ(LevelDBPrefStore::PREF_READ_ERROR_NONE, pref_store_->ReadPrefs());
+  }
+
+  void Close() {
+    pref_store_ = NULL;
+    RunLoop().RunUntilIdle();
+  }
+
+  void CloseAndReopen() {
+    Close();
+    Open();
+  }
+
+  // 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 in the source tree.
+  base::FilePath data_dir_;
+  // A message loop that we can use as the file thread message loop.
+  MessageLoop message_loop_;
+
+  scoped_refptr<LevelDBPrefStore> pref_store_;
+};
+
+TEST_F(LevelDBPrefStoreTest, PutAndGet) {
+  Open();
+  const std::string key = "some.key";
+  pref_store_->SetValue(key, new FundamentalValue(5));

[Mattias Nissler (ping if slow), 2014/03/20 09:32:25]

Might want to put a GetValue check here before running the loop - the new value
should be visible immediately.

[dgrogan, 2014/04/12 00:32:45]

Removed the RunUntilIdle completely, it wasn't serving any purpose.

+  RunLoop().RunUntilIdle();
+  FundamentalValue orig_value(5);
+  const base::Value* actual_value;
+  EXPECT_TRUE(pref_store_->GetValue(key, &actual_value));
+  EXPECT_TRUE(orig_value.Equals(actual_value));
+}
+
+TEST_F(LevelDBPrefStoreTest, PutAndGetPersistent) {
+  Open();
+  const std::string key = "some.key";
+  pref_store_->SetValue(key, new FundamentalValue(5));
+  RunLoop().RunUntilIdle();
+
+  CloseAndReopen();
+  const base::Value* actual_value = NULL;
+  FundamentalValue orig_value(5);
+  EXPECT_TRUE(pref_store_->GetValue(key, &actual_value));
+  EXPECT_TRUE(orig_value.Equals(actual_value));
+}
+
+TEST_F(LevelDBPrefStoreTest, BasicObserver) {
+  scoped_refptr<LevelDBPrefStore> pref_store = new LevelDBPrefStore(
+      temp_dir_.path(), message_loop_.message_loop_proxy().get());
+  MockPrefStoreObserver mock_observer;
+  pref_store->AddObserver(&mock_observer);
+  EXPECT_CALL(mock_observer, OnInitializationCompleted(true)).Times(1);
+  EXPECT_EQ(PersistentPrefStore::PREF_READ_ERROR_NONE, pref_store->ReadPrefs());
+  testing::Mock::VerifyAndClearExpectations(&mock_observer);
+
+  const std::string key = "some.key";
+  EXPECT_CALL(mock_observer, OnPrefValueChanged(key)).Times(1);
+  pref_store->SetValue(key, new FundamentalValue(5));
+
+  pref_store->RemoveObserver(&mock_observer);
+}
+
+TEST_F(LevelDBPrefStoreTest, SetValueSilently) {
+  Open();
+
+  MockPrefStoreObserver mock_observer;
+  pref_store_->AddObserver(&mock_observer);
+  const std::string key = "some.key";
+  EXPECT_CALL(mock_observer, OnPrefValueChanged(key)).Times(0);
+  pref_store_->SetValueSilently(key, new FundamentalValue(30));
+  RunLoop().RunUntilIdle();
+  pref_store_->RemoveObserver(&mock_observer);
+
+  CloseAndReopen();
+  FundamentalValue value(30);
+  const base::Value* actual_value = NULL;
+  EXPECT_TRUE(pref_store_->GetValue(key, &actual_value));
+  EXPECT_TRUE(base::Value::Equals(&value, actual_value));
+}
+
+TEST_F(LevelDBPrefStoreTest, GetMutableValue) {
+  Open();
+
+  const std::string key = "some.key";
+  base::DictionaryValue* orig_value = new DictionaryValue;
+  orig_value->SetInteger("key2", 25);
+  pref_store_->SetValue(key, orig_value);
+  base::Value* actual_value;
+
+  EXPECT_TRUE(pref_store_->GetMutableValue(key, &actual_value));
+  EXPECT_TRUE(orig_value->Equals(actual_value));
+  base::DictionaryValue* dict_value =
+      static_cast<base::DictionaryValue*>(actual_value);
+  dict_value->SetInteger("key2", 30);
+  pref_store_->ReportValueChanged(key);
+  RunLoop().RunUntilIdle();
+
+  // Ensure the new value is stored in memory.
+  const base::Value* retrieved_value;
+  EXPECT_TRUE(pref_store_->GetValue(key, &retrieved_value));

[Mattias Nissler (ping if slow), 2014/03/20 09:32:25]

Suggestion: Instead of decoding the dictionary by hand below, it may be easier
to just keep a dictionary in the expected state and call
EXPECT_TRUE(Value::Equals())

[dgrogan, 2014/04/12 00:32:45]

Done.

+  const base::DictionaryValue* dictionary;
+  EXPECT_TRUE(retrieved_value->GetAsDictionary(&dictionary));

[Mattias Nissler (ping if slow), 2014/03/20 09:32:25]

This should be ASSERT_TRUE() (here and below), the test will crash otherwise if
|dictionary| is not valid below.

[dgrogan, 2014/04/12 00:32:45]

Obviated by your suggestion above.

+  const base::Value* inner_value;
+  EXPECT_TRUE(dictionary->Get("key2", &inner_value));
+  int inner_integer;
+  EXPECT_TRUE(inner_value->GetAsInteger(&inner_integer));
+  EXPECT_EQ(30, inner_integer);
+
+  // Ensure the new value is persisted to disk.
+  CloseAndReopen();
+  EXPECT_TRUE(pref_store_->GetValue(key, &retrieved_value));

[Mattias Nissler (ping if slow), 2014/03/20 09:32:25]

... and you could reuse that expected dictionary here. 

[dgrogan, 2014/04/12 00:32:45]

Done.

+  EXPECT_TRUE(retrieved_value->GetAsDictionary(&dictionary));
+  EXPECT_TRUE(dictionary->Get("key2", &inner_value));
+  EXPECT_TRUE(inner_value->GetAsInteger(&inner_integer));
+  EXPECT_EQ(30, inner_integer);
+}
+
+TEST_F(LevelDBPrefStoreTest, RemoveFromMemory) {
+  Open();
+  const std::string key = "some.key";
+  pref_store_->SetValue(key, new FundamentalValue(5));
+
+  MockPrefStoreObserver mock_observer;
+  pref_store_->AddObserver(&mock_observer);
+  EXPECT_CALL(mock_observer, OnPrefValueChanged(key)).Times(1);
+  pref_store_->RemoveValue(key);
+  pref_store_->RemoveObserver(&mock_observer);
+  RunLoop().RunUntilIdle();
+  const base::Value* retrieved_value;
+  EXPECT_FALSE(pref_store_->GetValue(key, &retrieved_value));
+
+  CloseAndReopen();
+
+  EXPECT_FALSE(pref_store_->GetValue(key, &retrieved_value));
+}
+
+TEST_F(LevelDBPrefStoreTest, RemoveFromDisk) {

[Mattias Nissler (ping if slow), 2014/03/20 09:32:25]

Isn't this mostly identical with RemoveFromMemory above? Might just want to
merge the two tests.

[dgrogan, 2014/04/12 00:32:45]

The second was written because the first didn't catch a bug in the
implementation. Instead of merging, I made them more distinct so it's clear they
are testing different codepaths.

+  Open();
+  const std::string key = "some.key";
+  pref_store_->SetValue(key, new FundamentalValue(5));
+
+  CloseAndReopen();
+
+  MockPrefStoreObserver mock_observer;
+  pref_store_->AddObserver(&mock_observer);
+  EXPECT_CALL(mock_observer, OnPrefValueChanged(key)).Times(1);
+  pref_store_->RemoveValue(key);
+  pref_store_->RemoveObserver(&mock_observer);
+  RunLoop().RunUntilIdle();
+
+  CloseAndReopen();
+
+  const base::Value* retrieved_value;
+  EXPECT_FALSE(pref_store_->GetValue(key, &retrieved_value));
+}
+
+TEST_F(LevelDBPrefStoreTest, OpenAsync) {
+  // First set a key/value with a synchronous connection.
+  Open();
+  const std::string key = "some.key";
+  pref_store_->SetValue(key, new FundamentalValue(5));
+  Close();
+
+  scoped_refptr<LevelDBPrefStore> pref_store(new LevelDBPrefStore(
+      temp_dir_.path(), message_loop_.message_loop_proxy().get()));
+  MockReadErrorDelegate* delegate = new MockReadErrorDelegate;
+  pref_store->ReadPrefsAsync(delegate);
+
+  MockPrefStoreObserver mock_observer;
+  pref_store->AddObserver(&mock_observer);
+  EXPECT_CALL(mock_observer, OnInitializationCompleted(true)).Times(1);
+  RunLoop().RunUntilIdle();
+  pref_store->RemoveObserver(&mock_observer);
+
+  const base::Value* result;
+  EXPECT_TRUE(pref_store->GetValue("some.key", &result));
+  int int_value;
+  EXPECT_TRUE(result->GetAsInteger(&int_value));
+  EXPECT_EQ(5, int_value);
+
+  pref_store = NULL;
+}
+
+TEST_F(LevelDBPrefStoreTest, OpenAsyncError) {
+  // Open a connection that will lock the database.
+  Open();
+
+  // Try to open an async connection to the same database.
+  scoped_refptr<LevelDBPrefStore> pref_store(new LevelDBPrefStore(
+      temp_dir_.path(), message_loop_.message_loop_proxy().get()));
+  MockReadErrorDelegate* delegate = new MockReadErrorDelegate;
+  pref_store->ReadPrefsAsync(delegate);
+
+  MockPrefStoreObserver mock_observer;
+  pref_store->AddObserver(&mock_observer);
+  EXPECT_CALL(*delegate,
+              OnError(PersistentPrefStore::PREF_READ_ERROR_LEVELDB_IO_ERROR))
+      .Times(1);
+  EXPECT_CALL(mock_observer, OnInitializationCompleted(true)).Times(1);
+  RunLoop().RunUntilIdle();
+  pref_store->RemoveObserver(&mock_observer);
+
+  EXPECT_TRUE(pref_store->ReadOnly());
+  EXPECT_EQ(PersistentPrefStore::PREF_READ_ERROR_LEVELDB_IO_ERROR,
+            pref_store->GetReadError());
+
+  // Sync connection to the database will be closed by the destructor.
+}
+
+TEST_F(LevelDBPrefStoreTest, RepairCorrupt) {
+  // Open a database where CURRENT has no newline. Ensure that repair is called
+  // and there is no error reading the database.
+  FilePath corrupted_dir = data_dir_.AppendASCII("corrupted_leveldb");
+  base::FilePath dest = temp_dir_.path().AppendASCII("corrupted_leveldb");
+  const bool kRecursive = true;
+  ASSERT_TRUE(CopyDirectory(corrupted_dir, dest, kRecursive));
+  pref_store_ =
+      new LevelDBPrefStore(dest, message_loop_.message_loop_proxy().get());
+  EXPECT_EQ(LevelDBPrefStore::PREF_READ_ERROR_NONE, pref_store_->ReadPrefs());
+}
+
+TEST_F(LevelDBPrefStoreTest, Values) {
+  Open();
+  pref_store_->SetValue("boolean", new FundamentalValue(false));
+  pref_store_->SetValue("integer", new FundamentalValue(10));
+  pref_store_->SetValue("double", new FundamentalValue(10.3));
+  pref_store_->SetValue("string", new StringValue("some string"));
+
+  // Extra block so that variable names can be reused below.
+  {
+    DictionaryValue* dict_value = new DictionaryValue;

[Mattias Nissler (ping if slow), 2014/03/20 09:32:25]

Again, I suggest keeping copies of these objects so you can do
EXPECT_TRUE(Value::Equals()) below and safe some lines.

[dgrogan, 2014/04/12 00:32:45]

Done.

+    dict_value->Set("boolean", new FundamentalValue(true));
+    pref_store_->SetValue("dictionary", dict_value);
+
+    ListValue* list_value = new ListValue;
+    list_value->Set(2, new StringValue("string in list"));
+    pref_store_->SetValue("list", list_value);
+
+    // Do something nontrivial as well.
+    DictionaryValue* compound_value = new DictionaryValue;
+    ListValue* outer_list = new ListValue;
+    ListValue* inner_list = new ListValue;
+    inner_list->Set(0, new FundamentalValue(5));
+    outer_list->Set(1, inner_list);
+    compound_value->Set("compound_lists", outer_list);
+    pref_store_->SetValue("compound_value", compound_value);
+  }
+
+  CloseAndReopen();
+
+  const Value* value;
+  EXPECT_TRUE(pref_store_->GetValue("boolean", &value));
+  bool boolean_value;
+  EXPECT_TRUE(value->GetAsBoolean(&boolean_value));
+  EXPECT_EQ(false, boolean_value);
+
+  EXPECT_TRUE(pref_store_->GetValue("integer", &value));
+  int integer_value;
+  EXPECT_TRUE(value->GetAsInteger(&integer_value));
+  EXPECT_EQ(10, integer_value);
+
+  EXPECT_TRUE(pref_store_->GetValue("double", &value));
+  double double_value;
+  EXPECT_TRUE(value->GetAsDouble(&double_value));
+  EXPECT_LT(10.29, double_value);
+  EXPECT_GT(10.31, double_value);
+
+  EXPECT_TRUE(pref_store_->GetValue("string", &value));
+  std::string string_value;
+  EXPECT_TRUE(value->GetAsString(&string_value));
+  EXPECT_EQ("some string", string_value);
+
+  EXPECT_TRUE(pref_store_->GetValue("dictionary", &value));
+  const DictionaryValue* dict_value;
+  EXPECT_TRUE(value->GetAsDictionary(&dict_value));
+  EXPECT_TRUE(dict_value->GetBoolean("boolean", &boolean_value));
+  EXPECT_EQ(true, boolean_value);
+
+  EXPECT_TRUE(pref_store_->GetValue("list", &value));
+  const ListValue* list_value;
+  EXPECT_TRUE(value->GetAsList(&list_value));
+  EXPECT_TRUE(list_value->GetString(2, &string_value));
+  EXPECT_EQ("string in list", string_value);
+
+  EXPECT_TRUE(pref_store_->GetValue("compound_value", &value));
+  EXPECT_TRUE(value->GetAsDictionary(&dict_value));
+  const ListValue* outer_list;
+  const ListValue* inner_list;
+  EXPECT_TRUE(dict_value->GetList("compound_lists", &outer_list));
+  EXPECT_TRUE(outer_list->GetList(1, &inner_list));
+  EXPECT_TRUE(inner_list->GetInteger(0, &integer_value));
+  EXPECT_EQ(5, integer_value);
+}
+
+}  // namespace base