Adds testing infrastructure to web_ui_browsertest to support testing HtmlDialogs.

chrome/browser/ui/webui/web_ui_browsertest.h

 // Copyright (c) 2011 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_UI_WEBUI_WEB_UI_BROWSERTEST_H_
 #define CHROME_BROWSER_UI_WEBUI_WEB_UI_BROWSERTEST_H_
 #pragma once
 
 #include <string>
 
 #include "base/file_path.h"
 #include "base/string16.h"
 #include "chrome/browser/ui/webui/web_ui_test_handler.h"
 #include "chrome/test/base/in_process_browser_test.h"
 #include "chrome/test/test_navigation_observer.h"
 
 class RenderViewHost;
 class WebUIMessageHandler;
 
 namespace base {
 class Value;
 }
 
-// This macro simplifies the declaration of simple javascript unit tests.
+// These macros simplify the declaration of simple javascript unit tests.

[Sheridan Rawlins, 2011/09/09 15:47:50]

We shouldn't need any WEB_UI macros.

These macros should be torn down in favor of kicking off the tests from
javascript.  See chrome/test/data/print_preview.js for a complex example or
others such as .../async_gen.js

[flackr, 2011/09/15 18:41:52]

Done.

 // Use:
 //   WEB_UI_UNITTEST_F(MyWebUIPageTest, myJavascriptUnittest);
+//   WEB_UI_UNITTEST_F1(MyWebUIPageTest, myJavascriptUnittest, myArg);
+//   WEB_UI_ASYNC_UNITTEST_F(MyWebUIPageTest, myJavascriptUnittest);
+//   WEB_UI_ASYNC_UNITTEST_F1(MyWebUIPageTest, myJavascriptUnittest, myArg);
 #define WEB_UI_UNITTEST_F(x, y) \
   IN_PROC_BROWSER_TEST_F(x, y) { \
     ASSERT_TRUE(RunJavascriptTest(#y)); \
   }
 
+#define WEB_UI_UNITTEST_F1(x, y, z) \
+  IN_PROC_BROWSER_TEST_F(x, y) { \
+    ASSERT_TRUE(RunJavascriptTest(#y, z)); \
+  }
+
+#define WEB_UI_ASYNC_UNITTEST_F(x, y) \
+  IN_PROC_BROWSER_TEST_F(x, y) { \
+    ASSERT_TRUE(RunJavascriptAsyncTest(#y)); \
+  }
+
+#define WEB_UI_ASYNC_UNITTEST_F1(x, y, z) \
+  IN_PROC_BROWSER_TEST_F(x, y) { \
+    ASSERT_TRUE(RunJavascriptAsyncTest(#y, z)); \
+  }
+
 // The runner of WebUI javascript based tests.
 // See chrome/test/data/webui/test_api.js for the javascript side test API's.
 //
 // These tests should follow the form given in:
 // chrome/test/data/webui/sample_downloads.js.
 // and the lone test within this class.
 class WebUIBrowserTest
     : public InProcessBrowserTest,
-      public TestNavigationObserver::JsInjectionReadyObserver {
+      public TestNavigationObserver::JsInjectionReadyObserver,
+      public NotificationObserver {
  public:
   typedef std::vector<const base::Value*> ConstValueVector;
   virtual ~WebUIBrowserTest();
 
   // Add a custom helper JS library for your test.
   // If a relative path is specified, it'll be read
   // as relative to the test data dir.
   void AddLibrary(const FilePath& library_path);
 
   // Runs a javascript function in the context of all libraries.
@@ skipping 18 matching lines @@
   bool RunJavascriptTest(const std::string& test_name);
   bool RunJavascriptTest(const std::string& test_name,
                          base::Value* arg);
   bool RunJavascriptTest(const std::string& test_name,
                          base::Value* arg1,
                          base::Value* arg2);
   bool RunJavascriptTest(const std::string& test_name,
                          const ConstValueVector& test_arguments);
 
   // Runs a test that may include calls to functions in test_api.js, and waits
-  // for call to asyncTestDone().  Takes ownership of Value arguments.
+  // for call to testDone().  Takes ownership of Value arguments.
   bool RunJavascriptAsyncTest(const std::string& test_name);
   bool RunJavascriptAsyncTest(const std::string& test_name,
                               base::Value* arg);
   bool RunJavascriptAsyncTest(const std::string& test_name,
                               base::Value* arg1,
                               base::Value* arg2);
   bool RunJavascriptAsyncTest(const std::string& test_name,
                               base::Value* arg1,
                               base::Value* arg2,
                               base::Value* arg3);
@@ skipping 28 matching lines @@
   static const char kDummyURL[];
 
   WebUIBrowserTest();
 
   // Set up test path & override for |kDummyURL|.
   virtual void SetUpInProcessBrowserTestFixture() OVERRIDE;
 
   // Tear down override for |kDummyURL|.
   virtual void TearDownInProcessBrowserTestFixture() OVERRIDE;
 
+  // Observes the next HtmlDialog to be created.
+  virtual void ObserveNextHtmlDialog();
+
+  // Wait for HtmlDialog to have loaded.
+  virtual void WaitForHtmlDialogLoad();
+
   // Returns a mock WebUI object under test (if any).
   virtual WebUIMessageHandler* GetMockMessageHandler();
 
   // Returns a file:// GURL constructed from |path| inside the test data dir for
   // webui tests.
   static GURL WebUITestDataPathToURL(const FilePath::StringType& path);
 
  private:
   // TestNavigationObserver::JsInjectionReadyObserver implementation.
   virtual void OnJsInjectionReady(RenderViewHost* render_view_host) OVERRIDE;
 
+  // NotificationObserver implementation.
+  virtual void Observe(int type,
+                       const NotificationSource& source,
+                       const NotificationDetails& details);
+
   // Builds a string containing all added javascript libraries.
   void BuildJavascriptLibraries(string16* content);
 
   // Builds a string with a call to the runTest JS function, passing the
   // given |is_async|, |test_name| and its |args|.
   string16 BuildRunTestJSCall(bool is_async,
                               const std::string& test_name,
                               const WebUIBrowserTest::ConstValueVector& args);
 
   // Loads all libraries added with AddLibrary(), and calls |function_name| with
@@ skipping 22 matching lines @@
   std::vector<FilePath> user_libraries_;
 
   // Indicates that the libraries have been pre-loaded and to not load them
   // again.
   bool libraries_preloaded_;
 
   // Saves the states of |test_fixture| and |test_name| for calling
   // PreloadJavascriptLibraries().
   std::string preload_test_fixture_;
   std::string preload_test_name_;
+
+  // The WebUI instance used for testing.
+  WebUI* web_ui_instance_;
+
+  // Track whether the custom WebUI instance has loaded.
+  bool web_ui_instance_ready_;
+
+  // Track if a message loop is running waiting on notification.
+  bool message_loop_running_;
+
+  NotificationRegistrar registrar_;
 };
 
 #endif  // CHROME_BROWSER_UI_WEBUI_WEB_UI_BROWSERTEST_H_