/
proto_database_impl_unittest.cc
1173 lines (991 loc) · 47.9 KB
/
proto_database_impl_unittest.cc
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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2019 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/leveldb_proto/internal/proto_database_impl.h"
#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "base/functional/bind.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/thread_pool.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/task_environment.h"
#include "components/leveldb_proto/internal/leveldb_proto_feature_list.h"
#include "components/leveldb_proto/internal/proto_database_selector.h"
#include "components/leveldb_proto/internal/shared_proto_database_provider.h"
#include "components/leveldb_proto/public/proto_database_provider.h"
#include "components/leveldb_proto/testing/proto/test_db.pb.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace leveldb_proto {
namespace {
const std::string kDefaultClientName = "client";
// Example struct defined by clients that can be used instead of protos.
struct ClientStruct {
public:
ClientStruct() {}
ClientStruct(ClientStruct&& other) {
id_ = std::move(other.id_);
data_ = std::move(other.data_);
}
ClientStruct(const ClientStruct&) = delete;
ClientStruct& operator=(const ClientStruct&) = delete;
~ClientStruct() = default;
// The methods below are convenience methods to have a similar API as protocol
// buffers for the test framework. This is NOT required for uses of client
// structs.
std::string id() const { return id_; }
std::string data() const { return data_; }
std::string id_;
std::string data_;
};
void CreateData(const std::string& key,
const std::string& data,
TestProto* proto) {
// Ensure the DB key, the id-field and data-field are all unique values.
proto->set_id(key + key);
proto->set_data(key + key + key);
}
void CreateData(const std::string& key,
const std::string& data,
ClientStruct* as_struct) {
// Ensure the DB key, the id-field and data-field are all unique values.
as_struct->id_ = key + key;
as_struct->data_ = key + key + key;
}
void DataToProto(ClientStruct* data, TestProto* proto) {
proto->mutable_id()->swap(data->id_);
proto->mutable_data()->swap(data->data_);
}
void ProtoToData(TestProto* proto, ClientStruct* data) {
proto->mutable_id()->swap(data->id_);
proto->mutable_data()->swap(data->data_);
}
} // namespace
// Class used to shortcut the Init method so it returns a specified InitStatus.
class TestSharedProtoDatabase : public SharedProtoDatabase {
public:
TestSharedProtoDatabase(const std::string& client_db_id,
const base::FilePath& db_dir,
Enums::InitStatus use_status)
: SharedProtoDatabase::SharedProtoDatabase(client_db_id, db_dir) {
use_status_ = use_status;
}
void Init(
bool create_if_missing,
const std::string& client_db_id,
SharedClientInitCallback callback,
scoped_refptr<base::SequencedTaskRunner> callback_task_runner) override {
init_status_ = use_status_;
CheckCorruptionAndRunInitCallback(client_db_id, std::move(callback),
std::move(callback_task_runner),
use_status_);
}
private:
~TestSharedProtoDatabase() override {}
Enums::InitStatus use_status_;
};
class TestSharedProtoDatabaseClient : public SharedProtoDatabaseClient {
public:
using SharedProtoDatabaseClient::set_migration_status;
using SharedProtoDatabaseClient::SharedProtoDatabaseClient;
explicit TestSharedProtoDatabaseClient(
scoped_refptr<SharedProtoDatabase> shared_db)
: SharedProtoDatabaseClient::SharedProtoDatabaseClient(
std::make_unique<ProtoLevelDBWrapper>(shared_db->task_runner_,
shared_db->db_.get()),
ProtoDbType::TEST_DATABASE1,
shared_db) {}
void UpdateClientInitMetadata(
SharedDBMetadataProto::MigrationStatus migration_status) override {
set_migration_status(migration_status);
}
void UpdateEntriesWithRemoveFilter(
std::unique_ptr<KeyValueVector> entries_to_save,
const KeyFilter& delete_key_filter,
Callbacks::UpdateCallback callback) override {
std::move(callback).Run(true);
}
};
class TestProtoDatabaseProvider : public ProtoDatabaseProvider {
public:
explicit TestProtoDatabaseProvider(const base::FilePath& profile_dir)
: ProtoDatabaseProvider(profile_dir) {}
TestProtoDatabaseProvider(const base::FilePath& profile_dir,
const scoped_refptr<SharedProtoDatabase>& shared_db)
: ProtoDatabaseProvider(profile_dir) {
shared_db_ = shared_db;
}
void GetSharedDBInstance(
ProtoDatabaseProvider::GetSharedDBInstanceCallback callback,
scoped_refptr<base::SequencedTaskRunner> callback_task_runner) override {
callback_task_runner->PostTask(
FROM_HERE, base::BindOnce(std::move(callback), shared_db_));
}
private:
scoped_refptr<SharedProtoDatabase> shared_db_;
};
class TestSharedProtoDatabaseProvider : public SharedProtoDatabaseProvider {
public:
TestSharedProtoDatabaseProvider(
const scoped_refptr<base::SequencedTaskRunner>& client_task_runner,
base::WeakPtr<ProtoDatabaseProvider> provider_weak_ptr)
: SharedProtoDatabaseProvider(std::move(client_task_runner),
std::move(provider_weak_ptr)) {}
};
template <typename T>
class ProtoDatabaseImplTest : public testing::Test {
public:
void SetUp() override {
ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
ASSERT_TRUE(shared_db_temp_dir_.CreateUniqueTempDir());
shared_db_ = base::WrapRefCounted(new SharedProtoDatabase(
kDefaultClientName, shared_db_temp_dir_.GetPath()));
test_task_runner_ = shared_db_->database_task_runner_for_testing();
}
void TearDown() override { shared_db_->Shutdown(); }
void SetUpExperimentParams(std::map<std::string, std::string> params) {
scoped_feature_list_.InitAndEnableFeatureWithParameters(
kProtoDBSharedMigration, params);
}
std::unique_ptr<ProtoDatabaseImpl<TestProto, T>> CreateDBImpl(
ProtoDbType db_type,
const base::FilePath& db_dir,
const scoped_refptr<base::SequencedTaskRunner>& task_runner,
std::unique_ptr<SharedProtoDatabaseProvider> db_provider) {
return std::make_unique<ProtoDatabaseImpl<TestProto, T>>(
db_type, db_dir, task_runner, std::move(db_provider));
}
void GetDbAndWait(ProtoDatabaseProvider* db_provider, ProtoDbType db_type) {
base::ScopedTempDir temp_dir;
ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
auto db = db_provider->GetDB<TestProto, T>(db_type, temp_dir.GetPath(),
GetTestThreadTaskRunner());
base::RunLoop run_init;
// Initialize a database, it should succeed.
db->Init(base::BindOnce(
[](base::OnceClosure closure, Enums::InitStatus status) {
std::move(closure).Run();
EXPECT_TRUE(status == Enums::InitStatus::kOK);
},
run_init.QuitClosure()));
run_init.Run();
// Destroy the db and run all tasks to allow resources to be released before
// |temp_dir| is cleaned up.
db.reset();
task_environment_.RunUntilIdle();
}
std::unique_ptr<TestProtoDatabaseProvider> CreateProviderNoSharedDB() {
// Create a test provider with a test shared DB that will return invalid
// operation when a client is requested, level_db returns invalid operation
// when a database doesn't exist.
return CreateProviderWithTestSharedDB(Enums::InitStatus::kInvalidOperation);
}
std::unique_ptr<TestProtoDatabaseProvider> CreateProviderWithSharedDB() {
return std::make_unique<TestProtoDatabaseProvider>(
shared_db_temp_dir_.GetPath(), shared_db_);
}
std::unique_ptr<TestProtoDatabaseProvider> CreateProviderWithTestSharedDB(
Enums::InitStatus shared_client_init_status) {
auto test_shared_db = base::WrapRefCounted(new TestSharedProtoDatabase(
kDefaultClientName, shared_db_temp_dir_.GetPath(),
shared_client_init_status));
return std::make_unique<TestProtoDatabaseProvider>(
shared_db_temp_dir_.GetPath(), test_shared_db);
}
std::unique_ptr<TestSharedProtoDatabaseProvider> CreateSharedProvider(
TestProtoDatabaseProvider* db_provider) {
return std::make_unique<TestSharedProtoDatabaseProvider>(
base::SequencedTaskRunner::GetCurrentDefault(),
db_provider->weak_factory_.GetWeakPtr());
}
// Uses ProtoDatabaseImpl's 3 parameter Init to bypass the check that gets
// |use_shared_db|'s value.
void InitDBImpl(ProtoDatabaseImpl<TestProto, T>* db_impl,
const std::string& client_name,
bool use_shared_db,
Callbacks::InitStatusCallback callback) {
db_impl->InitInternal(client_name, CreateSimpleOptions(), use_shared_db,
std::move(callback));
}
void InitDBImplAndWait(ProtoDatabaseImpl<TestProto, T>* db_impl,
const std::string& client_name,
bool use_shared_db,
Enums::InitStatus expect_status) {
base::RunLoop init_loop;
InitDBImpl(
db_impl, client_name, use_shared_db,
base::BindOnce(
[](base::OnceClosure closure, Enums::InitStatus expect_status,
Enums::InitStatus status) {
ASSERT_EQ(status, expect_status);
std::move(closure).Run();
},
init_loop.QuitClosure(), expect_status));
init_loop.Run();
}
std::unique_ptr<TestSharedProtoDatabaseClient> GetSharedClient() {
return std::make_unique<TestSharedProtoDatabaseClient>(shared_db_);
}
void CallOnGetSharedDBClientAndWait(
std::unique_ptr<UniqueProtoDatabase> unique_db,
Enums::InitStatus unique_db_status,
bool use_shared_db,
std::unique_ptr<SharedProtoDatabaseClient> shared_db_client,
Enums::InitStatus shared_db_status,
Enums::InitStatus expect_status) {
base::RunLoop init_loop;
scoped_refptr<ProtoDatabaseSelector> selector(new ProtoDatabaseSelector(
ProtoDbType::TEST_DATABASE1, GetTestThreadTaskRunner(), nullptr));
GetTestThreadTaskRunner()->PostTask(
FROM_HERE,
base::BindOnce(
&ProtoDatabaseSelector::OnGetSharedDBClient, selector,
std::move(unique_db), unique_db_status, use_shared_db,
base::BindOnce(
[](base::OnceClosure closure, Enums::InitStatus expect_status,
Enums::InitStatus status) {
ASSERT_EQ(status, expect_status);
std::move(closure).Run();
},
init_loop.QuitClosure(), expect_status),
std::move(shared_db_client), shared_db_status));
init_loop.Run();
// If the process succeeded then check that the selector has a database set.
if (expect_status == Enums::InitStatus::kOK) {
ASSERT_NE(selector->db_, nullptr);
}
}
// Just uses each entry's key to fill out the id/data fields in TestProto as
// well.
void AddDataToDBImpl(ProtoDatabaseImpl<TestProto, T>* db_impl,
std::vector<std::string>* entry_keys) {
auto data_set = std::make_unique<std::vector<std::pair<std::string, T>>>();
for (const auto& key : *entry_keys) {
T data;
CreateData(key, key, &data);
data_set->emplace_back(key, std::move(data));
}
base::RunLoop data_loop;
db_impl->UpdateEntries(std::move(data_set),
std::make_unique<std::vector<std::string>>(),
base::BindOnce(
[](base::OnceClosure closure, bool success) {
ASSERT_TRUE(success);
std::move(closure).Run();
},
data_loop.QuitClosure()));
data_loop.Run();
}
void VerifyDataInDBImpl(ProtoDatabaseImpl<TestProto, T>* db_impl,
std::vector<std::string>* entry_keys) {
base::RunLoop load_loop;
db_impl->LoadKeysAndEntries(base::BindOnce(
[](base::OnceClosure closure, std::vector<std::string>* entry_keys,
bool success,
std::unique_ptr<std::map<std::string, T>> keys_entries) {
ASSERT_TRUE(success);
ASSERT_EQ(entry_keys->size(), keys_entries->size());
for (const auto& key : *entry_keys) {
auto search = keys_entries->find(key);
ASSERT_TRUE(search != keys_entries->end());
// CreateData above uses double key as id and triple key as data.
ASSERT_EQ(key + key, search->second.id());
ASSERT_EQ(key + key + key, search->second.data());
}
std::move(closure).Run();
},
load_loop.QuitClosure(), entry_keys));
load_loop.Run();
}
void UpdateClientMetadata(
SharedDBMetadataProto::MigrationStatus migration_status) {
base::RunLoop init_wait;
auto client = shared_db_->GetClientForTesting(
ProtoDbType::TEST_DATABASE1, /*create_if_missing=*/true,
base::BindOnce(
[](base::OnceClosure closure, Enums::InitStatus status,
SharedDBMetadataProto::MigrationStatus migration_status) {
EXPECT_EQ(Enums::kOK, status);
std::move(closure).Run();
},
init_wait.QuitClosure()));
init_wait.Run();
base::RunLoop wait_loop;
shared_db_->UpdateClientMetadataAsync(
client->client_db_id(), migration_status,
base::BindOnce(
[](base::OnceClosure closure, bool success) {
EXPECT_TRUE(success);
std::move(closure).Run();
},
wait_loop.QuitClosure()));
wait_loop.Run();
}
SharedDBMetadataProto::MigrationStatus GetClientMigrationStatus() {
SharedDBMetadataProto::MigrationStatus migration_status;
base::RunLoop init_wait;
auto client = shared_db_->GetClientForTesting(
ProtoDbType::TEST_DATABASE1, /*create_if_missing=*/true,
base::BindOnce(
[](base::OnceClosure closure,
SharedDBMetadataProto::MigrationStatus* output,
Enums::InitStatus status,
SharedDBMetadataProto::MigrationStatus migration_status) {
EXPECT_EQ(Enums::kOK, status);
*output = migration_status;
std::move(closure).Run();
},
init_wait.QuitClosure(), &migration_status));
init_wait.Run();
return migration_status;
}
scoped_refptr<base::SequencedTaskRunner> GetTestThreadTaskRunner() {
return test_task_runner_;
}
base::FilePath temp_dir() { return temp_dir_.GetPath(); }
private:
base::ScopedTempDir temp_dir_;
base::ScopedTempDir shared_db_temp_dir_;
base::test::ScopedFeatureList scoped_feature_list_;
protected:
base::test::TaskEnvironment task_environment_;
private:
// Shared database.
scoped_refptr<base::SequencedTaskRunner> test_task_runner_;
scoped_refptr<SharedProtoDatabase> shared_db_;
};
using ProtoDatabaseImplTestConfig = testing::Types<TestProto, ClientStruct>;
TYPED_TEST_SUITE(ProtoDatabaseImplTest, ProtoDatabaseImplTestConfig);
TYPED_TEST(ProtoDatabaseImplTest, FailsBothDatabases) {
auto db_provider = this->CreateProviderNoSharedDB();
auto shared_db_provider = this->CreateSharedProvider(db_provider.get());
auto db_impl =
this->CreateDBImpl(ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider.get()));
this->InitDBImplAndWait(db_impl.get(), kDefaultClientName, true,
Enums::InitStatus::kError);
}
TYPED_TEST(ProtoDatabaseImplTest, Fails_UseShared_NoSharedDB) {
auto unique_db =
std::make_unique<UniqueProtoDatabase>(this->GetTestThreadTaskRunner());
// If a shared DB is requested, and it fails to open for any reason then we
// return a failure, the shared DB is opened using create_if_missing = true,
// so we shouldn't get a missing DB.
this->CallOnGetSharedDBClientAndWait(
std::move(unique_db), // Unique DB opens fine.
Enums::InitStatus::kOK,
true, // We should be using a shared DB.
nullptr, // Shared DB failed to open.
Enums::InitStatus::kError, // Shared DB had an IO error.
Enums::InitStatus::kError); // Then the DB impl should return an error.
this->CallOnGetSharedDBClientAndWait(
std::move(unique_db), // Unique DB opens fine.
Enums::InitStatus::kOK,
true, // We should be using a shared DB.
nullptr, // Shared DB failed to open.
Enums::InitStatus::kInvalidOperation, // Shared DB doesn't exist.
Enums::InitStatus::kError); // Then the DB impl should return an error.
}
TYPED_TEST(ProtoDatabaseImplTest,
SucceedsWithShared_UseShared_HasSharedDB_UniqueNotFound) {
auto shared_db_client = this->GetSharedClient();
// Migration status is not attempted.
shared_db_client->set_migration_status(
SharedDBMetadataProto::MIGRATION_NOT_ATTEMPTED);
// If we request a shared DB, the unique DB fails to open because it doesn't
// exist and a migration hasn't been attempted then we return the shared DB
// and we set the migration status to migrated to shared.
this->CallOnGetSharedDBClientAndWait(
nullptr, // Unique DB fails to open.
Enums::InitStatus::kInvalidOperation, // Unique DB doesn't exist.
true, // We should be using a shared DB.
std::move(shared_db_client), // Shared DB opens fine.
Enums::InitStatus::kOK,
Enums::InitStatus::kOK); // Then the DB impl should return the shared DB.
}
TYPED_TEST(ProtoDatabaseImplTest,
Fails_UseShared_HasSharedDB_UniqueHadIOError) {
auto shared_db_client = this->GetSharedClient();
// Migration status is not attempted.
shared_db_client->set_migration_status(
SharedDBMetadataProto::MIGRATION_NOT_ATTEMPTED);
// If we request a shared DB, the unique DB fails to open because of an IO
// error and a migration hasn't been attempted then we throw an error, as the
// unique DB could contain data yet to be migrated.
this->CallOnGetSharedDBClientAndWait(
nullptr, // Unique DB fails to open.
Enums::InitStatus::kError, // Unique DB had an IO error.
true, // We should be using a shared DB.
std::move(shared_db_client), // Shared DB opens fine.
Enums::InitStatus::kOK,
Enums::InitStatus::kError); // Then the DB impl should return an error.
}
TYPED_TEST(ProtoDatabaseImplTest,
SuccedsWithShared_UseShared_HasSharedDB_DataWasMigratedToShared) {
auto shared_db_client = this->GetSharedClient();
// Database has been migrated to Shared.
shared_db_client->set_migration_status(
SharedDBMetadataProto::MIGRATE_TO_SHARED_SUCCESSFUL);
// If we request a shared DB, the unique DB fails to open for any reason and
// the data has been migrated to the shared DB then we can return the shared
// DB safely.
this->CallOnGetSharedDBClientAndWait(
nullptr, // Unique DB fails to open.
Enums::InitStatus::kInvalidOperation, // Unique DB doesn't exist.
true, // We should be using a shared DB.
std::move(shared_db_client), // Shared DB opens fine.
Enums::InitStatus::kOK,
Enums::InitStatus::kOK); // Then the DB impl should use the shared DB.
shared_db_client = this->GetSharedClient();
// Data has been migrated to Shared, Unique DB still exists and should be
// removed.
shared_db_client->set_migration_status(
SharedDBMetadataProto::MIGRATE_TO_SHARED_UNIQUE_TO_BE_DELETED);
// This second scenario occurs when the unique DB is marked to be deleted, but
// it fails to open, we should also return the unique DB without throwing an
// error.
this->CallOnGetSharedDBClientAndWait(
nullptr, // Unique DB fails to open.
Enums::InitStatus::kError, // Unique DB had an IO error.
true, // We should be using a shared DB.
std::move(shared_db_client), // Shared DB opens fine.
Enums::InitStatus::kOK,
Enums::InitStatus::kOK); // Then the DB impl should use the shared DB.
}
TYPED_TEST(ProtoDatabaseImplTest,
SucceedsWithShared_UseShared_HasSharedDB_MigratedUniqueWasDeleted) {
auto shared_db_client = this->GetSharedClient();
// Database has been migrated to Unique.
shared_db_client->set_migration_status(
SharedDBMetadataProto::MIGRATE_TO_UNIQUE_SUCCESSFUL);
// If we request a shared DB, the unique DB fails does not exist and
// the data has been migrated to the unique DB then we return shared db.
this->CallOnGetSharedDBClientAndWait(
nullptr, // Unique DB fails to open.
Enums::InitStatus::kInvalidOperation, // Unique DB missing.
true, // We should be using a shared DB.
std::move(shared_db_client), // Shared DB opens fine.
Enums::InitStatus::kOK,
Enums::InitStatus::kOK); // Returns shared db.
shared_db_client = this->GetSharedClient();
// Data has been migrated to Unique, but data still exists in Shared DB that
// should be removed.
shared_db_client->set_migration_status(
SharedDBMetadataProto::MIGRATE_TO_UNIQUE_SHARED_TO_BE_DELETED);
// This second scenario occurs when the Shared DB still contains data, we
// should still clear shared and return it.
this->CallOnGetSharedDBClientAndWait(
nullptr, // Unique DB fails to open.
Enums::InitStatus::kInvalidOperation, // Unique DB missing.
true, // We should be using a shared DB.
std::move(shared_db_client), // Shared DB opens fine.
Enums::InitStatus::kOK,
Enums::InitStatus::kOK); // Returns shared db
}
TYPED_TEST(ProtoDatabaseImplTest,
Fails_UseShared_HasSharedDB_DataWasMigratedToUnique) {
auto shared_db_client = this->GetSharedClient();
// Database has been migrated to Unique.
shared_db_client->set_migration_status(
SharedDBMetadataProto::MIGRATE_TO_UNIQUE_SUCCESSFUL);
// If we request a shared DB, the unique DB fails to open for any reason and
// the data has been migrated to the unique DB then we throw an error, as the
// unique database may contain data.
this->CallOnGetSharedDBClientAndWait(
nullptr, // Unique DB fails to open.
Enums::InitStatus::kError, // Unique DB failure.
true, // We should be using a shared DB.
std::move(shared_db_client), // Shared DB opens fine.
Enums::InitStatus::kOK,
Enums::InitStatus::kError); // Then the DB impl should throw an error.
shared_db_client = this->GetSharedClient();
// Data has been migrated to Unique, but data still exists in Shared DB that
// should be removed.
shared_db_client->set_migration_status(
SharedDBMetadataProto::MIGRATE_TO_UNIQUE_SHARED_TO_BE_DELETED);
// This second scenario occurs when the Shared DB still contains data, we
// should still throw an error.
this->CallOnGetSharedDBClientAndWait(
nullptr, // Unique DB fails to open.
Enums::InitStatus::kError, // Unique DB had an IO error.
true, // We should be using a shared DB.
std::move(shared_db_client), // Shared DB opens fine.
Enums::InitStatus::kOK,
Enums::InitStatus::kError); // Then the DB impl should throw an error.
}
TYPED_TEST(
ProtoDatabaseImplTest,
SucceedsWithShared_DontUseShared_HasSharedDB_DataWasMigratedToShared) {
auto shared_db_client = this->GetSharedClient();
// Database has been migrated to Shared.
shared_db_client->set_migration_status(
SharedDBMetadataProto::MIGRATE_TO_SHARED_SUCCESSFUL);
// If we request a unique DB, the unique DB fails to open for any reason and
// the data has been migrated to the shared DB then we use the Shared DB.
this->CallOnGetSharedDBClientAndWait(
nullptr, // Unique DB fails to open.
Enums::InitStatus::kInvalidOperation, // Unique DB doesn't exist.
false, // We should be using a unique DB.
std::move(shared_db_client), // Shared DB opens fine.
Enums::InitStatus::kOK,
Enums::InitStatus::kOK); // Then the DB impl should use the shared DB.
shared_db_client = this->GetSharedClient();
// Data has been migrated to Shared, but the Unique DB still exists and needs
// to be deleted.
shared_db_client->set_migration_status(
SharedDBMetadataProto::MIGRATE_TO_SHARED_UNIQUE_TO_BE_DELETED);
// This second scenario occurs when the unique database is marked to be
// deleted, we should still use the shared DB.
this->CallOnGetSharedDBClientAndWait(
nullptr, // Unique DB fails to open.
Enums::InitStatus::kError, // Unique DB had an IO error.
true, // We should be using a shared DB.
std::move(shared_db_client), // Shared DB opens fine.
Enums::InitStatus::kOK,
Enums::InitStatus::kOK); // Then the DB impl should use the shared DB.
}
TYPED_TEST(ProtoDatabaseImplTest,
SucceedsWithUnique_DontUseShared_SharedDBNotFound) {
auto unique_db =
std::make_unique<UniqueProtoDatabase>(this->GetTestThreadTaskRunner());
// If the shared DB client fails to open because it doesn't exist then we can
// return the unique DB safely.
this->CallOnGetSharedDBClientAndWait(
std::move(unique_db), // Unique DB opens fine.
Enums::InitStatus::kOK,
false, // We should be using a unique DB.
nullptr, // Shared DB failed to open.
Enums::InitStatus::kInvalidOperation, // Shared DB doesn't exist.
Enums::InitStatus::kOK); // Then the DB impl should return the unique DB.
}
TYPED_TEST(ProtoDatabaseImplTest, Fails_DontUseShared_SharedDBFailed) {
auto unique_db =
std::make_unique<UniqueProtoDatabase>(this->GetTestThreadTaskRunner());
// If the shared DB client fails to open because of an IO error then we
// shouldn't return a database, as the shared DB could contain data not yet
// migrated.
this->CallOnGetSharedDBClientAndWait(
std::move(unique_db), // Unique DB opens fine.
Enums::InitStatus::kOK,
false, // We should be using a unique DB.
nullptr, // Shared DB failed to open.
Enums::InitStatus::kError, // Shared DB had an IO error.
Enums::InitStatus::kError); // Then the DB impl should return an error.
}
TYPED_TEST(ProtoDatabaseImplTest, Fails_UseShared_NoSharedDB_NoUniqueDB) {
auto db_provider = this->CreateProviderNoSharedDB();
auto db_impl =
this->CreateDBImpl(ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider.get()));
this->InitDBImplAndWait(db_impl.get(), kDefaultClientName, true,
Enums::InitStatus::kError);
}
// Migration tests:
TYPED_TEST(ProtoDatabaseImplTest, Migration_EmptyDBs_UniqueToShared) {
// First we create a unique DB so our second pass has a unique DB available.
auto db_provider_noshared = this->CreateProviderNoSharedDB();
auto unique_db_impl = this->CreateDBImpl(
ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider_noshared.get()));
this->InitDBImplAndWait(unique_db_impl.get(), kDefaultClientName, false,
Enums::InitStatus::kOK);
// Kill the DB impl so it doesn't have a lock on the DB anymore.
unique_db_impl.reset();
// DB impl posts a task to destroy its database, so we wait for that task to
// complete.
base::RunLoop destroy_loop;
this->GetTestThreadTaskRunner()->PostTask(FROM_HERE,
destroy_loop.QuitClosure());
destroy_loop.Run();
auto db_provider_withshared = this->CreateProviderWithSharedDB();
auto shared_db_impl = this->CreateDBImpl(
ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider_withshared.get()));
this->InitDBImplAndWait(shared_db_impl.get(), kDefaultClientName, true,
Enums::InitStatus::kOK);
EXPECT_EQ(SharedDBMetadataProto::MIGRATE_TO_SHARED_SUCCESSFUL,
this->GetClientMigrationStatus());
}
TYPED_TEST(ProtoDatabaseImplTest, Migration_EmptyDBs_SharedToUnique) {
// First we create a unique DB so our second pass has a unique DB available.
auto db_provider = this->CreateProviderWithSharedDB();
auto shared_db_impl =
this->CreateDBImpl(ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider.get()));
this->InitDBImplAndWait(shared_db_impl.get(), kDefaultClientName, true,
Enums::InitStatus::kOK);
// As the unique DB doesn't exist then the DB impl sets the migration status
// to migrated to shared.
EXPECT_EQ(SharedDBMetadataProto::MIGRATE_TO_SHARED_SUCCESSFUL,
this->GetClientMigrationStatus());
auto unique_db_impl =
this->CreateDBImpl(ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider.get()));
this->InitDBImplAndWait(shared_db_impl.get(), kDefaultClientName, false,
Enums::InitStatus::kOK);
EXPECT_EQ(SharedDBMetadataProto::MIGRATE_TO_UNIQUE_SUCCESSFUL,
this->GetClientMigrationStatus());
}
TYPED_TEST(ProtoDatabaseImplTest, Migration_UniqueToShared) {
auto data_set = std::make_unique<std::vector<std::string>>();
data_set->emplace_back("entry1");
data_set->emplace_back("entry2");
data_set->emplace_back("entry3");
// First we create a unique DB so our second pass has a unique DB available.
auto db_provider_noshared = this->CreateProviderNoSharedDB();
auto unique_db_impl = this->CreateDBImpl(
ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider_noshared.get()));
this->InitDBImplAndWait(unique_db_impl.get(), kDefaultClientName, false,
Enums::InitStatus::kOK);
this->AddDataToDBImpl(unique_db_impl.get(), data_set.get());
// Kill the DB impl so it doesn't have a lock on the DB anymore.
unique_db_impl.reset();
// DB impl posts a task to destroy its database, so we wait for that task to
// complete.
base::RunLoop destroy_loop;
this->GetTestThreadTaskRunner()->PostTask(FROM_HERE,
destroy_loop.QuitClosure());
destroy_loop.Run();
auto db_provider_withshared = this->CreateProviderWithSharedDB();
auto shared_db_impl = this->CreateDBImpl(
ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider_withshared.get()));
this->InitDBImplAndWait(shared_db_impl.get(), kDefaultClientName, true,
Enums::InitStatus::kOK);
this->VerifyDataInDBImpl(shared_db_impl.get(), data_set.get());
EXPECT_EQ(SharedDBMetadataProto::MIGRATE_TO_SHARED_SUCCESSFUL,
this->GetClientMigrationStatus());
}
TYPED_TEST(ProtoDatabaseImplTest, Migration_SharedToUnique) {
auto data_set = std::make_unique<std::vector<std::string>>();
data_set->emplace_back("entry1");
data_set->emplace_back("entry2");
data_set->emplace_back("entry3");
// First we create a shared DB so our second pass has a shared DB available.
auto db_provider_withshared = this->CreateProviderWithSharedDB();
auto shared_db_impl = this->CreateDBImpl(
ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider_withshared.get()));
this->InitDBImplAndWait(shared_db_impl.get(), kDefaultClientName, true,
Enums::InitStatus::kOK);
this->AddDataToDBImpl(shared_db_impl.get(), data_set.get());
// As the unique DB doesn't exist then the DB impl sets the migration status
// to migrated to shared.
EXPECT_EQ(SharedDBMetadataProto::MIGRATE_TO_SHARED_SUCCESSFUL,
this->GetClientMigrationStatus());
auto unique_db_impl = this->CreateDBImpl(
ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider_withshared.get()));
this->InitDBImplAndWait(unique_db_impl.get(), kDefaultClientName, false,
Enums::InitStatus::kOK);
this->VerifyDataInDBImpl(unique_db_impl.get(), data_set.get());
EXPECT_EQ(SharedDBMetadataProto::MIGRATE_TO_UNIQUE_SUCCESSFUL,
this->GetClientMigrationStatus());
}
TYPED_TEST(ProtoDatabaseImplTest, Migration_UniqueToShared_UniqueObsolete) {
auto data_set = std::make_unique<std::vector<std::string>>();
data_set->emplace_back("entry1");
data_set->emplace_back("entry2");
data_set->emplace_back("entry3");
// First we create a unique DB so our second pass has a unique DB available.
auto db_provider_noshared = this->CreateProviderNoSharedDB();
auto unique_db_impl = this->CreateDBImpl(
ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider_noshared.get()));
this->InitDBImplAndWait(unique_db_impl.get(), kDefaultClientName, false,
Enums::InitStatus::kOK);
this->AddDataToDBImpl(unique_db_impl.get(), data_set.get());
// Kill the DB impl so it doesn't have a lock on the DB anymore.
unique_db_impl.reset();
this->UpdateClientMetadata(
SharedDBMetadataProto::MIGRATE_TO_SHARED_UNIQUE_TO_BE_DELETED);
auto db_provider_withshared = this->CreateProviderWithSharedDB();
auto shared_db_impl = this->CreateDBImpl(
ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider_withshared.get()));
this->InitDBImplAndWait(shared_db_impl.get(), kDefaultClientName, true,
Enums::InitStatus::kOK);
// Unique DB should be deleted in migration. So, shared DB should be clean.
data_set->clear();
this->VerifyDataInDBImpl(shared_db_impl.get(), data_set.get());
EXPECT_EQ(SharedDBMetadataProto::MIGRATE_TO_SHARED_SUCCESSFUL,
this->GetClientMigrationStatus());
}
TYPED_TEST(ProtoDatabaseImplTest, Migration_UniqueToShared_SharedObsolete) {
auto data_set = std::make_unique<std::vector<std::string>>();
data_set->emplace_back("entry1");
data_set->emplace_back("entry2");
data_set->emplace_back("entry3");
// First we create a shared DB so our second pass has a shared DB available.
auto db_provider_withshared = this->CreateProviderWithSharedDB();
auto shared_db_impl = this->CreateDBImpl(
ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider_withshared.get()));
this->InitDBImplAndWait(shared_db_impl.get(), kDefaultClientName, true,
Enums::InitStatus::kOK);
this->AddDataToDBImpl(shared_db_impl.get(), data_set.get());
// As there's no unique DB, the DB impl is going to set the state to migrated
// to shared.
EXPECT_EQ(SharedDBMetadataProto::MIGRATE_TO_SHARED_SUCCESSFUL,
this->GetClientMigrationStatus());
// Force create an unique DB, which was deleted by migration.
auto db_provider_noshared = this->CreateProviderNoSharedDB();
auto unique_db_impl = this->CreateDBImpl(
ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider_noshared.get()));
this->InitDBImplAndWait(unique_db_impl.get(), kDefaultClientName, false,
Enums::InitStatus::kOK);
unique_db_impl.reset();
this->UpdateClientMetadata(
SharedDBMetadataProto::MIGRATE_TO_UNIQUE_SHARED_TO_BE_DELETED);
shared_db_impl.reset();
db_provider_withshared = this->CreateProviderWithSharedDB();
auto shared_db_impl1 = this->CreateDBImpl(
ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider_withshared.get()));
this->InitDBImplAndWait(shared_db_impl1.get(), kDefaultClientName, true,
Enums::InitStatus::kOK);
// Shared DB should be deleted in migration. So, shared DB should be clean.
data_set->clear();
this->VerifyDataInDBImpl(shared_db_impl1.get(), data_set.get());
EXPECT_EQ(SharedDBMetadataProto::MIGRATE_TO_SHARED_SUCCESSFUL,
this->GetClientMigrationStatus());
}
TYPED_TEST(ProtoDatabaseImplTest, Migration_SharedToUnique_SharedObsolete) {
auto data_set = std::make_unique<std::vector<std::string>>();
data_set->emplace_back("entry1");
data_set->emplace_back("entry2");
data_set->emplace_back("entry3");
// First we create a shared DB so our second pass has a shared DB available.
auto db_provider_withshared = this->CreateProviderWithSharedDB();
auto shared_db_impl = this->CreateDBImpl(
ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider_withshared.get()));
this->InitDBImplAndWait(shared_db_impl.get(), kDefaultClientName, true,
Enums::InitStatus::kOK);
this->AddDataToDBImpl(shared_db_impl.get(), data_set.get());
// As there's no Unique DB, the DB impl changes the migration status to
// migrated to shared.
EXPECT_EQ(SharedDBMetadataProto::MIGRATE_TO_SHARED_SUCCESSFUL,
this->GetClientMigrationStatus());
this->UpdateClientMetadata(
SharedDBMetadataProto::MIGRATE_TO_UNIQUE_SHARED_TO_BE_DELETED);
auto unique_db_impl = this->CreateDBImpl(
ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider_withshared.get()));
this->InitDBImplAndWait(unique_db_impl.get(), kDefaultClientName, false,
Enums::InitStatus::kOK);
// Shared DB should be deleted in migration. So, unique DB should be clean.
data_set->clear();
this->VerifyDataInDBImpl(unique_db_impl.get(), data_set.get());
EXPECT_EQ(SharedDBMetadataProto::MIGRATE_TO_UNIQUE_SUCCESSFUL,
this->GetClientMigrationStatus());
}
TYPED_TEST(ProtoDatabaseImplTest, Migration_SharedToUnique_UniqueObsolete) {
auto data_set = std::make_unique<std::vector<std::string>>();
data_set->emplace_back("entry1");
data_set->emplace_back("entry2");
data_set->emplace_back("entry3");
// First we create a shared DB so our second pass has a shared DB available.
auto db_provider_noshared = this->CreateProviderNoSharedDB();
auto unique_db_impl = this->CreateDBImpl(
ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider_noshared.get()));
this->InitDBImplAndWait(unique_db_impl.get(), kDefaultClientName, false,
Enums::InitStatus::kOK);
this->AddDataToDBImpl(unique_db_impl.get(), data_set.get());
this->UpdateClientMetadata(
SharedDBMetadataProto::MIGRATE_TO_SHARED_UNIQUE_TO_BE_DELETED);
unique_db_impl.reset();
auto db_provider_withshared = this->CreateProviderWithSharedDB();
auto shared_db_impl = this->CreateDBImpl(
ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider_withshared.get()));
this->InitDBImplAndWait(shared_db_impl.get(), kDefaultClientName, false,
Enums::InitStatus::kOK);
// Unique DB should be deleted in migration. So, unique DB should be clean.
data_set->clear();
this->VerifyDataInDBImpl(shared_db_impl.get(), data_set.get());
EXPECT_EQ(SharedDBMetadataProto::MIGRATE_TO_UNIQUE_SUCCESSFUL,
this->GetClientMigrationStatus());
}
TYPED_TEST(ProtoDatabaseImplTest, InMemoryDatabaseDoesNoMigration) {
auto data_set = std::make_unique<std::vector<std::string>>();
data_set->emplace_back("entry1");
data_set->emplace_back("entry2");
data_set->emplace_back("entry3");
auto db_provider_withshared = this->CreateProviderWithSharedDB();
// First we create a shared DB so our second pass has a shared DB available.
auto shared_db_impl = this->CreateDBImpl(
ProtoDbType::TEST_DATABASE1, this->temp_dir(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider_withshared.get()));
this->InitDBImplAndWait(shared_db_impl.get(), kDefaultClientName, true,
Enums::InitStatus::kOK);
this->AddDataToDBImpl(shared_db_impl.get(), data_set.get());
EXPECT_EQ(SharedDBMetadataProto::MIGRATE_TO_SHARED_SUCCESSFUL,
this->GetClientMigrationStatus());
shared_db_impl.reset();
// Open in memory database (unique db). This should not migrate the data from
// shared db.
auto unique_db_impl = this->CreateDBImpl(
ProtoDbType::TEST_DATABASE1, base::FilePath(),
this->GetTestThreadTaskRunner(),
this->CreateSharedProvider(db_provider_withshared.get()));