1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/sqlite_proto/proto_table_manager.h"
#include <vector>
#include "base/memory/scoped_refptr.h"
#include "base/strings/strcat.h"
#include "base/task/single_thread_task_runner.h"
#include "base/test/task_environment.h"
#include "components/sqlite_proto/key_value_data.h"
#include "components/sqlite_proto/key_value_table.h"
#include "components/sqlite_proto/test_proto.pb.h"
#include "sql/database.h"
#include "sql/meta_table.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace sqlite_proto {
namespace {
MATCHER_P(EqualsProto,
message,
"Match a proto Message equal to the matcher's argument.") {
std::string expected_serialized, actual_serialized;
message.SerializeToString(&expected_serialized);
arg.SerializeToString(&actual_serialized);
return expected_serialized == actual_serialized;
}
constexpr char kTableName[] = "my_table";
} // namespace
TEST(ProtoTableTest, PutReinitializeAndGet) {
// In order to test ProtoTableManager is correctly
// initializing the underlying database's tables:
// - create a database and a ProtoTableManager on it;
// - store some data; and
// - construct a new ProtoTableManager to read from the
// existing database state.
base::test::TaskEnvironment env;
sql::Database db;
CHECK(db.OpenInMemory());
auto manager = base::MakeRefCounted<ProtoTableManager>(
base::SingleThreadTaskRunner::GetCurrentDefault());
manager->InitializeOnDbSequence(&db, std::vector<std::string>{kTableName},
/*schema_version=*/1);
KeyValueTable<TestProto> table(kTableName);
TestProto first_entry, second_entry;
first_entry.set_value(1);
second_entry.set_value(1);
{
KeyValueData<TestProto> data(manager, &table,
/*max_num_entries=*/absl::nullopt,
/*flush_delay=*/base::TimeDelta());
// In these tests, we're using the current thread as the DB sequence.
data.InitializeOnDBSequence();
data.UpdateData("a", first_entry);
data.UpdateData("b", second_entry);
env.RunUntilIdle();
}
manager = base::MakeRefCounted<ProtoTableManager>(
base::SingleThreadTaskRunner::GetCurrentDefault());
manager->InitializeOnDbSequence(&db, std::vector<std::string>{kTableName},
/*schema_version=*/1);
{
KeyValueData<TestProto> data(manager, &table,
/*max_num_entries=*/absl::nullopt,
/*flush_delay=*/base::TimeDelta());
data.InitializeOnDBSequence();
TestProto result;
ASSERT_TRUE(data.TryGetData("a", &result));
EXPECT_THAT(result, EqualsProto(first_entry));
ASSERT_TRUE(data.TryGetData("b", &result));
EXPECT_THAT(result, EqualsProto(second_entry));
}
}
TEST(ProtoTableTest, ReinitializingWithDifferentVersionClearsTables) {
// In order to test ProtoTableManager is correctly
// initializing the underlying database's tables:
// - create a database and a ProtoTableManager on it;
// - store some data; and
// - construct a new ProtoTableManager to read from the
// existing database state.
base::test::TaskEnvironment env;
sql::Database db;
CHECK(db.OpenInMemory());
constexpr int kInitialVersion = 1;
auto manager = base::MakeRefCounted<ProtoTableManager>(
base::SingleThreadTaskRunner::GetCurrentDefault());
manager->InitializeOnDbSequence(&db, std::vector<std::string>{kTableName},
/*schema_version=*/kInitialVersion);
KeyValueTable<TestProto> table(kTableName);
TestProto first_entry, second_entry;
first_entry.set_value(1);
second_entry.set_value(1);
{
KeyValueData<TestProto> data(manager, &table,
/*max_num_entries=*/absl::nullopt,
/*flush_delay=*/base::TimeDelta());
// In these tests, we're using the current thread as the DB sequence.
data.InitializeOnDBSequence();
data.UpdateData("a", first_entry);
data.UpdateData("b", second_entry);
env.RunUntilIdle();
}
manager = base::MakeRefCounted<ProtoTableManager>(
base::SingleThreadTaskRunner::GetCurrentDefault());
manager->InitializeOnDbSequence(&db, std::vector<std::string>{kTableName},
/*schema_version=*/kInitialVersion + 1);
{
KeyValueData<TestProto> data(manager, &table,
/*max_num_entries=*/absl::nullopt,
/*flush_delay=*/base::TimeDelta());
data.InitializeOnDBSequence();
TestProto result;
EXPECT_FALSE(data.TryGetData("a", &result));
EXPECT_FALSE(data.TryGetData("b", &result));
}
}
TEST(ProtoTableTest, InitializingWithoutWrittenVersionClearsTables) {
// Check that, when reinitializing the database when the most recent write
// occurred before the database started keeping track of versions,
// ProtoTableManager correctly clears the database.
base::test::TaskEnvironment env;
sql::Database db;
CHECK(db.OpenInMemory());
constexpr int kInitialVersion = 1;
auto manager = base::MakeRefCounted<ProtoTableManager>(
base::SingleThreadTaskRunner::GetCurrentDefault());
manager->InitializeOnDbSequence(&db, std::vector<std::string>{kTableName},
/*schema_version=*/kInitialVersion);
KeyValueTable<TestProto> table(kTableName);
TestProto first_entry, second_entry;
first_entry.set_value(1);
second_entry.set_value(1);
{
KeyValueData<TestProto> data(manager, &table,
/*max_num_entries=*/absl::nullopt,
/*flush_delay=*/base::TimeDelta());
// In these tests, we're using the current thread as the DB sequence.
data.InitializeOnDBSequence();
data.UpdateData("a", first_entry);
data.UpdateData("b", second_entry);
env.RunUntilIdle();
ASSERT_TRUE(sql::MetaTable::DeleteTableForTesting(&db));
env.RunUntilIdle();
}
manager = base::MakeRefCounted<ProtoTableManager>(
base::SingleThreadTaskRunner::GetCurrentDefault());
manager->InitializeOnDbSequence(&db, std::vector<std::string>{kTableName},
/*schema_version=*/kInitialVersion);
{
KeyValueData<TestProto> data(manager, &table,
/*max_num_entries=*/absl::nullopt,
/*flush_delay=*/base::TimeDelta());
data.InitializeOnDBSequence();
TestProto result;
EXPECT_FALSE(data.TryGetData("a", &result));
EXPECT_FALSE(data.TryGetData("b", &result));
}
}
TEST(ProtoTableTest, LoadingUnexpectedlyLargeVersionClearsTables) {
// Check that, when reinitializing the database and the most recent write
// occurred against a greater version of the database, ProtoTableManager
// correctly clears the database.
base::test::TaskEnvironment env;
sql::Database db;
CHECK(db.OpenInMemory());
constexpr int kInitialVersion = 1;
auto manager = base::MakeRefCounted<ProtoTableManager>(
base::SingleThreadTaskRunner::GetCurrentDefault());
manager->InitializeOnDbSequence(&db, std::vector<std::string>{kTableName},
/*schema_version=*/kInitialVersion);
KeyValueTable<TestProto> table(kTableName);
TestProto first_entry, second_entry;
first_entry.set_value(1);
second_entry.set_value(1);
{
KeyValueData<TestProto> data(manager, &table,
/*max_num_entries=*/absl::nullopt,
/*flush_delay=*/base::TimeDelta());
// In these tests, we're using the current thread as the DB sequence.
data.InitializeOnDBSequence();
data.UpdateData("a", first_entry);
data.UpdateData("b", second_entry);
env.RunUntilIdle();
// Overwrite the stored version. It's safe to use an instance of
// sql::MetaTable here because all sql::MetaTable instances use the same
// database name ("meta") to manipulate versions.
//
// MetaTable::Init only writes a version if there was no version previously
// written, so it doesn't matter what values the final two arguments have.
// The SetVersionNumber is what actually overwrites the version.
sql::MetaTable meta_helper;
ASSERT_TRUE(meta_helper.Init(&db, 1, 1));
ASSERT_TRUE(meta_helper.SetVersionNumber(kInitialVersion + 1));
ASSERT_TRUE(meta_helper.SetCompatibleVersionNumber(kInitialVersion + 1));
env.RunUntilIdle();
}
manager = base::MakeRefCounted<ProtoTableManager>(
base::SingleThreadTaskRunner::GetCurrentDefault());
manager->InitializeOnDbSequence(&db, std::vector<std::string>{kTableName},
/*schema_version=*/kInitialVersion);
{
KeyValueData<TestProto> data(manager, &table,
/*max_num_entries=*/absl::nullopt,
/*flush_delay=*/base::TimeDelta());
data.InitializeOnDBSequence();
TestProto result;
EXPECT_FALSE(data.TryGetData("a", &result));
EXPECT_FALSE(data.TryGetData("b", &result));
}
}
} // namespace sqlite_proto
|