Support automatic javascript test registry in gtest when creating WebUI tests.

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 CONTENT_BROWSER_WEBUI_WEB_UI_BROWSERTEST_H_
-#define CONTENT_BROWSER_WEBUI_WEB_UI_BROWSERTEST_H_
+#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 "chrome/browser/ui/webui/web_ui_test_handler.h"
 #include "chrome/test/in_process_browser_test.h"
 
 class Value;
 class WebUIMessageHandler;
 
 // This macro simplifies the declaration of simple javascript unit tests.
 // Use:
 //   WEB_UI_UNITTEST_F(MyWebUIPageTest, myJavascriptUnittest);
 #define WEB_UI_UNITTEST_F(x, y) \
   IN_PROC_BROWSER_TEST_F(x, y) { \
     ASSERT_TRUE(RunJavascriptTest(#y)); \
   }
 
+#define WEB_UI_BROWSER_TEST_JS_(test_case_name, test_name, parent_class, \
+                                parent_id, assertion, jsfile)            \
+class GTEST_TEST_CLASS_NAME_(test_case_name, test_name)\
+    : public parent_class, public ::testing::WithParamInterface<std::string> {\
+ public:\
+  GTEST_TEST_CLASS_NAME_(test_case_name, test_name)() {}\
+ protected:\
+  virtual void PrepForJSOnMainThread();\
+  virtual void RunTestOnMainThread() {\
+    AddLibrary(FilePath(jsfile));\
+    PrepForJSOnMainThread();\
+    assertion(RunJavascriptTest(GetParam()));\
+  }\
+ private:\
+  static ::testing::internal::TestMetaFactory<                          \
+      GTEST_TEST_CLASS_NAME_(test_case_name, test_name)> meta_factory_; \
+  virtual void TestBody() {}\
+  static int const gtest_registering_dummy_;\
+  GTEST_DISALLOW_COPY_AND_ASSIGN_(\
+      GTEST_TEST_CLASS_NAME_(test_case_name, test_name));\
+};\
+\
+::testing::internal::TestMetaFactory<                                   \
+    GTEST_TEST_CLASS_NAME_(test_case_name, test_name)>\
+    GTEST_TEST_CLASS_NAME_(test_case_name, test_name)::meta_factory_;       \
+int const GTEST_TEST_CLASS_NAME_(test_case_name,                        \
+                                 test_name)::gtest_registering_dummy_ = \
+      ::parent_class::AddJSToRegistry(\
+          FilePath(jsfile),\
+          #test_case_name, #test_name, "", "",\

[David Tseng, 2011/05/30 20:44:49]

Do we need the |test_name| parameter?  It is already parsed from the js file and
the |test_case_name| serves to be the general category of test.

[Sheridan Rawlins, 2011/05/31 23:15:00]

I include the test_name after the slash so that it is visible, and useful in
--gtest_filter.

Consider the case where you have a js file with several tests and want to run
them on several pages, you could do

WEB_UI_BROWSER_TEST_JS(MyCase, MyTest1, FILE_PATH_LITERAL("myjs.js")) {
  ui_test_utils::NavigateToURL(browser(), GURL("mypage1"));
}

WEB_UI_BROWSER_TEST_JS(MyCase, MyTest2, FILE_PATH_LITERAL("myjs.js")) {
  ui_test_utils::NavigateToURL(browser(), GURL("mypage2"));
}

You could run .../browser_tests --gtest_filter=MyCase.*/MyTest2

On 2011/05/30 20:44:49, David Tseng wrote:

+          (parent_id),\
+          parent_class::SetUpTestCase,\
+          parent_class::TearDownTestCase,\
+          &meta_factory_);\
+void GTEST_TEST_CLASS_NAME_(test_case_name, test_name)::PrepForJSOnMainThread()
+
+#define WEB_UI_BROWSER_TEST_JS_TRUE(test_fixture, test_name, jsfile) \
+  WEB_UI_BROWSER_TEST_JS_(test_fixture, test_name, test_fixture,        \
+                          ::testing::internal::GetTypeId<test_fixture>(), \
+                          ASSERT_TRUE, jsfile)
+
+#define WEB_UI_BROWSER_TEST_JS_FALSE(test_fixture, test_name, jsfile) \
+  WEB_UI_BROWSER_TEST_JS_(test_fixture, test_name, test_fixture,        \
+                          ::testing::internal::GetTypeId<test_fixture>(), \
+                          ASSERT_FALSE, jsfile)
+
+#define WEB_UI_BROWSER_TEST_JS WEB_UI_BROWSER_TEST_JS_TRUE
+
 // 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:
   typedef std::vector<const Value*> ConstValueVector;
   virtual ~WebUIBrowserTest();
@@ skipping 26 matching lines @@
 
  protected:
   WebUIBrowserTest();
 
   // Setup test path.
   virtual void SetUpInProcessBrowserTestFixture();
 
   // Returns a mock WebUI object under test (if any).
   virtual WebUIMessageHandler* GetMockMessageHandler();
 
+  static int AddJSToRegistry(
+      const FilePath& library_path,
+      const char* test_case_name, const char* name,
+      const char* type_param,
+      const char* value_param,
+      ::testing::internal::TypeId fixture_class_id,
+      ::testing::internal::SetUpTestCaseFunc set_up_tc,
+      ::testing::internal::TearDownTestCaseFunc tear_down_tc,
+      ::testing::internal::TestMetaFactoryBase<std::string>* meta_factory);
+
  private:
   // Builds a string containing all added javascript libraries.
-  void BuildJavascriptLibraries(std::string* content);
+  void BuildJavascriptLibraries(std::string* content) const;
 
   // Builds a string with a call to the runTest JS function, passing the
   // given test and its arguments.
   string16 BuildRunTestJSCall(const std::string& test_name,
                               const WebUIBrowserTest::ConstValueVector& args);
 
   // Calls the specified function with all libraries available. If |is_test|
   // is true, the framework listens for pass fail messages from javascript.
   // The provided arguments vector is passed to |function_name|.
   bool RunJavascriptUsingHandler(const std::string& function_name,
                                  const ConstValueVector& function_arguments,
                                  bool is_test);
 
   // Attaches mock and test handlers.
   void SetupHandlers();
 
   // Handles test framework messages.
   scoped_ptr<WebUITestHandler> test_handler_;
 
   // Location of test data (currently test/data/webui).
   FilePath test_data_directory_;
 
   // User added libraries
-  std::vector<FilePath> user_libraries;
+  std::vector<FilePath> user_libraries_;
 };
 
-#endif  // CONTENT_BROWSER_WEBUI_WEB_UI_BROWSERTEST_H_
+#endif  // CHROME_BROWSER_UI_WEBUI_WEB_UI_BROWSERTEST_H_