Add special-case support for Polymer tests.

Polymer tests use a special wrapper that we need to be aware of.

Closes #128

[email protected]

Review URL: https://codereview.chromium.org//1152083008

Author: nex3

CHANGELOG.md

@@ -5,6 +5,10 @@
   string. This allows such errors to be captured using the Zone API and improves
   formatting.
 
+* Improve support for Polymer tests. This fixes a flaky time-out error and adds
+  support for Dartifying JavaScript stack traces when running Polymer tests via
+  `pub serve`.
+
 * In order to be more extensible, all exception handling within tests now uses
   the Zone API.
 

lib/src/runner/browser/polymer.dart

@@ -0,0 +1,108 @@
+// Copyright (c) 2015, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+library test.runner.browser.polymer;
+
+import 'dart:io';
+
+import 'package:glob/glob.dart';
+import 'package:path/path.dart' as p;
+import 'package:pub_semver/pub_semver.dart';
+import 'package:yaml/yaml.dart';
+
+/// Whether the package being tested uses the Polymer transforemrs at all.
+///
+/// This will be `null` until [_initialize] is called.
+bool _usesPolymer;
+
+/// The set of entry points passed in to the polymer transformer's config.
+///
+/// This will be `null` if no entrypoints are declared, indicating that all
+/// entrypoints are supported.
+Set<String> _entrypoints;
+
+/// The $includes for the polymer transformer.
+Set<Glob> _includes;
+
+/// The $excludes for the polymer transformer.
+Set<Glob> _excludes;
+
+/// Returns whether [path] is an entrypoint transformed by the Polymer
+/// transformer.
+///
+/// The Polymer transformer creates a bootstrapping wrapper script around the
+/// entrypoints it's run on, so we need to know that so we can fetch the correct
+/// source map file.
+bool isPolymerEntrypoint(String path) {
+  if (_usesPolymer == null) _initialize();
+  if (!_usesPolymer) return false;
+
+  if (_excludes != null) {
+    // If there are any excludes, it must not match any of them.
+    for (var exclude in _excludes) {
+      if (exclude.matches(path)) return false;
+    }
+  }
+
+  // If there are any includes, it must match one of them.
+  if (_includes != null && !_includes.any((include) => include.matches(path))) {
+    return false;
+  }
+
+  if (_entrypoints == null) return true;
+  return _entrypoints.contains(path);
+}
+
+/// Initializes [_usesPolymer], [_entrypoints], [_includes], and [_excludes]
+/// based on the contents of the pubspec.
+///
+/// This doesn't need to do any validation of the pubspec, since pub itself does
+/// that before running the test executable.
+void _initialize() {
+  _usesPolymer = false;
+
+  var pubspec = loadYaml(new File("pubspec.yaml").readAsStringSync());
+
+  var transformers = pubspec['transformers'];
+  if (transformers == null) {
+    return;
+  }
+
+  for (var phase in transformers) {
+    var phases = phase is List ? phase : [phase];
+    for (var transformer in phases) {
+      if (transformer is String) {
+        if (transformer != "polymer") continue;
+        _usesPolymer = true;
+        return;
+      }
+
+      if (transformer.keys.single != "polymer") continue;
+      _usesPolymer = true;
+
+      var configuration = transformer.values.single;
+
+      var entrypoints = configuration["entry_points"];
+      if (entrypoints != null) _entrypoints = entrypoints.toSet();
+
+      _includes = _parseGlobField(configuration, r"$includes");
+      _excludes = _parseGlobField(configuration, r"$excludes");
+      return;
+    }
+  }
+}
+
+/// Parses a glob field (either `$include` or `$exclude`).
+Set<Glob> _parseGlobField(YamlMap configuration, String name) {
+  if (!configuration.containsKey(name)) return null;
+  var field = configuration[name];
+
+  if (field is String) {
+    return new Set.from([new Glob(field, context: p.url, recursive: true)]);
+  }
+
+  return new Set.from(field.map((node) {
+    return new Glob(node, context: p.url, recursive: true);
+  }));
+}

lib/src/runner/browser/server.dart

@@ -36,6 +36,7 @@ import 'dartium.dart';
 import 'firefox.dart';
 import 'internet_explorer.dart';
 import 'phantom_js.dart';
+import 'polymer.dart';
 import 'safari.dart';
 
 /// A server that serves JS-compiled tests to browsers.
@@ -263,8 +264,21 @@ void main() {
     if (_pubServeUrl != null) {
       var suitePrefix = p.withoutExtension(
           p.relative(path, from: p.join(_root, 'test')));
-      var jsUrl = _pubServeUrl.resolve(
+
+      var jsUrl;
+      // Polymer generates a bootstrap entrypoint that wraps the entrypoint we
+      // see on disk, and modifies the HTML file to point to the bootstrap
+      // instead. To make sure we get the right source maps and wait for the
+      // right file to compile, we have some Polymer-specific logic here to load
+      // the boostrap instead of the unwrapped file.
+      if (isPolymerEntrypoint(path)) {
+        jsUrl = _pubServeUrl.resolve(
+            "$suitePrefix.html.polymer.bootstrap.dart.browser_test.dart.js");
+      } else {
+        jsUrl = _pubServeUrl.resolve(
           '$suitePrefix.dart.browser_test.dart.js');
+      }
+
       await _pubServeSuite(path, jsUrl);
       suiteUrl = _pubServeUrl.resolveUri(p.toUri('$suitePrefix.html'));
     } else {

pubspec.yaml

@@ -10,6 +10,7 @@ dependencies:
   args: '>=0.12.1 <0.14.0'
   barback: '>=0.14.0 <0.16.0'
   crypto: '^0.9.0'
+  glob: '^1.0.0'
   http_multi_server: '^1.0.0'
   http_parser: '^0.0.2'
   path: '^1.2.0'