Register a pref to control migration status

chrome/browser/content_settings/host_content_settings_map_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 <memory>
 #include <string>
 
 #include "base/auto_reset.h"
 #include "base/command_line.h"
 #include "base/json/json_reader.h"
@@ skipping 1408 matching lines @@
 
   host_content_settings_map->GetSettingsForOneType(CONTENT_SETTINGS_TYPE_POPUPS,
                                                    std::string(), &settings);
   // |host_content_settings_map| contains default setting and a domain scoped
   // setting.
   EXPECT_EQ(2U, settings.size());
   EXPECT_TRUE(settings[0].primary_pattern.ToString() ==
               "https://[*.]example.com:443");
   EXPECT_TRUE(settings[1].primary_pattern.ToString() == "*");
 
-  host_content_settings_map->MigrateDomainScopedSettings();
+  host_content_settings_map->MigrateDomainScopedSettings(false);
 
   // After migration, settings only affect origins.
   EXPECT_EQ(
       CONTENT_SETTING_ALLOW,
       host_content_settings_map->GetContentSetting(
           http_host, http_host, CONTENT_SETTINGS_TYPE_COOKIES, std::string()));
   EXPECT_EQ(CONTENT_SETTING_BLOCK,
             host_content_settings_map->GetContentSetting(
                 http_host_narrower, http_host_narrower,
                 CONTENT_SETTINGS_TYPE_COOKIES, std::string()));
@@ skipping 17 matching lines @@
   host_content_settings_map->GetSettingsForOneType(CONTENT_SETTINGS_TYPE_POPUPS,
                                                    std::string(), &settings);
   // |host_content_settings_map| contains default setting and a origin scoped
   // setting.
   EXPECT_EQ(2U, settings.size());
   EXPECT_TRUE(settings[0].primary_pattern.ToString() ==
               "https://example.com:443");
   EXPECT_TRUE(settings[1].primary_pattern.ToString() == "*");
 }
 
+TEST_F(HostContentSettingsMapTest, DomainToOriginMigrationStatus) {
+  TestingProfile profile;
+  PrefService* prefs = profile.GetPrefs();
+
+  HostContentSettingsMap* host_content_settings_map =
+      HostContentSettingsMapFactory::GetForProfile(&profile);
+
+  // Initial state is NOT_MIGRATED.
+  EXPECT_EQ(0, prefs->GetInteger(prefs::kDomainToOriginMigrationStatus));
+
+  // Do migration on HostContentSettingsMap construction will change the state
+  // to MIGRATED_BEFORE_SYNC.
+  host_content_settings_map->MigrateDomainScopedSettings(false);
+  EXPECT_EQ(1, prefs->GetInteger(prefs::kDomainToOriginMigrationStatus));

[raymes, 2016/07/21 00:58:54]

Rather than checking the value of the pref (which is more of an implementation
detail), could we instead add some content settings and check whether migration
happens, e.g.

-Add an old setting
-Migrate before sync.
-Check migration
-Add another old setting
-Migrate before sync
-Check no migration happened
-Migrate after sync
-Check migration
-Add another old setting
-Migrate after sync
-Check no migration

[lshang, 2016/07/22 01:33:06]

Done.

+
+  // Another call on HostContentSettingsMap construction to do migration will
+  // not change the state(i.e. migration code don't acturally get executed).
+  host_content_settings_map->MigrateDomainScopedSettings(false);
+  EXPECT_EQ(1, prefs->GetInteger(prefs::kDomainToOriginMigrationStatus));
+
+  // Do migration after sync will change the state to MIGRATED_AFTER_SYNC.
+  host_content_settings_map->MigrateDomainScopedSettings(true);
+  EXPECT_EQ(2, prefs->GetInteger(prefs::kDomainToOriginMigrationStatus));
+
+  // Another call after sync to do migration will not change the state
+  // (i.e. migration has finished, won't get executed anymore).
+  host_content_settings_map->MigrateDomainScopedSettings(true);
+  EXPECT_EQ(2, prefs->GetInteger(prefs::kDomainToOriginMigrationStatus));
+}
+
 TEST_F(HostContentSettingsMapTest, InvalidPattern) {
   // This is a regression test for crbug.com/618529, which fixed a memory leak
   // when a website setting was set under a URL that mapped to an invalid
   // pattern.
   TestingProfile profile;
   HostContentSettingsMap* host_content_settings_map =
       HostContentSettingsMapFactory::GetForProfile(&profile);
   GURL unsupported_url = GURL("view-source:http://www.google.com");
   base::DictionaryValue test_value;
   test_value.SetString("test", "value");
   host_content_settings_map->SetWebsiteSettingDefaultScope(
       unsupported_url, unsupported_url, CONTENT_SETTINGS_TYPE_APP_BANNER,
       std::string(), base::WrapUnique(test_value.DeepCopy()));
   EXPECT_EQ(nullptr,
             host_content_settings_map->GetWebsiteSetting(
                 unsupported_url, unsupported_url,
                 CONTENT_SETTINGS_TYPE_APP_BANNER, std::string(), nullptr));
 }