forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsyncer_unittest.cc
4971 lines (4437 loc) · 185 KB
/
syncer_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 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.
//
// Syncer unit tests. Unfortunately a lot of these tests
// are outdated and need to be reworked and updated.
#include <algorithm>
#include <limits>
#include <list>
#include <map>
#include <set>
#include <string>
#include "base/bind.h"
#include "base/bind_helpers.h"
#include "base/callback.h"
#include "base/compiler_specific.h"
#include "base/location.h"
#include "base/memory/scoped_ptr.h"
#include "base/message_loop/message_loop.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/stringprintf.h"
#include "base/time/time.h"
#include "build/build_config.h"
#include "sync/engine/get_commit_ids.h"
#include "sync/engine/net/server_connection_manager.h"
#include "sync/engine/sync_scheduler_impl.h"
#include "sync/engine/syncer.h"
#include "sync/engine/syncer_proto_util.h"
#include "sync/internal_api/public/base/cancelation_signal.h"
#include "sync/internal_api/public/base/model_type.h"
#include "sync/internal_api/public/engine/model_safe_worker.h"
#include "sync/internal_api/public/sessions/commit_counters.h"
#include "sync/internal_api/public/sessions/status_counters.h"
#include "sync/internal_api/public/sessions/update_counters.h"
#include "sync/protocol/bookmark_specifics.pb.h"
#include "sync/protocol/nigori_specifics.pb.h"
#include "sync/protocol/preference_specifics.pb.h"
#include "sync/protocol/sync.pb.h"
#include "sync/sessions/sync_session_context.h"
#include "sync/syncable/mutable_entry.h"
#include "sync/syncable/nigori_util.h"
#include "sync/syncable/syncable_delete_journal.h"
#include "sync/syncable/syncable_read_transaction.h"
#include "sync/syncable/syncable_util.h"
#include "sync/syncable/syncable_write_transaction.h"
#include "sync/test/engine/fake_model_worker.h"
#include "sync/test/engine/mock_connection_manager.h"
#include "sync/test/engine/test_directory_setter_upper.h"
#include "sync/test/engine/test_id_factory.h"
#include "sync/test/engine/test_syncable_utils.h"
#include "sync/test/fake_encryptor.h"
#include "sync/test/fake_sync_encryption_handler.h"
#include "sync/test/sessions/mock_debug_info_getter.h"
#include "sync/util/cryptographer.h"
#include "sync/util/extensions_activity.h"
#include "sync/util/time.h"
#include "testing/gtest/include/gtest/gtest.h"
using base::TimeDelta;
using std::count;
using std::map;
using std::multimap;
using std::set;
using std::string;
using std::vector;
namespace syncer {
using syncable::BaseTransaction;
using syncable::Blob;
using syncable::CountEntriesWithName;
using syncable::Directory;
using syncable::Entry;
using syncable::GetFirstEntryWithName;
using syncable::GetOnlyEntryWithName;
using syncable::Id;
using syncable::kEncryptedString;
using syncable::MutableEntry;
using syncable::WriteTransaction;
using syncable::CREATE;
using syncable::GET_BY_HANDLE;
using syncable::GET_BY_ID;
using syncable::GET_BY_CLIENT_TAG;
using syncable::GET_BY_SERVER_TAG;
using syncable::GET_TYPE_ROOT;
using syncable::UNITTEST;
using sessions::MockDebugInfoGetter;
using sessions::StatusController;
using sessions::SyncSessionContext;
using sessions::SyncSession;
namespace {
// A helper to hold on to the counters emitted by the sync engine.
class TypeDebugInfoCache : public TypeDebugInfoObserver {
public:
TypeDebugInfoCache();
virtual ~TypeDebugInfoCache();
CommitCounters GetLatestCommitCounters(ModelType type) const;
UpdateCounters GetLatestUpdateCounters(ModelType type) const;
StatusCounters GetLatestStatusCounters(ModelType type) const;
// TypeDebugInfoObserver implementation.
virtual void OnCommitCountersUpdated(
syncer::ModelType type,
const CommitCounters& counters) OVERRIDE;
virtual void OnUpdateCountersUpdated(
syncer::ModelType type,
const UpdateCounters& counters) OVERRIDE;
virtual void OnStatusCountersUpdated(
syncer::ModelType type,
const StatusCounters& counters) OVERRIDE;
private:
std::map<ModelType, CommitCounters> commit_counters_map_;
std::map<ModelType, UpdateCounters> update_counters_map_;
std::map<ModelType, StatusCounters> status_counters_map_;
};
TypeDebugInfoCache::TypeDebugInfoCache() {}
TypeDebugInfoCache::~TypeDebugInfoCache() {}
CommitCounters TypeDebugInfoCache::GetLatestCommitCounters(
ModelType type) const {
std::map<ModelType, CommitCounters>::const_iterator it =
commit_counters_map_.find(type);
if (it == commit_counters_map_.end()) {
return CommitCounters();
} else {
return it->second;
}
}
UpdateCounters TypeDebugInfoCache::GetLatestUpdateCounters(
ModelType type) const {
std::map<ModelType, UpdateCounters>::const_iterator it =
update_counters_map_.find(type);
if (it == update_counters_map_.end()) {
return UpdateCounters();
} else {
return it->second;
}
}
StatusCounters TypeDebugInfoCache::GetLatestStatusCounters(
ModelType type) const {
std::map<ModelType, StatusCounters>::const_iterator it =
status_counters_map_.find(type);
if (it == status_counters_map_.end()) {
return StatusCounters();
} else {
return it->second;
}
}
void TypeDebugInfoCache::OnCommitCountersUpdated(
syncer::ModelType type,
const CommitCounters& counters) {
commit_counters_map_[type] = counters;
}
void TypeDebugInfoCache::OnUpdateCountersUpdated(
syncer::ModelType type,
const UpdateCounters& counters) {
update_counters_map_[type] = counters;
}
void TypeDebugInfoCache::OnStatusCountersUpdated(
syncer::ModelType type,
const StatusCounters& counters) {
status_counters_map_[type] = counters;
}
} // namespace
class SyncerTest : public testing::Test,
public SyncSession::Delegate,
public SyncEngineEventListener {
protected:
SyncerTest()
: extensions_activity_(new ExtensionsActivity),
syncer_(NULL),
saw_syncer_event_(false),
last_client_invalidation_hint_buffer_size_(10) {
}
// SyncSession::Delegate implementation.
virtual void OnThrottled(const base::TimeDelta& throttle_duration) OVERRIDE {
FAIL() << "Should not get silenced.";
}
virtual void OnTypesThrottled(
ModelTypeSet types,
const base::TimeDelta& throttle_duration) OVERRIDE {
FAIL() << "Should not get silenced.";
}
virtual bool IsCurrentlyThrottled() OVERRIDE {
return false;
}
virtual void OnReceivedLongPollIntervalUpdate(
const base::TimeDelta& new_interval) OVERRIDE {
last_long_poll_interval_received_ = new_interval;
}
virtual void OnReceivedShortPollIntervalUpdate(
const base::TimeDelta& new_interval) OVERRIDE {
last_short_poll_interval_received_ = new_interval;
}
virtual void OnReceivedSessionsCommitDelay(
const base::TimeDelta& new_delay) OVERRIDE {
last_sessions_commit_delay_seconds_ = new_delay;
}
virtual void OnReceivedClientInvalidationHintBufferSize(
int size) OVERRIDE {
last_client_invalidation_hint_buffer_size_ = size;
}
virtual void OnReceivedGuRetryDelay(const base::TimeDelta& delay) OVERRIDE {}
virtual void OnReceivedMigrationRequest(ModelTypeSet types) OVERRIDE {}
virtual void OnProtocolEvent(const ProtocolEvent& event) OVERRIDE {}
virtual void OnSyncProtocolError(const SyncProtocolError& error) OVERRIDE {}
void GetModelSafeRoutingInfo(ModelSafeRoutingInfo* out) {
// We're just testing the sync engine here, so we shunt everything to
// the SyncerThread. Datatypes which aren't enabled aren't in the map.
for (ModelTypeSet::Iterator it = enabled_datatypes_.First();
it.Good(); it.Inc()) {
(*out)[it.Get()] = GROUP_PASSIVE;
}
}
virtual void OnSyncCycleEvent(const SyncCycleEvent& event) OVERRIDE {
DVLOG(1) << "HandleSyncEngineEvent in unittest " << event.what_happened;
// we only test for entry-specific events, not status changed ones.
switch (event.what_happened) {
case SyncCycleEvent::SYNC_CYCLE_BEGIN: // Fall through.
case SyncCycleEvent::STATUS_CHANGED:
case SyncCycleEvent::SYNC_CYCLE_ENDED:
return;
default:
CHECK(false) << "Handling unknown error type in unit tests!!";
}
saw_syncer_event_ = true;
}
virtual void OnActionableError(const SyncProtocolError& error) OVERRIDE {}
virtual void OnRetryTimeChanged(base::Time retry_time) OVERRIDE {}
virtual void OnThrottledTypesChanged(ModelTypeSet throttled_types) OVERRIDE {}
virtual void OnMigrationRequested(ModelTypeSet types) OVERRIDE {}
void ResetSession() {
session_.reset(SyncSession::Build(context_.get(), this));
}
void SyncShareNudge() {
ResetSession();
// Pretend we've seen a local change, to make the nudge_tracker look normal.
nudge_tracker_.RecordLocalChange(ModelTypeSet(BOOKMARKS));
EXPECT_TRUE(
syncer_->NormalSyncShare(
context_->GetEnabledTypes(),
nudge_tracker_,
session_.get()));
}
void SyncShareConfigure() {
ResetSession();
EXPECT_TRUE(syncer_->ConfigureSyncShare(
context_->GetEnabledTypes(),
sync_pb::GetUpdatesCallerInfo::RECONFIGURATION,
session_.get()));
}
virtual void SetUp() {
dir_maker_.SetUp();
mock_server_.reset(new MockConnectionManager(directory(),
&cancelation_signal_));
debug_info_getter_.reset(new MockDebugInfoGetter);
EnableDatatype(BOOKMARKS);
EnableDatatype(NIGORI);
EnableDatatype(PREFERENCES);
EnableDatatype(NIGORI);
workers_.push_back(scoped_refptr<ModelSafeWorker>(
new FakeModelWorker(GROUP_PASSIVE)));
std::vector<SyncEngineEventListener*> listeners;
listeners.push_back(this);
ModelSafeRoutingInfo routing_info;
GetModelSafeRoutingInfo(&routing_info);
model_type_registry_.reset(new ModelTypeRegistry(workers_, directory()));
model_type_registry_->RegisterDirectoryTypeDebugInfoObserver(
&debug_info_cache_);
context_.reset(
new SyncSessionContext(
mock_server_.get(), directory(),
extensions_activity_,
listeners, debug_info_getter_.get(),
model_type_registry_.get(),
true, // enable keystore encryption
false, // force enable pre-commit GU avoidance experiment
"fake_invalidator_client_id"));
context_->SetRoutingInfo(routing_info);
syncer_ = new Syncer(&cancelation_signal_);
syncable::ReadTransaction trans(FROM_HERE, directory());
syncable::Directory::Metahandles children;
directory()->GetChildHandlesById(&trans, trans.root_id(), &children);
ASSERT_EQ(0u, children.size());
saw_syncer_event_ = false;
root_id_ = TestIdFactory::root();
parent_id_ = ids_.MakeServer("parent id");
child_id_ = ids_.MakeServer("child id");
directory()->set_store_birthday(mock_server_->store_birthday());
mock_server_->SetKeystoreKey("encryption_key");
}
virtual void TearDown() {
model_type_registry_->UnregisterDirectoryTypeDebugInfoObserver(
&debug_info_cache_);
mock_server_.reset();
delete syncer_;
syncer_ = NULL;
dir_maker_.TearDown();
}
void WriteTestDataToEntry(WriteTransaction* trans, MutableEntry* entry) {
EXPECT_FALSE(entry->GetIsDir());
EXPECT_FALSE(entry->GetIsDel());
sync_pb::EntitySpecifics specifics;
specifics.mutable_bookmark()->set_url("http://demo/");
specifics.mutable_bookmark()->set_favicon("PNG");
entry->PutSpecifics(specifics);
entry->PutIsUnsynced(true);
}
void VerifyTestDataInEntry(BaseTransaction* trans, Entry* entry) {
EXPECT_FALSE(entry->GetIsDir());
EXPECT_FALSE(entry->GetIsDel());
VerifyTestBookmarkDataInEntry(entry);
}
void VerifyTestBookmarkDataInEntry(Entry* entry) {
const sync_pb::EntitySpecifics& specifics = entry->GetSpecifics();
EXPECT_TRUE(specifics.has_bookmark());
EXPECT_EQ("PNG", specifics.bookmark().favicon());
EXPECT_EQ("http://demo/", specifics.bookmark().url());
}
void VerifyHierarchyConflictsReported(
const sync_pb::ClientToServerMessage& message) {
// Our request should have included a warning about hierarchy conflicts.
const sync_pb::ClientStatus& client_status = message.client_status();
EXPECT_TRUE(client_status.has_hierarchy_conflict_detected());
EXPECT_TRUE(client_status.hierarchy_conflict_detected());
}
void VerifyNoHierarchyConflictsReported(
const sync_pb::ClientToServerMessage& message) {
// Our request should have reported no hierarchy conflicts detected.
const sync_pb::ClientStatus& client_status = message.client_status();
EXPECT_TRUE(client_status.has_hierarchy_conflict_detected());
EXPECT_FALSE(client_status.hierarchy_conflict_detected());
}
void VerifyHierarchyConflictsUnspecified(
const sync_pb::ClientToServerMessage& message) {
// Our request should have neither confirmed nor denied hierarchy conflicts.
const sync_pb::ClientStatus& client_status = message.client_status();
EXPECT_FALSE(client_status.has_hierarchy_conflict_detected());
}
sync_pb::EntitySpecifics DefaultBookmarkSpecifics() {
sync_pb::EntitySpecifics result;
AddDefaultFieldValue(BOOKMARKS, &result);
return result;
}
sync_pb::EntitySpecifics DefaultPreferencesSpecifics() {
sync_pb::EntitySpecifics result;
AddDefaultFieldValue(PREFERENCES, &result);
return result;
}
// Enumeration of alterations to entries for commit ordering tests.
enum EntryFeature {
LIST_END = 0, // Denotes the end of the list of features from below.
SYNCED, // Items are unsynced by default
DELETED,
OLD_MTIME,
MOVED_FROM_ROOT,
};
struct CommitOrderingTest {
// expected commit index.
int commit_index;
// Details about the item
syncable::Id id;
syncable::Id parent_id;
EntryFeature features[10];
static CommitOrderingTest MakeLastCommitItem() {
CommitOrderingTest last_commit_item;
last_commit_item.commit_index = -1;
last_commit_item.id = TestIdFactory::root();
return last_commit_item;
}
};
void RunCommitOrderingTest(CommitOrderingTest* test) {
map<int, syncable::Id> expected_positions;
{ // Transaction scope.
WriteTransaction trans(FROM_HERE, UNITTEST, directory());
while (!test->id.IsRoot()) {
if (test->commit_index >= 0) {
map<int, syncable::Id>::value_type entry(test->commit_index,
test->id);
bool double_position = !expected_positions.insert(entry).second;
ASSERT_FALSE(double_position) << "Two id's expected at one position";
}
string utf8_name = test->id.GetServerId();
string name(utf8_name.begin(), utf8_name.end());
MutableEntry entry(&trans, CREATE, BOOKMARKS, test->parent_id, name);
entry.PutId(test->id);
if (test->id.ServerKnows()) {
entry.PutBaseVersion(5);
entry.PutServerVersion(5);
entry.PutServerParentId(test->parent_id);
}
entry.PutIsDir(true);
entry.PutIsUnsynced(true);
entry.PutSpecifics(DefaultBookmarkSpecifics());
// Set the time to 30 seconds in the future to reduce the chance of
// flaky tests.
const base::Time& now_plus_30s =
base::Time::Now() + base::TimeDelta::FromSeconds(30);
const base::Time& now_minus_2h =
base::Time::Now() - base::TimeDelta::FromHours(2);
entry.PutMtime(now_plus_30s);
for (size_t i = 0 ; i < arraysize(test->features) ; ++i) {
switch (test->features[i]) {
case LIST_END:
break;
case SYNCED:
entry.PutIsUnsynced(false);
break;
case DELETED:
entry.PutIsDel(true);
break;
case OLD_MTIME:
entry.PutMtime(now_minus_2h);
break;
case MOVED_FROM_ROOT:
entry.PutServerParentId(trans.root_id());
break;
default:
FAIL() << "Bad value in CommitOrderingTest list";
}
}
test++;
}
}
SyncShareNudge();
ASSERT_TRUE(expected_positions.size() ==
mock_server_->committed_ids().size());
// If this test starts failing, be aware other sort orders could be valid.
for (size_t i = 0; i < expected_positions.size(); ++i) {
SCOPED_TRACE(i);
EXPECT_EQ(1u, expected_positions.count(i));
EXPECT_EQ(expected_positions[i], mock_server_->committed_ids()[i]);
}
}
CommitCounters GetCommitCounters(ModelType type) {
return debug_info_cache_.GetLatestCommitCounters(type);
}
UpdateCounters GetUpdateCounters(ModelType type) {
return debug_info_cache_.GetLatestUpdateCounters(type);
}
StatusCounters GetStatusCounters(ModelType type) {
return debug_info_cache_.GetLatestStatusCounters(type);
}
Directory* directory() {
return dir_maker_.directory();
}
const std::string local_cache_guid() {
return directory()->cache_guid();
}
const std::string foreign_cache_guid() {
return "kqyg7097kro6GSUod+GSg==";
}
int64 CreateUnsyncedDirectory(const string& entry_name,
const string& idstring) {
return CreateUnsyncedDirectory(entry_name,
syncable::Id::CreateFromServerId(idstring));
}
int64 CreateUnsyncedDirectory(const string& entry_name,
const syncable::Id& id) {
WriteTransaction wtrans(FROM_HERE, UNITTEST, directory());
MutableEntry entry(
&wtrans, CREATE, BOOKMARKS, wtrans.root_id(), entry_name);
EXPECT_TRUE(entry.good());
entry.PutIsUnsynced(true);
entry.PutIsDir(true);
entry.PutSpecifics(DefaultBookmarkSpecifics());
entry.PutBaseVersion(id.ServerKnows() ? 1 : 0);
entry.PutId(id);
return entry.GetMetahandle();
}
void EnableDatatype(ModelType model_type) {
enabled_datatypes_.Put(model_type);
ModelSafeRoutingInfo routing_info;
GetModelSafeRoutingInfo(&routing_info);
if (context_) {
context_->SetRoutingInfo(routing_info);
}
mock_server_->ExpectGetUpdatesRequestTypes(enabled_datatypes_);
}
void DisableDatatype(ModelType model_type) {
enabled_datatypes_.Remove(model_type);
ModelSafeRoutingInfo routing_info;
GetModelSafeRoutingInfo(&routing_info);
if (context_) {
context_->SetRoutingInfo(routing_info);
}
mock_server_->ExpectGetUpdatesRequestTypes(enabled_datatypes_);
}
Cryptographer* GetCryptographer(syncable::BaseTransaction* trans) {
return directory()->GetCryptographer(trans);
}
// Configures SyncSessionContext and NudgeTracker so Syncer won't call
// GetUpdates prior to Commit. This method can be used to ensure a Commit is
// not preceeded by GetUpdates.
void ConfigureNoGetUpdatesRequired() {
context_->set_server_enabled_pre_commit_update_avoidance(true);
nudge_tracker_.OnInvalidationsEnabled();
nudge_tracker_.RecordSuccessfulSyncCycle();
ASSERT_FALSE(context_->ShouldFetchUpdatesBeforeCommit());
ASSERT_FALSE(nudge_tracker_.IsGetUpdatesRequired());
}
base::MessageLoop message_loop_;
// Some ids to aid tests. Only the root one's value is specific. The rest
// are named for test clarity.
// TODO(chron): Get rid of these inbuilt IDs. They only make it
// more confusing.
syncable::Id root_id_;
syncable::Id parent_id_;
syncable::Id child_id_;
TestIdFactory ids_;
TestDirectorySetterUpper dir_maker_;
FakeEncryptor encryptor_;
scoped_refptr<ExtensionsActivity> extensions_activity_;
scoped_ptr<MockConnectionManager> mock_server_;
CancelationSignal cancelation_signal_;
Syncer* syncer_;
scoped_ptr<SyncSession> session_;
TypeDebugInfoCache debug_info_cache_;
scoped_ptr<ModelTypeRegistry> model_type_registry_;
scoped_ptr<SyncSessionContext> context_;
bool saw_syncer_event_;
base::TimeDelta last_short_poll_interval_received_;
base::TimeDelta last_long_poll_interval_received_;
base::TimeDelta last_sessions_commit_delay_seconds_;
int last_client_invalidation_hint_buffer_size_;
std::vector<scoped_refptr<ModelSafeWorker> > workers_;
ModelTypeSet enabled_datatypes_;
sessions::NudgeTracker nudge_tracker_;
scoped_ptr<MockDebugInfoGetter> debug_info_getter_;
DISALLOW_COPY_AND_ASSIGN(SyncerTest);
};
TEST_F(SyncerTest, TestCallGatherUnsyncedEntries) {
{
Syncer::UnsyncedMetaHandles handles;
{
syncable::ReadTransaction trans(FROM_HERE, directory());
GetUnsyncedEntries(&trans, &handles);
}
ASSERT_EQ(0u, handles.size());
}
// TODO(sync): When we can dynamically connect and disconnect the mock
// ServerConnectionManager test disconnected GetUnsyncedEntries here. It's a
// regression for a very old bug.
}
TEST_F(SyncerTest, GetCommitIdsFiltersThrottledEntries) {
const ModelTypeSet throttled_types(BOOKMARKS);
sync_pb::EntitySpecifics bookmark_data;
AddDefaultFieldValue(BOOKMARKS, &bookmark_data);
mock_server_->AddUpdateDirectory(1, 0, "A", 10, 10,
foreign_cache_guid(), "-1");
SyncShareNudge();
{
WriteTransaction wtrans(FROM_HERE, UNITTEST, directory());
MutableEntry A(&wtrans, GET_BY_ID, ids_.FromNumber(1));
ASSERT_TRUE(A.good());
A.PutIsUnsynced(true);
A.PutSpecifics(bookmark_data);
A.PutNonUniqueName("bookmark");
}
// Now sync without enabling bookmarks.
mock_server_->ExpectGetUpdatesRequestTypes(
Difference(context_->GetEnabledTypes(), ModelTypeSet(BOOKMARKS)));
ResetSession();
syncer_->NormalSyncShare(
Difference(context_->GetEnabledTypes(), ModelTypeSet(BOOKMARKS)),
nudge_tracker_,
session_.get());
{
// Nothing should have been committed as bookmarks is throttled.
syncable::ReadTransaction rtrans(FROM_HERE, directory());
Entry entryA(&rtrans, syncable::GET_BY_ID, ids_.FromNumber(1));
ASSERT_TRUE(entryA.good());
EXPECT_TRUE(entryA.GetIsUnsynced());
}
// Sync again with bookmarks enabled.
mock_server_->ExpectGetUpdatesRequestTypes(context_->GetEnabledTypes());
SyncShareNudge();
{
// It should have been committed.
syncable::ReadTransaction rtrans(FROM_HERE, directory());
Entry entryA(&rtrans, syncable::GET_BY_ID, ids_.FromNumber(1));
ASSERT_TRUE(entryA.good());
EXPECT_FALSE(entryA.GetIsUnsynced());
}
}
// We use a macro so we can preserve the error location.
#define VERIFY_ENTRY(id, is_unapplied, is_unsynced, prev_initialized, \
parent_id, version, server_version, id_fac, rtrans) \
do { \
Entry entryA(rtrans, syncable::GET_BY_ID, id_fac.FromNumber(id)); \
ASSERT_TRUE(entryA.good()); \
/* We don't use EXPECT_EQ here because when the left side param is false,
gcc 4.6 warns about converting 'false' to pointer type for argument 1. */ \
EXPECT_TRUE(is_unsynced == entryA.GetIsUnsynced()); \
EXPECT_TRUE(is_unapplied == entryA.GetIsUnappliedUpdate()); \
EXPECT_TRUE(prev_initialized == \
IsRealDataType(GetModelTypeFromSpecifics( \
entryA.GetBaseServerSpecifics()))); \
EXPECT_TRUE(parent_id == -1 || \
entryA.GetParentId()== id_fac.FromNumber(parent_id)); \
EXPECT_EQ(version, entryA.GetBaseVersion()); \
EXPECT_EQ(server_version, entryA.GetServerVersion()); \
} while (0)
TEST_F(SyncerTest, GetCommitIdsFiltersUnreadyEntries) {
KeyParams key_params = {"localhost", "dummy", "foobar"};
KeyParams other_params = {"localhost", "dummy", "foobar2"};
sync_pb::EntitySpecifics bookmark, encrypted_bookmark;
bookmark.mutable_bookmark()->set_url("url");
bookmark.mutable_bookmark()->set_title("title");
AddDefaultFieldValue(BOOKMARKS, &encrypted_bookmark);
mock_server_->AddUpdateDirectory(1, 0, "A", 10, 10,
foreign_cache_guid(), "-1");
mock_server_->AddUpdateDirectory(2, 0, "B", 10, 10,
foreign_cache_guid(), "-2");
mock_server_->AddUpdateDirectory(3, 0, "C", 10, 10,
foreign_cache_guid(), "-3");
mock_server_->AddUpdateDirectory(4, 0, "D", 10, 10,
foreign_cache_guid(), "-4");
SyncShareNudge();
// Server side change will put A in conflict.
mock_server_->AddUpdateDirectory(1, 0, "A", 20, 20,
foreign_cache_guid(), "-1");
{
// Mark bookmarks as encrypted and set the cryptographer to have pending
// keys.
WriteTransaction wtrans(FROM_HERE, UNITTEST, directory());
Cryptographer other_cryptographer(&encryptor_);
other_cryptographer.AddKey(other_params);
sync_pb::EntitySpecifics specifics;
sync_pb::NigoriSpecifics* nigori = specifics.mutable_nigori();
other_cryptographer.GetKeys(nigori->mutable_encryption_keybag());
dir_maker_.encryption_handler()->EnableEncryptEverything();
// Set up with an old passphrase, but have pending keys
GetCryptographer(&wtrans)->AddKey(key_params);
GetCryptographer(&wtrans)->Encrypt(bookmark,
encrypted_bookmark.mutable_encrypted());
GetCryptographer(&wtrans)->SetPendingKeys(nigori->encryption_keybag());
// In conflict but properly encrypted.
MutableEntry A(&wtrans, GET_BY_ID, ids_.FromNumber(1));
ASSERT_TRUE(A.good());
A.PutIsUnsynced(true);
A.PutSpecifics(encrypted_bookmark);
A.PutNonUniqueName(kEncryptedString);
// Not in conflict and properly encrypted.
MutableEntry B(&wtrans, GET_BY_ID, ids_.FromNumber(2));
ASSERT_TRUE(B.good());
B.PutIsUnsynced(true);
B.PutSpecifics(encrypted_bookmark);
B.PutNonUniqueName(kEncryptedString);
// Unencrypted specifics.
MutableEntry C(&wtrans, GET_BY_ID, ids_.FromNumber(3));
ASSERT_TRUE(C.good());
C.PutIsUnsynced(true);
C.PutNonUniqueName(kEncryptedString);
// Unencrypted non_unique_name.
MutableEntry D(&wtrans, GET_BY_ID, ids_.FromNumber(4));
ASSERT_TRUE(D.good());
D.PutIsUnsynced(true);
D.PutSpecifics(encrypted_bookmark);
D.PutNonUniqueName("not encrypted");
}
SyncShareNudge();
{
// Nothing should have commited due to bookmarks being encrypted and
// the cryptographer having pending keys. A would have been resolved
// as a simple conflict, but still be unsynced until the next sync cycle.
syncable::ReadTransaction rtrans(FROM_HERE, directory());
VERIFY_ENTRY(1, false, true, false, 0, 20, 20, ids_, &rtrans);
VERIFY_ENTRY(2, false, true, false, 0, 10, 10, ids_, &rtrans);
VERIFY_ENTRY(3, false, true, false, 0, 10, 10, ids_, &rtrans);
VERIFY_ENTRY(4, false, true, false, 0, 10, 10, ids_, &rtrans);
// Resolve the pending keys.
GetCryptographer(&rtrans)->DecryptPendingKeys(other_params);
}
SyncShareNudge();
{
// All properly encrypted and non-conflicting items should commit. "A" was
// conflicting, but last sync cycle resolved it as simple conflict, so on
// this sync cycle it committed succesfullly.
syncable::ReadTransaction rtrans(FROM_HERE, directory());
// Committed successfully.
VERIFY_ENTRY(1, false, false, false, 0, 21, 21, ids_, &rtrans);
// Committed successfully.
VERIFY_ENTRY(2, false, false, false, 0, 11, 11, ids_, &rtrans);
// Was not properly encrypted.
VERIFY_ENTRY(3, false, true, false, 0, 10, 10, ids_, &rtrans);
// Was not properly encrypted.
VERIFY_ENTRY(4, false, true, false, 0, 10, 10, ids_, &rtrans);
}
{
// Fix the remaining items.
WriteTransaction wtrans(FROM_HERE, UNITTEST, directory());
MutableEntry C(&wtrans, GET_BY_ID, ids_.FromNumber(3));
ASSERT_TRUE(C.good());
C.PutSpecifics(encrypted_bookmark);
C.PutNonUniqueName(kEncryptedString);
MutableEntry D(&wtrans, GET_BY_ID, ids_.FromNumber(4));
ASSERT_TRUE(D.good());
D.PutSpecifics(encrypted_bookmark);
D.PutNonUniqueName(kEncryptedString);
}
SyncShareNudge();
{
const StatusController& status_controller = session_->status_controller();
// Expect success.
EXPECT_EQ(status_controller.model_neutral_state().commit_result, SYNCER_OK);
// None should be unsynced anymore.
syncable::ReadTransaction rtrans(FROM_HERE, directory());
VERIFY_ENTRY(1, false, false, false, 0, 21, 21, ids_, &rtrans);
VERIFY_ENTRY(2, false, false, false, 0, 11, 11, ids_, &rtrans);
VERIFY_ENTRY(3, false, false, false, 0, 11, 11, ids_, &rtrans);
VERIFY_ENTRY(4, false, false, false, 0, 11, 11, ids_, &rtrans);
}
}
TEST_F(SyncerTest, EncryptionAwareConflicts) {
KeyParams key_params = {"localhost", "dummy", "foobar"};
Cryptographer other_cryptographer(&encryptor_);
other_cryptographer.AddKey(key_params);
sync_pb::EntitySpecifics bookmark, encrypted_bookmark, modified_bookmark;
bookmark.mutable_bookmark()->set_title("title");
other_cryptographer.Encrypt(bookmark,
encrypted_bookmark.mutable_encrypted());
AddDefaultFieldValue(BOOKMARKS, &encrypted_bookmark);
modified_bookmark.mutable_bookmark()->set_title("title2");
other_cryptographer.Encrypt(modified_bookmark,
modified_bookmark.mutable_encrypted());
sync_pb::EntitySpecifics pref, encrypted_pref, modified_pref;
pref.mutable_preference()->set_name("name");
AddDefaultFieldValue(PREFERENCES, &encrypted_pref);
other_cryptographer.Encrypt(pref,
encrypted_pref.mutable_encrypted());
modified_pref.mutable_preference()->set_name("name2");
other_cryptographer.Encrypt(modified_pref,
modified_pref.mutable_encrypted());
{
// Mark bookmarks and preferences as encrypted and set the cryptographer to
// have pending keys.
WriteTransaction wtrans(FROM_HERE, UNITTEST, directory());
sync_pb::EntitySpecifics specifics;
sync_pb::NigoriSpecifics* nigori = specifics.mutable_nigori();
other_cryptographer.GetKeys(nigori->mutable_encryption_keybag());
dir_maker_.encryption_handler()->EnableEncryptEverything();
GetCryptographer(&wtrans)->SetPendingKeys(nigori->encryption_keybag());
EXPECT_TRUE(GetCryptographer(&wtrans)->has_pending_keys());
}
// We need to remember the exact position of our local items, so we can
// make updates that do not modify those positions.
UniquePosition pos1;
UniquePosition pos2;
UniquePosition pos3;
mock_server_->AddUpdateSpecifics(1, 0, "A", 10, 10, true, 0, bookmark,
foreign_cache_guid(), "-1");
mock_server_->AddUpdateSpecifics(2, 1, "B", 10, 10, false, 2, bookmark,
foreign_cache_guid(), "-2");
mock_server_->AddUpdateSpecifics(3, 1, "C", 10, 10, false, 1, bookmark,
foreign_cache_guid(), "-3");
mock_server_->AddUpdateSpecifics(4, 0, "D", 10, 10, false, 0, pref);
SyncShareNudge();
{
// Initial state. Everything is normal.
syncable::ReadTransaction rtrans(FROM_HERE, directory());
VERIFY_ENTRY(1, false, false, false, 0, 10, 10, ids_, &rtrans);
VERIFY_ENTRY(2, false, false, false, 1, 10, 10, ids_, &rtrans);
VERIFY_ENTRY(3, false, false, false, 1, 10, 10, ids_, &rtrans);
VERIFY_ENTRY(4, false, false, false, 0, 10, 10, ids_, &rtrans);
Entry entry1(&rtrans, syncable::GET_BY_ID, ids_.FromNumber(1));
ASSERT_TRUE(entry1.GetUniquePosition().Equals(
entry1.GetServerUniquePosition()));
pos1 = entry1.GetUniquePosition();
Entry entry2(&rtrans, syncable::GET_BY_ID, ids_.FromNumber(2));
pos2 = entry2.GetUniquePosition();
Entry entry3(&rtrans, syncable::GET_BY_ID, ids_.FromNumber(3));
pos3 = entry3.GetUniquePosition();
}
// Server side encryption will not be applied due to undecryptable data.
// At this point, BASE_SERVER_SPECIFICS should be filled for all four items.
mock_server_->AddUpdateSpecifics(1, 0, kEncryptedString, 20, 20, true, 0,
encrypted_bookmark,
foreign_cache_guid(), "-1");
mock_server_->AddUpdateSpecifics(2, 1, kEncryptedString, 20, 20, false, 2,
encrypted_bookmark,
foreign_cache_guid(), "-2");
mock_server_->AddUpdateSpecifics(3, 1, kEncryptedString, 20, 20, false, 1,
encrypted_bookmark,
foreign_cache_guid(), "-3");
mock_server_->AddUpdateSpecifics(4, 0, kEncryptedString, 20, 20, false, 0,
encrypted_pref,
foreign_cache_guid(), "-4");
SyncShareNudge();
{
// All should be unapplied due to being undecryptable and have a valid
// BASE_SERVER_SPECIFICS.
syncable::ReadTransaction rtrans(FROM_HERE, directory());
VERIFY_ENTRY(1, true, false, true, 0, 10, 20, ids_, &rtrans);
VERIFY_ENTRY(2, true, false, true, 1, 10, 20, ids_, &rtrans);
VERIFY_ENTRY(3, true, false, true, 1, 10, 20, ids_, &rtrans);
VERIFY_ENTRY(4, true, false, true, 0, 10, 20, ids_, &rtrans);
}
// Server side change that don't modify anything should not affect
// BASE_SERVER_SPECIFICS (such as name changes and mtime changes).
mock_server_->AddUpdateSpecifics(1, 0, kEncryptedString, 30, 30, true, 0,
encrypted_bookmark,
foreign_cache_guid(), "-1");
mock_server_->AddUpdateSpecifics(2, 1, kEncryptedString, 30, 30, false, 2,
encrypted_bookmark,
foreign_cache_guid(), "-2");
// Item 3 doesn't change.
mock_server_->AddUpdateSpecifics(4, 0, kEncryptedString, 30, 30, false, 0,
encrypted_pref,
foreign_cache_guid(), "-4");
SyncShareNudge();
{
// Items 1, 2, and 4 should have newer server versions, 3 remains the same.
// All should remain unapplied due to be undecryptable.
syncable::ReadTransaction rtrans(FROM_HERE, directory());
VERIFY_ENTRY(1, true, false, true, 0, 10, 30, ids_, &rtrans);
VERIFY_ENTRY(2, true, false, true, 1, 10, 30, ids_, &rtrans);
VERIFY_ENTRY(3, true, false, true, 1, 10, 20, ids_, &rtrans);
VERIFY_ENTRY(4, true, false, true, 0, 10, 30, ids_, &rtrans);
}
// Positional changes, parent changes, and specifics changes should reset
// BASE_SERVER_SPECIFICS.
// Became unencrypted.
mock_server_->AddUpdateSpecifics(1, 0, "A", 40, 40, true, 0, bookmark,
foreign_cache_guid(), "-1");
// Reordered to after item 2.
mock_server_->AddUpdateSpecifics(3, 1, kEncryptedString, 30, 30, false, 3,
encrypted_bookmark,
foreign_cache_guid(), "-3");
SyncShareNudge();
{
// Items 2 and 4 should be the only ones with BASE_SERVER_SPECIFICS set.
// Items 1 is now unencrypted, so should have applied normally.
syncable::ReadTransaction rtrans(FROM_HERE, directory());
VERIFY_ENTRY(1, false, false, false, 0, 40, 40, ids_, &rtrans);
VERIFY_ENTRY(2, true, false, true, 1, 10, 30, ids_, &rtrans);
VERIFY_ENTRY(3, true, false, false, 1, 10, 30, ids_, &rtrans);
VERIFY_ENTRY(4, true, false, true, 0, 10, 30, ids_, &rtrans);
}
// Make local changes, which should remain unsynced for items 2, 3, 4.
{
WriteTransaction wtrans(FROM_HERE, UNITTEST, directory());
MutableEntry A(&wtrans, GET_BY_ID, ids_.FromNumber(1));
ASSERT_TRUE(A.good());
A.PutSpecifics(modified_bookmark);
A.PutNonUniqueName(kEncryptedString);
A.PutIsUnsynced(true);
MutableEntry B(&wtrans, GET_BY_ID, ids_.FromNumber(2));
ASSERT_TRUE(B.good());
B.PutSpecifics(modified_bookmark);
B.PutNonUniqueName(kEncryptedString);
B.PutIsUnsynced(true);
MutableEntry C(&wtrans, GET_BY_ID, ids_.FromNumber(3));
ASSERT_TRUE(C.good());
C.PutSpecifics(modified_bookmark);
C.PutNonUniqueName(kEncryptedString);
C.PutIsUnsynced(true);
MutableEntry D(&wtrans, GET_BY_ID, ids_.FromNumber(4));
ASSERT_TRUE(D.good());
D.PutSpecifics(modified_pref);
D.PutNonUniqueName(kEncryptedString);
D.PutIsUnsynced(true);
}
SyncShareNudge();
{
// Item 1 remains unsynced due to there being pending keys.
// Items 2, 3, 4 should remain unsynced since they were not up to date.
syncable::ReadTransaction rtrans(FROM_HERE, directory());
VERIFY_ENTRY(1, false, true, false, 0, 40, 40, ids_, &rtrans);
VERIFY_ENTRY(2, true, true, true, 1, 10, 30, ids_, &rtrans);
VERIFY_ENTRY(3, true, true, false, 1, 10, 30, ids_, &rtrans);
VERIFY_ENTRY(4, true, true, true, 0, 10, 30, ids_, &rtrans);
}
{
syncable::ReadTransaction rtrans(FROM_HERE, directory());
// Resolve the pending keys.
GetCryptographer(&rtrans)->DecryptPendingKeys(key_params);
}
// First cycle resolves conflicts, second cycle commits changes.
SyncShareNudge();
EXPECT_EQ(1, GetUpdateCounters(BOOKMARKS).num_server_overwrites);
EXPECT_EQ(1, GetUpdateCounters(PREFERENCES).num_server_overwrites);
EXPECT_EQ(1, GetUpdateCounters(BOOKMARKS).num_local_overwrites);
// We successfully commited item(s).
EXPECT_EQ(2, GetCommitCounters(BOOKMARKS).num_commits_attempted);
EXPECT_EQ(2, GetCommitCounters(BOOKMARKS).num_commits_success);
EXPECT_EQ(1, GetCommitCounters(PREFERENCES).num_commits_attempted);
EXPECT_EQ(1, GetCommitCounters(PREFERENCES).num_commits_success);
SyncShareNudge();
// Everything should be resolved now. The local changes should have
// overwritten the server changes for 2 and 4, while the server changes
// overwrote the local for entry 3.
//
// Expect there will be no new overwrites.
EXPECT_EQ(1, GetUpdateCounters(BOOKMARKS).num_server_overwrites);
EXPECT_EQ(1, GetUpdateCounters(BOOKMARKS).num_local_overwrites);
EXPECT_EQ(2, GetCommitCounters(BOOKMARKS).num_commits_success);
EXPECT_EQ(1, GetCommitCounters(PREFERENCES).num_commits_success);
syncable::ReadTransaction rtrans(FROM_HERE, directory());
VERIFY_ENTRY(1, false, false, false, 0, 41, 41, ids_, &rtrans);
VERIFY_ENTRY(2, false, false, false, 1, 31, 31, ids_, &rtrans);
VERIFY_ENTRY(3, false, false, false, 1, 30, 30, ids_, &rtrans);
VERIFY_ENTRY(4, false, false, false, 0, 31, 31, ids_, &rtrans);
}