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/ref_counted.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"
+#include "base/run_loop.h"
+#include "base/strings/utf_string_conversions.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());
+    DCHECK_EQ(LevelDBPrefStore::PREF_READ_ERROR_NONE, pref_store_->ReadPrefs());

[Mattias Nissler (ping if slow), 2014/02/25 10:51:44]

This should probably be an EXPECT_EQ or ASSERT_EQ?

[dgrogan, 2014/03/05 03:06:58]

Done.

+  }
+
+  void CloseAndReopen() {
+    pref_store_ = NULL;
+    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";
+  base::Value* value = new FundamentalValue(5);

[Mattias Nissler (ping if slow), 2014/02/25 10:51:44]

nit: no need for the |value| variable, just inline on next line.

[dgrogan, 2014/03/05 03:06:58]

Done.

+  pref_store_->SetValue(key, value);
+  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";
+  base::Value* value = new FundamentalValue(5);
+  pref_store_->SetValue(key, value);
+  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());
+
+  const std::string key = "some.key";
+  base::Value* value = new FundamentalValue(5);
+  EXPECT_CALL(mock_observer, OnPrefValueChanged(key)).Times(1);

[Mattias Nissler (ping if slow), 2014/02/25 10:51:44]

The gmock docs say:

Important note: Google Mock requires expectations to be set before the mock
functions are called, otherwise the behavior is undefined. In particular, you
mustn't interleave EXPECT_CALL()s and calls to the mock functions.

(from https://code.google.com/p/googlemock/wiki/ForDummies)

The only exception you get is Mock::VerifyAndClearExpectations to start a new
cycle, which you should put after line 99 here.

[dgrogan, 2014/03/05 03:06:58]

Thanks, done.

+  pref_store->SetValue(key, value);
+
+  pref_store->RemoveObserver(&mock_observer);
+}
+
+TEST_F(LevelDBPrefStoreTest, SetValueSilently) {
+  Open();
+
+  MockPrefStoreObserver mock_observer;
+  pref_store_->AddObserver(&mock_observer);
+  const std::string key = "some.key";
+  base::Value* value = new FundamentalValue(30);
+  EXPECT_CALL(mock_observer, OnPrefValueChanged(key)).Times(0);
+  pref_store_->SetValueSilently(key, value);
+  RunLoop().RunUntilIdle();
+  pref_store_->RemoveObserver(&mock_observer);
+
+  CloseAndReopen();
+  value = new FundamentalValue(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));
+  const base::Value* inner_value;
+  EXPECT_TRUE(static_cast<const base::DictionaryValue*>(retrieved_value)
+                  ->Get("key2", &inner_value));

[Mattias Nissler (ping if slow), 2014/02/25 10:51:44]

The canonical way to do this is to call GetAsDictionary() on retrieved_value and
GetInteger() on the result.

[dgrogan, 2014/03/05 03:06:58]

Done.

+  const base::FundamentalValue* inner_fundamental_value =
+      static_cast<const base::FundamentalValue*>(inner_value);
+  int inner_integer;
+  EXPECT_TRUE(inner_fundamental_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));
+  EXPECT_TRUE(static_cast<const base::DictionaryValue*>(retrieved_value)
+                  ->Get("key2", &inner_value));
+  inner_fundamental_value =
+      static_cast<const base::FundamentalValue*>(inner_value);
+  EXPECT_TRUE(inner_fundamental_value->GetAsInteger(&inner_integer));

[Mattias Nissler (ping if slow), 2014/02/25 10:51:44]

same comments regarding reading the integer here.

[dgrogan, 2014/03/05 03:06:58]

Done.

+  EXPECT_EQ(30, inner_integer);
+}
+
+TEST_F(LevelDBPrefStoreTest, Remove) {
+  Open();
+  const std::string key = "some.key";
+  base::Value* orig_value = new FundamentalValue(5);
+  pref_store_->SetValue(key, orig_value);
+  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) {
+  pref_store_ = new LevelDBPrefStore(
+          temp_dir_.path(), message_loop_.message_loop_proxy().get());
+  MockReadErrorDelegate* delegate = new MockReadErrorDelegate;
+  pref_store_->ReadPrefsAsync(delegate);
+  EXPECT_CALL(*delegate,
+      OnError(PersistentPrefStore::PREF_READ_ERROR_NO_FILE)).Times(0);
+  MockPrefStoreObserver mock_observer;
+  pref_store_->AddObserver(&mock_observer);
+  EXPECT_CALL(mock_observer, OnInitializationCompleted(true)).Times(1);
+  RunLoop().RunUntilIdle();
+  pref_store_->RemoveObserver(&mock_observer);
+}
+

[Mattias Nissler (ping if slow), 2014/02/25 10:51:44]

Another test that makes sure all different Value types work would be nice to
have. I suspect that this works thanks to JSON serialization working correctly,
but then there are exceptions like base::Value::TYPE_BINARY, and the test may
serve as documentation what's expected to work.

[dgrogan, 2014/03/20 00:25:37]

Added.

+}  // namespace base