Instant: Use only one hidden WebContents per profile.

chrome/browser/instant/instant_test_utils.h

 // Copyright 2013 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.
 
 #ifndef CHROME_BROWSER_INSTANT_INSTANT_TEST_UTILS_H_
 #define CHROME_BROWSER_INSTANT_INSTANT_TEST_UTILS_H_
 
 #include <string>
 
+#include "base/basictypes.h"
+#include "base/compiler_specific.h"
 #include "base/run_loop.h"
-#include "chrome/browser/instant/instant_controller.h"
 #include "chrome/browser/instant/instant_model_observer.h"
-#include "chrome/browser/ui/browser.h"
-#include "chrome/browser/ui/browser_instant_controller.h"
-#include "chrome/browser/ui/browser_window.h"
-#include "chrome/browser/ui/omnibox/location_bar.h"
-#include "chrome/browser/ui/omnibox/omnibox_view.h"
-#include "chrome/common/search_types.h"
-#include "chrome/test/base/in_process_browser_test.h"
+#include "googleurl/src/gurl.h"
+#include "net/test/test_server.h"
+
+class Browser;
+class InstantController;
+class InstantModel;
+class InstantService;
+class OmniboxView;
+struct TemplateURLData;
+
+namespace content {
+class WebContents;
+}
 
 class InstantTestModelObserver : public InstantModelObserver {
  public:
-  InstantTestModelObserver(InstantModel* model,
-                           chrome::search::Mode::Type desired_mode_type);
-  ~InstantTestModelObserver();
+  InstantTestModelObserver(InstantController* controller,
+                           const InstantModel* desired_model);
+  virtual ~InstantTestModelObserver();
 
-  void WaitUntilDesiredPreviewState();
-
-  // Overridden from InstantModelObserver:
-  virtual void PreviewStateChanged(const InstantModel& model) OVERRIDE;
+  void WaitForDesiredOverlayState();
 
  private:
-  InstantModel* const model_;
-  const chrome::search::Mode::Type desired_mode_type_;
+  // Overridden from InstantModelObserver:
+  virtual void OverlayStateChanged(const InstantModel& model) OVERRIDE;
+
+  InstantController* const controller_;
+  const InstantModel* const desired_model_;
   base::RunLoop run_loop_;
 
   DISALLOW_COPY_AND_ASSIGN(InstantTestModelObserver);
 };
 
-class InstantTestBase : public InProcessBrowserTest {
+// This utility class is meant to be used in a "mix-in" fashion, giving the
+// derived test class additional Instant-related functionality.
+class InstantTestBase {
  public:
-  InstantTestBase()
-      : https_test_server_(
-            net::TestServer::TYPE_HTTPS,
-            net::BaseTestServer::SSLOptions(),
-            base::FilePath(FILE_PATH_LITERAL("chrome/test/data"))) {
-  }
+  InstantTestBase();
+  virtual ~InstantTestBase();
 
- protected:
-  void SetupInstant();
+  // Accessors for common objects. These objects are meant for use by derived
+  // classes. InstantTestBase doesn't itself use them.
+  net::TestServer* https_test_server() { return &https_test_server_; }
+  const GURL& instant_url() const { return instant_url_; }
+  void set_instant_url(const GURL& url) { instant_url_ = url; }
+  void set_browser(Browser* browser) { browser_ = browser; }
 
-  InstantController* instant() {
-    return browser()->instant_controller()->instant();
-  }
+  // Initializes the user profile dir so that Instant is disabled. Returns true
+  // on success. Call this from InProcessBrowserTest::SetUpUserDataDirectory()
+  // to ensure that Instant doesn't try to activate on browser startup. To
+  // re-enable Instant later, call SetupDefaultSearchProvider().
+  bool DisableInstantOnStartup();
 
-  OmniboxView* omnibox() {
-    return browser()->window()->GetLocationBar()->GetLocationEntry();
-  }
+  // Sets up the default search engine. NOTE: |template_data| must have a valid
+  // Instant URL for this to work. In particular, InstantTestBase doesn't fill
+  // it in using |instant_url_|.
+  void SetupDefaultSearchProvider(const TemplateURLData& template_data);
 
-  void KillInstantRenderView();
+  InstantService* service() const;
+  InstantController* instant() const;
+  OmniboxView* omnibox() const;
 
   void FocusOmnibox();
   void FocusOmniboxAndWaitForInstantSupport();
 
   void SetOmniboxText(const std::string& text);
-  void SetOmniboxTextAndWaitForInstantToShow(const std::string& text);
+  void SetOmniboxTextAndWaitForOverlayToShow(const std::string& text);
 
   bool GetBoolFromJS(content::WebContents* contents,
                      const std::string& script,
                      bool* result) WARN_UNUSED_RESULT;
   bool GetIntFromJS(content::WebContents* contents,
                     const std::string& script,
                     int* result) WARN_UNUSED_RESULT;
   bool GetStringFromJS(content::WebContents* contents,
                        const std::string& script,
                        std::string* result) WARN_UNUSED_RESULT;
-  bool ExecuteScript(const std::string& script) WARN_UNUSED_RESULT;
   bool CheckVisibilityIs(content::WebContents* contents,
                          bool expected) WARN_UNUSED_RESULT;
-  bool HasUserInputInProgress();
-  bool HasTemporaryText();
 
+  void KillOverlayRenderView();
+
+ private:
+  net::TestServer https_test_server_;
   GURL instant_url_;
+  Browser* browser_;
 
-  // HTTPS Testing server, started on demand.
-  net::TestServer https_test_server_;
+  DISALLOW_COPY_AND_ASSIGN(InstantTestBase);
 };
 
 #endif  // CHROME_BROWSER_INSTANT_INSTANT_TEST_UTILS_H_