Add observer interface to PrerenderContents.

chrome/browser/prerender/prerender_tracker_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 <set>
+#include <utility>
 
 #include "base/logging.h"
 #include "base/message_loop.h"
+#include "chrome/browser/prerender/prerender_contents.h"
 #include "chrome/browser/prerender/prerender_manager.h"
 #include "chrome/browser/prerender/prerender_tracker.h"
 #include "chrome/test/base/testing_browser_process.h"
 #include "content/public/test/test_browser_thread.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 using content::BrowserThread;
 
 namespace prerender {
 
 namespace {
 
+class TestPrerenderContents : public PrerenderContents {
+ public:
+  TestPrerenderContents(PrerenderManager* prerender_manager,
+                        int child_id, int route_id)
+      : PrerenderContents(prerender_manager, NULL, GURL(), content::Referrer(),

[mmenke, 2012/12/03 20:02:47]

Suggest a comment that the NULL is the profile argument.

[gavinp, 2012/12/04 18:04:48]

Done, but I used a static_cast<> as the comment.

+                          ORIGIN_NONE, PrerenderManager::kNoExperiment),
+        child_id_(child_id),
+        route_id_(route_id) {
+  }
+
+  ~TestPrerenderContents() {
+    set_final_status(FINAL_STATUS_USED);
+  }
+
+  virtual bool GetChildId(int* child_id) const OVERRIDE {
+    *child_id = child_id_;
+    return true;
+  }
+
+  virtual bool GetRouteId(int* route_id) const OVERRIDE {
+    *route_id = route_id_;
+    return true;
+  }
+
+ private:
+  int child_id_;
+  int route_id_;
+};
+
 class TestPrerenderManager : public PrerenderManager {
  public:
   explicit TestPrerenderManager(PrerenderTracker* prerender_tracker) :
       PrerenderManager(NULL, prerender_tracker) {
     mutable_config().rate_limit_enabled = false;
   }
 
   virtual void DestroyPrerenderForRenderView(
       int process_id, int view_id, FinalStatus final_status) OVERRIDE {
     cancelled_id_pairs_.insert(std::make_pair(process_id, view_id));
@@ skipping 43 matching lines @@
  private:
   MessageLoop message_loop_;
   content::TestBrowserThread ui_thread_;
   content::TestBrowserThread io_thread_;
 
   scoped_ptr<TestPrerenderManager> prerender_manager_;
 };
 
 // Check that a non-existant RenderView is handled correctly.
 TEST_F(PrerenderTrackerTest, PrerenderTrackerNull) {
   FinalStatus final_status;

[mmenke, 2012/12/03 20:02:47]

While you're here, could you move it to just above its first use (Per Google
style)?

[gavinp, 2012/12/04 18:04:48]

Done.

+  TestPrerenderContents test_contents(prerender_manager(), 0, 0);
   EXPECT_FALSE(prerender_tracker()->TryUse(0, 0));
   EXPECT_FALSE(prerender_tracker()->TryCancel(0, 0, FINAL_STATUS_HTTPS));
   EXPECT_FALSE(prerender_tracker()->TryCancelOnIOThread(
       0, 0, FINAL_STATUS_HTTPS));
   EXPECT_FALSE(prerender_tracker()->IsPrerenderingOnIOThread(0, 0));
   EXPECT_FALSE(prerender_tracker()->GetFinalStatus(0, 0, &final_status));
   EXPECT_FALSE(prerender_manager()->WasPrerenderCancelled(0, 0));
 }
 
 // Check that a page that is used is handled correctly.
 TEST_F(PrerenderTrackerTest, PrerenderTrackerUsed) {
-  prerender_tracker()->OnPrerenderingStarted(0, 0, prerender_manager());
+  TestPrerenderContents test_contents(prerender_manager(), 0, 0);

[mmenke, 2012/12/03 20:02:47]

optional:  Could just toss this in the test framework.

[gavinp, 2012/12/04 18:04:48]

Done. I also got rid of all the magic numbers, at the cost of many extra lines.

+
+  prerender_tracker()->OnPrerenderStart(&test_contents);
   EXPECT_EQ(FINAL_STATUS_MAX, GetCurrentStatus(0, 0));
 
   // This calls AddPrerenderOnIOThreadTask().
   RunEvents();
 
   EXPECT_TRUE(prerender_tracker()->IsPrerenderingOnIOThread(0, 0));
   EXPECT_EQ(FINAL_STATUS_MAX, GetCurrentStatus(0, 0));
 
   // Display the prerendered RenderView.
   EXPECT_TRUE(prerender_tracker()->TryUse(0, 0));
 
   // Make sure the page can't be destroyed or claim it was destroyed after
   // it's been used.
   EXPECT_FALSE(prerender_tracker()->TryCancel(0, 0, FINAL_STATUS_HTTPS));
   EXPECT_FALSE(prerender_tracker()->TryCancelOnIOThread(
       0, 0, FINAL_STATUS_TIMED_OUT));
   EXPECT_EQ(FINAL_STATUS_USED, GetCurrentStatus(0, 0));
 
   // This would call DestroyPrerenderForChildRouteIdPair(), if the prerender
   // were cancelled.
   RunEvents();
 
   // These functions should all behave as before.
   EXPECT_FALSE(prerender_tracker()->TryCancel(0, 0, FINAL_STATUS_HTTPS));
   EXPECT_FALSE(prerender_tracker()->TryCancelOnIOThread(
       0, 0, FINAL_STATUS_TIMED_OUT));
   EXPECT_EQ(FINAL_STATUS_USED, GetCurrentStatus(0, 0));
 
   // This calls DestroyPrerenderForChildRouteIdPair().
-  prerender_tracker()->OnPrerenderingFinished(0, 0);
+  prerender_tracker()->OnPrerenderStop(&test_contents);
   EXPECT_TRUE(prerender_tracker()->IsPrerenderingOnIOThread(0, 0));
 
   // This calls RemovePrerenderOnIOThreadTask().
   RunEvents();
 
   FinalStatus final_status;
   EXPECT_FALSE(prerender_tracker()->GetFinalStatus(0, 0, &final_status));
   EXPECT_FALSE(prerender_tracker()->IsPrerenderingOnIOThread(0, 0));
   EXPECT_FALSE(prerender_tracker()->TryCancel(0, 0, FINAL_STATUS_HTTPS));
   EXPECT_FALSE(prerender_manager()->WasPrerenderCancelled(0, 0));
 }
 
 // Check that a prerendered page cancelled by TryCancel() is handled correctly.
 TEST_F(PrerenderTrackerTest, PrerenderTrackerCancelled) {
-  prerender_tracker()->OnPrerenderingStarted(0, 0, prerender_manager());
+  TestPrerenderContents test_contents(prerender_manager(), 0, 0);
+
+  prerender_tracker()->OnPrerenderStart(&test_contents);
   EXPECT_EQ(FINAL_STATUS_MAX, GetCurrentStatus(0, 0));
 
   // This calls AddPrerenderOnIOThreadTask().
   RunEvents();
 
   // Cancel the prerender.
   EXPECT_TRUE(prerender_tracker()->TryCancel(0, 0, FINAL_STATUS_HTTPS));
 
   EXPECT_FALSE(prerender_tracker()->TryUse(0, 0));
   EXPECT_TRUE(prerender_tracker()->TryCancel(0, 0, FINAL_STATUS_TIMED_OUT));
   EXPECT_TRUE(prerender_tracker()->TryCancelOnIOThread(
       0, 0, FINAL_STATUS_TIMED_OUT));
   EXPECT_EQ(FINAL_STATUS_HTTPS, GetCurrentStatus(0, 0));
 
   // This calls DestroyPrerenderForChildRouteIdPair().
   RunEvents();
   EXPECT_TRUE(prerender_manager()->WasPrerenderCancelled(0, 0));
 
   // These should all work until the prerendering RenderViewHost is destroyed.
   EXPECT_TRUE(prerender_tracker()->TryCancel(0, 0, FINAL_STATUS_TIMED_OUT));
   EXPECT_TRUE(prerender_tracker()->TryCancelOnIOThread(
       0, 0, FINAL_STATUS_TIMED_OUT));
   EXPECT_EQ(FINAL_STATUS_HTTPS, GetCurrentStatus(0, 0));
 
-  prerender_tracker()->OnPrerenderingFinished(0, 0);
+  prerender_tracker()->OnPrerenderStop(&test_contents);
   EXPECT_TRUE(prerender_tracker()->IsPrerenderingOnIOThread(0, 0));
 
   // This calls RemovePrerenderOnIOThreadTask().
   RunEvents();
 
   FinalStatus final_status;
   EXPECT_FALSE(prerender_tracker()->GetFinalStatus(0, 0, &final_status));
   EXPECT_FALSE(prerender_tracker()->IsPrerenderingOnIOThread(0, 0));
 }
 
 // Check that a prerendered page cancelled on the IO thread by
 // TryCancelOnIOThread() is handled correctly.
 TEST_F(PrerenderTrackerTest, PrerenderTrackerCancelledOnIO) {
-  prerender_tracker()->OnPrerenderingStarted(0, 0, prerender_manager());
+  TestPrerenderContents test_contents(prerender_manager(), 0, 0);
+
+  prerender_tracker()->OnPrerenderStart(&test_contents);
   EXPECT_EQ(FINAL_STATUS_MAX, GetCurrentStatus(0, 0));
 
   // This calls AddPrerenderOnIOThreadTask().
   RunEvents();
 
   // Cancel the prerender.
   EXPECT_TRUE(prerender_tracker()->TryCancelOnIOThread(
       0, 0, FINAL_STATUS_TIMED_OUT));
 
   EXPECT_FALSE(prerender_tracker()->TryUse(0, 0));
   EXPECT_TRUE(prerender_tracker()->TryCancel(0, 0, FINAL_STATUS_HTTPS));
   EXPECT_TRUE(prerender_tracker()->TryCancelOnIOThread(
       0, 0, FINAL_STATUS_HTTPS));
   EXPECT_EQ(FINAL_STATUS_TIMED_OUT, GetCurrentStatus(0, 0));
 
   // This calls DestroyPrerenderForChildRouteIdPair().
   RunEvents();
   EXPECT_TRUE(prerender_manager()->WasPrerenderCancelled(0, 0));
 
   // These should all work until the prerendering RenderViewHost is destroyed.
   EXPECT_TRUE(prerender_tracker()->TryCancel(0, 0, FINAL_STATUS_HTTPS));
   EXPECT_TRUE(prerender_tracker()->TryCancelOnIOThread(
       0, 0, FINAL_STATUS_HTTPS));
   EXPECT_EQ(FINAL_STATUS_TIMED_OUT, GetCurrentStatus(0, 0));
 
-  prerender_tracker()->OnPrerenderingFinished(0, 0);
+  prerender_tracker()->OnPrerenderStop(&test_contents);
   EXPECT_TRUE(prerender_tracker()->IsPrerenderingOnIOThread(0, 0));
 
   // This calls RemovePrerenderOnIOThreadTask().
   RunEvents();
 
   FinalStatus final_status;
   EXPECT_FALSE(prerender_tracker()->GetFinalStatus(0, 0, &final_status));
   EXPECT_FALSE(prerender_tracker()->IsPrerenderingOnIOThread(0, 0));
 }
 
 // Check that a prerendered page cancelled before it reaches the IO thread is
 // handled correctly.
 TEST_F(PrerenderTrackerTest, PrerenderTrackerCancelledFast) {
-  prerender_tracker()->OnPrerenderingStarted(0, 0, prerender_manager());
+  TestPrerenderContents test_contents(prerender_manager(), 0, 0);
+
+  prerender_tracker()->OnPrerenderStart(&test_contents);
+
   // Cancel the prerender.
   EXPECT_TRUE(prerender_tracker()->TryCancel(0, 0, FINAL_STATUS_HTTPS));
 
   EXPECT_FALSE(prerender_tracker()->TryUse(0, 0));
   EXPECT_TRUE(prerender_tracker()->TryCancel(0, 0, FINAL_STATUS_TIMED_OUT));
 
   // This calls AddPrerenderOnIOThreadTask() and
   // DestroyPrerenderForChildRouteIdPair().
   RunEvents();
   EXPECT_TRUE(prerender_manager()->WasPrerenderCancelled(0, 0));
 
   EXPECT_TRUE(prerender_tracker()->TryCancelOnIOThread(
       0, 0, FINAL_STATUS_TIMED_OUT));
   EXPECT_TRUE(prerender_tracker()->TryCancel(0, 0, FINAL_STATUS_TIMED_OUT));
   EXPECT_EQ(FINAL_STATUS_HTTPS, GetCurrentStatus(0, 0));
 
-  prerender_tracker()->OnPrerenderingFinished(0, 0);
+  prerender_tracker()->OnPrerenderStop(&test_contents);
 
   // This calls RemovePrerenderOnIOThreadTask().
   RunEvents();
 
   FinalStatus final_status;
   EXPECT_FALSE(prerender_tracker()->GetFinalStatus(0, 0, &final_status));
   EXPECT_FALSE(prerender_tracker()->IsPrerenderingOnIOThread(0, 0));
 }
 
 // Check that handling two pages at once works.
 TEST_F(PrerenderTrackerTest, PrerenderTrackerMultiple) {
-  prerender_tracker()->OnPrerenderingStarted(0, 0, prerender_manager());
+  TestPrerenderContents first_test_contents(prerender_manager(), 0, 0);
+  prerender_tracker()->OnPrerenderStart(&first_test_contents);
 
   // This calls AddPrerenderOnIOThreadTask().
   RunEvents();
   EXPECT_TRUE(prerender_tracker()->IsPrerenderingOnIOThread(0, 0));
   EXPECT_FALSE(prerender_tracker()->IsPrerenderingOnIOThread(1, 2));
   EXPECT_FALSE(prerender_tracker()->TryUse(1, 2));
   EXPECT_FALSE(prerender_tracker()->TryCancel(1, 2, FINAL_STATUS_HTTPS));
 
   // Start second prerender.
-  prerender_tracker()->OnPrerenderingStarted(1, 2, prerender_manager());
+  TestPrerenderContents second_test_contents(prerender_manager(), 1, 2);
+  prerender_tracker()->OnPrerenderStart(&second_test_contents);
   // This calls AddPrerenderOnIOThreadTask().
   RunEvents();
 
   // Use (0, 0).
   EXPECT_TRUE(prerender_tracker()->TryUse(0, 0));
   EXPECT_EQ(FINAL_STATUS_USED, GetCurrentStatus(0, 0));
   EXPECT_EQ(FINAL_STATUS_MAX, GetCurrentStatus(1, 2));
 
   // Cancel (1, 2).
   EXPECT_TRUE(prerender_tracker()->TryCancelOnIOThread(
       1, 2, FINAL_STATUS_HTTPS));
 
   EXPECT_FALSE(prerender_tracker()->TryCancel(0, 0, FINAL_STATUS_HTTPS));
   EXPECT_EQ(FINAL_STATUS_USED, GetCurrentStatus(0, 0));
 
   EXPECT_FALSE(prerender_tracker()->TryUse(1, 2));
   EXPECT_TRUE(prerender_tracker()->TryCancel(1, 2, FINAL_STATUS_HTTPS));
   EXPECT_EQ(FINAL_STATUS_HTTPS, GetCurrentStatus(1, 2));
 
   // This calls DestroyPrerenderForChildRouteIdPair().
   RunEvents();
   EXPECT_FALSE(prerender_manager()->WasPrerenderCancelled(0, 0));
   EXPECT_TRUE(prerender_manager()->WasPrerenderCancelled(1, 2));
 
-  prerender_tracker()->OnPrerenderingFinished(0, 0);
-  prerender_tracker()->OnPrerenderingFinished(1, 2);
+  prerender_tracker()->OnPrerenderStop(&first_test_contents);
+  prerender_tracker()->OnPrerenderStop(&second_test_contents);
 
   // This calls RemovePrerenderOnIOThreadTask().
   RunEvents();
 
   FinalStatus final_status;
   EXPECT_FALSE(prerender_tracker()->GetFinalStatus(0, 0, &final_status));
   EXPECT_FALSE(prerender_tracker()->IsPrerenderingOnIOThread(0, 0));
 
   EXPECT_FALSE(prerender_tracker()->GetFinalStatus(1, 2, &final_status));
   EXPECT_FALSE(prerender_tracker()->IsPrerenderingOnIOThread(1, 2));
 }
 
 }  // namespace prerender