Support automatically resolving dependencies in javascript tests.

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
  *     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.
-if (arguments.length < 4) {
+if (arguments.length != 6) {
   print('usage: ' +
-        arguments[0] + ' path-to-testfile.js testfile.js output.cc test-type');
+        arguments[0] +
+        ' path-to-testfile.js testfile.js path_to_deps.js output.cc test-type');
   quit(-1);
 }
 
 /**
  * Full path to the test input file.
  * @type {string}
  */
 var jsFile = arguments[1];
 
 /**
  * Relative path to the test input file appropriate for use in the
  * C++ TestFixture's addLibrary method.
  * @type {string}
  */
 var jsFileBase = arguments[2];
 
 /**
+ * Path to Closure library style deps.js file.
+ * @type {string?}
+ */
+var depsFile = arguments[3];
+
+/**
  * Path to C++ file generation is outputting to.
  * @type {string}
  */
-var outputFile = arguments[3];
+var outputFile = arguments[4];
 
 /**
  * Type of this test.
  * @type {string} ('unit'| 'webui')
  */
-var testType = arguments[4];
+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.
@@ skipping 49 matching lines @@
  * @return {{path: string, base: string}} Object describing the paths
  *     for |includeFile|.
  */
 function includeFileToPaths(includeFile) {
   return {
     path: jsFile.replace(/[^\/\\]+$/, includeFile),
     base: jsFileBase.replace(/[^\/\\]+$/, includeFile),
   };
 }
 
+
+/**
+ * Maps namespace/object names to the path to the file that provides them.
+ * Populated from the |depsFile| if any.
+ * @type {Object.<string, string>}
+ */
+var dependencyProvidesToPaths = {};
+
+/**
+ * For each path included in the |depsFile|, if any, contains
+ * the list of object/namespace names required by the file.
+ * @type {Object.<string, Array.<string>>}
+ */
+var dependencyPathsToRequires = {};
+
+if (depsFile) {
+  var goog = goog || {};
+  /**
+   * Called by the javascript in the deps file to add modules and their
+   * dependencies.
+   * @param {string} path Relative path to the file.
+   * @param Array.<string> provides Objects provided by this file.
+   * @param Array.<string> requires Objects required by this file.
+   */
+  goog.addDependency = function(path, provides, requires) {
+    provides.forEach(function(provide) {
+      dependencyProvidesToPaths[provide] = path;
+    });
+    dependencyPathsToRequires[path] = requires;
+  };
+
+  // Read and eval the deps file.  It should only contain goog.addDependency
+  // calls.
+  eval(read(depsFile));
+}
+
+/**
+ * Resolves a list of libraries to an ordered list of paths to load by the
+ * generated C++.  The input can contain paths relative to the test script and,
+ * if a deps file was provided, namespace/object names provided by the
+ * deps file.  For the latter case, dependencies will be resolved and
+ * included in the correct order, meaning that the returned array may contain
+ * more entries than the input.
+ * @param {Array.<string>} libraries List of libraries, either paths or
+ *     namespace/object names if a deps file was provided.
+ * @return {Array.<string>} List of paths to load.
+ */
+function resolveLibraries(libraries) {
+  var resultPaths = [];
+  var addedPaths = {};
+
+  function addPath(path) {
+    addedPaths[path] = true;
+    resultPaths.push(path);
+  }
+
+  function resolveAndAppend(path) {
+    if (addedPaths[path]) {
+      return;
+    }
+    // Set before recursing to catch cycles.
+    addedPaths[path] = true;
+    dependencyPathsToRequires[path].forEach(function(require) {
+      var providingPath = dependencyProvidesToPaths[require];
+      if (!providingPath) {
+        print('Unknown object', require, 'required by', path);
+        quit(-1);
+      }
+      resolveAndAppend(providingPath);
+    });
+    resultPaths.push(path);
+  }
+
+  // Always add closure libaries base.js if provided by deps.

[David Tseng, 2014/05/30 17:08:46]

libraries

+  var basePath = dependencyProvidesToPaths['goog'];
+  if (basePath) {
+    addPath(basePath);
+  }
+
+  libraries.forEach(function(library) {
+    var providingPath = dependencyProvidesToPaths[library];
+    if (providingPath) {
+      resolveAndAppend(providingPath);
+    } else {
+      var basePath = includeFileToPaths(library).base;
+      if (!addedPaths[basePath]) {
+        addPath(basePath);
+      }
+    }
+  });
+
+  return resultPaths;
+}
+
 /**
  * Output |code| verbatim.
  * @param {string} code The code to output.
  */
 function GEN(code) {
   print(code);
 }
 
 /**
  * Generate includes for the current |jsFile| by including them
@@ skipping 21 matching lines @@
   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(
-      this[testFixture].prototype.extraLibraries.map(
-          function(includeFile) {
-            return includeFileToPaths(includeFile).base;
-          }));
+      resolveLibraries(this[testFixture].prototype.extraLibraries));

[David Tseng, 2014/05/30 17:08:46]

Nice.

 
   if (typedefCppFixture && !(testFixture in typedeffedCppFixtures)) {
     print('typedef ' + typedefCppFixture + ' ' + testFixture + ';');
     typedeffedCppFixtures[testFixture] = typedefCppFixture;
   }
 
   print(testF + '(' + testFixture + ', ' + testFunction + ') {');
   for (var i = 0; i < extraLibraries.length; i++) {
     print('  AddLibrary(base::FilePath(FILE_PATH_LITERAL("' +
         extraLibraries[i].replace(/\\/g, '/') + '")));');
@@ skipping 17 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);