Fix memory error in unit test

chrome/browser/web_contents_unittest.cc

 // Copyright (c) 2006-2008 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/logging.h"
 #include "chrome/browser/interstitial_page.h"
 #include "chrome/browser/navigation_controller.h"
 #include "chrome/browser/navigation_entry.h"
 #include "chrome/browser/render_view_host.h"
 #include "chrome/browser/render_widget_host_view.h"
@@ skipping 240 matching lines @@
 };
 
 class TestInterstitialPage : public InterstitialPage {
  public:
   enum InterstitialState {
     UNDECIDED = 0, // No decision taken yet.
     OKED,          // Proceed was called.
     CANCELED       // DontProceed was called.
   };
 
+  // IMPORTANT NOTE: if you pass stack allocated values for |state| and
+  // |deleted| (like all interstitial related tests do at this point), make sure
+  // to create an instance of the TestInterstitialPageStateGuard class on the
+  // stack in your test.  This will ensure that the TestInterstitialPage states
+  // are cleared when the test finishes.
+  // Not doing so will cause stack trashing if your test does not hide the
+  // interstitial, as in such a case it will be destroyed in the test TearDown
+  // method and will dereference the |deleted| local variable which by then is
+  // out of scope.
   TestInterstitialPage(WebContents* tab,
                        bool new_navigation,
                        const GURL& url,
                        InterstitialState* state,
                        bool* deleted)
       : InterstitialPage(tab, new_navigation, url),
         state_(state),
         deleted_(deleted),
         command_received_count_(0) {
     *state_ = UNDECIDED;
     *deleted_ = false;
   }
 
   virtual ~TestInterstitialPage() {
-    *deleted_ = true;
+    if (deleted_)
+      *deleted_ = true;
   }
 
   virtual void DontProceed() {
-    *state_ = CANCELED;
+    if (state_)
+      *state_ = CANCELED;
     InterstitialPage::DontProceed();
   }
   virtual void Proceed() {
-    *state_ = OKED;
+    if (state_)
+      *state_ = OKED;
     InterstitialPage::Proceed();
   }
 
   int command_received_count() const {
     return command_received_count_;
   }
 
   void TestDomOperationResponse(const std::string& json_string) {
     DomOperationResponse(json_string, 1);
   }
 
   void TestDidNavigate(int page_id, const GURL& url) {
     ViewHostMsg_FrameNavigate_Params params;
     InitNavigateParams(&params, page_id, url);
     DidNavigate(render_view_host(), params);
   }
 
   void TestRendererGone() {
     RendererGone(render_view_host());
   }
 
   bool is_showing() const {
     return static_cast<TestRenderWidgetHostView*>(render_view_host()->view())->
         is_showing();
   }
 
+  void ClearStates() {
+    state_ = NULL;
+    deleted_ = NULL;
+  }
+
  protected:
   virtual RenderViewHost* CreateRenderViewHost() {
     return new TestRenderViewHost(
         SiteInstance::CreateSiteInstance(tab()->profile()),
         this, MSG_ROUTING_NONE, NULL);
   }
  
   virtual void CommandReceived(const std::string& command) {
     command_received_count_++;
   }
 
  private:
   InterstitialState* state_;
   bool* deleted_;
   int command_received_count_;
 };
 
+class TestInterstitialPageStateGuard {
+ public:
+  TestInterstitialPageStateGuard(TestInterstitialPage* interstitial_page)
+      : interstitial_page_(interstitial_page) {
+    DCHECK(interstitial_page_);
+  }
+  ~TestInterstitialPageStateGuard() {
+    interstitial_page_->ClearStates();
+  }
+
+ private:
+  TestInterstitialPage* interstitial_page_;
+};
+
 class WebContentsTest : public testing::Test {
  public:
   WebContentsTest() : contents(NULL) {}
 
   // testing::Test methods:
 
   virtual void SetUp() {
     profile.reset(new WebContentsTestingProfile());
 
     // This will be deleted when the WebContents goes away
@@ skipping 412 matching lines @@
   contents->controller()->LoadURL(GURL("http://www.evil.com"), GURL(),
                                   PageTransition::TYPED);
 
   // Show an interstitial.
   TestInterstitialPage::InterstitialState state =
       TestInterstitialPage::UNDECIDED;
   bool deleted = false;
   GURL url2("http://interstitial");
   TestInterstitialPage* interstitial =
       new TestInterstitialPage(contents, true, url2, &state, &deleted);
+  TestInterstitialPageStateGuard state_guard(interstitial);
   interstitial->Show();
   // The interstitial should not show until its navigation has committed.
   EXPECT_FALSE(interstitial->is_showing());
   EXPECT_FALSE(contents->showing_interstitial_page());
   EXPECT_TRUE(contents->interstitial_page() == NULL);
   // Let's commit the interstitial navigation.
   interstitial->TestDidNavigate(1, url2);
   EXPECT_TRUE(interstitial->is_showing());
   EXPECT_TRUE(contents->showing_interstitial_page());
   EXPECT_TRUE(contents->interstitial_page() == interstitial);
@@ skipping 24 matching lines @@
   EXPECT_EQ(1, contents->controller()->GetEntryCount());
 
   // Show an interstitial (no pending entry, the interstitial would have been
   // triggered by clicking on a link).
   TestInterstitialPage::InterstitialState state =
       TestInterstitialPage::UNDECIDED;
   bool deleted = false;
   GURL url2("http://interstitial");
   TestInterstitialPage* interstitial =
       new TestInterstitialPage(contents, true, url2, &state, &deleted);
+  TestInterstitialPageStateGuard state_guard(interstitial);
   interstitial->Show();
   // The interstitial should not show until its navigation has committed.
   EXPECT_FALSE(interstitial->is_showing());
   EXPECT_FALSE(contents->showing_interstitial_page());
   EXPECT_TRUE(contents->interstitial_page() == NULL);
   // Let's commit the interstitial navigation.
   interstitial->TestDidNavigate(1, url2);
   EXPECT_TRUE(interstitial->is_showing());
   EXPECT_TRUE(contents->showing_interstitial_page());
   EXPECT_TRUE(contents->interstitial_page() == interstitial);
@@ skipping 22 matching lines @@
   Navigate(1, url1);
   EXPECT_EQ(1, contents->controller()->GetEntryCount());
 
   // Show an interstitial.
   TestInterstitialPage::InterstitialState state =
       TestInterstitialPage::UNDECIDED;
   bool deleted = false;
   GURL url2("http://interstitial");
   TestInterstitialPage* interstitial =
       new TestInterstitialPage(contents, false, url2, &state, &deleted);
+  TestInterstitialPageStateGuard state_guard(interstitial);
   interstitial->Show();
   // The interstitial should not show until its navigation has committed.
   EXPECT_FALSE(interstitial->is_showing());
   EXPECT_FALSE(contents->showing_interstitial_page());
   EXPECT_TRUE(contents->interstitial_page() == NULL);
   // Let's commit the interstitial navigation.
   interstitial->TestDidNavigate(1, url2);
   EXPECT_TRUE(interstitial->is_showing());
   EXPECT_TRUE(contents->showing_interstitial_page());
   EXPECT_TRUE(contents->interstitial_page() == interstitial);
@@ skipping 27 matching lines @@
   contents->controller()->LoadURL(GURL("http://www.evil.com"), GURL(),
                                   PageTransition::TYPED);
 
   // Show an interstitial.
   TestInterstitialPage::InterstitialState state =
       TestInterstitialPage::UNDECIDED;
   bool deleted = false;
   GURL url2("http://interstitial");
   TestInterstitialPage* interstitial =
       new TestInterstitialPage(contents, true, url2, &state, &deleted);
+  TestInterstitialPageStateGuard state_guard(interstitial);
   interstitial->Show();
   // The interstitial should not show until its navigation has committed.
   EXPECT_FALSE(interstitial->is_showing());
   EXPECT_FALSE(contents->showing_interstitial_page());
   EXPECT_TRUE(contents->interstitial_page() == NULL);
   // Let's commit the interstitial navigation.
   interstitial->TestDidNavigate(1, url2);
   EXPECT_TRUE(interstitial->is_showing());
   EXPECT_TRUE(contents->showing_interstitial_page());
   EXPECT_TRUE(contents->interstitial_page() == interstitial);
@@ skipping 33 matching lines @@
   Navigate(1, url1);
   EXPECT_EQ(1, contents->controller()->GetEntryCount());
 
   // Show an interstitial.
   TestInterstitialPage::InterstitialState state =
       TestInterstitialPage::UNDECIDED;
   bool deleted = false;
   GURL url2("http://interstitial");
   TestInterstitialPage* interstitial =
       new TestInterstitialPage(contents, true, url2, &state, &deleted);
+  TestInterstitialPageStateGuard state_guard(interstitial);
   interstitial->Show();
   // The interstitial should not show until its navigation has committed.
   EXPECT_FALSE(interstitial->is_showing());
   EXPECT_FALSE(contents->showing_interstitial_page());
   EXPECT_TRUE(contents->interstitial_page() == NULL);
   // Let's commit the interstitial navigation.
   interstitial->TestDidNavigate(1, url2);
   EXPECT_TRUE(interstitial->is_showing());
   EXPECT_TRUE(contents->showing_interstitial_page());
   EXPECT_TRUE(contents->interstitial_page() == interstitial);
@@ skipping 33 matching lines @@
   Navigate(1, url1);
   EXPECT_EQ(1, contents->controller()->GetEntryCount());
 
   // Show an interstitial.
   TestInterstitialPage::InterstitialState state =
       TestInterstitialPage::UNDECIDED;
   bool deleted = false;
   GURL url2("http://interstitial");
   TestInterstitialPage* interstitial =
       new TestInterstitialPage(contents, false, url2, &state, &deleted);
+  TestInterstitialPageStateGuard state_guard(interstitial);
   interstitial->Show();
   // The interstitial should not show until its navigation has committed.
   EXPECT_FALSE(interstitial->is_showing());
   EXPECT_FALSE(contents->showing_interstitial_page());
   EXPECT_TRUE(contents->interstitial_page() == NULL);
   // Let's commit the interstitial navigation.
   interstitial->TestDidNavigate(1, url2);
   EXPECT_TRUE(interstitial->is_showing());
   EXPECT_TRUE(contents->showing_interstitial_page());
   EXPECT_TRUE(contents->interstitial_page() == interstitial);
@@ skipping 19 matching lines @@
 
 // Test navigating to a page that shows an interstitial, then navigating away.
 TEST_F(WebContentsTest, ShowInterstitialThenNavigate) {
   // Show interstitial.
   TestInterstitialPage::InterstitialState state =
       TestInterstitialPage::UNDECIDED;
   bool deleted = false;
   GURL url("http://interstitial");
   TestInterstitialPage* interstitial =
       new TestInterstitialPage(contents, true, url, &state, &deleted);
+  TestInterstitialPageStateGuard state_guard(interstitial);
   interstitial->Show();
   interstitial->TestDidNavigate(1, url);
 
   // While interstitial showing, navigate to a new URL.
   const GURL url2("http://www.yahoo.com");
   Navigate(1, url2);
 
   EXPECT_TRUE(deleted);
   EXPECT_EQ(TestInterstitialPage::CANCELED, state);
 }
 
 // Test navigating to a page that shows an interstitial, then close the tab.
 TEST_F(WebContentsTest, ShowInterstitialThenCloseTab) {
   // Show interstitial.
   TestInterstitialPage::InterstitialState state =
       TestInterstitialPage::UNDECIDED;
   bool deleted = false;
   GURL url("http://interstitial");
   TestInterstitialPage* interstitial =
       new TestInterstitialPage(contents, true, url, &state, &deleted);
+  TestInterstitialPageStateGuard state_guard(interstitial);
   interstitial->Show();
   interstitial->TestDidNavigate(1, url);
 
   // Now close the tab.
   contents->CloseContents();
   contents = NULL;  // So we don't detroy it again on TearDown.
   EXPECT_TRUE(deleted);
   EXPECT_EQ(TestInterstitialPage::CANCELED, state);
 }
 
 // Test that after Proceed is called and an interstitial is still shown, no more
 // commands get executed.
-// TODO(jcampan): bug #5700 Disabled because crashes on "XP Test" build bot.
-TEST_F(WebContentsTest, DISABLED_ShowInterstitialProceedMultipleCommands) {
+TEST_F(WebContentsTest, ShowInterstitialProceedMultipleCommands) {
   // Navigate to a page so we have a navigation entry in the controller.
   GURL url1("http://www.google.com");
   Navigate(1, url1);
   EXPECT_EQ(1, contents->controller()->GetEntryCount());
 
   // Show an interstitial.
   TestInterstitialPage::InterstitialState state =
       TestInterstitialPage::UNDECIDED;
   bool deleted = false;
   GURL url2("http://interstitial");
   TestInterstitialPage* interstitial =
       new TestInterstitialPage(contents, true, url2, &state, &deleted);
+  TestInterstitialPageStateGuard state_guard(interstitial);
   interstitial->Show();
   interstitial->TestDidNavigate(1, url2);
 
   // Run a command.
   EXPECT_EQ(0, interstitial->command_received_count());
   interstitial->TestDomOperationResponse("toto");
   EXPECT_EQ(1, interstitial->command_received_count());
 
   // Then proceed.
   interstitial->Proceed();
@@ skipping 13 matching lines @@
   Navigate(1, start_url);
   EXPECT_EQ(1, contents->controller()->GetEntryCount());
 
   // Show an interstitial.
   TestInterstitialPage::InterstitialState state1 =
       TestInterstitialPage::UNDECIDED;
   bool deleted1 = false;
   GURL url1("http://interstitial1");
   TestInterstitialPage* interstitial1 =
       new TestInterstitialPage(contents, true, url1, &state1, &deleted1);
+  TestInterstitialPageStateGuard state_guard1(interstitial1);
   interstitial1->Show();
   interstitial1->TestDidNavigate(1, url1);
 
   // Now show another interstitial.
   TestInterstitialPage::InterstitialState state2 =
       TestInterstitialPage::UNDECIDED;
   bool deleted2 = false;
   GURL url2("http://interstitial2");
   TestInterstitialPage* interstitial2 =
       new TestInterstitialPage(contents, true, url2, &state2, &deleted2);
+  TestInterstitialPageStateGuard state_guard2(interstitial2);
   interstitial2->Show();
   interstitial2->TestDidNavigate(1, url2);
 
   // Showing interstitial2 should have caused interstitial1 to go away.
   EXPECT_TRUE(deleted1);
   EXPECT_EQ(TestInterstitialPage::CANCELED, state1);
   
   // Let's make sure interstitial2 is working as intended.
   ASSERT_FALSE(deleted2);
   EXPECT_EQ(TestInterstitialPage::UNDECIDED, state2);  
@@ skipping 14 matching lines @@
 // not to show.
 TEST_F(WebContentsTest, NavigateBeforeInterstitialShows) {
   // Show an interstitial.
   TestInterstitialPage::InterstitialState state =
       TestInterstitialPage::UNDECIDED;
   bool deleted = false;
   GURL interstitial_url("http://interstitial");
   TestInterstitialPage* interstitial =
       new TestInterstitialPage(contents, true, interstitial_url,
                                &state, &deleted);
+  TestInterstitialPageStateGuard state_guard(interstitial);
   interstitial->Show();
 
   // Let's simulate a navigation initiated from the browser before the
   // interstitial finishes loading.
   const GURL url("http://www.google.com");
   contents->controller()->LoadURL(url, GURL(), PageTransition::TYPED);
   ASSERT_FALSE(deleted);
   EXPECT_FALSE(interstitial->is_showing());
 
   // Now let's make the interstitial navigation commit.
   interstitial->TestDidNavigate(1, interstitial_url);
 
   // After it loaded the interstitial should be gone.
   EXPECT_TRUE(deleted);
   EXPECT_EQ(TestInterstitialPage::CANCELED, state);
 }
 
 // Test showing an interstitial and have its renderer crash.
 TEST_F(WebContentsTest, InterstitialCrasher) {
   // Show an interstitial.
   TestInterstitialPage::InterstitialState state =
       TestInterstitialPage::UNDECIDED;
   bool deleted = false;
   GURL url("http://interstitial");
   TestInterstitialPage* interstitial =
       new TestInterstitialPage(contents, true, url, &state, &deleted);
+  TestInterstitialPageStateGuard state_guard(interstitial);
   interstitial->Show();
   // Simulate a renderer crash before the interstitial is shown.
   interstitial->TestRendererGone();
   // The interstitial should have been dismissed.
   EXPECT_TRUE(deleted);
   EXPECT_EQ(TestInterstitialPage::CANCELED, state);
 
   // Now try again but this time crash the intersitial after it was shown.
   interstitial =
       new TestInterstitialPage(contents, true, url, &state, &deleted);
   interstitial->Show();
   interstitial->TestDidNavigate(1, url);
   // Simulate a renderer crash.
   interstitial->TestRendererGone();
   // The interstitial should have been dismissed.
   EXPECT_TRUE(deleted);
   EXPECT_EQ(TestInterstitialPage::CANCELED, state);
 }