| // 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/frontend_data_type_controller.h" |
| |
| #include <utility> |
| |
| #include "base/bind.h" |
| #include "base/bind_helpers.h" |
| #include "base/callback.h" |
| #include "base/location.h" |
| #include "base/run_loop.h" |
| #include "base/sequenced_task_runner.h" |
| #include "base/test/scoped_task_environment.h" |
| #include "base/threading/sequenced_task_runner_handle.h" |
| #include "components/sync/driver/configure_context.h" |
| #include "components/sync/driver/data_type_controller_mock.h" |
| #include "components/sync/driver/fake_sync_service.h" |
| #include "components/sync/driver/frontend_data_type_controller_mock.h" |
| #include "components/sync/driver/model_associator_mock.h" |
| #include "components/sync/driver/sync_api_component_factory_mock.h" |
| #include "components/sync/model/change_processor_mock.h" |
| #include "testing/gtest/include/gtest/gtest.h" |
| |
| using testing::_; |
| using testing::DoAll; |
| using testing::InvokeWithoutArgs; |
| using testing::NiceMock; |
| using testing::Return; |
| using testing::SetArgPointee; |
| using testing::StrictMock; |
| |
| namespace syncer { |
| |
| class FrontendDataTypeControllerFake : public FrontendDataTypeController { |
| public: |
| FrontendDataTypeControllerFake(SyncService* sync_service, |
| SyncApiComponentFactory* component_factory, |
| FrontendDataTypeControllerMock* mock) |
| : FrontendDataTypeController(BOOKMARKS, base::DoNothing(), sync_service), |
| sync_service_(sync_service), |
| component_factory_(component_factory), |
| mock_(mock) {} |
| ~FrontendDataTypeControllerFake() override {} |
| |
| private: |
| void CreateSyncComponents() override { |
| SyncApiComponentFactory::SyncComponents sync_components = |
| component_factory_->CreateBookmarkSyncComponents( |
| CreateErrorHandler(), sync_service_->GetUserShare()); |
| model_associator_ = std::move(sync_components.model_associator); |
| change_processor_ = std::move(sync_components.change_processor); |
| } |
| |
| // We mock the following methods because their default implementations do |
| // nothing, but we still want to make sure they're called appropriately. |
| bool StartModels() override { return mock_->StartModels(); } |
| void CleanUpState() override { mock_->CleanUpState(); } |
| void RecordAssociationTime(base::TimeDelta time) override { |
| mock_->RecordAssociationTime(time); |
| } |
| void RecordStartFailure(DataTypeController::ConfigureResult result) override { |
| mock_->RecordStartFailure(result); |
| } |
| |
| SyncService* sync_service_; |
| SyncApiComponentFactory* component_factory_; |
| FrontendDataTypeControllerMock* mock_; |
| }; |
| |
| class SyncFrontendDataTypeControllerTest : public testing::Test { |
| public: |
| SyncFrontendDataTypeControllerTest() { |
| model_associator_deleter_ = |
| std::make_unique<NiceMock<ModelAssociatorMock>>(); |
| change_processor_deleter_ = |
| std::make_unique<NiceMock<ChangeProcessorMock>>(); |
| model_associator_ = model_associator_deleter_.get(); |
| change_processor_ = change_processor_deleter_.get(); |
| |
| ON_CALL(components_factory_, CreateBookmarkSyncComponents(_, _)) |
| .WillByDefault(testing::InvokeWithoutArgs([=]() { |
| SyncApiComponentFactory::SyncComponents components; |
| components.model_associator = std::move(model_associator_deleter_); |
| components.change_processor = std::move(change_processor_deleter_); |
| return components; |
| })); |
| } |
| |
| void SetUp() override { |
| dtc_mock_ = std::make_unique<StrictMock<FrontendDataTypeControllerMock>>(); |
| frontend_dtc_ = std::make_unique<FrontendDataTypeControllerFake>( |
| &sync_service_, &components_factory_, dtc_mock_.get()); |
| } |
| |
| protected: |
| void SetStartExpectations() { |
| EXPECT_CALL(*dtc_mock_, StartModels()).WillOnce(Return(true)); |
| EXPECT_CALL(model_load_callback_, Run(_, _)); |
| } |
| |
| void SetAssociateExpectations() { |
| EXPECT_CALL(*model_associator_, CryptoReadyIfNecessary()) |
| .WillOnce(Return(true)); |
| EXPECT_CALL(*model_associator_, SyncModelHasUserCreatedNodes(_)) |
| .WillOnce(DoAll(SetArgPointee<0>(true), Return(true))); |
| EXPECT_CALL(*model_associator_, AssociateModels(_, _)) |
| .WillOnce(Return(SyncError())); |
| EXPECT_CALL(*dtc_mock_, RecordAssociationTime(_)); |
| } |
| |
| void SetActivateExpectations(DataTypeController::ConfigureResult result) { |
| EXPECT_CALL(start_callback_, Run(result, _, _)); |
| } |
| |
| void SetStopExpectations() { |
| EXPECT_CALL(*dtc_mock_, CleanUpState()); |
| EXPECT_CALL(*model_associator_, DisassociateModels()) |
| .WillOnce(Return(SyncError())); |
| } |
| |
| void SetStartFailExpectations(DataTypeController::ConfigureResult result) { |
| EXPECT_CALL(*dtc_mock_, CleanUpState()); |
| EXPECT_CALL(*dtc_mock_, RecordStartFailure(result)); |
| EXPECT_CALL(start_callback_, Run(result, _, _)); |
| } |
| |
| void Start() { |
| frontend_dtc_->LoadModels( |
| ConfigureContext(), |
| base::Bind(&ModelLoadCallbackMock::Run, |
| base::Unretained(&model_load_callback_))); |
| frontend_dtc_->StartAssociating(base::Bind( |
| &StartCallbackMock::Run, base::Unretained(&start_callback_))); |
| PumpLoop(); |
| } |
| |
| void PumpLoop() { base::RunLoop().RunUntilIdle(); } |
| |
| base::test::ScopedTaskEnvironment task_environment_; |
| ModelAssociatorMock* model_associator_; |
| ChangeProcessorMock* change_processor_; |
| std::unique_ptr<ModelAssociatorMock> model_associator_deleter_; |
| std::unique_ptr<ChangeProcessorMock> change_processor_deleter_; |
| NiceMock<SyncApiComponentFactoryMock> components_factory_; |
| FakeSyncService sync_service_; |
| std::unique_ptr<FrontendDataTypeControllerFake> frontend_dtc_; |
| std::unique_ptr<FrontendDataTypeControllerMock> dtc_mock_; |
| StartCallbackMock start_callback_; |
| ModelLoadCallbackMock model_load_callback_; |
| }; |
| |
| TEST_F(SyncFrontendDataTypeControllerTest, StartOk) { |
| SetStartExpectations(); |
| SetAssociateExpectations(); |
| SetActivateExpectations(DataTypeController::OK); |
| EXPECT_EQ(DataTypeController::NOT_RUNNING, frontend_dtc_->state()); |
| Start(); |
| EXPECT_EQ(DataTypeController::RUNNING, frontend_dtc_->state()); |
| } |
| |
| TEST_F(SyncFrontendDataTypeControllerTest, StartFirstRun) { |
| SetStartExpectations(); |
| EXPECT_CALL(*model_associator_, CryptoReadyIfNecessary()) |
| .WillOnce(Return(true)); |
| EXPECT_CALL(*model_associator_, SyncModelHasUserCreatedNodes(_)) |
| .WillOnce(DoAll(SetArgPointee<0>(false), Return(true))); |
| EXPECT_CALL(*model_associator_, AssociateModels(_, _)) |
| .WillOnce(Return(SyncError())); |
| EXPECT_CALL(*dtc_mock_, RecordAssociationTime(_)); |
| SetActivateExpectations(DataTypeController::OK_FIRST_RUN); |
| EXPECT_EQ(DataTypeController::NOT_RUNNING, frontend_dtc_->state()); |
| Start(); |
| EXPECT_EQ(DataTypeController::RUNNING, frontend_dtc_->state()); |
| } |
| |
| TEST_F(SyncFrontendDataTypeControllerTest, StartStopBeforeAssociation) { |
| EXPECT_CALL(*dtc_mock_, StartModels()).WillOnce(Return(true)); |
| EXPECT_CALL(*dtc_mock_, CleanUpState()); |
| EXPECT_CALL(model_load_callback_, Run(_, _)); |
| EXPECT_EQ(DataTypeController::NOT_RUNNING, frontend_dtc_->state()); |
| base::SequencedTaskRunnerHandle::Get()->PostTask( |
| FROM_HERE, |
| base::BindOnce(&FrontendDataTypeController::Stop, |
| base::AsWeakPtr(frontend_dtc_.get()), STOP_SYNC)); |
| Start(); |
| EXPECT_EQ(DataTypeController::NOT_RUNNING, frontend_dtc_->state()); |
| } |
| |
| TEST_F(SyncFrontendDataTypeControllerTest, AbortDuringStartModels) { |
| EXPECT_CALL(*dtc_mock_, StartModels()).WillOnce(Return(false)); |
| EXPECT_CALL(*dtc_mock_, CleanUpState()); |
| EXPECT_EQ(DataTypeController::NOT_RUNNING, frontend_dtc_->state()); |
| frontend_dtc_->LoadModels( |
| ConfigureContext(), base::Bind(&ModelLoadCallbackMock::Run, |
| base::Unretained(&model_load_callback_))); |
| EXPECT_EQ(DataTypeController::MODEL_STARTING, frontend_dtc_->state()); |
| frontend_dtc_->Stop(STOP_SYNC); |
| EXPECT_EQ(DataTypeController::NOT_RUNNING, frontend_dtc_->state()); |
| } |
| |
| TEST_F(SyncFrontendDataTypeControllerTest, StartAssociationFailed) { |
| SetStartExpectations(); |
| EXPECT_CALL(*model_associator_, CryptoReadyIfNecessary()) |
| .WillOnce(Return(true)); |
| EXPECT_CALL(*model_associator_, SyncModelHasUserCreatedNodes(_)) |
| .WillOnce(DoAll(SetArgPointee<0>(true), Return(true))); |
| EXPECT_CALL(*model_associator_, AssociateModels(_, _)) |
| .WillOnce(Return( |
| SyncError(FROM_HERE, SyncError::DATATYPE_ERROR, "error", BOOKMARKS))); |
| |
| EXPECT_CALL(*dtc_mock_, RecordAssociationTime(_)); |
| SetStartFailExpectations(DataTypeController::ASSOCIATION_FAILED); |
| // Set up association to fail with an association failed error. |
| EXPECT_EQ(DataTypeController::NOT_RUNNING, frontend_dtc_->state()); |
| Start(); |
| EXPECT_EQ(DataTypeController::FAILED, frontend_dtc_->state()); |
| } |
| |
| TEST_F(SyncFrontendDataTypeControllerTest, |
| StartAssociationTriggersUnrecoverableError) { |
| SetStartExpectations(); |
| SetStartFailExpectations(DataTypeController::UNRECOVERABLE_ERROR); |
| // Set up association to fail with an unrecoverable error. |
| EXPECT_CALL(*model_associator_, CryptoReadyIfNecessary()) |
| .WillRepeatedly(Return(true)); |
| EXPECT_CALL(*model_associator_, SyncModelHasUserCreatedNodes(_)) |
| .WillRepeatedly(DoAll(SetArgPointee<0>(false), Return(false))); |
| EXPECT_EQ(DataTypeController::NOT_RUNNING, frontend_dtc_->state()); |
| Start(); |
| EXPECT_EQ(DataTypeController::NOT_RUNNING, frontend_dtc_->state()); |
| } |
| |
| TEST_F(SyncFrontendDataTypeControllerTest, StartAssociationCryptoNotReady) { |
| SetStartExpectations(); |
| SetStartFailExpectations(DataTypeController::NEEDS_CRYPTO); |
| // Set up association to fail with a NEEDS_CRYPTO error. |
| EXPECT_CALL(*model_associator_, CryptoReadyIfNecessary()) |
| .WillRepeatedly(Return(false)); |
| EXPECT_EQ(DataTypeController::NOT_RUNNING, frontend_dtc_->state()); |
| Start(); |
| EXPECT_EQ(DataTypeController::NOT_RUNNING, frontend_dtc_->state()); |
| } |
| |
| TEST_F(SyncFrontendDataTypeControllerTest, Stop) { |
| SetStartExpectations(); |
| SetAssociateExpectations(); |
| SetActivateExpectations(DataTypeController::OK); |
| SetStopExpectations(); |
| EXPECT_EQ(DataTypeController::NOT_RUNNING, frontend_dtc_->state()); |
| Start(); |
| EXPECT_EQ(DataTypeController::RUNNING, frontend_dtc_->state()); |
| frontend_dtc_->Stop(STOP_SYNC); |
| EXPECT_EQ(DataTypeController::NOT_RUNNING, frontend_dtc_->state()); |
| } |
| |
| } // namespace syncer |