| // 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_bookmarks/bookmark_data_type_controller.h" |
| |
| #include <memory> |
| |
| #include "base/bind.h" |
| #include "base/bind_helpers.h" |
| #include "base/callback.h" |
| #include "base/memory/ptr_util.h" |
| #include "base/message_loop/message_loop.h" |
| #include "base/run_loop.h" |
| #include "base/threading/thread_task_runner_handle.h" |
| #include "components/bookmarks/browser/bookmark_model.h" |
| #include "components/bookmarks/test/bookmark_test_helpers.h" |
| #include "components/bookmarks/test/test_bookmark_client.h" |
| #include "components/history/core/browser/history_service.h" |
| #include "components/prefs/testing_pref_service.h" |
| #include "components/sync/api/sync_error.h" |
| #include "components/sync/driver/change_processor_mock.h" |
| #include "components/sync/driver/data_type_controller_mock.h" |
| #include "components/sync/driver/fake_sync_client.h" |
| #include "components/sync/driver/fake_sync_service.h" |
| #include "components/sync/driver/model_associator_mock.h" |
| #include "components/sync/driver/sync_api_component_factory_mock.h" |
| #include "testing/gmock/include/gmock/gmock.h" |
| #include "testing/gtest/include/gtest/gtest.h" |
| |
| using bookmarks::BookmarkModel; |
| using browser_sync::BookmarkDataTypeController; |
| using sync_driver::ChangeProcessorMock; |
| using sync_driver::DataTypeController; |
| using sync_driver::ModelAssociatorMock; |
| using sync_driver::ModelLoadCallbackMock; |
| using sync_driver::StartCallbackMock; |
| using testing::_; |
| using testing::DoAll; |
| using testing::InvokeWithoutArgs; |
| using testing::Return; |
| using testing::SetArgumentPointee; |
| |
| namespace { |
| |
| class HistoryMock : public history::HistoryService { |
| public: |
| HistoryMock() : history::HistoryService() {} |
| MOCK_METHOD0(BackendLoaded, bool(void)); |
| |
| ~HistoryMock() override {} |
| }; |
| |
| } // namespace |
| |
| class SyncBookmarkDataTypeControllerTest : public testing::Test, |
| public sync_driver::FakeSyncClient { |
| public: |
| SyncBookmarkDataTypeControllerTest() {} |
| |
| // FakeSyncClient overrides. |
| BookmarkModel* GetBookmarkModel() override { return bookmark_model_.get(); } |
| history::HistoryService* GetHistoryService() override { |
| return history_service_.get(); |
| } |
| sync_driver::SyncService* GetSyncService() override { |
| return &service_; |
| } |
| sync_driver::SyncApiComponentFactory* GetSyncApiComponentFactory() override { |
| return profile_sync_factory_.get(); |
| } |
| |
| void SetUp() override { |
| model_associator_ = new ModelAssociatorMock(); |
| change_processor_ = new ChangeProcessorMock(); |
| history_service_.reset(new HistoryMock()); |
| profile_sync_factory_.reset( |
| new SyncApiComponentFactoryMock(model_associator_, |
| change_processor_)); |
| bookmark_dtc_ = |
| new BookmarkDataTypeController(base::ThreadTaskRunnerHandle::Get(), |
| base::Bind(&base::DoNothing), this); |
| } |
| |
| protected: |
| enum BookmarkLoadPolicy { |
| DONT_LOAD_MODEL, |
| LOAD_MODEL, |
| }; |
| |
| void CreateBookmarkModel(BookmarkLoadPolicy bookmark_load_policy) { |
| bookmark_model_.reset(new BookmarkModel( |
| base::WrapUnique(new bookmarks::TestBookmarkClient()))); |
| if (bookmark_load_policy == LOAD_MODEL) { |
| TestingPrefServiceSimple prefs; |
| bookmark_model_->Load(&prefs, base::FilePath(), |
| base::ThreadTaskRunnerHandle::Get(), |
| base::ThreadTaskRunnerHandle::Get()); |
| bookmarks::test::WaitForBookmarkModelToLoad(bookmark_model_.get()); |
| } |
| } |
| |
| void SetStartExpectations() { |
| EXPECT_CALL(*history_service_.get(), BackendLoaded()) |
| .WillRepeatedly(Return(true)); |
| EXPECT_CALL(model_load_callback_, Run(_, _)); |
| } |
| |
| void SetAssociateExpectations() { |
| EXPECT_CALL(*model_associator_, CryptoReadyIfNecessary()). |
| WillRepeatedly(Return(true)); |
| EXPECT_CALL(*profile_sync_factory_, CreateBookmarkSyncComponents(_, _)); |
| EXPECT_CALL(*model_associator_, SyncModelHasUserCreatedNodes(_)). |
| WillRepeatedly(DoAll(SetArgumentPointee<0>(true), Return(true))); |
| EXPECT_CALL(*model_associator_, AssociateModels(_, _)). |
| WillRepeatedly(Return(syncer::SyncError())); |
| } |
| |
| void SetStopExpectations() { |
| EXPECT_CALL(*model_associator_, DisassociateModels()). |
| WillOnce(Return(syncer::SyncError())); |
| } |
| |
| void Start() { |
| bookmark_dtc_->LoadModels( |
| base::Bind(&ModelLoadCallbackMock::Run, |
| base::Unretained(&model_load_callback_))); |
| bookmark_dtc_->StartAssociating( |
| base::Bind(&StartCallbackMock::Run, |
| base::Unretained(&start_callback_))); |
| base::RunLoop().RunUntilIdle(); |
| } |
| |
| void NotifyHistoryServiceLoaded() { |
| history_service_->NotifyHistoryServiceLoaded(); |
| } |
| |
| base::MessageLoop message_loop_; |
| scoped_refptr<BookmarkDataTypeController> bookmark_dtc_; |
| std::unique_ptr<SyncApiComponentFactoryMock> profile_sync_factory_; |
| std::unique_ptr<BookmarkModel> bookmark_model_; |
| std::unique_ptr<HistoryMock> history_service_; |
| sync_driver::FakeSyncService service_; |
| ModelAssociatorMock* model_associator_; |
| ChangeProcessorMock* change_processor_; |
| StartCallbackMock start_callback_; |
| ModelLoadCallbackMock model_load_callback_; |
| }; |
| |
| TEST_F(SyncBookmarkDataTypeControllerTest, StartDependentsReady) { |
| CreateBookmarkModel(LOAD_MODEL); |
| SetStartExpectations(); |
| SetAssociateExpectations(); |
| |
| EXPECT_EQ(DataTypeController::NOT_RUNNING, bookmark_dtc_->state()); |
| |
| EXPECT_CALL(start_callback_, Run(DataTypeController::OK, _, _)); |
| Start(); |
| EXPECT_EQ(DataTypeController::RUNNING, bookmark_dtc_->state()); |
| } |
| |
| TEST_F(SyncBookmarkDataTypeControllerTest, StartBookmarkModelNotReady) { |
| CreateBookmarkModel(DONT_LOAD_MODEL); |
| SetStartExpectations(); |
| SetAssociateExpectations(); |
| |
| EXPECT_CALL(start_callback_, Run(DataTypeController::OK, _, _)); |
| bookmark_dtc_->LoadModels( |
| base::Bind(&ModelLoadCallbackMock::Run, |
| base::Unretained(&model_load_callback_))); |
| EXPECT_EQ(DataTypeController::MODEL_STARTING, bookmark_dtc_->state()); |
| |
| TestingPrefServiceSimple prefs; |
| bookmark_model_->Load(&prefs, base::FilePath(), |
| base::ThreadTaskRunnerHandle::Get(), |
| base::ThreadTaskRunnerHandle::Get()); |
| bookmarks::test::WaitForBookmarkModelToLoad(bookmark_model_.get()); |
| EXPECT_EQ(DataTypeController::MODEL_LOADED, bookmark_dtc_->state()); |
| |
| bookmark_dtc_->StartAssociating( |
| base::Bind(&StartCallbackMock::Run, |
| base::Unretained(&start_callback_))); |
| base::RunLoop().RunUntilIdle(); |
| |
| EXPECT_EQ(DataTypeController::RUNNING, bookmark_dtc_->state()); |
| } |
| |
| TEST_F(SyncBookmarkDataTypeControllerTest, StartHistoryServiceNotReady) { |
| CreateBookmarkModel(LOAD_MODEL); |
| SetStartExpectations(); |
| EXPECT_CALL(*history_service_.get(), BackendLoaded()) |
| .WillRepeatedly(Return(false)); |
| |
| bookmark_dtc_->LoadModels( |
| base::Bind(&ModelLoadCallbackMock::Run, |
| base::Unretained(&model_load_callback_))); |
| |
| EXPECT_EQ(DataTypeController::MODEL_STARTING, bookmark_dtc_->state()); |
| testing::Mock::VerifyAndClearExpectations(history_service_.get()); |
| EXPECT_CALL(*history_service_.get(), BackendLoaded()) |
| .WillRepeatedly(Return(true)); |
| |
| // Send the notification that the history service has finished loading the db. |
| NotifyHistoryServiceLoaded(); |
| EXPECT_EQ(DataTypeController::MODEL_LOADED, bookmark_dtc_->state()); |
| } |
| |
| TEST_F(SyncBookmarkDataTypeControllerTest, StartFirstRun) { |
| CreateBookmarkModel(LOAD_MODEL); |
| SetStartExpectations(); |
| SetAssociateExpectations(); |
| EXPECT_CALL(*model_associator_, SyncModelHasUserCreatedNodes(_)). |
| WillRepeatedly(DoAll(SetArgumentPointee<0>(false), Return(true))); |
| EXPECT_CALL(start_callback_, Run(DataTypeController::OK_FIRST_RUN, _, _)); |
| Start(); |
| } |
| |
| TEST_F(SyncBookmarkDataTypeControllerTest, StartBusy) { |
| CreateBookmarkModel(LOAD_MODEL); |
| EXPECT_CALL(*history_service_.get(), BackendLoaded()) |
| .WillRepeatedly(Return(false)); |
| |
| EXPECT_CALL(model_load_callback_, Run(_, _)); |
| bookmark_dtc_->LoadModels( |
| base::Bind(&ModelLoadCallbackMock::Run, |
| base::Unretained(&model_load_callback_))); |
| bookmark_dtc_->LoadModels( |
| base::Bind(&ModelLoadCallbackMock::Run, |
| base::Unretained(&model_load_callback_))); |
| } |
| |
| TEST_F(SyncBookmarkDataTypeControllerTest, StartOk) { |
| CreateBookmarkModel(LOAD_MODEL); |
| SetStartExpectations(); |
| SetAssociateExpectations(); |
| EXPECT_CALL(*model_associator_, SyncModelHasUserCreatedNodes(_)). |
| WillRepeatedly(DoAll(SetArgumentPointee<0>(true), Return(true))); |
| |
| EXPECT_CALL(start_callback_, Run(DataTypeController::OK, _, _)); |
| Start(); |
| } |
| |
| TEST_F(SyncBookmarkDataTypeControllerTest, StartAssociationFailed) { |
| CreateBookmarkModel(LOAD_MODEL); |
| SetStartExpectations(); |
| // Set up association to fail. |
| EXPECT_CALL(*profile_sync_factory_, CreateBookmarkSyncComponents(_, _)); |
| EXPECT_CALL(*model_associator_, CryptoReadyIfNecessary()). |
| WillRepeatedly(Return(true)); |
| EXPECT_CALL(*model_associator_, SyncModelHasUserCreatedNodes(_)). |
| WillRepeatedly(DoAll(SetArgumentPointee<0>(true), Return(true))); |
| EXPECT_CALL(*model_associator_, AssociateModels(_, _)). |
| WillRepeatedly(Return(syncer::SyncError(FROM_HERE, |
| syncer::SyncError::DATATYPE_ERROR, |
| "error", |
| syncer::BOOKMARKS))); |
| |
| EXPECT_CALL(start_callback_, |
| Run(DataTypeController::ASSOCIATION_FAILED, _, _)); |
| Start(); |
| EXPECT_EQ(DataTypeController::DISABLED, bookmark_dtc_->state()); |
| } |
| |
| TEST_F(SyncBookmarkDataTypeControllerTest, |
| StartAssociationTriggersUnrecoverableError) { |
| CreateBookmarkModel(LOAD_MODEL); |
| SetStartExpectations(); |
| // Set up association to fail with an unrecoverable error. |
| EXPECT_CALL(*profile_sync_factory_, CreateBookmarkSyncComponents(_, _)); |
| EXPECT_CALL(*model_associator_, CryptoReadyIfNecessary()). |
| WillRepeatedly(Return(true)); |
| EXPECT_CALL(*model_associator_, SyncModelHasUserCreatedNodes(_)). |
| WillRepeatedly(DoAll(SetArgumentPointee<0>(false), Return(false))); |
| EXPECT_CALL(start_callback_, |
| Run(DataTypeController::UNRECOVERABLE_ERROR, _, _)); |
| Start(); |
| EXPECT_EQ(DataTypeController::NOT_RUNNING, bookmark_dtc_->state()); |
| } |
| |
| TEST_F(SyncBookmarkDataTypeControllerTest, StartAborted) { |
| CreateBookmarkModel(LOAD_MODEL); |
| EXPECT_CALL(*history_service_.get(), BackendLoaded()) |
| .WillRepeatedly(Return(false)); |
| |
| bookmark_dtc_->LoadModels( |
| base::Bind(&ModelLoadCallbackMock::Run, |
| base::Unretained(&model_load_callback_))); |
| |
| bookmark_dtc_->Stop(); |
| EXPECT_EQ(DataTypeController::NOT_RUNNING, bookmark_dtc_->state()); |
| } |
| |
| TEST_F(SyncBookmarkDataTypeControllerTest, Stop) { |
| CreateBookmarkModel(LOAD_MODEL); |
| SetStartExpectations(); |
| SetAssociateExpectations(); |
| SetStopExpectations(); |
| |
| EXPECT_EQ(DataTypeController::NOT_RUNNING, bookmark_dtc_->state()); |
| |
| EXPECT_CALL(start_callback_, Run(DataTypeController::OK, _, _)); |
| Start(); |
| EXPECT_EQ(DataTypeController::RUNNING, bookmark_dtc_->state()); |
| bookmark_dtc_->Stop(); |
| EXPECT_EQ(DataTypeController::NOT_RUNNING, bookmark_dtc_->state()); |
| } |