Create a list of policy changes before notifying observers

chrome/browser/policy/policy_service_impl_unittest.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 "chrome/browser/policy/policy_service_impl.h"
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/message_loop.h"
+#include "base/run_loop.h"
 #include "base/values.h"
 #include "chrome/browser/policy/mock_configuration_policy_provider.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/test/test_browser_thread.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 using ::testing::AnyNumber;
 using ::testing::Mock;
 using ::testing::Return;
@@ skipping 38 matching lines @@
                   base::Value::CreateStringValue(value));
   policy_map->Set(kDiffLevelPolicy, level, scope,
                   base::Value::CreateStringValue(value));
   policy_map = &bundle->Get(POLICY_DOMAIN_EXTENSIONS, kExtension);
   policy_map->Set(kSameLevelPolicy, POLICY_LEVEL_MANDATORY,
                   POLICY_SCOPE_USER, base::Value::CreateStringValue(value));
   policy_map->Set(kDiffLevelPolicy, level, scope,
                   base::Value::CreateStringValue(value));
 }
 
+// Observer class that changes the policy in the passed provider when the
+// callback is invoked.
+class ChangePolicyObserver : public PolicyService::Observer {
+ public:
+  explicit ChangePolicyObserver(MockConfigurationPolicyProvider* provider)
+      : provider_(provider),
+        observer_invoked_(false) {}
+
+  virtual void OnPolicyUpdated(PolicyDomain domain,
+                               const std::string& ns,
+                               const PolicyMap& previous,
+                               const PolicyMap& current) OVERRIDE {
+    PolicyMap new_policy;
+    new_policy.Set("foo", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
+                   base::Value::CreateIntegerValue(14));
+    provider_->UpdateChromePolicy(new_policy);
+    observer_invoked_ = true;
+  }
+
+  bool observer_invoked() const { return observer_invoked_; }
+
+ private:
+  MockConfigurationPolicyProvider* provider_;
+  bool observer_invoked_;
+};
+
 }  // namespace
 
 class PolicyServiceTest : public testing::Test {
  public:
-  PolicyServiceTest() {}
+  PolicyServiceTest() : loop_(MessageLoop::TYPE_UI) {}
 
   virtual void SetUp() OVERRIDE {
     EXPECT_CALL(provider0_, IsInitializationComplete())
         .WillRepeatedly(Return(true));
     EXPECT_CALL(provider1_, IsInitializationComplete())
         .WillRepeatedly(Return(true));
     EXPECT_CALL(provider2_, IsInitializationComplete())
         .WillRepeatedly(Return(true));
 
     provider0_.Init();
@@ skipping 22 matching lines @@
 
   MOCK_METHOD0(OnPolicyRefresh, void());
 
   // Returns true if the policies for |domain|, |component_id| match |expected|.
   bool VerifyPolicies(PolicyDomain domain,
                       const std::string& component_id,
                       const PolicyMap& expected) {
     return policy_service_->GetPolicies(domain, component_id).Equals(expected);
   }
 
+  void UpdateProviderPolicy(const PolicyMap& policy) {
+    provider0_.UpdateChromePolicy(policy);
+    RunUntilIdle();
+  }
+
+  void RunUntilIdle() {
+    base::RunLoop loop;
+    loop.RunUntilIdle();
+  }
+
  protected:
   MockConfigurationPolicyProvider provider0_;
   MockConfigurationPolicyProvider provider1_;
   MockConfigurationPolicyProvider provider2_;
   PolicyMap policy0_;
   PolicyMap policy1_;
   PolicyMap policy2_;
   scoped_ptr<PolicyServiceImpl> policy_service_;
+  MessageLoop loop_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(PolicyServiceTest);
 };
 
 TEST_F(PolicyServiceTest, LoadsPoliciesBeforeProvidersRefresh) {
   PolicyMap expected;
   expected.Set("pre", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                base::Value::CreateIntegerValue(13));
   EXPECT_TRUE(VerifyPolicies(POLICY_DOMAIN_CHROME, "", expected));
 }
 
 TEST_F(PolicyServiceTest, NotifyObservers) {
   MockPolicyServiceObserver observer;
   policy_service_->AddObserver(POLICY_DOMAIN_CHROME, &observer);
 
   PolicyMap expectedPrevious;
   expectedPrevious.Set("pre", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                        base::Value::CreateIntegerValue(13));
 
   PolicyMap expectedCurrent;
   expectedCurrent.CopyFrom(expectedPrevious);
   expectedCurrent.Set("aaa", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                       base::Value::CreateIntegerValue(123));
   policy0_.Set("aaa", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                base::Value::CreateIntegerValue(123));
   EXPECT_CALL(observer, OnPolicyUpdated(POLICY_DOMAIN_CHROME, "",
                                         PolicyEquals(&expectedPrevious),
                                         PolicyEquals(&expectedCurrent)));
-  provider0_.UpdateChromePolicy(policy0_);
+  UpdateProviderPolicy(policy0_);
   Mock::VerifyAndClearExpectations(&observer);
 
   // No changes.
   EXPECT_CALL(observer, OnPolicyUpdated(_, _, _, _)).Times(0);
-  provider0_.UpdateChromePolicy(policy0_);
+  UpdateProviderPolicy(policy0_);
   Mock::VerifyAndClearExpectations(&observer);
   EXPECT_TRUE(VerifyPolicies(POLICY_DOMAIN_CHROME, "", expectedCurrent));
 
   // New policy.
   expectedPrevious.CopyFrom(expectedCurrent);
   expectedCurrent.Set("bbb", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                       base::Value::CreateIntegerValue(456));
   policy0_.Set("bbb", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                base::Value::CreateIntegerValue(456));
   EXPECT_CALL(observer, OnPolicyUpdated(POLICY_DOMAIN_CHROME, "",
                                         PolicyEquals(&expectedPrevious),
                                         PolicyEquals(&expectedCurrent)));
-  provider0_.UpdateChromePolicy(policy0_);
+  UpdateProviderPolicy(policy0_);
   Mock::VerifyAndClearExpectations(&observer);
 
   // Removed policy.
   expectedPrevious.CopyFrom(expectedCurrent);
   expectedCurrent.Erase("bbb");
   policy0_.Erase("bbb");
   EXPECT_CALL(observer, OnPolicyUpdated(POLICY_DOMAIN_CHROME, "",
                                         PolicyEquals(&expectedPrevious),
                                         PolicyEquals(&expectedCurrent)));
-  provider0_.UpdateChromePolicy(policy0_);
+  UpdateProviderPolicy(policy0_);
   Mock::VerifyAndClearExpectations(&observer);
 
   // Changed policy.
   expectedPrevious.CopyFrom(expectedCurrent);
   expectedCurrent.Set("aaa", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                       base::Value::CreateIntegerValue(789));
   policy0_.Set("aaa", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                base::Value::CreateIntegerValue(789));
 
   EXPECT_CALL(observer, OnPolicyUpdated(POLICY_DOMAIN_CHROME, "",
                                         PolicyEquals(&expectedPrevious),
                                         PolicyEquals(&expectedCurrent)));
-  provider0_.UpdateChromePolicy(policy0_);
+  UpdateProviderPolicy(policy0_);
   Mock::VerifyAndClearExpectations(&observer);
 
   // No changes again.
   EXPECT_CALL(observer, OnPolicyUpdated(_, _, _, _)).Times(0);
-  provider0_.UpdateChromePolicy(policy0_);
+  UpdateProviderPolicy(policy0_);
   Mock::VerifyAndClearExpectations(&observer);
   EXPECT_TRUE(VerifyPolicies(POLICY_DOMAIN_CHROME, "", expectedCurrent));
 
   policy_service_->RemoveObserver(POLICY_DOMAIN_CHROME, &observer);
 }
 
 TEST_F(PolicyServiceTest, NotifyObserversInMultipleNamespaces) {
   const std::string kExtension0("extension-0");
   const std::string kExtension1("extension-1");
   const std::string kExtension2("extension-2");
@@ skipping 23 matching lines @@
                               PolicyEquals(&policy_map)));
   EXPECT_CALL(extension_observer,
               OnPolicyUpdated(POLICY_DOMAIN_EXTENSIONS, kExtension0,
                               PolicyEquals(&kEmptyPolicyMap),
                               PolicyEquals(&policy_map)));
   EXPECT_CALL(extension_observer,
               OnPolicyUpdated(POLICY_DOMAIN_EXTENSIONS, kExtension1,
                               PolicyEquals(&kEmptyPolicyMap),
                               PolicyEquals(&policy_map)));
   provider0_.UpdatePolicy(bundle.Pass());
+  RunUntilIdle();
   Mock::VerifyAndClearExpectations(&chrome_observer);
   Mock::VerifyAndClearExpectations(&extension_observer);
 
   // Chrome policy stays the same, kExtension0 is gone, kExtension1 changes,
   // and kExtension2 is new.
   previous_policy_map.CopyFrom(policy_map);
   bundle.reset(new PolicyBundle());
   bundle->Get(POLICY_DOMAIN_CHROME, "").CopyFrom(policy_map);
   policy_map.Set("policy", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                  base::Value::CreateStringValue("another value"));
   bundle->Get(POLICY_DOMAIN_EXTENSIONS, kExtension1).CopyFrom(policy_map);
   bundle->Get(POLICY_DOMAIN_EXTENSIONS, kExtension2).CopyFrom(policy_map);
 
   EXPECT_CALL(chrome_observer, OnPolicyUpdated(_, _, _, _)).Times(0);
   EXPECT_CALL(extension_observer,
               OnPolicyUpdated(POLICY_DOMAIN_EXTENSIONS, kExtension0,
                               PolicyEquals(&previous_policy_map),
                               PolicyEquals(&kEmptyPolicyMap)));
   EXPECT_CALL(extension_observer,
               OnPolicyUpdated(POLICY_DOMAIN_EXTENSIONS, kExtension1,
                               PolicyEquals(&previous_policy_map),
                               PolicyEquals(&policy_map)));
   EXPECT_CALL(extension_observer,
               OnPolicyUpdated(POLICY_DOMAIN_EXTENSIONS, kExtension2,
                               PolicyEquals(&kEmptyPolicyMap),
                               PolicyEquals(&policy_map)));
   provider0_.UpdatePolicy(bundle.Pass());
+  RunUntilIdle();
   Mock::VerifyAndClearExpectations(&chrome_observer);
   Mock::VerifyAndClearExpectations(&extension_observer);
 
   policy_service_->RemoveObserver(POLICY_DOMAIN_CHROME, &chrome_observer);
   policy_service_->RemoveObserver(POLICY_DOMAIN_EXTENSIONS,
                                   &extension_observer);
 }
 
+TEST_F(PolicyServiceTest, ObserverChangesPolicy) {
+  ChangePolicyObserver observer(&provider0_);
+  policy_service_->AddObserver(POLICY_DOMAIN_CHROME, &observer);
+  policy0_.Set("aaa", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
+               base::Value::CreateIntegerValue(123));
+  policy0_.Set("bbb", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
+               base::Value::CreateIntegerValue(1234));
+  // Should not crash.
+  UpdateProviderPolicy(policy0_);
+  policy_service_->RemoveObserver(POLICY_DOMAIN_CHROME, &observer);
+  EXPECT_TRUE(observer.observer_invoked());
+}
+
 TEST_F(PolicyServiceTest, Priorities) {
   PolicyMap expected;
   expected.Set("pre", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                base::Value::CreateIntegerValue(13));
   expected.Set("aaa", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                base::Value::CreateIntegerValue(0));
   policy0_.Set("aaa", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                base::Value::CreateIntegerValue(0));
   policy1_.Set("aaa", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                base::Value::CreateIntegerValue(1));
@@ skipping 24 matching lines @@
           policy_service_.get(), POLICY_DOMAIN_CHROME, ""));
 
   // Starting to observe existing policies doesn't trigger a notification.
   EXPECT_CALL(*this, OnPolicyValueUpdated(_, _)).Times(0);
   registrar->Observe("pre", base::Bind(
       &PolicyServiceTest::OnPolicyValueUpdated,
       base::Unretained(this)));
   registrar->Observe("aaa", base::Bind(
       &PolicyServiceTest::OnPolicyValueUpdated,
       base::Unretained(this)));
+  {
+    // Let any queued up notifications fire.
+    base::RunLoop loop;
+    loop.RunUntilIdle();
+  }

[Joao da Silva, 2013/01/07 09:23:52]

RunUntilIdle()?

[Andrew T Wilson (Slow), 2013/01/07 14:11:32]

Done.

   Mock::VerifyAndClearExpectations(this);
 
   // Changing it now triggers a notification.
   base::FundamentalValue kValue0(0);
   EXPECT_CALL(*this, OnPolicyValueUpdated(NULL, ValueEquals(&kValue0)));
   policy0_.Set("aaa", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                kValue0.DeepCopy());
-  provider0_.UpdateChromePolicy(policy0_);
+  UpdateProviderPolicy(policy0_);
   Mock::VerifyAndClearExpectations(this);
 
   // Changing other values doesn't trigger a notification.
   EXPECT_CALL(*this, OnPolicyValueUpdated(_, _)).Times(0);
   policy0_.Set("bbb", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                kValue0.DeepCopy());
-  provider0_.UpdateChromePolicy(policy0_);
+  UpdateProviderPolicy(policy0_);
   Mock::VerifyAndClearExpectations(this);
 
   // Modifying the value triggers a notification.
   base::FundamentalValue kValue1(1);
   EXPECT_CALL(*this, OnPolicyValueUpdated(ValueEquals(&kValue0),
                                           ValueEquals(&kValue1)));
   policy0_.Set("aaa", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                kValue1.DeepCopy());
-  provider0_.UpdateChromePolicy(policy0_);
+  UpdateProviderPolicy(policy0_);
   Mock::VerifyAndClearExpectations(this);
 
   // Removing the value triggers a notification.
   EXPECT_CALL(*this, OnPolicyValueUpdated(ValueEquals(&kValue1), NULL));
   policy0_.Erase("aaa");
-  provider0_.UpdateChromePolicy(policy0_);
+  UpdateProviderPolicy(policy0_);
   Mock::VerifyAndClearExpectations(this);
 
   // No more notifications after destroying the registrar.
   EXPECT_CALL(*this, OnPolicyValueUpdated(_, _)).Times(0);
   registrar.reset();
   policy0_.Set("aaa", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                kValue1.DeepCopy());
   policy0_.Set("pre", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                kValue1.DeepCopy());
-  provider0_.UpdateChromePolicy(policy0_);
+  UpdateProviderPolicy(policy0_);
   Mock::VerifyAndClearExpectations(this);
 }
 
 TEST_F(PolicyServiceTest, RefreshPolicies) {
-  MessageLoop loop;
-  content::TestBrowserThread ui_thread(content::BrowserThread::UI, &loop);
-  content::TestBrowserThread file_thread(content::BrowserThread::FILE, &loop);
-  content::TestBrowserThread io_thread(content::BrowserThread::IO, &loop);
+  content::TestBrowserThread ui_thread(content::BrowserThread::UI, &loop_);
+  content::TestBrowserThread file_thread(content::BrowserThread::FILE, &loop_);
+  content::TestBrowserThread io_thread(content::BrowserThread::IO, &loop_);
 
   EXPECT_CALL(provider0_, RefreshPolicies()).Times(AnyNumber());
   EXPECT_CALL(provider1_, RefreshPolicies()).Times(AnyNumber());
   EXPECT_CALL(provider2_, RefreshPolicies()).Times(AnyNumber());
 
   EXPECT_CALL(*this, OnPolicyRefresh()).Times(0);
   policy_service_->RefreshPolicies(base::Bind(
       &PolicyServiceTest::OnPolicyRefresh,
       base::Unretained(this)));
-  loop.RunUntilIdle();
+  // Let any queued observer tasks run.
+  RunUntilIdle();
   Mock::VerifyAndClearExpectations(this);
 
   EXPECT_CALL(*this, OnPolicyRefresh()).Times(0);
   base::FundamentalValue kValue0(0);
   policy0_.Set("aaa", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                kValue0.DeepCopy());
-  provider0_.UpdateChromePolicy(policy0_);
-  loop.RunUntilIdle();
+  UpdateProviderPolicy(policy0_);
   Mock::VerifyAndClearExpectations(this);
 
   EXPECT_CALL(*this, OnPolicyRefresh()).Times(0);
   base::FundamentalValue kValue1(1);
   policy1_.Set("aaa", POLICY_LEVEL_RECOMMENDED, POLICY_SCOPE_USER,
                kValue1.DeepCopy());
   provider1_.UpdateChromePolicy(policy1_);
-  loop.RunUntilIdle();
+  RunUntilIdle();
   Mock::VerifyAndClearExpectations(this);
 
   // A provider can refresh more than once after a RefreshPolicies call, but
   // OnPolicyRefresh should be triggered only after all providers are
   // refreshed.
   EXPECT_CALL(*this, OnPolicyRefresh()).Times(0);
   policy1_.Set("bbb", POLICY_LEVEL_RECOMMENDED, POLICY_SCOPE_USER,
                kValue1.DeepCopy());
   provider1_.UpdateChromePolicy(policy1_);
-  loop.RunUntilIdle();
+  RunUntilIdle();
   Mock::VerifyAndClearExpectations(this);
 
   // If another RefreshPolicies() call happens while waiting for a previous
   // one to complete, then all providers must refresh again.
   EXPECT_CALL(*this, OnPolicyRefresh()).Times(0);
   policy_service_->RefreshPolicies(base::Bind(
       &PolicyServiceTest::OnPolicyRefresh,
       base::Unretained(this)));
-  loop.RunUntilIdle();
+  RunUntilIdle();
   Mock::VerifyAndClearExpectations(this);
 
   EXPECT_CALL(*this, OnPolicyRefresh()).Times(0);
   policy2_.Set("bbb", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                kValue0.DeepCopy());
   provider2_.UpdateChromePolicy(policy2_);
-  loop.RunUntilIdle();
+  RunUntilIdle();
   Mock::VerifyAndClearExpectations(this);
 
   // Providers 0 and 1 must reload again.
   EXPECT_CALL(*this, OnPolicyRefresh()).Times(2);
   base::FundamentalValue kValue2(2);
   policy0_.Set("aaa", POLICY_LEVEL_MANDATORY, POLICY_SCOPE_USER,
                kValue2.DeepCopy());
   provider0_.UpdateChromePolicy(policy0_);
   provider1_.UpdateChromePolicy(policy1_);
-  loop.RunUntilIdle();
+  RunUntilIdle();
   Mock::VerifyAndClearExpectations(this);
 
   const PolicyMap& policies = policy_service_->GetPolicies(
       POLICY_DOMAIN_CHROME, "");
   EXPECT_TRUE(base::Value::Equals(&kValue2, policies.GetValue("aaa")));
   EXPECT_TRUE(base::Value::Equals(&kValue0, policies.GetValue("bbb")));
 }
 
 TEST_F(PolicyServiceTest, NamespaceMerge) {
   scoped_ptr<PolicyBundle> bundle0(new PolicyBundle());
@@ skipping 20 matching lines @@
   // level/scope combination takes precedence, on every namespace.
   expected.Set(kDiffLevelPolicy, POLICY_LEVEL_MANDATORY, POLICY_SCOPE_MACHINE,
                base::Value::CreateStringValue("bundle2"));
   EXPECT_TRUE(policy_service_->GetPolicies(POLICY_DOMAIN_CHROME, "")
       .Equals(expected));
   EXPECT_TRUE(policy_service_->GetPolicies(POLICY_DOMAIN_EXTENSIONS, kExtension)
       .Equals(expected));
 }
 
 }  // namespace policy