[protector] Support for collapsing multiple changes into a single one.

chrome/browser/protector/protector_service_browsertest.cc

 // 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 "base/memory/scoped_ptr.h"
 #include "base/message_loop.h"
 #include "chrome/app/chrome_command_ids.h"
 #include "chrome/browser/protector/mock_setting_change.h"
 #include "chrome/browser/protector/protector_service.h"
 #include "chrome/browser/protector/protector_service_factory.h"
@@ skipping 16 matching lines @@
  public:
   virtual void SetUpOnMainThread() {
     protector_service_ =
         ProtectorServiceFactory::GetForProfile(browser()->profile());
     // ProtectService will own this change instance.
     mock_change_ = new NiceMock<MockSettingChange>();
   }
 
  protected:
   GlobalError* GetGlobalError(BaseSettingChange* change) {
-    std::vector<ProtectorService::Item>::iterator item =
-        std::find_if(protector_service_->items_.begin(),
-                     protector_service_->items_.end(),
-                     ProtectorService::MatchItemByChange(change));
-    return item == protector_service_->items_.end() ?
-        NULL : item->error.get();
+    for (ProtectorService::Items::iterator item =
+             protector_service_->items_.begin();
+         item != protector_service_->items_.end(); item++) {
+      if (item->change.get() == change)
+        return item->error.get();
+    }
+    return NULL;
   }
 
   // Checks that |protector_service_| has an error instance corresponding to
   // |change| and that GlobalErrorService knows about it.
   bool IsGlobalErrorActive(BaseSettingChange* change) {
     GlobalError* error = GetGlobalError(change);
     if (!error)
       return false;
     if (!GlobalErrorServiceFactory::GetForProfile(browser()->profile())->
             GetGlobalErrorByMenuItemCommandID(error->MenuItemCommandID())) {
       return false;
     }
     return protector_service_->IsShowingChange();
   }
 
   ProtectorService* protector_service_;
   MockSettingChange* mock_change_;
 };
 
 IN_PROC_BROWSER_TEST_F(ProtectorServiceTest, ChangeInitError) {
   // Init fails and causes the change to be ignored.
   EXPECT_CALL(*mock_change_, MockInit(browser()->profile())).
       WillOnce(Return(false));
   protector_service_->ShowChange(mock_change_);
   EXPECT_FALSE(IsGlobalErrorActive(mock_change_));
   ui_test_utils::RunAllPendingInMessageLoop();
   EXPECT_FALSE(IsGlobalErrorActive(mock_change_));
+  EXPECT_FALSE(protector_service_->GetLastChange());
 }
 
 IN_PROC_BROWSER_TEST_F(ProtectorServiceTest, ShowAndDismiss) {
   // Show the change and immediately dismiss it.
   EXPECT_CALL(*mock_change_, MockInit(browser()->profile())).
       WillOnce(Return(true));
   protector_service_->ShowChange(mock_change_);
   ui_test_utils::RunAllPendingInMessageLoop();
   EXPECT_TRUE(IsGlobalErrorActive(mock_change_));
+  EXPECT_EQ(mock_change_, protector_service_->GetLastChange());
   protector_service_->DismissChange(mock_change_);
   ui_test_utils::RunAllPendingInMessageLoop();
   EXPECT_FALSE(IsGlobalErrorActive(mock_change_));
+  EXPECT_FALSE(protector_service_->GetLastChange());
 }
 
 IN_PROC_BROWSER_TEST_F(ProtectorServiceTest, ShowAndApply) {
   // Show the change and apply it.
   EXPECT_CALL(*mock_change_, MockInit(browser()->profile())).
       WillOnce(Return(true));
   protector_service_->ShowChange(mock_change_);
   ui_test_utils::RunAllPendingInMessageLoop();
   EXPECT_TRUE(IsGlobalErrorActive(mock_change_));
   EXPECT_CALL(*mock_change_, Apply(browser()));
@@ skipping 68 matching lines @@
   EXPECT_FALSE(IsGlobalErrorActive(mock_change_));
 }
 
 IN_PROC_BROWSER_TEST_F(ProtectorServiceTest, ShowMultipleChangesAndApply) {
   // Show the first change.
   EXPECT_CALL(*mock_change_, MockInit(browser()->profile())).
       WillOnce(Return(true));
   protector_service_->ShowChange(mock_change_);
   ui_test_utils::RunAllPendingInMessageLoop();
   EXPECT_TRUE(IsGlobalErrorActive(mock_change_));
+  EXPECT_EQ(mock_change_, protector_service_->GetLastChange());
 
   // ProtectService will own this change instance as well.
   MockSettingChange* mock_change2 = new NiceMock<MockSettingChange>();
   // Show the second change.
   EXPECT_CALL(*mock_change2, MockInit(browser()->profile())).
       WillOnce(Return(true));
   protector_service_->ShowChange(mock_change2);
   ui_test_utils::RunAllPendingInMessageLoop();
   EXPECT_TRUE(IsGlobalErrorActive(mock_change_));
   EXPECT_TRUE(IsGlobalErrorActive(mock_change2));
+  EXPECT_EQ(mock_change2, protector_service_->GetLastChange());
 
   // Apply the first change, the second should still be active.
   EXPECT_CALL(*mock_change_, Apply(browser()));
   protector_service_->ApplyChange(mock_change_, browser());
   ui_test_utils::RunAllPendingInMessageLoop();
   EXPECT_FALSE(IsGlobalErrorActive(mock_change_));
   EXPECT_TRUE(IsGlobalErrorActive(mock_change2));
+  EXPECT_EQ(mock_change2, protector_service_->GetLastChange());
 
   // Finally apply the second change.
   EXPECT_CALL(*mock_change2, Apply(browser()));
   protector_service_->ApplyChange(mock_change2, browser());
   ui_test_utils::RunAllPendingInMessageLoop();
   EXPECT_FALSE(IsGlobalErrorActive(mock_change_));
   EXPECT_FALSE(IsGlobalErrorActive(mock_change2));
+  EXPECT_FALSE(protector_service_->GetLastChange());
 }
 
 IN_PROC_BROWSER_TEST_F(ProtectorServiceTest,
                        ShowMultipleChangesDismissAndApply) {
   // Show the first change.
   EXPECT_CALL(*mock_change_, MockInit(browser()->profile())).
       WillOnce(Return(true));
   protector_service_->ShowChange(mock_change_);
   ui_test_utils::RunAllPendingInMessageLoop();
   EXPECT_TRUE(IsGlobalErrorActive(mock_change_));
@@ skipping 109 matching lines @@
   ASSERT_TRUE(error2->HasShownBubbleView());
 
   // Finally apply the second change.
   EXPECT_CALL(*mock_change2, Apply(browser()));
   error2->BubbleViewCancelButtonPressed(browser());
   error2->GetBubbleView()->CloseBubbleView();
   ui_test_utils::RunAllPendingInMessageLoop();
   EXPECT_FALSE(IsGlobalErrorActive(mock_change2));
 }
 
+IN_PROC_BROWSER_TEST_F(ProtectorServiceTest, ShowMultipleDifferentKeys) {
+  // Show the first change with some non-empty key.
+  EXPECT_CALL(*mock_change_, MockInit(browser()->profile())).
+      WillOnce(Return(true));
+  EXPECT_CALL(*mock_change_, GetApplyKeyword()).WillRepeatedly(Return("K1"));
+  protector_service_->ShowChange(mock_change_);
+  ui_test_utils::RunAllPendingInMessageLoop();
+  EXPECT_TRUE(IsGlobalErrorActive(mock_change_));
+  EXPECT_EQ(mock_change_, protector_service_->GetLastChange());
+
+  // ProtectService will own this change instance as well.
+  MockSettingChange* mock_change2 = new NiceMock<MockSettingChange>();
+  // Show the second change with another non-empty key.
+  EXPECT_CALL(*mock_change2, MockInit(browser()->profile())).
+      WillOnce(Return(true));
+  EXPECT_CALL(*mock_change2, GetApplyKeyword()).WillRepeatedly(Return("K2"));
+  protector_service_->ShowChange(mock_change2);
+  ui_test_utils::RunAllPendingInMessageLoop();
+
+  // Both changes are shown separately, not composited.
+  EXPECT_TRUE(IsGlobalErrorActive(mock_change_));
+  EXPECT_TRUE(IsGlobalErrorActive(mock_change2));
+  EXPECT_EQ(mock_change2, protector_service_->GetLastChange());
+
+  protector_service_->DismissChange(mock_change_);
+  protector_service_->DismissChange(mock_change2);
+  ui_test_utils::RunAllPendingInMessageLoop();
+  EXPECT_FALSE(protector_service_->GetLastChange());
+}
+
+IN_PROC_BROWSER_TEST_F(ProtectorServiceTest, ShowCompositeAndDismiss) {
+  const std::string key1 = "K1";
+
+  // Show the first change.
+  EXPECT_CALL(*mock_change_, MockInit(browser()->profile())).
+      WillOnce(Return(true));
+  EXPECT_CALL(*mock_change_, GetApplyKeyword()).WillRepeatedly(Return(key1));
+  protector_service_->ShowChange(mock_change_);
+  ui_test_utils::RunAllPendingInMessageLoop();
+  EXPECT_TRUE(IsGlobalErrorActive(mock_change_));
+  EXPECT_EQ(mock_change_, protector_service_->GetLastChange());
+
+  // The first bubble view has been displayed.
+  GlobalError* error = GetGlobalError(mock_change_);
+  ASSERT_TRUE(error);
+  EXPECT_TRUE(error->HasShownBubbleView());
+
+  // ProtectService will own this change instance as well.
+  MockSettingChange* mock_change2 = new NiceMock<MockSettingChange>();
+  // Show the second change.
+  EXPECT_CALL(*mock_change2, MockInit(browser()->profile())).
+      WillOnce(Return(true));
+  EXPECT_CALL(*mock_change2, GetApplyKeyword()).WillRepeatedly(Return(key1));
+  protector_service_->ShowChange(mock_change2);
+  ui_test_utils::RunAllPendingInMessageLoop();
+
+  // Now ProtectorService should be showing a single composite change.
+  EXPECT_FALSE(IsGlobalErrorActive(mock_change_));
+  EXPECT_FALSE(IsGlobalErrorActive(mock_change2));
+
+  BaseSettingChange* composite_change = protector_service_->GetLastChange();
+  ASSERT_TRUE(composite_change);
+  EXPECT_TRUE(IsGlobalErrorActive(composite_change));
+
+  // The second (composite) bubble view has been displayed.
+  GlobalError* error2 = GetGlobalError(composite_change);
+  ASSERT_TRUE(error2);
+  EXPECT_TRUE(error2->HasShownBubbleView());
+
+  protector_service_->DismissChange(composite_change);
+  ui_test_utils::RunAllPendingInMessageLoop();
+  EXPECT_FALSE(IsGlobalErrorActive(composite_change));
+  EXPECT_FALSE(protector_service_->GetLastChange());
+
+  // Show the third change.
+  MockSettingChange* mock_change3 = new NiceMock<MockSettingChange>();
+  EXPECT_CALL(*mock_change3, MockInit(browser()->profile())).
+      WillOnce(Return(true));
+  EXPECT_CALL(*mock_change3, GetApplyKeyword()).WillRepeatedly(Return(key1));
+  protector_service_->ShowChange(mock_change3);
+  ui_test_utils::RunAllPendingInMessageLoop();
+
+  // The third change should not be composed with the previous.
+  EXPECT_TRUE(IsGlobalErrorActive(mock_change3));
+  EXPECT_EQ(mock_change3, protector_service_->GetLastChange());
+
+  protector_service_->DismissChange(mock_change3);
+  ui_test_utils::RunAllPendingInMessageLoop();
+  EXPECT_FALSE(IsGlobalErrorActive(mock_change3));
+  EXPECT_FALSE(protector_service_->GetLastChange());
+}
+
+IN_PROC_BROWSER_TEST_F(ProtectorServiceTest, ShowCompositeAndOther) {
+  const std::string key1 = "K1";
+  const std::string key2 = "K2";
+
+  // Show the first change.
+  EXPECT_CALL(*mock_change_, MockInit(browser()->profile())).
+      WillOnce(Return(true));
+  EXPECT_CALL(*mock_change_, GetApplyKeyword()).WillRepeatedly(Return(key1));
+  protector_service_->ShowChange(mock_change_);
+  ui_test_utils::RunAllPendingInMessageLoop();
+  EXPECT_TRUE(IsGlobalErrorActive(mock_change_));
+  EXPECT_EQ(mock_change_, protector_service_->GetLastChange());
+
+  // ProtectService will own this change instance as well.
+  MockSettingChange* mock_change2 = new NiceMock<MockSettingChange>();
+  // Show the second change.
+  EXPECT_CALL(*mock_change2, MockInit(browser()->profile())).
+      WillOnce(Return(true));
+  EXPECT_CALL(*mock_change2, GetApplyKeyword()).WillRepeatedly(Return(key1));
+  protector_service_->ShowChange(mock_change2);
+  ui_test_utils::RunAllPendingInMessageLoop();
+
+  // Now ProtectorService should be showing a single composite change.
+  BaseSettingChange* composite_change = protector_service_->GetLastChange();
+  ASSERT_TRUE(composite_change);
+  EXPECT_TRUE(IsGlobalErrorActive(composite_change));
+
+  // Show the third change, with the same key as 1st and 2nd.
+  MockSettingChange* mock_change3 = new NiceMock<MockSettingChange>();
+  EXPECT_CALL(*mock_change3, MockInit(browser()->profile())).
+      WillOnce(Return(true));
+  EXPECT_CALL(*mock_change3, GetApplyKeyword()).WillRepeatedly(Return(key1));
+  protector_service_->ShowChange(mock_change3);
+  ui_test_utils::RunAllPendingInMessageLoop();
+
+  // The third change should be composed with the previous.
+  EXPECT_FALSE(IsGlobalErrorActive(mock_change3));
+  EXPECT_EQ(composite_change, protector_service_->GetLastChange());
+  EXPECT_TRUE(IsGlobalErrorActive(composite_change));
+
+  // Show the 4th change, now with a different key.
+  MockSettingChange* mock_change4 = new NiceMock<MockSettingChange>();
+  EXPECT_CALL(*mock_change4, MockInit(browser()->profile())).
+      WillOnce(Return(true));
+  EXPECT_CALL(*mock_change4, GetApplyKeyword()).WillRepeatedly(Return(key2));
+  protector_service_->ShowChange(mock_change4);
+  ui_test_utils::RunAllPendingInMessageLoop();
+
+  // The 4th change is shown independently.
+  EXPECT_TRUE(IsGlobalErrorActive(composite_change));
+  EXPECT_TRUE(IsGlobalErrorActive(mock_change4));
+  EXPECT_EQ(mock_change4, protector_service_->GetLastChange());
+
+  protector_service_->DismissChange(composite_change);
+  protector_service_->DismissChange(mock_change4);
+  ui_test_utils::RunAllPendingInMessageLoop();
+  EXPECT_FALSE(IsGlobalErrorActive(composite_change));
+  EXPECT_FALSE(IsGlobalErrorActive(mock_change4));
+  EXPECT_FALSE(protector_service_->GetLastChange());
+}
+
+IN_PROC_BROWSER_TEST_F(ProtectorServiceTest, ShowCompositeAndDismissSingle) {
+  const std::string key1 = "K1";
+  const std::string key2 = "K2";
+
+  // Show the first change.
+  EXPECT_CALL(*mock_change_, MockInit(browser()->profile())).
+      WillOnce(Return(true));
+  EXPECT_CALL(*mock_change_, GetApplyKeyword()).WillRepeatedly(Return(key1));
+  protector_service_->ShowChange(mock_change_);
+  ui_test_utils::RunAllPendingInMessageLoop();
+  EXPECT_TRUE(IsGlobalErrorActive(mock_change_));
+  EXPECT_EQ(mock_change_, protector_service_->GetLastChange());
+
+  // ProtectService will own this change instance as well.
+  MockSettingChange* mock_change2 = new NiceMock<MockSettingChange>();
+  // Show the second change.
+  EXPECT_CALL(*mock_change2, MockInit(browser()->profile())).
+      WillOnce(Return(true));
+  EXPECT_CALL(*mock_change2, GetApplyKeyword()).WillRepeatedly(Return(key1));
+  protector_service_->ShowChange(mock_change2);
+  ui_test_utils::RunAllPendingInMessageLoop();
+
+  // Now ProtectorService should be showing a single composite change.
+  EXPECT_FALSE(IsGlobalErrorActive(mock_change_));
+  EXPECT_FALSE(IsGlobalErrorActive(mock_change2));
+
+  BaseSettingChange* composite_change = protector_service_->GetLastChange();
+  ASSERT_TRUE(composite_change);
+  EXPECT_TRUE(IsGlobalErrorActive(composite_change));
+
+  // Show the third change with a different key.
+  MockSettingChange* mock_change3 = new NiceMock<MockSettingChange>();
+  EXPECT_CALL(*mock_change3, MockInit(browser()->profile())).
+      WillOnce(Return(true));
+  EXPECT_CALL(*mock_change3, GetApplyKeyword()).WillRepeatedly(Return(key2));
+  protector_service_->ShowChange(mock_change3);
+  ui_test_utils::RunAllPendingInMessageLoop();
+
+  // The third change should not be composed with the previous.
+  EXPECT_TRUE(IsGlobalErrorActive(mock_change3));
+  EXPECT_TRUE(IsGlobalErrorActive(composite_change));
+  EXPECT_EQ(mock_change3, protector_service_->GetLastChange());
+
+  // Now dismiss the first change.
+  protector_service_->DismissChange(mock_change_);
+  ui_test_utils::RunAllPendingInMessageLoop();
+
+  // This should effectively dismiss the whole composite change.
+  EXPECT_FALSE(IsGlobalErrorActive(composite_change));
+  EXPECT_TRUE(IsGlobalErrorActive(mock_change3));
+  EXPECT_EQ(mock_change3, protector_service_->GetLastChange());
+
+  protector_service_->DismissChange(mock_change3);
+  ui_test_utils::RunAllPendingInMessageLoop();
+  EXPECT_FALSE(IsGlobalErrorActive(mock_change3));
+  EXPECT_FALSE(protector_service_->GetLastChange());
+}
+
 // TODO(ivankr): Timeout test.
 
 }  // namespace protector