123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274 |
- // Copyright (c) 2012 The Chromium Authors. All rights reserved.
- // Use of this source code is governed by a BSD-style license that can be
- // found in the LICENSE file.
- #include "components/sync/driver/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/base/model_type_test_util.h"
- #include "components/sync/driver/data_type_manager_mock.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(ModelTypeSet());
- }
- void TearDown() override { migrator_.reset(); }
- // Marks all types in |unsynced_types| as unsynced and all other
- // types as synced.
- void SetUnsyncedTypes(ModelTypeSet unsynced_types) {
- ON_CALL(manager_, GetPurgedDataTypes())
- .WillByDefault(Return(unsynced_types));
- }
- void SendConfigureDone(DataTypeManager::ConfigureStatus status,
- ModelTypeSet 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_; }
- ModelTypeSet 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_;
- ModelTypeSet 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);
- ModelTypeSet 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(ModelTypeSet());
- 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);
- ModelTypeSet 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(ModelTypeSet());
- 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) {
- ModelTypeSet 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(ModelTypeSet());
- SendConfigureDone(DataTypeManager::OK, ModelTypeSet());
- 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) {
- ModelTypeSet 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 ModelTypeSet 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) {
- ModelTypeSet to_migrate;
- ModelTypeSet difference;
- to_migrate.Put(PREFERENCES);
- difference.Put(AUTOFILL);
- difference.Put(BOOKMARKS);
- EXPECT_CALL(*manager(), state())
- .WillOnce(Return(DataTypeManager::CONFIGURED));
- EXPECT_CALL(*manager(), PurgeForMigration(HasModelTypes(to_migrate)));
- migrator()->MigrateTypes(to_migrate);
- EXPECT_EQ(BackendMigrator::DISABLING_TYPES, migrator()->state());
- Mock::VerifyAndClearExpectations(manager());
- EXPECT_CALL(*manager(), PurgeForMigration(HasModelTypes(to_migrate)));
- SetUnsyncedTypes(ModelTypeSet());
- 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) {
- ModelTypeSet 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());
- ModelTypeSet 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) {
- ModelTypeSet to_migrate;
- to_migrate.Put(PREFERENCES);
- EXPECT_CALL(*manager(), state())
- .WillOnce(Return(DataTypeManager::CONFIGURED));
- EXPECT_CALL(*manager(), PurgeForMigration);
- migrator()->MigrateTypes(to_migrate);
- SetUnsyncedTypes(ModelTypeSet());
- SendConfigureDone(DataTypeManager::ABORTED, ModelTypeSet());
- EXPECT_EQ(BackendMigrator::IDLE, migrator()->state());
- }
- } // namespace syncer
|