Rename apps::ShellWindow to apps::AppWindow

* Rename ShellWindowRegistry
* Rename ShellWindowGeometryCache
* Rename members like shell_window_ to app_window_
* Rename locals like shell_window to app_window

BUG=343591
TEST=compiles
COLLABORATOR=scheib@chromium.org
TBR=skuhne@chromium.org for chrome/browser/ui/ash/launcher
TBR=thakis@chromium.org for chrome/browser/ui/cocoa
TBR=erg@chromium.org for chrome/browser/ui/gtk
TBR=sky@chromium.org for chrome/test

Review URL: https://codereview.chromium.org/166573005

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@251542 0039d316-1c4b-4281-b951-d872f2087c98

1 files changed, 345 insertions, 0 deletions

diff --git a/apps/app_window_geometry_cache_unittest.cc b/apps/app_window_geometry_cache_unittest.cc
new file mode 100644
index 0000000..deda109
--- /dev/null
+++ b/apps/app_window_geometry_cache_unittest.cc
@@ -0,0 +1,345 @@
+// Copyright 2014 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 "apps/app_window_geometry_cache.h"
+#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/test_extension_prefs.h"
+#include "chrome/test/base/testing_profile.h"
+#include "content/public/test/test_browser_thread.h"
+#include "content/public/test/test_utils.h"
+#include "extensions/browser/extension_prefs.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+const char kWindowId[] = "windowid";
+const char kWindowId2[] = "windowid2";
+
+using content::BrowserThread;
+
+namespace apps {
+
+// Base class for tests.
+class AppWindowGeometryCacheTest : public testing::Test {
+ public:
+  AppWindowGeometryCacheTest()
+      : ui_thread_(BrowserThread::UI, &ui_message_loop_) {
+    prefs_.reset(new extensions::TestExtensionPrefs(
+        ui_message_loop_.message_loop_proxy().get()));
+    cache_.reset(new AppWindowGeometryCache(&profile_, prefs_->prefs()));
+    cache_->SetSyncDelayForTests(0);
+  }
+
+  void AddGeometryAndLoadExtension(const std::string& extension_id,
+                                   const std::string& window_id,
+                                   const gfx::Rect& bounds,
+                                   const gfx::Rect& screen_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_;
+  base::MessageLoopForUI ui_message_loop_;
+  content::TestBrowserThread ui_thread_;
+  scoped_ptr<extensions::TestExtensionPrefs> prefs_;
+  scoped_ptr<AppWindowGeometryCache> cache_;
+};
+
+void AppWindowGeometryCacheTest::AddGeometryAndLoadExtension(
+    const std::string& extension_id,
+    const std::string& window_id,
+    const gfx::Rect& bounds,
+    const gfx::Rect& screen_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("screen_bounds_x", screen_bounds.x());
+  value->SetInteger("screen_bounds_y", screen_bounds.y());
+  value->SetInteger("screen_bounds_w", screen_bounds.width());
+  value->SetInteger("screen_bounds_h", screen_bounds.height());
+  value->SetInteger("state", state);
+  dict->SetWithoutPathExpansion(window_id, value);
+  prefs_->prefs()->SetGeometryCache(extension_id, dict.Pass());
+  LoadExtension(extension_id);
+}
+
+void AppWindowGeometryCacheTest::WaitForSync() {
+  content::RunAllPendingInMessageLoop();
+}
+
+void AppWindowGeometryCacheTest::LoadExtension(
+    const std::string& extension_id) {
+  cache_->LoadGeometryFromStorage(extension_id);
+  WaitForSync();
+}
+
+void AppWindowGeometryCacheTest::UnloadExtension(
+    const std::string& extension_id) {
+  cache_->OnExtensionUnloaded(extension_id);
+  WaitForSync();
+}
+
+// Test getting geometry from an empty store.
+TEST_F(AppWindowGeometryCacheTest, GetGeometryEmptyStore) {
+  const std::string extension_id = prefs_->AddExtensionAndReturnId("ext1");
+  ASSERT_FALSE(cache_->GetGeometry(extension_id, kWindowId, NULL, NULL, NULL));
+}
+
+// Test getting geometry for an unknown extension.
+TEST_F(AppWindowGeometryCacheTest, 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(0, 0, 1600, 900),
+                              ui::SHOW_STATE_NORMAL);
+  ASSERT_FALSE(cache_->GetGeometry(extension_id2, kWindowId, NULL, NULL, NULL));
+}
+
+// Test getting geometry for an unknown window in a known extension.
+TEST_F(AppWindowGeometryCacheTest, GetGeometryUnkownWindow) {
+  const std::string extension_id = prefs_->AddExtensionAndReturnId("ext1");
+  AddGeometryAndLoadExtension(extension_id,
+                              kWindowId,
+                              gfx::Rect(4, 5, 31, 43),
+                              gfx::Rect(0, 0, 1600, 900),
+                              ui::SHOW_STATE_NORMAL);
+  ASSERT_FALSE(cache_->GetGeometry(extension_id, kWindowId2, NULL, NULL, NULL));
+}
+
+// Test that loading geometry, screen_bounds and state from the store works
+// correctly.
+TEST_F(AppWindowGeometryCacheTest, GetGeometryAndStateFromStore) {
+  const std::string extension_id = prefs_->AddExtensionAndReturnId("ext1");
+  gfx::Rect bounds(4, 5, 31, 43);
+  gfx::Rect screen_bounds(0, 0, 1600, 900);
+  ui::WindowShowState state = ui::SHOW_STATE_NORMAL;
+  AddGeometryAndLoadExtension(
+      extension_id, kWindowId, bounds, screen_bounds, state);
+  gfx::Rect new_bounds;
+  gfx::Rect new_screen_bounds;
+  ui::WindowShowState new_state = ui::SHOW_STATE_DEFAULT;
+  ASSERT_TRUE(cache_->GetGeometry(
+      extension_id, kWindowId, &new_bounds, &new_screen_bounds, &new_state));
+  ASSERT_EQ(bounds, new_bounds);
+  ASSERT_EQ(screen_bounds, new_screen_bounds);
+  ASSERT_EQ(state, new_state);
+}
+
+// Test corrupt bounds will not be loaded.
+TEST_F(AppWindowGeometryCacheTest, CorruptBounds) {
+  const std::string extension_id = prefs_->AddExtensionAndReturnId("ext1");
+  gfx::Rect bounds;
+  gfx::Rect screen_bounds(0, 0, 1600, 900);
+  ui::WindowShowState state = ui::SHOW_STATE_NORMAL;
+  AddGeometryAndLoadExtension(
+      extension_id, kWindowId, bounds, screen_bounds, state);
+  gfx::Rect new_bounds;
+  gfx::Rect new_screen_bounds;
+  ui::WindowShowState new_state = ui::SHOW_STATE_DEFAULT;
+  ASSERT_FALSE(cache_->GetGeometry(
+      extension_id, kWindowId, &new_bounds, &new_screen_bounds, &new_state));
+  ASSERT_TRUE(new_bounds.IsEmpty());
+  ASSERT_TRUE(new_screen_bounds.IsEmpty());
+  ASSERT_EQ(new_state, ui::SHOW_STATE_DEFAULT);
+}
+
+// Test corrupt screen bounds will not be loaded.
+TEST_F(AppWindowGeometryCacheTest, CorruptScreenBounds) {
+  const std::string extension_id = prefs_->AddExtensionAndReturnId("ext1");
+  gfx::Rect bounds(4, 5, 31, 43);
+  gfx::Rect screen_bounds;
+  ui::WindowShowState state = ui::SHOW_STATE_NORMAL;
+  AddGeometryAndLoadExtension(
+      extension_id, kWindowId, bounds, screen_bounds, state);
+  gfx::Rect new_bounds;
+  gfx::Rect new_screen_bounds;
+  ui::WindowShowState new_state = ui::SHOW_STATE_DEFAULT;
+  ASSERT_FALSE(cache_->GetGeometry(
+      extension_id, kWindowId, &new_bounds, &new_screen_bounds, &new_state));
+  ASSERT_TRUE(new_bounds.IsEmpty());
+  ASSERT_TRUE(new_screen_bounds.IsEmpty());
+  ASSERT_EQ(new_state, ui::SHOW_STATE_DEFAULT);
+}
+
+// Test corrupt state will not be loaded.
+TEST_F(AppWindowGeometryCacheTest, CorruptState) {
+  const std::string extension_id = prefs_->AddExtensionAndReturnId("ext1");
+  gfx::Rect bounds(4, 5, 31, 43);
+  gfx::Rect screen_bounds(0, 0, 1600, 900);
+  ui::WindowShowState state = ui::SHOW_STATE_DEFAULT;
+  AddGeometryAndLoadExtension(
+      extension_id, kWindowId, bounds, screen_bounds, state);
+  gfx::Rect new_bounds;
+  gfx::Rect new_screen_bounds;
+  ui::WindowShowState new_state = ui::SHOW_STATE_DEFAULT;
+  ASSERT_FALSE(cache_->GetGeometry(
+      extension_id, kWindowId, &new_bounds, &new_screen_bounds, &new_state));
+  ASSERT_TRUE(new_bounds.IsEmpty());
+  ASSERT_TRUE(new_screen_bounds.IsEmpty());
+  ASSERT_EQ(new_state, ui::SHOW_STATE_DEFAULT);
+}
+
+// Test saving geometry, screen_bounds and state to the cache and state store,
+// and reading it back.
+TEST_F(AppWindowGeometryCacheTest, 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 screen_bounds(0, 0, 1600, 900);
+  ui::WindowShowState state = ui::SHOW_STATE_NORMAL;
+  cache_->SaveGeometry(extension_id, window_id, bounds, screen_bounds, state);
+
+  // make sure that immediately reading back geometry works
+  gfx::Rect new_bounds;
+  gfx::Rect new_screen_bounds;
+  ui::WindowShowState new_state = ui::SHOW_STATE_DEFAULT;
+  ASSERT_TRUE(cache_->GetGeometry(
+      extension_id, window_id, &new_bounds, &new_screen_bounds, &new_state));
+  ASSERT_EQ(bounds, new_bounds);
+  ASSERT_EQ(screen_bounds, new_screen_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 + ".screen_bounds_x", &v));
+  ASSERT_EQ(screen_bounds.x(), v);
+  ASSERT_TRUE(dict->GetInteger(window_id + ".screen_bounds_y", &v));
+  ASSERT_EQ(screen_bounds.y(), v);
+  ASSERT_TRUE(dict->GetInteger(window_id + ".screen_bounds_w", &v));
+  ASSERT_EQ(screen_bounds.width(), v);
+  ASSERT_TRUE(dict->GetInteger(window_id + ".screen_bounds_h", &v));
+  ASSERT_EQ(screen_bounds.height(), v);
+  ASSERT_TRUE(dict->GetInteger(window_id + ".state", &v));
+  ASSERT_EQ(state, v);
+
+  // reload extension
+  LoadExtension(extension_id);
+  // and make sure the geometry got reloaded properly too
+  ASSERT_TRUE(cache_->GetGeometry(
+      extension_id, window_id, &new_bounds, &new_screen_bounds, &new_state));
+  ASSERT_EQ(bounds, new_bounds);
+  ASSERT_EQ(screen_bounds, new_screen_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(AppWindowGeometryCacheTest, 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);
+
+  gfx::Rect screen_bounds1(0, 0, 1600, 900);
+  gfx::Rect screen_bounds2(0, 0, 1366, 768);
+  gfx::Rect screen_bounds2_duplicate(0, 0, 1366, 768);
+
+  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, screen_bounds1, ui::SHOW_STATE_NORMAL);
+  WaitForSync();
+  Mock::VerifyAndClearExpectations(&observer);
+
+  // Write a different bounds - it should also do > 0 writes.
+  EXPECT_CALL(observer, OnPreferenceChanged(_));
+  cache_->SaveGeometry(
+      extension_id, kWindowId, bounds2, screen_bounds1, ui::SHOW_STATE_NORMAL);
+  WaitForSync();
+  Mock::VerifyAndClearExpectations(&observer);
+
+  // Write a different screen bounds - it should also do > 0 writes.
+  EXPECT_CALL(observer, OnPreferenceChanged(_));
+  cache_->SaveGeometry(
+      extension_id, kWindowId, bounds2, screen_bounds2, ui::SHOW_STATE_NORMAL);
+  WaitForSync();
+  Mock::VerifyAndClearExpectations(&observer);
+
+  // Write a different state - it should also do > 0 writes.
+  EXPECT_CALL(observer, OnPreferenceChanged(_));
+  cache_->SaveGeometry(extension_id,
+                       kWindowId,
+                       bounds2,
+                       screen_bounds2,
+                       ui::SHOW_STATE_MAXIMIZED);
+  WaitForSync();
+  Mock::VerifyAndClearExpectations(&observer);
+
+  // Write a bounds, screen 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,
+                       screen_bounds2_duplicate,
+                       ui::SHOW_STATE_MAXIMIZED);
+  WaitForSync();
+  Mock::VerifyAndClearExpectations(&observer);
+}
+
+// Tests that no more than kMaxCachedWindows windows will be cached.
+TEST_F(AppWindowGeometryCacheTest, MaxWindows) {
+  const std::string extension_id = prefs_->AddExtensionAndReturnId("ext1");
+  // inform cache of extension
+  LoadExtension(extension_id);
+
+  gfx::Rect bounds(4, 5, 31, 43);
+  gfx::Rect screen_bounds(0, 0, 1600, 900);
+  for (size_t i = 0; i < AppWindowGeometryCache::kMaxCachedWindows + 1; ++i) {
+    std::string window_id = "window_" + base::IntToString(i);
+    cache_->SaveGeometry(
+        extension_id, window_id, bounds, screen_bounds, ui::SHOW_STATE_NORMAL);
+  }
+
+  // The first added window should no longer have cached geometry.
+  EXPECT_FALSE(cache_->GetGeometry(extension_id, "window_0", NULL, NULL, NULL));
+  // All other windows should still exist.
+  for (size_t i = 1; i < AppWindowGeometryCache::kMaxCachedWindows + 1; ++i) {
+    std::string window_id = "window_" + base::IntToString(i);
+    EXPECT_TRUE(cache_->GetGeometry(extension_id, window_id, NULL, NULL, NULL));
+  }
+}
+
+}  // namespace extensions