Split TabRestoreService into InMemoryTRS and PersistentTRS

chrome/browser/sessions/tab_restore_service_browsertest.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

[sky, 2012/10/25 00:45:44]

This file mostly tests persistant_tab_restore_service, right? It should be
renamed to match that (and peristent_tab_restore_service.h should be the first
include, then newline).

[Philippe, 2012/10/25 15:37:07]

Right, done. We will see in a next CL how to split it.

 // found in the LICENSE file.
 
+#include "base/compiler_specific.h"
 #include "base/stringprintf.h"
 #include "base/utf_string_conversions.h"
+#include "chrome/browser/sessions/persistent_tab_restore_service.h"
 #include "chrome/browser/sessions/session_service.h"
 #include "chrome/browser/sessions/session_service_factory.h"
 #include "chrome/browser/sessions/session_types.h"
 #include "chrome/browser/sessions/session_types_test_helper.h"
-#include "chrome/browser/sessions/tab_restore_service.h"
 #include "chrome/browser/sessions/tab_restore_service_factory.h"
 #include "chrome/browser/ui/browser_window.h"
 #include "chrome/common/chrome_notification_types.h"
 #include "chrome/common/url_constants.h"
 #include "chrome/test/base/chrome_render_view_host_test_harness.h"
 #include "chrome/test/base/chrome_render_view_test.h"
 #include "chrome/test/base/in_process_browser_test.h"
 #include "chrome/test/base/testing_profile.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/navigation_controller.h"
@@ skipping 38 matching lines @@
     url2_ = GURL("http://2");
     url3_ = GURL("http://3");
     user_agent_override_ = "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/535.19"
         " (KHTML, like Gecko) Chrome/18.0.1025.45 Safari/535.19";
   }
 
   ~TabRestoreServiceTest() {
   }
 
  protected:
-  // testing::Test overrides
-  virtual void SetUp() {
+  static const size_t kMaxEntries;
+
+  // testing::Test:
+  virtual void SetUp() OVERRIDE {
     WebKit::initialize(webkit_platform_support_.Get());
     ChromeRenderViewHostTestHarness::SetUp();
     time_factory_ = new TabRestoreTimeFactory();
-    service_.reset(new TabRestoreService(profile(), time_factory_));
+    service_.reset(new PersistentTabRestoreService(profile(), time_factory_));
   }
 
-  virtual void TearDown() {
+  virtual void TearDown() OVERRIDE {
     service_->Shutdown();
     service_.reset();
     delete time_factory_;
     ChromeRenderViewHostTestHarness::TearDown();
     WebKit::shutdown();
   }
 
+  TabRestoreService::Entries* mutable_entries() {
+    return service_->mutable_entries();
+  }
+
+  void PruneEntries() {
+    service_->PruneEntries();
+  }
+
   void AddThreeNavigations() {
     // Navigate to three URLs.
     NavigateAndCommit(url1_);
     NavigateAndCommit(url2_);
     NavigateAndCommit(url3_);
   }
 
   void NavigateToIndex(int index) {
     // Navigate back. We have to do this song and dance as NavigationController
     // isn't happy if you navigate immediately while going back.
     controller().GoToIndex(index);
     WebContentsTester::For(contents())->CommitPendingNavigation();
   }
 
   void RecreateService() {
     // Must set service to null first so that it is destroyed before the new
     // one is created.
     service_->Shutdown();
     service_.reset();
-    service_.reset(new TabRestoreService(profile(), time_factory_));
+    service_.reset(new PersistentTabRestoreService(profile(), time_factory_));
     service_->LoadTabsFromLastSession();
   }
 
   // Adds a window with one tab and url to the profile's session service.
   // If |pinned| is true, the tab is marked as pinned in the session service.
   void AddWindowWithOneTabToSessionService(bool pinned) {
     SessionService* session_service =
         SessionServiceFactory::GetForProfile(profile());
     SessionID tab_id;
     SessionID window_id;
@@ skipping 21 matching lines @@
     AddWindowWithOneTabToSessionService(pinned);
 
     // Set this, otherwise previous session won't be loaded.
     profile()->set_last_session_exited_cleanly(false);
   }
 
   GURL url1_;
   GURL url2_;
   GURL url3_;
   std::string user_agent_override_;
-  scoped_ptr<TabRestoreService> service_;
+  scoped_ptr<PersistentTabRestoreService> service_;
   TabRestoreTimeFactory* time_factory_;
   content::RenderViewTest::RendererWebKitPlatformSupportImplNoSandbox
       webkit_platform_support_;
   content::TestBrowserThread ui_thread_;
 };
 
+const size_t TabRestoreServiceTest::kMaxEntries =
+    TabRestoreServiceHelper::kMaxEntries;
+
 TEST_F(TabRestoreServiceTest, Basic) {
   AddThreeNavigations();
 
   // Have the service record the tab.
   service_->CreateHistoricalTab(contents(), -1);
 
   // Make sure an entry was created.
   ASSERT_EQ(1U, service_->entries().size());
 
   // Make sure the entry matches.
@@ skipping 316 matching lines @@
   EXPECT_TRUE(url1_ == tab->navigations[0].virtual_url());
   EXPECT_TRUE(url2_ == tab->navigations[1].virtual_url());
   EXPECT_TRUE(url3_ == tab->navigations[2].virtual_url());
 }
 
 // Creates TabRestoreService::kMaxEntries + 1 windows in the session service
 // and makes sure we only get back TabRestoreService::kMaxEntries on restore.
 TEST_F(TabRestoreServiceTest, ManyWindowsInSessionService) {
   CreateSessionServiceWithOneWindow(false);
 
-  for (size_t i = 0; i < TabRestoreService::kMaxEntries; ++i)
+  for (size_t i = 0; i < kMaxEntries; ++i)
     AddWindowWithOneTabToSessionService(false);
 
   SessionServiceFactory::GetForProfile(profile())->
       MoveCurrentSessionToLastSession();
 
   AddThreeNavigations();
 
   service_->CreateHistoricalTab(contents(), -1);
 
   RecreateService();
 
   // We should get back kMaxEntries entries. We added more, but
   // TabRestoreService only allows up to kMaxEntries.
-  ASSERT_EQ(TabRestoreService::kMaxEntries, service_->entries().size());
+  ASSERT_EQ(kMaxEntries, service_->entries().size());
 
   // The first entry should come from the session service.
   TabRestoreService::Entry* entry = service_->entries().front();
   ASSERT_EQ(TabRestoreService::WINDOW, entry->type);
   TabRestoreService::Window* window =
       static_cast<TabRestoreService::Window*>(entry);
   ASSERT_EQ(1U, window->tabs.size());
   EXPECT_EQ(0, window->selected_tab_index);
   EXPECT_EQ(0, window->timestamp.ToInternalValue());
   ASSERT_EQ(1U, window->tabs[0].navigations.size());
@@ skipping 51 matching lines @@
     EXPECT_EQ(
         SessionTypesTestHelper::GetTimestamp(old_navigations[i]),
         SessionTypesTestHelper::GetTimestamp(restored_tab->navigations[i]));
   }
 }
 
 TEST_F(TabRestoreServiceTest, PruneEntries) {
   service_->ClearEntries();
   ASSERT_TRUE(service_->entries().empty());
 
-  const size_t max_entries = TabRestoreService::kMaxEntries;
+  const size_t max_entries = kMaxEntries;
   for (size_t i = 0; i < max_entries + 5; i++) {
     TabNavigation navigation =
         SessionTypesTestHelper::CreateNavigation(
             StringPrintf("http://%d", static_cast<int>(i)),
             StringPrintf("%d", static_cast<int>(i)));
 
     Tab* tab = new Tab();
     tab->navigations.push_back(navigation);
     tab->current_navigation_index = 0;
 
-    service_->entries_.push_back(tab);
+    mutable_entries()->push_back(tab);
   }
 
   // Only keep kMaxEntries around.
-  EXPECT_EQ(max_entries + 5, service_->entries_.size());
-  service_->PruneEntries();
-  EXPECT_EQ(max_entries, service_->entries_.size());
+  EXPECT_EQ(max_entries + 5, service_->entries().size());
+  PruneEntries();
+  EXPECT_EQ(max_entries, service_->entries().size());
   // Pruning again does nothing.
-  service_->PruneEntries();
-  EXPECT_EQ(max_entries, service_->entries_.size());
+  PruneEntries();
+  EXPECT_EQ(max_entries, service_->entries().size());
 
   // Prune older first.
   const char kRecentUrl[] = "http://recent";
   TabNavigation navigation =
       SessionTypesTestHelper::CreateNavigation(kRecentUrl, "Most recent");
   Tab* tab = new Tab();
   tab->navigations.push_back(navigation);
   tab->current_navigation_index = 0;
-  service_->entries_.push_front(tab);
-  EXPECT_EQ(max_entries + 1, service_->entries_.size());
-  service_->PruneEntries();
-  EXPECT_EQ(max_entries, service_->entries_.size());
+  mutable_entries()->push_front(tab);
+  EXPECT_EQ(max_entries + 1, service_->entries().size());
+  PruneEntries();
+  EXPECT_EQ(max_entries, service_->entries().size());
   EXPECT_EQ(GURL(kRecentUrl),
-      static_cast<Tab*>(service_->entries_.front())->
+      static_cast<Tab*>(service_->entries().front())->
           navigations[0].virtual_url());
 
   // Ignore NTPs.
   navigation =
       SessionTypesTestHelper::CreateNavigation(
           chrome::kChromeUINewTabURL, "New tab");
 
   tab = new Tab();
   tab->navigations.push_back(navigation);
   tab->current_navigation_index = 0;
-  service_->entries_.push_front(tab);
+  mutable_entries()->push_front(tab);
 
-  EXPECT_EQ(max_entries + 1, service_->entries_.size());
-  service_->PruneEntries();
-  EXPECT_EQ(max_entries, service_->entries_.size());
+  EXPECT_EQ(max_entries + 1, service_->entries().size());
+  PruneEntries();
+  EXPECT_EQ(max_entries, service_->entries().size());
   EXPECT_EQ(GURL(kRecentUrl),
-      static_cast<Tab*>(service_->entries_.front())->
+      static_cast<Tab*>(service_->entries().front())->
           navigations[0].virtual_url());
 
   // Don't prune pinned NTPs.
   tab = new Tab();
   tab->pinned = true;
   tab->current_navigation_index = 0;
   tab->navigations.push_back(navigation);
-  service_->entries_.push_front(tab);
-  EXPECT_EQ(max_entries + 1, service_->entries_.size());
-  service_->PruneEntries();
-  EXPECT_EQ(max_entries, service_->entries_.size());
+  mutable_entries()->push_front(tab);
+  EXPECT_EQ(max_entries + 1, service_->entries().size());
+  PruneEntries();
+  EXPECT_EQ(max_entries, service_->entries().size());
   EXPECT_EQ(GURL(chrome::kChromeUINewTabURL),
-      static_cast<Tab*>(service_->entries_.front())->
+      static_cast<Tab*>(service_->entries().front())->
           navigations[0].virtual_url());
 
   // Don't prune NTPs that have multiple navigations.
   // (Erase the last NTP first.)
-  delete service_->entries_.front();
-  service_->entries_.erase(service_->entries_.begin());
+  delete service_->entries().front();
+  mutable_entries()->erase(mutable_entries()->begin());
   tab = new Tab();
   tab->current_navigation_index = 1;
   tab->navigations.push_back(navigation);
   tab->navigations.push_back(navigation);
-  service_->entries_.push_front(tab);
-  EXPECT_EQ(max_entries, service_->entries_.size());
-  service_->PruneEntries();
-  EXPECT_EQ(max_entries, service_->entries_.size());
+  mutable_entries()->push_front(tab);
+  EXPECT_EQ(max_entries, service_->entries().size());
+  PruneEntries();
+  EXPECT_EQ(max_entries, service_->entries().size());
   EXPECT_EQ(GURL(chrome::kChromeUINewTabURL),
-      static_cast<Tab*>(service_->entries_.front())->
+      static_cast<Tab*>(service_->entries().front())->
           navigations[1].virtual_url());
 }
 
 // Regression test for crbug.com/106082
 TEST_F(TabRestoreServiceTest, PruneIsCalled) {
   CreateSessionServiceWithOneWindow(false);
 
   SessionServiceFactory::GetForProfile(profile())->
       MoveCurrentSessionToLastSession();
 
   profile()->set_restored_last_session(true);
 
-  const size_t max_entries = TabRestoreService::kMaxEntries;
+  const size_t max_entries = kMaxEntries;
   for (size_t i = 0; i < max_entries + 5; i++) {
     NavigateAndCommit(GURL(StringPrintf("http://%d", static_cast<int>(i))));
     service_->CreateHistoricalTab(contents(), -1);
   }
 
-  EXPECT_EQ(max_entries, service_->entries_.size());
+  EXPECT_EQ(max_entries, service_->entries().size());
   // This should not crash.
   service_->LoadTabsFromLastSession();
-  EXPECT_EQ(max_entries, service_->entries_.size());
+  EXPECT_EQ(max_entries, service_->entries().size());
 }