Save and restore State for ShellWindows, including panels

chrome/browser/extensions/shell_window_geometry_cache_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 "base/memory/scoped_ptr.h"
 #include "base/prefs/mock_pref_change_callback.h"
 #include "base/strings/string_number_conversions.h"
 #include "chrome/browser/extensions/extension_prefs.h"
 #include "chrome/browser/extensions/shell_window_geometry_cache.h"
 #include "chrome/browser/extensions/test_extension_prefs.h"
@@ skipping 18 matching lines @@
 class ShellWindowGeometryCacheTest : public testing::Test {
  public:
   ShellWindowGeometryCacheTest() :
         ui_thread_(BrowserThread::UI, &ui_message_loop_) {
     prefs_.reset(new TestExtensionPrefs(ui_message_loop_.message_loop_proxy()));
     cache_.reset(
         new ShellWindowGeometryCache(&profile_, prefs_->prefs()));
     cache_->SetSyncDelayForTests(0);
   }
 
-  void AddGeometryAndLoadExtension(const std::string& extension_id,
-                                   const std::string& window_id,
-                                   const gfx::Rect& bounds);
+  void AddGeometryAndLoadExtension(
+      const std::string& extension_id,
+      const std::string& window_id,
+      const gfx::Rect& bounds,
+      ui::WindowShowState state);
 
   // Spins the UI threads' message loops to make sure any task
   // posted to sync the geometry to the value store gets a chance to run.
   void WaitForSync();
 
   void LoadExtension(const std::string& extension_id);
   void UnloadExtension(const std::string& extension_id);
 
  protected:
   TestingProfile profile_;
   MessageLoopForUI ui_message_loop_;
   content::TestBrowserThread ui_thread_;
   scoped_ptr<TestExtensionPrefs> prefs_;
   scoped_ptr<ShellWindowGeometryCache> cache_;
 };
 
 void ShellWindowGeometryCacheTest::AddGeometryAndLoadExtension(
-    const std::string& extension_id, const std::string& window_id,
-    const gfx::Rect& bounds) {
+    const std::string& extension_id,
+    const std::string& window_id,
+    const gfx::Rect& bounds,
+    ui::WindowShowState state) {
   scoped_ptr<base::DictionaryValue> dict(new base::DictionaryValue);
   base::DictionaryValue* value = new base::DictionaryValue;
   value->SetInteger("x", bounds.x());
   value->SetInteger("y", bounds.y());
   value->SetInteger("w", bounds.width());
   value->SetInteger("h", bounds.height());
+  value->SetInteger("state", state);
   dict->SetWithoutPathExpansion(window_id, value);
   prefs_->prefs()->SetGeometryCache(extension_id, dict.Pass());
   LoadExtension(extension_id);
 }
 
 void ShellWindowGeometryCacheTest::WaitForSync() {
   content::RunAllPendingInMessageLoop();
 }
 
 void ShellWindowGeometryCacheTest::LoadExtension(
     const std::string& extension_id) {
   cache_->OnExtensionLoaded(extension_id);
   WaitForSync();
 }
 
 void ShellWindowGeometryCacheTest::UnloadExtension(
     const std::string& extension_id) {
   cache_->OnExtensionUnloaded(extension_id);
   WaitForSync();
 }
 
 // Test getting geometry from an empty store.
 TEST_F(ShellWindowGeometryCacheTest, GetGeometryEmptyStore) {
   const std::string extension_id = prefs_->AddExtensionAndReturnId("ext1");
   gfx::Rect bounds;
-  ASSERT_FALSE(cache_->GetGeometry(extension_id, kWindowId, &bounds));
+  ASSERT_FALSE(cache_->GetGeometry(extension_id, kWindowId, &bounds, NULL));

[Mr4D (OOO till 08-26), 2013/05/06 21:40:16]

Not that this really changes anything, but why do you pass NULL here (and in the
other 4 locations below)? If you wanted to test that the value does not get
written (or the function does not crash) you could have done the same to the
bounds parameter.

[stevenjb, 2013/05/07 16:06:32]

Changed bounds to be NULL also.

 }
 
 // Test getting geometry for an unknown extension.
 TEST_F(ShellWindowGeometryCacheTest, GetGeometryUnkownExtension) {
   const std::string extension_id1 = prefs_->AddExtensionAndReturnId("ext1");
   const std::string extension_id2 = prefs_->AddExtensionAndReturnId("ext2");
   AddGeometryAndLoadExtension(extension_id1, kWindowId,
-                              gfx::Rect(4, 5, 31, 43));
+                              gfx::Rect(4, 5, 31, 43),
+                              ui::SHOW_STATE_DEFAULT);
   gfx::Rect bounds;
-  ASSERT_FALSE(cache_->GetGeometry(extension_id2, kWindowId, &bounds));
+  ASSERT_FALSE(cache_->GetGeometry(extension_id2, kWindowId, &bounds, NULL));
 }
 
 // Test getting geometry for an unknown window in a known extension.
 TEST_F(ShellWindowGeometryCacheTest, GetGeometryUnkownWindow) {
   const std::string extension_id = prefs_->AddExtensionAndReturnId("ext1");
   AddGeometryAndLoadExtension(extension_id, kWindowId,
-                              gfx::Rect(4, 5, 31, 43));
+                              gfx::Rect(4, 5, 31, 43),
+                              ui::SHOW_STATE_DEFAULT);
   gfx::Rect bounds;
-  ASSERT_FALSE(cache_->GetGeometry(extension_id, kWindowId2, &bounds));
+  ASSERT_FALSE(cache_->GetGeometry(extension_id, kWindowId2, &bounds, NULL));
 }
 
-// Test that loading geometry from the store works correctly.
-TEST_F(ShellWindowGeometryCacheTest, GetGeometryFromStore) {
+// Test that loading geometry and state from the store works correctly.
+TEST_F(ShellWindowGeometryCacheTest, GetGeometryAndStateFromStore) {
   const std::string extension_id = prefs_->AddExtensionAndReturnId("ext1");
   gfx::Rect bounds(4, 5, 31, 43);
-  AddGeometryAndLoadExtension(extension_id, kWindowId, bounds);
-  gfx::Rect newBounds;
-  ASSERT_TRUE(cache_->GetGeometry(extension_id, kWindowId, &newBounds));
-  ASSERT_EQ(bounds, newBounds);
+  ui::WindowShowState state = ui::SHOW_STATE_NORMAL;
+  AddGeometryAndLoadExtension(extension_id, kWindowId, bounds, state);
+  gfx::Rect new_bounds;
+  ui::WindowShowState new_state = ui::SHOW_STATE_DEFAULT;
+  ASSERT_TRUE(cache_->GetGeometry(
+      extension_id, kWindowId, &new_bounds, &new_state));
+  ASSERT_EQ(bounds, new_bounds);
+  ASSERT_EQ(state, new_state);
 }
 
-// Test saving geometry to the cache and state store, and reading it back.
-TEST_F(ShellWindowGeometryCacheTest, SaveGeometryToStore) {
+// Test saving geometry and state to the cache and state store, and reading
+// it back.
+TEST_F(ShellWindowGeometryCacheTest, SaveGeometryAndStateToStore) {
   const std::string extension_id = prefs_->AddExtensionAndReturnId("ext1");
   const std::string window_id(kWindowId);
 
   // inform cache of extension
   LoadExtension(extension_id);
 
   // update geometry stored in cache
   gfx::Rect bounds(4, 5, 31, 43);
-  gfx::Rect newBounds;
-  cache_->SaveGeometry(extension_id, window_id, bounds);
+  ui::WindowShowState state = ui::SHOW_STATE_NORMAL;
+  cache_->SaveGeometry(extension_id, window_id, bounds, state);
 
   // make sure that immediately reading back geometry works
-  ASSERT_TRUE(cache_->GetGeometry(extension_id, window_id, &newBounds));
-  ASSERT_EQ(bounds, newBounds);
+  gfx::Rect new_bounds;
+  ui::WindowShowState new_state = ui::SHOW_STATE_DEFAULT;
+  ASSERT_TRUE(cache_->GetGeometry(
+      extension_id, window_id, &new_bounds, &new_state));
+  ASSERT_EQ(bounds, new_bounds);
+  ASSERT_EQ(state, new_state);
 
   // unload extension to force cache to save data to the state store
   UnloadExtension(extension_id);
 
   // check if geometry got stored correctly in the state store
   const base::DictionaryValue* dict =
       prefs_->prefs()->GetGeometryCache(extension_id);
   ASSERT_TRUE(dict);
 
   ASSERT_TRUE(dict->HasKey(window_id));
   int v;
   ASSERT_TRUE(dict->GetInteger(window_id + ".x", &v));
   ASSERT_EQ(bounds.x(), v);
   ASSERT_TRUE(dict->GetInteger(window_id + ".y", &v));
   ASSERT_EQ(bounds.y(), v);
   ASSERT_TRUE(dict->GetInteger(window_id + ".w", &v));
   ASSERT_EQ(bounds.width(), v);
   ASSERT_TRUE(dict->GetInteger(window_id + ".h", &v));
   ASSERT_EQ(bounds.height(), v);
+  ASSERT_TRUE(dict->GetInteger(window_id + ".state", &v));
+  ASSERT_EQ(state, v);
 
   // check to make sure cache indeed doesn't know about this extension anymore
-  ASSERT_FALSE(cache_->GetGeometry(extension_id, window_id, &newBounds));
+  ASSERT_FALSE(cache_->GetGeometry(
+      extension_id, window_id, &new_bounds, &new_state));
 
   // reload extension
   LoadExtension(extension_id);
   // and make sure the geometry got reloaded properly too
-  ASSERT_TRUE(cache_->GetGeometry(extension_id, window_id, &newBounds));
-  ASSERT_EQ(bounds, newBounds);
+  ASSERT_TRUE(cache_->GetGeometry(
+      extension_id, window_id, &new_bounds, &new_state));
+  ASSERT_EQ(bounds, new_bounds);
+  ASSERT_EQ(state, new_state);
 }
 
 // Tests that we won't do writes to the state store for SaveGeometry calls
 // which don't change the state we already have.
 TEST_F(ShellWindowGeometryCacheTest, NoDuplicateWrites) {
   using testing::_;
   using testing::Mock;
 
   const std::string extension_id = prefs_->AddExtensionAndReturnId("ext1");
   gfx::Rect bounds1(100, 200, 300, 400);
   gfx::Rect bounds2(200, 400, 600, 800);
   gfx::Rect bounds2_duplicate(200, 400, 600, 800);
 
   MockPrefChangeCallback observer(prefs_->pref_service());
   PrefChangeRegistrar registrar;
   registrar.Init(prefs_->pref_service());
   registrar.Add("extensions.settings", observer.GetCallback());
 
   // Write the first bounds - it should do > 0 writes.
   EXPECT_CALL(observer, OnPreferenceChanged(_));
-  cache_->SaveGeometry(extension_id, kWindowId, bounds1);
+  cache_->SaveGeometry(extension_id, kWindowId, bounds1,
+                       ui::SHOW_STATE_DEFAULT);
   WaitForSync();
   Mock::VerifyAndClearExpectations(&observer);
 
   // Write a different bounds - it should also do > 0 writes.
   EXPECT_CALL(observer, OnPreferenceChanged(_));
-  cache_->SaveGeometry(extension_id, kWindowId, bounds2);
+  cache_->SaveGeometry(extension_id, kWindowId, bounds2,
+                       ui::SHOW_STATE_DEFAULT);
   WaitForSync();
   Mock::VerifyAndClearExpectations(&observer);
 
-  // Write a bounds that's a duplicate of what we already have. This should
-  // not do any writes.
+  // Write a different state - it should also do > 0 writes.
+  EXPECT_CALL(observer, OnPreferenceChanged(_));
+  cache_->SaveGeometry(extension_id, kWindowId, bounds2,
+                       ui::SHOW_STATE_NORMAL);
+  WaitForSync();
+  Mock::VerifyAndClearExpectations(&observer);
+
+  // Write a bounds and state that's a duplicate of what we already have.
+  // This should not do any writes.
   EXPECT_CALL(observer, OnPreferenceChanged(_)).Times(0);
-  cache_->SaveGeometry(extension_id, kWindowId, bounds2_duplicate);
+  cache_->SaveGeometry(extension_id, kWindowId, bounds2_duplicate,
+                       ui::SHOW_STATE_NORMAL);
   WaitForSync();
   Mock::VerifyAndClearExpectations(&observer);
 }
 
 // Tests that no more than kMaxCachedWindows windows will be cached.
 TEST_F(ShellWindowGeometryCacheTest, MaxWindows) {
   const std::string extension_id = prefs_->AddExtensionAndReturnId("ext1");
   // inform cache of extension
   LoadExtension(extension_id);
 
   gfx::Rect bounds(4, 5, 31, 43);
   for (size_t i = 0; i < ShellWindowGeometryCache::kMaxCachedWindows + 1; ++i) {
     std::string window_id = "window_" + base::IntToString(i);
-    cache_->SaveGeometry(extension_id, window_id, bounds);
+    cache_->SaveGeometry(extension_id, window_id, bounds,
+                         ui::SHOW_STATE_DEFAULT);
   }
 
   // The first added window should no longer have cached geometry.
-  EXPECT_FALSE(cache_->GetGeometry(extension_id, "window_0", &bounds));
+  EXPECT_FALSE(cache_->GetGeometry(extension_id, "window_0", &bounds, NULL));
   // All other windows should still exist.
   for (size_t i = 1; i < ShellWindowGeometryCache::kMaxCachedWindows + 1; ++i) {
     std::string window_id = "window_" + base::IntToString(i);
-    EXPECT_TRUE(cache_->GetGeometry(extension_id, window_id, &bounds));
+    EXPECT_TRUE(cache_->GetGeometry(extension_id, window_id, &bounds, NULL));
   }
 }
 
 } // namespace extensions