Support javascript gtests in an extension background page.

chrome/test/base/js2gtest.js

 // 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.
 
 /**
  * @fileoverview Generator script for creating gtest-style JavaScript
- *     tests for WebUI and unit tests. Generates C++ gtest wrappers
+ *     tests for extensions, WebUI and unit tests. Generates C++ gtest wrappers
  *     which will invoke the appropriate JavaScript for each test.
  * @author scr@chromium.org (Sheridan Rawlins)
  * @see WebUI testing: http://goo.gl/ZWFXF
  * @see gtest documentation: http://goo.gl/Ujj3H
  * @see chrome/chrome_tests.gypi
  * @see tools/gypv8sh.py
  */
 
 // Arguments from rules in chrome_tests.gypi are passed in through
 // python script gypv8sh.py.
@@ skipping 24 matching lines @@
 var depsFile = arguments[3];
 
 /**
  * Path to C++ file generation is outputting to.
  * @type {string}
  */
 var outputFile = arguments[4];
 
 /**
  * Type of this test.
- * @type {string} ('unit'| 'webui')
+ * @type {string} ('extension' | 'unit' | 'webui')

[Peter Lundblad, 2014/06/11 16:45:07]

Add code to validate that the test is one of these types.

[Peter Lundblad, 2014/06/11 16:45:07]

Add code to validate that the test is one of these types.

[Peter Lundblad, 2014/06/11 16:45:07]

Add code to validate that the test is one of these types.

[David Tseng, 2014/06/11 17:52:55]

Sure ok.

  */
 var testType = arguments[5];
 
 /**
  * C++ gtest macro to use for TEST_F depending on |testType|.
  * @type {string} ('TEST_F'|'IN_PROC_BROWSER_TEST_F')
  */
 var testF;
 
 /**
  * Keeps track of whether a typedef has been generated for each test
  * fixture.
  * @type {Object.<string, string>}
  */
 var typedeffedCppFixtures = {};
 
 /**
  * Maintains a list of relative file paths to add to each gtest body
  * for inclusion at runtime before running each JavaScript test.
  * @type {Array.<string>}
  */
 var genIncludes = [];
 
 /**
  * When true, add calls to set_preload_test_(fixture|name). This is needed when
  * |testType| === 'browser' to send an injection message before the page loads,
- * but is not required or supported for |testType| === 'unit'.
+ * but is not required or supported for |testType| === 'extension' or

[Peter Lundblad, 2014/06/11 16:45:07]

nit: Is this comment out of date talking about type === 'browser'?  Also,
simplify the esentence by not listing all tests this is not supported for;)

[Peter Lundblad, 2014/06/11 16:45:07]

nit: Is this comment out of date talking about type === 'browser'?  Also,
simplify the esentence by not listing all tests this is not supported for;)

[Peter Lundblad, 2014/06/11 16:45:07]

nit: Is this comment out of date talking about type === 'browser'?  Also,
simplify the esentence by not listing all tests this is not supported for;)

[David Tseng, 2014/06/11 17:52:55]

Updated.

+ * |testType| === 'unit'.
  * @type {boolean}
  */
 var addSetPreloadInfo;
 
-// Generate the file to stdout.
-print('// GENERATED FILE');
-print('// ' + arguments.join(' '));
-print('// PLEASE DO NOT HAND EDIT!');
-print();
+/**
+ * Whether cc headers need to be generated.
+ * @type {boolean}
+ */
+var needGenHeader = true;
 
-// Output some C++ headers based upon the |testType|.
-//
-// Currently supports:
-// 'unit' - unit_tests harness, js2unit rule, V8UnitTest superclass.
-// 'webui' - browser_tests harness, js2webui rule, WebUIBrowserTest superclass.
-if (testType === 'unit') {
-  print('#include "chrome/test/base/v8_unit_test.h"');
-  testing.Test.prototype.typedefCppFixture = 'V8UnitTest';
-  testF = 'TEST_F';
-  addSetPreloadInfo = false;
-} else {
-  print('#include "chrome/test/base/web_ui_browser_test.h"');
-  testing.Test.prototype.typedefCppFixture = 'WebUIBrowserTest';
-  testF = 'IN_PROC_BROWSER_TEST_F';
-  addSetPreloadInfo = true;
+/**
+ * Helpful hint pointing back to the source js.
+ * @type {string}
+ */
+var argHint = '// ' + this['arguments'].join(' ');
+
+
+/**
+ * Generates the header of the cc file to stdout.
+ * @param {string} testFixture Name of test fixture.
+ */
+function maybeGenHeader(testFixture) {
+  if (!needGenHeader)
+    return;
+  needGenHeader = false;
+  print('// GENERATED FILE');
+  print(argHint);
+  print('// PLEASE DO NOT HAND EDIT!');
+  print();
+
+  // Output some C++ headers based upon the |testType|.
+  //
+  // Currently supports:
+  // 'extension' - browser_tests harness, js2extension rule,
+  //               ExtensionJSBrowserTest superclass.
+  // 'unit' - unit_tests harness, js2unit rule, V8UnitTest superclass.
+  // 'webui' - browser_tests harness, js2webui rule, WebUIBrowserTest
+  // superclass.
+  if (testType === 'extension') {
+    print('#include "chrome/test/base/extension_js_browser_test.h"');
+    testing.Test.prototype.typedefCppFixture = 'ExtensionJSBrowserTest';
+    addSetPreloadInfo = false;
+    testF = 'IN_PROC_BROWSER_TEST_F';
+  } else if (testType === 'unit') {
+    print('#include "chrome/test/base/v8_unit_test.h"');
+    testing.Test.prototype.typedefCppFixture = 'V8UnitTest';
+    testF = 'TEST_F';
+    addSetPreloadInfo = false;
+  } else {
+    print('#include "chrome/test/base/web_ui_browser_test.h"');
+    testing.Test.prototype.typedefCppFixture = 'WebUIBrowserTest';
+    testF = 'IN_PROC_BROWSER_TEST_F';
+    addSetPreloadInfo = true;
+  }
+  print('#include "url/gurl.h"');
+  print('#include "testing/gtest/include/gtest/gtest.h"');
+  if (this[testFixture].prototype.testGenCppIncludes)
+    this[testFixture].prototype.testGenCppIncludes();
+  print();
 }
-print('#include "url/gurl.h"');
-print('#include "testing/gtest/include/gtest/gtest.h"');
-print();
+
 
 /**
  * Convert the |includeFile| to paths appropriate for immediate
  * inclusion (path) and runtime inclusion (base).
  * @param {string} includeFile The file to include.
  * @return {{path: string, base: string}} Object describing the paths
  *     for |includeFile|.
  */
 function includeFileToPaths(includeFile) {
   return {
@@ skipping 98 matching lines @@
 
 /**
  * Output |code| verbatim.
  * @param {string} code The code to output.
  */
 function GEN(code) {
   print(code);
 }
 
 /**
+ * Outputs |commentEncodedCode| by converting it to a js fragment.
+ * @param {function} commentEncodedCode A function in the following format (note
+ * the space in '/ *' and '* /' should be removed to form a comment delimiter):
+ *    function() {/ *! my_cpp_code.DoSomething(); * /
+ *    Code between / *! and * / will be extracted and written to stdout.
+ */
+function GEN_BLOCK(commentEncodedCode) {
+  var code = commentEncodedCode.toString().
+      replace(/^[^\/]+\/\*!?/, '').
+      replace(/\*\/[^\/]+$/, '').
+      replace(/^\n|\n$/, '').
+      replace(/\s+$/, '');
+  GEN(code);
+}
+
+/**
  * Generate includes for the current |jsFile| by including them
  * immediately and at runtime.
  * @param {Array.<string>} includes Paths to JavaScript files to
  *     include immediately and at runtime.
  */
 function GEN_INCLUDE(includes) {
   for (var i = 0; i < includes.length; i++) {
     var includePaths = includeFileToPaths(includes[i]);
     var js = read(includePaths.path);
     ('global', eval)(js);
     genIncludes.push(includePaths.base);
   }
 }
 
 /**
  * Generate gtest-style TEST_F definitions for C++ with a body that
  * will invoke the |testBody| for |testFixture|.|testFunction|.
  * @param {string} testFixture The name of this test's fixture.
  * @param {string} testFunction The name of this test's function.
  * @param {Function} testBody The function body to execute for this test.
  */
 function TEST_F(testFixture, testFunction, testBody) {
+  maybeGenHeader(testFixture);

[Peter Lundblad, 2014/06/11 16:45:07]

Does the defered generation of the file header play well with the
GEN function?

[David Tseng, 2014/06/11 17:52:55]

I haven't had any problems; was there a specific concern?

   var browsePreload = this[testFixture].prototype.browsePreload;
   var browsePrintPreload = this[testFixture].prototype.browsePrintPreload;
   var testGenPreamble = this[testFixture].prototype.testGenPreamble;
   var testGenPostamble = this[testFixture].prototype.testGenPostamble;
   var typedefCppFixture = this[testFixture].prototype.typedefCppFixture;
   var isAsyncParam = testType === 'unit' ? '' :
       this[testFixture].prototype.isAsync + ', ';
   var testShouldFail = this[testFixture].prototype.testShouldFail;
   var testPredicate = testShouldFail ? 'ASSERT_FALSE' : 'ASSERT_TRUE';
   var extraLibraries = genIncludes.concat(
@@ skipping 32 matching lines @@
         '"' + testFunction + '"));');
   if (testGenPostamble)
     testGenPostamble(testFixture, testFunction);
   print('}');
   print();
 }
 
 // Now that generation functions are defined, load in |jsFile|.
 var js = read(jsFile);
 eval(js);