Fix homepage migration for users who never changed their settings.

chrome/test/functional/protector.py

 #!/usr/bin/env python
 # 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.
 
 import pyauto_functional  # Must be imported first
 import pyauto
 import test_utils
 
 import json
@@ skipping 133 matching lines @@
     """
     with open(os.path.join(self._profile_path, 'Preferences'), 'w') as f:
       json.dump(prefs, f)
 
   def _InvalidatePreferencesBackup(self):
     """Makes the Preferences backup invalid by clearing the signature."""
     prefs = self._LoadPreferences()
     prefs['backup']['_signature'] = 'INVALID'
     self._WritePreferences(prefs)
 
-  def _ChangeSessionStartupPrefs(self, startup_type, startup_urls=None,
+  def _ChangeSessionStartupPrefs(self, startup_type=None, startup_urls=None,
                                  homepage=None):
     """Changes the session startup type and the list of URLs to load on startup.
 
     Args:
-      startup_type: int with one of _SESSION_STARTUP_* values.
+      startup_type: int with one of _SESSION_STARTUP_* values. If startup_type
+          is None, then it deletes the preference.
       startup_urls: list(str) with a list of URLs; if None, is left unchanged.
       homepage: unless None, the new value for homepage.
     """
     prefs = self._LoadPreferences()
-    prefs['session']['restore_on_startup'] = startup_type
+    if startup_type is None:
+      del prefs['session']['restore_on_startup']
+    else:
+      prefs['session']['restore_on_startup'] = startup_type
+
     if startup_urls is not None:
       prefs['session']['urls_to_restore_on_startup'] = startup_urls
     if homepage is not None:
       prefs['homepage'] = homepage
     self._WritePreferences(prefs)
 
   def _ChangePinnedTabsPrefs(self, pinned_tabs):
     """Changes the list of pinned tabs.
 
     Args:
@@ skipping 256 matching lines @@
         pre_launch_hook=lambda: self._ChangeSessionStartupPrefs(
             self._SESSION_STARTUP_URLS,
             startup_urls=['http://www.google.com']))
     # The change must be detected by Protector.
     self.assertTrue(self.GetProtectorState()['showing_change'])
     # Change the setting manually.
     self.SetPrefs(pyauto.kRestoreOnStartup, self._SESSION_STARTUP_NTP)
     # No longer showing the change.
     self.assertFalse(self.GetProtectorState()['showing_change'])
 
-  def testSessionStartupPrefMigration(self):
+  def testSessionStartupPrefMigrationFromHomepage(self):
     """Test migration from old session.restore_on_startup values (homepage)."""
     # Set startup prefs to restoring last open tabs.
     self.SetPrefs(pyauto.kRestoreOnStartup, self._SESSION_STARTUP_LAST)
     self.SetPrefs(pyauto.kURLsToRestoreOnStartup, [])
     new_homepage = 'http://www.google.com/'
     # Restart browser with startup prefs set to open homepage (google.com).
     self.RestartBrowser(
         clear_profile=False,
         pre_launch_hook=lambda: self._ChangeSessionStartupPrefs(
             self._SESSION_STARTUP_HOMEPAGE,
             homepage=new_homepage))
     # The change must be detected by Protector.
     self.assertTrue(self.GetProtectorState()['showing_change'])
     # Protector must restore old preference values.
     self.assertEqual(self._SESSION_STARTUP_LAST,
                      self.GetPrefsInfo().Prefs(pyauto.kRestoreOnStartup))
     self.assertEqual([],
                      self.GetPrefsInfo().Prefs(pyauto.kURLsToRestoreOnStartup))
     self.ApplyProtectorChange()
     # Now the new preference values are active.
     self.assertEqual(self._SESSION_STARTUP_URLS,
                      self.GetPrefsInfo().Prefs(pyauto.kRestoreOnStartup))
     # Homepage migrated to the list of startup URLs.
     self.assertEqual([new_homepage],
                      self.GetPrefsInfo().Prefs(pyauto.kURLsToRestoreOnStartup))
     # No longer showing the change.
     self.assertFalse(self.GetProtectorState()['showing_change'])
 
+  def testSessionStartupPrefMigrationFromBlank(self):
+    """Test migration from session.restore_on_startup being blank, as it would
+       be for a user who had m18 or lower, and never changed that preference.
+    """
+    # Set startup prefs to restoring last open tabs.
+    self.SetPrefs(pyauto.kRestoreOnStartup, self._SESSION_STARTUP_LAST)
+    self.SetPrefs(pyauto.kURLsToRestoreOnStartup, [])
+    # Set the homepage.
+    new_homepage = 'http://www.google.com/'
+    self.SetPrefs(pyauto.kHomePageIsNewTabPage, False)
+    self.SetPrefs(pyauto.kHomePage, new_homepage)
+    # Restart browser, clearing the 'restore on startup' pref.
+    self.RestartBrowser(
+        clear_profile=False,
+        pre_launch_hook=lambda: self._ChangeSessionStartupPrefs(
+            startup_type=None))
+    # The change must be detected by Protector.
+    self.assertTrue(self.GetProtectorState()['showing_change'])
+    # Protector must restore old preference values.
+    self.assertEqual(self._SESSION_STARTUP_LAST,
+                     self.GetPrefsInfo().Prefs(pyauto.kRestoreOnStartup))
+    self.assertEqual([],
+                     self.GetPrefsInfo().Prefs(pyauto.kURLsToRestoreOnStartup))

[Nirnimesh, 2012/04/14 08:09:55]

use assertFalse instead

+    self.ApplyProtectorChange()
+    # Now the new preference values are active.
+    self.assertEqual(self._SESSION_STARTUP_URLS,
+                     self.GetPrefsInfo().Prefs(pyauto.kRestoreOnStartup))
+    # Homepage migrated to the list of startup URLs.
+    self.assertEqual([new_homepage],
+                     self.GetPrefsInfo().Prefs(pyauto.kURLsToRestoreOnStartup))
+    # No longer showing the change.
+    self.assertFalse(self.GetProtectorState()['showing_change'])
+
+  def testSessionStartupPrefNoMigrationOnHomepageChange(self):
+    """Test that when the user modifies their homepage in m19+, we don't do the
+       preference migration.
+    """
+    # Leave the kRestoreOnStartup preference unset so that the default value
+    # applies (for m18, that's "open the homepage"), and set the homepage.
+    new_homepage = 'http://www.google.com/'
+    self.SetPrefs(pyauto.kHomePageIsNewTabPage, False)
+    self.SetPrefs(pyauto.kHomePage, new_homepage)
+    # Restart browser.
+    self.RestartBrowser(clear_profile=False)
+    # Now the new preference values are active.
+    self.assertEqual(self._SESSION_STARTUP_NTP,
+                     self.GetPrefsInfo().Prefs(pyauto.kRestoreOnStartup))
+    # kURLsToRestoreOnStartup pref is unchanged.
+    self.assertEqual([],
+                     self.GetPrefsInfo().Prefs(pyauto.kURLsToRestoreOnStartup))
+
   def testDetectPinnedTabsChangeAndApply(self):
     """Test for detecting and applying a change to pinned tabs."""
     pinned_urls = ['chrome://version/', 'chrome://credits/']
     self.RestartBrowser(
         clear_profile=False,
         pre_launch_hook=lambda: self._ChangePinnedTabsPrefs(pinned_urls))
     # The change must be detected by Protector.
     self.assertTrue(self.GetProtectorState()['showing_change'])
     # Protector must restore old preference values.
     self.assertEqual([],
@@ skipping 122 matching lines @@
                      self.GetPrefsInfo().Prefs(pyauto.kRestoreOnStartup))
     # Verify that open tabs are consistent with new prefs.
     info = self.GetBrowserInfo()
     self.assertEqual(1, len(info['windows']))  # one window
     self.assertEqual(1, len(info['windows'][0]['tabs']))  # one tab
     self.assertEqual(new_url, info['windows'][0]['tabs'][0]['url'])
 
 
 if __name__ == '__main__':
   pyauto_functional.Main()