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
|
// Copyright 2012 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/sync/service/backend_migrator.h"
#include <memory>
#include "base/run_loop.h"
#include "base/test/mock_callback.h"
#include "base/test/task_environment.h"
#include "components/sync/test/data_type_manager_mock.h"
#include "components/sync/test/data_type_test_util.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
using ::testing::_;
using ::testing::Eq;
using ::testing::Mock;
using ::testing::NiceMock;
using ::testing::Return;
namespace syncer {
class SyncBackendMigratorTest : public testing::Test {
public:
SyncBackendMigratorTest() = default;
~SyncBackendMigratorTest() override = default;
void SetUp() override {
Mock::VerifyAndClear(manager());
preferred_types_.Put(BOOKMARKS);
preferred_types_.Put(PREFERENCES);
preferred_types_.Put(AUTOFILL);
migrator_ = std::make_unique<BackendMigrator>(
"Profile0", manager(), reconfigure_callback()->Get(),
migration_done_callback()->Get());
SetUnsyncedTypes(DataTypeSet());
}
void TearDown() override { migrator_.reset(); }
// Marks all types in `unsynced_types` as unsynced and all other
// types as synced.
void SetUnsyncedTypes(DataTypeSet unsynced_types) {
ON_CALL(manager_, GetStoppedDataTypesExcludingNigori())
.WillByDefault(Return(unsynced_types));
}
void SendConfigureDone(DataTypeManager::ConfigureStatus status,
DataTypeSet requested_types) {
if (status == DataTypeManager::OK) {
DataTypeManager::ConfigureResult result(status, requested_types);
migrator_->OnConfigureDone(result);
} else {
DataTypeManager::ConfigureResult result(status, requested_types);
migrator_->OnConfigureDone(result);
}
base::RunLoop run_loop;
run_loop.RunUntilIdle();
}
DataTypeManagerMock* manager() { return &manager_; }
DataTypeSet preferred_types() { return preferred_types_; }
base::MockCallback<base::RepeatingClosure>* reconfigure_callback() {
return &reconfigure_callback_;
}
base::MockCallback<base::RepeatingClosure>* migration_done_callback() {
return &migration_done_callback_;
}
BackendMigrator* migrator() { return migrator_.get(); }
private:
base::test::SingleThreadTaskEnvironment task_environment_;
DataTypeSet preferred_types_;
NiceMock<DataTypeManagerMock> manager_;
NiceMock<base::MockCallback<base::RepeatingClosure>> reconfigure_callback_;
NiceMock<base::MockCallback<base::RepeatingClosure>> migration_done_callback_;
std::unique_ptr<BackendMigrator> migrator_;
};
class MockMigrationObserver : public MigrationObserver {
public:
~MockMigrationObserver() override = default;
MOCK_METHOD(void, OnMigrationStateChange, ());
};
// Test that in the normal case a migration does transition through each state
// and wind up back in IDLE.
TEST_F(SyncBackendMigratorTest, Sanity) {
EXPECT_CALL(*migration_done_callback(), Run()).Times(0);
MockMigrationObserver migration_observer;
migrator()->AddMigrationObserver(&migration_observer);
EXPECT_CALL(migration_observer, OnMigrationStateChange()).Times(4);
DataTypeSet to_migrate, difference;
to_migrate.Put(PREFERENCES);
difference.Put(AUTOFILL);
difference.Put(BOOKMARKS);
EXPECT_CALL(*manager(), state())
.WillOnce(Return(DataTypeManager::CONFIGURED));
EXPECT_CALL(*manager(), PurgeForMigration);
EXPECT_CALL(*reconfigure_callback(), Run());
migrator()->MigrateTypes(to_migrate);
EXPECT_EQ(BackendMigrator::DISABLING_TYPES, migrator()->state());
SetUnsyncedTypes(to_migrate);
SendConfigureDone(DataTypeManager::OK, difference);
EXPECT_EQ(BackendMigrator::REENABLING_TYPES, migrator()->state());
EXPECT_CALL(*migration_done_callback(), Run());
SetUnsyncedTypes(DataTypeSet());
SendConfigureDone(DataTypeManager::OK, preferred_types());
EXPECT_EQ(BackendMigrator::IDLE, migrator()->state());
migrator()->RemoveMigrationObserver(&migration_observer);
}
// Test that in the normal case with Nigori a migration transitions through
// each state and wind up back in IDLE.
TEST_F(SyncBackendMigratorTest, MigrateNigori) {
EXPECT_CALL(*migration_done_callback(), Run()).Times(0);
DataTypeSet to_migrate, difference;
to_migrate.Put(NIGORI);
difference.Put(AUTOFILL);
difference.Put(BOOKMARKS);
EXPECT_CALL(*manager(), state())
.WillOnce(Return(DataTypeManager::CONFIGURED));
EXPECT_CALL(*manager(), PurgeForMigration);
migrator()->MigrateTypes(to_migrate);
EXPECT_EQ(BackendMigrator::DISABLING_TYPES, migrator()->state());
EXPECT_CALL(*reconfigure_callback(), Run());
SetUnsyncedTypes(to_migrate);
SendConfigureDone(DataTypeManager::OK, difference);
EXPECT_EQ(BackendMigrator::REENABLING_TYPES, migrator()->state());
EXPECT_CALL(*migration_done_callback(), Run());
SetUnsyncedTypes(DataTypeSet());
SendConfigureDone(DataTypeManager::OK, preferred_types());
EXPECT_EQ(BackendMigrator::IDLE, migrator()->state());
}
// Test that the migrator waits for the data type manager to be idle before
// starting a migration.
TEST_F(SyncBackendMigratorTest, WaitToStart) {
DataTypeSet to_migrate;
to_migrate.Put(PREFERENCES);
EXPECT_CALL(*manager(), state())
.WillOnce(Return(DataTypeManager::CONFIGURING));
EXPECT_CALL(*reconfigure_callback(), Run()).Times(0);
migrator()->MigrateTypes(to_migrate);
EXPECT_EQ(BackendMigrator::WAITING_TO_START, migrator()->state());
Mock::VerifyAndClearExpectations(manager());
EXPECT_CALL(*manager(), state())
.WillOnce(Return(DataTypeManager::CONFIGURED));
EXPECT_CALL(*manager(), PurgeForMigration);
SetUnsyncedTypes(DataTypeSet());
SendConfigureDone(DataTypeManager::OK, DataTypeSet());
EXPECT_EQ(BackendMigrator::DISABLING_TYPES, migrator()->state());
}
// Test that the migrator can cope with a migration request while a migration
// is in progress.
TEST_F(SyncBackendMigratorTest, RestartMigration) {
DataTypeSet to_migrate1, to_migrate2, to_migrate_union, bookmarks;
to_migrate1.Put(PREFERENCES);
to_migrate2.Put(AUTOFILL);
to_migrate_union.Put(PREFERENCES);
to_migrate_union.Put(AUTOFILL);
bookmarks.Put(BOOKMARKS);
EXPECT_CALL(*manager(), state())
.WillOnce(Return(DataTypeManager::CONFIGURED));
EXPECT_CALL(*manager(), PurgeForMigration).Times(2);
migrator()->MigrateTypes(to_migrate1);
EXPECT_EQ(BackendMigrator::DISABLING_TYPES, migrator()->state());
migrator()->MigrateTypes(to_migrate2);
const DataTypeSet difference1 = Difference(preferred_types(), to_migrate1);
Mock::VerifyAndClearExpectations(manager());
EXPECT_CALL(*manager(), PurgeForMigration);
EXPECT_CALL(*reconfigure_callback(), Run());
SetUnsyncedTypes(to_migrate1);
SendConfigureDone(DataTypeManager::OK, difference1);
EXPECT_EQ(BackendMigrator::DISABLING_TYPES, migrator()->state());
SetUnsyncedTypes(to_migrate_union);
SendConfigureDone(DataTypeManager::OK, bookmarks);
EXPECT_EQ(BackendMigrator::REENABLING_TYPES, migrator()->state());
}
// Test that an external invocation of Configure(...) during a migration results
// in a migration reattempt.
TEST_F(SyncBackendMigratorTest, InterruptedWhileDisablingTypes) {
DataTypeSet to_migrate;
DataTypeSet difference;
to_migrate.Put(PREFERENCES);
difference.Put(AUTOFILL);
difference.Put(BOOKMARKS);
EXPECT_CALL(*manager(), state())
.WillOnce(Return(DataTypeManager::CONFIGURED));
EXPECT_CALL(*manager(), PurgeForMigration(HasDataTypes(to_migrate)));
migrator()->MigrateTypes(to_migrate);
EXPECT_EQ(BackendMigrator::DISABLING_TYPES, migrator()->state());
Mock::VerifyAndClearExpectations(manager());
EXPECT_CALL(*manager(), PurgeForMigration(HasDataTypes(to_migrate)));
SetUnsyncedTypes(DataTypeSet());
SendConfigureDone(DataTypeManager::OK, preferred_types());
EXPECT_EQ(BackendMigrator::DISABLING_TYPES, migrator()->state());
}
// Test that spurious OnConfigureDone events don't confuse the
// migrator while it's waiting for disabled types to have been purged
// from the sync db.
TEST_F(SyncBackendMigratorTest, WaitingForPurge) {
DataTypeSet to_migrate, difference;
to_migrate.Put(PREFERENCES);
to_migrate.Put(AUTOFILL);
difference.Put(BOOKMARKS);
EXPECT_CALL(*manager(), state())
.WillOnce(Return(DataTypeManager::CONFIGURED));
EXPECT_CALL(*manager(), PurgeForMigration);
EXPECT_CALL(*reconfigure_callback(), Run());
migrator()->MigrateTypes(to_migrate);
EXPECT_EQ(BackendMigrator::DISABLING_TYPES, migrator()->state());
SendConfigureDone(DataTypeManager::OK, difference);
EXPECT_EQ(BackendMigrator::DISABLING_TYPES, migrator()->state());
DataTypeSet prefs;
prefs.Put(PREFERENCES);
SetUnsyncedTypes(prefs);
SendConfigureDone(DataTypeManager::OK, difference);
EXPECT_EQ(BackendMigrator::DISABLING_TYPES, migrator()->state());
SetUnsyncedTypes(to_migrate);
SendConfigureDone(DataTypeManager::OK, difference);
EXPECT_EQ(BackendMigrator::REENABLING_TYPES, migrator()->state());
}
TEST_F(SyncBackendMigratorTest, ConfigureFailure) {
DataTypeSet to_migrate;
to_migrate.Put(PREFERENCES);
EXPECT_CALL(*manager(), state())
.WillOnce(Return(DataTypeManager::CONFIGURED));
EXPECT_CALL(*manager(), PurgeForMigration);
migrator()->MigrateTypes(to_migrate);
SetUnsyncedTypes(DataTypeSet());
SendConfigureDone(DataTypeManager::ABORTED, DataTypeSet());
EXPECT_EQ(BackendMigrator::IDLE, migrator()->state());
}
} // namespace syncer
|
